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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::Clusters::AgentTokens, feature_category: :deployment_management do
let_it_be(:agent) { create(:cluster_agent) }
let_it_be(:agent_token_one) { create(:cluster_agent_token, agent: agent) }
let_it_be(:revoked_agent_token) { create(:cluster_agent_token, :revoked, agent: agent) }
let_it_be(:project) { agent.project }
let_it_be(:user) { agent.created_by_user }
let_it_be(:unauthorized_user) { create(:user, guest_of: project) }
before_all do
project.add_maintainer(user)
end
describe 'GET /projects/:id/cluster_agents/:agent_id/tokens' do
context 'with authorized user' do
it 'only returns active agent tokens' do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user)
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(response).to match_response_schema('public_api/v4/agent_tokens')
expect(json_response.count).to eq(1)
expect(json_response.first['name']).to eq(agent_token_one.name)
expect(json_response.first['agent_id']).to eq(agent.id)
end
end
it 'returns a not_found error if agent_id does not exist' do
get api("/projects/#{project.id}/cluster_agents/#{non_existing_record_id}/tokens", user)
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with unauthorized user' do
it 'cannot access agent tokens' do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", unauthorized_user)
expect(response).to have_gitlab_http_status(:not_found)
end
end
it 'avoids N+1 queries', :request_store do
# Establish baseline
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user)
control = ActiveRecord::QueryRecorder.new do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user)
expect(response).to have_gitlab_http_status(:ok)
end
# Now create a second record and ensure that the API does not execute
# any more queries than before
create(:cluster_agent_token, agent: agent)
expect do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user)
end.not_to exceed_query_limit(control)
end
end
describe 'GET /projects/:id/cluster_agents/:agent_id/tokens/:token_id' do
context 'with authorized user' do
it 'returns an agent token' do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{agent_token_one.id}", user)
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/agent_token')
expect(json_response['id']).to eq(agent_token_one.id)
expect(json_response['name']).to eq(agent_token_one.name)
expect(json_response['agent_id']).to eq(agent.id)
end
end
it 'returns a 404 if agent token is revoked' do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{revoked_agent_token.id}", user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns a 404 if agent does not exist' do
path = "/projects/#{project.id}/cluster_agents/#{non_existing_record_id}/tokens/#{non_existing_record_id}"
get api(path, user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns a 404 error if agent token id is not available' do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{non_existing_record_id}", user)
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with unauthorized user' do
it 'cannot access single agent token' do
get api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{agent_token_one.id}", unauthorized_user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'cannot access token from agent of another project' do
another_project = create(:project, namespace: unauthorized_user.namespace)
another_agent = create(:cluster_agent, project: another_project, created_by_user: unauthorized_user)
get api(
"/projects/#{another_project.id}/cluster_agents/#{another_agent.id}/tokens/#{agent_token_one.id}",
unauthorized_user
)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
describe 'POST /projects/:id/cluster_agents/:agent_id/tokens' do
it 'creates a new agent token' do
params = {
name: 'test-token',
description: 'Test description'
}
post(api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user), params: params)
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:created)
expect(response).to match_response_schema('public_api/v4/agent_token_with_token')
expect(json_response['name']).to eq(params[:name])
expect(json_response['description']).to eq(params[:description])
expect(json_response['agent_id']).to eq(agent.id)
end
end
it 'returns a 400 error if name not given' do
post api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user)
expect(response).to have_gitlab_http_status(:bad_request)
end
it 'returns 404 error if project does not exist' do
post api("/projects/#{non_existing_record_id}/cluster_agents/tokens", user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns 404 error if agent does not exist' do
post api("/projects/#{project.id}/cluster_agents/#{non_existing_record_id}/tokens", user),
params: { name: "some" }
expect(response).to have_gitlab_http_status(:not_found)
end
context 'with unauthorized user' do
it 'prevents to create agent token' do
post api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", unauthorized_user),
params: { name: "some" }
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'when the active agent tokens limit is reached' do
before do
# create an additional agent token to make it 2
create(:cluster_agent_token, agent: agent)
end
it 'returns a bad request (400) error' do
params = {
name: 'test-token',
description: 'Test description'
}
post(api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens", user), params: params)
aggregate_failures "testing response" do
expect(response).to have_gitlab_http_status(:bad_request)
error_message = json_response['message']
expect(error_message).to eq('400 Bad request - An agent can have only two active tokens at a time')
end
end
end
end
describe 'DELETE /projects/:id/cluster_agents/:agent_id/tokens/:token_id' do
it 'revokes agent token' do
delete api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{agent_token_one.id}", user)
expect(response).to have_gitlab_http_status(:no_content)
expect(agent_token_one.reload).to be_revoked
end
it 'returns a success response when revoking an already revoked agent token', :aggregate_failures do
delete api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{revoked_agent_token.id}", user)
expect(response).to have_gitlab_http_status(:no_content)
expect(revoked_agent_token.reload).to be_revoked
end
it 'returns a 404 error when given agent_id does not exist' do
path = "/projects/#{project.id}/cluster_agents/#{non_existing_record_id}/tokens/#{non_existing_record_id}"
delete api(path, user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns a 404 error when revoking non existent agent token' do
delete api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{non_existing_record_id}", user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns a 404 if the user is unauthorized to revoke' do
delete api("/projects/#{project.id}/cluster_agents/#{agent.id}/tokens/#{agent_token_one.id}", unauthorized_user)
expect(response).to have_gitlab_http_status(:forbidden)
end
it 'cannot revoke token from agent of another project' do
another_project = create(:project, namespace: unauthorized_user.namespace)
another_agent = create(:cluster_agent, project: another_project, created_by_user: unauthorized_user)
delete api(
"/projects/#{another_project.id}/cluster_agents/#{another_agent.id}/tokens/#{agent_token_one.id}",
unauthorized_user
)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
|
