Merge branch 'mc/feature/expose-artifacts-locked' into 'master'

Consider artifact locking when exposing artifact information

See merge request gitlab-org/gitlab!32787

app/models/ci/build.rb

@@ -777,6 +777,8 @@ module Ci
     end
 
     def artifacts_expired?
+      return false if artifacts_locked?
+
       artifacts_expire_at && artifacts_expire_at < Time.current
     end
 
@@ -958,6 +960,10 @@ module Ci
 
     private
 
+    def artifacts_locked?
+      job_artifacts_archive&.locked?
+    end
+
     def dependencies
       strong_memoize(:dependencies) do
         Ci::BuildDependencies.new(self)
@@ -1027,6 +1033,8 @@ module Ci
     end
 
     def has_expiring_artifacts?
+      return false if artifacts_locked?
+
       artifacts_expire_at.present? && artifacts_expire_at > Time.current
     end
 

app/serializers/build_artifact_entity.rb

@@ -23,6 +23,10 @@ class BuildArtifactEntity < Grape::Entity
     fast_browse_project_job_artifacts_path(project, job)
   end
 
+  expose :locked, if: -> (*) { job.job_artifacts_archive.present? } do |job|
+    job.job_artifacts_archive.locked?
+  end
+
   private
 
   alias_method :job, :object

app/serializers/build_details_entity.rb

@@ -46,6 +46,10 @@ class BuildDetailsEntity < JobEntity
     expose :expired, if: -> (*) { build.artifacts_expire_at.present? } do |build|
       build.artifacts_expired?
     end
+
+    expose :locked, if: -> (*) { build.job_artifacts_archive.present? } do |build|
+      build.job_artifacts_archive.locked?
+    end
   end
 
   expose :report_artifacts,

spec/fixtures/api/schemas/job/artifact.json

@@ -5,7 +5,8 @@
     "browse_path": { "type": "string"},
     "keep_path": { "type": "string"},
     "expired": { "type": "boolean" },
-    "expire_at": { "type": "string", "format": "date-time" }
+    "expire_at": { "type": "string", "format": "date-time" },
+    "locked": { "type": "boolean" }
   },
   "additionalProperties": false
 }

spec/models/ci/build_spec.rb

@@ -590,22 +590,28 @@ describe Ci::Build do
   describe '#artifacts?' do
     subject { build.artifacts? }
 
-    context 'when new artifacts are used' do
-      context 'artifacts archive does not exist' do
-        let(:build) { create(:ci_build) }
+    context 'artifacts archive does not exist' do
+      let(:build) { create(:ci_build) }
 
-        it { is_expected.to be_falsy }
-      end
+      it { is_expected.to be_falsy }
+    end
 
-      context 'artifacts archive exists' do
-        let(:build) { create(:ci_build, :artifacts) }
+    context 'artifacts archive exists' do
+      let(:build) { create(:ci_build, :artifacts) }
 
-        it { is_expected.to be_truthy }
+      it { is_expected.to be_truthy }
+
+      context 'is expired' do
+        let(:build) { create(:ci_build, :artifacts, :expired) }
+
+        it { is_expected.to be_falsy }
 
-        context 'is expired' do
-          let(:build) { create(:ci_build, :artifacts, :expired) }
+        context 'is locked' do
+          before do
+            build.job_artifacts_archive.update(locked: true)
+          end
 
-          it { is_expected.to be_falsy }
+          it { is_expected.to be_truthy }
         end
       end
     end
@@ -630,6 +636,14 @@ describe Ci::Build do
       end
 
       it { is_expected.to be_truthy }
+
+      context 'is locked' do
+        before do
+          create(:ci_job_artifact, :archive, job: build, locked: true)
+        end
+
+        it { is_expected.to be_falsey }
+      end
     end
 
     context 'is not expired' do
@@ -2252,6 +2266,16 @@ describe Ci::Build do
         it 'has expiring artifacts' do
           expect(build).to have_expiring_archive_artifacts
         end
+
+        context 'and job artifacts are locked' do
+          before do
+            archive.update(locked: true)
+          end
+
+          it 'does not have expiring artifacts' do
+            expect(build).not_to have_expiring_archive_artifacts
+          end
+        end
       end
 
       context 'and job artifacts archive record does not exist' do

spec/serializers/build_artifact_entity_spec.rb

@@ -30,5 +30,9 @@ describe BuildArtifactEntity do
       expect(subject[:browse_path])
         .to include "jobs/#{job.id}/artifacts/browse"
     end
+
+    it 'exposes locked information about artifact' do
+      expect(subject).to include(:locked)
+    end
   end
 end

spec/serializers/build_details_entity_spec.rb

@@ -190,7 +190,7 @@ describe BuildDetailsEntity do
       let!(:report) { create(:ci_job_artifact, :codequality, job: build) }
 
       it 'exposes artifact details' do
-        expect(subject[:artifact].keys).to include(:download_path, :browse_path, :keep_path, :expire_at, :expired)
+        expect(subject[:artifact].keys).to include(:download_path, :browse_path, :keep_path, :expire_at, :expired, :locked)
       end
     end
   end