2015-08-25 21:42:46 -04:00
|
|
|
module Ci
|
|
|
|
class Runner < ActiveRecord::Base
|
2017-09-06 07:13:52 -04:00
|
|
|
extend Gitlab::Ci::Model
|
2017-11-24 05:45:19 -05:00
|
|
|
include Gitlab::SQL::Pattern
|
2015-10-12 15:12:31 -04:00
|
|
|
|
2016-12-16 11:42:35 -05:00
|
|
|
RUNNER_QUEUE_EXPIRY_TIME = 60.minutes
|
2017-05-27 11:14:34 -04:00
|
|
|
ONLINE_CONTACT_TIMEOUT = 1.hour
|
2017-02-21 18:32:18 -05:00
|
|
|
AVAILABLE_SCOPES = %w[specific shared active paused online].freeze
|
2017-08-16 12:54:05 -04:00
|
|
|
FORM_EDITABLE = %i[description tag_list active run_untagged locked access_level].freeze
|
2016-03-01 10:41:18 -05:00
|
|
|
|
2016-10-18 17:20:36 -04:00
|
|
|
has_many :builds
|
2017-06-08 11:16:27 -04:00
|
|
|
has_many :runner_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
2017-03-17 19:06:11 -04:00
|
|
|
has_many :projects, through: :runner_projects
|
2015-08-25 21:42:46 -04:00
|
|
|
|
|
|
|
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) }
|
2017-05-27 11:14:34 -04:00
|
|
|
scope :online, ->() { where('contacted_at > ?', contact_time_deadline) }
|
2015-10-23 12:15:13 -04:00
|
|
|
scope :ordered, ->() { order(id: :desc) }
|
2015-08-25 21:42:46 -04:00
|
|
|
|
2016-01-26 11:03:38 -05:00
|
|
|
scope :owned_or_shared, ->(project_id) do
|
2017-02-22 17:54:59 -05:00
|
|
|
joins('LEFT JOIN ci_runner_projects ON ci_runner_projects.runner_id = ci_runners.id')
|
2017-03-17 19:06:11 -04:00
|
|
|
.where("ci_runner_projects.project_id = :project_id OR ci_runners.is_shared = true", project_id: project_id)
|
2016-01-26 11:03:38 -05:00
|
|
|
end
|
|
|
|
|
2016-06-20 04:52:05 -04:00
|
|
|
scope :assignable_for, ->(project) do
|
2016-06-16 11:20:13 -04:00
|
|
|
# FIXME: That `to_sql` is needed to workaround a weird Rails bug.
|
|
|
|
# Without that, placeholders would miss one and couldn't match.
|
2017-06-21 09:48:12 -04:00
|
|
|
where(locked: false)
|
|
|
|
.where.not("id IN (#{project.runners.select(:id).to_sql})").specific
|
2016-06-02 06:41:26 -04:00
|
|
|
end
|
|
|
|
|
2016-05-18 12:38:21 -04:00
|
|
|
validate :tag_constraints
|
2017-08-31 05:28:29 -04:00
|
|
|
validates :access_level, presence: true
|
2016-05-05 08:27:06 -04:00
|
|
|
|
2015-08-25 21:42:46 -04:00
|
|
|
acts_as_taggable
|
|
|
|
|
2017-01-20 13:38:58 -05:00
|
|
|
after_destroy :cleanup_runner_queue
|
|
|
|
|
2017-08-16 10:13:43 -04:00
|
|
|
enum access_level: {
|
2017-08-29 02:56:03 -04:00
|
|
|
not_protected: 0,
|
|
|
|
ref_protected: 1
|
2017-08-16 10:13:43 -04:00
|
|
|
}
|
|
|
|
|
2016-03-01 10:41:18 -05:00
|
|
|
# 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.
|
2015-08-25 21:42:46 -04:00
|
|
|
def self.search(query)
|
2017-11-24 06:24:24 -05:00
|
|
|
fuzzy_search(query, [:token, :description])
|
2015-08-25 21:42:46 -04:00
|
|
|
end
|
|
|
|
|
2017-05-27 11:14:34 -04:00
|
|
|
def self.contact_time_deadline
|
|
|
|
ONLINE_CONTACT_TIMEOUT.ago
|
|
|
|
end
|
|
|
|
|
2015-08-25 21:42:46 -04:00
|
|
|
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
|
2016-06-14 11:11:43 -04:00
|
|
|
project.runner_projects.create(runner_id: self.id)
|
2015-08-25 21:42:46 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def display_name
|
2016-05-30 07:46:47 -04:00
|
|
|
return short_sha if description.blank?
|
2015-08-25 21:42:46 -04:00
|
|
|
|
|
|
|
description
|
|
|
|
end
|
|
|
|
|
|
|
|
def shared?
|
|
|
|
is_shared
|
|
|
|
end
|
|
|
|
|
2015-10-12 15:12:31 -04:00
|
|
|
def online?
|
2017-05-27 11:14:34 -04:00
|
|
|
contacted_at && contacted_at > self.class.contact_time_deadline
|
2015-10-12 15:12:31 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def status
|
|
|
|
if contacted_at.nil?
|
|
|
|
:not_connected
|
|
|
|
elsif active?
|
|
|
|
online? ? :online : :offline
|
|
|
|
else
|
|
|
|
:paused
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-08-25 21:42:46 -04:00
|
|
|
def belongs_to_one_project?
|
|
|
|
runner_projects.count == 1
|
|
|
|
end
|
|
|
|
|
|
|
|
def specific?
|
|
|
|
!shared?
|
|
|
|
end
|
|
|
|
|
2016-06-08 03:19:49 -04:00
|
|
|
def can_pick?(build)
|
2017-08-29 02:56:03 -04:00
|
|
|
return false if self.ref_protected? && !build.protected?
|
2017-08-28 08:10:01 -04:00
|
|
|
|
2017-11-30 17:17:41 -05:00
|
|
|
assignable_for?(build.project_id) && accepting_tags?(build)
|
2016-06-01 06:34:20 -04:00
|
|
|
end
|
|
|
|
|
2015-08-25 21:42:46 -04:00
|
|
|
def only_for?(project)
|
|
|
|
projects == [project]
|
|
|
|
end
|
|
|
|
|
|
|
|
def short_sha
|
2015-10-14 08:21:49 -04:00
|
|
|
token[0...8] if token
|
2015-08-25 21:42:46 -04:00
|
|
|
end
|
2016-05-06 02:47:19 -04:00
|
|
|
|
|
|
|
def has_tags?
|
|
|
|
tag_list.any?
|
|
|
|
end
|
2016-05-07 14:36:03 -04:00
|
|
|
|
2016-07-20 07:17:21 -04:00
|
|
|
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
|
|
|
|
|
2016-12-15 19:04:18 -05:00
|
|
|
def tick_runner_queue
|
2017-01-20 08:16:13 -05:00
|
|
|
SecureRandom.hex.tap do |new_update|
|
2017-03-06 05:44:45 -05:00
|
|
|
::Gitlab::Workhorse.set_key_and_notify(runner_queue_key, new_update,
|
2017-02-28 06:07:04 -05:00
|
|
|
expire: RUNNER_QUEUE_EXPIRY_TIME, overwrite: true)
|
2017-01-20 08:16:13 -05:00
|
|
|
end
|
2016-12-15 16:30:31 -05:00
|
|
|
end
|
|
|
|
|
2016-12-15 19:04:18 -05:00
|
|
|
def ensure_runner_queue_value
|
2017-03-06 05:44:45 -05:00
|
|
|
new_value = SecureRandom.hex
|
|
|
|
::Gitlab::Workhorse.set_key_and_notify(runner_queue_key, new_value,
|
|
|
|
expire: RUNNER_QUEUE_EXPIRY_TIME, overwrite: false)
|
2016-12-15 19:04:18 -05:00
|
|
|
end
|
|
|
|
|
2017-08-24 12:44:36 -04:00
|
|
|
def runner_queue_value_latest?(value)
|
2016-12-15 19:04:18 -05:00
|
|
|
ensure_runner_queue_value == value if value.present?
|
2016-12-15 16:30:31 -05:00
|
|
|
end
|
|
|
|
|
2016-05-07 14:36:03 -04:00
|
|
|
private
|
|
|
|
|
2017-01-20 13:38:58 -05:00
|
|
|
def cleanup_runner_queue
|
2017-07-10 23:35:47 -04:00
|
|
|
Gitlab::Redis::Queues.with do |redis|
|
2017-01-20 13:38:58 -05:00
|
|
|
redis.del(runner_queue_key)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-12-15 19:04:18 -05:00
|
|
|
def runner_queue_key
|
2016-12-16 10:33:08 -05:00
|
|
|
"runner:build_queue:#{self.token}"
|
2016-12-15 16:30:31 -05:00
|
|
|
end
|
|
|
|
|
2016-05-18 12:38:21 -04:00
|
|
|
def tag_constraints
|
2016-05-07 14:36:03 -04:00
|
|
|
unless has_tags? || run_untagged?
|
|
|
|
errors.add(:tags_list,
|
|
|
|
'can not be empty when runner is not allowed to pick untagged jobs')
|
|
|
|
end
|
|
|
|
end
|
2016-06-01 06:34:20 -04:00
|
|
|
|
2017-11-30 17:17:41 -05:00
|
|
|
def assignable_for?(project_id)
|
|
|
|
is_shared? || projects.exists?(id: project_id)
|
2016-06-01 06:34:20 -04:00
|
|
|
end
|
|
|
|
|
2016-06-08 03:43:43 -04:00
|
|
|
def accepting_tags?(build)
|
|
|
|
(run_untagged? || build.has_tags?) && (build.tag_list - tag_list).empty?
|
2016-06-01 06:34:20 -04:00
|
|
|
end
|
2015-08-25 21:42:46 -04:00
|
|
|
end
|
|
|
|
end
|