2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
require 'spec_helper'
2023-05-27 22:25:52 +05:30
RSpec . describe Gitlab :: Ci :: Config :: External :: Mapper , feature_category : :pipeline_composition do
2019-06-05 12:25:43 +05:30
include StubRequests
2023-03-04 22:38:38 +05:30
include RepoHelpers
2019-06-05 12:25:43 +05:30
2020-04-08 14:13:33 +05:30
let_it_be ( :project ) { create ( :project , :repository ) }
2022-07-23 23:45:48 +05:30
let_it_be ( :user ) { project . owner }
2021-06-08 01:23:25 +05:30
2019-02-15 15:39:39 +05:30
let ( :local_file ) { '/lib/gitlab/ci/templates/non-existent-file.yml' }
2019-12-04 20:38:33 +05:30
let ( :remote_url ) { 'https://gitlab.com/gitlab-org/gitlab-foss/blob/1234/.gitlab-ci-1.yml' }
2019-02-15 15:39:39 +05:30
let ( :template_file ) { 'Auto-DevOps.gitlab-ci.yml' }
2022-04-01 21:47:47 +05:30
let ( :variables ) { project . predefined_variables }
2023-03-04 22:38:38 +05:30
let ( :context_params ) { { project : project , sha : project . commit . sha , user : user , variables : variables } }
2019-12-21 20:55:43 +05:30
let ( :context ) { Gitlab :: Ci :: Config :: External :: Context . new ( ** context_params ) }
2019-02-15 15:39:39 +05:30
2018-12-05 23:21:45 +05:30
let ( :file_content ) do
2023-03-04 22:38:38 +05:30
<< ~ YAML
2022-06-21 17:19:12 +05:30
image : 'image:1.0'
2023-03-04 22:38:38 +05:30
YAML
2018-12-05 23:21:45 +05:30
end
2022-06-21 17:19:12 +05:30
subject ( :mapper ) { described_class . new ( values , context ) }
2019-02-15 15:39:39 +05:30
before do
2019-06-05 12:25:43 +05:30
stub_full_request ( remote_url ) . to_return ( body : file_content )
2019-12-21 20:55:43 +05:30
2020-01-01 13:55:28 +05:30
allow_next_instance_of ( Gitlab :: Ci :: Config :: External :: Context ) do | instance |
allow ( instance ) . to receive ( :check_execution_time! )
end
2019-02-15 15:39:39 +05:30
end
2018-12-05 23:21:45 +05:30
describe '#process' do
2022-06-21 17:19:12 +05:30
subject ( :process ) { mapper . process }
2018-12-05 23:21:45 +05:30
2022-07-23 23:45:48 +05:30
shared_examples 'logging config file fetch' do | key , count |
it 'propagates the pipeline logger' do
process
2023-03-04 22:38:38 +05:30
fetch_content_log_count = context
2022-07-23 23:45:48 +05:30
. logger
. observations_hash
. dig ( key , 'count' )
expect ( fetch_content_log_count ) . to eq ( count )
end
end
2019-02-15 15:39:39 +05:30
context " when single 'include' keyword is defined " do
2018-12-05 23:21:45 +05:30
context 'when the string is a local file' do
let ( :values ) do
2019-02-15 15:39:39 +05:30
{ include : local_file ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2019-02-15 15:39:39 +05:30
end
it 'returns File instances' do
expect ( subject ) . to contain_exactly (
an_instance_of ( Gitlab :: Ci :: Config :: External :: File :: Local ) )
2018-12-05 23:21:45 +05:30
end
2022-07-23 23:45:48 +05:30
it_behaves_like 'logging config file fetch' , 'config_file_fetch_local_content_duration_s' , 1
2019-02-15 15:39:39 +05:30
end
2018-12-05 23:21:45 +05:30
2019-02-15 15:39:39 +05:30
context 'when the key is a local file hash' do
let ( :values ) do
{ include : { 'local' = > local_file } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2018-12-05 23:21:45 +05:30
end
it 'returns File instances' do
2019-02-15 15:39:39 +05:30
expect ( subject ) . to contain_exactly (
an_instance_of ( Gitlab :: Ci :: Config :: External :: File :: Local ) )
2018-12-05 23:21:45 +05:30
end
end
context 'when the string is a remote file' do
let ( :values ) do
2022-06-21 17:19:12 +05:30
{ include : remote_url , image : 'image:1.0' }
2019-02-15 15:39:39 +05:30
end
it 'returns File instances' do
expect ( subject ) . to contain_exactly (
an_instance_of ( Gitlab :: Ci :: Config :: External :: File :: Remote ) )
end
2022-07-23 23:45:48 +05:30
it_behaves_like 'logging config file fetch' , 'config_file_fetch_remote_content_duration_s' , 1
2019-02-15 15:39:39 +05:30
end
context 'when the key is a remote file hash' do
let ( :values ) do
{ include : { 'remote' = > remote_url } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2018-12-05 23:21:45 +05:30
end
2019-02-15 15:39:39 +05:30
it 'returns File instances' do
expect ( subject ) . to contain_exactly (
an_instance_of ( Gitlab :: Ci :: Config :: External :: File :: Remote ) )
2018-12-05 23:21:45 +05:30
end
2019-02-15 15:39:39 +05:30
end
2018-12-05 23:21:45 +05:30
2019-02-15 15:39:39 +05:30
context 'when the key is a template file hash' do
let ( :values ) do
{ include : { 'template' = > template_file } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2018-12-05 23:21:45 +05:30
end
it 'returns File instances' do
2019-02-15 15:39:39 +05:30
expect ( subject ) . to contain_exactly (
an_instance_of ( Gitlab :: Ci :: Config :: External :: File :: Template ) )
end
2022-07-23 23:45:48 +05:30
it_behaves_like 'logging config file fetch' , 'config_file_fetch_template_content_duration_s' , 1
2019-02-15 15:39:39 +05:30
end
2023-01-13 00:05:48 +05:30
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
2023-04-23 21:23:45 +05:30
expect { subject } . to raise_error ( described_class :: AmbigiousSpecificationError , / `{"invalid":"secret-file.yml"}` does not have a valid subkey for include. Valid subkeys are: / )
2023-01-13 00:05:48 +05:30
end
end
context 'when the key is a hash of local and remote' do
2022-04-01 21:47:47 +05:30
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' }
2019-02-15 15:39:39 +05:30
let ( :values ) do
{ include : { 'local' = > local_file , 'remote' = > remote_url } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2019-02-15 15:39:39 +05:30
end
it 'returns ambigious specification error' do
2023-04-23 21:23:45 +05:30
expect { subject } . to raise_error ( described_class :: AmbigiousSpecificationError , / Each include must use only one of / )
2018-12-05 23:21:45 +05:30
end
end
2021-01-29 00:20:46 +05:30
context " when the key is a project's file " do
let ( :values ) do
{ include : { project : project . full_path , file : local_file } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-01-29 00:20:46 +05:30
end
it 'returns File instances' do
expect ( subject ) . to contain_exactly (
an_instance_of ( Gitlab :: Ci :: Config :: External :: File :: Project ) )
end
2022-07-23 23:45:48 +05:30
it_behaves_like 'logging config file fetch' , 'config_file_fetch_project_content_duration_s' , 1
2021-01-29 00:20:46 +05:30
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' ] } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-01-29 00:20:46 +05:30
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
2022-07-23 23:45:48 +05:30
2023-04-23 21:23:45 +05:30
it_behaves_like 'logging config file fetch' , 'config_file_fetch_project_content_duration_s' , 1
2021-01-29 00:20:46 +05:30
end
2018-12-05 23:21:45 +05:30
end
context " when 'include' is defined as an array " do
let ( :values ) do
2019-02-15 15:39:39 +05:30
{ include : [ remote_url , local_file ] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2018-12-05 23:21:45 +05:30
end
2019-02-15 15:39:39 +05:30
it 'returns Files instances' do
expect ( subject ) . to all ( respond_to ( :valid? ) )
expect ( subject ) . to all ( respond_to ( :content ) )
2018-12-05 23:21:45 +05:30
end
2019-02-15 15:39:39 +05:30
end
2018-12-05 23:21:45 +05:30
2019-02-15 15:39:39 +05:30
context " when 'include' is defined as an array of hashes " do
let ( :values ) do
{ include : [ { remote : remote_url } , { local : local_file } ] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2018-12-05 23:21:45 +05:30
end
it 'returns Files instances' do
expect ( subject ) . to all ( respond_to ( :valid? ) )
expect ( subject ) . to all ( respond_to ( :content ) )
end
2019-02-15 15:39:39 +05:30
context 'when it has ambigious match' do
let ( :values ) do
{ include : [ { remote : remote_url , local : local_file } ] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2019-02-15 15:39:39 +05:30
end
it 'returns ambigious specification error' do
expect { subject } . to raise_error ( described_class :: AmbigiousSpecificationError )
end
end
2018-12-05 23:21:45 +05:30
end
context " when 'include' is not defined " do
let ( :values ) do
{
2022-06-21 17:19:12 +05:30
image : 'image:1.0'
2018-12-05 23:21:45 +05:30
}
end
it 'returns an empty array' do
expect ( subject ) . to be_empty
end
end
2019-07-07 11:18:12 +05:30
2022-04-04 11:22:00 +05:30
context " when duplicate 'include's are defined " do
let ( :values ) do
{ include : [
2022-11-25 23:54:43 +05:30
{ 'local' = > local_file } ,
{ 'local' = > local_file }
] ,
2022-10-11 01:57:18 +05:30
image : 'image:1.0' }
2022-04-04 11:22:00 +05:30
end
it 'does not raise an exception' do
2022-06-21 17:19:12 +05:30
expect { process } . not_to raise_error
end
2023-04-23 21:23:45 +05:30
it 'has expanset with two' do
2022-06-21 17:19:12 +05:30
process
2023-04-23 21:23:45 +05:30
expect ( context . expandset . size ) . to eq ( 2 )
end
2022-04-04 11:22:00 +05:30
end
context 'when passing max number of files' do
2019-07-07 11:18:12 +05:30
let ( :values ) do
{ include : [
{ 'local' = > local_file } ,
2022-04-04 11:22:00 +05:30
{ 'remote' = > remote_url }
2019-07-07 11:18:12 +05:30
] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2019-07-07 11:18:12 +05:30
end
2022-04-04 11:22:00 +05:30
it 'does not raise an exception' do
2022-08-13 15:12:31 +05:30
allow ( context ) . to receive ( :max_includes ) . and_return ( 2 )
2022-04-04 11:22:00 +05:30
expect { subject } . not_to raise_error
2021-01-29 00:20:46 +05:30
end
2019-07-07 11:18:12 +05:30
end
context " when too many 'includes' are defined " do
let ( :values ) do
{ include : [
{ 'local' = > local_file } ,
{ 'remote' = > remote_url }
] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2019-07-07 11:18:12 +05:30
end
it 'raises an exception' do
2022-08-13 15:12:31 +05:30
allow ( context ) . to receive ( :max_includes ) . and_return ( 1 )
2019-07-07 11:18:12 +05:30
expect { subject } . to raise_error ( described_class :: TooManyIncludesError )
end
2021-01-29 00:20:46 +05:30
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
2022-08-13 15:12:31 +05:30
allow ( context ) . to receive ( :max_includes ) . and_return ( 1 )
2021-01-29 00:20:46 +05:30
expect { subject } . to raise_error ( described_class :: TooManyIncludesError )
end
end
2019-07-07 11:18:12 +05:30
end
2021-03-08 18:12:59 +05:30
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 ] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-03-08 18:12:59 +05:30
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 } ] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-03-08 18:12:59 +05:30
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 } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-03-08 18:12:59 +05:30
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' ] } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-03-08 18:12:59 +05:30
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 } ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-03-08 18:12:59 +05:30
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
2021-04-29 21:17:54 +05:30
context 'when local file path has wildcard' do
2023-03-04 22:38:38 +05:30
let_it_be ( :project ) { create ( :project , :repository ) }
2021-04-29 21:17:54 +05:30
let ( :values ) do
{ include : 'myfolder/*.yml' }
end
2023-03-04 22:38:38 +05:30
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
2021-04-29 21:17:54 +05:30
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
2021-10-27 15:23:28 +05:30
end
context " when 'include' has rules " do
let ( :values ) do
{ include : [ { remote : remote_url } ,
{ local : local_file , rules : [ { if : " $CI_PROJECT_ID == ' #{ project_id } ' " } ] } ] ,
2022-06-21 17:19:12 +05:30
image : 'image:1.0' }
2021-10-27 15:23:28 +05:30
end
2021-04-29 21:17:54 +05:30
2021-10-27 15:23:28 +05:30
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 ) )
2021-04-29 21:17:54 +05:30
end
2021-10-27 15:23:28 +05:30
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
2021-04-29 21:17:54 +05:30
end
end
2022-06-21 17:19:12 +05:30
context " when locations are same after masking variables " do
let ( :variables ) do
2022-11-25 23:54:43 +05:30
Gitlab :: Ci :: Variables :: Collection . new (
[
{ 'key' = > 'GITLAB_TOKEN' , 'value' = > 'secret-file1' , 'masked' = > true } ,
{ 'key' = > 'GITLAB_TOKEN' , 'value' = > 'secret-file2' , 'masked' = > true }
] )
2022-06-21 17:19:12 +05:30
end
let ( :values ) do
{ include : [
2022-11-25 23:54:43 +05:30
{ 'local' = > 'hello/secret-file1.yml' } ,
{ 'local' = > 'hello/secret-file2.yml' }
] ,
2022-10-11 01:57:18 +05:30
image : 'ruby:2.7' }
2022-06-21 17:19:12 +05:30
end
it 'has expanset with two' do
process
2023-03-04 22:38:38 +05:30
expect ( context . expandset . size ) . to eq ( 2 )
2022-06-21 17:19:12 +05:30
end
end
2018-12-05 23:21:45 +05:30
end
end