2013-05-22 13:58:44 +00:00
|
|
|
# To add new service you should build a class inherited from Service
|
|
|
|
# and implement a set of methods
|
2012-11-19 18:14:05 +00:00
|
|
|
class Service < ActiveRecord::Base
|
2015-02-05 22:20:55 +00:00
|
|
|
include Sortable
|
2018-01-25 15:21:23 +00:00
|
|
|
include Importable
|
|
|
|
|
2017-07-03 14:01:41 +00:00
|
|
|
serialize :properties, JSON # rubocop:disable Cop/ActiveRecordSerialize
|
2014-09-08 00:54:18 +00:00
|
|
|
|
2014-02-26 08:41:44 +00:00
|
|
|
default_value_for :active, false
|
2015-02-19 05:02:57 +00:00
|
|
|
default_value_for :push_events, true
|
|
|
|
default_value_for :issues_events, true
|
2016-08-30 21:39:25 +00:00
|
|
|
default_value_for :confidential_issues_events, true
|
2016-11-14 21:30:01 +00:00
|
|
|
default_value_for :commit_events, true
|
2015-02-19 05:02:57 +00:00
|
|
|
default_value_for :merge_requests_events, true
|
|
|
|
default_value_for :tag_push_events, true
|
2015-03-05 18:38:23 +00:00
|
|
|
default_value_for :note_events, true
|
2018-04-03 11:00:33 +00:00
|
|
|
default_value_for :confidential_note_events, true
|
2017-05-15 15:11:45 +00:00
|
|
|
default_value_for :job_events, true
|
2016-09-09 12:32:06 +00:00
|
|
|
default_value_for :pipeline_events, true
|
2016-02-28 07:26:52 +00:00
|
|
|
default_value_for :wiki_page_events, true
|
2014-09-11 15:48:29 +00:00
|
|
|
|
|
|
|
after_initialize :initialize_properties
|
2014-02-26 08:41:44 +00:00
|
|
|
|
2015-10-15 07:09:01 +00:00
|
|
|
after_commit :reset_updated_properties
|
2016-06-03 08:21:18 +00:00
|
|
|
after_commit :cache_project_has_external_issue_tracker
|
2016-07-17 14:32:11 +00:00
|
|
|
after_commit :cache_project_has_external_wiki
|
2015-10-15 07:09:01 +00:00
|
|
|
|
2016-06-08 16:10:46 +00:00
|
|
|
belongs_to :project, inverse_of: :services
|
2012-11-19 18:14:05 +00:00
|
|
|
has_one :service_hook
|
|
|
|
|
2017-03-31 15:11:28 +00:00
|
|
|
validates :project_id, presence: true, unless: proc { |service| service.template? }
|
2017-04-25 15:47:57 +00:00
|
|
|
validates :type, presence: true
|
2013-01-03 07:52:14 +00:00
|
|
|
|
2017-02-14 14:15:41 +00:00
|
|
|
scope :visible, -> { where.not(type: 'GitlabIssueTrackerService') }
|
2016-01-19 12:48:07 +00:00
|
|
|
scope :issue_trackers, -> { where(category: 'issue_tracker') }
|
2016-07-21 08:36:02 +00:00
|
|
|
scope :external_wikis, -> { where(type: 'ExternalWikiService').active }
|
2016-01-19 12:48:07 +00:00
|
|
|
scope :active, -> { where(active: true) }
|
|
|
|
scope :without_defaults, -> { where(default: false) }
|
2015-01-28 22:25:55 +00:00
|
|
|
|
2015-02-19 05:02:57 +00: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 22:11:46 +00:00
|
|
|
scope :confidential_issue_hooks, -> { where(confidential_issues_events: true, active: true) }
|
2015-02-19 05:02:57 +00:00
|
|
|
scope :merge_request_hooks, -> { where(merge_requests_events: true, active: true) }
|
2015-03-05 18:38:23 +00:00
|
|
|
scope :note_hooks, -> { where(note_events: true, active: true) }
|
2018-04-03 11:00:33 +00:00
|
|
|
scope :confidential_note_hooks, -> { where(confidential_note_events: true, active: true) }
|
2017-05-15 15:11:45 +00:00
|
|
|
scope :job_hooks, -> { where(job_events: true, active: true) }
|
2016-08-02 10:06:31 +00:00
|
|
|
scope :pipeline_hooks, -> { where(pipeline_events: true, active: true) }
|
2016-02-28 07:26:52 +00:00
|
|
|
scope :wiki_page_hooks, -> { where(wiki_page_events: true, active: true) }
|
2016-06-03 08:21:18 +00:00
|
|
|
scope :external_issue_trackers, -> { issue_trackers.active.without_defaults }
|
2018-01-04 22:35:41 +00:00
|
|
|
scope :deployment, -> { where(category: 'deployment') }
|
2015-02-19 05:02:57 +00:00
|
|
|
|
2016-01-19 12:48:07 +00:00
|
|
|
default_value_for :category, 'common'
|
|
|
|
|
2013-01-03 07:52:14 +00:00
|
|
|
def activated?
|
|
|
|
active
|
|
|
|
end
|
2013-05-22 13:58:44 +00:00
|
|
|
|
2017-07-05 12:07:03 +00:00
|
|
|
def show_active_box?
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
def editable?
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
2015-02-12 01:34:41 +00:00
|
|
|
def template?
|
|
|
|
template
|
|
|
|
end
|
|
|
|
|
2014-05-28 08:35:43 +00:00
|
|
|
def category
|
2016-01-19 12:48:07 +00:00
|
|
|
read_attribute(:category).to_sym
|
2014-05-28 08:35:43 +00:00
|
|
|
end
|
|
|
|
|
2014-09-11 15:48:29 +00:00
|
|
|
def initialize_properties
|
|
|
|
self.properties = {} if properties.nil?
|
|
|
|
end
|
|
|
|
|
2013-05-22 13:58:44 +00:00
|
|
|
def title
|
2013-05-22 14:59:43 +00:00
|
|
|
# implement inside child
|
2013-05-22 13:58:44 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def description
|
2013-05-22 14:59:43 +00:00
|
|
|
# implement inside child
|
2013-05-22 13:58:44 +00:00
|
|
|
end
|
|
|
|
|
2014-05-28 08:35:43 +00:00
|
|
|
def help
|
|
|
|
# implement inside child
|
|
|
|
end
|
|
|
|
|
2013-05-22 13:58:44 +00:00
|
|
|
def to_param
|
2013-05-22 14:59:43 +00:00
|
|
|
# implement inside child
|
2016-12-27 12:44:24 +00:00
|
|
|
self.class.to_param
|
2013-05-22 13:58:44 +00:00
|
|
|
end
|
|
|
|
|
2017-01-12 22:33:04 +00:00
|
|
|
def self.to_param
|
|
|
|
raise NotImplementedError
|
|
|
|
end
|
|
|
|
|
2013-05-22 13:58:44 +00:00
|
|
|
def fields
|
2013-05-22 14:59:43 +00:00
|
|
|
# implement inside child
|
2013-05-22 13:58:44 +00:00
|
|
|
[]
|
|
|
|
end
|
2013-05-22 14:59:43 +00:00
|
|
|
|
2016-07-12 21:19:47 +00:00
|
|
|
def test_data(project, user)
|
2016-08-12 08:09:29 +00:00
|
|
|
Gitlab::DataBuilder::Push.build_sample(project, user)
|
2016-07-12 21:19:47 +00:00
|
|
|
end
|
|
|
|
|
2016-07-12 20:00:49 +00:00
|
|
|
def event_channel_names
|
|
|
|
[]
|
|
|
|
end
|
|
|
|
|
2016-08-02 10:06:31 +00:00
|
|
|
def event_names
|
2016-12-27 12:44:24 +00:00
|
|
|
self.class.event_names
|
2016-08-02 10:06:31 +00:00
|
|
|
end
|
|
|
|
|
2017-01-12 22:33:04 +00:00
|
|
|
def self.event_names
|
|
|
|
self.supported_events.map { |event| "#{event}_events" }
|
|
|
|
end
|
|
|
|
|
2016-07-13 19:49:47 +00:00
|
|
|
def event_field(event)
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2018-01-06 06:18:13 +00:00
|
|
|
def api_field_names
|
|
|
|
fields.map { |field| field[:name] }
|
|
|
|
.reject { |field_name| field_name =~ /(password|token|key)/ }
|
|
|
|
end
|
|
|
|
|
2016-07-13 19:49:47 +00:00
|
|
|
def global_fields
|
|
|
|
fields
|
|
|
|
end
|
|
|
|
|
2018-03-06 23:20:01 +00:00
|
|
|
def configurable_events
|
|
|
|
events = self.class.supported_events
|
|
|
|
|
|
|
|
# No need to disable individual triggers when there is only one
|
|
|
|
if events.count == 1
|
|
|
|
[]
|
|
|
|
else
|
|
|
|
events
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-02-28 16:33:18 +00:00
|
|
|
def supported_events
|
2016-12-27 12:44:24 +00:00
|
|
|
self.class.supported_events
|
2015-02-28 16:33:18 +00:00
|
|
|
end
|
|
|
|
|
2017-01-12 22:33:04 +00:00
|
|
|
def self.supported_events
|
|
|
|
%w(push tag_push issue confidential_issue merge_request wiki_page)
|
|
|
|
end
|
|
|
|
|
2015-08-12 07:40:54 +00:00
|
|
|
def execute(data)
|
2013-05-22 14:59:43 +00:00
|
|
|
# implement inside child
|
|
|
|
end
|
2013-08-09 18:14:02 +00:00
|
|
|
|
2015-08-12 07:40:54 +00:00
|
|
|
def test(data)
|
|
|
|
# default implementation
|
|
|
|
result = execute(data)
|
|
|
|
{ success: result.present?, result: result }
|
|
|
|
end
|
|
|
|
|
2013-08-09 18:14:02 +00:00
|
|
|
def can_test?
|
2017-04-24 15:23:51 +00:00
|
|
|
true
|
2013-08-09 18:14:02 +00:00
|
|
|
end
|
2014-09-08 00:54:18 +00:00
|
|
|
|
|
|
|
# Provide convenient accessor methods
|
|
|
|
# for each serialized property.
|
2015-10-15 07:09:01 +00:00
|
|
|
# Also keep track of updated properties in a similar way as ActiveModel::Dirty
|
2014-09-08 00:54:18 +00:00
|
|
|
def self.prop_accessor(*args)
|
|
|
|
args.each do |arg|
|
|
|
|
class_eval %{
|
2018-04-03 11:00:33 +00:00
|
|
|
unless method_defined?(arg)
|
|
|
|
def #{arg}
|
|
|
|
properties['#{arg}']
|
|
|
|
end
|
2014-09-08 00:54:18 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def #{arg}=(value)
|
2016-10-04 08:01:32 +00:00
|
|
|
self.properties ||= {}
|
2015-10-15 07:09:01 +00:00
|
|
|
updated_properties['#{arg}'] = #{arg} unless #{arg}_changed?
|
2014-09-08 00:54:18 +00:00
|
|
|
self.properties['#{arg}'] = value
|
|
|
|
end
|
2015-10-15 07:09:01 +00: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-08 00:54:18 +00:00
|
|
|
}
|
|
|
|
end
|
|
|
|
end
|
2014-12-07 10:29:37 +00:00
|
|
|
|
2015-12-07 12:23:23 +00: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 17:01:57 +00:00
|
|
|
def #{arg}?
|
2018-04-07 22:48:38 +00:00
|
|
|
if Gitlab.rails5?
|
|
|
|
!ActiveModel::Type::Boolean::FALSE_VALUES.include?(#{arg})
|
|
|
|
else
|
|
|
|
ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(#{arg})
|
|
|
|
end
|
2015-12-11 17:01:57 +00:00
|
|
|
end
|
|
|
|
}
|
2015-12-07 12:23:23 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-10-15 07:09:01 +00: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 12:48:07 +00:00
|
|
|
# ActiveRecord does not provide a mechanism to track changes in serialized keys,
|
2015-10-15 07:09:01 +00: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 10:20:38 +00:00
|
|
|
end
|
|
|
|
|
2015-10-15 07:09:01 +00:00
|
|
|
def reset_updated_properties
|
|
|
|
@updated_properties = nil
|
|
|
|
end
|
2016-01-19 12:48:07 +00:00
|
|
|
|
2014-12-07 10:29:37 +00:00
|
|
|
def async_execute(data)
|
2015-02-28 16:33:18 +00:00
|
|
|
return unless supported_events.include?(data[:object_kind])
|
2015-03-18 02:06:43 +00:00
|
|
|
|
2017-11-29 15:30:17 +00:00
|
|
|
ProjectServiceWorker.perform_async(id, data)
|
2014-12-07 10:29:37 +00:00
|
|
|
end
|
2015-01-23 19:55:41 +00:00
|
|
|
|
|
|
|
def issue_tracker?
|
|
|
|
self.category == :issue_tracker
|
|
|
|
end
|
|
|
|
|
2015-02-12 17:19:55 +00:00
|
|
|
def self.available_services_names
|
2017-02-15 01:52:44 +00:00
|
|
|
service_names = %w[
|
2015-03-18 02:06:43 +00:00
|
|
|
asana
|
2015-04-09 20:37:07 +00:00
|
|
|
assembla
|
|
|
|
bamboo
|
2015-04-11 18:02:13 +00:00
|
|
|
buildkite
|
2016-06-26 17:36:43 +00:00
|
|
|
bugzilla
|
2015-04-09 20:37:07 +00:00
|
|
|
campfire
|
|
|
|
custom_issue_tracker
|
2015-08-26 23:58:49 +00:00
|
|
|
drone_ci
|
2015-03-18 02:06:43 +00:00
|
|
|
emails_on_push
|
2015-04-09 20:37:07 +00:00
|
|
|
external_wiki
|
|
|
|
flowdock
|
2015-03-18 02:06:43 +00:00
|
|
|
gemnasium
|
2015-04-09 20:37:07 +00:00
|
|
|
hipchat
|
|
|
|
irker
|
2015-03-18 02:06:43 +00:00
|
|
|
jira
|
2016-12-08 16:36:26 +00:00
|
|
|
kubernetes
|
2016-11-18 15:16:45 +00:00
|
|
|
mattermost_slash_commands
|
2016-12-20 21:29:39 +00:00
|
|
|
mattermost
|
2017-09-21 20:05:44 +00:00
|
|
|
packagist
|
2016-11-17 11:06:45 +00:00
|
|
|
pipelines_email
|
2015-04-09 20:37:07 +00:00
|
|
|
pivotaltracker
|
2017-03-07 16:57:42 +00:00
|
|
|
prometheus
|
2015-04-09 20:37:07 +00:00
|
|
|
pushover
|
2015-03-18 02:06:43 +00:00
|
|
|
redmine
|
2016-11-30 14:51:48 +00:00
|
|
|
slack_slash_commands
|
2016-12-20 21:14:33 +00:00
|
|
|
slack
|
2015-04-09 20:37:07 +00:00
|
|
|
teamcity
|
2017-04-03 15:37:23 +00:00
|
|
|
microsoft_teams
|
2016-08-31 18:16:03 +00:00
|
|
|
]
|
2018-01-11 16:34:01 +00:00
|
|
|
|
2017-04-05 11:04:34 +00:00
|
|
|
if Rails.env.development?
|
|
|
|
service_names += %w[mock_ci mock_deployment mock_monitoring]
|
|
|
|
end
|
2017-02-15 01:52:44 +00:00
|
|
|
|
|
|
|
service_names.sort_by(&:downcase)
|
2015-02-12 17:19:55 +00:00
|
|
|
end
|
|
|
|
|
2016-11-16 11:46:07 +00:00
|
|
|
def self.build_from_template(project_id, template)
|
2015-02-12 01:34:41 +00:00
|
|
|
service = template.dup
|
2018-03-27 15:33:29 +00:00
|
|
|
service.active = false unless service.valid?
|
2015-02-12 01:34:41 +00:00
|
|
|
service.template = false
|
|
|
|
service.project_id = project_id
|
2016-11-16 11:46:07 +00:00
|
|
|
service
|
2015-01-23 19:55:41 +00:00
|
|
|
end
|
2016-06-03 08:21:18 +00:00
|
|
|
|
2018-01-04 09:33:51 +00:00
|
|
|
def deprecated?
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
|
|
|
def deprecation_message
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2018-01-04 22:35:41 +00:00
|
|
|
def self.find_by_template
|
|
|
|
find_by(template: true)
|
|
|
|
end
|
|
|
|
|
2016-06-03 08:21:18 +00:00
|
|
|
private
|
|
|
|
|
|
|
|
def cache_project_has_external_issue_tracker
|
|
|
|
if project && !project.destroyed?
|
|
|
|
project.cache_has_external_issue_tracker
|
|
|
|
end
|
|
|
|
end
|
2016-07-17 14:32:11 +00:00
|
|
|
|
|
|
|
def cache_project_has_external_wiki
|
|
|
|
if project && !project.destroyed?
|
|
|
|
project.cache_has_external_wiki
|
|
|
|
end
|
|
|
|
end
|
2018-01-26 13:48:47 +00:00
|
|
|
|
2018-03-16 19:09:35 +00:00
|
|
|
def self.event_description(event)
|
|
|
|
case event
|
|
|
|
when "push", "push_events"
|
|
|
|
"Event will be triggered by a push to the repository"
|
|
|
|
when "tag_push", "tag_push_events"
|
|
|
|
"Event will be triggered when a new tag is pushed to the repository"
|
|
|
|
when "note", "note_events"
|
|
|
|
"Event will be triggered when someone adds a comment"
|
|
|
|
when "issue", "issue_events"
|
|
|
|
"Event will be triggered when an issue is created/updated/closed"
|
|
|
|
when "confidential_issue", "confidential_issue_events"
|
|
|
|
"Event will be triggered when a confidential issue is created/updated/closed"
|
|
|
|
when "merge_request", "merge_request_events"
|
|
|
|
"Event will be triggered when a merge request is created/updated/merged"
|
|
|
|
when "pipeline", "pipeline_events"
|
|
|
|
"Event will be triggered when a pipeline status changes"
|
|
|
|
when "wiki_page", "wiki_page_events"
|
|
|
|
"Event will be triggered when a wiki page is created/updated"
|
|
|
|
when "commit", "commit_events"
|
|
|
|
"Event will be triggered when a commit is created/updated"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-01-26 13:48:47 +00:00
|
|
|
def valid_recipients?
|
|
|
|
activated? && !importing?
|
|
|
|
end
|
2012-11-19 18:14:05 +00:00
|
|
|
end
|