gitlab-org--gitlab-foss/app/models/integrations/base_ci.rb

# frozen_string_literal: true

# Base class for CI integrations
# List methods you need to implement to get your CI integration
# working with GitLab merge requests
module Integrations
  class BaseCi < Integration
    default_value_for :category, 'ci'

    def valid_token?(token)
      self.respond_to?(:token) && self.token.present? && ActiveSupport::SecurityUtils.secure_compare(token, self.token)
    end

    def self.supported_events
      %w[push]
    end

    # Return complete url to build page
    #
    # Ex.
    #   http://jenkins.example.com:8888/job/test1/scm/bySHA1/12d65c
    #
    def build_page(sha, ref)
      # implement inside child
    end

    # Return string with build status or :error symbol
    #
    # Allowed states: 'success', 'failed', 'running', 'pending', 'skipped'
    #
    #
    # Ex.
    #   @integration.commit_status('13be4ac', 'master')
    #   # => 'success'
    #
    #   @integration.commit_status('2abe4ac', 'dev')
    #   # => 'running'
    #
    #
    def commit_status(sha, ref)
      # implement inside child
    end
  end
end