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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

235 lines
6.2 KiB
Ruby
Raw Normal View History

2019-10-12 21:52:04 +05:30
# frozen_string_literal: true
2016-08-24 12:49:21 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe Gitlab::Ci::Config::Entry::Cache do
2021-03-11 19:13:27 +05:30
using RSpec::Parameterized::TableSyntax
2017-09-10 17:25:29 +05:30
subject(:entry) { described_class.new(config) }
2016-08-24 12:49:21 +05:30
2021-06-08 01:23:25 +05:30
describe 'validations' do
2017-09-10 17:25:29 +05:30
before do
entry.compose!
end
2016-08-24 12:49:21 +05:30
2021-06-08 01:23:25 +05:30
context 'when entry config value is correct' do
let(:policy) { nil }
let(:key) { 'some key' }
let(:when_config) { nil }
let(:config) do
{
key: key,
untracked: true,
paths: ['some/path/']
}.tap do |config|
config[:policy] = policy if policy
config[:when] = when_config if when_config
2021-01-03 14:25:43 +05:30
end
2016-08-24 12:49:21 +05:30
end
2021-06-08 01:23:25 +05:30
describe '#value' do
shared_examples 'hash key value' do
it 'returns hash value' do
expect(entry.value).to eq(key: key, untracked: true, paths: ['some/path/'], policy: 'pull-push', when: 'on_success')
end
2019-12-26 22:10:19 +05:30
end
2021-06-08 01:23:25 +05:30
it_behaves_like 'hash key value'
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
context 'with files' do
let(:key) { { files: %w[a-file other-file] } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it_behaves_like 'hash key value'
2019-12-26 22:10:19 +05:30
end
2021-06-08 01:23:25 +05:30
context 'with files and prefix' do
let(:key) { { files: %w[a-file other-file], prefix: 'prefix-value' } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it_behaves_like 'hash key value'
2019-12-26 22:10:19 +05:30
end
2021-04-17 20:07:23 +05:30
2021-06-08 01:23:25 +05:30
context 'with prefix' do
let(:key) { { prefix: 'prefix-value' } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it 'key is nil' do
expect(entry.value).to match(a_hash_including(key: nil))
2019-12-26 22:10:19 +05:30
end
2016-08-24 12:49:21 +05:30
end
2021-01-03 14:25:43 +05:30
2021-06-08 01:23:25 +05:30
context 'with `policy`' do
where(:policy, :result) do
'pull-push' | 'pull-push'
'push' | 'push'
'pull' | 'pull'
'unknown' | 'unknown' # invalid
2021-01-03 14:25:43 +05:30
end
2021-06-08 01:23:25 +05:30
with_them do
it { expect(entry.value).to include(policy: result) }
2021-01-03 14:25:43 +05:30
end
2021-06-08 01:23:25 +05:30
end
2021-01-03 14:25:43 +05:30
2021-06-08 01:23:25 +05:30
context 'without `policy`' do
it 'assigns policy to default' do
expect(entry.value).to include(policy: 'pull-push')
2021-01-03 14:25:43 +05:30
end
2021-06-08 01:23:25 +05:30
end
2021-01-03 14:25:43 +05:30
2021-06-08 01:23:25 +05:30
context 'with `when`' do
where(:when_config, :result) do
'on_success' | 'on_success'
'on_failure' | 'on_failure'
'always' | 'always'
'unknown' | 'unknown' # invalid
2021-01-03 14:25:43 +05:30
end
2016-08-24 12:49:21 +05:30
2021-06-08 01:23:25 +05:30
with_them do
it { expect(entry.value).to include(when: result) }
2021-04-17 20:07:23 +05:30
end
2021-06-08 01:23:25 +05:30
end
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
context 'without `when`' do
it 'assigns when to default' do
expect(entry.value).to include(when: 'on_success')
2021-04-17 20:07:23 +05:30
end
2019-12-26 22:10:19 +05:30
end
2021-06-08 01:23:25 +05:30
end
2017-09-10 17:25:29 +05:30
2021-06-08 01:23:25 +05:30
describe '#valid?' do
it { is_expected.to be_valid }
2021-04-17 20:07:23 +05:30
2021-06-08 01:23:25 +05:30
context 'with files' do
let(:key) { { files: %w[a-file other-file] } }
2017-09-10 17:25:29 +05:30
2021-06-08 01:23:25 +05:30
it { is_expected.to be_valid }
2021-01-03 14:25:43 +05:30
end
2021-06-08 01:23:25 +05:30
end
2017-09-10 17:25:29 +05:30
2021-06-08 01:23:25 +05:30
context 'with `policy`' do
where(:policy, :valid) do
'pull-push' | true
'push' | true
'pull' | true
'unknown' | false
end
2021-01-03 14:25:43 +05:30
2021-06-08 01:23:25 +05:30
with_them do
it 'returns expected validity' do
expect(entry.valid?).to eq(valid)
2021-01-03 14:25:43 +05:30
end
end
2021-06-08 01:23:25 +05:30
end
2017-08-17 22:00:37 +05:30
2021-06-08 01:23:25 +05:30
context 'with `when`' do
where(:when_config, :valid) do
'on_success' | true
'on_failure' | true
'always' | true
'unknown' | false
end
2021-04-17 20:07:23 +05:30
2021-06-08 01:23:25 +05:30
with_them do
it 'returns expected validity' do
expect(entry.valid?).to eq(valid)
2021-04-17 20:07:23 +05:30
end
2017-08-17 22:00:37 +05:30
end
2021-06-08 01:23:25 +05:30
end
2017-08-17 22:00:37 +05:30
2021-06-08 01:23:25 +05:30
context 'with key missing' do
let(:config) do
{ untracked: true,
paths: ['some/path/'] }
end
2021-04-17 20:07:23 +05:30
2021-06-08 01:23:25 +05:30
describe '#value' do
it 'sets key with the default' do
expect(entry.value[:key])
.to eq(Gitlab::Ci::Config::Entry::Key.default)
2017-08-17 22:00:37 +05:30
end
end
end
2021-06-08 01:23:25 +05:30
end
2016-08-24 12:49:21 +05:30
2021-06-08 01:23:25 +05:30
context 'when entry value is not correct' do
describe '#errors' do
subject { entry.errors }
2019-12-21 20:55:43 +05:30
2021-06-08 01:23:25 +05:30
context 'when is not a hash' do
let(:config) { 'ls' }
2016-08-24 12:49:21 +05:30
2021-06-08 01:23:25 +05:30
it 'reports errors with config value' do
is_expected.to include 'cache config should be a hash'
2017-09-10 17:25:29 +05:30
end
2021-06-08 01:23:25 +05:30
end
2017-09-10 17:25:29 +05:30
2021-06-08 01:23:25 +05:30
context 'when policy is unknown' do
let(:config) { { policy: 'unknown' } }
2017-09-10 17:25:29 +05:30
2021-06-08 01:23:25 +05:30
it 'reports error' do
is_expected.to include('cache policy should be pull-push, push, or pull')
2016-08-24 12:49:21 +05:30
end
2021-06-08 01:23:25 +05:30
end
2016-08-24 12:49:21 +05:30
2021-06-08 01:23:25 +05:30
context 'when `when` is unknown' do
let(:config) { { when: 'unknown' } }
2021-01-03 14:25:43 +05:30
2021-06-08 01:23:25 +05:30
it 'reports error' do
is_expected.to include('cache when should be on_success, on_failure or always')
2021-01-03 14:25:43 +05:30
end
2021-06-08 01:23:25 +05:30
end
2021-01-03 14:25:43 +05:30
2021-06-08 01:23:25 +05:30
context 'when descendants are invalid' do
context 'with invalid keys' do
let(:config) { { key: 1 } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it 'reports error with descendants' do
is_expected.to include 'key should be a hash, a string or a symbol'
2019-12-26 22:10:19 +05:30
end
2021-06-08 01:23:25 +05:30
end
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
context 'with empty key' do
let(:config) { { key: {} } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it 'reports error with descendants' do
is_expected.to include 'key config missing required keys: files'
2019-12-26 22:10:19 +05:30
end
2021-06-08 01:23:25 +05:30
end
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
context 'with invalid files' do
let(:config) { { key: { files: 'a-file' } } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it 'reports error with descendants' do
is_expected.to include 'key:files config should be an array of strings'
2019-12-26 22:10:19 +05:30
end
2021-06-08 01:23:25 +05:30
end
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
context 'with prefix without files' do
let(:config) { { key: { prefix: 'a-prefix' } } }
2019-12-26 22:10:19 +05:30
2021-06-08 01:23:25 +05:30
it 'reports error with descendants' do
is_expected.to include 'key config missing required keys: files'
2019-12-26 22:10:19 +05:30
end
2016-08-24 12:49:21 +05:30
end
2021-04-17 20:07:23 +05:30
context 'when there is an unknown key present' do
2021-06-08 01:23:25 +05:30
let(:config) { { key: { unknown: 'a-file' } } }
2016-08-24 12:49:21 +05:30
2021-04-17 20:07:23 +05:30
it 'reports error with descendants' do
2021-06-08 01:23:25 +05:30
is_expected.to include 'key config contains unknown keys: unknown'
2021-04-17 20:07:23 +05:30
end
2016-08-24 12:49:21 +05:30
end
end
2021-06-08 01:23:25 +05:30
context 'when there is an unknown key present' do
let(:config) { { invalid: true } }
it 'reports error with descendants' do
is_expected.to include 'cache config contains unknown keys: invalid'
end
end
2016-08-24 12:49:21 +05:30
end
end
end
end