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
|
/*
* 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.alm.client.github;
import java.util.Arrays;
import java.util.Set;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Suite;
import org.sonar.auth.github.GsonRepositoryPermissions;
import org.sonar.db.permission.ProjectPermission;
import org.sonar.db.provisioning.DevOpsPermissionsMappingDto;
import static org.assertj.core.api.Assertions.assertThat;
@RunWith(Suite.class)
@Suite.SuiteClasses({
GithubPermissionConverterTest.ToSonarqubeRolesForDefaultRepositoryPermissionTest.class,
GithubPermissionConverterTest.ToSonarqubeRolesWithFallbackOnRepositoryPermissionsTest.class
})
public class GithubPermissionConverterTest {
private static final Set<DevOpsPermissionsMappingDto> ALL_PERMISSIONS_MAPPING_FROM_DB = Set.of(
new DevOpsPermissionsMappingDto("uuid1", "github", "read", ProjectPermission.CODEVIEWER),
new DevOpsPermissionsMappingDto("uuid2", "github", "triage", ProjectPermission.SECURITYHOTSPOT_ADMIN),
new DevOpsPermissionsMappingDto("uuid3", "github", "write", ProjectPermission.ISSUE_ADMIN),
new DevOpsPermissionsMappingDto("uuid4", "github", "maintain", ProjectPermission.SCAN),
new DevOpsPermissionsMappingDto("uuid5", "github", "admin", ProjectPermission.ADMIN)
) ;
private static final GsonRepositoryPermissions NO_PERMS = new GsonRepositoryPermissions(false, false, false, false, false);
private static final GsonRepositoryPermissions READ_PERMS = new GsonRepositoryPermissions(false, false, false, false, true);
private static final GsonRepositoryPermissions TRIAGE_PERMS = new GsonRepositoryPermissions(false, false, false, true, true);
private static final GsonRepositoryPermissions WRITE_PERMS = new GsonRepositoryPermissions(false, false, true, true, true);
private static final GsonRepositoryPermissions MAINTAIN_PERMS = new GsonRepositoryPermissions(false, true, true, true, true);
private static final GsonRepositoryPermissions ADMIN_PERMS = new GsonRepositoryPermissions(true, true, true, true, true);
@RunWith(Parameterized.class)
public static class ToSonarqubeRolesWithFallbackOnRepositoryPermissionsTest {
private final GithubPermissionConverter githubPermissionConverter = new GithubPermissionConverter();
private final String role;
private final GsonRepositoryPermissions repositoryPermissions;
private final Set<String> expectedSqPermissions;
@Parameterized.Parameters(name = "GH role:{0}, GH perms:{1}, Expected SQ perms:{2}")
public static Iterable<Object[]> testData() {
return Arrays.asList(new Object[][] {
{"none", NO_PERMS, Set.of()},
{"read", NO_PERMS, Set.of(ProjectPermission.CODEVIEWER)},
{"read", READ_PERMS, Set.of(ProjectPermission.CODEVIEWER)},
{"pull", NO_PERMS, Set.of(ProjectPermission.CODEVIEWER)},
{"triage", NO_PERMS, Set.of(ProjectPermission.SECURITYHOTSPOT_ADMIN)},
{"write", NO_PERMS, Set.of(ProjectPermission.ISSUE_ADMIN)},
{"push", NO_PERMS, Set.of(ProjectPermission.ISSUE_ADMIN)},
{"maintain", NO_PERMS, Set.of(ProjectPermission.SCAN)},
{"admin", NO_PERMS, Set.of(ProjectPermission.ADMIN)},
{"custom_role_extending_read", READ_PERMS, Set.of(ProjectPermission.CODEVIEWER)},
{"custom_role_extending_triage", TRIAGE_PERMS, Set.of(ProjectPermission.SECURITYHOTSPOT_ADMIN)},
{"custom_role_extending_write", WRITE_PERMS, Set.of(ProjectPermission.ISSUE_ADMIN)},
{"custom_role_extending_maintain", MAINTAIN_PERMS, Set.of(ProjectPermission.SCAN)},
{"custom_role_extending_admin", ADMIN_PERMS, Set.of(ProjectPermission.ADMIN)},
});
}
public ToSonarqubeRolesWithFallbackOnRepositoryPermissionsTest(String role, GsonRepositoryPermissions repositoryPermissions, Set<String> expectedSqPermissions) {
this.role = role;
this.repositoryPermissions = repositoryPermissions;
this.expectedSqPermissions = expectedSqPermissions;
}
@Test
public void toGithubRepositoryPermissions_convertsCorrectly() {
Set<ProjectPermission> actualPermissions = githubPermissionConverter.toSonarqubeRolesWithFallbackOnRepositoryPermissions(ALL_PERMISSIONS_MAPPING_FROM_DB, role, repositoryPermissions);
assertThat(actualPermissions).isEqualTo(expectedSqPermissions);
}
}
@RunWith(Parameterized.class)
public static class ToSonarqubeRolesForDefaultRepositoryPermissionTest {
private final GithubPermissionConverter githubPermissionConverter = new GithubPermissionConverter();
private final String role;
private final Set<String> expectedSqPermissions;
@Parameterized.Parameters(name = "GH role:{0}, GH perms:{1}, Expected SQ perms:{2}")
public static Iterable<Object[]> testData() {
return Arrays.asList(new Object[][] {
{"none", Set.of()},
{"read", Set.of(ProjectPermission.CODEVIEWER)},
{"triage", Set.of(ProjectPermission.SECURITYHOTSPOT_ADMIN)},
{"write", Set.of(ProjectPermission.ISSUE_ADMIN)},
{"maintain", Set.of(ProjectPermission.SCAN)},
{"admin", Set.of(ProjectPermission.ADMIN)}
});
}
public ToSonarqubeRolesForDefaultRepositoryPermissionTest(String role, Set<String> expectedSqPermissions) {
this.role = role;
this.expectedSqPermissions = expectedSqPermissions;
}
@Test
public void toGithubRepositoryPermissions_convertsCorrectly() {
Set<ProjectPermission> actualPermissions = githubPermissionConverter.toSonarqubeRolesForDefaultRepositoryPermission(ALL_PERMISSIONS_MAPPING_FROM_DB, role);
assertThat(actualPermissions).isEqualTo(expectedSqPermissions);
}
}
}
|