2018-09-29 18:34:47 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-02-14 17:52:02 -05:00
|
|
|
module API
|
|
|
|
module Helpers
|
2017-02-15 19:30:46 -05:00
|
|
|
module Runner
|
2020-05-27 11:08:11 -04:00
|
|
|
include Gitlab::Utils::StrongMemoize
|
|
|
|
|
2019-09-13 09:26:31 -04:00
|
|
|
prepend_if_ee('EE::API::Helpers::Runner') # rubocop: disable Cop/InjectEnterpriseEditionModule
|
|
|
|
|
2019-09-10 04:11:43 -04:00
|
|
|
JOB_TOKEN_HEADER = 'HTTP_JOB_TOKEN'
|
2017-02-28 07:29:52 -05:00
|
|
|
JOB_TOKEN_PARAM = :token
|
2017-02-15 12:08:29 -05:00
|
|
|
|
2017-02-14 17:52:02 -05:00
|
|
|
def runner_registration_token_valid?
|
2019-06-25 13:54:42 -04:00
|
|
|
ActiveSupport::SecurityUtils.secure_compare(params[:token], Gitlab::CurrentSettings.runners_registration_token)
|
2017-02-14 17:52:02 -05:00
|
|
|
end
|
|
|
|
|
2018-02-22 01:03:00 -05:00
|
|
|
def authenticate_runner!
|
|
|
|
forbidden! unless current_runner
|
2017-11-14 04:02:39 -05:00
|
|
|
|
2018-02-22 01:03:00 -05:00
|
|
|
current_runner
|
2020-05-27 11:08:11 -04:00
|
|
|
.heartbeat(get_runner_details_from_request)
|
2017-02-14 17:52:02 -05:00
|
|
|
end
|
|
|
|
|
2018-02-22 01:03:00 -05:00
|
|
|
def get_runner_details_from_request
|
|
|
|
return get_runner_ip unless params['info'].present?
|
|
|
|
|
|
|
|
attributes_for_keys(%w(name version revision platform architecture), params['info'])
|
|
|
|
.merge(get_runner_ip)
|
|
|
|
end
|
2018-01-29 11:21:30 -05:00
|
|
|
|
2018-02-22 01:03:00 -05:00
|
|
|
def get_runner_ip
|
2019-07-24 10:15:50 -04:00
|
|
|
{ ip_address: ip_address }
|
2017-02-14 17:52:02 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def current_runner
|
2020-05-27 11:08:11 -04:00
|
|
|
strong_memoize(:current_runner) do
|
|
|
|
::Ci::Runner.find_by_token(params[:token].to_s)
|
|
|
|
end
|
2017-02-14 17:52:02 -05:00
|
|
|
end
|
2017-02-15 12:08:29 -05:00
|
|
|
|
2020-05-27 11:08:11 -04:00
|
|
|
def authenticate_job!(require_running: true)
|
|
|
|
job = current_job
|
2017-02-28 06:52:08 -05:00
|
|
|
|
2020-05-27 11:08:11 -04:00
|
|
|
not_found! unless job
|
|
|
|
forbidden! unless job_token_valid?(job)
|
2017-02-28 06:52:08 -05:00
|
|
|
|
2020-05-27 11:08:11 -04:00
|
|
|
forbidden!('Project has been deleted!') if job.project.nil? || job.project.pending_delete?
|
2017-02-28 06:52:08 -05:00
|
|
|
forbidden!('Job has been erased!') if job.erased?
|
2017-02-28 07:29:52 -05:00
|
|
|
|
2020-05-27 11:08:11 -04:00
|
|
|
if require_running
|
|
|
|
job_forbidden!(job, 'Job is not running') unless job.running?
|
|
|
|
end
|
2017-03-31 07:56:27 -04:00
|
|
|
|
2020-05-27 11:08:11 -04:00
|
|
|
if Gitlab::Ci::Features.job_heartbeats_runner?(job.project)
|
|
|
|
job.runner&.heartbeat(get_runner_ip)
|
2017-02-28 07:29:52 -05:00
|
|
|
end
|
2017-03-31 07:56:27 -04:00
|
|
|
|
|
|
|
job
|
2017-02-28 07:29:52 -05:00
|
|
|
end
|
|
|
|
|
2020-02-05 16:09:02 -05:00
|
|
|
def current_job
|
2020-05-27 11:08:11 -04:00
|
|
|
strong_memoize(:current_job) do
|
2020-06-25 20:09:13 -04:00
|
|
|
::Ci::Build.find_by_id(params[:id])
|
2020-05-27 11:08:11 -04:00
|
|
|
end
|
2020-02-05 16:09:02 -05:00
|
|
|
end
|
|
|
|
|
2017-02-28 07:29:52 -05:00
|
|
|
def job_token_valid?(job)
|
|
|
|
token = (params[JOB_TOKEN_PARAM] || env[JOB_TOKEN_HEADER]).to_s
|
|
|
|
token && job.valid_token?(token)
|
|
|
|
end
|
2017-02-28 08:27:25 -05:00
|
|
|
|
2018-06-07 11:27:26 -04:00
|
|
|
def job_forbidden!(job, reason)
|
|
|
|
header 'Job-Status', job.status
|
|
|
|
forbidden!(reason)
|
|
|
|
end
|
2017-02-14 17:52:02 -05:00
|
|
|
end
|
|
|
|
end
|
2017-02-15 19:20:17 -05:00
|
|
|
end
|