Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow repository ADMIN to update RepositoryMetadata #1116

Merged
merged 5 commits into from
Mar 20, 2025
Merged

Allow repository ADMIN to update RepositoryMetadata #1116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2d5dca7
Allow repository ADMIN to update RepositoryMetadata
minwoox Mar 19, 2025
c16af6f
Fix
minwoox Mar 19, 2025
e4a68e7
lint
minwoox Mar 20, 2025
9a6e183
Merge branch 'main' into metadataRepositoryAdmin
minwoox Mar 20, 2025
b86a473
lint
minwoox Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion server/src/main/java/com/linecorp/centraldogma/server/internal/api/MetadataApiService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
import com.linecorp.centraldogma.server.QuotaConfig;
import com.linecorp.centraldogma.server.command.CommandExecutor;
import com.linecorp.centraldogma.server.internal.api.auth.RequiresProjectRole;
import com.linecorp.centraldogma.server.internal.api.auth.RequiresRepositoryRole;
import com.linecorp.centraldogma.server.internal.api.auth.RequiresSystemAdministrator;
import com.linecorp.centraldogma.server.metadata.MetadataService;
import com.linecorp.centraldogma.server.metadata.ProjectRoles;
Expand All @@ -61,7 +62,6 @@
* Annotated service object for managing metadata of projects.
*/
@ProducesJson
@RequiresProjectRole(ProjectRole.OWNER)
public class MetadataApiService extends AbstractService {

private final MetadataService mds;
Expand All @@ -79,6 +79,7 @@ public MetadataApiService(CommandExecutor executor, MetadataService mds,
*
* <p>Adds a member to the specified {@code projectName}.
*/
@RequiresProjectRole(ProjectRole.OWNER)
@Post("/metadata/{projectName}/members")
public CompletableFuture<Revision> addMember(@Param String projectName,
IdAndProjectRole request,
Expand All @@ -93,6 +94,7 @@ public CompletableFuture<Revision> addMember(@Param String projectName,
* <p>Updates the {@link ProjectRole} of the specified {@code memberId} in the specified
* {@code projectName}.
*/
@RequiresProjectRole(ProjectRole.OWNER)
@Patch("/metadata/{projectName}/members/{memberId}")
@Consumes("application/json-patch+json")
public CompletableFuture<Revision> updateMember(@Param String projectName,
Expand All @@ -111,6 +113,7 @@ public CompletableFuture<Revision> updateMember(@Param String projectName,
*
* <p>Removes the specified {@code memberId} from the specified {@code projectName}.
*/
@RequiresProjectRole(ProjectRole.OWNER)
@Delete("/metadata/{projectName}/members/{memberId}")
public CompletableFuture<Revision> removeMember(@Param String projectName,
@Param String memberId,
Expand All @@ -125,6 +128,7 @@ public CompletableFuture<Revision> removeMember(@Param String projectName,
*
* <p>Adds a {@link Token} to the specified {@code projectName}.
*/
@RequiresProjectRole(ProjectRole.OWNER)
@Post("/metadata/{projectName}/tokens")
public CompletableFuture<Revision> addToken(@Param String projectName,
IdAndProjectRole request,
Expand All @@ -139,6 +143,7 @@ public CompletableFuture<Revision> addToken(@Param String projectName,
* <p>Updates the {@link ProjectRole} of the {@link Token} of the specified {@code appId}
* in the specified {@code projectName}.
*/
@RequiresProjectRole(ProjectRole.OWNER)
@Patch("/metadata/{projectName}/tokens/{appId}")
@Consumes("application/json-patch+json")
public CompletableFuture<Revision> updateTokenRole(@Param String projectName,
Expand All @@ -156,6 +161,7 @@ public CompletableFuture<Revision> updateTokenRole(@Param String projectName,
*
* <p>Removes the {@link Token} of the specified {@code appId} from the specified {@code projectName}.
*/
@RequiresProjectRole(ProjectRole.OWNER)
@Delete("/metadata/{projectName}/tokens/{appId}")
public CompletableFuture<Revision> removeToken(@Param String projectName,
@Param String appId,
Expand All @@ -176,6 +182,7 @@ public CompletableFuture<Revision> removeToken(@Param String projectName,
* }
* }</pre>
*/
@RequiresRepositoryRole(RepositoryRole.ADMIN)
@Post("/metadata/{projectName}/repos/{repoName}/roles/projects")
public CompletableFuture<Revision> updateRepositoryProjectRoles(
@Param String projectName,
Expand All @@ -201,6 +208,7 @@ public CompletableFuture<Revision> updateRepositoryProjectRoles(
* <p>Adds the {@link RepositoryRole} of the specific users to the specified {@code repoName} in the
* specified {@code projectName}.
*/
@RequiresRepositoryRole(RepositoryRole.ADMIN)
@Post("/metadata/{projectName}/repos/{repoName}/roles/users")
public CompletableFuture<Revision> addUserRepositoryRole(
@Param String projectName,
Expand All @@ -218,6 +226,7 @@ public CompletableFuture<Revision> addUserRepositoryRole(
* <p>Removes {@link RepositoryRole} of the specified {@code memberId} from the specified {@code repoName}
* in the specified {@code projectName}.
*/
@RequiresRepositoryRole(RepositoryRole.ADMIN)
@Delete("/metadata/{projectName}/repos/{repoName}/roles/users/{memberId}")
public CompletableFuture<Revision> removeUserRepositoryRole(@Param String projectName,
@Param String repoName,
Expand All @@ -235,6 +244,7 @@ public CompletableFuture<Revision> removeUserRepositoryRole(@Param String projec
* <p>Adds the {@link RepositoryRole} for a token to the specified {@code repoName} in the specified
* {@code projectName}.
*/
@RequiresRepositoryRole(RepositoryRole.ADMIN)
@Post("/metadata/{projectName}/repos/{repoName}/roles/tokens")
public CompletableFuture<Revision> addTokenRepositoryRole(
@Param String projectName,
Expand All @@ -251,6 +261,7 @@ public CompletableFuture<Revision> addTokenRepositoryRole(
* <p>Removes the {@link RepositoryRole} of the specified {@code appId} from the specified {@code repoName}
* in the specified {@code projectName}.
*/
@RequiresRepositoryRole(RepositoryRole.ADMIN)
@Delete("/metadata/{projectName}/repos/{repoName}/roles/tokens/{appId}")
public CompletableFuture<Revision> removeTokenRepositoryRole(@Param String projectName,
@Param String repoName,
Expand Down
178 changes: 119 additions & 59 deletions server/src/test/java/com/linecorp/centraldogma/server/metadata/MetadataApiServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ class MetadataApiServiceTest {
private static final String REPOSITORY_NAME = "foo_repo";

private static final String MEMBER_ID = "[email protected]";
private static final String MEMBER_APP_ID = "foo";
private static final String APP_ID = "app_id";

@RegisterExtension
Expand All @@ -73,6 +74,8 @@ protected void configure(CentralDogmaBuilder builder) {

@SuppressWarnings("NotNullFieldNotInitialized")
static BlockingWebClient systemAdminClient;
@SuppressWarnings("NotNullFieldNotInitialized")
static BlockingWebClient memberTokenClient;

@BeforeAll
static void setUp() throws JsonMappingException, JsonParseException {
Expand All @@ -98,11 +101,35 @@ static void setUp() throws JsonMappingException, JsonParseException {
.isSameAs(HttpStatus.CREATED);

// Create a token
final HttpRequest request = HttpRequest.builder()
.post("/api/v1/tokens")
.content(MediaType.FORM_DATA, "appId=" + APP_ID)
.build();
HttpRequest request = HttpRequest.builder()
.post("/api/v1/tokens")
.content(MediaType.FORM_DATA, "appId=" + APP_ID)
.build();
assertThat(systemAdminClient.execute(request).status()).isSameAs(HttpStatus.CREATED);

final String memberToken = "appToken-secret-member";
// Create a token with a non-random secret.
request = HttpRequest.builder()
.post("/api/v1/tokens")
.content(MediaType.FORM_DATA,
"secret=" + memberToken + "&isSystemAdmin=false&appId=foo")
.build();
AggregatedHttpResponse res = systemAdminClient.execute(request);
assertThat(res.status()).isEqualTo(HttpStatus.CREATED);
res = systemAdminClient.get("/api/v1/tokens");
assertThat(res.contentUtf8()).contains("\"secret\":\"" + memberToken + '"');

// Add as a member to the project
request = HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/tokens")
.contentJson(new IdAndProjectRole(MEMBER_APP_ID, ProjectRole.MEMBER))
.build();
res = systemAdminClient.execute(request);
assertThat(res.status()).isSameAs(HttpStatus.OK);

memberTokenClient = WebClient.builder(dogma.httpClient().uri())
.auth(AuthToken.ofOAuth2(memberToken)).build()
.blocking();
}

@Test
Expand All @@ -113,18 +140,13 @@ void addUpdateAndRemoveProjectMember() throws JsonProcessingException {
ReplaceMode.RFC6902);
// [{"op":"replace","path":"/role","value":"OWNER"}]
// Update the member
HttpRequest request = HttpRequest.builder()
.patch("/api/v1/metadata/" + PROJECT_NAME + "/members/" + MEMBER_ID)
.content(MediaType.JSON_PATCH, Jackson.writeValueAsString(jsonPatch))
.build();
final HttpRequest request =
HttpRequest.builder()
.patch("/api/v1/metadata/" + PROJECT_NAME + "/members/" + MEMBER_ID)
.content(MediaType.JSON_PATCH, Jackson.writeValueAsString(jsonPatch))
.build();
assertThat(systemAdminClient.execute(request).status()).isSameAs(HttpStatus.OK);

// Remove the member
request = HttpRequest.builder()
.delete("/api/v1/metadata/" + PROJECT_NAME + "/members/" + MEMBER_ID)
.build();
assertThat(systemAdminClient.execute(request).status())
.isSameAs(HttpStatus.NO_CONTENT);
removeProjectMember();
}

private static void addProjectMember() {
Expand All @@ -135,6 +157,15 @@ private static void addProjectMember() {
assertThat(systemAdminClient.execute(request).status()).isSameAs(HttpStatus.OK);
}

private static void removeProjectMember() {
final HttpRequest request = HttpRequest.builder()
.delete("/api/v1/metadata/" + PROJECT_NAME + "/members/" +
MEMBER_ID)
.build();
assertThat(systemAdminClient.execute(request).status()).isSameAs(HttpStatus.NO_CONTENT);
assertThat(projectMetadata().repo(REPOSITORY_NAME).roles().users().get(MEMBER_ID)).isNull();
}

@Test
void addUpdateAndRemoveProjectToken() throws JsonProcessingException {
addProjectToken();
Expand Down Expand Up @@ -171,25 +202,18 @@ private static void addProjectToken() {
@Test
void addUpdateAndRemoveRepositoryUser() throws JsonProcessingException {
addProjectMember();
HttpRequest request = HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/" +
REPOSITORY_NAME + "/roles/users")
.contentJson(new IdAndRepositoryRole(MEMBER_ID, RepositoryRole.READ))
.build();
final HttpRequest request =
HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/" +
REPOSITORY_NAME + "/roles/users")
.contentJson(new IdAndRepositoryRole(MEMBER_ID, RepositoryRole.READ))
.build();
assertThat(systemAdminClient.execute(request).status()).isSameAs(HttpStatus.OK);

ProjectMetadata projectMetadata = projectMetadata();
assertThat(projectMetadata.repo(REPOSITORY_NAME).roles().users().get(MEMBER_ID))
assertThat(projectMetadata().repo(REPOSITORY_NAME).roles().users().get(MEMBER_ID))
.isSameAs(RepositoryRole.READ);

// Remove the member
request = HttpRequest.builder()
.delete("/api/v1/metadata/" + PROJECT_NAME + "/members/" + MEMBER_ID)
.build();
assertThat(systemAdminClient.execute(request).status())
.isSameAs(HttpStatus.NO_CONTENT);
projectMetadata = projectMetadata();
assertThat(projectMetadata.repo(REPOSITORY_NAME).roles().users().get(MEMBER_ID)).isNull();
removeProjectMember();
}

@Test
Expand Down Expand Up @@ -218,44 +242,23 @@ void addUpdateAndRemoveRepositoryToken() throws JsonProcessingException {

@Test
void grantRoleToMemberForMetaRepository() throws Exception {
final String memberToken = "appToken-secret-member";
// Create a token with a non-random secret.
HttpRequest request = HttpRequest.builder()
.post("/api/v1/tokens")
.content(MediaType.FORM_DATA,
"secret=" + memberToken + "&isSystemAdmin=false&appId=foo")
.build();
AggregatedHttpResponse res = systemAdminClient.execute(request);
assertThat(res.status()).isEqualTo(HttpStatus.CREATED);
res = systemAdminClient.get("/api/v1/tokens");
assertThat(res.contentUtf8()).contains("\"secret\":\"" + memberToken + '"');

// Add as a member to the project
request = HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/tokens")
.contentJson(new IdAndProjectRole("foo", ProjectRole.MEMBER))
.build();
res = systemAdminClient.execute(request);
assertThat(res.status()).isSameAs(HttpStatus.OK);

final BlockingWebClient memberClient = WebClient.builder(dogma.httpClient().uri())
.auth(AuthToken.ofOAuth2(memberToken)).build()
.blocking();
res = memberClient.get("/api/v1/projects/" + PROJECT_NAME + "/repos/meta/list");
final AggregatedHttpResponse res =
memberTokenClient.get("/api/v1/projects/" + PROJECT_NAME + "/repos/meta/list");
// A member isn't allowed to access the meta repository.
assertThat(res.status()).isSameAs(HttpStatus.FORBIDDEN);
assertThat(res.contentUtf8()).contains(
"Repository 'foo_proj/meta' can be accessed only by a system administrator.");

// Can't give a READ role to the member.
request = HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/meta/roles/projects")
.contentJson(ProjectRoles.of(RepositoryRole.READ, null))
.build();
final HttpRequest request =
HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/meta/roles/projects")
.contentJson(ProjectRoles.of(RepositoryRole.READ, null))
.build();
assertThat(systemAdminClient.execute(request).status()).isSameAs(HttpStatus.BAD_REQUEST);

// The member cannot access the meta repository.
assertThat(memberClient.get(
assertThat(memberTokenClient.get(
"/api/v1/projects/" + PROJECT_NAME + "/repos/meta/list").status())
.isSameAs(HttpStatus.FORBIDDEN);
}
Expand Down Expand Up @@ -291,11 +294,68 @@ void shouldNotAllowWritePermissionForGuest() {
assertThat(successResponse.content().major()).isGreaterThan(0);
}

@Test
void repositoryAdminCanUpdateRepositoryMetadata() {
addProjectMember();
HttpRequest updateRepositoryProjectRolesRequest = updateRepositoryProjectRolesRequest();
assertThat(memberTokenClient.execute(updateRepositoryProjectRolesRequest).status())
.isSameAs(HttpStatus.FORBIDDEN);
HttpRequest addUserRepositoryRoleRequest = addUserRepositoryRoleRequest();
assertThat(memberTokenClient.execute(addUserRepositoryRoleRequest).status())
.isSameAs(HttpStatus.FORBIDDEN);
HttpRequest removeUserRepositoryRoleRequest = removeUserRepositoryRoleRequest();
assertThat(memberTokenClient.execute(removeUserRepositoryRoleRequest).status())
.isSameAs(HttpStatus.FORBIDDEN);

// Promote the member to a repository admin.
final HttpRequest req = HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/" +
REPOSITORY_NAME + "/roles/tokens")
.contentJson(new IdAndRepositoryRole("foo", RepositoryRole.ADMIN))
.build();
assertThat(systemAdminClient.execute(req).status()).isSameAs(HttpStatus.OK);

// Now the member can update the repository metadata.
updateRepositoryProjectRolesRequest = updateRepositoryProjectRolesRequest();
assertThat(memberTokenClient.execute(updateRepositoryProjectRolesRequest).status())
.isSameAs(HttpStatus.OK);
addUserRepositoryRoleRequest = addUserRepositoryRoleRequest();
assertThat(memberTokenClient.execute(addUserRepositoryRoleRequest).status())
.isSameAs(HttpStatus.OK);
removeUserRepositoryRoleRequest = removeUserRepositoryRoleRequest();
assertThat(memberTokenClient.execute(removeUserRepositoryRoleRequest).status())
.isSameAs(HttpStatus.NO_CONTENT);
removeProjectMember();
}

private static ProjectMetadata projectMetadata() {
return systemAdminClient.prepare()
.get("/api/v1/projects/" + PROJECT_NAME)
.asJson(ProjectMetadata.class, new ObjectMapper())
.execute()
.content();
}

private static HttpRequest updateRepositoryProjectRolesRequest() {
return HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/" +
REPOSITORY_NAME + "/roles/projects")
.contentJson(ProjectRoles.of(RepositoryRole.READ, null))
.build();
}

private static HttpRequest addUserRepositoryRoleRequest() {
return HttpRequest.builder()
.post("/api/v1/metadata/" + PROJECT_NAME + "/repos/" +
REPOSITORY_NAME + "/roles/users")
.contentJson(new IdAndRepositoryRole(MEMBER_ID, RepositoryRole.ADMIN))
.build();
}

private static HttpRequest removeUserRepositoryRoleRequest() {
return HttpRequest.builder()
.delete("/api/v1/metadata/" + PROJECT_NAME + "/repos/" +
REPOSITORY_NAME + "/roles/users/" + MEMBER_ID)
.build();
}
}