BigW Consortium Gitlab

runner.rb 3.85 KB
Newer Older
1 2 3
module Ci
  class Runner < ActiveRecord::Base
    extend Ci::Model
4

5
    LAST_CONTACT_TIME = 2.hours.ago
6
    AVAILABLE_SCOPES = %w[specific shared active paused online]
7
    FORM_EDITABLE = %i[description tag_list active run_untagged locked]
8

9 10
    has_many :builds, class_name: 'Ci::Build'
    has_many :runner_projects, dependent: :destroy, class_name: 'Ci::RunnerProject'
11
    has_many :projects, through: :runner_projects, class_name: '::Project', foreign_key: :gl_project_id
12 13 14 15 16 17 18 19 20

    has_one :last_build, ->() { order('id DESC') }, class_name: 'Ci::Build'

    before_validation :set_default_values

    scope :specific, ->() { where(is_shared: false) }
    scope :shared, ->() { where(is_shared: true) }
    scope :active, ->() { where(active: true) }
    scope :paused, ->() { where(active: false) }
21
    scope :online, ->() { where('contacted_at > ?', LAST_CONTACT_TIME) }
22
    scope :ordered, ->() { order(id: :desc) }
23

24 25
    scope :owned_or_shared, ->(project_id) do
      joins('LEFT JOIN ci_runner_projects ON ci_runner_projects.runner_id = ci_runners.id')
26
        .where("ci_runner_projects.gl_project_id = :project_id OR ci_runners.is_shared = true", project_id: project_id)
27 28
    end

Lin Jen-Shin committed
29
    scope :assignable_for, ->(project) do
30 31
      # FIXME: That `to_sql` is needed to workaround a weird Rails bug.
      #        Without that, placeholders would miss one and couldn't match.
32 33
      where(locked: false).
        where.not("id IN (#{project.runners.select(:id).to_sql})").specific
34 35
    end

36
    validate :tag_constraints
37

38 39
    acts_as_taggable

40 41 42 43 44 45 46 47 48 49 50 51
    # Searches for runners matching the given query.
    #
    # This method uses ILIKE on PostgreSQL and LIKE on MySQL.
    #
    # This method performs a *partial* match on tokens, thus a query for "a"
    # will match any runner where the token contains the letter "a". As a result
    # you should *not* use this method for non-admin purposes as otherwise users
    # might be able to query a list of all runners.
    #
    # query - The search query as a String
    #
    # Returns an ActiveRecord::Relation.
52
    def self.search(query)
53
      t = arel_table
54 55 56
      pattern = "%#{query}%"

      where(t[:token].matches(pattern).or(t[:description].matches(pattern)))
57 58 59 60 61 62 63 64 65
    end

    def set_default_values
      self.token = SecureRandom.hex(15) if self.token.blank?
    end

    def assign_to(project, current_user = nil)
      self.is_shared = false if shared?
      self.save
66
      project.runner_projects.create(runner_id: self.id)
67 68 69
    end

    def display_name
70
      return short_sha if description.blank?
71 72 73 74 75 76 77 78

      description
    end

    def shared?
      is_shared
    end

79 80 81 82 83 84 85 86 87 88 89 90 91 92
    def online?
      contacted_at && contacted_at > LAST_CONTACT_TIME
    end

    def status
      if contacted_at.nil?
        :not_connected
      elsif active?
        online? ? :online : :offline
      else
        :paused
      end
    end

93 94 95 96 97 98 99 100
    def belongs_to_one_project?
      runner_projects.count == 1
    end

    def specific?
      !shared?
    end

101
    def can_pick?(build)
Lin Jen-Shin committed
102
      assignable_for?(build.project) && accepting_tags?(build)
103 104
    end

105 106 107 108 109
    def only_for?(project)
      projects == [project]
    end

    def short_sha
Kamil Trzcinski committed
110
      token[0...8] if token
111
    end
112 113 114 115

    def has_tags?
      tag_list.any?
    end
116

117 118 119 120 121 122 123 124
    def predefined_variables
      [
        { key: 'CI_RUNNER_ID', value: id.to_s, public: true },
        { key: 'CI_RUNNER_DESCRIPTION', value: description, public: true },
        { key: 'CI_RUNNER_TAGS', value: tag_list.to_s, public: true }
      ]
    end

125 126
    private

127
    def tag_constraints
128 129 130 131 132
      unless has_tags? || run_untagged?
        errors.add(:tags_list,
          'can not be empty when runner is not allowed to pick untagged jobs')
      end
    end
133

Lin Jen-Shin committed
134
    def assignable_for?(project)
135 136 137
      !locked? || projects.exists?(id: project.id)
    end

138 139
    def accepting_tags?(build)
      (run_untagged? || build.has_tags?) && (build.tag_list - tag_list).empty?
140
    end
141 142
  end
end