debian-mirror-gitlab/spec/lib/gitlab/ci/config/entry/root_spec.rb

366 lines
11 KiB
Ruby
Raw Normal View History

2019-10-12 21:52:04 +05:30
# frozen_string_literal: true
require 'spec_helper'
2019-09-30 21:07:59 +05:30
describe Gitlab::Ci::Config::Entry::Root do
let(:root) { described_class.new(hash) }
2016-08-24 12:49:21 +05:30
describe '.nodes' do
2017-08-17 22:00:37 +05:30
it 'returns a hash' do
expect(described_class.nodes).to be_a(Hash)
end
2017-08-17 22:00:37 +05:30
context 'when filtering all the entry/node names' do
it 'contains the expected node names' do
2019-12-26 22:10:19 +05:30
# No inheritable fields should be added to the `Root`
#
# Inheritable configuration can only be added to `default:`
#
# The purpose of `Root` is have only globally defined configuration.
2017-08-17 22:00:37 +05:30
expect(described_class.nodes.keys)
2019-12-26 22:10:19 +05:30
.to match_array(%i[before_script image services after_script
variables cache stages types include default workflow])
2017-08-17 22:00:37 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
context 'when configuration is valid' do
2019-09-30 21:07:59 +05:30
context 'when top-level entries are defined' do
2016-08-24 12:49:21 +05:30
let(:hash) do
2017-08-17 22:00:37 +05:30
{ before_script: %w(ls pwd),
2016-08-24 12:49:21 +05:30
image: 'ruby:2.2',
2019-09-30 21:07:59 +05:30
default: {},
2016-08-24 12:49:21 +05:30
services: ['postgres:9.1', 'mysql:5.5'],
variables: { VAR: 'value' },
after_script: ['make clean'],
2017-08-17 22:00:37 +05:30
stages: %w(build pages),
2016-09-13 17:45:13 +05:30
cache: { key: 'k', untracked: true, paths: ['public/'] },
rspec: { script: %w[rspec ls] },
2016-09-29 09:46:39 +05:30
spinach: { before_script: [], variables: {}, script: 'spinach' } }
2016-08-24 12:49:21 +05:30
end
2016-09-29 09:46:39 +05:30
describe '#compose!' do
2017-09-10 17:25:29 +05:30
before do
2019-09-30 21:07:59 +05:30
root.compose!
2017-09-10 17:25:29 +05:30
end
2016-08-24 12:49:21 +05:30
it 'creates nodes hash' do
2019-09-30 21:07:59 +05:30
expect(root.descendants).to be_an Array
2016-08-24 12:49:21 +05:30
end
2016-08-24 12:49:21 +05:30
it 'creates node object for each entry' do
2019-12-26 22:10:19 +05:30
expect(root.descendants.count).to eq 11
2016-08-24 12:49:21 +05:30
end
it 'creates node object using valid class' do
2019-09-30 21:07:59 +05:30
expect(root.descendants.first)
.to be_an_instance_of Gitlab::Ci::Config::Entry::Default
expect(root.descendants.second)
.to be_an_instance_of Gitlab::Config::Entry::Unspecified
2016-08-24 12:49:21 +05:30
end
it 'sets correct description for nodes' do
2019-09-30 21:07:59 +05:30
expect(root.descendants.first.description)
.to eq 'Default configuration for all jobs.'
expect(root.descendants.second.description)
.to eq 'List of external YAML files to include.'
2016-08-24 12:49:21 +05:30
end
2016-09-13 17:45:13 +05:30
describe '#leaf?' do
it 'is not leaf' do
2019-09-30 21:07:59 +05:30
expect(root).not_to be_leaf
2016-09-13 17:45:13 +05:30
end
end
end
2016-09-29 09:46:39 +05:30
context 'when composed' do
2017-09-10 17:25:29 +05:30
before do
2019-09-30 21:07:59 +05:30
root.compose!
2017-09-10 17:25:29 +05:30
end
2016-09-29 09:46:39 +05:30
describe '#errors' do
it 'has no errors' do
2019-09-30 21:07:59 +05:30
expect(root.errors).to be_empty
2016-08-24 12:49:21 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe '#stages_value' do
2016-08-24 12:49:21 +05:30
context 'when stages key defined' do
it 'returns array of stages' do
2019-09-30 21:07:59 +05:30
expect(root.stages_value).to eq %w[build pages]
2016-08-24 12:49:21 +05:30
end
end
context 'when deprecated types key defined' do
2016-09-13 17:45:13 +05:30
let(:hash) do
2017-08-17 22:00:37 +05:30
{ types: %w(test deploy),
2016-09-13 17:45:13 +05:30
rspec: { script: 'rspec' } }
end
2016-08-24 12:49:21 +05:30
it 'returns array of types as stages' do
2019-09-30 21:07:59 +05:30
expect(root.stages_value).to eq %w[test deploy]
2016-08-24 12:49:21 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
describe '#jobs_value' do
2016-09-13 17:45:13 +05:30
it 'returns jobs configuration' do
2019-09-30 21:07:59 +05:30
expect(root.jobs_value).to eq(
2016-09-13 17:45:13 +05:30
rspec: { name: :rspec,
script: %w[rspec ls],
2017-08-17 22:00:37 +05:30
before_script: %w(ls pwd),
2017-09-10 17:25:29 +05:30
image: { name: 'ruby:2.2' },
services: [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }],
2016-09-29 09:46:39 +05:30
stage: 'test',
2017-09-10 17:25:29 +05:30
cache: { key: 'k', untracked: true, paths: ['public/'], policy: 'pull-push' },
2019-09-30 21:07:59 +05:30
variables: {},
2017-08-17 22:00:37 +05:30
ignore: false,
2019-02-15 15:39:39 +05:30
after_script: ['make clean'],
2019-03-02 22:35:43 +05:30
only: { refs: %w[branches tags] } },
2016-09-13 17:45:13 +05:30
spinach: { name: :spinach,
2016-09-29 09:46:39 +05:30
before_script: [],
2016-09-13 17:45:13 +05:30
script: %w[spinach],
2017-09-10 17:25:29 +05:30
image: { name: 'ruby:2.2' },
services: [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }],
2016-09-29 09:46:39 +05:30
stage: 'test',
2017-09-10 17:25:29 +05:30
cache: { key: 'k', untracked: true, paths: ['public/'], policy: 'pull-push' },
2016-09-29 09:46:39 +05:30
variables: {},
2017-08-17 22:00:37 +05:30
ignore: false,
2019-02-15 15:39:39 +05:30
after_script: ['make clean'],
2019-03-02 22:35:43 +05:30
only: { refs: %w[branches tags] } }
2016-09-13 17:45:13 +05:30
)
end
end
end
end
2019-09-30 21:07:59 +05:30
context 'when a mix of top-level and default entries is used' do
let(:hash) do
{ before_script: %w(ls pwd),
after_script: ['make clean'],
default: {
image: 'ruby:2.1',
services: ['postgres:9.1', 'mysql:5.5']
},
variables: { VAR: 'value' },
stages: %w(build pages),
cache: { key: 'k', untracked: true, paths: ['public/'] },
rspec: { script: %w[rspec ls] },
spinach: { before_script: [], variables: { VAR: 'AA' }, script: 'spinach' } }
end
context 'when composed' do
before do
root.compose!
end
describe '#errors' do
it 'has no errors' do
expect(root.errors).to be_empty
end
end
describe '#jobs_value' do
it 'returns jobs configuration' do
expect(root.jobs_value).to eq(
rspec: { name: :rspec,
script: %w[rspec ls],
before_script: %w(ls pwd),
image: { name: 'ruby:2.1' },
services: [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }],
stage: 'test',
cache: { key: 'k', untracked: true, paths: ['public/'], policy: "pull-push" },
variables: {},
ignore: false,
after_script: ['make clean'],
only: { refs: %w[branches tags] } },
spinach: { name: :spinach,
before_script: [],
script: %w[spinach],
image: { name: 'ruby:2.1' },
services: [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }],
stage: 'test',
cache: { key: 'k', untracked: true, paths: ['public/'], policy: "pull-push" },
variables: { 'VAR' => 'AA' },
ignore: false,
after_script: ['make clean'],
only: { refs: %w[branches tags] } }
)
end
end
end
end
2016-08-24 12:49:21 +05:30
context 'when most of entires not defined' do
2017-09-10 17:25:29 +05:30
before do
2019-09-30 21:07:59 +05:30
root.compose!
2017-09-10 17:25:29 +05:30
end
2016-09-29 09:46:39 +05:30
let(:hash) do
{ cache: { key: 'a' }, rspec: { script: %w[ls] } }
end
2016-08-24 12:49:21 +05:30
describe '#nodes' do
it 'instantizes all nodes' do
2019-12-26 22:10:19 +05:30
expect(root.descendants.count).to eq 11
2016-08-24 12:49:21 +05:30
end
2016-09-29 09:46:39 +05:30
it 'contains unspecified nodes' do
2019-09-30 21:07:59 +05:30
expect(root.descendants.first)
2017-08-17 22:00:37 +05:30
.not_to be_specified
2016-08-24 12:49:21 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe '#variables_value' do
2019-09-30 21:07:59 +05:30
it 'returns root value for variables' do
expect(root.variables_value).to eq({})
2016-08-24 12:49:21 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe '#stages_value' do
2019-09-30 21:07:59 +05:30
it 'returns an array of root stages' do
2019-12-21 20:55:43 +05:30
expect(root.stages_value).to eq %w[.pre build test deploy .post]
end
end
2017-08-17 22:00:37 +05:30
describe '#cache_value' do
2016-08-24 12:49:21 +05:30
it 'returns correct cache definition' do
2019-09-30 21:07:59 +05:30
expect(root.cache_value).to eq(key: 'a', policy: 'pull-push')
end
end
end
context 'when variables resembles script-type job' do
before do
root.compose!
end
let(:hash) do
{
variables: { script: "ENV_VALUE" },
rspec: { script: "echo Hello World" }
}
end
describe '#variables_value' do
it 'returns root value for variables' do
expect(root.variables_value).to eq("script" => "ENV_VALUE")
end
end
describe '#jobs_value' do
it 'returns one job' do
expect(root.jobs_value.keys).to contain_exactly(:rspec)
2016-08-24 12:49:21 +05:30
end
end
end
##
# When nodes are specified but not defined, we assume that
2018-12-13 13:39:08 +05:30
# configuration is valid, and we assume that entry is simply undefined,
2016-08-24 12:49:21 +05:30
# despite the fact, that key is present. See issue #18775 for more
# details.
#
context 'when entires specified but not defined' do
2017-09-10 17:25:29 +05:30
before do
2019-09-30 21:07:59 +05:30
root.compose!
2017-09-10 17:25:29 +05:30
end
2016-09-29 09:46:39 +05:30
let(:hash) do
{ variables: nil, rspec: { script: 'rspec' } }
end
2016-08-24 12:49:21 +05:30
2017-08-17 22:00:37 +05:30
describe '#variables_value' do
2019-09-30 21:07:59 +05:30
it 'undefined entry returns a root value' do
expect(root.variables_value).to eq({})
end
end
end
end
2017-08-17 22:00:37 +05:30
context 'when configuration is not valid' do
2017-09-10 17:25:29 +05:30
before do
2019-09-30 21:07:59 +05:30
root.compose!
2017-09-10 17:25:29 +05:30
end
2017-08-17 22:00:37 +05:30
context 'when before script is not an array' do
let(:hash) do
{ before_script: 'ls' }
end
2017-08-17 22:00:37 +05:30
describe '#valid?' do
it 'is not valid' do
2019-09-30 21:07:59 +05:30
expect(root).not_to be_valid
2017-08-17 22:00:37 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe '#errors' do
it 'reports errors from child nodes' do
2019-09-30 21:07:59 +05:30
expect(root.errors)
2019-12-26 22:10:19 +05:30
.to include 'before_script config should be an array containing strings and arrays of strings'
2017-08-17 22:00:37 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
context 'when job does not have commands' do
let(:hash) do
{ before_script: ['echo 123'], rspec: { stage: 'test' } }
end
describe '#errors' do
it 'reports errors about missing script' do
2019-09-30 21:07:59 +05:30
expect(root.errors)
.to include "root config contains unknown keys: rspec"
2017-08-17 22:00:37 +05:30
end
end
end
end
context 'when value is not a hash' do
let(:hash) { [] }
describe '#valid?' do
it 'is not valid' do
2019-09-30 21:07:59 +05:30
expect(root).not_to be_valid
end
end
2016-08-24 12:49:21 +05:30
describe '#errors' do
it 'returns error about invalid type' do
2019-09-30 21:07:59 +05:30
expect(root.errors.first).to match /should be a hash/
2016-08-24 12:49:21 +05:30
end
end
end
2016-09-13 17:45:13 +05:30
describe '#specified?' do
2016-08-24 12:49:21 +05:30
it 'is concrete entry that is defined' do
2019-09-30 21:07:59 +05:30
expect(root.specified?).to be true
2016-08-24 12:49:21 +05:30
end
end
2016-09-29 09:46:39 +05:30
describe '#[]' do
2017-09-10 17:25:29 +05:30
before do
2019-09-30 21:07:59 +05:30
root.compose!
2017-09-10 17:25:29 +05:30
end
2016-09-29 09:46:39 +05:30
let(:hash) do
{ cache: { key: 'a' }, rspec: { script: 'ls' } }
end
2017-08-17 22:00:37 +05:30
context 'when entry exists' do
2016-09-29 09:46:39 +05:30
it 'returns correct entry' do
2019-09-30 21:07:59 +05:30
expect(root[:cache])
2017-08-17 22:00:37 +05:30
.to be_an_instance_of Gitlab::Ci::Config::Entry::Cache
2019-09-30 21:07:59 +05:30
expect(root[:jobs][:rspec][:script].value).to eq ['ls']
2016-09-29 09:46:39 +05:30
end
end
2017-08-17 22:00:37 +05:30
context 'when entry does not exist' do
2016-09-29 09:46:39 +05:30
it 'always return unspecified node' do
2019-09-30 21:07:59 +05:30
expect(root[:some][:unknown][:node])
2016-09-29 09:46:39 +05:30
.not_to be_specified
end
end
end
end