Skip to content

Commit

Permalink
Add tests.
Browse files Browse the repository at this point in the history
  • Loading branch information
@tunacicek
tunacicek committed Aug 21, 2023
1 parent 548ebe6 commit 831ad78
Show file tree
Hide file tree
Showing 4 changed files with 210 additions and 7 deletions.
2 changes: 1 addition & 1 deletion ...end/src/main/java/org/eclipse/tractusx/semantics/registry/service/ShellAccessHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public Set<ShellIdentifier> filterSpecificAssetIdsByTenantId( Set<ShellIdentifie
shellIdentifierExternalSubjectReferenceKey.getValue().equals( tenantId ) ||
// or match if externalSubjectId = externalSubjectIdWildcardPrefix and key of identifier (for example manufacturerPartId) is allowing wildcard.
(shellIdentifierExternalSubjectReferenceKey.getValue().equals( externalSubjectIdWildcardPrefix ) &&
externalSubjectIdWildcardAllowedTypes.contains( identifier.getKey() )) ).findFirst();
externalSubjectIdWildcardAllowedTypes.contains( identifier.getKey() )) ).findFirst();
if ( optionalReferenceKey.isPresent() ) {
externalSubjectIdSet.add( identifier );
}
Expand Down
2 changes: 1 addition & 1 deletion backend/src/main/java/org/eclipse/tractusx/semantics/registry/utils/ShellSpecification.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ private Predicate applyFilter( Root<T> root,CriteriaQuery<?> cq, CriteriaBuilder
Instant searchValue = shellCursor.getShellSearchCursor();
cq.orderBy( criteriaBuilder.asc( criteriaBuilder.coalesce( root.get( sortFieldName ), Instant.now() ) ) );

if(owningTenantId == tenantId){
if(owningTenantId.equals( tenantId )){
return criteriaBuilder.greaterThan( root.get( sortFieldName ), searchValue );
}

Expand Down
4 changes: 4 additions & 0 deletions ...est/java/org/eclipse/tractusx/semantics/registry/AbstractAssetAdministrationShellApi.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.eclipse.tractusx.semantics.RegistryProperties;
import org.eclipse.tractusx.semantics.registry.repository.ShellRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
Expand Down Expand Up @@ -66,6 +67,9 @@ public abstract class AbstractAssetAdministrationShellApi {
@Autowired
private RegistryProperties registryProperties;

@Autowired
protected ShellRepository shellRepository;

protected String getId(ObjectNode payload) {
return payload.get("identification").textValue();
}
Expand Down
209 changes: 204 additions & 5 deletions ...java/org/eclipse/tractusx/semantics/registry/AssetAdministrationShellApiSecurityTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
package org.eclipse.tractusx.semantics.registry;

import static org.hamcrest.Matchers.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import java.util.List;
import java.util.UUID;
Expand All @@ -40,11 +39,7 @@
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;

import java.util.List;
import java.util.UUID;

import static org.eclipse.tractusx.semantics.registry.TestUtil.*;
import static org.hamcrest.Matchers.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import com.fasterxml.jackson.databind.JsonNode;
Expand Down Expand Up @@ -1042,4 +1037,208 @@ public void testFindExternalShellIdsBySpecificAssetIdsWithDefaultClosedTenantBas
.andExpect(jsonPath("$.result", hasSize(0)));
}
}

/**
* The specificAssetId#externalSubjectId indicates which tenant is allowed to see the shell with all properties or not.
*/
@Nested
@DisplayName("Tenant based Shell visibility test")
class TenantBasedShellVisibilityTest {

@BeforeEach
public void before() {
shellRepository.deleteAll();
}

@Test
public void testGetAllShellsByOwningTenantId() throws Exception {
AssetAdministrationShellDescriptor shellPayload = TestUtil.createCompleteAasDescriptor();
shellPayload.setId(UUID.randomUUID().toString());
List<SpecificAssetId> shellpayloadSpecificAssetIDs = shellPayload.getSpecificAssetIds();
// Make all specificAssetIds to closed with externalSubjectId==null.
shellpayloadSpecificAssetIDs.forEach( specificAssetId -> specificAssetId.setExternalSubjectId( null ) );
shellPayload.setSpecificAssetIds( shellpayloadSpecificAssetIDs );

performShellCreateRequest(mapper.writeValueAsString(shellPayload));

// Request with owner TenantId (TENANT_ONE) returns one shell
mvc.perform(
MockMvcRequestBuilders
.get(SHELL_BASE_PATH)
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantOne().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.result").exists())
.andExpect(jsonPath("$.result", hasSize(1)))
.andExpect(jsonPath("$.result[0].description[*]").isNotEmpty())
.andExpect(jsonPath("$.result[0].idShort",is(shellPayload.getIdShort())));

// Request with TenantId (TENANT_TWO) returns no shells, because the shell not includes the externalSubjectId of Tenant_two as specificId
mvc.perform(
MockMvcRequestBuilders
.get(SHELL_BASE_PATH)
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantTwo().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.result").exists())
.andExpect(jsonPath("$.result", hasSize(0)));
}

@Test
public void testGetAllShellsWithPublicAccessByTenantId() throws Exception {
// the keyPrefix ensures that this test can run against a persistent database multiple times
String keyPrefix = UUID.randomUUID().toString();
AssetAdministrationShellDescriptor shellPayload = TestUtil.createCompleteAasDescriptor();
shellPayload.setSpecificAssetIds(null);
shellPayload.setId(UUID.randomUUID().toString());

// asset1 is only visible for the owner because the externalSubjectId = null
SpecificAssetId asset1 = TestUtil.createSpecificAssetId(keyPrefix + "defaultClosed","value_1",null);
// asset2 is visible for everyone, because externalSubjectId = PUBLIC_READABLE and specificAssetKey is manufacturerPartId (which is in the list of allowedTypes via application.yml)
SpecificAssetId asset2 = TestUtil.createSpecificAssetId("manufacturerPartId","value_2",List.of(getExternalSubjectIdWildcardPrefix()));
// asset3 is visible for tenantTwo, because externalSubjectId = tenantTwo
SpecificAssetId asset3 = TestUtil.createSpecificAssetId(keyPrefix + "tenantTwo","value_2",List.of(jwtTokenFactory.tenantTwo().getTenantId()));

shellPayload.setSpecificAssetIds(List.of(asset1,asset2,asset3));
performShellCreateRequest(mapper.writeValueAsString(shellPayload));

// Request with TenantId (TENANT_TWO) returns one shell with extend visibility of shell-properties, because tenantId is included in the specificAssetIds
mvc.perform(
MockMvcRequestBuilders
.get(SHELL_BASE_PATH)
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantTwo().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.result").exists())
.andExpect(jsonPath("$.result", hasSize(1)))
.andExpect(jsonPath("$.result[0].description[*]").isNotEmpty())
.andExpect(jsonPath("$.result[0].idShort",is(shellPayload.getIdShort())))
.andExpect(jsonPath("$.result[0].id",is( shellPayload.getId() )))
.andExpect(jsonPath("$.result[0].submodelDescriptors[*]").exists())
.andExpect(jsonPath("$.result[0].specificAssetIds[*]").exists());

// Request with TenantId (TENANT_THREE) returns one shell with only public visible shell-properties
mvc.perform(
MockMvcRequestBuilders
.get(SHELL_BASE_PATH)
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantThree().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.result").exists())
.andExpect(jsonPath("$.result", hasSize(1)))
.andExpect(jsonPath("$.result[0].description[*]").doesNotExist())
.andExpect(jsonPath("$.result[0].idShort").doesNotExist())
.andExpect(jsonPath("$.result[0].id",is( shellPayload.getId() )))
.andExpect(jsonPath("$.result[0].submodelDescriptors[*]").exists())
.andExpect(jsonPath("$.result[0].specificAssetIds[*]").exists());
}

@Test
public void testGetShellByExternalIdByOwningTenantId() throws Exception {
AssetAdministrationShellDescriptor shellPayload = TestUtil.createCompleteAasDescriptor();
shellPayload.setId(UUID.randomUUID().toString());
List<SpecificAssetId> shellpayloadSpecificAssetIDs = shellPayload.getSpecificAssetIds();
// Make all specificAssetIds to closed with externalSubjectId==null.
shellpayloadSpecificAssetIDs.forEach( specificAssetId -> specificAssetId.setExternalSubjectId( null ) );
shellPayload.setSpecificAssetIds( shellpayloadSpecificAssetIDs );

performShellCreateRequest(mapper.writeValueAsString(shellPayload));


// Request with owner TenantId (TENANT_ONE) returns one shell
mvc.perform(
MockMvcRequestBuilders
.get(SINGLE_SHELL_BASE_PATH, getEncodedValue( shellPayload.getId() ))
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantOne().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.description[*]").isNotEmpty())
.andExpect(jsonPath("$.idShort",is(shellPayload.getIdShort())));

// Request with TenantId (TENANT_TWO) returns no shell, because the shell not includes the externalSubjectId of Tenant_two as specificId
mvc.perform(
MockMvcRequestBuilders
.get(SINGLE_SHELL_BASE_PATH, getEncodedValue( shellPayload.getId() ))
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantTwo().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isNotFound());
}

@Test
public void testGetAllShellByExternalIdWithPublicAccessByTenantId() throws Exception {
// the keyPrefix ensures that this test can run against a persistent database multiple times
String keyPrefix = UUID.randomUUID().toString();
AssetAdministrationShellDescriptor shellPayload = TestUtil.createCompleteAasDescriptor();
shellPayload.setSpecificAssetIds(null);
shellPayload.setId(UUID.randomUUID().toString());

// asset1 is only visible for the owner because the externalSubjectId = null
SpecificAssetId asset1 = TestUtil.createSpecificAssetId(keyPrefix + "defaultClosed","value_1",null);
// asset2 is visible for everyone, because externalSubjectId = PUBLIC_READABLE and specificAssetKey is manufacturerPartId (which is in the list of allowedTypes via application.yml)
SpecificAssetId asset2 = TestUtil.createSpecificAssetId("manufacturerPartId","value_2",List.of(getExternalSubjectIdWildcardPrefix()));
// asset3 is visible for tenantTwo, because externalSubjectId = tenantTwo
SpecificAssetId asset3 = TestUtil.createSpecificAssetId(keyPrefix + "tenantTwo","value_2",List.of(jwtTokenFactory.tenantTwo().getTenantId()));

shellPayload.setSpecificAssetIds(List.of(asset1,asset2,asset3));
performShellCreateRequest(mapper.writeValueAsString(shellPayload));

// Request with TenantId (TENANT_TWO) returns one shell with extend visibility of shell-properties, because tenantId is included in the specificAssetIds
mvc.perform(
MockMvcRequestBuilders
.get(SINGLE_SHELL_BASE_PATH, getEncodedValue( shellPayload.getId() ))
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantTwo().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.description[*]").isNotEmpty())
.andExpect(jsonPath("$.idShort",is(shellPayload.getIdShort())))
.andExpect(jsonPath("$.id",is( shellPayload.getId() )))
.andExpect(jsonPath("$.submodelDescriptors[*]").exists())
.andExpect(jsonPath("$.specificAssetIds[*]").exists());

// Request with TenantId (TENANT_THREE) returns one shell with only public visible shell-properties
mvc.perform(
MockMvcRequestBuilders
.get(SINGLE_SHELL_BASE_PATH, getEncodedValue( shellPayload.getId() ))
.header( EXTERNAL_SUBJECT_ID_HEADER, jwtTokenFactory.tenantThree().getTenantId() )
.queryParam("pageSize", "100")
.accept(MediaType.APPLICATION_JSON)
.with(jwtTokenFactory.allRoles())
)
.andDo(MockMvcResultHandlers.print())
.andExpect(status().isOk())
.andExpect(jsonPath("$.description[*]").doesNotExist())
.andExpect(jsonPath("$.idShort").doesNotExist())
.andExpect(jsonPath("$.id",is( shellPayload.getId() )))
.andExpect(jsonPath("$.submodelDescriptors[*]").exists())
.andExpect(jsonPath("$.specificAssetIds[*]").exists());
}
}
}

0 comments on commit 831ad78

Please sign in to comment.