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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
/*
* SonarQube
* Copyright (C) 2009-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.auth.github;
import java.util.Optional;
import java.util.Set;
import org.junit.Rule;
import org.junit.Test;
import org.sonar.api.config.PropertyDefinition;
import org.sonar.api.config.PropertyDefinitions;
import org.sonar.api.config.internal.MapSettings;
import org.sonar.api.utils.System2;
import org.sonar.db.DbTester;
import org.sonar.db.provisioning.GithubOrganizationGroupDto;
import org.sonar.db.user.GroupDto;
import org.sonar.server.property.InternalProperties;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.sonar.auth.github.GitHubSettings.GITHUB_PROVISION_PROJECT_VISIBILITY;
import static org.sonar.auth.github.GitHubSettings.GITHUB_USER_CONSENT_FOR_PERMISSIONS_REQUIRED_AFTER_UPGRADE;
import static org.sonar.db.ce.CeTaskTypes.GITHUB_PROJECT_PERMISSIONS_PROVISIONING;
public class GitHubSettingsIT {
@Rule
public DbTester db = DbTester.create(System2.INSTANCE);
private final MapSettings settings = new MapSettings(new PropertyDefinitions(System2.INSTANCE, GitHubSettings.definitions()));
private final InternalProperties internalProperties = mock(InternalProperties.class);
private final GitHubSettings underTest = new GitHubSettings(settings.asConfig(), internalProperties, db.getDbClient());
@Test
public void is_enabled() {
enableGithubAuthentication();
assertThat(underTest.isEnabled()).isTrue();
settings.setProperty("sonar.auth.github.enabled", false);
assertThat(underTest.isEnabled()).isFalse();
}
@Test
public void is_enabled_always_return_false_when_client_id_is_null() {
settings.setProperty("sonar.auth.github.enabled", true);
settings.setProperty("sonar.auth.github.clientId.secured", (String) null);
settings.setProperty("sonar.auth.github.clientSecret.secured", "secret");
assertThat(underTest.isEnabled()).isFalse();
}
@Test
public void is_enabled_always_return_false_when_client_secret_is_null() {
settings.setProperty("sonar.auth.github.enabled", true);
settings.setProperty("sonar.auth.github.clientId.secured", "id");
settings.setProperty("sonar.auth.github.clientSecret.secured", (String) null);
assertThat(underTest.isEnabled()).isFalse();
}
@Test
public void isProvisioningEnabled_returnsFalseByDefault() {
enableGithubAuthentication();
when(internalProperties.read(GitHubSettings.GITHUB_PROVISIONING)).thenReturn(Optional.empty());
assertThat(underTest.isProvisioningEnabled()).isFalse();
}
@Test
public void isProvisioningEnabled_ifProvisioningEnabledButGithubAuthNotSet_returnsFalse() {
enableGithubAuthentication();
when(internalProperties.read(GitHubSettings.GITHUB_PROVISIONING)).thenReturn(Optional.of(Boolean.FALSE.toString()));
assertThat(underTest.isProvisioningEnabled()).isFalse();
}
@Test
public void isProvisioningEnabled_ifProvisioningEnabledButGithubAuthDisabled_returnsFalse() {
when(internalProperties.read(GitHubSettings.GITHUB_PROVISIONING)).thenReturn(Optional.of(Boolean.TRUE.toString()));
assertThat(underTest.isProvisioningEnabled()).isFalse();
}
@Test
public void isProvisioningEnabled_ifProvisioningEnabledAndGithubAuthEnabled_returnsTrue() {
enableGithubAuthenticationWithGithubApp();
when(internalProperties.read(GitHubSettings.GITHUB_PROVISIONING)).thenReturn(Optional.of(Boolean.TRUE.toString()));
assertThat(underTest.isProvisioningEnabled()).isTrue();
}
@Test
public void isUserConsentRequiredAfterUpgrade_returnsFalseByDefault() {
assertThat(underTest.isUserConsentRequiredAfterUpgrade()).isFalse();
}
@Test
public void isUserConsentRequiredAfterUpgrade_returnsTrueIfPropertyPresent() {
settings.setProperty(GITHUB_USER_CONSENT_FOR_PERMISSIONS_REQUIRED_AFTER_UPGRADE, "");
assertThat(underTest.isUserConsentRequiredAfterUpgrade()).isTrue();
}
@Test
public void isProjectVisibilitySynchronizationActivated_whenPropertyNotSet_returnsTrueByDefault() {
assertThat(underTest.isProjectVisibilitySynchronizationActivated()).isTrue();
}
@Test
public void isProjectVisibilitySynchronizationActivated_whenPropertyIsSetToFalse_returnsFalse() {
settings.setProperty(GITHUB_PROVISION_PROJECT_VISIBILITY, "false");
assertThat(underTest.isProjectVisibilitySynchronizationActivated()).isFalse();
}
@Test
public void isProjectVisibilitySynchronizationActivated_whenPropertyIsSetToTrue_returnsTrue() {
settings.setProperty(GITHUB_PROVISION_PROJECT_VISIBILITY, "true");
assertThat(underTest.isProjectVisibilitySynchronizationActivated()).isTrue();
}
@Test
public void setProvisioning_whenGitHubAuthDisabled_shouldThrow() {
assertThatIllegalStateException()
.isThrownBy(() -> underTest.setProvisioning(true))
.withMessage("GitHub authentication must be enabled to enable GitHub provisioning.");
assertThat(underTest.isProvisioningEnabled()).isFalse();
}
@Test
public void setProvisioning_whenPrivateKeyMissing_shouldThrow() {
enableGithubAuthenticationWithGithubApp();
settings.setProperty("sonar.auth.github.privateKey.secured", "");
assertThatIllegalStateException()
.isThrownBy(() -> underTest.setProvisioning(true))
.withMessage("Private key must be provided to enable GitHub provisioning.");
assertThat(underTest.isProvisioningEnabled()).isFalse();
}
@Test
public void setProvisioning_whenAppIdMissing_shouldThrow() {
enableGithubAuthenticationWithGithubApp();
settings.setProperty("sonar.auth.github.appId", "");
assertThatIllegalStateException()
.isThrownBy(() -> underTest.setProvisioning(true))
.withMessage("Application ID must be provided to enable GitHub provisioning.");
assertThat(underTest.isProvisioningEnabled()).isFalse();
}
@Test
public void setProvisioning_whenPassedTrue_delegatesToInternalPropertiesWrite() {
enableGithubAuthenticationWithGithubApp();
underTest.setProvisioning(true);
verify(internalProperties).write(GitHubSettings.GITHUB_PROVISIONING, Boolean.TRUE.toString());
}
@Test
public void setProvisioning_whenPassedFalse_delegatesToInternalPropertiesWriteAndCleansUpExternalGroups() {
createGithubManagedGroup();
createGitHubOrganizationGroup();
underTest.setProvisioning(false);
verify(internalProperties).write(GitHubSettings.GITHUB_PROVISIONING, Boolean.FALSE.toString());
assertThat(db.getDbClient().externalGroupDao().selectByIdentityProvider(db.getSession(), GitHubIdentityProvider.KEY)).isEmpty();
assertThat(db.getDbClient().githubOrganizationGroupDao().findAll(db.getSession())).isEmpty();
}
private void createGithubManagedGroup() {
GroupDto groupDto = db.users().insertGroup();
db.users().markGroupAsGithubManaged(groupDto.getUuid());
}
private void createGitHubOrganizationGroup() {
GroupDto groupDto = db.users().insertGroup();
db.getDbClient().githubOrganizationGroupDao().insert(db.getSession(), new GithubOrganizationGroupDto(groupDto.getUuid(), "org1"));
db.commit();
}
@Test
public void return_client_id() {
settings.setProperty("sonar.auth.github.clientId.secured", "id");
assertThat(underTest.clientId()).isEqualTo("id");
}
@Test
public void return_client_secret() {
settings.setProperty("sonar.auth.github.clientSecret.secured", "secret");
assertThat(underTest.clientSecret()).isEqualTo("secret");
}
@Test
public void return_app_id() {
settings.setProperty("sonar.auth.github.appId", "secret");
assertThat(underTest.appId()).isEqualTo("secret");
}
@Test
public void return_private_key() {
settings.setProperty("sonar.auth.github.privateKey.secured", "secret");
assertThat(underTest.privateKey()).isEqualTo("secret");
}
@Test
public void allow_users_to_sign_up() {
settings.setProperty("sonar.auth.github.allowUsersToSignUp", "true");
assertThat(underTest.allowUsersToSignUp()).isTrue();
settings.setProperty("sonar.auth.github.allowUsersToSignUp", "false");
assertThat(underTest.allowUsersToSignUp()).isFalse();
// default value
settings.setProperty("sonar.auth.github.allowUsersToSignUp", (String) null);
assertThat(underTest.allowUsersToSignUp()).isTrue();
}
@Test
public void sync_groups() {
settings.setProperty("sonar.auth.github.groupsSync", "true");
assertThat(underTest.syncGroups()).isTrue();
settings.setProperty("sonar.auth.github.groupsSync", "false");
assertThat(underTest.syncGroups()).isFalse();
// default value
settings.setProperty("sonar.auth.github.groupsSync", (String) null);
assertThat(underTest.syncGroups()).isFalse();
}
@Test
public void apiUrl_must_have_ending_slash() {
settings.setProperty("sonar.auth.github.apiUrl", "https://github.com");
assertThat(underTest.apiURL()).isEqualTo("https://github.com/");
settings.setProperty("sonar.auth.github.apiUrl", "https://github.com/");
assertThat(underTest.apiURL()).isEqualTo("https://github.com/");
}
@Test
public void webUrl_must_have_ending_slash() {
settings.setProperty("sonar.auth.github.webUrl", "https://github.com");
assertThat(underTest.webURL()).isEqualTo("https://github.com/");
settings.setProperty("sonar.auth.github.webUrl", "https://github.com/");
assertThat(underTest.webURL()).isEqualTo("https://github.com/");
}
@Test
public void return_organizations_single() {
String setting = "example";
settings.setProperty("sonar.auth.github.organizations", setting);
Set<String> actual = underTest.getOrganizations();
assertThat(actual).containsOnly(setting);
}
@Test
public void return_organizations_multiple() {
String setting = "example0,example1";
settings.setProperty("sonar.auth.github.organizations", setting);
Set<String> actual = underTest.getOrganizations();
assertThat(actual).containsOnly("example0", "example1");
}
@Test
public void return_organizations_empty_list() {
String[] setting = null;
settings.setProperty("sonar.auth.github.organizations", setting);
Set<String> actual = underTest.getOrganizations();
assertThat(actual).isEmpty();
}
@Test
public void definitions() {
assertThat(GitHubSettings.definitions().stream()
.map(PropertyDefinition::name))
.containsExactly(
"Enabled",
"Client ID",
"Client Secret",
"App ID",
"Private Key",
"Allow users to sign up",
"Synchronize teams as groups",
"The API url for a GitHub instance.",
"The WEB url for a GitHub instance.",
"Organizations",
"Provision project visibility");
}
private void enableGithubAuthentication() {
settings.setProperty("sonar.auth.github.clientId.secured", "id");
settings.setProperty("sonar.auth.github.clientSecret.secured", "secret");
settings.setProperty("sonar.auth.github.enabled", true);
}
private void enableGithubAuthenticationWithGithubApp() {
enableGithubAuthentication();
settings.setProperty("sonar.auth.github.appId", "id");
settings.setProperty("sonar.auth.github.privateKey.secured", "secret");
}
@Test
public void getProjectsPermissionsProvisioningTaskName_returnsCorrectTaskName() {
assertThat(underTest.getProjectsPermissionsProvisioningTaskName()).isEqualTo(GITHUB_PROJECT_PERMISSIONS_PROVISIONING);
}
}
|
