# frozen_string_literal: true require 'spec_helper' RSpec.describe Gitlab::Ci::Config::External::Mapper, feature_category: :pipeline_composition do include StubRequests include RepoHelpers let_it_be(:project) { create(:project, :repository) } let_it_be(:user) { project.owner } let(:local_file) { '/lib/gitlab/ci/templates/non-existent-file.yml' } let(:remote_url) { 'https://gitlab.com/gitlab-org/gitlab-foss/blob/1234/.gitlab-ci-1.yml' } let(:template_file) { 'Auto-DevOps.gitlab-ci.yml' } let(:variables) { project.predefined_variables } let(:context_params) { { project: project, sha: project.commit.sha, user: user, variables: variables } } let(:context) { Gitlab::Ci::Config::External::Context.new(**context_params) } let(:file_content) do <<~YAML image: 'image:1.0' YAML end subject(:mapper) { described_class.new(values, context) } before do stub_full_request(remote_url).to_return(body: file_content) allow_next_instance_of(Gitlab::Ci::Config::External::Context) do |instance| allow(instance).to receive(:check_execution_time!) end end describe '#process' do subject(:process) { mapper.process } shared_examples 'logging config file fetch' do |key, count| it 'propagates the pipeline logger' do process fetch_content_log_count = context .logger .observations_hash .dig(key, 'count') expect(fetch_content_log_count).to eq(count) end end context "when single 'include' keyword is defined" do context 'when the string is a local file' do let(:values) do { include: local_file, image: 'image:1.0' } end it 'returns File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Local)) end it_behaves_like 'logging config file fetch', 'config_file_fetch_local_content_duration_s', 1 end context 'when the key is a local file hash' do let(:values) do { include: { 'local' => local_file }, image: 'image:1.0' } end it 'returns File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Local)) end end context 'when the string is a remote file' do let(:values) do { include: remote_url, image: 'image:1.0' } end it 'returns File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Remote)) end it_behaves_like 'logging config file fetch', 'config_file_fetch_remote_content_duration_s', 1 end context 'when the key is a remote file hash' do let(:values) do { include: { 'remote' => remote_url }, image: 'image:1.0' } end it 'returns File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Remote)) end end context 'when the key is a template file hash' do let(:values) do { include: { 'template' => template_file }, image: 'image:1.0' } end it 'returns File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Template)) end it_behaves_like 'logging config file fetch', 'config_file_fetch_template_content_duration_s', 1 end context 'when the key is not valid' do let(:local_file) { 'secret-file.yml' } let(:values) do { include: { invalid: local_file }, image: 'image:1.0' } end it 'returns ambigious specification error' do expect { subject }.to raise_error(described_class::AmbigiousSpecificationError, /`{"invalid":"secret-file.yml"}` does not have a valid subkey for include. Valid subkeys are:/) end end context 'when the key is a hash of local and remote' do let(:variables) { Gitlab::Ci::Variables::Collection.new([{ 'key' => 'GITLAB_TOKEN', 'value' => 'secret-file', 'masked' => true }]) } let(:local_file) { 'secret-file.yml' } let(:remote_url) { 'https://gitlab.com/secret-file.yml' } let(:values) do { include: { 'local' => local_file, 'remote' => remote_url }, image: 'image:1.0' } end it 'returns ambigious specification error' do expect { subject }.to raise_error(described_class::AmbigiousSpecificationError, /Each include must use only one of/) end end context "when the key is a project's file" do let(:values) do { include: { project: project.full_path, file: local_file }, image: 'image:1.0' } end it 'returns File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Project)) end it_behaves_like 'logging config file fetch', 'config_file_fetch_project_content_duration_s', 1 end context "when the key is project's files" do let(:values) do { include: { project: project.full_path, file: [local_file, 'another_file_path.yml'] }, image: 'image:1.0' } end it 'returns two File instances' do expect(subject).to contain_exactly( an_instance_of(Gitlab::Ci::Config::External::File::Project), an_instance_of(Gitlab::Ci::Config::External::File::Project)) end it_behaves_like 'logging config file fetch', 'config_file_fetch_project_content_duration_s', 1 end end context "when 'include' is defined as an array" do let(:values) do { include: [remote_url, local_file], image: 'image:1.0' } end it 'returns Files instances' do expect(subject).to all(respond_to(:valid?)) expect(subject).to all(respond_to(:content)) end end context "when 'include' is defined as an array of hashes" do let(:values) do { include: [{ remote: remote_url }, { local: local_file }], image: 'image:1.0' } end it 'returns Files instances' do expect(subject).to all(respond_to(:valid?)) expect(subject).to all(respond_to(:content)) end context 'when it has ambigious match' do let(:values) do { include: [{ remote: remote_url, local: local_file }], image: 'image:1.0' } end it 'returns ambigious specification error' do expect { subject }.to raise_error(described_class::AmbigiousSpecificationError) end end end context "when 'include' is not defined" do let(:values) do { image: 'image:1.0' } end it 'returns an empty array' do expect(subject).to be_empty end end context "when duplicate 'include's are defined" do let(:values) do { include: [ { 'local' => local_file }, { 'local' => local_file } ], image: 'image:1.0' } end it 'does not raise an exception' do expect { process }.not_to raise_error end it 'has expanset with two' do process expect(context.expandset.size).to eq(2) end end context 'when passing max number of files' do let(:values) do { include: [ { 'local' => local_file }, { 'remote' => remote_url } ], image: 'image:1.0' } end it 'does not raise an exception' do allow(context).to receive(:max_includes).and_return(2) expect { subject }.not_to raise_error end end context "when too many 'includes' are defined" do let(:values) do { include: [ { 'local' => local_file }, { 'remote' => remote_url } ], image: 'image:1.0' } end it 'raises an exception' do allow(context).to receive(:max_includes).and_return(1) expect { subject }.to raise_error(described_class::TooManyIncludesError) end context 'when including multiple files from a project' do let(:values) do { include: { project: project.full_path, file: [local_file, 'another_file_path.yml'] } } end it 'raises an exception' do allow(context).to receive(:max_includes).and_return(1) expect { subject }.to raise_error(described_class::TooManyIncludesError) end end end context "when 'include' section uses project variable" do let(:full_local_file_path) { '$CI_PROJECT_PATH' + local_file } context 'when local file is included as a single string' do let(:values) do { include: full_local_file_path } end it 'expands the variable', :aggregate_failures do expect(subject[0].location).to eq(project.full_path + local_file) expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Local)) end end context 'when remote file is included as a single string' do let(:remote_url) { "#{Gitlab.config.gitlab.url}/radio/.gitlab-ci.yml" } let(:values) do { include: '$CI_SERVER_URL/radio/.gitlab-ci.yml' } end it 'expands the variable', :aggregate_failures do expect(subject[0].location).to eq(remote_url) expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Remote)) end end context 'defined as an array' do let(:values) do { include: [full_local_file_path, remote_url], image: 'image:1.0' } end it 'expands the variable' do expect(subject[0].location).to eq(project.full_path + local_file) expect(subject[1].location).to eq(remote_url) end end context 'defined as an array of hashes' do let(:values) do { include: [{ local: full_local_file_path }, { remote: remote_url }], image: 'image:1.0' } end it 'expands the variable' do expect(subject[0].location).to eq(project.full_path + local_file) expect(subject[1].location).to eq(remote_url) end end context 'local file hash' do let(:values) do { include: { 'local' => full_local_file_path } } end it 'expands the variable' do expect(subject[0].location).to eq(project.full_path + local_file) end end context 'project name' do let(:values) do { include: { project: '$CI_PROJECT_PATH', file: local_file }, image: 'image:1.0' } end it 'expands the variable', :aggregate_failures do expect(subject[0].project_name).to eq(project.full_path) expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Project)) end end context 'with multiple files' do let(:values) do { include: { project: project.full_path, file: [full_local_file_path, 'another_file_path.yml'] }, image: 'image:1.0' } end it 'expands the variable' do expect(subject[0].location).to eq(project.full_path + local_file) expect(subject[1].location).to eq('another_file_path.yml') end end context 'when include variable has an unsupported type for variable expansion' do let(:values) do { include: { project: project.id, file: local_file }, image: 'image:1.0' } end it 'does not invoke expansion for the variable', :aggregate_failures do expect(ExpandVariables).not_to receive(:expand).with(project.id, context_params[:variables]) expect { subject }.to raise_error(described_class::AmbigiousSpecificationError) end end end context 'when local file path has wildcard' do let_it_be(:project) { create(:project, :repository) } let(:values) do { include: 'myfolder/*.yml' } end let(:project_files) do { 'myfolder/file1.yml' => <<~YAML, my_build: script: echo Hello World YAML 'myfolder/file2.yml' => <<~YAML my_test: script: echo Hello World YAML } end around do |example| create_and_delete_files(project, project_files) do example.run end end it 'includes the matched local files' do expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Local), an_instance_of(Gitlab::Ci::Config::External::File::Local)) expect(subject.map(&:location)).to contain_exactly('myfolder/file1.yml', 'myfolder/file2.yml') end end context "when 'include' has rules" do let(:values) do { include: [{ remote: remote_url }, { local: local_file, rules: [{ if: "$CI_PROJECT_ID == '#{project_id}'" }] }], image: 'image:1.0' } end context 'when the rules matches' do let(:project_id) { project.id } it 'includes the file' do expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Remote), an_instance_of(Gitlab::Ci::Config::External::File::Local)) end end context 'when the rules does not match' do let(:project_id) { non_existing_record_id } it 'does not include the file' do expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Remote)) end end end context "when locations are same after masking variables" do let(:variables) do Gitlab::Ci::Variables::Collection.new( [ { 'key' => 'GITLAB_TOKEN', 'value' => 'secret-file1', 'masked' => true }, { 'key' => 'GITLAB_TOKEN', 'value' => 'secret-file2', 'masked' => true } ]) end let(:values) do { include: [ { 'local' => 'hello/secret-file1.yml' }, { 'local' => 'hello/secret-file2.yml' } ], image: 'ruby:2.7' } end it 'has expanset with two' do process expect(context.expandset.size).to eq(2) end end end end