1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Ci::JwtV2, feature_category: :continuous_integration do
let(:namespace) { build_stubbed(:namespace) }
let(:project) { build_stubbed(:project, namespace: namespace) }
let(:user) do
build_stubbed(
:user,
identities: [build_stubbed(:identity, extern_uid: '1', provider: 'github')]
)
end
let(:pipeline) { build_stubbed(:ci_pipeline, ref: 'auto-deploy-2020-03-19') }
let(:runner) { build_stubbed(:ci_runner) }
let(:aud) { described_class::DEFAULT_AUD }
let(:build) do
build_stubbed(
:ci_build,
project: project,
user: user,
pipeline: pipeline,
runner: runner
)
end
subject(:ci_job_jwt_v2) { described_class.new(build, ttl: 30, aud: aud) }
it { is_expected.to be_a Gitlab::Ci::Jwt }
describe '#payload' do
subject(:payload) { ci_job_jwt_v2.payload }
it 'has correct values for the standard JWT attributes' do
aggregate_failures do
expect(payload[:iss]).to eq(Settings.gitlab.base_url)
expect(payload[:aud]).to eq(Settings.gitlab.base_url)
expect(payload[:sub]).to eq("project_path:#{project.full_path}:ref_type:branch:ref:#{pipeline.source_ref}")
end
end
it 'includes user identities when enabled' do
expect(user).to receive(:pass_user_identities_to_ci_jwt).and_return(true)
identities = payload[:user_identities].map { |identity| identity.slice(:extern_uid, :provider) }
expect(identities).to eq([{ extern_uid: '1', provider: 'github' }])
end
it 'does not include user identities when disabled' do
expect(user).to receive(:pass_user_identities_to_ci_jwt).and_return(false)
expect(payload).not_to include(:user_identities)
end
context 'when given an aud' do
let(:aud) { 'AWS' }
it 'uses that aud in the payload' do
expect(payload[:aud]).to eq('AWS')
end
end
describe 'custom claims' do
describe 'runner_id' do
it 'is the ID of the runner executing the job' do
expect(payload[:runner_id]).to eq(runner.id)
end
context 'when build is not associated with a runner' do
let(:runner) { nil }
it 'is nil' do
expect(payload[:runner_id]).to be_nil
end
end
end
describe 'runner_environment' do
context 'when runner is gitlab-hosted' do
before do
allow(runner).to receive(:gitlab_hosted?).and_return(true)
end
it "is #{described_class::GITLAB_HOSTED_RUNNER}" do
expect(payload[:runner_environment]).to eq(described_class::GITLAB_HOSTED_RUNNER)
end
end
context 'when runner is self-hosted' do
before do
allow(runner).to receive(:gitlab_hosted?).and_return(false)
end
it "is #{described_class::SELF_HOSTED_RUNNER}" do
expect(payload[:runner_environment]).to eq(described_class::SELF_HOSTED_RUNNER)
end
end
context 'when build is not associated with a runner' do
let(:runner) { nil }
it 'is nil' do
expect(payload[:runner_environment]).to be_nil
end
end
end
describe 'sha' do
it 'is the commit revision the project is built for' do
expect(payload[:sha]).to eq(pipeline.sha)
end
end
describe 'ci_config_ref_uri' do
let(:project_config) do
instance_double(
Gitlab::Ci::ProjectConfig,
url: 'gitlab.com/gitlab-org/gitlab//.gitlab-ci.yml',
source: :repository_source
)
end
before do
allow(Gitlab::Ci::ProjectConfig).to receive(:new).with(
project: project,
sha: pipeline.sha,
pipeline_source: pipeline.source.to_sym,
pipeline_source_bridge: pipeline.source_bridge
).and_return(project_config)
end
it 'joins project_config.url and pipeline.source_ref_path with @' do
expect(payload[:ci_config_ref_uri]).to eq('gitlab.com/gitlab-org/gitlab//.gitlab-ci.yml' \
'@refs/heads/auto-deploy-2020-03-19')
end
context 'when project config is nil' do
before do
allow(Gitlab::Ci::ProjectConfig).to receive(:new).and_return(nil)
end
it 'is nil' do
expect(payload[:ci_config_ref_uri]).to be_nil
end
end
context 'when ProjectConfig#url raises an error' do
before do
allow(project_config).to receive(:url).and_raise(RuntimeError)
end
it 'raises the same error' do
expect { payload }.to raise_error(RuntimeError)
end
context 'in production' do
before do
stub_rails_env('production')
end
it 'is nil' do
expect(payload[:ci_config_ref_uri]).to be_nil
end
end
end
context 'when ci_jwt_v2_ci_config_ref_uri_claim flag is disabled' do
before do
stub_feature_flags(ci_jwt_v2_ref_uri_claim: false)
end
it 'is nil' do
expect(payload[:ci_config_ref_uri]).to be_nil
end
end
context 'when config source is not repository' do
before do
allow(project_config).to receive(:source).and_return(:auto_devops_source)
end
it 'is nil' do
expect(payload[:ci_config_ref_uri]).to be_nil
end
end
end
end
end
end
|