Skip to content

[groups-validation] - Add catalogItemId to groups validation. #82

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

Merged
sergio-soria-bi merged 1 commit into from
Sep 3, 2026
Merged

[groups-validation] - Add catalogItemId to groups validation. #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions ...rg/opendevstack/component_catalog/server/controllers/ProvisionerActionsApiController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public ResponseEntity<Void> notifyProvisioningStatusUpdate(String projectKey,
projectKey, provisioningStatusUpdateRequest.toString());

var normalizedProjectKey = projectKey.toUpperCase();
provisionerActionsApiFacade.validateGroupRestrictions(normalizedProjectKey);
provisionerActionsApiFacade.validateGroupRestrictions(normalizedProjectKey, provisioningStatusUpdateRequest);
var normalizedComponentUrl = provisioningStatusUpdateRequest.getComponentUrl().orElse(Strings.EMPTY);
var parameters = map(provisioningStatusUpdateRequest);

Expand All @@ -68,7 +68,7 @@ public ResponseEntity<Void> notifyProvisioningStatusUpdatePartially(String proje
projectKey, provisioningStatusUpdateRequest.toString());

var normalizedProjectKey = projectKey.toUpperCase();
provisionerActionsApiFacade.validateGroupRestrictions(normalizedProjectKey);
provisionerActionsApiFacade.validateGroupRestrictions(normalizedProjectKey, provisioningStatusUpdateRequest);
var normalizedComponentUrl = provisioningStatusUpdateRequest.getComponentUrl().orElse(Strings.EMPTY);
var parameters = map(provisioningStatusUpdateRequest);

Expand Down
15 changes: 12 additions & 3 deletions ...in/java/org/opendevstack/component_catalog/server/facade/ProvisionerActionsApiFacade.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import org.jspecify.annotations.NonNull;
import org.opendevstack.component_catalog.config.ApplicationPropertiesConfiguration;
import org.opendevstack.component_catalog.server.controllers.exceptions.ForbiddenException;
import org.opendevstack.component_catalog.server.controllers.exceptions.InvalidRestEntityException;
import org.opendevstack.component_catalog.server.model.ProvisioningStatusUpdateRequest;
import org.opendevstack.component_catalog.server.services.ProjectsInfoService;
import org.opendevstack.component_catalog.server.services.catalog.CatalogItemUserActionGroupsRestriction;
Expand Down Expand Up @@ -49,8 +50,15 @@ public ProvisionerActionsApiFacade(ProjectsInfoService projectsInfoService,
.toList();
}

public void validateGroupRestrictions(String projectKey) {
public void validateGroupRestrictions(String projectKey, ProvisioningStatusUpdateRequest provisioningStatusUpdateRequest) {
var accessToken = authenticationFacade.getAccessToken();
var catalogItemId = provisioningStatusUpdateRequest.getCatalogItemId();

if (catalogItemId == null) {
log.error("Catalog item id is null. Cannot validate group restrictions");

throw new InvalidRestEntityException("Catalog item id is null. Cannot validate group restrictions");
}

var oid = JwtUtils.extractClaim(accessToken, "oid");

Expand All @@ -61,11 +69,11 @@ public void validateGroupRestrictions(String projectKey) {
} else {
log.debug("Token with oid '{}' is NOT allowed to bypass group restrictions for project {}. Validating group restrictions", oid.orElse("unknown"), projectKey);

validateGroupRestrictions(projectKey, accessToken);
validateGroupRestrictions(projectKey, catalogItemId, accessToken);
}
}

private void validateGroupRestrictions(String projectKey, String accessToken) {
private void validateGroupRestrictions(String projectKey, String catalogItemId, String accessToken) {
var groupRestriction = CatalogItemUserActionGroupsRestriction.builder()
.prefix(groupsRestrictionProps.getPrefix())
.suffix(groupsRestrictionProps.getSuffix())
Expand All @@ -81,6 +89,7 @@ private void validateGroupRestrictions(String projectKey, String accessToken) {
var params = RestrictionsParams.builder()
.userGroups(userGroups)
.projectKey(projectKey)
.catalogItemId(catalogItemId)
.build();

var requestable = Optional.ofNullable(groupsRestrictionsEvaluator.evaluate(evaluationRestrictions, params))
Expand Down
8 changes: 4 additions & 4 deletions ...pendevstack/component_catalog/server/controllers/ProvisionerActionsApiControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ void givenAProjectKey_whenNotifyProvisioningCompleted_thenServiceIsCalled() thro
provisionerActionsApiController.notifyProvisioningStatusUpdate(projectKey, status, request);

// then
verify(provisionerActionsApiFacade).validateGroupRestrictions(projectKey.toUpperCase());
verify(provisionerActionsApiFacade).validateGroupRestrictions(projectKey.toUpperCase(), request);
verify(provisionerActionsService).updateComponentProvisioningStatus(projectKey.toUpperCase(),
request(componentId, catalogItemId, Status.CREATED, componentUrl, workflowJobId, deletionWorkflowJobId, parameters)
);
Expand Down Expand Up @@ -129,7 +129,7 @@ void givenAProjectKey_whenNotifyProvisioningStatusUpdatePartially_thenCallsServi
provisionerActionsApiController.notifyProvisioningStatusUpdatePartially(projectKey, status, request);

// then
verify(provisionerActionsApiFacade).validateGroupRestrictions(projectKey.toUpperCase());
verify(provisionerActionsApiFacade).validateGroupRestrictions(projectKey.toUpperCase(), request);
verify(provisionerActionsService).updatePartiallyComponentProvisioningStatus(
projectKey.toUpperCase(),
request(componentId, catalogItemId, Status.CREATING, componentUrl, workflowJobId, deletionWorkflowJobId, parameters)
Expand Down Expand Up @@ -168,7 +168,7 @@ void givenAProjectKeyAndNoComponentUrl_whenNotifyProvisioningStatusUpdatePartial
provisionerActionsApiController.notifyProvisioningStatusUpdatePartially(projectKey, status, request);

// then
verify(provisionerActionsApiFacade).validateGroupRestrictions(eq(projectKey.toUpperCase()));
verify(provisionerActionsApiFacade).validateGroupRestrictions(eq(projectKey.toUpperCase()), eq(request));
verify(provisionerActionsService).updatePartiallyComponentProvisioningStatus(
projectKey.toUpperCase(),
request(componentId, catalogItemId, Status.CREATING, "", workflowJobId, deletionWorkflowJobId, parameters)
Expand Down Expand Up @@ -207,7 +207,7 @@ void givenAProjectKeyAndNoComponentUrl_whenNotifyProvisioningStatusUpdate_thenSe
provisionerActionsApiController.notifyProvisioningStatusUpdate(projectKey, status, request);

// then
verify(provisionerActionsApiFacade).validateGroupRestrictions(eq(projectKey.toUpperCase()));
verify(provisionerActionsApiFacade).validateGroupRestrictions(eq(projectKey.toUpperCase()), eq(request));
verify(provisionerActionsService).updateComponentProvisioningStatus(
projectKey.toUpperCase(),
request(componentId, catalogItemId, Status.CREATING, "", workflowJobId, deletionWorkflowJobId, parameters)
Expand Down
83 changes: 71 additions & 12 deletions ...ava/org/opendevstack/component_catalog/server/facade/ProvisionerActionsApiFacadeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import org.mockito.junit.jupiter.MockitoExtension;
import org.opendevstack.component_catalog.config.ApplicationPropertiesConfiguration;
import org.opendevstack.component_catalog.server.controllers.exceptions.ForbiddenException;
import org.opendevstack.component_catalog.server.controllers.exceptions.InvalidRestEntityException;
import org.opendevstack.component_catalog.server.model.ProvisioningStatusUpdateRequest;
import org.opendevstack.component_catalog.server.model.ProvisioningStatusUpdateRequestParametersInner;
import org.opendevstack.component_catalog.server.services.ProjectsInfoService;
Expand All @@ -23,6 +24,7 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
Expand All @@ -31,6 +33,9 @@
@ExtendWith(MockitoExtension.class)
class ProvisionerActionsApiFacadeTest {

private static final String PROJECT_KEY = "PROJECT";
private static final String CATALOG_ITEM_ID = "catalog-item-id";

@Mock
private ProjectsInfoService projectsInfoService;
@Mock
Expand Down Expand Up @@ -92,12 +97,16 @@ void map_withEmptyParameters_returnsEmptyList() {
assertThat(result).isEmpty();
}

private ProvisioningStatusUpdateRequest requestWithCatalogItemId(String catalogItemId) {
return new ProvisioningStatusUpdateRequest().catalogItemId(catalogItemId);
}

@Test
void validateGroupRestrictions_whenUserHasPermissions_doesNotThrow() {
// given
var projectKey = "PROJECT";
var accessToken = "accessToken";
var userGroups = List.of("group1");
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);
when(groupsRestrictionProps.getPrefix()).thenReturn(List.of("prefix-"));
Expand All @@ -111,16 +120,23 @@ void validateGroupRestrictions_whenUserHasPermissions_doesNotThrow() {
.thenReturn(Optional.empty());

// when / then
provisionerActionsApiFacade.validateGroupRestrictions(projectKey);
provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request);

verify(groupsRestrictionsEvaluator)
.evaluate(any(EvaluationRestrictions.class), eq(RestrictionsParams.builder()
.userGroups(userGroups)
.projectKey(PROJECT_KEY)
.catalogItemId(CATALOG_ITEM_ID)
.build()));
}
}

@Test
void validateGroupRestrictions_whenUserHasNoPermissions_throwsForbiddenException() {
// given
var projectKey = "PROJECT";
var accessToken = "accessToken";
var userGroups = List.of("group1");
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);
when(groupsRestrictionProps.getPrefix()).thenReturn(List.of("prefix-"));
Expand All @@ -134,7 +150,7 @@ void validateGroupRestrictions_whenUserHasNoPermissions_throwsForbiddenException
.thenReturn(Optional.empty());

// when / then
assertThatThrownBy(() -> provisionerActionsApiFacade.validateGroupRestrictions(projectKey))
assertThatThrownBy(() -> provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request))
.isInstanceOf(ForbiddenException.class)
.hasMessage("User not allowed to perform this action");
}
Expand All @@ -143,9 +159,9 @@ void validateGroupRestrictions_whenUserHasNoPermissions_throwsForbiddenException
@Test
void validateGroupRestrictions_whenEvaluatorReturnsNull_doesNotThrow() {
// given
var projectKey = "PROJECT";
var accessToken = "accessToken";
var userGroups = List.of("group1");
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);
when(groupsRestrictionProps.getPrefix()).thenReturn(List.of("prefix-"));
Expand All @@ -159,16 +175,16 @@ void validateGroupRestrictions_whenEvaluatorReturnsNull_doesNotThrow() {
.thenReturn(Optional.empty());

// when / then
provisionerActionsApiFacade.validateGroupRestrictions(projectKey);
provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request);
}
}

@Test
void validateGroupRestrictions_whenPermittedOidsContainsExtractedOid_bypassesGroupRestrictions() {
// given
var projectKey = "PROJECT";
var accessToken = "accessToken";
var permittedOid = "oid1";
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);

Expand All @@ -177,7 +193,7 @@ void validateGroupRestrictions_whenPermittedOidsContainsExtractedOid_bypassesGro
.thenReturn(Optional.of(permittedOid));

// when
provisionerActionsApiFacade.validateGroupRestrictions(projectKey);
provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request);

// then - Verify that the group restrictions evaluator is never called when oid is in permittedOids
verify(groupsRestrictionsEvaluator, never())
Expand All @@ -189,9 +205,9 @@ void validateGroupRestrictions_whenPermittedOidsContainsExtractedOid_bypassesGro
@Test
void validateGroupRestrictions_whenPermittedOidsContainsExtractedOid_doesNotThrow() {
// given
var projectKey = "PROJECT";
var accessToken = "accessToken";
var permittedOid = "oid2";
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);

Expand All @@ -200,16 +216,16 @@ void validateGroupRestrictions_whenPermittedOidsContainsExtractedOid_doesNotThro
.thenReturn(Optional.of(permittedOid));

// when / then - should not throw any exception
provisionerActionsApiFacade.validateGroupRestrictions(projectKey);
provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request);
}
}

@Test
void validateGroupRestrictions_whenTokenHasNoOid_callsGroupRestrictionsEvaluation() {
// given
var projectKey = "PROJECT";
var accessToken = "accessToken";
var userGroups = List.of("group1");
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);
when(groupsRestrictionProps.getPrefix()).thenReturn(List.of("prefix-"));
Expand All @@ -223,13 +239,56 @@ void validateGroupRestrictions_whenTokenHasNoOid_callsGroupRestrictionsEvaluatio
.thenReturn(Optional.empty());

// when
provisionerActionsApiFacade.validateGroupRestrictions(projectKey);
provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request);

// then - Verify that the group restrictions evaluator is called when oid is not in permittedOids
verify(groupsRestrictionsEvaluator)
.evaluate(any(EvaluationRestrictions.class), any(RestrictionsParams.class));
verify(projectsInfoService).getProjectGroups(accessToken);
}
}

@Test
void validateGroupRestrictions_whenCatalogItemIdIsNull_throwsInvalidRestEntityException() {
// given
var request = requestWithCatalogItemId(null);

// when / then
assertThatThrownBy(() -> provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request))
.isInstanceOf(InvalidRestEntityException.class)
.hasMessage("Catalog item id is null. Cannot validate group restrictions");

verify(authenticationFacade).getAccessToken();
verify(groupsRestrictionsEvaluator, never()).evaluate(any(EvaluationRestrictions.class), any(RestrictionsParams.class));
verify(projectsInfoService, never()).getProjectGroups(any());
}

@Test
void validateGroupRestrictions_whenExtractedOidIsNotPermitted_callsGroupRestrictionsEvaluation() {
// given
var accessToken = "accessToken";
var userGroups = List.of("group1");
var request = requestWithCatalogItemId(CATALOG_ITEM_ID);

when(authenticationFacade.getAccessToken()).thenReturn(accessToken);
when(groupsRestrictionProps.getPrefix()).thenReturn(List.of("prefix-"));
when(groupsRestrictionProps.getSuffix()).thenReturn(List.of("-suffix"));
when(projectsInfoService.getProjectGroups(accessToken)).thenReturn(userGroups);
when(groupsRestrictionsEvaluator.evaluate(any(EvaluationRestrictions.class), any(RestrictionsParams.class)))
.thenReturn(RestrictionsEvaluatorResultMother.of(true, "allowed"));

try (var jwtUtilsMocked = mockStatic(JwtUtils.class)) {
jwtUtilsMocked.when(() -> JwtUtils.extractClaim(accessToken, "oid"))
.thenReturn(Optional.of("non-permitted-oid"));

// when
provisionerActionsApiFacade.validateGroupRestrictions(PROJECT_KEY, request);

// then
verify(groupsRestrictionsEvaluator)
.evaluate(any(EvaluationRestrictions.class), any(RestrictionsParams.class));
verify(projectsInfoService).getProjectGroups(accessToken);
}
}
}

Loading