Merge branch 'persist-fulll-ref-path-for-mr-pipelines' into 'master'

Use merge request HEAD ref for detached merge request pipelines

Closes #58454

See merge request gitlab-org/gitlab-ce!25504

10 files changed, 294 insertions, 18 deletions

diff --git a/spec/factories/merge_requests.rb b/spec/factories/merge_requests.rb
index a1809a26265..abf0e6bccb7 100644
--- a/spec/factories/merge_requests.rb
+++ b/spec/factories/merge_requests.rb
@@ -117,9 +117,20 @@ FactoryBot.define do
       end
     end
 
+    trait :with_legacy_detached_merge_request_pipeline do
+      after(:create) do |merge_request|
+        merge_request.merge_request_pipelines << create(:ci_pipeline,
+          source: :merge_request_event,
+          merge_request: merge_request,
+          project: merge_request.source_project,
+          ref: merge_request.source_branch,
+          sha: merge_request.source_branch_sha)
+      end
+    end
+
     trait :with_detached_merge_request_pipeline do
-      after(:build) do |merge_request|
-        merge_request.merge_request_pipelines << build(:ci_pipeline,
+      after(:create) do |merge_request|
+        merge_request.merge_request_pipelines << create(:ci_pipeline,
           source: :merge_request_event,
           merge_request: merge_request,
           project: merge_request.source_project,
@@ -135,7 +146,7 @@ FactoryBot.define do
         target_sha { target_branch_sha }
       end
 
-      after(:build) do |merge_request, evaluator|
+      after(:create) do |merge_request, evaluator|
         merge_request.merge_request_pipelines << create(:ci_pipeline,
           source: :merge_request_event,
           merge_request: merge_request,
diff --git a/spec/lib/gitlab/ci/pipeline/chain/command_spec.rb b/spec/lib/gitlab/ci/pipeline/chain/command_spec.rb
index dab0fb51bcc..5181e9c1583 100644
--- a/spec/lib/gitlab/ci/pipeline/chain/command_spec.rb
+++ b/spec/lib/gitlab/ci/pipeline/chain/command_spec.rb
@@ -48,6 +48,24 @@ describe Gitlab::Ci::Pipeline::Chain::Command do
       end
     end
 
+    describe '#merge_request_ref_exists?' do
+      subject { command.merge_request_ref_exists? }
+
+      let!(:merge_request) { create(:merge_request, source_project: project, target_project: project) }
+
+      context 'for existing merge request ref' do
+        let(:origin_ref) { merge_request.ref_path }
+
+        it { is_expected.to eq(true) }
+      end
+
+      context 'for branch ref' do
+        let(:origin_ref) { merge_request.source_branch }
+
+        it { is_expected.to eq(false) }
+      end
+    end
+
     describe '#ref' do
       subject { command.ref }
 
diff --git a/spec/lib/gitlab/ci/pipeline/chain/validate/abilities_spec.rb b/spec/lib/gitlab/ci/pipeline/chain/validate/abilities_spec.rb
index 8ba56d73838..7d750877d09 100644
--- a/spec/lib/gitlab/ci/pipeline/chain/validate/abilities_spec.rb
+++ b/spec/lib/gitlab/ci/pipeline/chain/validate/abilities_spec.rb
@@ -10,12 +10,33 @@ describe Gitlab::Ci::Pipeline::Chain::Validate::Abilities do
 
   let(:command) do
     Gitlab::Ci::Pipeline::Chain::Command.new(
-      project: project, current_user: user, origin_ref: ref)
+      project: project, current_user: user, origin_ref: origin_ref, merge_request: merge_request)
   end
 
   let(:step) { described_class.new(pipeline, command) }
 
   let(:ref) { 'master' }
+  let(:origin_ref) { ref }
+  let(:merge_request) { nil }
+
+  shared_context 'detached merge request pipeline' do
+    let(:merge_request) do
+      create(:merge_request,
+        source_project: project,
+        source_branch: ref,
+        target_project: project,
+        target_branch: 'feature')
+    end
+
+    let(:pipeline) do
+      build(:ci_pipeline,
+        source: :merge_request_event,
+        merge_request: merge_request,
+        project: project)
+    end
+
+    let(:origin_ref) { merge_request.ref_path }
+  end
 
   context 'when users has no ability to run a pipeline' do
     before do
@@ -58,6 +79,12 @@ describe Gitlab::Ci::Pipeline::Chain::Validate::Abilities do
 
       it { is_expected.to be_truthy }
 
+      context 'when pipeline is a detached merge request pipeline' do
+        include_context 'detached merge request pipeline'
+
+        it { is_expected.to be_truthy }
+      end
+
       context 'when the branch is protected' do
         let!(:protected_branch) do
           create(:protected_branch, project: project, name: ref)
@@ -65,6 +92,12 @@ describe Gitlab::Ci::Pipeline::Chain::Validate::Abilities do
 
         it { is_expected.to be_falsey }
 
+        context 'when pipeline is a detached merge request pipeline' do
+          include_context 'detached merge request pipeline'
+
+          it { is_expected.to be_falsey }
+        end
+
         context 'when developers are allowed to merge' do
           let!(:protected_branch) do
             create(:protected_branch,
@@ -74,6 +107,12 @@ describe Gitlab::Ci::Pipeline::Chain::Validate::Abilities do
           end
 
           it { is_expected.to be_truthy }
+
+          context 'when pipeline is a detached merge request pipeline' do
+            include_context 'detached merge request pipeline'
+
+            it { is_expected.to be_truthy }
+          end
         end
       end
 
@@ -112,6 +151,12 @@ describe Gitlab::Ci::Pipeline::Chain::Validate::Abilities do
         end
 
         it { is_expected.to be_truthy }
+
+        context 'when pipeline is a detached merge request pipeline' do
+          include_context 'detached merge request pipeline'
+
+          it { is_expected.to be_truthy }
+        end
       end
 
       context 'when the tag is protected' do
diff --git a/spec/lib/gitlab/ci/pipeline/chain/validate/repository_spec.rb b/spec/lib/gitlab/ci/pipeline/chain/validate/repository_spec.rb
index a7cad423d09..2e8c9d70098 100644
--- a/spec/lib/gitlab/ci/pipeline/chain/validate/repository_spec.rb
+++ b/spec/lib/gitlab/ci/pipeline/chain/validate/repository_spec.rb
@@ -42,6 +42,25 @@ describe Gitlab::Ci::Pipeline::Chain::Validate::Repository do
     end
   end
 
+  context 'when origin ref is a merge request ref' do
+    let(:command) do
+      Gitlab::Ci::Pipeline::Chain::Command.new(
+        project: project, current_user: user, origin_ref: origin_ref, checkout_sha: checkout_sha)
+    end
+
+    let(:merge_request) { create(:merge_request, source_project: project, target_project: project) }
+    let(:origin_ref) { merge_request.ref_path }
+    let(:checkout_sha) { project.repository.commit(merge_request.ref_path).id }
+
+    it 'does not break the chain' do
+      expect(step.break?).to be false
+    end
+
+    it 'does not append pipeline errors' do
+      expect(pipeline.errors).to be_empty
+    end
+  end
+
   context 'when ref is ambiguous' do
     let(:project) do
       create(:project, :repository).tap do |proj|
diff --git a/spec/models/ci/build_spec.rb b/spec/models/ci/build_spec.rb
index 7500e6ae5b1..3ec07143e93 100644
--- a/spec/models/ci/build_spec.rb
+++ b/spec/models/ci/build_spec.rb
@@ -24,6 +24,8 @@ describe Ci::Build do
   it { is_expected.to respond_to(:has_trace?) }
   it { is_expected.to respond_to(:trace) }
   it { is_expected.to delegate_method(:merge_request_event?).to(:pipeline) }
+  it { is_expected.to delegate_method(:merge_request_ref?).to(:pipeline) }
+  it { is_expected.to delegate_method(:legacy_detached_merge_request_pipeline?).to(:pipeline) }
 
   it { is_expected.to be_a(ArtifactMigratable) }
 
@@ -3626,6 +3628,24 @@ describe Ci::Build do
         it { is_expected.to be_falsey }
       end
     end
+
+    context 'when refspecs feature is required by build' do
+      before do
+        allow(build).to receive(:merge_request_ref?) { true }
+      end
+
+      context 'when runner provides given feature' do
+        let(:runner_features) { { refspecs: true } }
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when runner does not provide given feature' do
+        let(:runner_features) { {} }
+
+        it { is_expected.to be_falsey }
+      end
+    end
   end
 
   describe '#deployment_status' do
diff --git a/spec/models/ci/pipeline_spec.rb b/spec/models/ci/pipeline_spec.rb
index 225c6812bec..e5f3a9ce67a 100644
--- a/spec/models/ci/pipeline_spec.rb
+++ b/spec/models/ci/pipeline_spec.rb
@@ -362,6 +362,42 @@ describe Ci::Pipeline, :mailer do
     end
   end
 
+  describe '#merge_request_ref?' do
+    subject { pipeline.merge_request_ref? }
+
+    it 'calls MergeRequest#merge_request_ref?' do
+      expect(MergeRequest).to receive(:merge_request_ref?).with(pipeline.ref)
+
+      subject
+    end
+  end
+
+  describe '#legacy_detached_merge_request_pipeline?' do
+    subject { pipeline.legacy_detached_merge_request_pipeline? }
+
+    set(:merge_request) { create(:merge_request) }
+    let(:ref) { 'feature' }
+    let(:target_sha) { nil }
+
+    let(:pipeline) do
+      build(:ci_pipeline, source: :merge_request_event, merge_request: merge_request, ref: ref, target_sha: target_sha)
+    end
+
+    it { is_expected.to be_truthy }
+
+    context 'when pipeline ref is a merge request ref' do
+      let(:ref) { 'refs/merge-requests/1/head' }
+
+      it { is_expected.to be_falsy }
+    end
+
+    context 'when target sha is set' do
+      let(:target_sha) { 'target-sha' }
+
+      it { is_expected.to be_falsy }
+    end
+  end
+
   describe '#matches_sha_or_source_sha?' do
     subject { pipeline.matches_sha_or_source_sha?(sample_sha) }
 
diff --git a/spec/models/merge_request_spec.rb b/spec/models/merge_request_spec.rb
index a1de0c63623..5adeb616e84 100644
--- a/spec/models/merge_request_spec.rb
+++ b/spec/models/merge_request_spec.rb
@@ -3115,4 +3115,32 @@ describe MergeRequest do
       end
     end
   end
+
+  describe '.merge_request_ref?' do
+    subject { described_class.merge_request_ref?(ref) }
+
+    context 'when ref is ref name of a branch' do
+      let(:ref) { 'feature' }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when ref is HEAD ref path of a branch' do
+      let(:ref) { 'refs/heads/feature' }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when ref is HEAD ref path of a merge request' do
+      let(:ref) { 'refs/merge-requests/1/head' }
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'when ref is merge ref path of a merge request' do
+      let(:ref) { 'refs/merge-requests/1/merge' }
+
+      it { is_expected.to be_truthy }
+    end
+  end
 end
diff --git a/spec/presenters/ci/build_runner_presenter_spec.rb b/spec/presenters/ci/build_runner_presenter_spec.rb
index f50bcf54b46..ad6cb012d0b 100644
--- a/spec/presenters/ci/build_runner_presenter_spec.rb
+++ b/spec/presenters/ci/build_runner_presenter_spec.rb
@@ -136,6 +136,24 @@ describe Ci::BuildRunnerPresenter do
         is_expected.to eq(1)
       end
     end
+
+    context 'when pipeline is detached merge request pipeline' do
+      let(:merge_request) { create(:merge_request, :with_detached_merge_request_pipeline) }
+      let(:pipeline) { merge_request.all_pipelines.first }
+      let(:build) { create(:ci_build, ref: pipeline.ref, pipeline: pipeline) }
+
+      it 'returns the default git depth for pipelines for merge requests' do
+        is_expected.to eq(described_class::DEFAULT_GIT_DEPTH_MERGE_REQUEST)
+      end
+
+      context 'when pipeline is legacy detached merge request pipeline' do
+        let(:merge_request) { create(:merge_request, :with_legacy_detached_merge_request_pipeline) }
+
+        it 'behaves as branch pipeline' do
+          is_expected.to eq(0)
+        end
+      end
+    end
   end
 
   describe '#refspecs' do
@@ -165,5 +183,25 @@ describe Ci::BuildRunnerPresenter do
         end
       end
     end
+
+    context 'when pipeline is detached merge request pipeline' do
+      let(:merge_request) { create(:merge_request, :with_detached_merge_request_pipeline) }
+      let(:pipeline) { merge_request.all_pipelines.first }
+      let(:build) { create(:ci_build, ref: pipeline.ref, pipeline: pipeline) }
+
+      it 'returns the correct refspecs' do
+        is_expected
+          .to contain_exactly('+refs/merge-requests/1/head:refs/merge-requests/1/head')
+      end
+
+      context 'when pipeline is legacy detached merge request pipeline' do
+        let(:merge_request) { create(:merge_request, :with_legacy_detached_merge_request_pipeline) }
+
+        it 'returns the correct refspecs' do
+          is_expected.to contain_exactly('+refs/tags/*:refs/tags/*',
+                                         '+refs/heads/*:refs/remotes/origin/*')
+        end
+      end
+    end
   end
 end
diff --git a/spec/services/merge_requests/create_service_spec.rb b/spec/services/merge_requests/create_service_spec.rb
index a04a4d5fc36..55e7b46248b 100644
--- a/spec/services/merge_requests/create_service_spec.rb
+++ b/spec/services/merge_requests/create_service_spec.rb
@@ -173,7 +173,7 @@ describe MergeRequests::CreateService do
         end
       end
 
-      describe 'Merge request pipelines' do
+      describe 'Pipelines for merge requests' do
         before do
           stub_ci_pipeline_yaml_file(YAML.dump(config))
         end
@@ -189,12 +189,46 @@ describe MergeRequests::CreateService do
             }
           end
 
-          it 'creates a merge request pipeline and sets it as a head pipeline' do
+          it 'creates a detached merge request pipeline and sets it as a head pipeline' do
             expect(merge_request).to be_persisted
 
             merge_request.reload
             expect(merge_request.merge_request_pipelines.count).to eq(1)
-            expect(merge_request.actual_head_pipeline).to be_merge_request_event
+            expect(merge_request.actual_head_pipeline).to be_detached_merge_request_pipeline
+          end
+
+          context 'when merge request is submitted from forked project' do
+            let(:target_project) { fork_project(project, nil, repository: true) }
+
+            let(:opts) do
+              {
+                title: 'Awesome merge_request',
+                source_branch: 'feature',
+                target_branch: 'master',
+                target_project_id: target_project.id
+              }
+            end
+
+            before do
+              target_project.add_developer(assignee)
+              target_project.add_maintainer(user)
+            end
+
+            it 'create legacy detached merge request pipeline for fork merge request' do
+              expect(merge_request.actual_head_pipeline)
+                .to be_legacy_detached_merge_request_pipeline
+            end
+          end
+
+          context 'when ci_use_merge_request_ref feature flag is false' do
+            before do
+              stub_feature_flags(ci_use_merge_request_ref: false)
+            end
+
+            it 'create legacy detached merge request pipeline for non-fork merge request' do
+              expect(merge_request.actual_head_pipeline)
+                .to be_legacy_detached_merge_request_pipeline
+            end
           end
 
           context 'when there are no commits between source branch and target branch' do
@@ -207,7 +241,7 @@ describe MergeRequests::CreateService do
               }
             end
 
-            it 'does not create a merge request pipeline' do
+            it 'does not create a detached merge request pipeline' do
               expect(merge_request).to be_persisted
 
               merge_request.reload
@@ -225,7 +259,7 @@ describe MergeRequests::CreateService do
               merge_request
             end
 
-            it 'sets the latest merge request pipeline as the head pipeline' do
+            it 'sets the latest detached merge request pipeline as the head pipeline' do
               expect(merge_request.actual_head_pipeline).to be_merge_request_event
             end
           end
@@ -235,7 +269,7 @@ describe MergeRequests::CreateService do
               stub_feature_flags(ci_merge_request_pipeline: false)
             end
 
-            it 'does not create a merge request pipeline' do
+            it 'does not create a detached merge request pipeline' do
               expect(merge_request).to be_persisted
 
               merge_request.reload
@@ -254,7 +288,7 @@ describe MergeRequests::CreateService do
             }
           end
 
-          it 'does not create a merge request pipeline' do
+          it 'does not create a detached merge request pipeline' do
             expect(merge_request).to be_persisted
 
             merge_request.reload
diff --git a/spec/services/merge_requests/refresh_service_spec.rb b/spec/services/merge_requests/refresh_service_spec.rb
index 6c8ff163692..25cbac6d7ee 100644
--- a/spec/services/merge_requests/refresh_service_spec.rb
+++ b/spec/services/merge_requests/refresh_service_spec.rb
@@ -141,7 +141,7 @@ describe MergeRequests::RefreshService do
       end
     end
 
-    describe 'Merge request pipelines' do
+    describe 'Pipelines for merge requests' do
       before do
         stub_ci_pipeline_yaml_file(YAML.dump(config))
       end
@@ -159,7 +159,7 @@ describe MergeRequests::RefreshService do
           }
         end
 
-        it 'create merge request pipeline with commits' do
+        it 'create detached merge request pipeline with commits' do
           expect { subject }
             .to change { @merge_request.merge_request_pipelines.count }.by(1)
             .and change { @fork_merge_request.merge_request_pipelines.count }.by(1)
@@ -170,7 +170,34 @@ describe MergeRequests::RefreshService do
           expect(@another_merge_request.has_commits?).to be_falsy
         end
 
-        context "when branch pipeline was created before a merge request pipline has been created" do
+        it 'create detached merge request pipeline for non-fork merge request' do
+          subject
+
+          expect(@merge_request.merge_request_pipelines.first)
+            .to be_detached_merge_request_pipeline
+        end
+
+        it 'create legacy detached merge request pipeline for fork merge request' do
+          subject
+
+          expect(@fork_merge_request.merge_request_pipelines.first)
+            .to be_legacy_detached_merge_request_pipeline
+        end
+
+        context 'when ci_use_merge_request_ref feature flag is false' do
+          before do
+            stub_feature_flags(ci_use_merge_request_ref: false)
+          end
+
+          it 'create legacy detached merge request pipeline for non-fork merge request' do
+            subject
+
+            expect(@merge_request.merge_request_pipelines.first)
+              .to be_legacy_detached_merge_request_pipeline
+          end
+        end
+
+        context "when branch pipeline was created before a detaced merge request pipeline has been created" do
           before do
             create(:ci_pipeline, project: @merge_request.source_project,
                                  sha: @merge_request.diff_head_sha,
@@ -180,7 +207,7 @@ describe MergeRequests::RefreshService do
             subject
           end
 
-          it 'sets the latest merge request pipeline as a head pipeline' do
+          it 'sets the latest detached merge request pipeline as a head pipeline' do
             @merge_request.reload
             expect(@merge_request.actual_head_pipeline).to be_merge_request_event
           end
@@ -193,7 +220,7 @@ describe MergeRequests::RefreshService do
         end
 
         context "when MergeRequestUpdateWorker is retried by an exception" do
-          it 'does not re-create a duplicate merge request pipeline' do
+          it 'does not re-create a duplicate detached merge request pipeline' do
             expect do
               service.new(@project, @user).execute(@oldrev, @newrev, 'refs/heads/master')
             end.to change { @merge_request.merge_request_pipelines.count }.by(1)
@@ -209,7 +236,7 @@ describe MergeRequests::RefreshService do
             stub_feature_flags(ci_merge_request_pipeline: false)
           end
 
-          it 'does not create a merge request pipeline' do
+          it 'does not create a detached merge request pipeline' do
             expect { subject }
               .not_to change { @merge_request.merge_request_pipelines.count }
           end
@@ -226,7 +253,7 @@ describe MergeRequests::RefreshService do
           }
         end
 
-        it 'does not create a merge request pipeline' do
+        it 'does not create a detached merge request pipeline' do
           expect { subject }
             .not_to change { @merge_request.merge_request_pipelines.count }
         end