diff --git a/scripts/trigger-build.rb b/scripts/trigger-build.rb
index a3356c664d19d33a55af2051bb83c074eb07d5bd..c86279ce95250e8bef5e38bfcdae713e4a5ea2c0 100755
--- a/scripts/trigger-build.rb
+++ b/scripts/trigger-build.rb
@@ -83,7 +83,7 @@ def simple_forwarded_variables
# Override to trigger and work with pipeline on different GitLab instance
# type: :downstream -> downstream build and pipeline status
# type: :upstream -> this project, e.g. for posting comments
- def gitlab_client(type)
+ def gitlab_client(_type)
# By default, always use the same client
@gitlab_client ||= Gitlab.client(
endpoint: 'https://gitlab.com/api/v4',
@@ -97,10 +97,15 @@ def downstream_project_path
end
# Must be overridden
- def ref
+ def ref_param_name
raise NotImplementedError
end
+ # Can be overridden
+ def primary_ref
+ 'main'
+ end
+
# Can be overridden
def trigger_token
ENV['CI_JOB_TOKEN']
@@ -116,6 +121,27 @@ def version_param_value(version_file)
ENV[version_file]&.strip || File.read(version_file).strip
end
+ # Can be overridden
+ def trigger_stable_branch_if_detected?
+ false
+ end
+
+ def stable_branch?
+ ENV['CI_COMMIT_REF_NAME'] =~ /^[\d-]+-stable(-ee)?$/
+ end
+
+ def fallback_ref
+ if trigger_stable_branch_if_detected? && stable_branch?
+ ENV['CI_COMMIT_REF_NAME'].delete_suffix('-ee')
+ else
+ primary_ref
+ end
+ end
+
+ def ref
+ ENV.fetch(ref_param_name, fallback_ref)
+ end
+
def base_variables
# Use CI_MERGE_REQUEST_SOURCE_BRANCH_SHA for omnibus checkouts due to pipeline for merged results,
# and fallback to CI_COMMIT_SHA for the `detached` pipelines.
@@ -146,8 +172,16 @@ def downstream_project_path
ENV.fetch('OMNIBUS_PROJECT_PATH', 'gitlab-org/build/omnibus-gitlab-mirror')
end
- def ref
- ENV.fetch('OMNIBUS_BRANCH', 'master')
+ def ref_param_name
+ 'OMNIBUS_BRANCH'
+ end
+
+ def primary_ref
+ 'master'
+ end
+
+ def trigger_stable_branch_if_detected?
+ true
end
def extra_variables
@@ -184,10 +218,16 @@ def variables
private
- def ref
- return ENV['CI_COMMIT_REF_NAME'] if ENV['CI_COMMIT_REF_NAME'] =~ /^[\d-]+-stable(-ee)?$/
+ def ref_param_name
+ 'CNG_BRANCH'
+ end
+
+ def primary_ref
+ 'master'
+ end
- ENV.fetch('CNG_BRANCH', 'master')
+ def trigger_stable_branch_if_detected?
+ true
end
def extra_variables
@@ -272,8 +312,8 @@ def downstream_project_path
ENV.fetch('DOCS_PROJECT_PATH', 'gitlab-org/gitlab-docs')
end
- def ref
- ENV.fetch('DOCS_BRANCH', 'main')
+ def ref_param_name
+ 'DOCS_BRANCH'
end
# `gitlab-org/gitlab-docs` pipeline trigger "Triggered from gitlab-org/gitlab 'review-docs-deploy' job"
@@ -377,8 +417,12 @@ def extra_variables
}
end
- def ref
- ENV['GITLABCOM_DATABASE_TESTING_TRIGGER_REF'] || 'master'
+ def ref_param_name
+ 'GITLABCOM_DATABASE_TESTING_TRIGGER_REF'
+ end
+
+ def primary_ref
+ 'master'
end
end
diff --git a/spec/scripts/trigger-build_spec.rb b/spec/scripts/trigger-build_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..18e57966bc27a977aecc814e38d8b5c752301dfb
--- /dev/null
+++ b/spec/scripts/trigger-build_spec.rb
@@ -0,0 +1,936 @@
+# frozen_string_literal: true
+# rubocop:disable RSpec/VerifiedDoubles
+
+require 'fast_spec_helper'
+require 'rspec-parameterized'
+
+require_relative '../../scripts/trigger-build'
+
+RSpec.describe Trigger do
+ let(:env) do
+ {
+ 'CI_JOB_URL' => 'ci_job_url',
+ 'CI_PROJECT_PATH' => 'ci_project_path',
+ 'CI_COMMIT_REF_NAME' => 'ci_commit_ref_name',
+ 'CI_COMMIT_REF_SLUG' => 'ci_commit_ref_slug',
+ 'CI_COMMIT_SHA' => 'ci_commit_sha',
+ 'CI_MERGE_REQUEST_PROJECT_ID' => 'ci_merge_request_project_id',
+ 'CI_MERGE_REQUEST_IID' => 'ci_merge_request_iid',
+ 'GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN' => 'bot-token',
+ 'CI_JOB_TOKEN' => 'job-token',
+ 'GITLAB_USER_NAME' => 'gitlab_user_name',
+ 'GITLAB_USER_LOGIN' => 'gitlab_user_login',
+ 'QA_IMAGE' => 'qa_image'
+ }
+ end
+
+ let(:stubbed_downstream_gitlab_client) { double('downstream_gitlab_api_client') }
+ let(:gitlab_client_private_token) { env['GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN'] }
+ let(:stubbed_pipeline) { Struct.new(:id, :web_url).new(42, 'pipeline_url') }
+ let(:trigger_token) { env['CI_JOB_TOKEN'] }
+ let(:api_endpoint) { 'https://gitlab.com/api/v4' }
+
+ before do
+ stub_env(env)
+ allow(subject).to receive(:puts)
+ allow(Gitlab).to receive(:client)
+ .with(
+ endpoint: api_endpoint,
+ private_token: gitlab_client_private_token
+ )
+ .and_return(stubbed_downstream_gitlab_client)
+ end
+
+ def expect_run_trigger_with_params(variables = {})
+ expect(stubbed_downstream_gitlab_client).to receive(:run_trigger)
+ .with(
+ downstream_project_path,
+ trigger_token,
+ ref,
+ hash_including(variables)
+ )
+ .and_return(stubbed_pipeline)
+ end
+
+ describe Trigger::Base do
+ let(:ref) { 'main' }
+
+ describe '#invoke!' do
+ context "when required methods aren't defined" do
+ it 'raises a NotImplementedError' do
+ expect { described_class.new.invoke! }.to raise_error(NotImplementedError)
+ end
+ end
+
+ context "when required methods are defined" do
+ let(:downstream_project_path) { 'foo/bar' }
+ let(:subclass) do
+ Class.new(Trigger::Base) do
+ def downstream_project_path
+ 'foo/bar'
+ end
+
+ # Must be overridden
+ def ref_param_name
+ 'FOO_BAR_BRANCH'
+ end
+ end
+ end
+
+ subject { subclass.new }
+
+ context 'when env variable `FOO_BAR_BRANCH` does not exist' do
+ it 'triggers the pipeline on the correct project and branch' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+
+ context 'when env variable `FOO_BAR_BRANCH` exists' do
+ let(:ref) { 'foo_bar_branch' }
+
+ before do
+ stub_env('FOO_BAR_BRANCH', ref)
+ end
+
+ it 'triggers the pipeline on the correct project and branch' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+
+ it 'waits for downstream pipeline' do
+ expect_run_trigger_with_params
+ expect(Trigger::Pipeline).to receive(:new)
+ .with(downstream_project_path, stubbed_pipeline.id, stubbed_downstream_gitlab_client)
+
+ subject.invoke!
+ end
+
+ context 'with post_comment: true' do
+ before do
+ stub_env('CI_COMMIT_REF_NAME', "#{ref}-ee")
+ end
+
+ it 'posts a comment' do
+ expect_run_trigger_with_params
+ expect(Trigger::CommitComment).to receive(:post!).with(stubbed_pipeline, stubbed_downstream_gitlab_client)
+
+ subject.invoke!(post_comment: true)
+ end
+ end
+
+ context 'with downstream_job_name: "foo"' do
+ let(:downstream_job) { Struct.new(:id, :name).new(42, 'foo') }
+ let(:paginated_resources) { Struct.new(:auto_paginate).new([downstream_job]) }
+
+ before do
+ stub_env('CI_COMMIT_REF_NAME', "#{ref}-ee")
+ end
+
+ it 'fetches the downstream job' do
+ expect_run_trigger_with_params
+ expect(stubbed_downstream_gitlab_client).to receive(:pipeline_jobs)
+ .with(downstream_project_path, stubbed_pipeline.id).and_return(paginated_resources)
+ expect(Trigger::Job).to receive(:new)
+ .with(downstream_project_path, downstream_job.id, stubbed_downstream_gitlab_client)
+
+ subject.invoke!(downstream_job_name: 'foo')
+ end
+ end
+ end
+ end
+
+ describe '#variables' do
+ let(:simple_forwarded_variables) do
+ {
+ 'TRIGGER_SOURCE' => env['CI_JOB_URL'],
+ 'TOP_UPSTREAM_SOURCE_PROJECT' => env['CI_PROJECT_PATH'],
+ 'TOP_UPSTREAM_SOURCE_REF' => env['CI_COMMIT_REF_NAME'],
+ 'TOP_UPSTREAM_SOURCE_JOB' => env['CI_JOB_URL'],
+ 'TOP_UPSTREAM_MERGE_REQUEST_PROJECT_ID' => env['CI_MERGE_REQUEST_PROJECT_ID'],
+ 'TOP_UPSTREAM_MERGE_REQUEST_IID' => env['CI_MERGE_REQUEST_IID']
+ }
+ end
+
+ it 'includes simple forwarded variables' do
+ expect(subject.variables).to include(simple_forwarded_variables)
+ end
+
+ describe "#base_variables" do
+ context 'when CI_COMMIT_TAG is set' do
+ before do
+ stub_env('CI_COMMIT_TAG', 'v1.0')
+ end
+
+ it 'sets GITLAB_REF_SLUG to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['GITLAB_REF_SLUG']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+
+ context 'when CI_COMMIT_TAG is nil' do
+ before do
+ stub_env('CI_COMMIT_TAG', nil)
+ end
+
+ it 'sets GITLAB_REF_SLUG to CI_COMMIT_REF_SLUG' do
+ expect(subject.variables['GITLAB_REF_SLUG']).to eq(env['CI_COMMIT_REF_SLUG'])
+ end
+ end
+
+ context 'when TRIGGERED_USER is set' do
+ before do
+ stub_env('TRIGGERED_USER', 'triggered_user')
+ end
+
+ it 'sets TRIGGERED_USER to triggered_user' do
+ expect(subject.variables['TRIGGERED_USER']).to eq('triggered_user')
+ end
+ end
+
+ context 'when TRIGGERED_USER is not set' do
+ before do
+ stub_env('TRIGGERED_USER', nil)
+ end
+
+ it 'sets TRIGGERED_USER to GITLAB_USER_NAME' do
+ expect(subject.variables['TRIGGERED_USER']).to eq(env['GITLAB_USER_NAME'])
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', 'ci_merge_request_source_branch_sha')
+ end
+
+ it 'sets TOP_UPSTREAM_SOURCE_SHA to ci_merge_request_source_branch_sha' do
+ expect(subject.variables['TOP_UPSTREAM_SOURCE_SHA']).to eq('ci_merge_request_source_branch_sha')
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set as empty' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', '')
+ end
+
+ it 'sets TOP_UPSTREAM_SOURCE_SHA to CI_COMMIT_SHA' do
+ expect(subject.variables['TOP_UPSTREAM_SOURCE_SHA']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is not set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', nil)
+ end
+
+ it 'sets TOP_UPSTREAM_SOURCE_SHA to CI_COMMIT_SHA' do
+ expect(subject.variables['TOP_UPSTREAM_SOURCE_SHA']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+ end
+
+ describe "#version_file_variables" do
+ using RSpec::Parameterized::TableSyntax
+
+ where(:version_file, :version) do
+ 'GITALY_SERVER_VERSION' | "1"
+ 'GITLAB_ELASTICSEARCH_INDEXER_VERSION' | "2"
+ 'GITLAB_KAS_VERSION' | "3"
+ 'GITLAB_PAGES_VERSION' | "4"
+ 'GITLAB_SHELL_VERSION' | "5"
+ 'GITLAB_WORKHORSE_VERSION' | "6"
+ end
+
+ with_them do
+ context "when set in ENV" do
+ before do
+ stub_env(version_file, version)
+ end
+
+ it 'includes the version from ENV' do
+ expect(subject.variables[version_file]).to eq(version)
+ end
+ end
+
+ context "when set in a file" do
+ before do
+ allow(File).to receive(:read).and_call_original
+ end
+
+ it 'includes the version from the file' do
+ expect(File).to receive(:read).with(version_file).and_return(version)
+ expect(subject.variables[version_file]).to eq(version)
+ end
+ end
+ end
+ end
+ end
+ end
+
+ describe Trigger::Omnibus do
+ describe '#variables' do
+ it 'invokes the trigger with expected variables' do
+ expect(subject.variables).to include(
+ 'QA_IMAGE' => env['QA_IMAGE'],
+ 'SKIP_QA_DOCKER' => 'true',
+ 'ALTERNATIVE_SOURCES' => 'true',
+ 'CACHE_UPDATE' => env['OMNIBUS_GITLAB_CACHE_UPDATE'],
+ 'GITLAB_QA_OPTIONS' => env['GITLAB_QA_OPTIONS'],
+ 'QA_TESTS' => env['QA_TESTS'],
+ 'ALLURE_JOB_NAME' => env['ALLURE_JOB_NAME']
+ )
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', 'ci_merge_request_source_branch_sha')
+ end
+
+ it 'sets GITLAB_VERSION & IMAGE_TAG to ci_merge_request_source_branch_sha' do
+ expect(subject.variables).to include(
+ 'GITLAB_VERSION' => 'ci_merge_request_source_branch_sha',
+ 'IMAGE_TAG' => 'ci_merge_request_source_branch_sha'
+ )
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set as empty' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', '')
+ end
+
+ it 'sets GITLAB_VERSION & IMAGE_TAG to CI_COMMIT_SHA' do
+ expect(subject.variables).to include(
+ 'GITLAB_VERSION' => env['CI_COMMIT_SHA'],
+ 'IMAGE_TAG' => env['CI_COMMIT_SHA']
+ )
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is not set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', nil)
+ end
+
+ it 'sets GITLAB_VERSION & IMAGE_TAG to CI_COMMIT_SHA' do
+ expect(subject.variables).to include(
+ 'GITLAB_VERSION' => env['CI_COMMIT_SHA'],
+ 'IMAGE_TAG' => env['CI_COMMIT_SHA']
+ )
+ end
+ end
+
+ context 'when Trigger.security? is true' do
+ before do
+ allow(Trigger).to receive(:security?).and_return(true)
+ end
+
+ it 'sets SECURITY_SOURCES to true' do
+ expect(subject.variables['SECURITY_SOURCES']).to eq('true')
+ end
+ end
+
+ context 'when Trigger.security? is false' do
+ before do
+ allow(Trigger).to receive(:security?).and_return(false)
+ end
+
+ it 'sets SECURITY_SOURCES to false' do
+ expect(subject.variables['SECURITY_SOURCES']).to eq('false')
+ end
+ end
+
+ context 'when Trigger.ee? is true' do
+ before do
+ allow(Trigger).to receive(:ee?).and_return(true)
+ end
+
+ it 'sets ee to true' do
+ expect(subject.variables['ee']).to eq('true')
+ end
+ end
+
+ context 'when Trigger.ee? is false' do
+ before do
+ allow(Trigger).to receive(:ee?).and_return(false)
+ end
+
+ it 'sets ee to false' do
+ expect(subject.variables['ee']).to eq('false')
+ end
+ end
+
+ context 'when QA_BRANCH is set' do
+ before do
+ stub_env('QA_BRANCH', 'qa_branch')
+ end
+
+ it 'sets QA_BRANCH to qa_branch' do
+ expect(subject.variables['QA_BRANCH']).to eq('qa_branch')
+ end
+ end
+ end
+
+ describe '.access_token' do
+ context 'when OMNIBUS_GITLAB_PROJECT_ACCESS_TOKEN is set' do
+ let(:omnibus_gitlab_project_access_token) { 'omnibus_gitlab_project_access_token' }
+
+ before do
+ stub_env('OMNIBUS_GITLAB_PROJECT_ACCESS_TOKEN', omnibus_gitlab_project_access_token)
+ end
+
+ it 'returns the omnibus-specific access token' do
+ expect(described_class.access_token).to eq(omnibus_gitlab_project_access_token)
+ end
+ end
+
+ context 'when OMNIBUS_GITLAB_PROJECT_ACCESS_TOKEN is not set' do
+ before do
+ stub_env('OMNIBUS_GITLAB_PROJECT_ACCESS_TOKEN', nil)
+ end
+
+ it 'returns the default access token' do
+ expect(described_class.access_token).to eq(Trigger::Base.access_token)
+ end
+ end
+ end
+
+ describe '#invoke!' do
+ let(:downstream_project_path) { 'gitlab-org/build/omnibus-gitlab-mirror' }
+ let(:ref) { 'master' }
+
+ let(:env) do
+ super().merge(
+ 'QA_IMAGE' => 'qa_image',
+ 'OMNIBUS_GITLAB_PROJECT_ACCESS_TOKEN' => nil,
+ 'OMNIBUS_GITLAB_CACHE_UPDATE' => 'omnibus_gitlab_cache_update',
+ 'GITLAB_QA_OPTIONS' => 'gitlab_qa_options',
+ 'QA_TESTS' => 'qa_tests',
+ 'ALLURE_JOB_NAME' => 'allure_job_name'
+ )
+ end
+
+ describe '#downstream_project_path' do
+ context 'when OMNIBUS_PROJECT_PATH is set' do
+ let(:downstream_project_path) { 'omnibus_project_path' }
+
+ before do
+ stub_env('OMNIBUS_PROJECT_PATH', downstream_project_path)
+ end
+
+ it 'triggers the pipeline on the correct project' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+
+ describe '#ref' do
+ context 'when OMNIBUS_BRANCH is set' do
+ let(:ref) { 'omnibus_branch' }
+
+ before do
+ stub_env('OMNIBUS_BRANCH', ref)
+ end
+
+ it 'triggers the pipeline on the correct ref' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+
+ context 'when CI_COMMIT_REF_NAME is a stable branch' do
+ let(:ref) { '14-10-stable' }
+
+ before do
+ stub_env('CI_COMMIT_REF_NAME', "#{ref}-ee")
+ end
+
+ it 'triggers the pipeline on the correct ref' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+ end
+
+ describe Trigger::CNG do
+ describe '#variables' do
+ it 'does not include redundant variables' do
+ expect(subject.variables).not_to include('TRIGGER_SOURCE', 'TRIGGERED_USER')
+ end
+
+ it 'invokes the trigger with expected variables' do
+ expect(subject.variables).to include('FORCE_RAILS_IMAGE_BUILDS' => 'true')
+ end
+
+ describe "TRIGGER_BRANCH" do
+ context 'when CNG_BRANCH is not set' do
+ it 'sets TRIGGER_BRANCH to master' do
+ expect(subject.variables['TRIGGER_BRANCH']).to eq('master')
+ end
+ end
+
+ context 'when CNG_BRANCH is set' do
+ let(:ref) { 'cng_branch' }
+
+ before do
+ stub_env('CNG_BRANCH', ref)
+ end
+
+ it 'sets TRIGGER_BRANCH to cng_branch' do
+ expect(subject.variables['TRIGGER_BRANCH']).to eq(ref)
+ end
+ end
+
+ context 'when CI_COMMIT_REF_NAME is a stable branch' do
+ let(:ref) { '14-10-stable' }
+
+ before do
+ stub_env('CI_COMMIT_REF_NAME', "#{ref}-ee")
+ end
+
+ it 'sets TRIGGER_BRANCH to the corresponding stable branch' do
+ expect(subject.variables['TRIGGER_BRANCH']).to eq(ref)
+ end
+ end
+ end
+
+ describe "GITLAB_VERSION" do
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', 'ci_merge_request_source_branch_sha')
+ end
+
+ it 'sets GITLAB_VERSION to CI_MERGE_REQUEST_SOURCE_BRANCH_SHA' do
+ expect(subject.variables['GITLAB_VERSION']).to eq('ci_merge_request_source_branch_sha')
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set as empty' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', '')
+ end
+
+ it 'sets GITLAB_VERSION to CI_COMMIT_SHA' do
+ expect(subject.variables['GITLAB_VERSION']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is not set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', nil)
+ end
+
+ it 'sets GITLAB_VERSION to CI_COMMIT_SHA' do
+ expect(subject.variables['GITLAB_VERSION']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+ end
+
+ describe "GITLAB_TAG" do
+ context 'when CI_COMMIT_TAG is set' do
+ before do
+ stub_env('CI_COMMIT_TAG', 'v1.0')
+ end
+
+ it 'sets GITLAB_TAG to true' do
+ expect(subject.variables['GITLAB_TAG']).to eq('v1.0')
+ end
+ end
+
+ context 'when CI_COMMIT_TAG is nil' do
+ before do
+ stub_env('CI_COMMIT_TAG', nil)
+ end
+
+ it 'sets GITLAB_TAG to nil' do
+ expect(subject.variables['GITLAB_TAG']).to eq(nil)
+ end
+ end
+ end
+
+ describe "GITLAB_ASSETS_TAG" do
+ context 'when CI_COMMIT_TAG is set' do
+ before do
+ stub_env('CI_COMMIT_TAG', 'v1.0')
+ end
+
+ it 'sets GITLAB_ASSETS_TAG to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['GITLAB_ASSETS_TAG']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+
+ context 'when CI_COMMIT_TAG and CI_MERGE_REQUEST_SOURCE_BRANCH_SHA are nil' do
+ before do
+ stub_env('CI_COMMIT_TAG', nil)
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', nil)
+ end
+
+ it 'sets GITLAB_ASSETS_TAG to CI_COMMIT_SHA' do
+ expect(subject.variables['GITLAB_ASSETS_TAG']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+ end
+
+ describe "CE_PIPELINE" do
+ context 'when Trigger.ee? is true' do
+ before do
+ allow(Trigger).to receive(:ee?).and_return(true)
+ end
+
+ it 'sets CE_PIPELINE to nil' do
+ expect(subject.variables['CE_PIPELINE']).to eq(nil)
+ end
+ end
+
+ context 'when Trigger.ee? is false' do
+ before do
+ allow(Trigger).to receive(:ee?).and_return(false)
+ end
+
+ it 'sets CE_PIPELINE to true' do
+ expect(subject.variables['CE_PIPELINE']).to eq('true')
+ end
+ end
+ end
+
+ describe "EE_PIPELINE" do
+ context 'when Trigger.ee? is true' do
+ before do
+ allow(Trigger).to receive(:ee?).and_return(true)
+ end
+
+ it 'sets EE_PIPELINE to true' do
+ expect(subject.variables['EE_PIPELINE']).to eq('true')
+ end
+ end
+
+ context 'when Trigger.ee? is false' do
+ before do
+ allow(Trigger).to receive(:ee?).and_return(false)
+ end
+
+ it 'sets EE_PIPELINE to nil' do
+ expect(subject.variables['EE_PIPELINE']).to eq(nil)
+ end
+ end
+ end
+
+ describe "#version_param_value" do
+ using RSpec::Parameterized::TableSyntax
+
+ let(:version_file) { 'GITALY_SERVER_VERSION' }
+
+ where(:raw_version, :expected_version) do
+ "1.2.3" | "v1.2.3"
+ "1.2.3-rc1" | "v1.2.3-rc1"
+ "1.2.3-ee" | "v1.2.3-ee"
+ "1.2.3-rc1-ee" | "v1.2.3-rc1-ee"
+ end
+
+ with_them do
+ context "when set in ENV" do
+ before do
+ stub_env(version_file, raw_version)
+ end
+
+ it 'includes the version from ENV' do
+ expect(subject.variables[version_file]).to eq(expected_version)
+ end
+ end
+ end
+ end
+ end
+ end
+
+ describe Trigger::Docs do
+ describe '#variables' do
+ describe "BRANCH_CE" do
+ before do
+ stub_env('CI_PROJECT_PATH', 'gitlab-org/gitlab-foss')
+ end
+
+ context 'when CI_PROJECT_PATH is gitlab-org/gitlab-foss' do
+ it 'sets BRANCH_CE to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['BRANCH_CE']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+ end
+
+ describe "BRANCH_EE" do
+ before do
+ stub_env('CI_PROJECT_PATH', 'gitlab-org/gitlab')
+ end
+
+ context 'when CI_PROJECT_PATH is gitlab-org/gitlab' do
+ it 'sets BRANCH_EE to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['BRANCH_EE']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+ end
+
+ describe "BRANCH_RUNNER" do
+ before do
+ stub_env('CI_PROJECT_PATH', 'gitlab-org/gitlab-runner')
+ end
+
+ context 'when CI_PROJECT_PATH is gitlab-org/gitlab-runner' do
+ it 'sets BRANCH_RUNNER to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['BRANCH_RUNNER']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+ end
+
+ describe "BRANCH_OMNIBUS" do
+ before do
+ stub_env('CI_PROJECT_PATH', 'gitlab-org/omnibus-gitlab')
+ end
+
+ context 'when CI_PROJECT_PATH is gitlab-org/omnibus-gitlab' do
+ it 'sets BRANCH_OMNIBUS to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['BRANCH_OMNIBUS']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+ end
+
+ describe "BRANCH_CHARTS" do
+ before do
+ stub_env('CI_PROJECT_PATH', 'gitlab-org/charts/gitlab')
+ end
+
+ context 'when CI_PROJECT_PATH is gitlab-org/charts/gitlab' do
+ it 'sets BRANCH_CHARTS to CI_COMMIT_REF_NAME' do
+ expect(subject.variables['BRANCH_CHARTS']).to eq(env['CI_COMMIT_REF_NAME'])
+ end
+ end
+ end
+
+ describe "REVIEW_SLUG" do
+ before do
+ stub_env('CI_PROJECT_PATH', 'gitlab-org/gitlab-foss')
+ end
+
+ context 'when CI_MERGE_REQUEST_IID is set' do
+ it 'sets REVIEW_SLUG' do
+ expect(subject.variables['REVIEW_SLUG']).to eq("-ce-#{env['CI_MERGE_REQUEST_IID']}")
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_IID is not set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_IID', nil)
+ end
+
+ it 'sets REVIEW_SLUG' do
+ expect(subject.variables['REVIEW_SLUG']).to eq("-ce-#{env['CI_COMMIT_REF_SLUG']}")
+ end
+ end
+ end
+ end
+
+ describe '.access_token' do
+ context 'when DOCS_PROJECT_API_TOKEN is set' do
+ let(:docs_project_api_token) { 'docs_project_api_token' }
+
+ before do
+ stub_env('DOCS_PROJECT_API_TOKEN', docs_project_api_token)
+ end
+
+ it 'returns the docs-specific access token' do
+ expect(described_class.access_token).to eq(docs_project_api_token)
+ end
+ end
+
+ context 'when DOCS_PROJECT_API_TOKEN is not set' do
+ before do
+ stub_env('DOCS_PROJECT_API_TOKEN', nil)
+ end
+
+ it 'returns the default access token' do
+ expect(described_class.access_token).to eq(Trigger::Base.access_token)
+ end
+ end
+ end
+
+ describe '#invoke!' do
+ let(:downstream_project_path) { 'gitlab-org/gitlab-docs' }
+ let(:trigger_token) { 'docs_trigger_token' }
+ let(:ref) { 'main' }
+
+ let(:env) do
+ super().merge(
+ 'CI_PROJECT_PATH' => 'gitlab-org/gitlab-foss',
+ 'DOCS_PROJECT_API_TOKEN' => nil,
+ 'DOCS_TRIGGER_TOKEN' => trigger_token
+ )
+ end
+
+ describe '#downstream_project_path' do
+ context 'when DOCS_PROJECT_PATH is set' do
+ let(:downstream_project_path) { 'docs_project_path' }
+
+ before do
+ stub_env('DOCS_PROJECT_PATH', downstream_project_path)
+ end
+
+ it 'triggers the pipeline on the correct project' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+
+ describe '#ref' do
+ context 'when DOCS_BRANCH is set' do
+ let(:ref) { 'docs_branch' }
+
+ before do
+ stub_env('DOCS_BRANCH', ref)
+ end
+
+ it 'triggers the pipeline on the correct ref' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+ end
+ end
+
+ describe Trigger::DatabaseTesting do
+ describe '#variables' do
+ it 'invokes the trigger with expected variables' do
+ expect(subject.variables).to include('TRIGGERED_USER_LOGIN' => env['GITLAB_USER_LOGIN'])
+ end
+
+ describe "GITLAB_COMMIT_SHA" do
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', 'ci_merge_request_source_branch_sha')
+ end
+
+ it 'sets GITLAB_COMMIT_SHA to ci_merge_request_source_branch_sha' do
+ expect(subject.variables['GITLAB_COMMIT_SHA']).to eq('ci_merge_request_source_branch_sha')
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is set as empty' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', '')
+ end
+
+ it 'sets GITLAB_COMMIT_SHA to CI_COMMIT_SHA' do
+ expect(subject.variables['GITLAB_COMMIT_SHA']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+
+ context 'when CI_MERGE_REQUEST_SOURCE_BRANCH_SHA is not set' do
+ before do
+ stub_env('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', nil)
+ end
+
+ it 'sets GITLAB_COMMIT_SHA to CI_COMMIT_SHA' do
+ expect(subject.variables['GITLAB_COMMIT_SHA']).to eq(env['CI_COMMIT_SHA'])
+ end
+ end
+ end
+ end
+
+ describe '#invoke!' do
+ let(:downstream_project_path) { 'gitlab-com/database-team/gitlab-com-database-testing' }
+ let(:trigger_token) { 'gitlabcom_database_testing_access_token' }
+ let(:api_endpoint) { 'https://ops.gitlab.net/api/v4' }
+ let(:gitlab_client_private_token) { 'gitlabcom_database_testing_access_token' }
+ let(:ref) { 'master' }
+ let(:stubbed_upstream_gitlab_client) { double('upstream_gitlab_api_client') }
+ let(:mr_notes) { [double(body: described_class::IDENTIFIABLE_NOTE_TAG)] }
+
+ let(:env) do
+ super().merge(
+ 'GITLABCOM_DATABASE_TESTING_ACCESS_TOKEN' => gitlab_client_private_token,
+ 'GITLABCOM_DATABASE_TESTING_TRIGGER_TOKEN' => trigger_token
+ )
+ end
+
+ before do
+ allow(Gitlab).to receive(:client)
+ .with(
+ endpoint: 'https://gitlab.com/api/v4',
+ private_token: env['GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN']
+ )
+ .and_return(stubbed_upstream_gitlab_client)
+ allow(stubbed_upstream_gitlab_client).to receive(:merge_request_notes)
+ .with(
+ env['CI_PROJECT_PATH'],
+ env['CI_MERGE_REQUEST_IID']
+ )
+ .and_return(double(auto_paginate: mr_notes))
+ end
+
+ it 'invokes the trigger with expected variables' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+
+ describe '#downstream_project_path' do
+ context 'when GITLABCOM_DATABASE_TESTING_PROJECT_PATH is set' do
+ let(:downstream_project_path) { 'gitlabcom_database_testing_project_path' }
+
+ before do
+ stub_env('GITLABCOM_DATABASE_TESTING_PROJECT_PATH', downstream_project_path)
+ end
+
+ it 'triggers the pipeline on the correct project' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+
+ describe '#ref' do
+ context 'when GITLABCOM_DATABASE_TESTING_TRIGGER_REF is set' do
+ let(:ref) { 'gitlabcom_database_testing_trigger_ref' }
+
+ before do
+ stub_env('GITLABCOM_DATABASE_TESTING_TRIGGER_REF', ref)
+ end
+
+ it 'triggers the pipeline on the correct ref' do
+ expect_run_trigger_with_params
+
+ subject.invoke!
+ end
+ end
+ end
+
+ context 'when no MR notes with the identifier exist yet' do
+ let(:mr_notes) { [double(body: 'hello world')] }
+
+ it 'posts a new note' do
+ expect_run_trigger_with_params
+ expect(stubbed_upstream_gitlab_client).to receive(:create_merge_request_note)
+ .with(
+ env['CI_PROJECT_PATH'],
+ env['CI_MERGE_REQUEST_IID'],
+ instance_of(String)
+ )
+ .and_return(double(id: 42))
+
+ subject.invoke!
+ end
+ end
+ end
+ end
+end
+# rubocop:enable RSpec/VerifiedDoubles