Merge branch 'feature/sm/2772-pass-get-variables-with-ci_job_token-pipeline-triggers' into 'master'

Pass/get variables with $CI_JOB_TOKEN pipeline triggers

Closes #2772

See merge request !2557

app/services/ci/pipeline_trigger_service.rb

@@ -32,7 +32,6 @@ module Ci
       return unless can?(job.user, :read_project, project)
 
       return error("400 Job has to be running", 400) unless job.running?
-      return error("400 Variables not supported", 400) if params[:variables].any?
 
       pipeline = Ci::CreatePipelineService.new(project, job.user, ref: params[:ref])
         .execute(:pipeline, ignore_skip_ci: true) do |pipeline|
@@ -41,6 +40,8 @@ module Ci
             source_project: job.project,
             pipeline: pipeline,
             project: project)
+
+          create_pipeline_variables!(pipeline)
         end
 
       if pipeline.persisted?

changelogs/unreleased-ee/feature-sm-2772-pass-get-variables-with-ci_job_token-pipeline-triggers.yml

+---
+title: Support variables on Trigger API for Cross-project pipeline
+merge_request: 2557
+author:

doc/ci/triggers/README.md

@@ -38,8 +38,7 @@ build_docs:
 ```
 
 Pipelines triggered that way also expose a special variable:
-`CI_PIPELINE_SOURCE=pipeline`. This method currently doesn't support
-[the usage of trigger variables](#making-use-of-trigger-variables).
+`CI_PIPELINE_SOURCE=pipeline`.
 
 For more information, read about [triggering a pipeline](#triggering-a-pipeline).
 

spec/requests/api/triggers_spec.rb

@@ -191,11 +191,14 @@ describe API::Triggers do
                 variables: { 'KEY' => 'VALUE' } }
             end
 
-            it 'forbids to create a pipeline' do
-              subject
+            it 'creates a new pipeline with a variable' do
+              expect { subject }.to change(Ci::Pipeline, :count)
+                                .and change(Ci::PipelineVariable, :count)
 
-              expect(response).to have_http_status(400)
-              expect(json_response['message']).to eq('400 Variables not supported')
+              expect(response).to have_http_status(201)
+              expect(Ci::Pipeline.last.source).to eq('pipeline')
+              expect(Ci::Pipeline.last.triggered_by_pipeline).not_to be_nil
+              expect(Ci::Pipeline.last.variables.map { |v| { v.key => v.value } }.last).to eq(params[:variables])
             end
           end
         end

spec/services/ee/ci/pipeline_trigger_service_spec.rb

+require 'spec_helper'
+
+describe Ci::PipelineTriggerService do
+  let(:project) { create(:project, :repository) }
+
+  before do
+    stub_ci_pipeline_to_return_yaml_file
+  end
+
+  describe '#execute' do
+    let(:user) { create(:user) }
+    let!(:pipeline) { create(:ci_empty_pipeline, project: project) }
+    let(:job) { create(:ci_build, :running, pipeline: pipeline, user: user) }
+    let(:result) { described_class.new(project, user, params).execute }
+
+    before do
+      project.add_developer(user)
+    end
+
+    context 'when job user does not have a permission to read a project' do
+      let(:params) { { token: job.token, ref: 'master', variables: nil } }
+      let(:job) { create(:ci_build, pipeline: pipeline, user: create(:user)) }
+
+      it 'does nothing' do
+        expect { result }.not_to change { Ci::Pipeline.count }
+      end
+    end
+
+    context 'when job is not running' do
+      let(:params) { { token: job.token, ref: 'master', variables: nil } }
+      let(:job) { create(:ci_build, :success, pipeline: pipeline, user: user) }
+
+      it 'does nothing' do
+        expect { result }.not_to change { Ci::Pipeline.count }
+        expect(result[:message]).to eq('400 Job has to be running')
+      end
+    end
+
+    context 'when params have an existsed job token' do
+      context 'when params have an existsed ref' do
+        let(:params) { { token: job.token, ref: 'master', variables: nil } }
+
+        it 'triggers a pipeline' do
+          expect { result }.to change { Ci::Pipeline.count }.by(1)
+          expect(result[:pipeline].ref).to eq('master')
+          expect(result[:pipeline].project).to eq(project)
+          expect(result[:pipeline].user).to eq(job.user)
+          expect(result[:status]).to eq(:success)
+        end
+
+        context 'when commit message has [ci skip]' do
+          before do
+            allow_any_instance_of(Ci::Pipeline).to receive(:git_commit_message) { '[ci skip]' }
+          end
+
+          it 'ignores [ci skip] and create as general' do
+            expect { result }.to change { Ci::Pipeline.count }.by(1)
+            expect(result[:status]).to eq(:success)
+          end
+        end
+
+        context 'when params have a variable' do
+          let(:params) { { token: job.token, ref: 'master', variables: variables } }
+          let(:variables) { { 'AAA' => 'AAA123' } }
+
+          it 'has a variable' do
+            expect { result }.to change { Ci::PipelineVariable.count }.by(1)
+                             .and change { Ci::Sources::Pipeline.count }.by(1)
+            expect(result[:pipeline].variables.map { |v| { v.key => v.value } }.first).to eq(variables)
+            expect(job.sourced_pipelines.last.pipeline_id).to eq(result[:pipeline].id)
+          end
+        end
+      end
+
+      context 'when params have a non-existsed ref' do
+        let(:params) { { token: job.token, ref: 'invalid-ref', variables: nil } }
+
+        it 'does not job a pipeline' do
+          expect { result }.not_to change { Ci::Pipeline.count }
+          expect(result[:http_status]).to eq(400)
+        end
+      end
+    end
+
+    context 'when params have a non-existsed trigger token' do
+      let(:params) { { token: 'invalid-token', ref: nil, variables: nil } }
+
+      it 'does not trigger a pipeline' do
+        expect { result }.not_to change { Ci::Pipeline.count }
+        expect(result).to be_nil
+      end
+    end
+  end
+end