Commit 2df5ea68 authored by Rémy Coutable's avatar Rémy Coutable Committed by Yorick Peterse

Merge branch 'fix/hidden-build-validation-in-ci-yaml' into 'master'

Add posibility to define a hidden job without 'script' in .gitlab-ci.yml

References #15451

/cc @ayufan 

See merge request !3849
parent a3783cde
...@@ -9,6 +9,7 @@ v 8.7.1 (unreleased) ...@@ -9,6 +9,7 @@ v 8.7.1 (unreleased)
- Use the `can?` helper instead of `current_user.can?`. !3882 - Use the `can?` helper instead of `current_user.can?`. !3882
- Prevent users from deleting Webhooks via API they do not own - Prevent users from deleting Webhooks via API they do not own
- Fix Error 500 due to stale cache when projects are renamed or transferred - Fix Error 500 due to stale cache when projects are renamed or transferred
- Fix .gitlab-ci.yml parsing issue when hidde job is a template without script definition
v 8.7.0 v 8.7.0
- Gitlab::GitAccess and Gitlab::GitAccessWiki are now instrumented - Gitlab::GitAccess and Gitlab::GitAccessWiki are now instrumented
......
...@@ -61,23 +61,21 @@ module Ci ...@@ -61,23 +61,21 @@ module Ci
@stages = @config[:stages] || @config[:types] @stages = @config[:stages] || @config[:types]
@variables = @config[:variables] || {} @variables = @config[:variables] || {}
@cache = @config[:cache] @cache = @config[:cache]
@jobs = {}
@config.except!(*ALLOWED_YAML_KEYS) @config.except!(*ALLOWED_YAML_KEYS)
@config.each { |name, param| add_job(name, param) }
# anything that doesn't have script is considered as unknown raise ValidationError, "Please define at least one job" if @jobs.none?
@config.each do |name, param| end
raise ValidationError, "Unknown parameter: #{name}" unless param.is_a?(Hash) && param.has_key?(:script)
end
unless @config.values.any?{|job| job.is_a?(Hash)} def add_job(name, job)
raise ValidationError, "Please define at least one job" return if name.to_s.start_with?('.')
end
@jobs = {} raise ValidationError, "Unknown parameter: #{name}" unless job.is_a?(Hash) && job.has_key?(:script)
@config.each do |key, job|
next if key.to_s.start_with?('.') stage = job[:stage] || job[:type] || DEFAULT_STAGE
stage = job[:stage] || job[:type] || DEFAULT_STAGE @jobs[name] = { stage: stage }.merge(job)
@jobs[key] = { stage: stage }.merge(job)
end
end end
def build_job(name, job) def build_job(name, job)
...@@ -112,8 +110,6 @@ module Ci ...@@ -112,8 +110,6 @@ module Ci
true true
end end
private
def validate_global! def validate_global!
unless validate_array_of_strings(@before_script) unless validate_array_of_strings(@before_script)
raise ValidationError, "before_script should be an array of strings" raise ValidationError, "before_script should be an array of strings"
......
...@@ -648,70 +648,131 @@ module Ci ...@@ -648,70 +648,131 @@ module Ci
end end
describe "Hidden jobs" do describe "Hidden jobs" do
let(:config) do let(:config_processor) { GitlabCiYamlProcessor.new(config) }
YAML.dump({ subject { config_processor.builds_for_stage_and_ref("test", "master") }
'.hidden_job' => { script: 'test' },
'normal_job' => { script: 'test' } shared_examples 'hidden_job_handling' do
}) it "doesn't create jobs that start with dot" do
expect(subject.size).to eq(1)
expect(subject.first).to eq({
except: nil,
stage: "test",
stage_idx: 1,
name: :normal_job,
only: nil,
commands: "test",
tag_list: [],
options: {},
when: "on_success",
allow_failure: false
})
end
end end
let(:config_processor) { GitlabCiYamlProcessor.new(config) } context 'when hidden job have a script definition' do
let(:config) do
YAML.dump({
'.hidden_job' => { image: 'ruby:2.1', script: 'test' },
'normal_job' => { script: 'test' }
})
end
subject { config_processor.builds_for_stage_and_ref("test", "master") } it_behaves_like 'hidden_job_handling'
end
it "doesn't create jobs that starts with dot" do context "when hidden job doesn't have a script definition" do
expect(subject.size).to eq(1) let(:config) do
expect(subject.first).to eq({ YAML.dump({
except: nil, '.hidden_job' => { image: 'ruby:2.1' },
stage: "test", 'normal_job' => { script: 'test' }
stage_idx: 1, })
name: :normal_job, end
only: nil,
commands: "test", it_behaves_like 'hidden_job_handling'
tag_list: [],
options: {},
when: "on_success",
allow_failure: false
})
end end
end end
describe "YAML Alias/Anchor" do describe "YAML Alias/Anchor" do
it "is correctly supported for jobs" do let(:config_processor) { GitlabCiYamlProcessor.new(config) }
config = <<EOT subject { config_processor.builds_for_stage_and_ref("build", "master") }
shared_examples 'job_templates_handling' do
it "is correctly supported for jobs" do
expect(subject.size).to eq(2)
expect(subject.first).to eq({
except: nil,
stage: "build",
stage_idx: 0,
name: :job1,
only: nil,
commands: "execute-script-for-job",
tag_list: [],
options: {},
when: "on_success",
allow_failure: false
})
expect(subject.second).to eq({
except: nil,
stage: "build",
stage_idx: 0,
name: :job2,
only: nil,
commands: "execute-script-for-job",
tag_list: [],
options: {},
when: "on_success",
allow_failure: false
})
end
end
context 'when template is a job' do
let(:config) do
<<EOT
job1: &JOBTMPL job1: &JOBTMPL
stage: build
script: execute-script-for-job script: execute-script-for-job
job2: *JOBTMPL job2: *JOBTMPL
EOT EOT
end
config_processor = GitlabCiYamlProcessor.new(config) it_behaves_like 'job_templates_handling'
end
expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(2) context 'when template is a hidden job' do
expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({ let(:config) do
except: nil, <<EOT
stage: "test", .template: &JOBTMPL
stage_idx: 1, stage: build
name: :job1, script: execute-script-for-job
only: nil,
commands: "execute-script-for-job", job1: *JOBTMPL
tag_list: [],
options: {}, job2: *JOBTMPL
when: "on_success", EOT
allow_failure: false end
})
expect(config_processor.builds_for_stage_and_ref("test", "master").second).to eq({ it_behaves_like 'job_templates_handling'
except: nil, end
stage: "test",
stage_idx: 1, context 'when job adds its own keys to a template definition' do
name: :job2, let(:config) do
only: nil, <<EOT
commands: "execute-script-for-job", .template: &JOBTMPL
tag_list: [], stage: build
options: {},
when: "on_success", job1:
allow_failure: false <<: *JOBTMPL
}) script: execute-script-for-job
job2:
<<: *JOBTMPL
script: execute-script-for-job
EOT
end
it_behaves_like 'job_templates_handling'
end end
end end
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment