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
|
// Copyright (C) 2018 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.acceptance.rest;
import static com.google.gerrit.acceptance.rest.AbstractRestApiBindingsTest.Method.PUT;
import static com.google.gerrit.gpg.testing.TestKeys.validKeyWithoutExpiration;
import static org.apache.http.HttpStatus.SC_METHOD_NOT_ALLOWED;
import com.google.common.collect.ImmutableList;
import com.google.gerrit.acceptance.GerritConfig;
import com.google.gerrit.acceptance.UseSsh;
import com.google.gerrit.extensions.common.ChangeInput;
import com.google.gerrit.gpg.testing.TestKey;
import com.google.gerrit.server.ServerInitiated;
import com.google.gerrit.server.account.AccountsUpdate;
import com.google.gerrit.server.account.externalids.ExternalId;
import com.google.inject.Inject;
import com.google.inject.Provider;
import org.junit.Test;
/**
* Tests for checking the bindings of the accounts REST API.
*
* <p>These tests only verify that the account REST endpoints are correctly bound, they do no test
* the functionality of the account REST endpoints (for details see JavaDoc on {@link
* AbstractRestApiBindingsTest}).
*/
public class AccountsRestApiBindingsIT extends AbstractRestApiBindingsTest {
@Inject private @ServerInitiated Provider<AccountsUpdate> accountsUpdateProvider;
/**
* Account REST endpoints to be tested, each URL contains a placeholder for the account
* identifier.
*/
private static final ImmutableList<RestCall> ACCOUNT_ENDPOINTS =
ImmutableList.of(
RestCall.get("/accounts/%s"),
RestCall.put("/accounts/%s"),
RestCall.get("/accounts/%s/detail"),
RestCall.get("/accounts/%s/name"),
RestCall.put("/accounts/%s/name"),
RestCall.delete("/accounts/%s/name"),
RestCall.get("/accounts/%s/username"),
RestCall.builder(PUT, "/accounts/%s/username")
// Changing the username is not allowed.
.expectedResponseCode(SC_METHOD_NOT_ALLOWED)
.expectedMessage("Username cannot be changed.")
.build(),
RestCall.get("/accounts/%s/active"),
RestCall.put("/accounts/%s/active"),
RestCall.delete("/accounts/%s/active"),
RestCall.put("/accounts/%s/password.http"),
RestCall.delete("/accounts/%s/password.http"),
RestCall.get("/accounts/%s/status"),
RestCall.put("/accounts/%s/status"),
RestCall.get("/accounts/%s/avatar"),
RestCall.get("/accounts/%s/avatar.change.url"),
RestCall.get("/accounts/%s/emails/"),
RestCall.put("/accounts/%s/emails/new-email@foo.com"),
RestCall.get("/accounts/%s/sshkeys/"),
RestCall.post("/accounts/%s/sshkeys/"),
RestCall.get("/accounts/%s/watched.projects"),
RestCall.post("/accounts/%s/watched.projects"),
RestCall.post("/accounts/%s/watched.projects:delete"),
RestCall.get("/accounts/%s/groups"),
RestCall.get("/accounts/%s/preferences"),
RestCall.put("/accounts/%s/preferences"),
RestCall.get("/accounts/%s/preferences.diff"),
RestCall.put("/accounts/%s/preferences.diff"),
RestCall.get("/accounts/%s/preferences.edit"),
RestCall.put("/accounts/%s/preferences.edit"),
RestCall.get("/accounts/%s/starred.changes"),
RestCall.get("/accounts/%s/stars.changes"),
RestCall.post("/accounts/%s/index"),
RestCall.get("/accounts/%s/agreements"),
RestCall.put("/accounts/%s/agreements"),
RestCall.get("/accounts/%s/external.ids"),
RestCall.post("/accounts/%s/external.ids:delete"),
RestCall.post("/accounts/%s/drafts:delete"),
RestCall.get("/accounts/%s/oauthtoken"),
RestCall.get("/accounts/%s/capabilities"),
RestCall.get("/accounts/%s/capabilities/viewPlugins"),
RestCall.get("/accounts/%s/gpgkeys"),
RestCall.post("/accounts/%s/gpgkeys"));
/**
* Email REST endpoints to be tested, each URL contains a placeholders for the account and email
* identifier.
*/
private static final ImmutableList<RestCall> EMAIL_ENDPOINTS =
ImmutableList.of(
RestCall.get("/accounts/%s/emails/%s"),
RestCall.put("/accounts/%s/emails/%s"),
RestCall.put("/accounts/%s/emails/%s/preferred"),
// email deletion must be tested last
RestCall.delete("/accounts/%s/emails/%s"));
/**
* GPG key REST endpoints to be tested, each URL contains a placeholders for the account
* identifier and the GPG key identifier.
*/
private static final ImmutableList<RestCall> GPG_KEY_ENDPOINTS =
ImmutableList.of(
RestCall.get("/accounts/%s/gpgkeys/%s"),
// GPG key deletion must be tested last
RestCall.delete("/accounts/%s/gpgkeys/%s"));
/**
* SSH key REST endpoints to be tested, each URL contains a placeholders for the account and SSH
* key identifier.
*/
private static final ImmutableList<RestCall> SSH_KEY_ENDPOINTS =
ImmutableList.of(
RestCall.get("/accounts/%s/sshkeys/%s"),
// SSH key deletion must be tested last
RestCall.delete("/accounts/%s/sshkeys/%s"));
/**
* Star REST endpoints to be tested, each URL contains a placeholders for the account and change
* identifier.
*/
private static final ImmutableList<RestCall> STAR_ENDPOINTS =
ImmutableList.of(
RestCall.put("/accounts/%s/starred.changes/%s"),
RestCall.delete("/accounts/%s/starred.changes/%s"),
RestCall.get("/accounts/%s/stars.changes/%s"),
RestCall.post("/accounts/%s/stars.changes/%s"));
@Test
public void accountEndpoints() throws Exception {
execute(ACCOUNT_ENDPOINTS, "self");
}
@Test
public void emailEndpoints() throws Exception {
execute(EMAIL_ENDPOINTS, "self", admin.email);
}
@Test
@GerritConfig(name = "receive.enableSignedPush", value = "true")
public void gpgKeyEndpoints() throws Exception {
TestKey key = validKeyWithoutExpiration();
String id = key.getKeyIdString();
String email = "test1@example.com"; // email that is hard-coded in the test GPG key
accountsUpdateProvider
.get()
.update(
"Add Email",
admin.getId(),
u ->
u.addExternalId(
ExternalId.createWithEmail(name("test"), email, admin.getId(), email)));
setApiUser(admin);
gApi.accounts()
.self()
.putGpgKeys(ImmutableList.of(key.getPublicKeyArmored()), ImmutableList.of());
execute(GPG_KEY_ENDPOINTS, "self", id);
}
@Test
@UseSsh
public void sshKeyEndpoints() throws Exception {
String sshKeySeq = Integer.toString(gApi.accounts().self().listSshKeys().size());
execute(SSH_KEY_ENDPOINTS, "self", sshKeySeq);
}
@Test
public void starEndpoints() throws Exception {
ChangeInput ci = new ChangeInput(project.get(), "master", "Test change");
String changeId = gApi.changes().create(ci).get().id;
execute(STAR_ENDPOINTS, "self", changeId);
}
}
|
