BigW Consortium Gitlab

ci_service.rb 2.24 KB
Newer Older
Dmitriy Zaporozhets committed
1 2 3 4
# == Schema Information
#
# Table name: services
#
5 6 7 8 9 10 11 12 13 14 15 16 17
#  id                    :integer          not null, primary key
#  type                  :string(255)
#  title                 :string(255)
#  project_id            :integer
#  created_at            :datetime
#  updated_at            :datetime
#  active                :boolean          default(FALSE), not null
#  properties            :text
#  template              :boolean          default(FALSE)
#  push_events           :boolean          default(TRUE)
#  issues_events         :boolean          default(TRUE)
#  merge_requests_events :boolean          default(TRUE)
#  tag_push_events       :boolean          default(TRUE)
Stan Hu committed
18
#  note_events           :boolean          default(TRUE), not null
Stan Hu committed
19
#  build_events          :boolean          default(FALSE), not null
Dmitriy Zaporozhets committed
20 21
#

22 23 24 25
# Base class for CI services
# List methods you need to implement to get your CI service
# working with GitLab Merge Requests
class CiService < Service
26 27
  default_value_for :category, 'ci'

Kirilll Zaitsev committed
28
  def valid_token?(token)
29
    self.respond_to?(:token) && self.token.present? && ActiveSupport::SecurityUtils.variable_size_secure_compare(token, self.token)
Kirilll Zaitsev committed
30
  end
31

32 33 34 35
  def supported_events
    %w(push)
  end

Kirilll Zaitsev committed
36 37 38 39 40 41 42 43 44
  def merge_request_page(iid, sha, ref)
    commit_page(sha, ref)
  end

  def commit_page(sha, ref)
    build_page(sha, ref)
  end

  # Return complete url to merge_request page
45 46 47 48
  #
  # Ex.
  #   http://jenkins.example.com:8888/job/test1/scm/bySHA1/12d65c
  #
Valery Sizov committed
49
  def build_page(sha, ref)
50 51 52 53 54
    # implement inside child
  end

  # Return string with build status or :error symbol
  #
55
  # Allowed states: 'success', 'failed', 'running', 'pending', 'skipped'
56 57 58
  #
  #
  # Ex.
Kirilll Zaitsev committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
  #   @service.merge_request_status(9, '13be4ac', 'dev')
  #   # => 'success'
  #
  #   @service.merge_request_status(10, '2abe4ac', 'dev)
  #   # => 'running'
  #
  #
  def merge_request_status(iid, sha, ref)
    commit_status(sha, ref)
  end

  # Return string with build status or :error symbol
  #
  # Allowed states: 'success', 'failed', 'running', 'pending', 'skipped'
  #
  #
  # Ex.
  #   @service.commit_status('13be4ac', 'master')
77 78
  #   # => 'success'
  #
Kirilll Zaitsev committed
79
  #   @service.commit_status('2abe4ac', 'dev')
80 81 82
  #   # => 'running'
  #
  #
Valery Sizov committed
83
  def commit_status(sha, ref)
84 85 86
    # implement inside child
  end
end