fix: add a check for / suffix for basyx external url in registry integration #333
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| /******************************************************************************* | ||
| * Copyright (C) 2024 the Eclipse BaSyx Authors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining | ||
| * a copy of this software and associated documentation files (the | ||
| * "Software"), to deal in the Software without restriction, including | ||
| * without limitation the rights to use, copy, modify, merge, publish, | ||
| * distribute, sublicense, and/or sell copies of the Software, and to | ||
| * permit persons to whom the Software is furnished to do so, subject to | ||
| * the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be | ||
| * included in all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| * | ||
| * SPDX-License-Identifier: MIT | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.digitaltwin.basyx.aasrepository.feature.registry.integration; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
|
|
||
| import org.eclipse.digitaltwin.aas4j.v3.model.AssetAdministrationShell; | ||
| import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultAssetAdministrationShell; | ||
| import org.eclipse.digitaltwin.basyx.aasregistry.client.api.RegistryAndDiscoveryInterfaceApi; | ||
| import org.eclipse.digitaltwin.basyx.aasregistry.client.model.AssetAdministrationShellDescriptor; | ||
| import org.eclipse.digitaltwin.basyx.aasregistry.main.client.factory.AasDescriptorFactory; | ||
| import org.eclipse.digitaltwin.basyx.aasregistry.main.client.mapper.AttributeMapper; | ||
| import org.eclipse.digitaltwin.basyx.aasrepository.AasRepository; | ||
| import org.eclipse.digitaltwin.basyx.aasrepository.backend.SimpleAasRepositoryFactory; | ||
| import org.eclipse.digitaltwin.basyx.aasrepository.backend.inmemory.AasInMemoryBackendProvider; | ||
| import org.eclipse.digitaltwin.basyx.aasservice.backend.InMemoryAasServiceFactory; | ||
| import org.eclipse.digitaltwin.basyx.core.filerepository.InMemoryFileRepository; | ||
| import org.eclipse.digitaltwin.basyx.http.Base64UrlEncodedIdentifier; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.Parameterized; | ||
| import org.mockito.Mockito; | ||
|
|
||
| /** | ||
| * Test suite for {@link RegistryIntegrationAasRepository} feature | ||
| */ | ||
| @RunWith(Parameterized.class) | ||
| public class AasRepositoryRegistryLinkDescriptorGenerationTest { | ||
| private static final String DUMMY_IDSHORT = "ExampleMotor"; | ||
| private static final String DUMMY_AAS_ID = "customIdentifier"; | ||
|
|
||
| private static final String BASE_URL = "http://localhost:8081"; | ||
|
|
||
| private RegistryIntegrationAasRepository registryIntegrationAasRepository; | ||
| private AasRepository mockedAasRepository; | ||
| private AasRepositoryRegistryLink mockedRegistryLink; | ||
| private AttributeMapper mockedAttributeMapper; | ||
| private RegistryAndDiscoveryInterfaceApi mockedRegistryApi; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| mockedAasRepository = getAasRepository(); | ||
| mockedRegistryLink = Mockito.mock(AasRepositoryRegistryLink.class); | ||
| mockedAttributeMapper = Mockito.mock(AttributeMapper.class); | ||
| mockedRegistryApi = Mockito.mock(RegistryAndDiscoveryInterfaceApi.class); | ||
|
|
||
| Mockito.when(mockedRegistryLink.getRegistryApi()).thenReturn(mockedRegistryApi); | ||
|
|
||
| registryIntegrationAasRepository = new RegistryIntegrationAasRepository(mockedAasRepository, mockedRegistryLink, mockedAttributeMapper); | ||
| } | ||
|
|
||
| @Parameterized.Parameter(0) | ||
| public String externalUrl; | ||
|
|
||
| @Parameterized.Parameter(1) | ||
| public String expectedUrl; | ||
|
|
||
| @Parameterized.Parameters | ||
| public static Collection<Object[]> data() { | ||
| return Arrays.asList(new Object[][] { { BASE_URL + "/context", BASE_URL + "/context/shells/" + Base64UrlEncodedIdentifier.encodeIdentifier(DUMMY_AAS_ID) }, | ||
| { BASE_URL, BASE_URL + "/shells/" + Base64UrlEncodedIdentifier.encodeIdentifier(DUMMY_AAS_ID) }, { BASE_URL + "/", BASE_URL + "/shells/" + Base64UrlEncodedIdentifier.encodeIdentifier(DUMMY_AAS_ID) }, | ||
| { BASE_URL + "/context/", BASE_URL + "/context/shells/" + Base64UrlEncodedIdentifier.encodeIdentifier(DUMMY_AAS_ID) } }); | ||
| } | ||
|
|
||
| @Test | ||
| public void testExternalUrl() { | ||
| Mockito.when(mockedRegistryLink.getAasRepositoryBaseURLs()).thenReturn(List.of(externalUrl)); | ||
|
|
||
| AssetAdministrationShellDescriptor descriptor = createAndRetrieveDescriptor(createDummyAas()); | ||
| String actualUrl = descriptor.getEndpoints().get(0).getProtocolInformation().getHref(); | ||
|
|
||
| assertEquals(expectedUrl, actualUrl); | ||
| } | ||
|
|
||
| private AssetAdministrationShellDescriptor createAndRetrieveDescriptor(AssetAdministrationShell shell) { | ||
| registryIntegrationAasRepository.createAas(shell); | ||
|
|
||
| AasDescriptorFactory descriptorFactory = new AasDescriptorFactory(shell, mockedRegistryLink.getAasRepositoryBaseURLs(), mockedAttributeMapper); | ||
| return descriptorFactory.create(); | ||
| } | ||
|
|
||
| private AssetAdministrationShell createDummyAas() { | ||
| return new DefaultAssetAdministrationShell.Builder() | ||
| .id(DUMMY_AAS_ID) | ||
| .idShort(DUMMY_IDSHORT) | ||
| .build(); | ||
| } | ||
|
|
||
| protected AasRepository getAasRepository() { | ||
| return new SimpleAasRepositoryFactory(new AasInMemoryBackendProvider(), new InMemoryAasServiceFactory(new InMemoryFileRepository())).create(); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /******************************************************************************* | ||
| * Copyright (C) 2024 the Eclipse BaSyx Authors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining | ||
| * a copy of this software and associated documentation files (the | ||
| * "Software"), to deal in the Software without restriction, including | ||
| * without limitation the rights to use, copy, modify, merge, publish, | ||
| * distribute, sublicense, and/or sell copies of the Software, and to | ||
| * permit persons to whom the Software is furnished to do so, subject to | ||
| * the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be | ||
| * included in all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| * | ||
| * SPDX-License-Identifier: MIT | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.digitaltwin.basyx.core; | ||
|
|
||
| import java.net.MalformedURLException; | ||
| import java.net.URI; | ||
| import java.net.URISyntaxException; | ||
|
|
||
| public final class RepositoryUrlHelper { | ||
|
|
||
| private RepositoryUrlHelper() { | ||
| } | ||
|
|
||
| public static String createRepositoryUrl(String baseUrl, String additionalPath) { | ||
| try { | ||
| URI baseUri = new URI(baseUrl); | ||
|
|
||
| String[] basePathSegments = baseUri.getPath().replaceAll("^/|/$", "").split("/"); | ||
| String[] additionalPathSegments = additionalPath != null ? additionalPath.replaceAll("^/|/$", "").split("/") : new String[0]; | ||
|
|
||
| StringBuilder fullPath = new StringBuilder(); | ||
| for (String segment : basePathSegments) { | ||
| if (!segment.isEmpty()) { | ||
| fullPath.append("/").append(segment); | ||
| } | ||
| } | ||
| for (String segment : additionalPathSegments) { | ||
| if (!segment.isEmpty()) { | ||
| fullPath.append("/").append(segment); | ||
| } | ||
| } | ||
|
|
||
| URI finalUri = new URI(baseUri.getScheme(), null, baseUri.getHost(), baseUri.getPort(), fullPath.toString(), null, null); | ||
|
|
||
| return finalUri.toURL().toString(); | ||
| } catch (URISyntaxException | MalformedURLException e) { | ||
| throw new RuntimeException("The Base URL or additional path is malformed.\n" + e.getMessage(), e); | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /******************************************************************************* | ||
| * Copyright (C) 2024 the Eclipse BaSyx Authors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining | ||
| * a copy of this software and associated documentation files (the | ||
| * "Software"), to deal in the Software without restriction, including | ||
| * without limitation the rights to use, copy, modify, merge, publish, | ||
| * distribute, sublicense, and/or sell copies of the Software, and to | ||
| * permit persons to whom the Software is furnished to do so, subject to | ||
| * the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be | ||
| * included in all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| * | ||
| * SPDX-License-Identifier: MIT | ||
| ******************************************************************************/ | ||
|
|
||
| package org.eclipse.digitaltwin.basyx.core; | ||
|
|
||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| public class TestRepositoryUrlHelper { | ||
|
|
||
| private static final String BASE_URL = "http://localhost:8081"; | ||
| private static final String BASE_URL_WITH_CONTEXT = "http://localhost:8081/context"; | ||
| private static final String ADDITIONAL_PATH = "shells"; | ||
|
|
||
| private static final String EXPECTED_URL = BASE_URL + "/" + ADDITIONAL_PATH; | ||
| private static final String EXPECTED_URL_WITH_CONTEXT = BASE_URL_WITH_CONTEXT + "/" + ADDITIONAL_PATH; | ||
|
|
||
| @Test | ||
| public void testUrlWithTrailingSlashAndPathNameWithNoLeadingSlash() { | ||
| assertEquals(EXPECTED_URL, RepositoryUrlHelper.createRepositoryUrl(BASE_URL + "/", ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithoutTrailingSlashAndPathNameWithNoLeadingSlash() { | ||
| assertEquals(EXPECTED_URL, RepositoryUrlHelper.createRepositoryUrl(BASE_URL, ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithTrailingSlashAndPathNameWithLeadingSlash() { | ||
| assertEquals(EXPECTED_URL, RepositoryUrlHelper.createRepositoryUrl(BASE_URL + "/", "/" + ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithoutTrailingSlashAndPathNameWithLeadingSlash() { | ||
| assertEquals(EXPECTED_URL, RepositoryUrlHelper.createRepositoryUrl(BASE_URL, "/" + ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithContextAndTrailingSlashAndPathNameWithLeadingSlash() { | ||
| assertEquals(EXPECTED_URL_WITH_CONTEXT, | ||
| RepositoryUrlHelper.createRepositoryUrl(BASE_URL_WITH_CONTEXT + "/", "/" + ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithContextAndNoTrailingSlashAndPathNameWithLeadingSlash() { | ||
| assertEquals(EXPECTED_URL_WITH_CONTEXT, | ||
| RepositoryUrlHelper.createRepositoryUrl(BASE_URL_WITH_CONTEXT, "/" + ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithContextAndTrailingSlashAndPathNameWithNoLeadingSlash() { | ||
| assertEquals(EXPECTED_URL_WITH_CONTEXT, | ||
| RepositoryUrlHelper.createRepositoryUrl(BASE_URL_WITH_CONTEXT + "/", ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUrlWithContextAndNoTrailingSlashAndPathNameWithNoLeadingSlash() { | ||
| assertEquals(EXPECTED_URL_WITH_CONTEXT, | ||
| RepositoryUrlHelper.createRepositoryUrl(BASE_URL_WITH_CONTEXT, ADDITIONAL_PATH)); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add license header