401f65c43a
Add a new endpoint `projects/:id/jobs/artifacts/:ref_name/raw/*artifact_path?job=name` which is the close the web URL for consistency sake. This endpoint can be used to download a single file from artifacts for the specified ref and job. closes https://gitlab.com/gitlab-org/gitlab-ce/issues/54626
117 lines
3.7 KiB
Ruby
117 lines
3.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class JobArtifacts < Grape::API
|
|
before { authenticate_non_get! }
|
|
|
|
# EE::API::JobArtifacts would override the following helpers
|
|
helpers do
|
|
def authorize_download_artifacts!
|
|
authorize_read_builds!
|
|
end
|
|
end
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
end
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
desc 'Download the artifacts archive from a job' do
|
|
detail 'This feature was introduced in GitLab 8.10'
|
|
end
|
|
params do
|
|
requires :ref_name, type: String, desc: 'The ref from repository'
|
|
requires :job, type: String, desc: 'The name for the job'
|
|
end
|
|
route_setting :authentication, job_token_allowed: true
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
|
get ':id/jobs/artifacts/:ref_name/download',
|
|
requirements: { ref_name: /.+/ } do
|
|
authorize_download_artifacts!
|
|
|
|
builds = user_project.latest_successful_builds_for(params[:ref_name])
|
|
latest_build = builds.find_by!(name: params[:job])
|
|
|
|
present_carrierwave_file!(latest_build.artifacts_file)
|
|
end
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
|
|
|
desc 'Download a specific file from artifacts archive from a ref' do
|
|
detail 'This feature was introduced in GitLab 11.5'
|
|
end
|
|
params do
|
|
requires :ref_name, type: String, desc: 'The ref from repository'
|
|
requires :job, type: String, desc: 'The name for the job'
|
|
requires :artifact_path, type: String, desc: 'Artifact path'
|
|
end
|
|
get ':id/jobs/artifacts/:ref_name/raw/*artifact_path',
|
|
format: false,
|
|
requirements: { ref_name: /.+/ } do
|
|
authorize_download_artifacts!
|
|
|
|
build = user_project.latest_successful_build_for(params[:job], params[:ref_name])
|
|
|
|
path = Gitlab::Ci::Build::Artifacts::Path
|
|
.new(params[:artifact_path])
|
|
|
|
bad_request! unless path.valid?
|
|
|
|
send_artifacts_entry(build, path)
|
|
end
|
|
|
|
desc 'Download the artifacts archive from a job' do
|
|
detail 'This feature was introduced in GitLab 8.5'
|
|
end
|
|
params do
|
|
requires :job_id, type: Integer, desc: 'The ID of a job'
|
|
end
|
|
route_setting :authentication, job_token_allowed: true
|
|
get ':id/jobs/:job_id/artifacts' do
|
|
authorize_download_artifacts!
|
|
|
|
build = find_build!(params[:job_id])
|
|
|
|
present_carrierwave_file!(build.artifacts_file)
|
|
end
|
|
|
|
desc 'Download a specific file from artifacts archive' do
|
|
detail 'This feature was introduced in GitLab 10.0'
|
|
end
|
|
params do
|
|
requires :job_id, type: Integer, desc: 'The ID of a job'
|
|
requires :artifact_path, type: String, desc: 'Artifact path'
|
|
end
|
|
get ':id/jobs/:job_id/artifacts/*artifact_path', format: false do
|
|
authorize_read_builds!
|
|
|
|
build = find_build!(params[:job_id])
|
|
not_found! unless build.artifacts?
|
|
|
|
path = Gitlab::Ci::Build::Artifacts::Path
|
|
.new(params[:artifact_path])
|
|
|
|
bad_request! unless path.valid?
|
|
|
|
send_artifacts_entry(build, path)
|
|
end
|
|
|
|
desc 'Keep the artifacts to prevent them from being deleted' do
|
|
success Entities::Job
|
|
end
|
|
params do
|
|
requires :job_id, type: Integer, desc: 'The ID of a job'
|
|
end
|
|
post ':id/jobs/:job_id/artifacts/keep' do
|
|
authorize_update_builds!
|
|
|
|
build = find_build!(params[:job_id])
|
|
authorize!(:update_build, build)
|
|
break not_found!(build) unless build.artifacts?
|
|
|
|
build.keep_artifacts!
|
|
|
|
status 200
|
|
present build, with: Entities::Job
|
|
end
|
|
end
|
|
end
|
|
end
|