2013-05-22 09:58:44 -04:00
|
|
|
# To add new service you should build a class inherited from Service
|
|
|
|
# and implement a set of methods
|
2012-11-19 13:14:05 -05:00
|
|
|
class Service < ActiveRecord::Base
|
2015-02-05 17:20:55 -05:00
|
|
|
include Sortable
|
2017-07-03 10:01:41 -04:00
|
|
|
serialize :properties, JSON # rubocop:disable Cop/ActiveRecordSerialize
|
2014-09-07 20:54:18 -04:00
|
|
|
|
2014-02-26 03:41:44 -05:00
|
|
|
default_value_for :active, false
|
2015-02-19 00:02:57 -05:00
|
|
|
default_value_for :push_events, true
|
|
|
|
default_value_for :issues_events, true
|
2016-08-30 17:39:25 -04:00
|
|
|
default_value_for :confidential_issues_events, true
|
2016-11-14 16:30:01 -05:00
|
|
|
default_value_for :commit_events, true
|
2015-02-19 00:02:57 -05:00
|
|
|
default_value_for :merge_requests_events, true
|
|
|
|
default_value_for :tag_push_events, true
|
2015-03-05 13:38:23 -05:00
|
|
|
default_value_for :note_events, true
|
2017-05-15 11:11:45 -04:00
|
|
|
default_value_for :job_events, true
|
2016-09-09 08:32:06 -04:00
|
|
|
default_value_for :pipeline_events, true
|
2016-02-28 02:26:52 -05:00
|
|
|
default_value_for :wiki_page_events, true
|
2014-09-11 11:48:29 -04:00
|
|
|
|
|
|
|
after_initialize :initialize_properties
|
2014-02-26 03:41:44 -05:00
|
|
|
|
2015-10-15 03:09:01 -04:00
|
|
|
after_commit :reset_updated_properties
|
2016-06-03 04:21:18 -04:00
|
|
|
after_commit :cache_project_has_external_issue_tracker
|
2016-07-17 10:32:11 -04:00
|
|
|
after_commit :cache_project_has_external_wiki
|
2015-10-15 03:09:01 -04:00
|
|
|
|
2016-06-08 12:10:46 -04:00
|
|
|
belongs_to :project, inverse_of: :services
|
2012-11-19 13:14:05 -05:00
|
|
|
has_one :service_hook
|
|
|
|
|
2017-03-31 11:11:28 -04:00
|
|
|
validates :project_id, presence: true, unless: proc { |service| service.template? }
|
2017-04-25 11:47:57 -04:00
|
|
|
validates :type, presence: true
|
2013-01-03 02:52:14 -05:00
|
|
|
|
2017-02-14 09:15:41 -05:00
|
|
|
scope :visible, -> { where.not(type: 'GitlabIssueTrackerService') }
|
2016-01-19 07:48:07 -05:00
|
|
|
scope :issue_trackers, -> { where(category: 'issue_tracker') }
|
2016-07-21 04:36:02 -04:00
|
|
|
scope :external_wikis, -> { where(type: 'ExternalWikiService').active }
|
2016-01-19 07:48:07 -05:00
|
|
|
scope :active, -> { where(active: true) }
|
|
|
|
scope :without_defaults, -> { where(default: false) }
|
2015-01-28 17:25:55 -05:00
|
|
|
|
2015-02-19 00:02:57 -05:00
|
|
|
scope :push_hooks, -> { where(push_events: true, active: true) }
|
|
|
|
scope :tag_push_hooks, -> { where(tag_push_events: true, active: true) }
|
|
|
|
scope :issue_hooks, -> { where(issues_events: true, active: true) }
|
2016-08-30 18:11:46 -04:00
|
|
|
scope :confidential_issue_hooks, -> { where(confidential_issues_events: true, active: true) }
|
2015-02-19 00:02:57 -05:00
|
|
|
scope :merge_request_hooks, -> { where(merge_requests_events: true, active: true) }
|
2015-03-05 13:38:23 -05:00
|
|
|
scope :note_hooks, -> { where(note_events: true, active: true) }
|
2017-05-15 11:11:45 -04:00
|
|
|
scope :job_hooks, -> { where(job_events: true, active: true) }
|
2016-08-02 06:06:31 -04:00
|
|
|
scope :pipeline_hooks, -> { where(pipeline_events: true, active: true) }
|
2016-02-28 02:26:52 -05:00
|
|
|
scope :wiki_page_hooks, -> { where(wiki_page_events: true, active: true) }
|
2016-06-03 04:21:18 -04:00
|
|
|
scope :external_issue_trackers, -> { issue_trackers.active.without_defaults }
|
2015-02-19 00:02:57 -05:00
|
|
|
|
2016-01-19 07:48:07 -05:00
|
|
|
default_value_for :category, 'common'
|
|
|
|
|
2013-01-03 02:52:14 -05:00
|
|
|
def activated?
|
|
|
|
active
|
|
|
|
end
|
2013-05-22 09:58:44 -04:00
|
|
|
|
2017-07-05 08:07:03 -04:00
|
|
|
def show_active_box?
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
def editable?
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
2015-02-11 20:34:41 -05:00
|
|
|
def template?
|
|
|
|
template
|
|
|
|
end
|
|
|
|
|
2014-05-28 04:35:43 -04:00
|
|
|
def category
|
2016-01-19 07:48:07 -05:00
|
|
|
read_attribute(:category).to_sym
|
2014-05-28 04:35:43 -04:00
|
|
|
end
|
|
|
|
|
2014-09-11 11:48:29 -04:00
|
|
|
def initialize_properties
|
|
|
|
self.properties = {} if properties.nil?
|
|
|
|
end
|
|
|
|
|
2013-05-22 09:58:44 -04:00
|
|
|
def title
|
2013-05-22 10:59:43 -04:00
|
|
|
# implement inside child
|
2013-05-22 09:58:44 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def description
|
2013-05-22 10:59:43 -04:00
|
|
|
# implement inside child
|
2013-05-22 09:58:44 -04:00
|
|
|
end
|
|
|
|
|
2014-05-28 04:35:43 -04:00
|
|
|
def help
|
|
|
|
# implement inside child
|
|
|
|
end
|
|
|
|
|
2013-05-22 09:58:44 -04:00
|
|
|
def to_param
|
2013-05-22 10:59:43 -04:00
|
|
|
# implement inside child
|
2016-12-27 07:44:24 -05:00
|
|
|
self.class.to_param
|
2013-05-22 09:58:44 -04:00
|
|
|
end
|
|
|
|
|
2017-01-12 17:33:04 -05:00
|
|
|
def self.to_param
|
|
|
|
raise NotImplementedError
|
|
|
|
end
|
|
|
|
|
2013-05-22 09:58:44 -04:00
|
|
|
def fields
|
2013-05-22 10:59:43 -04:00
|
|
|
# implement inside child
|
2013-05-22 09:58:44 -04:00
|
|
|
[]
|
|
|
|
end
|
2013-05-22 10:59:43 -04:00
|
|
|
|
2016-07-12 17:19:47 -04:00
|
|
|
def test_data(project, user)
|
2016-08-12 04:09:29 -04:00
|
|
|
Gitlab::DataBuilder::Push.build_sample(project, user)
|
2016-07-12 17:19:47 -04:00
|
|
|
end
|
|
|
|
|
2016-07-12 16:00:49 -04:00
|
|
|
def event_channel_names
|
|
|
|
[]
|
|
|
|
end
|
|
|
|
|
2016-08-02 06:06:31 -04:00
|
|
|
def event_names
|
2016-12-27 07:44:24 -05:00
|
|
|
self.class.event_names
|
2016-08-02 06:06:31 -04:00
|
|
|
end
|
|
|
|
|
2017-01-12 17:33:04 -05:00
|
|
|
def self.event_names
|
|
|
|
self.supported_events.map { |event| "#{event}_events" }
|
|
|
|
end
|
|
|
|
|
2016-07-13 15:49:47 -04:00
|
|
|
def event_field(event)
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
|
|
|
def global_fields
|
|
|
|
fields
|
|
|
|
end
|
|
|
|
|
2015-02-28 11:33:18 -05:00
|
|
|
def supported_events
|
2016-12-27 07:44:24 -05:00
|
|
|
self.class.supported_events
|
2015-02-28 11:33:18 -05:00
|
|
|
end
|
|
|
|
|
2017-01-12 17:33:04 -05:00
|
|
|
def self.supported_events
|
|
|
|
%w(push tag_push issue confidential_issue merge_request wiki_page)
|
|
|
|
end
|
|
|
|
|
2015-08-12 03:40:54 -04:00
|
|
|
def execute(data)
|
2013-05-22 10:59:43 -04:00
|
|
|
# implement inside child
|
|
|
|
end
|
2013-08-09 14:14:02 -04:00
|
|
|
|
2015-08-12 03:40:54 -04:00
|
|
|
def test(data)
|
|
|
|
# default implementation
|
|
|
|
result = execute(data)
|
|
|
|
{ success: result.present?, result: result }
|
|
|
|
end
|
|
|
|
|
2013-08-09 14:14:02 -04:00
|
|
|
def can_test?
|
2017-04-24 11:23:51 -04:00
|
|
|
true
|
2013-08-09 14:14:02 -04:00
|
|
|
end
|
2014-09-07 20:54:18 -04:00
|
|
|
|
2016-07-12 17:19:47 -04:00
|
|
|
# reason why service cannot be tested
|
|
|
|
def disabled_title
|
|
|
|
"Please setup a project repository."
|
|
|
|
end
|
|
|
|
|
2014-09-07 20:54:18 -04:00
|
|
|
# Provide convenient accessor methods
|
|
|
|
# for each serialized property.
|
2015-10-15 03:09:01 -04:00
|
|
|
# Also keep track of updated properties in a similar way as ActiveModel::Dirty
|
2014-09-07 20:54:18 -04:00
|
|
|
def self.prop_accessor(*args)
|
|
|
|
args.each do |arg|
|
|
|
|
class_eval %{
|
|
|
|
def #{arg}
|
|
|
|
properties['#{arg}']
|
|
|
|
end
|
|
|
|
|
|
|
|
def #{arg}=(value)
|
2016-10-04 04:01:32 -04:00
|
|
|
self.properties ||= {}
|
2015-10-15 03:09:01 -04:00
|
|
|
updated_properties['#{arg}'] = #{arg} unless #{arg}_changed?
|
2014-09-07 20:54:18 -04:00
|
|
|
self.properties['#{arg}'] = value
|
|
|
|
end
|
2015-10-15 03:09:01 -04:00
|
|
|
|
|
|
|
def #{arg}_changed?
|
|
|
|
#{arg}_touched? && #{arg} != #{arg}_was
|
|
|
|
end
|
|
|
|
|
|
|
|
def #{arg}_touched?
|
|
|
|
updated_properties.include?('#{arg}')
|
|
|
|
end
|
|
|
|
|
|
|
|
def #{arg}_was
|
|
|
|
updated_properties['#{arg}']
|
|
|
|
end
|
2014-09-07 20:54:18 -04:00
|
|
|
}
|
|
|
|
end
|
|
|
|
end
|
2014-12-07 05:29:37 -05:00
|
|
|
|
2015-12-07 07:23:23 -05:00
|
|
|
# Provide convenient boolean accessor methods
|
|
|
|
# for each serialized property.
|
|
|
|
# Also keep track of updated properties in a similar way as ActiveModel::Dirty
|
|
|
|
def self.boolean_accessor(*args)
|
|
|
|
self.prop_accessor(*args)
|
|
|
|
|
|
|
|
args.each do |arg|
|
|
|
|
class_eval %{
|
2015-12-11 12:01:57 -05:00
|
|
|
def #{arg}?
|
|
|
|
ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(#{arg})
|
|
|
|
end
|
|
|
|
}
|
2015-12-07 07:23:23 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-10-15 03:09:01 -04:00
|
|
|
# Returns a hash of the properties that have been assigned a new value since last save,
|
|
|
|
# indicating their original values (attr => original value).
|
2016-01-19 07:48:07 -05:00
|
|
|
# ActiveRecord does not provide a mechanism to track changes in serialized keys,
|
2015-10-15 03:09:01 -04:00
|
|
|
# so we need a specific implementation for service properties.
|
|
|
|
# This allows to track changes to properties set with the accessor methods,
|
|
|
|
# but not direct manipulation of properties hash.
|
|
|
|
def updated_properties
|
|
|
|
@updated_properties ||= ActiveSupport::HashWithIndifferentAccess.new
|
2015-10-09 06:20:38 -04:00
|
|
|
end
|
|
|
|
|
2015-10-15 03:09:01 -04:00
|
|
|
def reset_updated_properties
|
|
|
|
@updated_properties = nil
|
|
|
|
end
|
2016-01-19 07:48:07 -05:00
|
|
|
|
2014-12-07 05:29:37 -05:00
|
|
|
def async_execute(data)
|
2015-02-28 11:33:18 -05:00
|
|
|
return unless supported_events.include?(data[:object_kind])
|
2015-03-17 22:06:43 -04:00
|
|
|
|
2014-12-07 05:29:37 -05:00
|
|
|
Sidekiq::Client.enqueue(ProjectServiceWorker, id, data)
|
|
|
|
end
|
2015-01-23 14:55:41 -05:00
|
|
|
|
|
|
|
def issue_tracker?
|
|
|
|
self.category == :issue_tracker
|
|
|
|
end
|
|
|
|
|
2015-02-12 12:19:55 -05:00
|
|
|
def self.available_services_names
|
2017-02-14 20:52:44 -05:00
|
|
|
service_names = %w[
|
2015-03-17 22:06:43 -04:00
|
|
|
asana
|
2015-04-09 16:37:07 -04:00
|
|
|
assembla
|
|
|
|
bamboo
|
2015-04-11 14:02:13 -04:00
|
|
|
buildkite
|
2016-06-26 13:36:43 -04:00
|
|
|
bugzilla
|
2015-04-09 16:37:07 -04:00
|
|
|
campfire
|
|
|
|
custom_issue_tracker
|
2015-08-26 19:58:49 -04:00
|
|
|
drone_ci
|
2015-03-17 22:06:43 -04:00
|
|
|
emails_on_push
|
2015-04-09 16:37:07 -04:00
|
|
|
external_wiki
|
|
|
|
flowdock
|
2015-03-17 22:06:43 -04:00
|
|
|
gemnasium
|
2015-04-09 16:37:07 -04:00
|
|
|
hipchat
|
|
|
|
irker
|
2015-03-17 22:06:43 -04:00
|
|
|
jira
|
2016-12-08 11:36:26 -05:00
|
|
|
kubernetes
|
2016-11-18 10:16:45 -05:00
|
|
|
mattermost_slash_commands
|
2016-12-20 16:29:39 -05:00
|
|
|
mattermost
|
2017-09-21 16:05:44 -04:00
|
|
|
packagist
|
2016-11-17 06:06:45 -05:00
|
|
|
pipelines_email
|
2015-04-09 16:37:07 -04:00
|
|
|
pivotaltracker
|
2017-03-07 11:57:42 -05:00
|
|
|
prometheus
|
2015-04-09 16:37:07 -04:00
|
|
|
pushover
|
2015-03-17 22:06:43 -04:00
|
|
|
redmine
|
2016-11-30 09:51:48 -05:00
|
|
|
slack_slash_commands
|
2016-12-20 16:14:33 -05:00
|
|
|
slack
|
2015-04-09 16:37:07 -04:00
|
|
|
teamcity
|
2017-04-03 11:37:23 -04:00
|
|
|
microsoft_teams
|
2016-08-31 14:16:03 -04:00
|
|
|
]
|
2017-04-05 07:04:34 -04:00
|
|
|
if Rails.env.development?
|
|
|
|
service_names += %w[mock_ci mock_deployment mock_monitoring]
|
|
|
|
end
|
2017-02-14 20:52:44 -05:00
|
|
|
|
|
|
|
service_names.sort_by(&:downcase)
|
2015-02-12 12:19:55 -05:00
|
|
|
end
|
|
|
|
|
2016-11-16 06:46:07 -05:00
|
|
|
def self.build_from_template(project_id, template)
|
2015-02-11 20:34:41 -05:00
|
|
|
service = template.dup
|
|
|
|
service.template = false
|
|
|
|
service.project_id = project_id
|
2016-11-16 06:46:07 -05:00
|
|
|
service
|
2015-01-23 14:55:41 -05:00
|
|
|
end
|
2016-06-03 04:21:18 -04:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def cache_project_has_external_issue_tracker
|
|
|
|
if project && !project.destroyed?
|
|
|
|
project.cache_has_external_issue_tracker
|
|
|
|
end
|
|
|
|
end
|
2016-07-17 10:32:11 -04:00
|
|
|
|
|
|
|
def cache_project_has_external_wiki
|
|
|
|
if project && !project.destroyed?
|
|
|
|
project.cache_has_external_wiki
|
|
|
|
end
|
|
|
|
end
|
2012-11-19 13:14:05 -05:00
|
|
|
end
|