From f7f4f3bee3a3cf563f2cad63f5b8602218c8ca6c Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 19 Dec 2023 02:05:04 +0100 Subject: [PATCH 001/116] feat(impl):[#214] parallel findEndpointDataForConnectors returning fastest non-failing result while ignoring the others --- .../EndpointDataForConnectorsService.java | 73 ++++++++++++++++--- .../EndpointDataForConnectorsServiceTest.java | 64 +++++++++++++--- 2 files changed, 117 insertions(+), 20 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 60b47b9259..92e8980d0e 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -23,7 +23,10 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; +import java.util.ArrayList; +import java.util.Collections; import java.util.List; +import java.util.concurrent.CountDownLatch; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -44,18 +47,68 @@ public class EndpointDataForConnectorsService { private final EdcEndpointReferenceRetriever edcSubmodelFacade; public EndpointDataReference findEndpointDataForConnectors(final List connectorEndpoints) { - for (final String connector : connectorEndpoints) { - log.info("Trying to retrieve EndpointDataReference for connector {}", connector); + return new FindFastestImpl().findEndpointDataForConnectors(connectorEndpoints); + } + + public class FindFastestImpl { + + private final List workers = Collections.synchronizedList(new ArrayList<>()); + private final List outputScraper = Collections.synchronizedList(new ArrayList<>()); + private final CountDownLatch countDownLatch = new CountDownLatch(1); + + public EndpointDataReference findEndpointDataForConnectors(final List connectorEndpoints) { + + this.workers.addAll(connectorEndpoints.stream().map(Worker::new).toList()); + this.workers.stream().map(Thread::new).toList().forEach(Thread::start); + try { - return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE); - } catch (EdcRetrieverException e) { - log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); + countDownLatch.await(); + } catch (InterruptedException e) { // TODO #214 @mfischer better handling?! + throw new RuntimeException(e); } + + return outputScraper.stream() + .findAny() + .orElseThrow(() -> new RestClientException( + "EndpointDataReference was not found. Requested connectorEndpoints: " + + String.join(", ", connectorEndpoints))); } - throw new RestClientException( - "EndpointDataReference was not found. Requested connectorEndpoints: " + String.join(", ", - connectorEndpoints)); - } + public class Worker implements Runnable { + private final String connector; + + public Worker(String connector) { + this.connector = connector; + } + + @Override + public void run() { + + log.info("Trying to retrieve EndpointDataReference for connector {}", connector); + + try { + final var result = edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE); + + workers.remove(this); + outputScraper.add(result); + countDownLatch.countDown(); + + } catch (EdcRetrieverException e) { + + workers.remove(this); + log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, + e); + + if (noWorkersRemaining()) { + countDownLatch.countDown(); + } + } + } + + private boolean noWorkersRemaining() { + return workers.isEmpty(); + } + } + } } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java index 0db64eb6f2..ac673208ab 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java @@ -36,6 +36,7 @@ import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.junit.jupiter.api.Test; +import org.mockito.stubbing.Answer; import org.springframework.web.client.RestClientException; class EndpointDataForConnectorsServiceTest { @@ -45,6 +46,7 @@ class EndpointDataForConnectorsServiceTest { private static final String connectionOneAddress = "connectionOneAddress"; private static final String connectionTwoAddress = "connectionTwoAddress"; + private static final String connectionThreeAddress = "connectionThreeAddress"; private final EdcEndpointReferenceRetriever edcSubmodelFacade = mock(EdcEndpointReferenceRetriever.class); @@ -69,13 +71,16 @@ void shouldReturnExpectedEndpointDataReference() throws EdcRetrieverException { @Test void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() throws EdcRetrieverException { - // given - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenThrow( - new EdcRetrieverException(new EdcClientException("EdcClientException"))); - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenReturn( - EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build()); + + { // given + // a failing answer + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenThrow(edcRetrieverException()); + // and a successful answer + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenReturn( + EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build()); + } // when final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( @@ -86,12 +91,47 @@ void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() thr assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionTwoAddress); } + @Test + void shouldReturnExpectedEndpointDataReferenceFromThirdConnectionEndpoint() throws EdcRetrieverException { + + // TODO #214 @mfischer can we improve this test without sleeping? + + { // given + // a slow answer + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenAnswer((Answer) invocation -> { + Thread.sleep(5000); + return EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build(); + }); + + // and a failing answer + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenThrow(edcRetrieverException()); + + // and the fastest answer + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionThreeAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenAnswer((Answer) invocation -> { + Thread.sleep(50); + return EndpointDataReference.Builder.newInstance().endpoint(connectionThreeAddress).build(); + }); + } + + // when + final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + List.of(connectionOneAddress, connectionTwoAddress, connectionThreeAddress)); + + // then + assertThat(endpointDataReference).isNotNull(); + assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionThreeAddress); + } + @Test void shouldThrowExceptionWhenConnectorEndpointsNotReachable() throws EdcRetrieverException { - // given + + // given # + // all answers failing when(edcSubmodelFacade.getEndpointReferenceForAsset(anyString(), eq(DT_REGISTRY_ASSET_TYPE), - eq(DT_REGISTRY_ASSET_VALUE))).thenThrow( - new EdcRetrieverException(new EdcClientException("EdcClientException"))); + eq(DT_REGISTRY_ASSET_VALUE))).thenThrow(edcRetrieverException()); final List connectorEndpoints = List.of(connectionOneAddress, connectionTwoAddress); // when + then @@ -100,4 +140,8 @@ void shouldThrowExceptionWhenConnectorEndpointsNotReachable() throws EdcRetrieve RestClientException.class).hasMessageContainingAll(connectionOneAddress, connectionTwoAddress); } + private static EdcRetrieverException edcRetrieverException() { + return new EdcRetrieverException(new EdcClientException("EdcClientException")); + } + } From a4bb6d36f19ddc49e3e9eec2ac10005f0654fcc0 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 21 Dec 2023 15:42:40 +0100 Subject: [PATCH 002/116] feat(impl):[#214] add FastestResultFinder to irs-common module --- .../common/util/concurrent/ResultFinder.java | 71 +++++++++++ .../util/concurrent/ResultFinderTest.java | 119 ++++++++++++++++++ .../EndpointDataForConnectorsServiceTest.java | 50 ++------ 3 files changed, 198 insertions(+), 42 deletions(-) create mode 100644 irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java create mode 100644 irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java new file mode 100644 index 0000000000..23dc17d30b --- /dev/null +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -0,0 +1,71 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2023 + * 2022: ZF Friedrichshafen AG + * 2022: ISTOS GmbH + * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2023: BOSCH AG + * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.common.util.concurrent; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +/** + * Helper class to find the relevant result from a list of futures. + */ +public class ResultFinder { + + /** + * Returns a new {@link CompletableFuture} which completes + * when at least one of the given futures completes successfully or all fail. + * The result from the fastest successful future is returned. The others are ignored. + * + * @param futures the futures + * @param the return type + * @return a {@link CompletableFuture} returning the fastest successful result or empty + */ + public CompletableFuture> getFastestResult(final List> futures) { + + if (futures == null || futures.isEmpty()) { + return CompletableFuture.supplyAsync(Optional::empty); + } + + final CompletableFuture> resultPromise = new CompletableFuture<>(); + + final var handledFutures = futures.stream() // + .map(future -> future.handle((value, throwable) -> { + if (!resultPromise.isDone() && throwable == null && value != null) { + resultPromise.complete(Optional.of(value)); + return true; + } else { + return false; + } + })).toList(); + + CompletableFuture.allOf(handledFutures.toArray(new CompletableFuture[0])).thenRun(() -> { + if (!resultPromise.isDone()) { + resultPromise.complete(Optional.empty()); + } + }); + + return resultPromise; + } + +} diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java new file mode 100644 index 0000000000..8500ba6bb9 --- /dev/null +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -0,0 +1,119 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2023 + * 2022: ZF Friedrichshafen AG + * 2022: ISTOS GmbH + * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2023: BOSCH AG + * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ + +package org.eclipse.tractusx.irs.common.util.concurrent; + +import static java.util.concurrent.CompletableFuture.supplyAsync; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.function.Supplier; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.NullAndEmptySource; + +class ResultFinderTest { + + final ResultFinder sut = new ResultFinder(); + + @NullAndEmptySource + @ParameterizedTest + void withNullOrEmptyInputList(final List> list) + throws ExecutionException, InterruptedException { + final var result = sut.getFastestResult(list).get(); + assertThat(result).isEmpty(); + } + + @Test + void withOneSuccessfulCompletableFuture() throws ExecutionException, InterruptedException { + final var futures = List.of(supplyAsync(() -> "ok")); + final var result = sut.getFastestResult(futures).get(); + assertThat(result.orElseThrow()).isEqualTo("ok"); + } + + @Test + void withOnlySuccessfulAndOtherCompletableFuturesFailing() throws ExecutionException, InterruptedException { + + // given + final List> futures = List.of( // + supplyAsync(() -> { + throw new RuntimeException("failing"); + }), // + supplyAsync(() -> "ok"), supplyAsync(() -> { + throw new RuntimeException("failing"); + })); + + // when + final var result = sut.getFastestResult(futures).get(); + + // then + assertThat(result.orElseThrow()).isEqualTo("ok"); + } + + @Test + void shouldReturnFastestSuccessful() throws ExecutionException, InterruptedException { + + // given + final List> futures = List.of( // + futureThrowAfterMillis(200, () -> new RuntimeException("slower failing")), // + futureReturnAfterMillis(1000, () -> "slowest success"), // + futureReturnAfterMillis(300, () -> "fastest success"), // + futureThrowAfterMillis(0, () -> new RuntimeException("failing immediately")) // + ); + + // when + final var result = sut.getFastestResult(futures).get(); + + // then + assertThat(result.orElseThrow()).isEqualTo("fastest success"); + } + + private static CompletableFuture futureThrowAfterMillis(final int sleepMillis, + final Supplier exceptionSupplier) { + return supplyAsync(() -> { + sleep(sleepMillis); + throw exceptionSupplier.get(); + }); + } + + private static CompletableFuture futureReturnAfterMillis(final int sleepMillis, + final Supplier resultSupplier) { + return supplyAsync(() -> { + sleep(sleepMillis); + return resultSupplier.get(); + }); + } + + private static void sleep(final int millis) { + try { + Thread.sleep(millis); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + +} \ No newline at end of file diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java index ac673208ab..10f763487e 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java @@ -36,7 +36,6 @@ import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.junit.jupiter.api.Test; -import org.mockito.stubbing.Answer; import org.springframework.web.client.RestClientException; class EndpointDataForConnectorsServiceTest { @@ -46,7 +45,6 @@ class EndpointDataForConnectorsServiceTest { private static final String connectionOneAddress = "connectionOneAddress"; private static final String connectionTwoAddress = "connectionTwoAddress"; - private static final String connectionThreeAddress = "connectionThreeAddress"; private final EdcEndpointReferenceRetriever edcSubmodelFacade = mock(EdcEndpointReferenceRetriever.class); @@ -61,12 +59,13 @@ void shouldReturnExpectedEndpointDataReference() throws EdcRetrieverException { EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build()); // when - final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + final List endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( Collections.singletonList(connectionOneAddress)); // then - assertThat(endpointDataReference).isNotNull(); - assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionOneAddress); + assertThat(endpointDataReference).hasSize(1); + assertThat(endpointDataReference.get(0)).isNotNull(); + assertThat(endpointDataReference.get(0).getEndpoint()).isEqualTo(connectionOneAddress); } @Test @@ -83,46 +82,13 @@ void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() thr } // when - final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + final List endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( List.of(connectionOneAddress, connectionTwoAddress)); // then - assertThat(endpointDataReference).isNotNull(); - assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionTwoAddress); - } - - @Test - void shouldReturnExpectedEndpointDataReferenceFromThirdConnectionEndpoint() throws EdcRetrieverException { - - // TODO #214 @mfischer can we improve this test without sleeping? - - { // given - // a slow answer - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenAnswer((Answer) invocation -> { - Thread.sleep(5000); - return EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build(); - }); - - // and a failing answer - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenThrow(edcRetrieverException()); - - // and the fastest answer - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionThreeAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenAnswer((Answer) invocation -> { - Thread.sleep(50); - return EndpointDataReference.Builder.newInstance().endpoint(connectionThreeAddress).build(); - }); - } - - // when - final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( - List.of(connectionOneAddress, connectionTwoAddress, connectionThreeAddress)); - - // then - assertThat(endpointDataReference).isNotNull(); - assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionThreeAddress); + assertThat(endpointDataReference).hasSize(1); + assertThat(endpointDataReference.get(0)).isNotNull(); + assertThat(endpointDataReference.get(0).getEndpoint()).isEqualTo(connectionTwoAddress); } @Test From 901c7db74baa70ef4e3e5723118c655d6da82bb7 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 21 Dec 2023 18:46:57 +0100 Subject: [PATCH 003/116] feat(impl):[#214] add logging of warnings to ResultFinder --- .../tractusx/irs/common/util/concurrent/ResultFinder.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 23dc17d30b..fde4dca384 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -27,9 +27,12 @@ import java.util.Optional; import java.util.concurrent.CompletableFuture; +import lombok.extern.slf4j.Slf4j; + /** * Helper class to find the relevant result from a list of futures. */ +@Slf4j public class ResultFinder { /** @@ -55,6 +58,9 @@ public CompletableFuture> getFastestResult(final List Date: Thu, 21 Dec 2023 18:49:06 +0100 Subject: [PATCH 004/116] feat(impl):[#214] add irs-common dependencies to irs-edc-client and irs-registry-client --- irs-edc-client/pom.xml | 5 +++++ irs-registry-client/pom.xml | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/irs-edc-client/pom.xml b/irs-edc-client/pom.xml index 10d3049c1e..a767cde24d 100644 --- a/irs-edc-client/pom.xml +++ b/irs-edc-client/pom.xml @@ -168,6 +168,11 @@ org.eclipse.edc ${edc.version} + + org.eclipse.tractusx.irs + irs-common + ${revision} + org.eclipse.tractusx.irs diff --git a/irs-registry-client/pom.xml b/irs-registry-client/pom.xml index 9621ea237e..719c474c78 100644 --- a/irs-registry-client/pom.xml +++ b/irs-registry-client/pom.xml @@ -59,6 +59,11 @@ snakeyaml ${snakeyaml.version} + + org.eclipse.tractusx.irs + irs-common + ${revision} + org.eclipse.tractusx.irs irs-testing From 66987e3fe52f4988c15aa8c91f8c2108bffe98bd Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 22 Dec 2023 12:57:07 +0100 Subject: [PATCH 005/116] feat(impl):[#214] improve ResultFinder code --- .../common/util/concurrent/ResultFinder.java | 36 ++++++++++++------- .../util/concurrent/ResultFinderTest.java | 3 ++ 2 files changed, 26 insertions(+), 13 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index fde4dca384..d88c7b53db 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -23,6 +23,8 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.common.util.concurrent; +import static java.util.concurrent.CompletableFuture.allOf; + import java.util.List; import java.util.Optional; import java.util.concurrent.CompletableFuture; @@ -52,20 +54,28 @@ public CompletableFuture> getFastestResult(final List> resultPromise = new CompletableFuture<>(); - final var handledFutures = futures.stream() // - .map(future -> future.handle((value, throwable) -> { - if (!resultPromise.isDone() && throwable == null && value != null) { - resultPromise.complete(Optional.of(value)); - return true; - } else { - if (throwable != null) { - log.warn(throwable.getMessage(), throwable); - } - return false; - } - })).toList(); + final var handledFutures = // + futures.stream() // + .map(future -> future.handle((value, throwable) -> { + + final boolean notFinishedByOtherFuture = !resultPromise.isDone(); + final boolean currentFutureSuccessful = throwable == null && value != null; + + if (notFinishedByOtherFuture && currentFutureSuccessful) { + + // first future that completes successfully completes the overall future + resultPromise.complete(Optional.of(value)); + return true; + + } else { + if (throwable != null) { + log.warn(throwable.getMessage(), throwable); + } + return false; + } + })).toList(); - CompletableFuture.allOf(handledFutures.toArray(new CompletableFuture[0])).thenRun(() -> { + allOf(handledFutures.toArray(new CompletableFuture[0])).thenRun(() -> { if (!resultPromise.isDone()) { resultPromise.complete(Optional.empty()); } diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index 8500ba6bb9..2cf76500d9 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -36,6 +36,9 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.NullAndEmptySource; +/** + * Test for {@link ResultFinder} + */ class ResultFinderTest { final ResultFinder sut = new ResultFinder(); From 8f56c4d6081e679ad68bc5919262381e31b33f6d Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 22 Dec 2023 14:22:22 +0100 Subject: [PATCH 006/116] feat(impl):[#214] remove Optional from return type reason: returning Optional requires too many changes in existing code when ResultFinder is used later --- .../common/util/concurrent/ResultFinder.java | 15 ++++++------ .../util/concurrent/ResultFinderTest.java | 24 +++++++++---------- 2 files changed, 19 insertions(+), 20 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index d88c7b53db..40cbee83ec 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -23,13 +23,12 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.common.util.concurrent; -import static java.util.concurrent.CompletableFuture.allOf; +import lombok.extern.slf4j.Slf4j; import java.util.List; -import java.util.Optional; import java.util.concurrent.CompletableFuture; -import lombok.extern.slf4j.Slf4j; +import static java.util.concurrent.CompletableFuture.allOf; /** * Helper class to find the relevant result from a list of futures. @@ -46,13 +45,13 @@ public class ResultFinder { * @param the return type * @return a {@link CompletableFuture} returning the fastest successful result or empty */ - public CompletableFuture> getFastestResult(final List> futures) { + public CompletableFuture getFastestResult(final List> futures) { if (futures == null || futures.isEmpty()) { - return CompletableFuture.supplyAsync(Optional::empty); + return CompletableFuture.supplyAsync(() -> null); } - final CompletableFuture> resultPromise = new CompletableFuture<>(); + final CompletableFuture resultPromise = new CompletableFuture<>(); final var handledFutures = // futures.stream() // @@ -64,7 +63,7 @@ public CompletableFuture> getFastestResult(final List CompletableFuture> getFastestResult(final List { if (!resultPromise.isDone()) { - resultPromise.complete(Optional.empty()); + resultPromise.complete(null); } }); diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index 2cf76500d9..25673665e0 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -24,17 +24,17 @@ package org.eclipse.tractusx.irs.common.util.concurrent; -import static java.util.concurrent.CompletableFuture.supplyAsync; -import static org.assertj.core.api.AssertionsForClassTypes.assertThat; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.NullAndEmptySource; import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.function.Supplier; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.NullAndEmptySource; +import static java.util.concurrent.CompletableFuture.supplyAsync; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; /** * Test for {@link ResultFinder} @@ -48,14 +48,14 @@ class ResultFinderTest { void withNullOrEmptyInputList(final List> list) throws ExecutionException, InterruptedException { final var result = sut.getFastestResult(list).get(); - assertThat(result).isEmpty(); + assertThat(result).isNull(); } @Test void withOneSuccessfulCompletableFuture() throws ExecutionException, InterruptedException { final var futures = List.of(supplyAsync(() -> "ok")); - final var result = sut.getFastestResult(futures).get(); - assertThat(result.orElseThrow()).isEqualTo("ok"); + final String result = sut.getFastestResult(futures).get(); + assertThat(result).isEqualTo("ok"); } @Test @@ -71,10 +71,10 @@ void withOnlySuccessfulAndOtherCompletableFuturesFailing() throws ExecutionExcep })); // when - final var result = sut.getFastestResult(futures).get(); + final String result = sut.getFastestResult(futures).get(); // then - assertThat(result.orElseThrow()).isEqualTo("ok"); + assertThat(result).isEqualTo("ok"); } @Test @@ -89,10 +89,10 @@ void shouldReturnFastestSuccessful() throws ExecutionException, InterruptedExcep ); // when - final var result = sut.getFastestResult(futures).get(); + final String result = sut.getFastestResult(futures).get(); // then - assertThat(result.orElseThrow()).isEqualTo("fastest success"); + assertThat(result).isEqualTo("fastest success"); } private static CompletableFuture futureThrowAfterMillis(final int sleepMillis, From 26daa2a80d390d632deb246c0e749da953c66772 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 22 Dec 2023 15:51:24 +0100 Subject: [PATCH 007/116] feat(impl):[#214] group tests by method name via @Nested --- .../irs/edc/client/EdcSubmodelFacadeTest.java | 265 ++++++++++-------- 1 file changed, 142 insertions(+), 123 deletions(-) diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java index 1be05c5c6b..cd5b38b84c 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java @@ -37,6 +37,8 @@ import org.eclipse.tractusx.irs.edc.client.edcsubmodelclient.EdcSubmodelClient; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.InjectMocks; @@ -56,134 +58,151 @@ class EdcSubmodelFacadeTest { @Mock private EdcSubmodelClient client; + @Nested + @DisplayName("getSubmodelRawPayload") + class GetSubmodelRawPayloadTests { + + @Test + void shouldThrowExecutionExceptionForSubmodel() throws EdcClientException { + // arrange + final ExecutionException e = new ExecutionException(new EdcClientException("test")); + final CompletableFuture future = CompletableFuture.failedFuture(e); + when(client.getSubmodelRawPayload(any(), any(), any())).thenReturn(future); + + // act + ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, + SUBMODEL_SUFIX, ASSET_ID); + + // assert + assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + } + + @Test + void shouldThrowEdcClientExceptionForSubmodel() throws EdcClientException { + // arrange + final EdcClientException e = new EdcClientException("test"); + when(client.getSubmodelRawPayload(any(), any(), any())).thenThrow(e); + + // act + ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, + SUBMODEL_SUFIX, ASSET_ID); + + // assert + assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + } + + @Test + void shouldRestoreInterruptOnInterruptExceptionForSubmodel() + throws EdcClientException, ExecutionException, InterruptedException { + // arrange + final CompletableFuture future = mock(CompletableFuture.class); + final InterruptedException e = new InterruptedException(); + when(future.get()).thenThrow(e); + when(client.getSubmodelRawPayload(any(), any(), any())).thenReturn(future); + + // act + testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); + + // assert + assertThat(Thread.currentThread().isInterrupted()).isTrue(); + } - @Test - void shouldThrowExecutionExceptionForSubmodel() throws EdcClientException { - // arrange - final ExecutionException e = new ExecutionException(new EdcClientException("test")); - final CompletableFuture future = CompletableFuture.failedFuture(e); - when(client.getSubmodelRawPayload(any(), any(), any())).thenReturn(future); - - // act - ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); - - // assert - assertThatThrownBy(action).isInstanceOf(EdcClientException.class); - } - - @Test - void shouldThrowEdcClientExceptionForSubmodel() throws EdcClientException { - // arrange - final EdcClientException e = new EdcClientException("test"); - when(client.getSubmodelRawPayload(any(), any(), any())).thenThrow(e); - - // act - ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); - - // assert - assertThatThrownBy(action).isInstanceOf(EdcClientException.class); - } - - @Test - void shouldRestoreInterruptOnInterruptExceptionForSubmodel() - throws EdcClientException, ExecutionException, InterruptedException { - // arrange - final CompletableFuture future = mock(CompletableFuture.class); - final InterruptedException e = new InterruptedException(); - when(future.get()).thenThrow(e); - when(client.getSubmodelRawPayload(any(), any(), any())).thenReturn(future); - - // act - testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); - - // assert - assertThat(Thread.currentThread().isInterrupted()).isTrue(); - } - - @Test - void shouldRestoreInterruptOnInterruptExceptionForNotification() - throws EdcClientException, ExecutionException, InterruptedException { - // arrange - final CompletableFuture future = mock(CompletableFuture.class); - final InterruptedException e = new InterruptedException(); - when(future.get()).thenThrow(e); - when(client.sendNotification(any(), any(), any())).thenReturn(future); - - // act - testee.sendNotification("", "notify-request-asset", null); - - // assert - assertThat(Thread.currentThread().isInterrupted()).isTrue(); - } - - @Test - void shouldThrowExecutionExceptionForNotification() throws EdcClientException { - // arrange - final ExecutionException e = new ExecutionException(new EdcClientException("test")); - final CompletableFuture future = CompletableFuture.failedFuture(e); - when(client.sendNotification(any(), any(), any())).thenReturn(future); - - // act - ThrowableAssert.ThrowingCallable action = () -> testee.sendNotification("", "notify-request-asset", null); - - // assert - assertThatThrownBy(action).isInstanceOf(EdcClientException.class); } - @Test - void shouldThrowEdcClientExceptionForNotification() throws EdcClientException { - // arrange - final EdcClientException e = new EdcClientException("test"); - when(client.sendNotification(any(), any(), any())).thenThrow(e); - - // act - ThrowableAssert.ThrowingCallable action = () -> testee.sendNotification("", "notify-request-asset", null); - - // assert - assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + @Nested + @DisplayName("sendNotification") + class SendNotificationTests { + + @Test + void shouldRestoreInterruptOnInterruptExceptionForNotification() + throws EdcClientException, ExecutionException, InterruptedException { + // arrange + final CompletableFuture future = mock(CompletableFuture.class); + final InterruptedException e = new InterruptedException(); + when(future.get()).thenThrow(e); + when(client.sendNotification(any(), any(), any())).thenReturn(future); + + // act + testee.sendNotification("", "notify-request-asset", null); + + // assert + assertThat(Thread.currentThread().isInterrupted()).isTrue(); + } + + @Test + void shouldThrowExecutionExceptionForNotification() throws EdcClientException { + // arrange + final ExecutionException e = new ExecutionException(new EdcClientException("test")); + final CompletableFuture future = CompletableFuture.failedFuture(e); + when(client.sendNotification(any(), any(), any())).thenReturn(future); + + // act + ThrowableAssert.ThrowingCallable action = () -> testee.sendNotification("", "notify-request-asset", null); + + // assert + assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + } + + @Test + void shouldThrowEdcClientExceptionForNotification() throws EdcClientException { + // arrange + final EdcClientException e = new EdcClientException("test"); + when(client.sendNotification(any(), any(), any())).thenThrow(e); + + // act + ThrowableAssert.ThrowingCallable action = () -> testee.sendNotification("", "notify-request-asset", null); + + // assert + assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + } } - @Test - void shouldThrowEdcClientExceptionForEndpointReference() throws EdcClientException { - // arrange - final EdcClientException e = new EdcClientException("test"); - when(client.getEndpointReferenceForAsset(any(), any(), any())).thenThrow(e); - - // act - ThrowableAssert.ThrowingCallable action = () -> testee.getEndpointReferenceForAsset("", "", ""); - - // assert - assertThatThrownBy(action).isInstanceOf(EdcClientException.class); - } - - @Test - void shouldThrowExecutionExceptionForEndpointReference() throws EdcClientException { - // arrange - final ExecutionException e = new ExecutionException(new EdcClientException("test")); - final CompletableFuture future = CompletableFuture.failedFuture(e); - when(client.getEndpointReferenceForAsset(any(), any(), any())).thenReturn(future); - - // act - ThrowableAssert.ThrowingCallable action = () -> testee.getEndpointReferenceForAsset("", "", ""); - - // assert - assertThatThrownBy(action).isInstanceOf(EdcClientException.class); - } - - @Test - void shouldRestoreInterruptOnInterruptExceptionForEndpointReference() - throws EdcClientException, ExecutionException, InterruptedException { - // arrange - final CompletableFuture future = mock(CompletableFuture.class); - final InterruptedException e = new InterruptedException(); - when(future.get()).thenThrow(e); - when(client.getEndpointReferenceForAsset(any(), any(), any())).thenReturn(future); - - // act - testee.getEndpointReferenceForAsset("", "", ""); - - // assert - assertThat(Thread.currentThread().isInterrupted()).isTrue(); + @Nested + @DisplayName("getEndpointReferenceForAsset") + class GetEndpointReferenceForAssetTests { + + @Test + void shouldThrowEdcClientExceptionForEndpointReference() throws EdcClientException { + // arrange + final EdcClientException e = new EdcClientException("test"); + when(client.getEndpointReferenceForAsset(any(), any(), any())).thenThrow(e); + + // act + ThrowableAssert.ThrowingCallable action = () -> testee.getEndpointReferenceForAsset("", "", ""); + + // assert + assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + } + + @Test + void shouldThrowExecutionExceptionForEndpointReference() throws EdcClientException { + // arrange + final ExecutionException e = new ExecutionException(new EdcClientException("test")); + final CompletableFuture future = CompletableFuture.failedFuture(e); + when(client.getEndpointReferenceForAsset(any(), any(), any())).thenReturn(future); + + // act + ThrowableAssert.ThrowingCallable action = () -> testee.getEndpointReferenceForAsset("", "", ""); + + // assert + assertThatThrownBy(action).isInstanceOf(EdcClientException.class); + } + + @Test + void shouldRestoreInterruptOnInterruptExceptionForEndpointReference() + throws EdcClientException, ExecutionException, InterruptedException { + // arrange + final CompletableFuture future = mock(CompletableFuture.class); + final InterruptedException e = new InterruptedException(); + when(future.get()).thenThrow(e); + when(client.getEndpointReferenceForAsset(any(), any(), any())).thenReturn(future); + + // act + testee.getEndpointReferenceForAsset("", "", ""); + + // assert + assertThat(Thread.currentThread().isInterrupted()).isTrue(); + } } } \ No newline at end of file From a614f98a07d764e685ccd6a4387edb55b5ebb034 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 22 Dec 2023 20:14:23 +0100 Subject: [PATCH 008/116] feat(impl):[#214] undo f7f4f3bee3a3cf563f2cad63f5b8602218c8ca6c --- .../EndpointDataForConnectorsService.java | 73 +++---------------- .../EndpointDataForConnectorsServiceTest.java | 45 +++++------- 2 files changed, 27 insertions(+), 91 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 92e8980d0e..60b47b9259 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -23,10 +23,7 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; -import java.util.ArrayList; -import java.util.Collections; import java.util.List; -import java.util.concurrent.CountDownLatch; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -47,68 +44,18 @@ public class EndpointDataForConnectorsService { private final EdcEndpointReferenceRetriever edcSubmodelFacade; public EndpointDataReference findEndpointDataForConnectors(final List connectorEndpoints) { - return new FindFastestImpl().findEndpointDataForConnectors(connectorEndpoints); - } - - public class FindFastestImpl { - - private final List workers = Collections.synchronizedList(new ArrayList<>()); - private final List outputScraper = Collections.synchronizedList(new ArrayList<>()); - private final CountDownLatch countDownLatch = new CountDownLatch(1); - - public EndpointDataReference findEndpointDataForConnectors(final List connectorEndpoints) { - - this.workers.addAll(connectorEndpoints.stream().map(Worker::new).toList()); - this.workers.stream().map(Thread::new).toList().forEach(Thread::start); - + for (final String connector : connectorEndpoints) { + log.info("Trying to retrieve EndpointDataReference for connector {}", connector); try { - countDownLatch.await(); - } catch (InterruptedException e) { // TODO #214 @mfischer better handling?! - throw new RuntimeException(e); - } - - return outputScraper.stream() - .findAny() - .orElseThrow(() -> new RestClientException( - "EndpointDataReference was not found. Requested connectorEndpoints: " - + String.join(", ", connectorEndpoints))); - } - - public class Worker implements Runnable { - private final String connector; - - public Worker(String connector) { - this.connector = connector; - } - - @Override - public void run() { - - log.info("Trying to retrieve EndpointDataReference for connector {}", connector); - - try { - final var result = edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE); - - workers.remove(this); - outputScraper.add(result); - countDownLatch.countDown(); - - } catch (EdcRetrieverException e) { - - workers.remove(this); - log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, - e); - - if (noWorkersRemaining()) { - countDownLatch.countDown(); - } - } - } - - private boolean noWorkersRemaining() { - return workers.isEmpty(); + return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE); + } catch (EdcRetrieverException e) { + log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); } } + throw new RestClientException( + "EndpointDataReference was not found. Requested connectorEndpoints: " + String.join(", ", + connectorEndpoints)); } + } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java index 10f763487e..589d28508e 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java @@ -11,8 +11,7 @@ * * This program and the accompanying materials are made available under the * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * + * https://www.apache.org/licenses/LICENSE-2.0. * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the @@ -59,45 +58,39 @@ void shouldReturnExpectedEndpointDataReference() throws EdcRetrieverException { EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build()); // when - final List endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( Collections.singletonList(connectionOneAddress)); // then - assertThat(endpointDataReference).hasSize(1); - assertThat(endpointDataReference.get(0)).isNotNull(); - assertThat(endpointDataReference.get(0).getEndpoint()).isEqualTo(connectionOneAddress); + assertThat(endpointDataReference).isNotNull(); + assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionOneAddress); } @Test void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() throws EdcRetrieverException { - - { // given - // a failing answer - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenThrow(edcRetrieverException()); - // and a successful answer - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenReturn( - EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build()); - } + // given + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenThrow( + new EdcRetrieverException(new EdcClientException("EdcClientException"))); + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenReturn( + EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build()); // when - final List endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( List.of(connectionOneAddress, connectionTwoAddress)); // then - assertThat(endpointDataReference).hasSize(1); - assertThat(endpointDataReference.get(0)).isNotNull(); - assertThat(endpointDataReference.get(0).getEndpoint()).isEqualTo(connectionTwoAddress); + assertThat(endpointDataReference).isNotNull(); + assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionTwoAddress); } @Test void shouldThrowExceptionWhenConnectorEndpointsNotReachable() throws EdcRetrieverException { - - // given # - // all answers failing + // given when(edcSubmodelFacade.getEndpointReferenceForAsset(anyString(), eq(DT_REGISTRY_ASSET_TYPE), - eq(DT_REGISTRY_ASSET_VALUE))).thenThrow(edcRetrieverException()); + eq(DT_REGISTRY_ASSET_VALUE))).thenThrow( + new EdcRetrieverException(new EdcClientException("EdcClientException"))); final List connectorEndpoints = List.of(connectionOneAddress, connectionTwoAddress); // when + then @@ -106,8 +99,4 @@ void shouldThrowExceptionWhenConnectorEndpointsNotReachable() throws EdcRetrieve RestClientException.class).hasMessageContainingAll(connectionOneAddress, connectionTwoAddress); } - private static EdcRetrieverException edcRetrieverException() { - return new EdcRetrieverException(new EdcClientException("EdcClientException")); - } - } From f3600437bf3318d38e74ef770c1074c2d232bb9c Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 9 Jan 2024 23:30:15 +0100 Subject: [PATCH 009/116] feat(impl):[#214] Handle multiple EDC URLs in DecentralDigitalTwinRegistryService - EndpointDataForConnectorsService returns multiple EndpointDataReferences now - These are handled in DecentralDigitalTwinRegistryService.fetchShellDescriptors and by selecting the results of the fastest --- .../DecentralDigitalTwinRegistryService.java | 108 +++-- .../EndpointDataForConnectorsService.java | 38 +- .../RegistryServiceRuntimeException.java | 30 ++ .../DefaultConfigurationTest.java | 15 +- ...centralDigitalTwinRegistryServiceTest.java | 393 ++++++++++++------ .../EndpointDataForConnectorsServiceTest.java | 17 +- .../RegistryServiceRuntimeExceptionTest.java | 36 ++ 7 files changed, 452 insertions(+), 185 deletions(-) create mode 100644 irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java create mode 100644 irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index ec88b11da0..5134d62184 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -23,26 +23,30 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; -import java.time.Instant; -import java.util.ArrayList; +import static java.util.concurrent.CompletableFuture.supplyAsync; + import java.util.Collection; +import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; import java.util.stream.Collectors; import java.util.stream.Stream; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; -import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryService; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; +import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceRuntimeException; import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; import org.jetbrains.annotations.NotNull; @@ -57,6 +61,17 @@ public class DecentralDigitalTwinRegistryService implements DigitalTwinRegistryS private final EndpointDataForConnectorsService endpointDataForConnectorsService; private final DecentralDigitalTwinRegistryClient decentralDigitalTwinRegistryClient; + private ResultFinder resultFinder = new ResultFinder(); + + /** + * Package private setter in order to allow simulating {@link InterruptedException} and {@link ExecutionException} in tests. + * + * @param resultFinder the {@link ResultFinder} + */ + void setResultFinder(final ResultFinder resultFinder) { + this.resultFinder = resultFinder; + } + private static Stream>> groupKeysByBpn( final Collection keys) { return keys.stream().collect(Collectors.groupingBy(DigitalTwinRegistryKey::bpn)).entrySet().stream(); @@ -65,10 +80,13 @@ private static Stream>> groupKeys @Override public Collection fetchShells(final Collection keys) throws RegistryServiceException { + log.info("Fetching shell(s) for {} key(s)", keys.size()); + final var calledEndpoints = new HashSet(); final var collectedShells = groupKeysByBpn(keys).flatMap( - entry -> fetchShellDescriptors(calledEndpoints, entry.getKey(), entry.getValue())).toList(); + entry -> fetchShellDescriptors(calledEndpoints, entry.getKey(), entry.getValue()).stream()).toList(); + if (collectedShells.isEmpty()) { throw new ShellNotFoundException("Unable to find any of the requested shells", calledEndpoints); } else { @@ -78,40 +96,40 @@ public Collection fetchShells(final Collecti } @NotNull - private Stream fetchShellDescriptors(final Set calledEndpoints, + private List fetchShellDescriptors(final Set calledEndpoints, final String bpn, final List keys) { + log.info("Fetching {} shells for bpn {}", keys.size(), bpn); + final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); calledEndpoints.addAll(connectorEndpoints); - final List descriptors = new ArrayList<>(); - - EndpointDataReference endpointDataReference = null; - - for (final DigitalTwinRegistryKey key : keys) { - endpointDataReference = renewIfNecessary(endpointDataReference, connectorEndpoints); - descriptors.add(fetchShellDescriptor(endpointDataReference, key)); + try { + final var endpointDataReferences = getEndpointDataReferences(connectorEndpoints); + final var futures = endpointDataReferences.stream() + .map(edr -> supplyAsynchShellDescriptorForKeys(keys, edr)) + .toList(); + + return resultFinder.getFastestResult(futures).get(); + + } catch (InterruptedException e) { + log.debug("InterruptedException occurred while fetching shells for bpn '%s'".formatted(bpn), e); + Thread.currentThread().interrupt(); + return Collections.emptyList(); + } catch (ExecutionException e) { + throw new RegistryServiceRuntimeException( + "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); } - - return descriptors.stream(); } - private EndpointDataReference renewIfNecessary(final EndpointDataReference endpointDataReference, - final List connectorEndpoints) { - if (endpointDataReference == null || endpointDataReference.getAuthCode() == null) { - return getEndpointDataReference(connectorEndpoints); - } else { - final var tokenExpirationInstant = extractTokenExpiration(endpointDataReference.getAuthCode()); - if (Instant.now().isAfter(tokenExpirationInstant)) { - log.info("EndpointDataReference token has expired, getting a new one."); - return getEndpointDataReference(connectorEndpoints); - } - return endpointDataReference; - } + private CompletableFuture> supplyAsynchShellDescriptorForKeys( + final List keys, final EndpointDataReference endpointDataReference) { + return supplyAsync(() -> fetchShellDescriptorsForKey(keys, endpointDataReference)); } - private Instant extractTokenExpiration(final String token) { - return Instant.ofEpochSecond(EDRAuthCode.fromAuthCodeToken(token).getExp()); + private List fetchShellDescriptorsForKey( + final List keys, final EndpointDataReference endpointDataReference) { + return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); } private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDataReference endpointDataReference, @@ -147,20 +165,42 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f } @NotNull - private EndpointDataReference getEndpointDataReference(final List connectorEndpoints) { + private List getEndpointDataReferences(final List connectorEndpoints) { return endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints); } private Collection lookupShellIds(final String bpn) { log.info("Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - final var endpointDataReference = getEndpointDataReference(connectorEndpoints); + final var endpointDataReferences = getEndpointDataReferences(connectorEndpoints); + + try { + final var futures = endpointDataReferences.stream() + .map(edr -> supplyAsyncLookupShellIds(bpn, edr)) + .toList(); + final var shellIds = resultFinder.getFastestResult(futures).get(); + + log.info("Found {} shell id(s) in total", shellIds.size()); + return shellIds; + + } catch (InterruptedException e) { + log.debug("InterruptedException occurred while looking up shells ids for bpn '%s'".formatted(bpn), e); + Thread.currentThread().interrupt(); + return Collections.emptyList(); + } catch (ExecutionException e) { + throw new RegistryServiceRuntimeException( + "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + } + } + + private CompletableFuture> supplyAsyncLookupShellIds(final String bpn, + final EndpointDataReference endpointDataReference) { + return supplyAsync(() -> lookupShellIds(bpn, endpointDataReference)); + } - final var shellIds = decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( - endpointDataReference, + private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { + return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(endpointDataReference, List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); - log.info("Found {} shell id(s) in total", shellIds.size()); - return shellIds; } @Override diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 60b47b9259..27068a8ffb 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -24,6 +24,7 @@ package org.eclipse.tractusx.irs.registryclient.decentral; import java.util.List; +import java.util.Optional; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -43,19 +44,32 @@ public class EndpointDataForConnectorsService { private final EdcEndpointReferenceRetriever edcSubmodelFacade; - public EndpointDataReference findEndpointDataForConnectors(final List connectorEndpoints) { - for (final String connector : connectorEndpoints) { - log.info("Trying to retrieve EndpointDataReference for connector {}", connector); - try { - return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE); - } catch (EdcRetrieverException e) { - log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); - } + public List findEndpointDataForConnectors(final List connectorEndpoints) { + + final List endpointDataReferences = // + connectorEndpoints.stream().parallel() // + .map(this::getEndpointReferenceForAsset) // + .filter(Optional::isPresent) // + .map(Optional::get) // + .map(EndpointDataReference.class::cast).toList(); + + if (endpointDataReferences.isEmpty()) { + throw new RestClientException("EndpointDataReference was not found. Requested connectorEndpoints: " // + + String.join(", ", connectorEndpoints)); + } else { + return endpointDataReferences; + } + } + + private Optional getEndpointReferenceForAsset(final String connector) { + log.info("Trying to retrieve EndpointDataReference for connector {}", connector); + try { + return Optional.ofNullable(edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)); + } catch (EdcRetrieverException e) { + log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); + return Optional.empty(); } - throw new RestClientException( - "EndpointDataReference was not found. Requested connectorEndpoints: " + String.join(", ", - connectorEndpoints)); } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java new file mode 100644 index 0000000000..0a72286295 --- /dev/null +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java @@ -0,0 +1,30 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.registryclient.exceptions; + +/** + * Base runtime exception for the registry client + */ +public class RegistryServiceRuntimeException extends RuntimeException { + + public RegistryServiceRuntimeException(final String msg, final Throwable cause) { + super(msg, cause); + } + +} diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java index d710e6b602..81be9760be 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java @@ -26,14 +26,16 @@ 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.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.util.List; -import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelClient; +import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.junit.jupiter.api.Test; import org.springframework.web.client.RestClientException; @@ -74,12 +76,19 @@ void edcSubmodelFacade() { @Test void endpointDataForConnectorsService() throws EdcClientException { + + // ARRANGE final var mock = mock(EdcSubmodelFacade.class); + final var endpointAddress = "endpointaddress"; + final var endpointDataReference = EndpointDataReference.Builder.newInstance().endpoint(endpointAddress).build(); + when(mock.getEndpointReferenceForAsset(eq(endpointAddress), any(), any())).thenReturn(endpointDataReference); + // ACT final var endpointDataForConnectorsService = testee.endpointDataForConnectorsService(mock); - endpointDataForConnectorsService.findEndpointDataForConnectors(List.of("test")); + endpointDataForConnectorsService.findEndpointDataForConnectors(List.of(endpointAddress)); - verify(mock).getEndpointReferenceForAsset(any(), any(), any()); + // ASSERT + verify(mock).getEndpointReferenceForAsset(eq(endpointAddress), any(), any()); } @Test diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index aba4a21f00..9c2745c677 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -23,8 +23,12 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; +import static java.util.Collections.emptyList; +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.anyList; +import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -33,13 +37,14 @@ import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Base64; -import java.util.Collection; -import java.util.Collections; import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; import java.util.function.Function; -import org.assertj.core.api.Assertions; +import org.assertj.core.api.ThrowableAssert.ThrowingCallable; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.component.assetadministrationshell.SubmodelDescriptor; @@ -48,20 +53,23 @@ import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; +import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceRuntimeException; +import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; -import org.mockito.ArgumentMatchers; -import org.mockito.Mockito; class DecentralDigitalTwinRegistryServiceTest { - private final ConnectorEndpointsService connectorEndpointsService = Mockito.mock(ConnectorEndpointsService.class); - private final EndpointDataForConnectorsService endpointDataForConnectorsService = Mockito.mock( + private final ConnectorEndpointsService connectorEndpointsService = mock(ConnectorEndpointsService.class); + private final EndpointDataForConnectorsService endpointDataForConnectorsService = mock( EndpointDataForConnectorsService.class); - private final DecentralDigitalTwinRegistryClient decentralDigitalTwinRegistryClient = Mockito.mock( + private final DecentralDigitalTwinRegistryClient decentralDigitalTwinRegistryClient = mock( DecentralDigitalTwinRegistryClient.class); - private final DecentralDigitalTwinRegistryService decentralDigitalTwinRegistryService = new DecentralDigitalTwinRegistryService( + private final DecentralDigitalTwinRegistryService sut = new DecentralDigitalTwinRegistryService( connectorEndpointsService, endpointDataForConnectorsService, decentralDigitalTwinRegistryClient); private static String createAuthCode(final Function expirationModifier) { @@ -82,132 +90,259 @@ public static AssetAdministrationShellDescriptor shellDescriptor( .build(); } - @Test - void shouldReturnExpectedShell() throws RegistryServiceException { - // given - final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( - "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final AssetAdministrationShellDescriptor expectedShell = shellDescriptor(Collections.emptyList()); - EndpointDataReference endpointDataReference = EndpointDataReference.Builder.newInstance() - .endpoint("url.to.host") - .build(); - final LookupShellsResponse lookupShellsResponse = LookupShellsResponse.builder() - .result(Collections.emptyList()) - .build(); - when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(ArgumentMatchers.anyList())).thenReturn( - endpointDataReference); - when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), - ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); - when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); - - // when - final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( - List.of(digitalTwinRegistryKey)); - - // then - Assertions.assertThat(actualShell).containsExactly(expectedShell); + @Nested + @DisplayName("fetchShells") + class FetchShellsTests { + + @Test + void shouldReturnExpectedShell() throws RegistryServiceException { + // given + final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( + "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); + final var expectedShell = shellDescriptor(emptyList()); + final var endpointDataReference = endpointDataReference("url.to.host"); + final var lookupShellsResponse = LookupShellsResponse.builder().result(emptyList()).build(); + + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( + List.of(endpointDataReference)); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), + anyList())).thenReturn(lookupShellsResponse); + when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( + expectedShell); + + // when + final var actualShell = sut.fetchShells(List.of(digitalTwinRegistryKey)); + + // then + assertThat(actualShell).containsExactly(expectedShell); + } + + @Test + void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedException { + + // given + simulateResultFinderInterrupted(); + + final var lookupShellsResponse = LookupShellsResponse.builder().result(emptyList()).build(); + + final List connectorEndpoints = List.of("address1", "address2"); + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(connectorEndpoints); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).thenReturn( + List.of(endpointDataReference("url.to.host1"), endpointDataReference("url.to.host2"))); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), + anyList())).thenReturn(lookupShellsResponse); + when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( + shellDescriptor(emptyList())); + + // when + final ThrowingCallable call = () -> sut.fetchShells( + List.of(new DigitalTwinRegistryKey("dummyShellId", "dummyBpn"))); + + // then + assertThatThrownBy(call).isInstanceOf(ShellNotFoundException.class) + .hasMessage("Unable to find any of the requested shells") + .satisfies(e -> assertThat( + ((ShellNotFoundException) e).getCalledEndpoints()).containsExactlyInAnyOrder( + "address1", "address2")); + } + + @Test + void whenExecutionExceptionOccurs() { + + // given + simulateGetFastestResultFailedFuture(); + + final var lookupShellsResponse = LookupShellsResponse.builder().result(emptyList()).build(); + + final List connectorEndpoints = List.of("address"); + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(connectorEndpoints); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).thenReturn( + List.of(endpointDataReference("url.to.host"))); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), + anyList())).thenReturn(lookupShellsResponse); + when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( + shellDescriptor(emptyList())); + + // when + final var bpn = "dummyBpn"; + final ThrowingCallable call = () -> sut.fetchShells( + List.of(new DigitalTwinRegistryKey("dummyShellId", bpn))); + + // then + assertThatThrownBy(call).isInstanceOf(RegistryServiceRuntimeException.class) + .hasMessageContaining("Exception occurred while fetching shells for bpn") + .hasMessageContaining("'" + bpn + "'"); + + } + + @Test + void shouldThrowShellNotFound_IfNoDigitalTwinRegistryKeys() { + assertThatThrownBy(() -> sut.fetchShells(emptyList())).isInstanceOf(ShellNotFoundException.class); + } + } - @Test - void shouldRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceException { - // given - final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( - "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final AssetAdministrationShellDescriptor expectedShell = shellDescriptor(Collections.emptyList()); - final var authCode = "test." + createAuthCode(exp -> exp.minus(1, ChronoUnit.DAYS)); - EndpointDataReference endpointDataReference = EndpointDataReference.Builder.newInstance() - .endpoint("url.to.host") - .authKey("test") - .authCode(authCode) - .build(); - EndpointDataReference renewedReference = EndpointDataReference.Builder.newInstance() - .endpoint("url.to.host") - .build(); - final LookupShellsResponse lookupShellsResponse = LookupShellsResponse.builder() - .result(Collections.emptyList()) - .build(); - when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(ArgumentMatchers.anyList())).thenReturn( - endpointDataReference, renewedReference); - when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), - ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); - when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); - - // when - final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( - List.of(digitalTwinRegistryKey, digitalTwinRegistryKey)); - - // then - Assertions.assertThat(actualShell).containsExactly(expectedShell, expectedShell); - - verify(endpointDataForConnectorsService, times(2)).findEndpointDataForConnectors(anyList()); + private void simulateGetFastestResultFailedFuture() { + final ResultFinder resultFinderMock = mock(ResultFinder.class); + when(resultFinderMock.getFastestResult(any())).thenReturn( + CompletableFuture.failedFuture(new IllegalStateException("some illegal state"))); + sut.setResultFinder(resultFinderMock); } - @Test - void shouldNotRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceException { - // given - final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( - "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final AssetAdministrationShellDescriptor expectedShell = shellDescriptor(Collections.emptyList()); - final var authCode = "test." + createAuthCode(exp -> exp.plus(1, ChronoUnit.DAYS)); - EndpointDataReference endpointDataReference = EndpointDataReference.Builder.newInstance() - .endpoint("url.to.host") - .authKey("test") - .authCode(authCode) - .build(); - final LookupShellsResponse lookupShellsResponse = LookupShellsResponse.builder() - .result(Collections.emptyList()) - .build(); - when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(ArgumentMatchers.anyList())).thenReturn( - endpointDataReference); - when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), - ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); - when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); - - // when - final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( - List.of(digitalTwinRegistryKey, digitalTwinRegistryKey, digitalTwinRegistryKey)); - - // then - Assertions.assertThat(actualShell).containsExactly(expectedShell, expectedShell, expectedShell); - - verify(endpointDataForConnectorsService, times(1)).findEndpointDataForConnectors(anyList()); + private void simulateResultFinderInterrupted() throws InterruptedException, ExecutionException { + final ResultFinder resultFinderMock = mock(ResultFinder.class); + final CompletableFuture completableFutureMock = mock(CompletableFuture.class); + when(completableFutureMock.get()).thenThrow(new InterruptedException("interrupted")); + when(resultFinderMock.getFastestResult(any())).thenReturn(completableFutureMock); + sut.setResultFinder(resultFinderMock); + } + + private static EndpointDataReference endpointDataReference(final String url) { + return endpointDataReferenceBuilder().endpoint(url).build(); + } + + // FIXME #214 clarify: after removal of DecentralDigitalTwinRegistryService.renewIfNecessary + // (as discussed with jhartmann) these tests make no sense anymore + // and the one that checks renewal fails of course. + // Was it really ok to remove the renewal? + // What do we do with these tests? Remove completely or adapt? How? + @Nested + @DisplayName("fetchShells - tests for EndpointDataReference renewal") + class FetchShellsEndpointDataReferenceRenewalTests { + + @Test + @Disabled("disabled until clarified, see FIXME comment above") + void shouldRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceException { + + // given + final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( + "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); + final var expectedShell = shellDescriptor(emptyList()); + + final var expiredAuthCode = "test." + createAuthCode(exp -> exp.minus(1, ChronoUnit.DAYS)); + final var expiredReference = EndpointDataReference.Builder.newInstance() + .endpoint("url.to.host") + .authKey("test") + .authCode(expiredAuthCode) + .build(); + + final var renewedReference = EndpointDataReference.Builder.newInstance().endpoint("url.to.host").build(); + + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( + List.of(expiredReference), List.of(renewedReference)); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), + anyList())).thenReturn(LookupShellsResponse.builder().result(emptyList()).build()); + when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( + expectedShell); + + // when + final var actualShell = sut.fetchShells(List.of(digitalTwinRegistryKey, digitalTwinRegistryKey)); + + // then + assertThat(actualShell).containsExactly(expectedShell, expectedShell); + + verify(endpointDataForConnectorsService, times(2)).findEndpointDataForConnectors(anyList()); + } + + @Test + void shouldNotRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceException { + // given + final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( + "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); + final var expectedShell = shellDescriptor(emptyList()); + final var authCode = "test." + createAuthCode(exp -> exp.plus(1, ChronoUnit.DAYS)); + final var endpointDataReference = endpointDataReferenceBuilder().endpoint("url.to.host") + .authKey("test") + .authCode(authCode) + .build(); + final var lookupShellsResponse = LookupShellsResponse.builder().result(emptyList()).build(); + + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( + List.of(endpointDataReference)); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), + anyList())).thenReturn(lookupShellsResponse); + when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( + expectedShell); + + // when + final var actualShell = sut.fetchShells( + List.of(digitalTwinRegistryKey, digitalTwinRegistryKey, digitalTwinRegistryKey)); + + // then + assertThat(actualShell).containsExactly(expectedShell, expectedShell, expectedShell); + + verify(endpointDataForConnectorsService, times(1)).findEndpointDataForConnectors(anyList()); + } + + } + + @Nested + @DisplayName("lookupGlobalAssetIds") + class LookupGlobalAssetIdsTests { + + @Test + void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { + // given + final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( + "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); + + final var expectedGlobalAssetId = "urn:uuid:4132cd2b-cbe7-4881-a6b4-aaaaaaaaaaaa"; + final var expectedShell = shellDescriptor(emptyList()).toBuilder() + .globalAssetId(expectedGlobalAssetId) + .build(); + final var endpointDataReference = endpointDataReference("url.to.host"); + final var lookupShellsResponse = LookupShellsResponse.builder() + .result(List.of(digitalTwinRegistryKey.shellId())) + .build(); + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( + List.of(endpointDataReference)); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), + anyList())).thenReturn(lookupShellsResponse); + when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( + expectedShell); + + // when + final var globalAssetIds = sut.lookupGlobalAssetIds(digitalTwinRegistryKey.bpn()); + + // then + assertThat(globalAssetIds).containsExactly(expectedGlobalAssetId); + } + + @Test + void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedException { + // given + simulateResultFinderInterrupted(); + + // when + final ThrowingCallable call = () -> sut.lookupGlobalAssetIds("dummyBpn"); + + // then + assertThatThrownBy(call).isInstanceOf(ShellNotFoundException.class) + .hasMessage("Unable to find any of the requested shells"); + } + + @Test + void whenExecutionExceptionOccurs() { + // given + simulateGetFastestResultFailedFuture(); + + // when + final var bpn = "dummyBpn"; + final ThrowingCallable call = () -> sut.lookupGlobalAssetIds(bpn); + + // then + assertThatThrownBy(call).isInstanceOf(RegistryServiceRuntimeException.class) + .hasMessageContaining("Exception occurred while looking up shell ids for bpn") + .hasMessageContaining("'" + bpn + "'"); + } } - @Test - void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { - // given - final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( - "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - - final String expectedGlobalAssetId = "urn:uuid:4132cd2b-cbe7-4881-a6b4-aaaaaaaaaaaa"; - final var expectedShell = shellDescriptor(Collections.emptyList()).toBuilder() - .globalAssetId(expectedGlobalAssetId) - .build(); - final var endpointDataReference = EndpointDataReference.Builder.newInstance().endpoint("url.to.host").build(); - final LookupShellsResponse lookupShellsResponse = LookupShellsResponse.builder() - .result(List.of( - digitalTwinRegistryKey.shellId())) - .build(); - when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(ArgumentMatchers.anyList())).thenReturn( - endpointDataReference); - when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), - ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); - when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); - - // when - final Collection globalAssetIds = decentralDigitalTwinRegistryService.lookupGlobalAssetIds( - digitalTwinRegistryKey.bpn()); - - // then - Assertions.assertThat(globalAssetIds).containsExactly(expectedGlobalAssetId); + private static EndpointDataReference.Builder endpointDataReferenceBuilder() { + return EndpointDataReference.Builder.newInstance(); } } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java index 589d28508e..85d5fc1e4f 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java @@ -11,7 +11,8 @@ * * This program and the accompanying materials are made available under the * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. * + * https://www.apache.org/licenses/LICENSE-2.0. + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the @@ -58,12 +59,13 @@ void shouldReturnExpectedEndpointDataReference() throws EdcRetrieverException { EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build()); // when - final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + final List endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( Collections.singletonList(connectionOneAddress)); // then - assertThat(endpointDataReference).isNotNull(); - assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionOneAddress); + assertThat(endpointDataReferences).isNotEmpty() + .extracting(EndpointDataReference::getEndpoint) + .contains(connectionOneAddress); } @Test @@ -77,12 +79,13 @@ void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() thr EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build()); // when - final EndpointDataReference endpointDataReference = endpointDataForConnectorsService.findEndpointDataForConnectors( + final List endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( List.of(connectionOneAddress, connectionTwoAddress)); // then - assertThat(endpointDataReference).isNotNull(); - assertThat(endpointDataReference.getEndpoint()).isEqualTo(connectionTwoAddress); + assertThat(endpointDataReferences).isNotEmpty() + .extracting(EndpointDataReference::getEndpoint) + .contains(connectionTwoAddress); } @Test diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java new file mode 100644 index 0000000000..40c0a99f30 --- /dev/null +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java @@ -0,0 +1,36 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.registryclient.exceptions; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.junit.jupiter.api.Test; + +class RegistryServiceRuntimeExceptionTest { + + @Test + void test() { + final IllegalArgumentException expectedCause = new IllegalArgumentException("original cause"); + final RegistryServiceRuntimeException exception = new RegistryServiceRuntimeException("message", expectedCause); + + assertThat(exception).hasMessage("message") + .hasCauseInstanceOf(IllegalArgumentException.class) + .hasCause(expectedCause); + } +} \ No newline at end of file From 1f61dab5dd95e5975b34715e3d909b3add97a94c Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 10 Jan 2024 00:08:11 +0100 Subject: [PATCH 010/116] feat(impl):[#214] fix checkstyle and pmd warnings --- .../DecentralDigitalTwinRegistryService.java | 12 ++++++------ .../exceptions/RegistryServiceRuntimeException.java | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 5134d62184..cd411616ed 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -63,20 +63,20 @@ public class DecentralDigitalTwinRegistryService implements DigitalTwinRegistryS private ResultFinder resultFinder = new ResultFinder(); + private static Stream>> groupKeysByBpn( + final Collection keys) { + return keys.stream().collect(Collectors.groupingBy(DigitalTwinRegistryKey::bpn)).entrySet().stream(); + } + /** * Package private setter in order to allow simulating {@link InterruptedException} and {@link ExecutionException} in tests. * * @param resultFinder the {@link ResultFinder} */ - void setResultFinder(final ResultFinder resultFinder) { + /* package */ void setResultFinder(final ResultFinder resultFinder) { this.resultFinder = resultFinder; } - private static Stream>> groupKeysByBpn( - final Collection keys) { - return keys.stream().collect(Collectors.groupingBy(DigitalTwinRegistryKey::bpn)).entrySet().stream(); - } - @Override public Collection fetchShells(final Collection keys) throws RegistryServiceException { diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java index 0a72286295..b032140b27 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2021,2022,2024 Contributors to the Eclipse Foundation + * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional * information regarding copyright ownership. From 5eb0f743a7a65a3a2527163521a05196a31a4900 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 10 Jan 2024 00:59:33 +0100 Subject: [PATCH 011/116] feat(impl):[#214] fix pmd warnings --- .../DecentralDigitalTwinRegistryService.java | 31 ++++++------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index cd411616ed..bf1dc2abb8 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -31,7 +31,6 @@ import java.util.List; import java.util.Map; import java.util.Set; -import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -69,7 +68,8 @@ private static Stream>> groupKeys } /** - * Package private setter in order to allow simulating {@link InterruptedException} and {@link ExecutionException} in tests. + * Package private setter in order to allow simulating {@link InterruptedException} + * and {@link ExecutionException} in tests. * * @param resultFinder the {@link ResultFinder} */ @@ -105,9 +105,11 @@ private List fetchShellDescriptors(final Set calledEndpoints.addAll(connectorEndpoints); try { - final var endpointDataReferences = getEndpointDataReferences(connectorEndpoints); + final var endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( + connectorEndpoints); final var futures = endpointDataReferences.stream() - .map(edr -> supplyAsynchShellDescriptorForKeys(keys, edr)) + .map(edr -> supplyAsync( + () -> fetchShellDescriptorsForKey(keys, edr))) .toList(); return resultFinder.getFastestResult(futures).get(); @@ -122,11 +124,6 @@ private List fetchShellDescriptors(final Set } } - private CompletableFuture> supplyAsynchShellDescriptorForKeys( - final List keys, final EndpointDataReference endpointDataReference) { - return supplyAsync(() -> fetchShellDescriptorsForKey(keys, endpointDataReference)); - } - private List fetchShellDescriptorsForKey( final List keys, final EndpointDataReference endpointDataReference) { return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); @@ -164,19 +161,14 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f return aaShellIdentification; } - @NotNull - private List getEndpointDataReferences(final List connectorEndpoints) { - return endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints); - } - private Collection lookupShellIds(final String bpn) { log.info("Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - final var endpointDataReferences = getEndpointDataReferences(connectorEndpoints); + final var endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( + connectorEndpoints); try { - final var futures = endpointDataReferences.stream() - .map(edr -> supplyAsyncLookupShellIds(bpn, edr)) + final var futures = endpointDataReferences.stream().map(edr -> supplyAsync(() -> lookupShellIds(bpn, edr))) .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); @@ -193,11 +185,6 @@ private Collection lookupShellIds(final String bpn) { } } - private CompletableFuture> supplyAsyncLookupShellIds(final String bpn, - final EndpointDataReference endpointDataReference) { - return supplyAsync(() -> lookupShellIds(bpn, endpointDataReference)); - } - private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(endpointDataReference, List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); From 3c98757fc4402dc05168083d4cb271acd81e44f0 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 15 Jan 2024 10:46:14 +0100 Subject: [PATCH 012/116] feat(imp):[#214] improve variable naming for better readability --- .../job/delegate/AbstractDelegate.java | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java index 9f3516bdb5..906d781844 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java @@ -86,30 +86,35 @@ protected ItemContainer next(final ItemContainer.ItemContainerBuilder itemContai } protected String requestSubmodelAsString(final EdcSubmodelFacade submodelFacade, - final ConnectorEndpointsService connectorEndpointsService, final Endpoint endpoint, final String bpn) + final ConnectorEndpointsService connectorEndpointsService, final Endpoint digitalTwinRegistryEndpoint, + final String bpn) throws EdcClientException { - final String subprotocolBody = endpoint.getProtocolInformation().getSubprotocolBody(); + + final String subprotocolBody = digitalTwinRegistryEndpoint.getProtocolInformation().getSubprotocolBody(); final Optional dspEndpoint = extractDspEndpoint(subprotocolBody); + if (dspEndpoint.isPresent()) { log.debug("Using dspEndpoint of subprotocolBody '{}' to get submodel payload", subprotocolBody); - return submodelFacade.getSubmodelRawPayload(dspEndpoint.get(), endpoint.getProtocolInformation().getHref(), + return submodelFacade.getSubmodelRawPayload(dspEndpoint.get(), + digitalTwinRegistryEndpoint.getProtocolInformation().getHref(), extractAssetId(subprotocolBody)); } else { log.info("SubprotocolBody does not contain '{}'. Using Discovery Service as fallback.", DSP_ENDPOINT); final List connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - return getSubmodel(submodelFacade, endpoint, connectorEndpoints); + + return getSubmodel(submodelFacade, digitalTwinRegistryEndpoint, connectorEndpoints); } } - private String getSubmodel(final EdcSubmodelFacade submodelFacade, final Endpoint endpoint, + private String getSubmodel(final EdcSubmodelFacade submodelFacade, final Endpoint digitalTwinRegistryEndpoint, final List connectorEndpoints) throws EdcClientException { for (final String connectorEndpoint : connectorEndpoints) { try { return submodelFacade.getSubmodelRawPayload(connectorEndpoint, - endpoint.getProtocolInformation().getHref(), - extractAssetId(endpoint.getProtocolInformation().getSubprotocolBody())); + digitalTwinRegistryEndpoint.getProtocolInformation().getHref(), + extractAssetId(digitalTwinRegistryEndpoint.getProtocolInformation().getSubprotocolBody())); } catch (EdcClientException e) { - log.info("EdcClientException while accessing endpoint '{}'", connectorEndpoint, e); + log.info("EdcClientException while accessing digitalTwinRegistryEndpoint '{}'", connectorEndpoint, e); } } throw new EdcClientException( From e7a8fe2eac6d32c66f80857dab6c5d18d3b78800 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 15 Jan 2024 14:25:24 +0100 Subject: [PATCH 013/116] feat(imp):[#214] use completedFuture(null) instead of supplyAsync(() -> null) --- .../tractusx/irs/common/util/concurrent/ResultFinder.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 40cbee83ec..2c2ddb5fc1 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -23,12 +23,12 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.common.util.concurrent; -import lombok.extern.slf4j.Slf4j; +import static java.util.concurrent.CompletableFuture.allOf; import java.util.List; import java.util.concurrent.CompletableFuture; -import static java.util.concurrent.CompletableFuture.allOf; +import lombok.extern.slf4j.Slf4j; /** * Helper class to find the relevant result from a list of futures. @@ -48,7 +48,7 @@ public class ResultFinder { public CompletableFuture getFastestResult(final List> futures) { if (futures == null || futures.isEmpty()) { - return CompletableFuture.supplyAsync(() -> null); + return CompletableFuture.completedFuture(null); } final CompletableFuture resultPromise = new CompletableFuture<>(); From eb9f18ceb7dd1821f22b1e816da14b242303cd75 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 15 Jan 2024 18:32:22 +0100 Subject: [PATCH 014/116] feat(imp):[#214] exception handling for ResultFinder when all fail --- .../common/util/concurrent/ResultFinder.java | 32 +++++++++++++- .../util/concurrent/ResultFinderTest.java | 44 ++++++++++++++++--- 2 files changed, 69 insertions(+), 7 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 2c2ddb5fc1..c359dae785 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -25,9 +25,13 @@ import static java.util.concurrent.CompletableFuture.allOf; +import java.util.ArrayList; import java.util.List; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import lombok.Getter; +import lombok.ToString; import lombok.extern.slf4j.Slf4j; /** @@ -53,9 +57,14 @@ public CompletableFuture getFastestResult(final List final CompletableFuture resultPromise = new CompletableFuture<>(); + final ArrayList exceptions = new ArrayList<>(); + final var handledFutures = // futures.stream() // - .map(future -> future.handle((value, throwable) -> { + .map(future -> future.exceptionally(t -> { + exceptions.add(t); + throw new CompletionException(t); + }).handle((value, throwable) -> { final boolean notFinishedByOtherFuture = !resultPromise.isDone(); final boolean currentFutureSuccessful = throwable == null && value != null; @@ -69,6 +78,7 @@ public CompletableFuture getFastestResult(final List } else { if (throwable != null) { log.warn(throwable.getMessage(), throwable); + throw new CompletionException(throwable.getMessage(), throwable); } return false; } @@ -76,11 +86,31 @@ public CompletableFuture getFastestResult(final List allOf(handledFutures.toArray(new CompletableFuture[0])).thenRun(() -> { if (!resultPromise.isDone()) { + log.warn("result promise not done yet, completing with null"); resultPromise.complete(null); } + }).exceptionally(t -> { + // returning list, because t is just one of multiple throwables that may have occurred + resultPromise.completeExceptionally(new CompletionExceptions(exceptions)); + return null; }); return resultPromise; } + /** + * Helper exception that can hold multiple causes. + */ + @Getter + @ToString + public static class CompletionExceptions extends CompletionException { + + private final List causes; + + public CompletionExceptions(final List causes) { + super("All failing, use getCauses() for details"); + this.causes = causes; + } + + } } diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index 25673665e0..941820e9e4 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -24,17 +24,19 @@ package org.eclipse.tractusx.irs.common.util.concurrent; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.NullAndEmptySource; +import static java.util.concurrent.CompletableFuture.supplyAsync; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.function.Supplier; -import static java.util.concurrent.CompletableFuture.supplyAsync; -import static org.assertj.core.api.AssertionsForClassTypes.assertThat; +import org.assertj.core.api.ThrowableAssert.ThrowingCallable; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.NullAndEmptySource; /** * Test for {@link ResultFinder} @@ -66,7 +68,8 @@ void withOnlySuccessfulAndOtherCompletableFuturesFailing() throws ExecutionExcep supplyAsync(() -> { throw new RuntimeException("failing"); }), // - supplyAsync(() -> "ok"), supplyAsync(() -> { + supplyAsync(() -> "ok"), // + supplyAsync(() -> { throw new RuntimeException("failing"); })); @@ -77,6 +80,35 @@ void withOnlySuccessfulAndOtherCompletableFuturesFailing() throws ExecutionExcep assertThat(result).isEqualTo("ok"); } + @Test + void withAllCompletableFuturesFailing() throws Throwable { + + // given + final List> futures = List.of( // + futureThrowAfterMillis(5000, () -> new RuntimeException("failing 1")), // + supplyAsync(() -> { + throw new RuntimeException("failing 2"); + }), // + futureThrowAfterMillis(1000, () -> new RuntimeException("failing 3"))); + + // when + final ThrowingCallable call = () -> sut.getFastestResult(futures).get(); + + // then + assertThatThrownBy(call).isInstanceOf(ExecutionException.class) + .extracting(Throwable::getCause) + .isInstanceOf(ResultFinder.CompletionExceptions.class) + .extracting(collectedFailures -> (ResultFinder.CompletionExceptions) collectedFailures) + .extracting(ResultFinder.CompletionExceptions::getCauses) + .describedAs("should have collected all exceptions") + .satisfies(causes -> assertThat( + causes.stream().map(Throwable::getMessage).toList()).containsExactlyInAnyOrder( + "java.lang.RuntimeException: failing 1", + "java.lang.RuntimeException: failing 2", + "java.lang.RuntimeException: failing 3")); + + } + @Test void shouldReturnFastestSuccessful() throws ExecutionException, InterruptedException { From 705ae6b1c8c399e30ff9b8eed000af7f4d91366f Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 15 Jan 2024 18:50:19 +0100 Subject: [PATCH 015/116] feat(imp):[#214] exception handling for ResultFinder when all fail --- .../common/util/concurrent/ResultFinder.java | 10 ++++------ .../util/concurrent/ResultFinderTest.java | 18 +++++++++++++----- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index c359dae785..ffa4a9686e 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -84,15 +84,13 @@ public CompletableFuture getFastestResult(final List } })).toList(); - allOf(handledFutures.toArray(new CompletableFuture[0])).thenRun(() -> { + allOf(handledFutures.toArray(new CompletableFuture[0])).whenComplete((value, ex) -> { + if (ex != null) { + resultPromise.completeExceptionally(new CompletionExceptions(exceptions)); + } if (!resultPromise.isDone()) { - log.warn("result promise not done yet, completing with null"); resultPromise.complete(null); } - }).exceptionally(t -> { - // returning list, because t is just one of multiple throwables that may have occurred - resultPromise.completeExceptionally(new CompletionExceptions(exceptions)); - return null; }); return resultPromise; diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index 941820e9e4..bc65526a64 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -34,6 +34,9 @@ import java.util.function.Supplier; import org.assertj.core.api.ThrowableAssert.ThrowingCallable; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.DisplayNameGeneration; +import org.junit.jupiter.api.DisplayNameGenerator; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.NullAndEmptySource; @@ -41,27 +44,31 @@ /** * Test for {@link ResultFinder} */ +@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class) +@DisplayName("ResultFinder") class ResultFinderTest { final ResultFinder sut = new ResultFinder(); @NullAndEmptySource @ParameterizedTest - void withNullOrEmptyInputList(final List> list) + void with_null_or_empty_input_list_it_should_return_null(final List> list) throws ExecutionException, InterruptedException { final var result = sut.getFastestResult(list).get(); assertThat(result).isNull(); } @Test - void withOneSuccessfulCompletableFuture() throws ExecutionException, InterruptedException { + void with_one_successful_CompletableFuture_it_should_return_the_successful_result() + throws ExecutionException, InterruptedException { final var futures = List.of(supplyAsync(() -> "ok")); final String result = sut.getFastestResult(futures).get(); assertThat(result).isEqualTo("ok"); } @Test - void withOnlySuccessfulAndOtherCompletableFuturesFailing() throws ExecutionException, InterruptedException { + void with_only_successful_and_other_CompletableFutures_failing_it_should_return_the_successful_resulr() + throws ExecutionException, InterruptedException { // given final List> futures = List.of( // @@ -81,7 +88,7 @@ void withOnlySuccessfulAndOtherCompletableFuturesFailing() throws ExecutionExcep } @Test - void withAllCompletableFuturesFailing() throws Throwable { + void with_all_CompletableFutures_failing_it_should_throw() { // given final List> futures = List.of( // @@ -110,7 +117,8 @@ void withAllCompletableFuturesFailing() throws Throwable { } @Test - void shouldReturnFastestSuccessful() throws ExecutionException, InterruptedException { + void with_multiple_successful_CompletableFutures_it_should_return_fastest_successful_result() + throws ExecutionException, InterruptedException { // given final List> futures = List.of( // From 3624c7e86df483eaa89ac02df6313ebf3b305ada Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 15 Jan 2024 20:35:46 +0100 Subject: [PATCH 016/116] feat(imp):[#214] reduce complexity by extraction of code to methods --- .../common/util/concurrent/ResultFinder.java | 72 +++++++++++-------- 1 file changed, 44 insertions(+), 28 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index ffa4a9686e..ff82e6a19c 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -29,6 +29,8 @@ import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionException; +import java.util.function.BiFunction; +import java.util.function.Function; import lombok.Getter; import lombok.ToString; @@ -57,38 +59,18 @@ public CompletableFuture getFastestResult(final List final CompletableFuture resultPromise = new CompletableFuture<>(); - final ArrayList exceptions = new ArrayList<>(); + final List exceptions = new ArrayList<>(); final var handledFutures = // - futures.stream() // - .map(future -> future.exceptionally(t -> { - exceptions.add(t); - throw new CompletionException(t); - }).handle((value, throwable) -> { - - final boolean notFinishedByOtherFuture = !resultPromise.isDone(); - final boolean currentFutureSuccessful = throwable == null && value != null; - - if (notFinishedByOtherFuture && currentFutureSuccessful) { - - // first future that completes successfully completes the overall future - resultPromise.complete(value); - return true; - - } else { - if (throwable != null) { - log.warn(throwable.getMessage(), throwable); - throw new CompletionException(throwable.getMessage(), throwable); - } - return false; - } - })).toList(); - - allOf(handledFutures.toArray(new CompletableFuture[0])).whenComplete((value, ex) -> { + futures.stream() + .map(future -> future.exceptionally(completingExceptionallyCollectingException(exceptions)) + .handle(completingOnFirstSuccessful(resultPromise))) + .toList(); + + allOf(toArray(handledFutures)).whenComplete((value, ex) -> { if (ex != null) { resultPromise.completeExceptionally(new CompletionExceptions(exceptions)); - } - if (!resultPromise.isDone()) { + } else if (!resultPromise.isDone()) { resultPromise.complete(null); } }); @@ -96,6 +78,40 @@ public CompletableFuture getFastestResult(final List return resultPromise; } + private static CompletableFuture[] toArray(final List> handledFutures) { + return handledFutures.toArray(new CompletableFuture[0]); + } + + private static BiFunction completingOnFirstSuccessful( + final CompletableFuture resultPromise) { + return (value, throwable) -> { + final boolean notFinishedByOtherFuture = !resultPromise.isDone(); + final boolean currentFutureSuccessful = throwable == null && value != null; + + if (notFinishedByOtherFuture && currentFutureSuccessful) { + + // first future that completes successfully completes the overall future + resultPromise.complete(value); + return true; + + } else { + if (throwable != null) { + log.warn(throwable.getMessage(), throwable); + throw new CompletionException(throwable.getMessage(), throwable); + } + return false; + } + }; + } + + private static Function completingExceptionallyCollectingException( + final List exceptions) { + return t -> { + exceptions.add(t); + throw new CompletionException(t); + }; + } + /** * Helper exception that can hold multiple causes. */ From 99d6bfb9c28d276aea26e82faf1abae350cf0159 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 15 Jan 2024 21:16:19 +0100 Subject: [PATCH 017/116] feat(imp):[#214] parallelize edcSubmodelFacade.getEndpointReferenceForAsset in combination with the actual data request --- .../DecentralDigitalTwinRegistryService.java | 30 +++-- .../EndpointDataForConnectorsService.java | 33 ++--- .../DefaultConfigurationTest.java | 22 ++- ...centralDigitalTwinRegistryServiceTest.java | 126 +++--------------- .../EndpointDataForConnectorsServiceTest.java | 96 +++++++++---- 5 files changed, 137 insertions(+), 170 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index bf1dc2abb8..e2f7cd8a89 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -23,10 +23,10 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; +import static java.util.Collections.emptyList; import static java.util.concurrent.CompletableFuture.supplyAsync; import java.util.Collection; -import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; @@ -104,20 +104,23 @@ private List fetchShellDescriptors(final Set final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); calledEndpoints.addAll(connectorEndpoints); + final var service = endpointDataForConnectorsService; + try { - final var endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( - connectorEndpoints); - final var futures = endpointDataReferences.stream() - .map(edr -> supplyAsync( - () -> fetchShellDescriptorsForKey(keys, edr))) - .toList(); + + final var futures = // + service.findEndpointDataForConnectors(connectorEndpoints) + .stream() + .map(edrFuture -> edrFuture.thenCompose( + edr -> supplyAsync(() -> fetchShellDescriptorsForKey(keys, edr)))) + .toList(); return resultFinder.getFastestResult(futures).get(); } catch (InterruptedException e) { log.debug("InterruptedException occurred while fetching shells for bpn '%s'".formatted(bpn), e); Thread.currentThread().interrupt(); - return Collections.emptyList(); + return emptyList(); } catch (ExecutionException e) { throw new RegistryServiceRuntimeException( "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); @@ -164,12 +167,13 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f private Collection lookupShellIds(final String bpn) { log.info("Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - final var endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( - connectorEndpoints); + final var edrFutures = endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints); try { - final var futures = endpointDataReferences.stream().map(edr -> supplyAsync(() -> lookupShellIds(bpn, edr))) - .toList(); + final var futures = edrFutures.stream() + .map(edrFuture -> edrFuture.thenCompose( + edr -> supplyAsync(() -> lookupShellIds(bpn, edr)))) + .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); log.info("Found {} shell id(s) in total", shellIds.size()); @@ -178,7 +182,7 @@ private Collection lookupShellIds(final String bpn) { } catch (InterruptedException e) { log.debug("InterruptedException occurred while looking up shells ids for bpn '%s'".formatted(bpn), e); Thread.currentThread().interrupt(); - return Collections.emptyList(); + return emptyList(); } catch (ExecutionException e) { throw new RegistryServiceRuntimeException( "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 27068a8ffb..975fcffd6a 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -24,12 +24,12 @@ package org.eclipse.tractusx.irs.registryclient.decentral; import java.util.List; -import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; -import org.springframework.web.client.RestClientException; /** * Service that use edc client to make calls to edc connector endpoints @@ -44,32 +44,25 @@ public class EndpointDataForConnectorsService { private final EdcEndpointReferenceRetriever edcSubmodelFacade; - public List findEndpointDataForConnectors(final List connectorEndpoints) { + public List> findEndpointDataForConnectors( + final List connectorEndpoints) { - final List endpointDataReferences = // - connectorEndpoints.stream().parallel() // - .map(this::getEndpointReferenceForAsset) // - .filter(Optional::isPresent) // - .map(Optional::get) // - .map(EndpointDataReference.class::cast).toList(); - - if (endpointDataReferences.isEmpty()) { - throw new RestClientException("EndpointDataReference was not found. Requested connectorEndpoints: " // - + String.join(", ", connectorEndpoints)); - } else { - return endpointDataReferences; - } + return connectorEndpoints.stream() + .map(connectorEndpoint -> CompletableFuture.supplyAsync( + () -> getEndpointReferenceForAsset(connectorEndpoint))) + .toList(); } - private Optional getEndpointReferenceForAsset(final String connector) { + private EndpointDataReference getEndpointReferenceForAsset(final String connector) { log.info("Trying to retrieve EndpointDataReference for connector {}", connector); try { - return Optional.ofNullable(edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)); + return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE); } catch (EdcRetrieverException e) { log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); - return Optional.empty(); + throw new CompletionException(e.getMessage(), e); } + } } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java index 81be9760be..9ac85f450d 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java @@ -32,13 +32,14 @@ import static org.mockito.Mockito.when; import java.util.List; +import java.util.concurrent.ExecutionException; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelClient; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.registryclient.decentral.EdcRetrieverException; import org.junit.jupiter.api.Test; -import org.springframework.web.client.RestClientException; import org.springframework.web.client.RestTemplate; class DefaultConfigurationTest { @@ -85,7 +86,15 @@ void endpointDataForConnectorsService() throws EdcClientException { // ACT final var endpointDataForConnectorsService = testee.endpointDataForConnectorsService(mock); - endpointDataForConnectorsService.findEndpointDataForConnectors(List.of(endpointAddress)); + + endpointDataForConnectorsService.findEndpointDataForConnectors(List.of(endpointAddress)) // + .forEach(future -> { + try { + future.get(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }); // ASSERT verify(mock).getEndpointReferenceForAsset(eq(endpointAddress), any(), any()); @@ -98,9 +107,10 @@ void endpointDataForConnectorsService_withException() throws EdcClientException final var endpointDataForConnectorsService = testee.endpointDataForConnectorsService(mock); final var dummyEndpoints = List.of("test"); - assertThatThrownBy( - () -> endpointDataForConnectorsService.findEndpointDataForConnectors(dummyEndpoints)).isInstanceOf( - RestClientException.class); - + endpointDataForConnectorsService.findEndpointDataForConnectors(dummyEndpoints).forEach(future -> { + assertThatThrownBy(future::get).isInstanceOf(ExecutionException.class) + .extracting(Throwable::getCause) + .isInstanceOf(EdcRetrieverException.class); + }); } } \ No newline at end of file diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index 9c2745c677..95352c3151 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -24,23 +24,17 @@ package org.eclipse.tractusx.irs.registryclient.decentral; import static java.util.Collections.emptyList; +import static java.util.concurrent.CompletableFuture.completedFuture; 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.anyList; import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -import java.nio.charset.StandardCharsets; -import java.time.Instant; -import java.time.temporal.ChronoUnit; -import java.util.Base64; import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; -import java.util.function.Function; import org.assertj.core.api.ThrowableAssert.ThrowingCallable; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; @@ -48,14 +42,11 @@ import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.component.assetadministrationshell.SubmodelDescriptor; -import org.eclipse.tractusx.irs.data.StringMapper; -import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceRuntimeException; import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; -import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; @@ -72,20 +63,14 @@ class DecentralDigitalTwinRegistryServiceTest { private final DecentralDigitalTwinRegistryService sut = new DecentralDigitalTwinRegistryService( connectorEndpointsService, endpointDataForConnectorsService, decentralDigitalTwinRegistryClient); - private static String createAuthCode(final Function expirationModifier) { - final var serializedEdrAuthCode = StringMapper.mapToString( - EDRAuthCode.builder().exp(expirationModifier.apply(Instant.now()).getEpochSecond()).build()); - final var bytes = serializedEdrAuthCode.getBytes(StandardCharsets.UTF_8); - return Base64.getUrlEncoder().encodeToString(bytes); - } - public static AssetAdministrationShellDescriptor shellDescriptor( final List submodelDescriptors) { + + final var specificAssetIds = List.of( + IdentifierKeyValuePair.builder().name("ManufacturerId").value("BPNL00000003AYRE").build()); + return AssetAdministrationShellDescriptor.builder() - .specificAssetIds(List.of(IdentifierKeyValuePair.builder() - .name("ManufacturerId") - .value("BPNL00000003AYRE") - .build())) + .specificAssetIds(specificAssetIds) .submodelDescriptors(submodelDescriptors) .build(); } @@ -104,8 +89,11 @@ void shouldReturnExpectedShell() throws RegistryServiceException { final var lookupShellsResponse = LookupShellsResponse.builder().result(emptyList()).build(); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); + + final var endpointDataRefFutures = List.of(completedFuture(endpointDataReference)); when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( - List.of(endpointDataReference)); + endpointDataRefFutures); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( @@ -128,8 +116,13 @@ void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedExce final List connectorEndpoints = List.of("address1", "address2"); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(connectorEndpoints); + + final var dataRefFutures = List.of( // + completedFuture(endpointDataReference("url.to.host1")), // + completedFuture(endpointDataReference("url.to.host2"))); when(endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).thenReturn( - List.of(endpointDataReference("url.to.host1"), endpointDataReference("url.to.host2"))); + dataRefFutures); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( @@ -157,8 +150,11 @@ void whenExecutionExceptionOccurs() { final List connectorEndpoints = List.of("address"); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(connectorEndpoints); + + final var dataRefFutures = List.of(completedFuture(endpointDataReference("url.to.host"))); when(endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).thenReturn( - List.of(endpointDataReference("url.to.host"))); + dataRefFutures); + when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( @@ -202,83 +198,6 @@ private static EndpointDataReference endpointDataReference(final String url) { return endpointDataReferenceBuilder().endpoint(url).build(); } - // FIXME #214 clarify: after removal of DecentralDigitalTwinRegistryService.renewIfNecessary - // (as discussed with jhartmann) these tests make no sense anymore - // and the one that checks renewal fails of course. - // Was it really ok to remove the renewal? - // What do we do with these tests? Remove completely or adapt? How? - @Nested - @DisplayName("fetchShells - tests for EndpointDataReference renewal") - class FetchShellsEndpointDataReferenceRenewalTests { - - @Test - @Disabled("disabled until clarified, see FIXME comment above") - void shouldRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceException { - - // given - final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( - "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final var expectedShell = shellDescriptor(emptyList()); - - final var expiredAuthCode = "test." + createAuthCode(exp -> exp.minus(1, ChronoUnit.DAYS)); - final var expiredReference = EndpointDataReference.Builder.newInstance() - .endpoint("url.to.host") - .authKey("test") - .authCode(expiredAuthCode) - .build(); - - final var renewedReference = EndpointDataReference.Builder.newInstance().endpoint("url.to.host").build(); - - when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( - List.of(expiredReference), List.of(renewedReference)); - when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), - anyList())).thenReturn(LookupShellsResponse.builder().result(emptyList()).build()); - when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); - - // when - final var actualShell = sut.fetchShells(List.of(digitalTwinRegistryKey, digitalTwinRegistryKey)); - - // then - assertThat(actualShell).containsExactly(expectedShell, expectedShell); - - verify(endpointDataForConnectorsService, times(2)).findEndpointDataForConnectors(anyList()); - } - - @Test - void shouldNotRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceException { - // given - final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( - "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final var expectedShell = shellDescriptor(emptyList()); - final var authCode = "test." + createAuthCode(exp -> exp.plus(1, ChronoUnit.DAYS)); - final var endpointDataReference = endpointDataReferenceBuilder().endpoint("url.to.host") - .authKey("test") - .authCode(authCode) - .build(); - final var lookupShellsResponse = LookupShellsResponse.builder().result(emptyList()).build(); - - when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( - List.of(endpointDataReference)); - when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), - anyList())).thenReturn(lookupShellsResponse); - when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); - - // when - final var actualShell = sut.fetchShells( - List.of(digitalTwinRegistryKey, digitalTwinRegistryKey, digitalTwinRegistryKey)); - - // then - assertThat(actualShell).containsExactly(expectedShell, expectedShell, expectedShell); - - verify(endpointDataForConnectorsService, times(1)).findEndpointDataForConnectors(anyList()); - } - - } - @Nested @DisplayName("lookupGlobalAssetIds") class LookupGlobalAssetIdsTests { @@ -293,13 +212,12 @@ void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { final var expectedShell = shellDescriptor(emptyList()).toBuilder() .globalAssetId(expectedGlobalAssetId) .build(); - final var endpointDataReference = endpointDataReference("url.to.host"); + final var dataRefFutures = List.of(completedFuture(endpointDataReference("url.to.host"))); final var lookupShellsResponse = LookupShellsResponse.builder() .result(List.of(digitalTwinRegistryKey.shellId())) .build(); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( - List.of(endpointDataReference)); + when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn(dataRefFutures); when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java index 85d5fc1e4f..af3fe2def0 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java @@ -24,19 +24,21 @@ package org.eclipse.tractusx.irs.registryclient.decentral; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; +import java.util.ArrayList; import java.util.Collections; import java.util.List; +import java.util.Objects; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.junit.jupiter.api.Test; -import org.springframework.web.client.RestClientException; class EndpointDataForConnectorsServiceTest { @@ -46,60 +48,100 @@ class EndpointDataForConnectorsServiceTest { private static final String connectionOneAddress = "connectionOneAddress"; private static final String connectionTwoAddress = "connectionTwoAddress"; + private static final EndpointDataReference CONNECTION_ONE_DATA_REF = // + EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build(); + + private static final EndpointDataReference CONNECTION_TWO_DATA_REF = // + EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build(); + private final EdcEndpointReferenceRetriever edcSubmodelFacade = mock(EdcEndpointReferenceRetriever.class); - private final EndpointDataForConnectorsService endpointDataForConnectorsService = new EndpointDataForConnectorsService( - edcSubmodelFacade); + private final EndpointDataForConnectorsService sut = new EndpointDataForConnectorsService(edcSubmodelFacade); @Test void shouldReturnExpectedEndpointDataReference() throws EdcRetrieverException { - // given + + // GIVEN when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenReturn( - EndpointDataReference.Builder.newInstance().endpoint(connectionOneAddress).build()); + DT_REGISTRY_ASSET_VALUE)).thenReturn(CONNECTION_ONE_DATA_REF); - // when - final List endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( + // WHEN + final List> endpointDataReferences = sut.findEndpointDataForConnectors( Collections.singletonList(connectionOneAddress)); - // then + // THEN assertThat(endpointDataReferences).isNotEmpty() + .extracting(CompletableFuture::get) + .isNotEmpty() .extracting(EndpointDataReference::getEndpoint) .contains(connectionOneAddress); } @Test void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() throws EdcRetrieverException { - // given + + // GIVEN + + // a first endpoint failing (1) when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionOneAddress, DT_REGISTRY_ASSET_TYPE, DT_REGISTRY_ASSET_VALUE)).thenThrow( new EdcRetrieverException(new EdcClientException("EdcClientException"))); - when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE)).thenReturn( - EndpointDataReference.Builder.newInstance().endpoint(connectionTwoAddress).build()); - // when - final List endpointDataReferences = endpointDataForConnectorsService.findEndpointDataForConnectors( - List.of(connectionOneAddress, connectionTwoAddress)); + // and a second endpoint returning successfully (2) + when(edcSubmodelFacade.getEndpointReferenceForAsset(connectionTwoAddress, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE)).thenReturn(CONNECTION_TWO_DATA_REF); + + // WHEN + final List> dataRefFutures = // + sut.findEndpointDataForConnectors(List.of(connectionOneAddress, // (1) + connectionTwoAddress // (2) + )); + + // THEN + final List dataReferences = // + dataRefFutures.stream() + .map(EndpointDataForConnectorsServiceTest::executeFutureMappingErrorsToNull) + .filter(Objects::nonNull) + .toList(); + + assertThat(dataReferences).isNotEmpty() // + .extracting(EndpointDataReference::getEndpoint) // + .contains(connectionTwoAddress); + } - // then - assertThat(endpointDataReferences).isNotEmpty() - .extracting(EndpointDataReference::getEndpoint) - .contains(connectionTwoAddress); + private static EndpointDataReference executeFutureMappingErrorsToNull( + final CompletableFuture future) { + try { + return future.get(); + } catch (InterruptedException | ExecutionException e) { + // ignore + return null; + } } @Test void shouldThrowExceptionWhenConnectorEndpointsNotReachable() throws EdcRetrieverException { - // given + + // GIVEN when(edcSubmodelFacade.getEndpointReferenceForAsset(anyString(), eq(DT_REGISTRY_ASSET_TYPE), eq(DT_REGISTRY_ASSET_VALUE))).thenThrow( new EdcRetrieverException(new EdcClientException("EdcClientException"))); - final List connectorEndpoints = List.of(connectionOneAddress, connectionTwoAddress); - // when + then - assertThatThrownBy( - () -> endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).isInstanceOf( - RestClientException.class).hasMessageContainingAll(connectionOneAddress, connectionTwoAddress); + // WHEN + final var exceptions = new ArrayList<>(); + + // THEN + final List connectorEndpoints = List.of(connectionOneAddress, connectionTwoAddress); + sut.findEndpointDataForConnectors(connectorEndpoints) // + .forEach(future -> { + try { + future.get(); + } catch (InterruptedException | ExecutionException e) { + exceptions.add(e); + } + }); + + assertThat(exceptions).hasSize(connectorEndpoints.size()); } } From 11abe4492110551619571d04c5cb160bc84fe364 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 16 Jan 2024 15:12:09 +0100 Subject: [PATCH 018/116] feat(imp):[#214] correct typo --- .../tractusx/irs/common/util/concurrent/ResultFinderTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index bc65526a64..7e92ae1f5b 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -67,7 +67,7 @@ void with_one_successful_CompletableFuture_it_should_return_the_successful_resul } @Test - void with_only_successful_and_other_CompletableFutures_failing_it_should_return_the_successful_resulr() + void with_only_successful_and_other_CompletableFutures_failing_it_should_return_the_successful_result() throws ExecutionException, InterruptedException { // given From 1d85a2ece93c8aec846813a7040a8b18f72d659e Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 16 Jan 2024 15:32:26 +0100 Subject: [PATCH 019/116] feat(imp):[#214] update deps --- DEPENDENCIES | 1 - 1 file changed, 1 deletion(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index 1d6bd77288..2a6e07d2e8 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -205,7 +205,6 @@ maven/mavencentral/net.minidev/accessors-smart/2.4.9, Apache-2.0, approved, #751 maven/mavencentral/net.minidev/json-smart/2.4.10, Apache-2.0, approved, #3288 maven/mavencentral/net.minidev/json-smart/2.4.11, Apache-2.0, approved, #3288 maven/mavencentral/net.sf.saxon/Saxon-HE/10.6, MPL-2.0 AND W3C, approved, #7945 -maven/mavencentral/org.apache.commons/commons-compress/1.23.0, Apache-2.0 AND BSD-3-Clause, approved, #7506 maven/mavencentral/org.apache.commons/commons-compress/1.24.0, Apache-2.0 AND BSD-3-Clause AND bzip2-1.0.6 AND LicenseRef-Public-Domain, approved, #10368 maven/mavencentral/org.apache.commons/commons-lang3/3.12.0, Apache-2.0, approved, clearlydefined maven/mavencentral/org.apache.commons/commons-pool2/2.11.1, Apache-2.0, approved, CQ23795 From 2219b3b68e4f7530d77eb68eee765a7698b42681 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 17 Jan 2024 17:23:11 +0100 Subject: [PATCH 020/116] feat(imp):[#214] update CHANGELOG.md --- CHANGELOG.md | 365 ++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 290 insertions(+), 75 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e09e7bc65f..43993888a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -8,52 +9,73 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- Dataspace Discovery Service handles multiple EDC-Urls received for BPN now - Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" ## [4.4.0] - 2024-01-15 + ### Added + - Added EDR token cache to reuse token after contract negotiation - Added cache mechanism in DiscoveryFinderClientImpl for findDiscoveryEndpoints ### Changed -- Authentication was redesigned to use API keys, instead of OAuth2 protocol. The api key has to be sent as a X-API-KEY request header. IRS is supporting two types of API keys - one for admin and one for regular/view usage. Use new ``apiKeyAdmin`` and ``apiKeyRegular`` config entries to set up API keys. + +- Authentication was redesigned to use API keys, instead of OAuth2 protocol. The api key has to be sent as a X-API-KEY + request header. IRS is supporting two types of API keys - one for admin and one for regular/view usage. Use + new ``apiKeyAdmin`` and ``apiKeyRegular`` config entries to set up API keys. ### Removed + - Removed ``oauth.resourceClaim``, ``oauth.irsNamespace``,``oauth.roles``,``oauth2.jwkSetUri`` config entries ## [4.3.0] - 2023-12-08 + ### Added + - Added support for `hasAlternatives` property in SingleLevelBomAsBuilt aspect ### Changed + - Updated edc dependencies to 0.2.1 - Update deprecated field `providerUrl` to `counterPartyAddress` in EDC catalog request - Update ESS EDC notification creation asset endpoint to v3 ## [4.2.0] - 2023-11-28 + ### Changed -- Changed default behaviour of IRS - when aspects list is not provided or empty in request body, IRS will not collect any submodel now (previously default aspects were collected). + +- Changed default behaviour of IRS - when aspects list is not provided or empty in request body, IRS will not collect + any submodel now (previously default aspects were collected). - ESS - - Added 'hops' parameter to SupplyChainImpacted Aspect model - contains relative distance in the supply chain - - Added `impactedSuppliersOnFirstTier` parameter to Supply SupplyChainImpacted Aspect model - contains information of first level supply chain impacted + - Added 'hops' parameter to SupplyChainImpacted Aspect model - contains relative distance in the supply chain + - Added `impactedSuppliersOnFirstTier` parameter to Supply SupplyChainImpacted Aspect model - contains information + of first level supply chain impacted - Exported health endpoints to prometheus (see HealthMetricsExportConfiguration, DependenciesHealthMetricsExportConfiguration) and added [system health dashboard](charts/irs-helm/dashboards/system-health-dashboard.json) in order to visualize health metrics of IRS and its dependencies ### Fixed + - Fixed incorrect passing of incidentBPNS for ESS Orders ### Known knowns + - [#253] Cancelation of order jobs is not working stable ## [4.1.0] - 2023-11-15 + ### Added -- IRS can now check the readiness of external services. Use the new ``management.health.dependencies.enabled`` config entry to determine if external dependencies health checks should be checked (false by default). - - The map of external services healthcheck endpoints can be configured with ``management.health.dependencies.urls`` property, eg. ``service_name: http://service_name_host/health`` + +- IRS can now check the readiness of external services. Use the new ``management.health.dependencies.enabled`` config + entry to determine if external dependencies health checks should be checked (false by default). + - The map of external services healthcheck endpoints can be configured with ``management.health.dependencies.urls`` + property, eg. ``service_name: http://service_name_host/health`` - Added cache mechanism for ConnectorEndpointService for fetchConnectorEndpoints method cache ### Changed + - Changed name of spring's OAuth2 client registration from 'keycloak' to 'common' like below: ``` spring: @@ -87,37 +109,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Update IRS API Swagger documentation to match AAS 3.0.0 ### Fixed + - IRS will return 206 Http status from GET /jobs/{id} endpoint if Job is still running ## [4.0.2] - 2023-11-20 + ### Changed + - Remove `apk upgrade --no-cache libssl3 libcrypto3` in Docker base image to be TRG compliant ## [4.0.1] - 2023-11-10 + ### Changed + - Added state `STARTED` as acceptable state to complete the EDC transfer process to be compatible with EDC 0.5.1 ## [4.0.0] - 2023-10-27 + ### Added + - Introduced new API endpoint to register ESS Jobs in Batch - POST {{IRS_HOST}}/irs/ess/orders - Added role "admin_irs" again ### Changed + - Deprecated query parameter 'jobStates' was removed from GET {{IRS_HOST}}/irs/jobs endpoint -- Moved OAuth2 JWT token claim to configuration. The fields can be configured with `oauth.resourceClaim`, `oauth.irsNamespace`, `oauth.roles`. +- Moved OAuth2 JWT token claim to configuration. The fields can be configured + with `oauth.resourceClaim`, `oauth.irsNamespace`, `oauth.roles`. - ESS - - Added Tombstone to ESS investigation in case required aspect models "PartAsPlanned" or "PartSiteInformationAsPlanned" are missing + - Added Tombstone to ESS investigation in case required aspect models "PartAsPlanned" or " + PartSiteInformationAsPlanned" are missing - Update dependencies to mitigate third party vulnerabilities ## [3.5.4] - 2023-10-25 + ### Changed + - removed role "admin_irs" ## [3.5.3] - 2023-10-09 + ### Fixed + - Fixed default policy creation. ### Changed + - Changed configuration for default policies from: ``` irs-edc-client: @@ -141,275 +178,378 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ``` ## [3.5.2] - 2023-10-06 + ### Changed + - Updated dependencies ## [3.5.1] - 2023-10-05 + ### Fixed + - Fix json schema validation ## [3.5.0] - 2023-09-27 + ### Changed -- IRS now makes use of the value `dspEndpoint` in `subprotocolBody` of the Asset Administration Shell to request submodel data directly. + +- IRS now makes use of the value `dspEndpoint` in `subprotocolBody` of the Asset Administration Shell to request + submodel data directly. - Policy Store API is extended to handle: - - multi permissions per each allowed Policy in POST call to create Policy - - multi constraint per each permission in POST call to create Permission - - logical AndConstraint and OrConstraint to give possibility to create complex restriction + - multi permissions per each allowed Policy in POST call to create Policy + - multi constraint per each permission in POST call to create Permission + - logical AndConstraint and OrConstraint to give possibility to create complex restriction ### Fixed + - Fixed a case where IRS submodel requests did not reuqest all EDC endpoints discovered by Discovery Finder - ESS - - Updated investigation request body field `incidentBPNs` to `incidentBPNSs`. - - Streamlined EDC notification flow and adjusted it to existing EDC client methods - - Changed investigation from BPNL to BPNS (`catenaXSiteId` of `PartSiteInformationAsPlanned`) - - Additional validation for `validityPeriod` of `PartAsPlanned` + - Updated investigation request body field `incidentBPNs` to `incidentBPNSs`. + - Streamlined EDC notification flow and adjusted it to existing EDC client methods + - Changed investigation from BPNL to BPNS (`catenaXSiteId` of `PartSiteInformationAsPlanned`) + - Additional validation for `validityPeriod` of `PartAsPlanned` ## [3.4.1] - 2023-09-22 + ### Changed + - Updated SingleLevelUsageAsBuilt schema to 2.0.0 version. ### Fixed + - Fixed missing access control for Batch and ESS API. ## [3.4.0] - 2023-09-01 + ### Added + - Added fetchCatalog to EDCCatalogFacade - Introduced new API endpoint to update 'validUntil' property of Policy - PUT {{IRS_HOST}}/irs/policies/{policyId} - Introduced new IRS role `admin_irs` which has unrestricted access to every API endpoint ### Changed -- Adjusted API access control. Users with role `view_irs` can only access jobs they created themselves. PolicyStore API access is restricted to role `admin_irs`. + +- Adjusted API access control. Users with role `view_irs` can only access jobs they created themselves. PolicyStore API + access is restricted to role `admin_irs`. ### Fixed + - Fixed bug where BPN's were delivered without 'manufacturerName' property filled ## [3.3.5] - 2023-08-30 + ### Changed + - Updated IRS Digital Twin Registry Client to support latest version 0.3.14-M1 ## [3.3.4] - 2023-08-24 + ### Fixed + - Added missing license information to documentation and docker image ## [3.3.3] - 2023-08-11 + ### Changed -- IRS now calls the entire dataplane URL retrieved from the registry href instead of building it from the URL of the EDC token and the path + +- IRS now calls the entire dataplane URL retrieved from the registry href instead of building it from the URL of the EDC + token and the path ### Fixed + - Switched to POST for DTR lookup request -- Added Base64 encoding to identifier for DTR shell-descriptor request +- Added Base64 encoding to identifier for DTR shell-descriptor request - Fixed an issue where IRS did not pass the BPN correctly for the ESS use-case ## [3.3.2] - 2023-07-31 + ### Fixed + - BPN is now passed on correctly when traversing the item graph - EDC Policies now get validated regardless of the type of constraint. - EDC Policies of type FrameworkAgreement are now validated correctly. - Fixed error in BPN handling for IRS Batch requests ## [3.3.1] - 2023-07-24 + ### Fixed + - Added missing field `businessPartner` for relationship aspect SingleLevelUsageAsBuilt ## [3.3.0] - 2023-07-20 + ### Changed + - BPN is now taken from the submodel data while traversing the item graph - Tombstone is created if no BPN is available for a child item ## [3.2.1] - 2023-07-19 + ### Fixed + - EDC Policies now get validated regardless of the type of constraint. - EDC Policies of type `FrameworkAgreement` are now validated correctly. - Fixed error in BPN handling for IRS Batch requests ## [3.2.0] - 2023-07-14 + ### Changed -- The client code for accessing the Digital Twin Registry (central and decentral) is now available as a spring boot maven library. See the README in the irs-registry-client module for more information. + +- The client code for accessing the Digital Twin Registry (central and decentral) is now available as a spring boot + maven library. See the README in the irs-registry-client module for more information. - Update EDC dependencies to 0.1.3 - Add Transformer to support new EDC constraint operator format -- IRS now supports the AAS API 3.0 and its updated models. **Note**: this also reflects in the Job response shells, please check the new schema. +- IRS now supports the AAS API 3.0 and its updated models. **Note**: this also reflects in the Job response shells, + please check the new schema. ### Known knowns -- [TRI-1460] ESS Notifications endpoints are not working in the decentral Digital Twin Registry scenario because endpoints does not provide bpn as a parameter. + +- [TRI-1460] ESS Notifications endpoints are not working in the decentral Digital Twin Registry scenario because + endpoints does not provide bpn as a parameter. - [TRI-1096] No limiting of requests in parallel - IRS allows sending API requests unlimited -- [TRI-1100] Potential denial-of-service (DoS) attack - IRS allows to enter a large number of characters, which are reflected in the response of the server -- [TRI-1098] Software related information disclosure - IRS returns redundant information about the type and version of used software -- [TRI-793] Misconfigured Access-Control-Allow- Origin Header - by intercepting network traffic it could be possible to read and modify any messages that are exchanged with server -- [TRI-1095] HTTP security headers configuration could be improved and allow for additional protection against some web application attacks -- [TRI-1441] Synchronous communication with shared C-X services without circuit breaker pattern - potentially could affect IRS resilience when other services becomes non-responsive. -- [TRI-1441] Cascading effects of failure when Digital Twin Registry becomes non-responsive - potentially bulkhead pattern could improve IRS resilience -- [TRI-1477] Retry mechanism used inside IRS could potentially affect IRS resilience - DDOS other services on which IRS is dependent, exhaustion of resources and available threads, etc. +- [TRI-1100] Potential denial-of-service (DoS) attack - IRS allows to enter a large number of characters, which are + reflected in the response of the server +- [TRI-1098] Software related information disclosure - IRS returns redundant information about the type and version of + used software +- [TRI-793] Misconfigured Access-Control-Allow- Origin Header - by intercepting network traffic it could be possible to + read and modify any messages that are exchanged with server +- [TRI-1095] HTTP security headers configuration could be improved and allow for additional protection against some web + application attacks +- [TRI-1441] Synchronous communication with shared C-X services without circuit breaker pattern - potentially could + affect IRS resilience when other services becomes non-responsive. +- [TRI-1441] Cascading effects of failure when Digital Twin Registry becomes non-responsive - potentially bulkhead + pattern could improve IRS resilience +- [TRI-1477] Retry mechanism used inside IRS could potentially affect IRS resilience - DDOS other services on which IRS + is dependent, exhaustion of resources and available threads, etc. - [TRI-1478] Lack of resources management - thread pooling, heap limitation etc. - [TRI-1024] IRS does not support scale out on multiple instances ## [3.1.0] - 2023-07-07 + ### Changed + - Removed catalog cache - Changed EDC catalog retrieval from pagination to filter -- Item graphs with asBuilt lifecycle & downward direction are now built with usage of SingleLevelBomAsBuilt aspect, instead of AssemblyPartRelationship aspect +- Item graphs with asBuilt lifecycle & downward direction are now built with usage of SingleLevelBomAsBuilt aspect, + instead of AssemblyPartRelationship aspect - Changed retrieval of BPN value from AAS Shell to SingleLevelBomAsBuilt - Renamed SerialPartTypization to SerialPart aspect - ESS - - Update ESS notification asset creation to new EDC DSP protocol - - Include DiscoveryFinder into ESS flow + - Update ESS notification asset creation to new EDC DSP protocol + - Include DiscoveryFinder into ESS flow ## [3.0.1] - 2023-06-28 + ### Fixed + - Added missing participantId to contract negotiation for decentral DTR contract negotiation - Fixed default value for contract negotiation and transfer process state-suffix ## [3.0.0] - 2023-06-26 + ### Added + - Handling of Decentral Digital Twin Registry as a way of request AAS for identifier - - Extend Register Job with key field that contain BPN and globalAssetId - - Requesting BPN endpoint catalog over Discrovery Finder - - Requesting EDC endpoint addresses for BPN over EDC Discovery Finder - - Add filter for catalog item search in EDC - - Authorize Digital Twin client with EDC Endpoint Reference + - Extend Register Job with key field that contain BPN and globalAssetId + - Requesting BPN endpoint catalog over Discrovery Finder + - Requesting EDC endpoint addresses for BPN over EDC Discovery Finder + - Add filter for catalog item search in EDC + - Authorize Digital Twin client with EDC Endpoint Reference - Added new Policy Store API to manage acceptable EDC policies - - `GET /irs/policies` - - `POST /irs/policies` - - `DELETE /irs/policies/{policyId}` + - `GET /irs/policies` + - `POST /irs/policies` + - `DELETE /irs/policies/{policyId}` ### Changed + - Updated EDC Client to use version 0.4.1 - - Adjusted Protocol from IDS to DSP - - Paths for catalog, contract negotiation and transfer process are now configurable via properties - - `edc.controlplane.endpoint.catalog` - - `edc.controlplane.endpoint.contract-negotiation` - - `edc.controlplane.endpoint.transfer-process` + - Adjusted Protocol from IDS to DSP + - Paths for catalog, contract negotiation and transfer process are now configurable via properties + - `edc.controlplane.endpoint.catalog` + - `edc.controlplane.endpoint.contract-negotiation` + - `edc.controlplane.endpoint.transfer-process` - EDR Callback is now configurable via property `edc.callback-url` ## [2.6.1] - 2023-05-15 + ### Added + - Validation if bpnEndpoint is set in properties before starting a job with lookupBPNs set to true - Automate release workflow - Validate if callback url starts with http or https before register a job ## [2.6.0] - 2023-05-05 + ### Added -- IRS now checks the EDC policies and only negotiates contracts if the policy matches the ones defined in the configuration at `edc.catalog.policies.allowedNames` (comma separated string) + +- IRS now checks the EDC policies and only negotiates contracts if the policy matches the ones defined in the + configuration at `edc.catalog.policies.allowedNames` (comma separated string) ### Changed + - Restructured the repository to make it more comprehensive -- Improved API descriptions regarding errors +- Improved API descriptions regarding errors ## [2.5.1] - 2023-04-28 + ### Changed + - Replaced Discovery Service mock with real implementation ## [2.5.0] - 2023-04-17 + ### Added -- Introduced Batch processing API endpoints. Batch Order is registered and executed for a bunch of globalAssetIds in one call. - - API Endpoint POST Register Batch Order {{IRS_HOST}}/irs/orders - - API Endpoint GET Batch Order {{IRS_HOST}}/irs/orders/:orderId - - API Endpoint GET Batch {{IRS_HOST}}/irs/orders/:orderId/batches/:batchId -- Introduced Environmental- and Social Standards processing API endpoints. - - API Endpoint POST Register job to start an investigation if a given bpn is contained in a part chain {{IRS_HOST}}/ess/bpn/investigations - - API Endpoint GET BPN Investigation {{IRS_HOST}}/ess/bpn/investigations/:id - - API Endpoint POST EDC Notification receive {{IRS_HOST}}/ess/notification/receive +- Introduced Batch processing API endpoints. Batch Order is registered and executed for a bunch of globalAssetIds in one + call. + - API Endpoint POST Register Batch Order {{IRS_HOST}}/irs/orders + - API Endpoint GET Batch Order {{IRS_HOST}}/irs/orders/:orderId + - API Endpoint GET Batch {{IRS_HOST}}/irs/orders/:orderId/batches/:batchId +- Introduced Environmental- and Social Standards processing API endpoints. + - API Endpoint POST Register job to start an investigation if a given bpn is contained in a part chain + {{IRS_HOST}}/ess/bpn/investigations + - API Endpoint GET BPN Investigation {{IRS_HOST}}/ess/bpn/investigations/:id + - API Endpoint POST EDC Notification receive {{IRS_HOST}}/ess/notification/receive ## [2.4.1] - 2023-04-21 + ### Fixed + - Updated spring-boot version to 3.0.6 to fix security issue - change GID in Dockerfile to fix https://github.com/eclipse-tractusx/item-relationship-service/issues/101 - ## [2.4.0] - 2023-03-30 + ### Added -- IRS is now able to cache the EDC catalog. Caching can be disabled via application config. Maximum amount of cached items and item time-to-live can be configured as well. + +- IRS is now able to cache the EDC catalog. Caching can be disabled via application config. Maximum amount of cached + items and item time-to-live can be configured as well. - EDC policies retrieved from contract offer are now added to the contract negotiation ### Changed -- API endpoints have now additional layer of security and require BPN claim in token. Allowed BPN that can access API can be configured with (*env:API_ALLOWED_BPN*) variable. + +- API endpoints have now additional layer of security and require BPN claim in token. Allowed BPN that can access API + can be configured with (*env:API_ALLOWED_BPN*) variable. - Updated Spring Boot dependency to 3.0.5 ### Fixed -- Fixed issue in paging when calling SemanticsHub with some page size configurations +- Fixed issue in paging when calling SemanticsHub with some page size configurations ## [2.3.2] - 2023-03-20 + ### Changed + - Replace pandoc with downdoc for conversion asciidoc to markdown ### Fixed + - In AssemblyPartRelationship the ``measurementUnit`` can be both parsed from both string and object versions - Decode URLs for ``assetId`` to prevent bug that encoded ``assetId`` cannot be found in the catalog ## [2.3.1] - 2023-03-07 + ### Changed + - Updated Spring Boot dependency to 3.0.3 ## [2.3.0] - 2023-02-21 + ### Added -- Introduced new endpoint ``/irs/aspectmodels`` which will list all available aspect models (from semantic hub or locally provided files if present) + +- Introduced new endpoint ``/irs/aspectmodels`` which will list all available aspect models (from semantic hub or + locally provided files if present) ### Fixed + - If Grafana is enabled - dashboards will be automatically imported on startup ### Changed + - Job creation validates ``aspects`` by using models available in semantic hub or locally provided. ## [2.2.1] - 2023-03-15 + ### Fixed -- Property "measurementUnit" of AssemblyPartRelationship can now be a String or a Map. According to the latest model, it is supposed to be a String, but due to varying test data, IRS supports both variants. + +- Property "measurementUnit" of AssemblyPartRelationship can now be a String or a Map. According to the latest model, it + is supposed to be a String, but due to varying test data, IRS supports both variants. - EDC Catalog IDs are now being URL decoded before usage ## [2.2.0] - 2023-01-20 + ### Added + - Added new job parameter flag "lookupBPNs" which toggles lookup of BPN numbers using the configured BPN URL -- Added new summary item "bpnLookups" which tracks completed and failed BPN requests. Excluded these metrics from "asyncFetchedItems" +- Added new summary item "bpnLookups" which tracks completed and failed BPN requests. Excluded these metrics from " + asyncFetchedItems" - Model schema JSON files can now be provided locally as a backup to the Semantic Hub. Use the new ``semanticsHub.localModelDirectory`` config entry to provide a folder with the models. - Added pagination to EDC catalog retrieval. ### Fixed + - BPNs array is now filled correctly when requesting a running job with parameter "returnUncompletedJob=true" ## [2.1.0] - 2023-01-11 + ### Changed + - Change 'jobParameter' to 'parameter' in GET calls in IRS API - Change 'jobStates' to 'states' request parameter in GET call for jobs by states, 'jobStates' is now deprecated - REST clients for DTR, SemHub and BPDM now use their own RestTemplates and configuration - application.yaml received some documentation ## [2.0.0] - 2022-12-09 + ### Added + - Added pagination to GET /irs/jobs endpoint (eg. {{IRS_HOST}}/irs/jobs?page=0&size=10&sort=completedOn,asc) ### Changed + - IRS API now requires 'view_irs' resource access inside Keycloak JWT token. - New 2.0.0 version of IRS API. Main goal was to remove 'job' prefix from attribute names - - change 'jobId' to 'id' in GET and POST calls - - change 'jobState' to 'state' in GET calls - - change 'jobCompleted' to 'completedOn' in GET calls - - change 'jobId' to 'id' and 'jobState' to 'state' in callback URI variables + - change 'jobId' to 'id' in GET and POST calls + - change 'jobState' to 'state' in GET calls + - change 'jobCompleted' to 'completedOn' in GET calls + - change 'jobId' to 'id' and 'jobState' to 'state' in callback URI variables ## [1.6.0] - 2022-11-25 + ### Added + - EDC client implementation (for negotiation and data exchange) - New callback endpoint for EDC (path: /internal/endpoint-data-reference) - Optional trusted port to make internal interfaces only available via that (config: server.trustedPort) ### Removed + - Removed the need for the API wrapper by directly communicating with the EDC control and data plane. ## [1.5.0] - 2022-11-11 + ### Added + - Added new parameters 'startedOn' and 'jobCompleted' to Job status response ### Changed + - Updated Spring Boot to 2.7.5 and Spring Security (Web and OAuth2 Client) dependencies to 5.7.5 due to CVEs - Renamed parameter from 'status' to 'jobState' in Job status response - Time to live for finished jobs is now configurable ## [1.4.0] - 2022-10-28 + ### Added -- Added new 'asPlanned' value for bomLifecycle request parameter - now BomAsPlanned can be traversed by the IRS to build relationships + +- Added new 'asPlanned' value for bomLifecycle request parameter - now BomAsPlanned can be traversed by the IRS to build + relationships ## [1.3.0] - 2022-10-18 + ### Added + - BPDM URL (*env:BPDM_URL*) is now configurable - SemanticsHub URL (*env:SEMANTICSHUB_URL*) and default URNs (*env:SEMANTICSHUB_DEFAULT_URNS*) are now configurable - Added an administration guide covering installation and configuration topics (TRI-593) @@ -417,38 +557,49 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added new optional parameter 'callbackUrl' to Job registration request ### Known knowns -- discovered lack of circuit breaker for communication with submodel server which is not responding (low risk) - will be addressed in future release + +- discovered lack of circuit breaker for communication with submodel server which is not responding (low risk) - will be + addressed in future release ## [1.2.0] - 2022-09-30 + ### Added + - Automatic eclipse dash IP-ticket creation - Automatic cucumber execution based on Tests in Jira ### Fixed + - Update HSTS header configuration (TRI-659) - Encode log output to avoid log forging (TRI-653) - Add missing X-Frame-Options header (TRI-661) - Switching to a distroless Docker base image to avoid vulnerable library (TRI-729) ### Changed + - Update EDC components to version 0.1.1 - Update testdata set to 1.3.2 - Create Tombstone for faulty/null/none BPN ManufactureId - Update aaswrapper to 0.0.7 ## [1.1.0] - 2022-09-12 + ### Added -- **Aspect Model validation** IRS now validates the aspect model responses requested via EDC. JSON schema files are requested on demand using Semantic Hub API. + +- **Aspect Model validation** IRS now validates the aspect model responses requested via EDC. JSON schema files are + requested on demand using Semantic Hub API. - **BPN mapping** IRS job result includes BPNs and the corresponding names. - **Enabled collecting of "Batch" submodels** IRS supports aspect model "Batch" ### Fixed + - **Malformed date-time in IRS job result** (TRI-627) - **Job cleanup process** Jobs are completely deleted after retention period exceeded. (TRI-631) - **IRS job processing** IRS jobs no longer stay stuck in state RUNNING due to malformed URLs. (TRI-675) - **Security fixes** Fixed various security findings. ### Changed + - **IRS monitoring** Added more metrics and improved Grafana dashboards. - **Submodel payload in IRS job response** Submodels are stored as object instead of string. - **CORS** Enabled CORS configuration @@ -458,85 +609,149 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **IRS stability and code quality** - **API docs** - **Test data and upload script** -- **Helm charts** Improved security and performance configurations. Created a All-in-One Helm Chart for IRS which includes all IRS dependencies. Helm Chart is released separately. +- **Helm charts** Improved security and performance configurations. Created a All-in-One Helm Chart for IRS which + includes all IRS dependencies. Helm Chart is released separately. - **Refactor relationship result object of IRS** - **FOSS initial GitHub & code preparation** Change package structure to `org.eclipse.tractusx`. ## [1.0.0] - 2022-07-25 + ### Changed + * **Improved Minio Helmchart** Latest Minio version is used now * **Submodel Information** If requested, the IRS collects submodel information now and adds it to the job result * **Improved job response** The job response object contains all the required fields now with correct values ## [0.9.1] - 2022-06-14 + ### Removed + - **Remove AAS Proxy** The IRS works without the AASProxy component ## [0.9.0] - 2022-04-27 + ### Added -- **Build traceability BoM as built tree** You can now use the IRS to retrieve a BoM tree with lifecycle stage "as built" for serialized components, which are distributed across the Catena-X network. In this release, the tree is being built on the aspects "SerialPartTypization" and "AssemblyPartRelationship". Focus is a tree built in the direction top-down/parent-child. + +- **Build traceability BoM as built tree** You can now use the IRS to retrieve a BoM tree with lifecycle stage "as + built" for serialized components, which are distributed across the Catena-X network. In this release, the tree is + being built on the aspects "SerialPartTypization" and "AssemblyPartRelationship". Focus is a tree built in the + direction top-down/parent-child. - *IRS API v1.0.0* First release of the IRS API. ### Fixed -- **Cloud Agnostic Solution** You have the ability now to deploy the solution on different cloud vendor solutions. We decoupled the application from its former Azure Stack. + +- **Cloud Agnostic Solution** You have the ability now to deploy the solution on different cloud vendor solutions. We + decoupled the application from its former Azure Stack. - **Security fixes** Various security fixes. ### Changed -- **Asynchronous Job Management** Since we cannot rely on a synchronous answer of each request within the network, we provide a job management for this process. + +- **Asynchronous Job Management** Since we cannot rely on a synchronous answer of each request within the network, we + provide a job management for this process. - **AAS Proxy** Requests to Digital Twin Registry are executed via the AAS Proxy. -- **Quality Gate for Release 1** The quality measures were implemented in accordance with the requirements for Release 1. +- **Quality Gate for Release 1** The quality measures were implemented in accordance with the requirements for Release + 1. - **Hotel Budapest catenax-ng** C-X-NG ready using the provided catenax-ng infrastructure. - **SCA Composition Analysis** Enablement of SCA Composition Analysis using Veracode and CodeQl. - **Github Integrations** VeraCode/Dependabot/SonarCloud/CodeQl ### Unresolved -- **Select Aspects you need** You are able to select the needed aspects for which you want to collect the correct endpoint information. + +- **Select Aspects you need** You are able to select the needed aspects for which you want to collect the correct + endpoint information. [Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.4.0...HEAD + [4.4.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.3.0...4.4.0 + [4.3.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.2.0...4.3.0 + [4.2.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.1.0...4.2.0 + [4.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.0.2...4.1.0 + [4.0.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.0.1...4.0.2 + [4.0.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.0.0...4.0.1 + [4.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.5.4...4.0.0 + [3.5.4]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.5.3...3.5.4 + [3.5.3]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.5.2...3.5.3 + [3.5.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.5.1...3.5.2 + [3.5.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.5.0...3.5.1 + [3.5.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.4.1...3.5.0 + [3.4.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.4.0...3.4.1 + [3.4.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.5...3.4.0 + [3.3.5]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.4...3.3.5 + [3.3.4]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.3...3.3.4 + [3.3.3]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.2...3.3.3 + [3.3.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.1...3.3.2 + [3.3.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.0...3.3.1 + [3.3.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.2.1...3.3.0 + [3.2.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.2.0...3.2.1 + [3.2.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.1.0...3.2.0 + [3.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.0.1...3.1.0 + [3.0.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.0.0...3.0.1 + [3.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.6.1...3.0.0 + [2.6.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.6.0...2.6.1 + [2.6.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.5.1...2.6.0 + [2.5.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.5.0...2.5.1 + [2.5.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.4.0...2.5.0 + [2.4.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.4.0...2.4.1 + [2.4.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.3.2...2.4.0 + [2.3.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.3.1...2.3.2 + [2.3.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.3.0...2.3.1 + [2.3.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.2.0...2.3.0 + [2.2.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.2.0...2.2.1 + [2.2.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.1.0...2.2.0 + [2.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.0.0...2.1.0 + [2.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.6.0...2.0.0 + [1.6.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.5.0...1.6.0 + [1.5.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.4.0...1.5.0 + [1.4.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.3.0...1.4.0 + [1.3.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.2.0...1.3.0 + [1.2.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/v1.1.0...1.2.0 + [1.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/v1.0.0...v1.1.0 + [1.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/v0.9.1...v1.0.0 + [0.9.1]: https://github.com/eclipse-tractusx/item-relationship-service/commits/v0.9.1 + [0.9.0]: https://github.com/eclipse-tractusx/item-relationship-service/commits/v0.9.0 From 6909a462dc9f7402df6f63832df8f9a465ccb4db Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 11:51:44 +0100 Subject: [PATCH 021/116] feat(imp):[#214] improve readability --- .../discovery/ConnectorEndpointsService.java | 11 ++++++----- .../discovery/DiscoveryFinderClientImpl.java | 8 +++++--- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/ConnectorEndpointsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/ConnectorEndpointsService.java index 68a2a2abcc..598344df01 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/ConnectorEndpointsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/ConnectorEndpointsService.java @@ -46,26 +46,27 @@ public class ConnectorEndpointsService { @Cacheable(CONNECTOR_ENDPOINT_SERVICE_CACHE_NAME) public List fetchConnectorEndpoints(final String bpn) { + if (StringUtils.isBlank(bpn)) { log.warn("BPN was null, cannot search for any connector endpoints. Returning empty list."); return List.of(); } log.info("Requesting connector endpoints for BPN {}", bpn); - final DiscoveryFinderRequest onlyBpn = new DiscoveryFinderRequest(List.of("bpn")); - final List discoveryEndpoints = discoveryFinderClient.findDiscoveryEndpoints(onlyBpn) - .endpoints(); - final List providedBpn = List.of(bpn); + + final var onlyBpn = new DiscoveryFinderRequest(List.of("bpn")); + final var discoveryEndpoints = discoveryFinderClient.findDiscoveryEndpoints(onlyBpn).endpoints(); final var endpoints = discoveryEndpoints.stream() .flatMap( discoveryEndpoint -> discoveryFinderClient.findConnectorEndpoints( - discoveryEndpoint.endpointAddress(), providedBpn) + discoveryEndpoint.endpointAddress(), List.of(bpn)) .stream() .filter(edcDiscoveryResult -> edcDiscoveryResult.bpn() .equals(bpn)) .map(EdcDiscoveryResult::connectorEndpoint)) .flatMap(List::stream) .toList(); + log.info("Discovered the following endpoints for BPN '{}': '{}'", bpn, String.join(", ", endpoints)); return endpoints; } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java index a9e2ca1507..1f8c52fd0d 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java @@ -65,9 +65,11 @@ public void evictDiscoveryEndpointsCacheValues() { @Override @Retry(name = "registry") public List findConnectorEndpoints(final String endpointAddress, final List bpns) { - final EdcDiscoveryResult[] edcDiscoveryResults = restTemplate.postForObject(endpointAddress, bpns, - EdcDiscoveryResult[].class); - return edcDiscoveryResults == null ? List.of() : List.of(edcDiscoveryResults); + return toList(restTemplate.postForObject(endpointAddress, bpns, EdcDiscoveryResult[].class)); + } + + private static List toList(final T[] arr) { + return arr == null ? List.of() : List.of(arr); } } From 981a7062f816fea4ade86e47fb3ca8ee99362608 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 12:04:28 +0100 Subject: [PATCH 022/116] feat(imp):[#214] fix license header --- .../tractusx/irs/common/util/concurrent/ResultFinder.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index ff82e6a19c..35c22b93bf 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -4,7 +4,7 @@ * 2022: ISTOS GmbH * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * 2022,2023: BOSCH AG - * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional * information regarding copyright ownership. From 641dd6765b9a7482d9e2bb01390e1164e4078a34 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 12:06:18 +0100 Subject: [PATCH 023/116] feat(imp):[#214] fix license header --- .../exceptions/RegistryServiceRuntimeException.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java index b032140b27..8ce90c32f3 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional * information regarding copyright ownership. From 0d2942e43d72ac1e517ccc8f368cbc629525d780 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 12:07:37 +0100 Subject: [PATCH 024/116] feat(imp):[#214] improve readability --- .../DecentralDigitalTwinRegistryService.java | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 9724382916..cb705304e2 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -104,16 +104,21 @@ private List fetchShellDescriptors(final Set final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); calledEndpoints.addAll(connectorEndpoints); - final var service = endpointDataForConnectorsService; + return fetchShellDescriptorsForConnectorEndpoints(bpn, keys, connectorEndpoints); + } + + private List fetchShellDescriptorsForConnectorEndpoints(final String bpn, + final List keys, final List connectorEndpoints) { try { - final var futures = // - service.findEndpointDataForConnectors(connectorEndpoints) - .stream() - .map(edrFuture -> edrFuture.thenCompose( - edr -> supplyAsync(() -> fetchShellDescriptorsForKey(keys, edr)))) - .toList(); + final var futures = endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints) + .stream() + .map(edrFuture -> edrFuture.thenCompose( + edr -> supplyAsync( + () -> fetchShellDescriptorsForKey(keys, + edr)))) + .toList(); return resultFinder.getFastestResult(futures).get(); From d844e70cc8d3c2e9c1d01f3c2042e68823f9b905 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 12:08:54 +0100 Subject: [PATCH 025/116] feat(imp):[#214] fix PMD warning --- .../irs/registryclient/discovery/DiscoveryFinderClientImpl.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java index 1f8c52fd0d..8927db7dd4 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/discovery/DiscoveryFinderClientImpl.java @@ -68,7 +68,7 @@ public List findConnectorEndpoints(final String endpointAddr return toList(restTemplate.postForObject(endpointAddress, bpns, EdcDiscoveryResult[].class)); } - private static List toList(final T[] arr) { + private static List toList(final T... arr) { return arr == null ? List.of() : List.of(arr); } From 6a117ddfdd9a3369191a72b8a641e2c895ad4139 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 13:15:58 +0100 Subject: [PATCH 026/116] feat(imp):[#214] improve readability and add some logging --- .../common/util/concurrent/ResultFinder.java | 37 +++++++++++++------ .../DecentralDigitalTwinRegistryService.java | 20 +++++----- .../EndpointDataForConnectorsService.java | 15 ++++++-- .../DefaultConfigurationTest.java | 4 +- ...centralDigitalTwinRegistryServiceTest.java | 13 ++++--- .../EndpointDataForConnectorsServiceTest.java | 6 +-- 6 files changed, 60 insertions(+), 35 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 35c22b93bf..4acd94a401 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -54,28 +54,39 @@ public class ResultFinder { public CompletableFuture getFastestResult(final List> futures) { if (futures == null || futures.isEmpty()) { + log.warn("Called getFastestResult with empty list of futures"); return CompletableFuture.completedFuture(null); } - final CompletableFuture resultPromise = new CompletableFuture<>(); + log.debug("Trying to get fastest result from list of futures"); + + final CompletableFuture fastestResultPromise = new CompletableFuture<>(); final List exceptions = new ArrayList<>(); final var handledFutures = // - futures.stream() - .map(future -> future.exceptionally(completingExceptionallyCollectingException(exceptions)) - .handle(completingOnFirstSuccessful(resultPromise))) - .toList(); + toArray(futures.stream() + .map(future -> future.exceptionally( + completingExceptionallyCollectingException(exceptions)) + .handle(completingOnFirstSuccessful(fastestResultPromise))) + .toList()); + + allOf(handledFutures).whenComplete((value, ex) -> { + + log.debug("List of futures completed"); - allOf(toArray(handledFutures)).whenComplete((value, ex) -> { if (ex != null) { - resultPromise.completeExceptionally(new CompletionExceptions(exceptions)); - } else if (!resultPromise.isDone()) { - resultPromise.complete(null); + log.error("Exception occurred: " + ex.getMessage(), ex); + fastestResultPromise.completeExceptionally(new CompletionExceptions(exceptions)); + } else if (!fastestResultPromise.isDone()) { + log.debug("Completing"); + fastestResultPromise.complete(null); + } else { + log.debug("Fastest result already found, ignoring the others"); } }); - return resultPromise; + return fastestResultPromise; } private static CompletableFuture[] toArray(final List> handledFutures) { @@ -84,19 +95,22 @@ private static CompletableFuture[] toArray(final List BiFunction completingOnFirstSuccessful( final CompletableFuture resultPromise) { + return (value, throwable) -> { + final boolean notFinishedByOtherFuture = !resultPromise.isDone(); final boolean currentFutureSuccessful = throwable == null && value != null; if (notFinishedByOtherFuture && currentFutureSuccessful) { // first future that completes successfully completes the overall future + log.debug("First future that completed successfully"); resultPromise.complete(value); return true; } else { if (throwable != null) { - log.warn(throwable.getMessage(), throwable); + log.warn("Exception occurred: " + throwable.getMessage(), throwable); throw new CompletionException(throwable.getMessage(), throwable); } return false; @@ -107,6 +121,7 @@ private static BiFunction completingOnFirstSuccessful private static Function completingExceptionallyCollectingException( final List exceptions) { return t -> { + log.error("Exception occurred: " + t.getMessage(), t); exceptions.add(t); throw new CompletionException(t); }; diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index cb705304e2..1ba4860849 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -102,6 +102,9 @@ private List fetchShellDescriptors(final Set log.info("Fetching {} shells for bpn {}", keys.size(), bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); + + log.debug("Found {} connector endpoints for bpn {}", connectorEndpoints.size(), bpn); + calledEndpoints.addAll(connectorEndpoints); return fetchShellDescriptorsForConnectorEndpoints(bpn, keys, connectorEndpoints); @@ -110,15 +113,13 @@ private List fetchShellDescriptors(final Set private List fetchShellDescriptorsForConnectorEndpoints(final String bpn, final List keys, final List connectorEndpoints) { + final EndpointDataForConnectorsService service = endpointDataForConnectorsService; try { - - final var futures = endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints) - .stream() - .map(edrFuture -> edrFuture.thenCompose( - edr -> supplyAsync( - () -> fetchShellDescriptorsForKey(keys, - edr)))) - .toList(); + final var futures = service.createFindEndpointDataForConnectorsFutures(connectorEndpoints) + .stream() + .map(edrFuture -> edrFuture.thenCompose( + edr -> supplyAsync(() -> fetchShellDescriptorsForKey(keys, edr)))) + .toList(); return resultFinder.getFastestResult(futures).get(); @@ -172,7 +173,8 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f private Collection lookupShellIds(final String bpn) { log.info("Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - final var edrFutures = endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints); + final var edrFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( + connectorEndpoints); try { final var futures = edrFutures.stream() diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index ce0b4af72c..dcd407bc9e 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -23,6 +23,8 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; +import static java.util.concurrent.CompletableFuture.supplyAsync; + import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionException; @@ -44,11 +46,12 @@ public class EndpointDataForConnectorsService { private final EdcEndpointReferenceRetriever edcSubmodelFacade; - public List> findEndpointDataForConnectors( + public List> createFindEndpointDataForConnectorsFutures( final List connectorEndpoints) { + log.debug("createFindEndpointDataForConnectorsFutures for connector endpoints: {}", connectorEndpoints); return connectorEndpoints.stream() - .map(connectorEndpoint -> CompletableFuture.supplyAsync( + .map(connectorEndpoint -> supplyAsync( () -> getEndpointReferenceForAsset(connectorEndpoint))) .toList(); } @@ -56,8 +59,12 @@ public List> findEndpointDataForConnect private EndpointDataReference getEndpointReferenceForAsset(final String connector) { log.info("Trying to retrieve EndpointDataReference for connector {}", connector); try { - return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, - DT_REGISTRY_ASSET_VALUE); + final var endpointDataReference = edcSubmodelFacade.getEndpointReferenceForAsset(connector, + DT_REGISTRY_ASSET_TYPE, DT_REGISTRY_ASSET_VALUE); + + log.debug("Got EndpointDataReference for connector {}", connector); + + return endpointDataReference; } catch (EdcRetrieverException e) { log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); throw new CompletionException(e.getMessage(), e); diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java index d8d96f2f32..c4a8157e30 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/DefaultConfigurationTest.java @@ -87,7 +87,7 @@ void endpointDataForConnectorsService() throws EdcClientException { // ACT final var endpointDataForConnectorsService = testee.endpointDataForConnectorsService(mock); - endpointDataForConnectorsService.findEndpointDataForConnectors(List.of(endpointAddress)) // + endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures(List.of(endpointAddress)) // .forEach(future -> { try { future.get(); @@ -107,7 +107,7 @@ void endpointDataForConnectorsService_withException() throws EdcClientException final var endpointDataForConnectorsService = testee.endpointDataForConnectorsService(mock); final var dummyEndpoints = List.of("test"); - endpointDataForConnectorsService.findEndpointDataForConnectors(dummyEndpoints).forEach(future -> { + endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures(dummyEndpoints).forEach(future -> { assertThatThrownBy(future::get).isInstanceOf(ExecutionException.class) .extracting(Throwable::getCause) .isInstanceOf(EdcRetrieverException.class); diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index 9a4addddb8..b98efe1a24 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -91,7 +91,7 @@ void shouldReturnExpectedShell() throws RegistryServiceException { when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); final var endpointDataRefFutures = List.of(completedFuture(endpointDataReference)); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn( + when(endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures(anyList())).thenReturn( endpointDataRefFutures); when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), @@ -120,8 +120,8 @@ void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedExce final var dataRefFutures = List.of( // completedFuture(endpointDataReference("url.to.host1")), // completedFuture(endpointDataReference("url.to.host2"))); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).thenReturn( - dataRefFutures); + when(endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( + connectorEndpoints)).thenReturn(dataRefFutures); when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); @@ -152,8 +152,8 @@ void whenExecutionExceptionOccurs() { when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(connectorEndpoints); final var dataRefFutures = List.of(completedFuture(endpointDataReference("url.to.host"))); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(connectorEndpoints)).thenReturn( - dataRefFutures); + when(endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( + connectorEndpoints)).thenReturn(dataRefFutures); when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); @@ -217,7 +217,8 @@ void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { .result(List.of(digitalTwinRegistryKey.shellId())) .build(); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("address")); - when(endpointDataForConnectorsService.findEndpointDataForConnectors(anyList())).thenReturn(dataRefFutures); + when(endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures(anyList())).thenReturn( + dataRefFutures); when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java index 20a2a07654..a18e672bf8 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsServiceTest.java @@ -66,7 +66,7 @@ void shouldReturnExpectedEndpointDataReference() throws EdcRetrieverException { DT_REGISTRY_ASSET_VALUE)).thenReturn(CONNECTION_ONE_DATA_REF); // WHEN - final List> endpointDataReferences = sut.findEndpointDataForConnectors( + final List> endpointDataReferences = sut.createFindEndpointDataForConnectorsFutures( Collections.singletonList(connectionOneAddress)); // THEN @@ -93,7 +93,7 @@ void shouldReturnExpectedEndpointDataReferenceFromSecondConnectionEndpoint() thr // WHEN final List> dataRefFutures = // - sut.findEndpointDataForConnectors(List.of(connectionOneAddress, // (1) + sut.createFindEndpointDataForConnectorsFutures(List.of(connectionOneAddress, // (1) connectionTwoAddress // (2) )); @@ -132,7 +132,7 @@ void shouldThrowExceptionWhenConnectorEndpointsNotReachable() throws EdcRetrieve // THEN final List connectorEndpoints = List.of(connectionOneAddress, connectionTwoAddress); - sut.findEndpointDataForConnectors(connectorEndpoints) // + sut.createFindEndpointDataForConnectorsFutures(connectorEndpoints) // .forEach(future -> { try { future.get(); From 8137cd215c3b6aae5ac8e1f57199d45da7b50519 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 14:05:40 +0100 Subject: [PATCH 027/116] feat(imp):[#214] improve readability --- .../irs/common/util/concurrent/ResultFinder.java | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 4acd94a401..78089f6646 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -64,14 +64,12 @@ public CompletableFuture getFastestResult(final List final List exceptions = new ArrayList<>(); - final var handledFutures = // - toArray(futures.stream() - .map(future -> future.exceptionally( - completingExceptionallyCollectingException(exceptions)) - .handle(completingOnFirstSuccessful(fastestResultPromise))) - .toList()); + final var futuresList = futures.stream() + .map(future -> future.exceptionally(collectingExceptionsAndThrow(exceptions)) + .handle(completingOnFirstSuccessful(fastestResultPromise))) + .toList(); - allOf(handledFutures).whenComplete((value, ex) -> { + allOf(toArray(futuresList)).whenComplete((value, ex) -> { log.debug("List of futures completed"); @@ -118,8 +116,7 @@ private static BiFunction completingOnFirstSuccessful }; } - private static Function completingExceptionallyCollectingException( - final List exceptions) { + private static Function collectingExceptionsAndThrow(final List exceptions) { return t -> { log.error("Exception occurred: " + t.getMessage(), t); exceptions.add(t); From f080d72bf50b597d336c2bef1e37fc40b8afda93 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 14:06:05 +0100 Subject: [PATCH 028/116] feat(imp):[#214] add some logging --- .../DecentralDigitalTwinRegistryService.java | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 1ba4860849..12aaed2f99 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -130,11 +130,14 @@ private List fetchShellDescriptorsForConnect } catch (ExecutionException e) { throw new RegistryServiceRuntimeException( "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + } finally { + log.debug("End fetchShellDescriptorsForConnectorEndpoints"); } } private List fetchShellDescriptorsForKey( final List keys, final EndpointDataReference endpointDataReference) { + log.info("Fetching shell descriptors for keys {}", keys); return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); } @@ -142,7 +145,7 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa final DigitalTwinRegistryKey key) { log.info("Retrieving AAS Identification for DigitalTwinRegistryKey: {}", key); final String aaShellIdentification = mapToShellId(endpointDataReference, key.shellId()); - + log.debug("aaShellIdentification: {}", aaShellIdentification); return decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(endpointDataReference, aaShellIdentification); } @@ -173,14 +176,15 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f private Collection lookupShellIds(final String bpn) { log.info("Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - final var edrFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( - connectorEndpoints); + log.debug("Looking up shell ids for bpn {} with connector endpoints {}", bpn, connectorEndpoints); + final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( + connectorEndpoints); try { - final var futures = edrFutures.stream() - .map(edrFuture -> edrFuture.thenCompose( - edr -> supplyAsync(() -> lookupShellIds(bpn, edr)))) - .toList(); + final var futures = endpointDataReferenceFutures.stream() + .map(edrFuture -> edrFuture.thenCompose( + edr -> supplyAsync(() -> lookupShellIds(bpn, edr)))) + .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); log.info("Found {} shell id(s) in total", shellIds.size()); @@ -197,6 +201,7 @@ private Collection lookupShellIds(final String bpn) { } private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { + log.debug("lookupShellIds for bpn {} with endpointDataReference {}", bpn, endpointDataReference); return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(endpointDataReference, List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); } From fe1f7c5552c98b25004c31a6fe027ae6339ad5c2 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 18 Jan 2024 14:43:24 +0100 Subject: [PATCH 029/116] feat(irs-registry-client): Add wiremock tests for decentral registry and discovery service --- irs-registry-client/pom.xml | 6 + ...igitalTwinRegistryServiceWiremockTest.java | 201 +++++++++++++++ .../decentral/DtrWiremockConfig.java | 239 ++++++++++++++++++ irs-testing/pom.xml | 17 ++ pom.xml | 4 +- 5 files changed, 465 insertions(+), 2 deletions(-) create mode 100644 irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java create mode 100644 irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java diff --git a/irs-registry-client/pom.xml b/irs-registry-client/pom.xml index 9621ea237e..7c9a483a26 100644 --- a/irs-registry-client/pom.xml +++ b/irs-registry-client/pom.xml @@ -53,6 +53,12 @@ org.springframework.boot spring-boot-starter-web provided + + + snakeyaml + org.yaml + + org.yaml diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java new file mode 100644 index 0000000000..279aa091a5 --- /dev/null +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -0,0 +1,201 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.registryclient.decentral; + +import static com.github.tomakehurst.wiremock.client.WireMock.exactly; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; +import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.DATAPLANE_URL; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.DISCOVERY_FINDER_PATH; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.DISCOVERY_FINDER_URL; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.EDC_DISCOVERY_PATH; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.LOOKUP_SHELLS_PATH; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.SHELL_DESCRIPTORS_PATH; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.TEST_BPN; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getLookupShells200; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getLookupShells200Empty; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getLookupShells404; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getShellDescriptor200; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getShellDescriptor404; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postDiscoveryFinder404; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postEdcDiscovery200; +import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postEdcDiscovery404; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import java.net.InetSocketAddress; +import java.net.Proxy; +import java.util.Collection; +import java.util.List; +import java.util.Map; + +import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; +import com.github.tomakehurst.wiremock.junit5.WireMockTest; +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; +import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; +import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; +import org.eclipse.tractusx.irs.registryclient.discovery.DiscoveryFinderClientImpl; +import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.http.client.SimpleClientHttpRequestFactory; +import org.springframework.web.client.HttpClientErrorException; +import org.springframework.web.client.RestTemplate; + +@WireMockTest +class DecentralDigitalTwinRegistryServiceWiremockTest { + private static final String PROXY_SERVER_HOST = "127.0.0.1"; + private final EdcEndpointReferenceRetriever edcSubmodelFacadeMock = mock(EdcEndpointReferenceRetriever.class); + private DecentralDigitalTwinRegistryService decentralDigitalTwinRegistryService; + + @BeforeEach + void setUp(WireMockRuntimeInfo wireMockRuntimeInfo) throws EdcRetrieverException { + // Configure RestTemplate to proxy all requests to localhost + final int httpPort = wireMockRuntimeInfo.getHttpPort(); + final Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(PROXY_SERVER_HOST, httpPort)); + final SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); + requestFactory.setProxy(proxy); + final var restTemplate = new RestTemplate(requestFactory); + + final var discoveryFinderClient = new DiscoveryFinderClientImpl(DISCOVERY_FINDER_URL, restTemplate); + final var connectorEndpointsService = new ConnectorEndpointsService(discoveryFinderClient); + final var endpointDataForConnectorsService = new EndpointDataForConnectorsService(edcSubmodelFacadeMock); + final var decentralDigitalTwinRegistryClient = new DecentralDigitalTwinRegistryClient(restTemplate, + SHELL_DESCRIPTORS_TEMPLATE, LOOKUP_SHELLS_TEMPLATE); + decentralDigitalTwinRegistryService = new DecentralDigitalTwinRegistryService(connectorEndpointsService, + endpointDataForConnectorsService, decentralDigitalTwinRegistryClient); + final var endpointDataReference = EndpointDataReference.Builder.newInstance() + .endpoint(DATAPLANE_URL) + .authCode("TEST") + .authKey("X-API-KEY") + .properties(Map.of()) + .build(); + when(edcSubmodelFacadeMock.getEndpointReferenceForAsset(any(), any(), any())).thenReturn(endpointDataReference); + } + + @Test + void shouldDiscoverEDCAndRequestRegistry() throws RegistryServiceException { + // Arrange + givenThat(postDiscoveryFinder200()); + givenThat(postEdcDiscovery200()); + givenThat(getLookupShells200()); + givenThat(getShellDescriptor200()); + + // Act + final Collection assetAdministrationShellDescriptors = decentralDigitalTwinRegistryService.fetchShells( + List.of(new DigitalTwinRegistryKey("testId", TEST_BPN))); + + // Assert + assertThat(assetAdministrationShellDescriptors).hasSize(1); + assertThat(assetAdministrationShellDescriptors.stream().findFirst().get().getSubmodelDescriptors()).hasSize(3); + verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); + verify(exactly(1), getRequestedFor(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*"))); + } + + @Test + void shouldThrowHttpClientExceptionInCaseOfDiscoveryError() { + // Arrange + givenThat(postDiscoveryFinder404()); + final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); + + // Act & Assert + assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( + HttpClientErrorException.class); + verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + } + + @Test + void shouldThrowHttpClientExceptionInCaseOfEdcDiscoveryError() { + // Arrange + givenThat(postDiscoveryFinder200()); + givenThat(postEdcDiscovery404()); + final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); + + // Act & Assert + assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( + HttpClientErrorException.class); + verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + } + + @Test + void shouldThrowHttpClientExceptionInCaseOfLookupShellsError() { + // Arrange + givenThat(postDiscoveryFinder200()); + givenThat(postEdcDiscovery200()); + givenThat(getLookupShells404()); + final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); + + // Act & Assert + assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( + HttpClientErrorException.class); + verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); + } + + @Test + void shouldThrowHttpClientExceptionInCaseOfShellDescriptorsError() { + // Arrange + givenThat(postDiscoveryFinder200()); + givenThat(postEdcDiscovery200()); + givenThat(getLookupShells200()); + givenThat(getShellDescriptor404()); + final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); + + // Act & Assert + assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( + HttpClientErrorException.class); + verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); + verify(exactly(1), getRequestedFor(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*"))); + } + + @Test + void shouldThrowExceptionOnEmptyShells() { + // Arrange + givenThat(postDiscoveryFinder200()); + givenThat(postEdcDiscovery200()); + givenThat(getLookupShells200Empty()); + givenThat(getShellDescriptor404()); + final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); + + // Act & Assert + assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( + HttpClientErrorException.class); + verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); + verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); + } +} diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java new file mode 100644 index 0000000000..00f1719e82 --- /dev/null +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java @@ -0,0 +1,239 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.registryclient.decentral; + +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; + +import java.util.List; + +import com.github.tomakehurst.wiremock.client.MappingBuilder; +import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder; + +public class DtrWiremockConfig { + public static final String SHELL_DESCRIPTORS_PATH = "/shell-descriptors/"; + public static final String SHELL_DESCRIPTORS_TEMPLATE = SHELL_DESCRIPTORS_PATH + "{aasIdentifier}"; + public static final String LOOKUP_SHELLS_PATH = "/lookup/shells"; + public static final String LOOKUP_SHELLS_TEMPLATE = LOOKUP_SHELLS_PATH + "?assetIds={assetIds}"; + public static final String DISCOVERY_FINDER_PATH = "/discoveryFinder"; + public static final String EDC_DISCOVERY_PATH = "/edcDiscovery"; + public static final String TEST_BPN = "BPNL00000000TEST"; + public static final String DISCOVERY_HOST = "http://discovery.finder"; + public static final String DATAPLANE_URL = "http://dataplane.test"; + public static final String DISCOVERY_FINDER_URL = DISCOVERY_HOST + DISCOVERY_FINDER_PATH; + + static ResponseDefinitionBuilder responseWithStatus(final int statusCode) { + return aResponse().withStatus(statusCode).withHeader("Content-Type", "application/json;charset=UTF-8"); + } + + static MappingBuilder getShellDescriptor200() { + final String materialForRecycling = submodel("https://dataplane.test/api/public/data/", + "urn:uuid:19b0338f-6d03-4198-b3b8-5c43f8958d60", "https://controlplane.test", "MaterialForRecycling", + "urn:uuid:cf06d5d5-e3f8-4bd4-bfcf-81815310701f", + "urn:bamm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling"); + + final String batch = submodel("https://dataplane.test/api/public/data/", + "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", "https://controlplane.test", "Batch", + "urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf", "urn:samm:io.catenax.batch:2.0.0#Batch"); + + final String singleLevelUsageAsBuilt = submodel("https://dataplane.test/api/public/data/", + "urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26", "https://controlplane.test", "SingleLevelUsageAsBuilt", + "urn:uuid:e2899f43-eca8-4aec-b877-4a69691f0487", + "urn:bamm:io.catenax.single_level_usage_as_built:2.0.0#SingleLevelUsageAsBuilt"); + + final List submodelDescriptors = List.of(materialForRecycling, batch, singleLevelUsageAsBuilt); + final List specificAssetIds = List.of(specificAssetId("manufacturerId", "BPNL00000003B0Q0"), + specificAssetId("batchId", "BID12345678")); + return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn(responseWithStatus(200).withBody( + assetAdministrationShell(submodelDescriptors, "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", + "EngineeringPlastics", "urn:uuid:9ce43b21-75e3-4cea-b13e-9a34f4f6822a", specificAssetIds))); + } + + public static String assetAdministrationShell(final List submodelDescriptors, final String globalAssetId, + final String idShort, final String shellId, final List specificAssetIds) { + return """ + { + "description": [], + "displayName": [], + "globalAssetId": "%s", + "idShort": "%s", + "id": "%s", + "specificAssetIds": [ + %s + ], + "submodelDescriptors": [ + %s + ] + } + """.formatted(globalAssetId, idShort, shellId, String.join(",\n", specificAssetIds), + String.join(",\n", submodelDescriptors)); + } + + public static String specificAssetId(final String key, final String value) { + return """ + { + "supplementalSemanticIds": [], + "name": "%s", + "value": "%s", + "externalSubjectId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "BPNL00000001CRHK" + } + ] + } + } + """.formatted(key, value); + } + + public static String submodel(final String dataplaneUrl, final String assetId, final String dspEndpoint, + final String idShort, final String submodelDescriptorId, final String semanticId) { + final String href = dataplaneUrl + submodelDescriptorId; + return """ + { + "endpoints": [ + { + "interface": "SUBMODEL-3.0", + "protocolInformation": { + "href": "%s", + "endpointProtocol": "HTTP", + "endpointProtocolVersion": [ + "1.1" + ], + "subprotocol": "DSP", + "subprotocolBody": "id=%s;dspEndpoint=%s", + "subprotocolBodyEncoding": "plain", + "securityAttributes": [ + { + "type": "NONE", + "key": "NONE", + "value": "NONE" + } + ] + } + } + ], + "idShort": "%s", + "id": "%s", + "semanticId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "%s" + } + ] + }, + "supplementalSemanticId": [], + "description": [], + "displayName": [] + } + """.formatted(href, assetId, dspEndpoint, idShort, submodelDescriptorId, semanticId); + } + + static MappingBuilder postEdcDiscovery200() { + return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn( + responseWithStatus(200).withBody(edcDiscovery("BPNL00000000TEST", List.of("http://edc.test/edc")))); + } + + public static String edcDiscovery(final String bpn, final List connectorEndpoints) { + return """ + [ + { + "bpn": "%s", + "connectorEndpoint": [ + %s + ] + } + ] + """.formatted(bpn, String.join(",\n", connectorEndpoints.stream().map(s -> "\"" + s + "\"").toList())); + } + + static MappingBuilder postDiscoveryFinder200() { + return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn( + responseWithStatus(200).withBody(discoveryFinder("http://discovery.finder/edcDiscovery"))); + } + + public static String discoveryFinder(final String discoveryFinderUrl) { + return """ + { + "endpoints": [ + { + "type": "bpn", + "description": "Service to discover EDC to a particular BPN", + "endpointAddress": "%s", + "documentation": "http://.../swagger/index.html", + "resourceId": "316417cd-0fb5-4daf-8dfa-8f68125923f1" + } + ] + } + """.formatted(discoveryFinderUrl); + } + + private static String discoveryFinderEmtpy() { + return """ + { + "endpoints": [ + ] + } + """; + } + + static MappingBuilder postDiscoveryFinder404() { + return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn(responseWithStatus(404)); + } + + static MappingBuilder postEdcDiscovery404() { + return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn(responseWithStatus(404)); + } + + static MappingBuilder getLookupShells200() { + return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(200).withBody( + lookupShells(List.of("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf")))); + } + + static MappingBuilder getLookupShells200Empty() { + return get(urlPathMatching(LOOKUP_SHELLS_PATH + ".*")).willReturn( + responseWithStatus(200).withBody(lookupShells(List.of()))); + } + + public static String lookupShells(final List shellIds) { + return """ + { + "paging_metadata": {}, + "result": [ + %s + ] + } + """.formatted(String.join(",\n", shellIds.stream().map(s -> "\"" + s + "\"").toList())); + } + + static MappingBuilder getLookupShells404() { + return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(404)); + } + + static MappingBuilder getShellDescriptor404() { + return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn(responseWithStatus(404)); + } +} \ No newline at end of file diff --git a/irs-testing/pom.xml b/irs-testing/pom.xml index 4bff31d728..f4b7d8dd81 100644 --- a/irs-testing/pom.xml +++ b/irs-testing/pom.xml @@ -69,11 +69,23 @@ net.datafaker datafaker ${datafaker.version} + + + snakeyaml + org.yaml + + org.eclipse.tractusx.irs irs-models ${irs-registry-client.version} + + + snakeyaml + org.yaml + + com.fasterxml.jackson.datatype @@ -91,5 +103,10 @@ org.testcontainers junit-jupiter + + org.wiremock + wiremock-standalone + ${wiremock-standalone.version} + diff --git a/pom.xml b/pom.xml index 0201230116..1fa66ecbcd 100644 --- a/pom.xml +++ b/pom.xml @@ -73,7 +73,7 @@ - 1.5.1-SNAPSHOT + 1.5.2-SNAPSHOT 3.1.6 @@ -94,7 +94,7 @@ 0.2.1 3.5.0 1.76 - 3.2.0 + 3.3.1 23.1.0 1.16.1 0.12.0 From 18dd6ed58f672b210d7a9555106b53e22b348ff1 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 15:16:06 +0100 Subject: [PATCH 030/116] feat(imp):[#214] fix PMD warning --- .../tractusx/irs/common/util/concurrent/ResultFinder.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 78089f6646..655494eb1b 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -76,11 +76,11 @@ public CompletableFuture getFastestResult(final List if (ex != null) { log.error("Exception occurred: " + ex.getMessage(), ex); fastestResultPromise.completeExceptionally(new CompletionExceptions(exceptions)); - } else if (!fastestResultPromise.isDone()) { + } else if (fastestResultPromise.isDone()) { + log.debug("Fastest result already found, ignoring the others"); + } else { log.debug("Completing"); fastestResultPromise.complete(null); - } else { - log.debug("Fastest result already found, ignoring the others"); } }); From 1eab989da152dc795f0989c612e6ec6c3881194e Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 15:28:04 +0100 Subject: [PATCH 031/116] feat(imp):[#214] update arc42 documentation --- .../cross-cutting/discovery-process-dtr.adoc | 197 ++++++++++++++++++ .../arc42/cross-cutting/under-the-hood.adoc | 88 +++++--- docs/src/docs/arc42/glossary.adoc | 5 + 3 files changed, 266 insertions(+), 24 deletions(-) create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc diff --git a/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc b/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc new file mode 100644 index 0000000000..43349184bf --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc @@ -0,0 +1,197 @@ +The Dataspace Discovery Service handles multiple EDC-Urls received for BPN. +This applies to the following scenarios: + +==== Scenarios + +===== EDC with multiple DTRs + +IRS queries all DTRs for the globalAssetId and will take the first result it gets. +If none of the DTRs return a result, IRS will create a tombstone. + +[plantuml,target=discovery-DTR--EDC-with-multiple-DTRs,format=svg] +---- +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider" as EDCProvider +participant "DTR 1" as DTR1 +participant "DTR 2" as DTR2 + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 1 EDC +IRS ->> EDCProvider: Query for DTR contract offer +EDCProvider ->> IRS: 2 DTR contract offers + +par QueryDTR1 + IRS ->> EDCProvider: Negotiate contract + IRS ->> DTR1: Query for DT + DTR1 ->> IRS: no DT +end + +par QueryDTR2 + IRS ->> EDCProvider: Negotiate contract + IRS ->> DTR2: Query for DT + DTR2 ->> IRS: DT +end +@enduml +---- + +===== Multiple EDCs with one DTR + +IRS starts a contract negotiation for all registry contract offers in parallel and queries the DTRs for all successful negotiations. +The first registry which responds with a DT will be the one used by IRS. + +[plantuml,target=discovery-DTR--multiple-EDCs-with-one-DTR,format=svg] +---- +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider 1" as EDCProvider1 +participant "EDC Provider 2" as EDCProvider2 +participant "EDC Provider 3" as EDCProvider3 +participant DTR + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 3 EDCs + +par CatalogRequestEDC1 + IRS ->> EDCProvider1: Query for DTR contract offer + EDCProvider1 ->> IRS: No offer +end + +par CatalogRequestEDC2 + IRS ->> EDCProvider2: Query for DTR contract offer + EDCProvider2 ->> IRS: No offer +end + +par CatalogRequestEDC3 + IRS ->> EDCProvider3: Query for DTR contract offer + EDCProvider3 ->> IRS: DTR contract offer + IRS -> EDCProvider3: Negotiate contract + IRS ->> DTR: Query for DT + DTR ->> IRS: DT +end +@enduml +---- + +===== One EDC with one DTR + +Only one EDC found for BPN and the catalog only contains one offer for the DTR. +IRS will use this registry and will create a tombstone if no DT could be found for the globalAssetId. + +[plantuml,target=discovery-DTR--one-EDC-with-one-DTR,format=svg] +---- +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider 3" as EDCProvider3 +participant DTR + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 1 EDC +IRS ->> EDCProvider3: Query for DTR contract offer +EDCProvider3 ->> IRS: DTR contract offer +IRS -> EDCProvider3: Negotiate contract +IRS ->> DTR: Query for DT +DTR ->> IRS: DT +@enduml +---- + +===== Multiple EDCs with multiple DTRs + +IRS starts a contract negotiation for all the registry offers. + +[plantuml,target=discovery-DTR--multiple-EDCs-with-multiple-DTRs,format=svg] +---- +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider 1" as EDCProvider1 +participant "EDC Provider 2" as EDCProvider2 +participant "EDC Provider 3" as EDCProvider3 +participant "DTR" as DTR + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 3 EDCs + +par CatalogRequestEDC1 + IRS ->> EDCProvider1: Query for DTR contract offer + EDCProvider1 ->> IRS: No offer +end + +par CatalogRequestEDC2 + IRS ->> EDCProvider2: Query for DTR contract offer + EDCProvider2 ->> IRS: DTR contract offer + IRS -> EDCProvider2: Negotiate contract + IRS ->> DTR: Query for DT + DTR ->> IRS: DT +end + +par CatalogRequestEDC3 + IRS ->> EDCProvider3: Query for DTR contract offer + EDCProvider3 ->> IRS: DTR contract offer + IRS -> EDCProvider3: Negotiate contract + IRS ->> DTR: Query for DT + DTR ->> IRS: No DT +end +@enduml +---- + +===== Multiple EDCs with no DTRs + +IRS starts a contract negotiation for all the registry offers and creates a tombstone since no DTR could be discovered. + +[plantuml,target=discovery-DTR--multiple-EDCs-with-no-DTRs,format=svg] +---- +@startuml +actor IRS +actor "Discovery Service" as DiscoveryService +participant "EDC 1" as EDCProvider1 +participant "EDC 2" as EDCProvider2 +participant "EDC 3" as EDCProvider3 + +IRS -> DiscoveryService: Get EDCs for BPN +DiscoveryService -> IRS: Return list of 3 EDCs + +par Catalog Request to EDC 1 + IRS -> EDCProvider1: Query for DTR contract offer + EDCProvider1 -> IRS: No offer +end + +and Catalog Request to EDC 2 + IRS -> EDCProvider2: Query for DTR contract offer + EDCProvider2 -> IRS: No offer +end + +and Catalog Request to EDC 3 + IRS -> EDCProvider3: Query for DTR contract offer + EDCProvider3 -> IRS: No offer +end + +IRS -> IRS: Tombstone +@enduml +---- + +==== Special Scenarios + +===== Same DT in multiple DTRs + +IRS will use all registries to query for the globalAssetId and takes the first result which is returned. +If no DT could be found in any of the DTRs, IRS will create a tombstone. + +===== Multiple DTs (with the same globalAssetId) in one DTR + +IRS uses the `/query` endpoint of the DTR to get the DT id based on the globalAssetId. +If more than one id is present for a globalAssetId, IRS will use the first of the list. + +[plantuml,target=discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR,format=svg] +---- +@startuml +actor IRS +participant DTR + +IRS -> DTR: /query for globalAssetId +DTR -> IRS: return list of two results +IRS -> IRS: use first +@enduml +---- diff --git a/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc b/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc index aaa8440e10..cb3ba4db52 100644 --- a/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc +++ b/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc @@ -1,82 +1,115 @@ = "Under-the-hood" concepts == Persistence + The IRS stores two types of data in a persistent way: - Job metadata - Job payloads, e.g. AAS shells or submodel data -All of this is data is stored in an object store. The currently used implementation is Minio (Amazon S3 compatible). -This reduces the complexity in storing and retrieving data. There also is no predefined model for the data, every document can be stored as it is. +All of this is data is stored in an object store. +The currently used implementation is Minio (Amazon S3 compatible). +This reduces the complexity in storing and retrieving data. +There also is no predefined model for the data, every document can be stored as it is. The downside of this approach is lack of query functionality, as we can only search through the keys of the entries but not based on the value data. In the future, another approach or an additional way to to index the data might be required. -To let the data survive system restarts, Minio needs to use a persistent volume for the data storage. A default configuration for this is provided in the Helm charts. +To let the data survive system restarts, Minio needs to use a persistent volume for the data storage. +A default configuration for this is provided in the Helm charts. == Transaction handling + There currently is no transaction management in the IRS. == Session handling + There is no session handling in the IRS, access is solely based on bearer tokens, the API is stateless. == Communication and integration -All interfaces to other systems are using RESTful calls over HTTP(S). Where central authentication is required, a common OAuth2 provider is used. + +All interfaces to other systems are using RESTful calls over HTTP(S). +Where central authentication is required, a common OAuth2 provider is used. For outgoing calls, the Spring RestTemplate mechanism is used and separate RestTemplates are created for the different ways of authentication. For incoming calls, we utilize the Spring REST Controller mechanism, annotating the interfaces accordingly and also documenting the endpoints using OpenAPI annotations. == Exception and error handling + There are two types of potential errors in the IRS: === Technical errors -Technical errors occur when there is a problem with the application itself, its configuration or directly connected infrastructure, e.g. the Minio persistence. Usually, the application cannot solve these problems by itself and requires some external support (manual work or automated recovery mechanisms, e.g. Kubernetes liveness probes). + +Technical errors occur when there is a problem with the application itself, its configuration or directly connected infrastructure, e.g. the Minio persistence. +Usually, the application cannot solve these problems by itself and requires some external support (manual work or automated recovery mechanisms, e.g. Kubernetes liveness probes). These errors are printed mainly to the application log and are relevant for the healthchecks. === Functional errors -Functional errors occur when there is a problem with the data that is being processed or external systems are unavailable and data cannot be sent / fetched as required for the process. While the system might not be able to provide the required function at that moment, it may work with a different dataset or as soon as the external systems recover. + +Functional errors occur when there is a problem with the data that is being processed or external systems are unavailable and data cannot be sent / fetched as required for the process. +While the system might not be able to provide the required function at that moment, it may work with a different dataset or as soon as the external systems recover. These errors are reported in the Job response and do not directly affect application health. === Rules for exception handling + ==== Throw or log, don't do both -When catching an exception, either log the exception and handle the problem or rethrow it, so it can be handled at a higher level of the code. By doing both, an exception might be written to the log multiple times, which can be confusing. + +When catching an exception, either log the exception and handle the problem or rethrow it, so it can be handled at a higher level of the code. +By doing both, an exception might be written to the log multiple times, which can be confusing. ==== Write own base exceptions for (internal) interfaces -By defining a common (checked) base exception for an interface, the caller is forced to handle potential errors, but can keep the logic simple. On the other hand, you still have the possibility to derive various, meaningful exceptions for different error cases, which can then be thrown via the API. + +By defining a common (checked) base exception for an interface, the caller is forced to handle potential errors, but can keep the logic simple. +On the other hand, you still have the possibility to derive various, meaningful exceptions for different error cases, which can then be thrown via the API. Of course, when using only RuntimeExceptions, this is not necessary - but those can be overlooked quite easily, so be careful there. ==== Central fallback exception handler -There will always be some exception that cannot be handled inside of the code correctly - or it may just have been unforeseen. A central fallback exception handler is required so all problems are visible in the log and the API always returns meaningful responses. In some cases, this is as simple as a HTTP 500. + +There will always be some exception that cannot be handled inside of the code correctly - or it may just have been unforeseen. +A central fallback exception handler is required so all problems are visible in the log and the API always returns meaningful responses. +In some cases, this is as simple as a HTTP 500. ==== Dont expose too much exception details over API -It's good to inform the user, why their request did not work, but only if they can do something about it (HTTP 4xx). So in case of application problems, you should not expose details of the problem to the caller. This way, we avoid opening potential attack vectors. -== Parallelization and threading -The heart of the IRS is the parallel execution of planned jobs. As almost each job requires multiple calls to various endpoints, those are done in parallel as well to reduce the total execution time for each job. +It's good to inform the user, why their request did not work, but only if they can do something about it (HTTP 4xx). +So in case of application problems, you should not expose details of the problem to the caller. +This way, we avoid opening potential attack vectors. -Tasks execution is orchestrated by the JobOrchestrator class. It utilizes a central ExecutorService, which manages the number of threads and schedules new Task as they come in. +== Parallelization and threading +The heart of the IRS is the parallel execution of planned jobs. +As almost each job requires multiple calls to various endpoints, those are done in parallel as well to reduce the total execution time for each job. +Tasks execution is orchestrated by the JobOrchestrator class. +It utilizes a central ExecutorService, which manages the number of threads and schedules new Task as they come in. == Plausibility checks and validation + Data validation happens at two points: -- IRS API: the data sent by the client is validated to match the model defined in the IRS. If the validation fails, the IRS sends a HTTP 400 response and indicates the problem to the caller. +- IRS API: the data sent by the client is validated to match the model defined in the IRS. +If the validation fails, the IRS sends a HTTP 400 response and indicates the problem to the caller. - Submodel payload: each time a submodel payload is requested from via EDC, the data is validated against the model defined in the SemanticHub for the matching aspect type. -- EDC Contract Offer Policy: each time IRS consumes data over the EDC, the policies of the offered contract will be validated. IDs of so-called "Rahmenverträgen" or Framework-Agreements can be added to the IRS Policy Store to be accepted by the IRS. If a Contract Offer does not match any of the IDs store in Policy Store, the contract offer will be declined and no data will be consumed. +- EDC Contract Offer Policy: each time IRS consumes data over the EDC, the policies of the offered contract will be validated. +IDs of so-called "Rahmenverträgen" or Framework-Agreements can be added to the IRS Policy Store to be accepted by the IRS. +If a Contract Offer does not match any of the IDs store in Policy Store, the contract offer will be declined and no data will be consumed. == Policy Store -The IRS gives its users the ability to manage, create and delete complex policies containing permissions and constraints in order to obtain the most precise control over access and use of data received from the edc provider. Policies stored in Policy Store will serve as input with allowed restriction and will be checked against every item from EDC Catalog. +The IRS gives its users the ability to manage, create and delete complex policies containing permissions and constraints in order to obtain the most precise control over access and use of data received from the edc provider. +Policies stored in Policy Store will serve as input with allowed restriction and will be checked against every item from EDC Catalog. -The structure of a Policy that can be stored in storage can be easily viewed by using Policy Store endpoints in the published API documentation. Each policy may contain more than one permission, which in turn consists of constraints linked together by AND or OR relationships. This model provides full flexibility and control over stored access and use policies. +The structure of a Policy that can be stored in storage can be easily viewed by using Policy Store endpoints in the published API documentation. +Each policy may contain more than one permission, which in turn consists of constraints linked together by AND or OR relationships. +This model provides full flexibility and control over stored access and use policies. == Digital Twin / EDC requirements -In order to work with the decentral network approach, IRS requires the Digital Twin to contain a `"subprotocolBody"` in each of the submodelDescriptor endpoints. This `"subprotocolBody"` has to contain the `"id"` of the EDC asset, as well as the `"dspEndpoint"` of the EDC, separated by a semicolon (e.g. `"subprotocolBody": "id=123;dspEndpoint=http://edc.control.plane/api/v1/dsp"`). +In order to work with the decentral network approach, IRS requires the Digital Twin to contain a `"subprotocolBody"` in each of the submodelDescriptor endpoints. +This `"subprotocolBody"` has to contain the `"id"` of the EDC asset, as well as the `"dspEndpoint"` of the EDC, separated by a semicolon (e.g. `"subprotocolBody": "id=123;dspEndpoint=http://edc.control.plane/api/v1/dsp"`). The `"dspEndpoint"` is used to request the EDC catalog of the dataprovider and the `"id"` to filter for the exact asset inside this catalog. @@ -94,7 +127,8 @@ Whenever a BPN is resolved via BPDM, the partner name is cached on IRS side, as === Semantics Hub -Whenever a semantic model schema is requested from the Semantic Hub, it is stored locally until the cache is evicted (configurable). The IRS can preload configured schema models on startup to reduce on demand call times. +Whenever a semantic model schema is requested from the Semantic Hub, it is stored locally until the cache is evicted (configurable). +The IRS can preload configured schema models on startup to reduce on demand call times. Additionally, models can be deployed with the system as a backup to the real Semantic Hub service. @@ -109,18 +143,24 @@ The time to live for both caches can be configured separately as described in th Further information on Discovery Service can be found in the chapter "System scope and context". +== Discovery Process + +=== Digital Twin Registry + +include::discovery-process-dtr.adoc[] + === EDC EndpointDataReferenceStorage is in-memory local storage that holds records (EndpointDataReferences) by either assetId or contractAgreementId. When EDC gets EndpointDataReference describing endpoint serving data it uses EndpointDataReferenceStorage and query it by assetId. -This allows reuse of already existing EndpointDataReference if it is present, valid, and it's token is not expired, -rather than starting whole new contract negotiation process. +This allows reuse of already existing EndpointDataReference if it is present, valid, and it's token is not expired, rather than starting whole new contract negotiation process. -In case token is expired the process is also shortened. We don't have to start new contract negotiation process, -since we can obtain required contractAgreementId from present authCode. This improves request processing time. +In case token is expired the process is also shortened. +We don't have to start new contract negotiation process, since we can obtain required contractAgreementId from present authCode. +This improves request processing time. -[source, mermaid] +[source,mermaid] .... sequenceDiagram autonumber diff --git a/docs/src/docs/arc42/glossary.adoc b/docs/src/docs/arc42/glossary.adoc index 9fb18f3da7..68eb016e89 100644 --- a/docs/src/docs/arc42/glossary.adoc +++ b/docs/src/docs/arc42/glossary.adoc @@ -7,9 +7,14 @@ |Aspect servers (submodel endpoints) |Companies participating in the interorganizational data exchange provides their data over aspect servers. The so called "submodel-descriptors" in the AAS shells are pointing to these AspectServers which provide the data-assets of the participating these companies in Catena-X. |BoM |Bill of Materials +|BPN | Business Partner Number +|DT | Digital Twin +|DTR | Digital Twin Registry. The Digital Twin Registry is the central registry which lists all digital twins and references their aspects including information about the underlying asset, asset manufacturer, and access options (e.g. aspect endpoints). +|EDC | Eclipse Dataspace Connector |Edge |see Traversal Aspect |IRS |Item Relationship Service |Item Graph |The result returned via the IRS. This corresponds to a tree structure in which each node represents a part of a virtual asset. +|MIW | Managed Identity Wallet |MTPDC |Formerly known Service Name: Multi Tier Parts Data Chain |PRS |Formerly known Service Name: Parts Relationship Service |Traversal Aspect |aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship. From e3ebc1ed502120550958209e405f1b6ace1e9144 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 16:35:45 +0100 Subject: [PATCH 032/116] feat(imp):[#214] correct PlantUML diagrams --- ...discovery-DTR--EDC-with-multiple-DTRs.puml | 28 +++ ...ith-the-same-globalAssedId-in-one-DTR.puml | 8 + ...DTR--multiple-EDCs-with-multiple-DTRs.puml | 38 ++++ ...overy-DTR--multiple-EDCs-with-no-DTRs.puml | 34 ++++ ...overy-DTR--multiple-EDCs-with-one-DTR.puml | 35 ++++ .../discovery-DTR--one-EDC-with-one-DTR.puml | 14 ++ .../cross-cutting/discovery-process-dtr.adoc | 190 +++--------------- 7 files changed, 186 insertions(+), 161 deletions(-) create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-DTR--EDC-with-multiple-DTRs.puml create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR.puml create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-multiple-DTRs.puml create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-no-DTRs.puml create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-one-DTR.puml create mode 100644 docs/src/docs/arc42/cross-cutting/discovery-DTR--one-EDC-with-one-DTR.puml diff --git a/docs/src/docs/arc42/cross-cutting/discovery-DTR--EDC-with-multiple-DTRs.puml b/docs/src/docs/arc42/cross-cutting/discovery-DTR--EDC-with-multiple-DTRs.puml new file mode 100644 index 0000000000..0689cd80a5 --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-DTR--EDC-with-multiple-DTRs.puml @@ -0,0 +1,28 @@ +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider" as EDCProvider +participant "DTR 1" as DTR1 +participant "DTR 2" as DTR2 + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 1 EDC +IRS ->> EDCProvider: Query for DTR contract offer +EDCProvider ->> IRS: 2 DTR contract offers + +par + group Query DTR 1 + IRS ->> EDCProvider: Negotiate contract + IRS ->> DTR1: Query for DT + DTR1 ->> IRS: no DT + end + + else + + group Query DTR 2 + IRS ->> EDCProvider: Negotiate contract + IRS ->> DTR2: Query for DT + DTR2 ->> IRS: DT + end +end +@enduml \ No newline at end of file diff --git a/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR.puml b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR.puml new file mode 100644 index 0000000000..5956218ecc --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR.puml @@ -0,0 +1,8 @@ +@startuml +actor IRS +participant DTR + +IRS -> DTR: /query for globalAssetId +DTR -> IRS: return list of two results +IRS -> IRS: use first +@enduml diff --git a/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-multiple-DTRs.puml b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-multiple-DTRs.puml new file mode 100644 index 0000000000..be20fd8964 --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-multiple-DTRs.puml @@ -0,0 +1,38 @@ +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider 1" as EDCProvider1 +participant "EDC Provider 2" as EDCProvider2 +participant "EDC Provider 3" as EDCProvider3 +participant "DTR" as DTR + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 3 EDCs + +par + group CatalogRequestEDC1 + IRS ->> EDCProvider1: Query for DTR contract offer + EDCProvider1 ->> IRS: No offer + end + + else + + group CatalogRequestEDC2 + IRS ->> EDCProvider2: Query for DTR contract offer + EDCProvider2 ->> IRS: DTR contract offer + IRS -> EDCProvider2: Negotiate contract + IRS ->> DTR: Query for DT + DTR ->> IRS: DT + end + + else + + group CatalogRequestEDC3 + IRS ->> EDCProvider3: Query for DTR contract offer + EDCProvider3 ->> IRS: DTR contract offer + IRS -> EDCProvider3: Negotiate contract + IRS ->> DTR: Query for DT + DTR ->> IRS: No DT + end +end +@enduml diff --git a/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-no-DTRs.puml b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-no-DTRs.puml new file mode 100644 index 0000000000..aaed9497b2 --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-no-DTRs.puml @@ -0,0 +1,34 @@ +@startuml +actor IRS +actor "Discovery Service" as DiscoveryService + +participant "EDC 1" as EDCProvider1 +participant "EDC 2" as EDCProvider2 +participant "EDC 3" as EDCProvider3 + +IRS -> DiscoveryService: Get EDCs for BPN +DiscoveryService -> IRS: Return list of 3 EDCs + +par + group Catalog Request to EDC 1 + IRS -> EDCProvider1: Query for DTR contract offer + EDCProvider1 -> IRS: No offer + end + + else + + group Catalog Request to EDC 2 + IRS -> EDCProvider2: Query for DTR contract offer + EDCProvider2 -> IRS: No offer + end + + else + + group Catalog Request to EDC 3 + IRS -> EDCProvider3: Query for DTR contract offer + EDCProvider3 -> IRS: No offer + end +end + +IRS -> IRS: Tombstone +@enduml diff --git a/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-one-DTR.puml b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-one-DTR.puml new file mode 100644 index 0000000000..f70cc4ac49 --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-DTR--multiple-EDCs-with-one-DTR.puml @@ -0,0 +1,35 @@ +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider 1" as EDCProvider1 +participant "EDC Provider 2" as EDCProvider2 +participant "EDC Provider 3" as EDCProvider3 +participant DTR + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 3 EDCs + +par + group CatalogRequestEDC1 + IRS ->> EDCProvider1: Query for DTR contract offer + EDCProvider1 ->> IRS: No offer + end + + else + + group CatalogRequestEDC2 + IRS ->> EDCProvider2: Query for DTR contract offer + EDCProvider2 ->> IRS: No offer + end + + else + + group CatalogRequestEDC3 + IRS ->> EDCProvider3: Query for DTR contract offer + EDCProvider3 ->> IRS: DTR contract offer + IRS -> EDCProvider3: Negotiate contract + IRS ->> DTR: Query for DT + DTR ->> IRS: DT + end +end +@enduml \ No newline at end of file diff --git a/docs/src/docs/arc42/cross-cutting/discovery-DTR--one-EDC-with-one-DTR.puml b/docs/src/docs/arc42/cross-cutting/discovery-DTR--one-EDC-with-one-DTR.puml new file mode 100644 index 0000000000..8b3277445d --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/discovery-DTR--one-EDC-with-one-DTR.puml @@ -0,0 +1,14 @@ +@startuml +participant IRS +participant DiscoveryService +participant "EDC Provider 3" as EDCProvider3 +participant DTR + +IRS ->> DiscoveryService: Get EDCs for BPN +DiscoveryService ->> IRS: Return list of 1 EDC +IRS ->> EDCProvider3: Query for DTR contract offer +EDCProvider3 ->> IRS: DTR contract offer +IRS -> EDCProvider3: Negotiate contract +IRS ->> DTR: Query for DT +DTR ->> IRS: DT +@enduml diff --git a/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc b/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc index 43349184bf..adc17688e3 100644 --- a/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc +++ b/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc @@ -1,197 +1,65 @@ The Dataspace Discovery Service handles multiple EDC-Urls received for BPN. This applies to the following scenarios: -==== Scenarios - -===== EDC with multiple DTRs +==== Scenario 1: EDC with multiple DTRs IRS queries all DTRs for the globalAssetId and will take the first result it gets. If none of the DTRs return a result, IRS will create a tombstone. [plantuml,target=discovery-DTR--EDC-with-multiple-DTRs,format=svg] ----- -@startuml -participant IRS -participant DiscoveryService -participant "EDC Provider" as EDCProvider -participant "DTR 1" as DTR1 -participant "DTR 2" as DTR2 - -IRS ->> DiscoveryService: Get EDCs for BPN -DiscoveryService ->> IRS: Return list of 1 EDC -IRS ->> EDCProvider: Query for DTR contract offer -EDCProvider ->> IRS: 2 DTR contract offers - -par QueryDTR1 - IRS ->> EDCProvider: Negotiate contract - IRS ->> DTR1: Query for DT - DTR1 ->> IRS: no DT -end - -par QueryDTR2 - IRS ->> EDCProvider: Negotiate contract - IRS ->> DTR2: Query for DT - DTR2 ->> IRS: DT -end -@enduml ----- - -===== Multiple EDCs with one DTR +.... +include::discovery-DTR--EDC-with-multiple-DTRs.puml[] +.... + +==== Scenario 2: Multiple EDCs with one DTR IRS starts a contract negotiation for all registry contract offers in parallel and queries the DTRs for all successful negotiations. The first registry which responds with a DT will be the one used by IRS. [plantuml,target=discovery-DTR--multiple-EDCs-with-one-DTR,format=svg] ----- -@startuml -participant IRS -participant DiscoveryService -participant "EDC Provider 1" as EDCProvider1 -participant "EDC Provider 2" as EDCProvider2 -participant "EDC Provider 3" as EDCProvider3 -participant DTR - -IRS ->> DiscoveryService: Get EDCs for BPN -DiscoveryService ->> IRS: Return list of 3 EDCs - -par CatalogRequestEDC1 - IRS ->> EDCProvider1: Query for DTR contract offer - EDCProvider1 ->> IRS: No offer -end - -par CatalogRequestEDC2 - IRS ->> EDCProvider2: Query for DTR contract offer - EDCProvider2 ->> IRS: No offer -end - -par CatalogRequestEDC3 - IRS ->> EDCProvider3: Query for DTR contract offer - EDCProvider3 ->> IRS: DTR contract offer - IRS -> EDCProvider3: Negotiate contract - IRS ->> DTR: Query for DT - DTR ->> IRS: DT -end -@enduml ----- - -===== One EDC with one DTR +.... +include::discovery-DTR--multiple-EDCs-with-one-DTR.puml[] +.... + +==== Scenario 3: One EDC with one DTR Only one EDC found for BPN and the catalog only contains one offer for the DTR. IRS will use this registry and will create a tombstone if no DT could be found for the globalAssetId. [plantuml,target=discovery-DTR--one-EDC-with-one-DTR,format=svg] ----- -@startuml -participant IRS -participant DiscoveryService -participant "EDC Provider 3" as EDCProvider3 -participant DTR - -IRS ->> DiscoveryService: Get EDCs for BPN -DiscoveryService ->> IRS: Return list of 1 EDC -IRS ->> EDCProvider3: Query for DTR contract offer -EDCProvider3 ->> IRS: DTR contract offer -IRS -> EDCProvider3: Negotiate contract -IRS ->> DTR: Query for DT -DTR ->> IRS: DT -@enduml ----- - -===== Multiple EDCs with multiple DTRs +.... +include::discovery-DTR--one-EDC-with-one-DTR.puml[] +.... + +==== Scenario 4: Multiple EDCs with multiple DTRs IRS starts a contract negotiation for all the registry offers. [plantuml,target=discovery-DTR--multiple-EDCs-with-multiple-DTRs,format=svg] ----- -@startuml -participant IRS -participant DiscoveryService -participant "EDC Provider 1" as EDCProvider1 -participant "EDC Provider 2" as EDCProvider2 -participant "EDC Provider 3" as EDCProvider3 -participant "DTR" as DTR - -IRS ->> DiscoveryService: Get EDCs for BPN -DiscoveryService ->> IRS: Return list of 3 EDCs - -par CatalogRequestEDC1 - IRS ->> EDCProvider1: Query for DTR contract offer - EDCProvider1 ->> IRS: No offer -end - -par CatalogRequestEDC2 - IRS ->> EDCProvider2: Query for DTR contract offer - EDCProvider2 ->> IRS: DTR contract offer - IRS -> EDCProvider2: Negotiate contract - IRS ->> DTR: Query for DT - DTR ->> IRS: DT -end - -par CatalogRequestEDC3 - IRS ->> EDCProvider3: Query for DTR contract offer - EDCProvider3 ->> IRS: DTR contract offer - IRS -> EDCProvider3: Negotiate contract - IRS ->> DTR: Query for DT - DTR ->> IRS: No DT -end -@enduml ----- - -===== Multiple EDCs with no DTRs +.... +include::discovery-DTR--multiple-EDCs-with-multiple-DTRs.puml[] +.... + +==== Scenario 5: Multiple EDCs with no DTRs IRS starts a contract negotiation for all the registry offers and creates a tombstone since no DTR could be discovered. [plantuml,target=discovery-DTR--multiple-EDCs-with-no-DTRs,format=svg] ----- -@startuml -actor IRS -actor "Discovery Service" as DiscoveryService -participant "EDC 1" as EDCProvider1 -participant "EDC 2" as EDCProvider2 -participant "EDC 3" as EDCProvider3 - -IRS -> DiscoveryService: Get EDCs for BPN -DiscoveryService -> IRS: Return list of 3 EDCs - -par Catalog Request to EDC 1 - IRS -> EDCProvider1: Query for DTR contract offer - EDCProvider1 -> IRS: No offer -end - -and Catalog Request to EDC 2 - IRS -> EDCProvider2: Query for DTR contract offer - EDCProvider2 -> IRS: No offer -end - -and Catalog Request to EDC 3 - IRS -> EDCProvider3: Query for DTR contract offer - EDCProvider3 -> IRS: No offer -end - -IRS -> IRS: Tombstone -@enduml ----- - -==== Special Scenarios +.... +include::discovery-DTR--multiple-EDCs-with-no-DTRs.puml[] +.... -===== Same DT in multiple DTRs +==== Special Scenario: Same DT in multiple DTRs IRS will use all registries to query for the globalAssetId and takes the first result which is returned. If no DT could be found in any of the DTRs, IRS will create a tombstone. -===== Multiple DTs (with the same globalAssetId) in one DTR +==== Special Scenario: Multiple DTs (with the same globalAssetId) in one DTR IRS uses the `/query` endpoint of the DTR to get the DT id based on the globalAssetId. If more than one id is present for a globalAssetId, IRS will use the first of the list. [plantuml,target=discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR,format=svg] ----- -@startuml -actor IRS -participant DTR - -IRS -> DTR: /query for globalAssetId -DTR -> IRS: return list of two results -IRS -> IRS: use first -@enduml ----- +.... +include::discovery-DTR--multiple-DTs-with-the-same-globalAssedId-in-one-DTR.puml[] +.... From 4b02479898bcfb8dbea3defa0b0b52aa113bad03 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 16:46:40 +0100 Subject: [PATCH 033/116] feat(imp):[#214] refined arc42 documentation --- docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc b/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc index adc17688e3..10cea2a582 100644 --- a/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc +++ b/docs/src/docs/arc42/cross-cutting/discovery-process-dtr.adoc @@ -1,5 +1,7 @@ The Dataspace Discovery Service handles multiple EDC-Urls received for BPN. -This applies to the following scenarios: +This applies to the following scenarios. + +__Please note that the expression "the first result" in the subsequent sections means the first successful answer.__ ==== Scenario 1: EDC with multiple DTRs From 8cb6954b8cebaae43d2ad57ac6ad63a7e1134728 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 18 Jan 2024 17:23:47 +0100 Subject: [PATCH 034/116] feat(imp):[#214] convert diagram from #256 in arc42 documentation to plantuml because currently we don't support mermaid there --- .../arc42/cross-cutting/under-the-hood.adoc | 59 ++++++++++--------- 1 file changed, 31 insertions(+), 28 deletions(-) diff --git a/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc b/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc index cb3ba4db52..38419e28cc 100644 --- a/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc +++ b/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc @@ -160,34 +160,37 @@ In case token is expired the process is also shortened. We don't have to start new contract negotiation process, since we can obtain required contractAgreementId from present authCode. This improves request processing time. -[source,mermaid] -.... -sequenceDiagram - autonumber - participant EdcSubmodelClient - participant ContractNegotiationService - participant EndpointDataReferenceStorage - participant EdcCallbackController - participant EdcDataPlaneClient - EdcSubmodelClient ->> EndpointDataReferenceStorage: Get EDR Token for EDC asset id - EndpointDataReferenceStorage ->> EdcSubmodelClient: Return Optional - alt Token is present and not expired - EdcSubmodelClient ->> EdcSubmodelClient: Optional.get - else - alt Token is expired - EdcSubmodelClient ->> ContractNegotiationService: Renew EDR Token based on existing Token - else Token is not present - EdcSubmodelClient ->> ContractNegotiationService: Negotiate new EDR Token - end - ContractNegotiationService -->> EdcCallbackController: EDC flow - EdcCallbackController ->> EndpointDataReferenceStorage: Store EDR token by EDC asset id after EDC callback - loop While EDR Token is not present - EdcSubmodelClient ->> EndpointDataReferenceStorage: Poll for EDR Token - end - EndpointDataReferenceStorage ->> EdcSubmodelClient: Return EDR Token +[plantuml,target=discovery-process-edc,format=svg] +---- +@startuml +autonumber +participant EdcSubmodelClient +participant ContractNegotiationService +participant EndpointDataReferenceStorage +participant EdcCallbackController +participant EdcDataPlaneClient + +EdcSubmodelClient ->> EndpointDataReferenceStorage: Get EDR Token for EDC asset id +EndpointDataReferenceStorage -->> EdcSubmodelClient: Return Optional + +alt Token is present and not expired + EdcSubmodelClient ->> EdcSubmodelClient: Optional.get +else + alt Token is expired + EdcSubmodelClient ->> ContractNegotiationService: Renew EDR Token based on existing Token + else Token is not present + EdcSubmodelClient ->> ContractNegotiationService: Negotiate new EDR Token end - EdcSubmodelClient ->> EdcDataPlaneClient: Get data(EDR Token, Dataplane URL) - EdcDataPlaneClient ->> EdcSubmodelClient: Return data -.... + ContractNegotiationService -->> EdcCallbackController: EDC flow + EdcCallbackController ->> EndpointDataReferenceStorage: Store EDR token by EDC asset id after EDC callback + loop While EDR Token is not present + EdcSubmodelClient ->> EndpointDataReferenceStorage: Poll for EDR Token + end + EndpointDataReferenceStorage -->> EdcSubmodelClient: Return EDR Token +end +EdcSubmodelClient ->> EdcDataPlaneClient: Get data(EDR Token, Dataplane URL) +EdcDataPlaneClient -->> EdcSubmodelClient: Return data +@enduml +---- From 62cc323f78637a18f559cef34e391530c5f9adcd Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 23 Jan 2024 17:41:00 +0100 Subject: [PATCH 035/116] feat(irs-api):[#344] Add wiremock test for BpdmFacade --- .../tractusx/irs/bpdm/BpdmWiremockTest.java | 126 ++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java new file mode 100644 index 0000000000..325c97cfd4 --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java @@ -0,0 +1,126 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.bpdm; + +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static org.assertj.core.api.Assertions.assertThat; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; + +import java.util.Optional; + +import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; +import com.github.tomakehurst.wiremock.junit5.WireMockTest; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.web.client.RestTemplate; + +@WireMockTest +class BpdmWiremockTest { + private static final String PROXY_SERVER_HOST = "127.0.0.1"; + private BpdmFacade bpdmFacade; + + @BeforeEach + void setUp(WireMockRuntimeInfo wireMockRuntimeInfo) { + final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); + + bpdmFacade = new BpdmFacade( + new BpdmClientImpl(restTemplate, "http://bpdm.test/legal-entities/{partnerId}?idType={idType}")); + } + + @Test + void shouldResolveManufacturerName() { + // Arrange + givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn( + aResponse().withStatus(200).withHeader("Content-Type", "application/json;charset=UTF-8").withBody(""" + { + "bpn": "BPNL00000000TEST", + "identifiers": [ + { + "value": "BPNL00000000TEST", + "type": { + "technicalKey": "BPN", + "name": "Business Partner Number", + "url": "" + }, + "issuingBody": { + "technicalKey": "CATENAX", + "name": "Catena-X", + "url": "" + }, + "status": { + "technicalKey": "UNKNOWN", + "name": "Unknown" + } + } + ], + "names": [ + { + "value": "TEST_BPN_DFT_1", + "shortName": null, + "type": { + "technicalKey": "OTHER", + "name": "Any other alternative name used for a company, such as a specific language variant.", + "url": "" + }, + "language": { + "technicalKey": "undefined", + "name": "Undefined" + } + } + ], + "legalForm": null, + "status": null, + "profileClassifications": [], + "types": [ + { + "technicalKey": "UNKNOWN", + "name": "Unknown", + "url": "" + } + ], + "bankAccounts": [], + "roles": [], + "relations": [], + "currentness": "2022-07-26T08:17:38.737578Z" + } + """))); + + // Act + final Optional manufacturerName = bpdmFacade.findManufacturerName("BPNL00000000TEST"); + + // Assert + assertThat(manufacturerName).isPresent().contains("TEST_BPN_DFT_1"); + } + + @Test + void shouldReturnEmptyOnNotFound() { + // Arrange + givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn( + aResponse().withStatus(404).withHeader("Content-Type", "application/json;charset=UTF-8"))); + + // Act + final Optional manufacturerName = bpdmFacade.findManufacturerName("BPNL00000000TEST"); + + // Assert + assertThat(manufacturerName).isEmpty(); + } +} From 57e09cda7cbf027b70a1ff2ea162b285b98c330a Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 23 Jan 2024 17:42:33 +0100 Subject: [PATCH 036/116] feat(irs-api):[#344] Extract WireMockConfig to irs-testing --- irs-testing/pom.xml | 5 ++ .../irs/testing/wiremock/WireMockConfig.java | 47 +++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java diff --git a/irs-testing/pom.xml b/irs-testing/pom.xml index f4b7d8dd81..7370be9eca 100644 --- a/irs-testing/pom.xml +++ b/irs-testing/pom.xml @@ -34,6 +34,7 @@ + org.springframework.boot @@ -53,6 +54,10 @@ + + org.springframework.boot + spring-boot-starter-web + net.minidev diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java new file mode 100644 index 0000000000..9ff8b9562c --- /dev/null +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java @@ -0,0 +1,47 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.testing.wiremock; + +import java.net.InetSocketAddress; +import java.net.Proxy; + +import org.springframework.http.client.SimpleClientHttpRequestFactory; +import org.springframework.web.client.RestTemplate; + +/** + * Common configurations for Wiremock tests. + */ +public final class WireMockConfig { + private WireMockConfig() { + } + + /** + * Configured RestTemplate which proxies all requests to the provided host / port. + * + * @param proxyServerHost the host where all requests will be proxied to + * @param httpPort the port of the host where all requests will be proxied to + * @return the configured {@link RestTemplate} + */ + public static RestTemplate restTemplateProxy(final String proxyServerHost, final int httpPort) { + final Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(proxyServerHost, httpPort)); + final SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); + requestFactory.setProxy(proxy); + return new RestTemplate(requestFactory); + } +} From 302ddd2be944e09979206af6467c3fc748766f2f Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 23 Jan 2024 17:43:49 +0100 Subject: [PATCH 037/116] feat(irs-api):[#344] Extract WireMockConfig to irs-testing --- ...centralDigitalTwinRegistryServiceWiremockTest.java | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index 279aa091a5..e00704f8c8 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -45,12 +45,11 @@ import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postDiscoveryFinder404; import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postEdcDiscovery200; import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postEdcDiscovery404; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -import java.net.InetSocketAddress; -import java.net.Proxy; import java.util.Collection; import java.util.List; import java.util.Map; @@ -65,7 +64,6 @@ import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.springframework.http.client.SimpleClientHttpRequestFactory; import org.springframework.web.client.HttpClientErrorException; import org.springframework.web.client.RestTemplate; @@ -77,12 +75,7 @@ class DecentralDigitalTwinRegistryServiceWiremockTest { @BeforeEach void setUp(WireMockRuntimeInfo wireMockRuntimeInfo) throws EdcRetrieverException { - // Configure RestTemplate to proxy all requests to localhost - final int httpPort = wireMockRuntimeInfo.getHttpPort(); - final Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(PROXY_SERVER_HOST, httpPort)); - final SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); - requestFactory.setProxy(proxy); - final var restTemplate = new RestTemplate(requestFactory); + final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); final var discoveryFinderClient = new DiscoveryFinderClientImpl(DISCOVERY_FINDER_URL, restTemplate); final var connectorEndpointsService = new ConnectorEndpointsService(discoveryFinderClient); From d819516cdf71e9a7eeeff08c83ffbfa97b6e66e8 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 23 Jan 2024 17:45:09 +0100 Subject: [PATCH 038/116] feat(edc-client):[#344] Extend SubmodelFacadeWiremockTest --- .../client/SubmodelFacadeWiremockTest.java | 40 +++++++------------ 1 file changed, 15 insertions(+), 25 deletions(-) diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java index 80aba6ad4d..7471135414 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java @@ -34,6 +34,7 @@ import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration.NAMESPACE_EDC_CID; import static org.eclipse.tractusx.irs.edc.client.testutil.TestMother.createEdcTransformer; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; @@ -49,6 +50,8 @@ import com.fasterxml.jackson.databind.ObjectMapper; import com.github.tomakehurst.wiremock.WireMockServer; +import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; +import com.github.tomakehurst.wiremock.junit5.WireMockTest; import io.github.resilience4j.retry.RetryRegistry; import org.assertj.core.api.ThrowableAssert; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; @@ -74,23 +77,23 @@ import org.springframework.web.client.RestClientException; import org.springframework.web.client.RestTemplate; +@WireMockTest class SubmodelFacadeWiremockTest { + private static final String PROXY_SERVER_HOST = "127.0.0.1"; private final static String connectorEndpoint = "https://connector.endpoint.com"; private final static String submodelDataplanePath = "/api/public/shells/12345/submodels/5678/submodel"; + private final static String submodelDataplaneUrl = "http://dataplane.test" + submodelDataplanePath; private final static String assetId = "12345"; private final EdcConfiguration config = new EdcConfiguration(); private final EndpointDataReferenceStorage storage = new EndpointDataReferenceStorage(Duration.ofMinutes(1)); - private WireMockServer wireMockServer; private EdcSubmodelClient edcSubmodelClient; private AcceptedPoliciesProvider acceptedPoliciesProvider; @BeforeEach - void configureSystemUnderTest() { - this.wireMockServer = new WireMockServer(options().dynamicPort()); - this.wireMockServer.start(); - configureFor(this.wireMockServer.port()); + void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { + final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); - config.getControlplane().getEndpoint().setData(buildApiMethodUrl()); + config.getControlplane().getEndpoint().setData("http://controlplane.test"); config.getControlplane().getEndpoint().setCatalog("/catalog/request"); config.getControlplane().getEndpoint().setContractNegotiation("/contractnegotiations"); config.getControlplane().getEndpoint().setTransferProcess("/transferprocesses"); @@ -99,7 +102,6 @@ void configureSystemUnderTest() { config.getControlplane().setProviderSuffix("/api/v1/dsp"); config.getSubmodel().setUrnPrefix("/urn"); - final RestTemplate restTemplate = new RestTemplateBuilder().build(); final List> messageConverters = restTemplate.getMessageConverters(); for (final HttpMessageConverter converter : messageConverters) { if (converter instanceof final MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter) { @@ -135,11 +137,6 @@ void configureSystemUnderTest() { pollingService, retryRegistry, catalogFacade, endpointDataReferenceCacheService); } - @AfterEach - void tearDown() { - this.wireMockServer.stop(); - } - @Test void shouldReturnAssemblyPartRelationshipAsString() throws EdcClientException, ExecutionException, InterruptedException { @@ -152,7 +149,7 @@ void shouldReturnAssemblyPartRelationshipAsString() "singleLevelBomAsBuilt.json"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), + final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get(); // Assert @@ -224,7 +221,7 @@ void shouldReturnMaterialForRecyclingAsString() "materialForRecycling.json"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), + final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get(); // Assert @@ -242,7 +239,7 @@ void shouldReturnObjectAsStringWhenResponseNotJSON() .withBody("test"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), + final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get(); // Assert @@ -271,7 +268,7 @@ void shouldThrowExceptionWhenPoliciesAreNotAccepted() { // Act & Assert final String errorMessage = "Consumption of asset '58505404-4da1-427a-82aa-b79482bcd1f0' is not permitted as the required catalog offer policies do not comply with defined IRS policies."; assertThatExceptionOfType(UsagePolicyException.class).isThrownBy( - () -> edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), assetId) + () -> edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId) .get()).withMessageEndingWith(errorMessage); } @@ -286,7 +283,7 @@ void shouldThrowExceptionWhenResponse_400() { // Act final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( - connectorEndpoint, buildWiremockDataplaneUrl(), assetId).get(5, TimeUnit.SECONDS); + connectorEndpoint, submodelDataplaneUrl, assetId).get(5, TimeUnit.SECONDS); // Assert assertThatExceptionOfType(ExecutionException.class).isThrownBy(throwingCallable) @@ -304,20 +301,13 @@ void shouldThrowExceptionWhenResponse_500() { // Act final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( - connectorEndpoint, buildWiremockDataplaneUrl(), assetId).get(5, TimeUnit.SECONDS); + connectorEndpoint, submodelDataplaneUrl, assetId).get(5, TimeUnit.SECONDS); // Assert assertThatExceptionOfType(ExecutionException.class).isThrownBy(throwingCallable) .withCauseInstanceOf(RestClientException.class); } - private String buildWiremockDataplaneUrl() { - return buildApiMethodUrl() + submodelDataplanePath; - } - - private String buildApiMethodUrl() { - return String.format("http://localhost:%d", this.wireMockServer.port()); - } private org.eclipse.tractusx.irs.edc.client.policy.Policy policy(String policyId, List permissions) { return new org.eclipse.tractusx.irs.edc.client.policy.Policy(policyId, OffsetDateTime.now(), From 588b7bd403e0fe1ab87dd5cc81da40593492ff0c Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 23 Jan 2024 17:45:50 +0100 Subject: [PATCH 039/116] feat(edc-client):[#344] Extend SemanticHubWiremockTest --- .../semanticshub/SemanticHubWiremockTest.java | 29 +++++++------------ 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java index 738a1d9373..1106c18891 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java @@ -29,44 +29,35 @@ import static com.github.tomakehurst.wiremock.client.WireMock.get; import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; import static org.assertj.core.api.Assertions.assertThat; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; -import com.github.tomakehurst.wiremock.WireMockServer; +import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; +import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.eclipse.tractusx.irs.configuration.SemanticsHubConfiguration; import org.eclipse.tractusx.irs.services.validation.SchemaNotFoundException; -import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.web.client.RestTemplate; +@WireMockTest class SemanticHubWiremockTest { - private WireMockServer wireMockServer; - + private static final String PROXY_SERVER_HOST = "127.0.0.1"; private SemanticsHubFacade semanticsHubFacade; - private SemanticsHubConfiguration config; @BeforeEach - void configureSystemUnderTest() { - this.wireMockServer = new WireMockServer(options().dynamicPort()); - this.wireMockServer.start(); - configureFor(this.wireMockServer.port()); + void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { + final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); - config = new SemanticsHubConfiguration(); + final SemanticsHubConfiguration config = new SemanticsHubConfiguration(); config.setPageSize(10); - config.setUrl(String.format("http://localhost:%d/models", this.wireMockServer.port())); - config.setModelJsonSchemaEndpoint("sem.hub/models/{urn}/json-schema"); + config.setUrl("http://semantic.hub/models"); + config.setModelJsonSchemaEndpoint("http://semantic.hub/models/{urn}/json-schema"); - final RestTemplate restTemplate = new RestTemplate(); final SemanticsHubClient semanticsHubClient = new SemanticsHubClientImpl(restTemplate, config); semanticsHubFacade = new SemanticsHubFacade(semanticsHubClient); } - @AfterEach - void tearDown() { - this.wireMockServer.stop(); - } - @Test void shouldReturn1Page() throws SchemaNotFoundException { givenThat(get(urlPathEqualTo("/models")).willReturn(aResponse().withStatus(200) From 4125ea90b7b6d212a90a84cf4f2b219ca83a7524 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 23 Jan 2024 17:47:10 +0100 Subject: [PATCH 040/116] feat(edc-client):[#344] Add IrsWireMock integration test --- .../irs/configuration/RestTemplateConfig.java | 2 + .../eclipse/tractusx/irs/IrsWireMockIT.java | 150 +++++ .../tractusx/irs/WireMockTestConfig.java | 83 +++ .../resources/__files/all-models-page-IT.json | 554 ++++++++++++++++++ 4 files changed, 789 insertions(+) create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java create mode 100644 irs-api/src/test/resources/__files/all-models-page-IT.json diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java index faf99e94ea..991d81498e 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java @@ -41,6 +41,7 @@ import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpRequest; import org.springframework.http.client.ClientHttpRequestExecution; @@ -66,6 +67,7 @@ @Configuration @RequiredArgsConstructor @SuppressWarnings("PMD.ExcessiveImports") +@Profile("!integrationtest") public class RestTemplateConfig { public static final String DTR_REST_TEMPLATE = "dtrRestTemplate"; diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java new file mode 100644 index 0000000000..d7970bdee4 --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java @@ -0,0 +1,150 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2023 + * 2022: ZF Friedrichshafen AG + * 2022: ISTOS GmbH + * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2023: BOSCH AG + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs; + +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.List; + +import com.github.tomakehurst.wiremock.junit5.WireMockTest; +import org.eclipse.tractusx.irs.component.JobHandle; +import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; +import org.eclipse.tractusx.irs.component.RegisterJob; +import org.eclipse.tractusx.irs.component.enums.Direction; +import org.eclipse.tractusx.irs.semanticshub.AspectModels; +import org.eclipse.tractusx.irs.services.IrsItemGraphQueryService; +import org.eclipse.tractusx.irs.services.SemanticHubService; +import org.eclipse.tractusx.irs.services.validation.SchemaNotFoundException; +import org.eclipse.tractusx.irs.testing.containers.MinioContainer; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.context.ApplicationContextInitializer; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.DynamicPropertyRegistry; +import org.springframework.test.context.DynamicPropertySource; +import org.springframework.test.context.support.TestPropertySourceUtils; +import org.testcontainers.junit.jupiter.Testcontainers; + +@WireMockTest(httpPort = 8085) +@Testcontainers +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = WireMockTestConfig.class + /*, properties = "spring.main.allow-bean-definition-overriding=true"*/) +@ContextConfiguration(initializers = IrsWireMockIT.MinioConfigInitializer.class) +//@Import({ WireMockTestConfig.class }) +@ActiveProfiles("integrationtest") +class IrsWireMockIT { + public static final String BPDM_TEST = "http://bpdm.test/legal-entities/{partnerId}?idType={idType}"; + public static final String DISCOVERY_TEST = "http://discovery.test"; + public static final String SEMANTIC_HUB_URL = "http://semantic.hub/models"; + public static final String SEMANTIC_HUB_SCHEMA_URL = "http://semantic.hub/models/{urn}/json-schema"; + private static final String ACCESS_KEY = "accessKey"; + private static final String SECRET_KEY = "secretKey"; + private static final MinioContainer minioContainer = new MinioContainer( + new MinioContainer.CredentialsProvider(ACCESS_KEY, SECRET_KEY)).withReuse(true); + public static final String EDC_URL = "http://edc.test:8081/management"; + @Autowired + private IrsItemGraphQueryService irsService; + + @Autowired + private SemanticHubService semanticHubService; + + @BeforeAll + static void startContainer() { + minioContainer.start(); + givenThat(get(urlPathEqualTo("/models")).willReturn(aResponse().withStatus(200) + .withHeader("Content-Type", + "application/json;charset=UTF-8") + .withBodyFile("all-models-page-IT.json"))); + } + + @AfterAll + static void stopContainer() { + minioContainer.stop(); + } + + @DynamicPropertySource + static void configureProperties(DynamicPropertyRegistry registry) { + registry.add("bpdm.bpnEndpoint", () -> BPDM_TEST); + registry.add("digitalTwinRegistry.discoveryFinderUrl", () -> DISCOVERY_TEST); + registry.add("semanticshub.url", () -> SEMANTIC_HUB_URL); + registry.add("semanticshub.modelJsonSchemaEndpoint", () -> SEMANTIC_HUB_SCHEMA_URL); + registry.add("irs-edc-client.controlplane.endpoint.data", () -> EDC_URL); + } + + @Test + void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundException { + // Act + final AspectModels allAspectModels = semanticHubService.getAllAspectModels(); + + // Assert + assertThat(allAspectModels.models()).hasSize(78); + } + + @Test + void shouldStartJob() { + // Arrange + final RegisterJob request = RegisterJob.builder() + .key(PartChainIdentificationKey.builder() + .bpn("BPNTEST") + .globalAssetId("globalAssetId") + .build()) + .depth(2) + .aspects(List.of("SerialPart", "Batch", "SingleLevelBomAsBuilt")) + .collectAspects(true) + .lookupBPNs(true) + .direction(Direction.DOWNWARD) + .build(); + + // Act + final JobHandle jobHandle = irsService.registerItemJob(request); + + // Assert + assertThat(jobHandle.getId()).isNotNull(); + } + + public static class MinioConfigInitializer + implements ApplicationContextInitializer { + + @Override + public void initialize(ConfigurableApplicationContext applicationContext) { + final String hostAddress = minioContainer.getHostAddress(); + TestPropertySourceUtils.addInlinedPropertiesToEnvironment(applicationContext, + "blobstore.endpoint=http://" + hostAddress, "blobstore.accessKey=" + ACCESS_KEY, + "blobstore.secretKey=" + SECRET_KEY, "policystore.persistence.endpoint=http://" + hostAddress, + "policystore.persistence.accessKey=" + ACCESS_KEY, + "policystore.persistence.secretKey=" + SECRET_KEY, + "policystore.persistence.bucketName=policy-test"); + } + } + +} diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java new file mode 100644 index 0000000000..4e7d14c48a --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java @@ -0,0 +1,83 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs; + +import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.BPDM_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.DISCOVERY_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.DTR_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.EDC_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.NO_ERROR_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.SEMHUB_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; + +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Primary; +import org.springframework.context.annotation.Profile; +import org.springframework.web.client.RestTemplate; + +@TestConfiguration +public class WireMockTestConfig { + public static final int HTTP_PORT = 8085; + private static final String PROXY_SERVER_HOST = "127.0.0.1"; + + @Primary + @Profile("integrationtest") + @Bean(DTR_REST_TEMPLATE) + RestTemplate dtrRestTemplate() { + return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + } + + @Primary + @Profile("integrationtest") + @Bean(EDC_REST_TEMPLATE) + RestTemplate edcRestTemplate() { + return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + } + + @Primary + @Profile("integrationtest") + @Bean(NO_ERROR_REST_TEMPLATE) + RestTemplate noErrorRestTemplate() { + return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + } + + @Primary + @Profile("integrationtest") + @Bean(DISCOVERY_REST_TEMPLATE) + RestTemplate discoveryRestTemplate() { + return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + } + + @Primary + @Profile("integrationtest") + @Bean(BPDM_REST_TEMPLATE) + RestTemplate bpdmRestTemplate() { + return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + } + + @Primary + @Profile("integrationtest") + @Bean(SEMHUB_REST_TEMPLATE) + @Qualifier(SEMHUB_REST_TEMPLATE) + RestTemplate semanticHubRestTemplate() { + return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + } +} diff --git a/irs-api/src/test/resources/__files/all-models-page-IT.json b/irs-api/src/test/resources/__files/all-models-page-IT.json new file mode 100644 index 0000000000..36d2bd6a4a --- /dev/null +++ b/irs-api/src/test/resources/__files/all-models-page-IT.json @@ -0,0 +1,554 @@ +{ + "items": [ + { + "urn": "urn:bamm:io.catenax.asset_tracker_links:1.0.0#AssetTrackerLinks", + "version": "1.0.0", + "name": "AssetTrackerLinks", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.battery.battery_pass:3.0.1#BatteryPass", + "version": "3.0.1", + "name": "BatteryPass", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.battery.product_description:1.0.1#ProductDescription", + "version": "1.0.1", + "name": "ProductDescription", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.bom_as_specified:1.0.0#BomAsSpecified", + "version": "1.0.0", + "name": "BomAsSpecified", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.bom_as_specified:1.0.1#BomAsSpecified", + "version": "1.0.1", + "name": "BomAsSpecified", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.certificate_of_destruction:1.0.1#CertificateOfDestruction", + "version": "1.0.1", + "name": "CertificateOfDestruction", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.classified_load_spectrum:1.0.0#ClassifiedLoadSpectrum", + "version": "1.0.0", + "name": "ClassifiedLoadSpectrum", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.decomissioning_certificate:1.0.0#DecommissioningCertificate", + "version": "1.0.0", + "name": "DecommissioningCertificate", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.eol_story:1.0.0#EndOfLife", + "version": "1.0.0", + "name": "EndOfLife", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.fleet.claim_data:1.0.0#ClaimData", + "version": "1.0.0", + "name": "ClaimData", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.fleet.diagnostic_data:1.0.0#DiagnosticData", + "version": "1.0.0", + "name": "DiagnosticData", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.idconversion:1.0.0#IdConversion", + "version": "1.0.0", + "name": "IdConversion", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.individual_asset_definition:1.0.0#IndividualAssetDefinition", + "version": "1.0.0", + "name": "IndividualAssetDefinition", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.iot_sensor_data:1.0.0#IotSensorData", + "version": "1.0.0", + "name": "IotSensorData", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.iot_sensor_device_definition:1.0.0#IotSensorDeviceDefinition", + "version": "1.0.0", + "name": "IotSensorDeviceDefinition", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.manufactured_parts_quality_information:1.0.0#ManufacturedPartsQualityInformation", + "version": "1.0.0", + "name": "ManufacturedPartsQualityInformation", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.manufacturing_capability:1.0.0#ManufacturingCapability", + "version": "1.0.0", + "name": "ManufacturingCapability", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.market_place_offer:1.2.0#MarketplaceOffer", + "version": "1.2.0", + "name": "MarketplaceOffer", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.market_place_offer:1.4.0#MarketplaceOffer", + "version": "1.4.0", + "name": "MarketplaceOffer", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#MaterialFlowSimulationResult", + "version": "1.0.0", + "name": "MaterialFlowSimulationResult", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.material_for_homologation:1.0.0#MaterialForHomologation", + "version": "1.0.0", + "name": "MaterialForHomologation", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.part_as_specified:1.0.0#PartAsSpecified", + "version": "1.0.0", + "name": "PartAsSpecified", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.part_as_specified:1.0.1#PartAsSpecified", + "version": "1.0.1", + "name": "PartAsSpecified", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.part_as_specified:2.0.0#PartAsSpecified", + "version": "2.0.0", + "name": "PartAsSpecified", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.pcf:2.0.0#Pcf", + "version": "2.0.0", + "name": "Pcf", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.pcf:3.0.0#Pcf", + "version": "3.0.0", + "name": "Pcf", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.pcf:4.0.0#Pcf", + "version": "4.0.0", + "name": "Pcf", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.pcf:4.0.1#Pcf", + "version": "4.0.1", + "name": "Pcf", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.product_stock:1.0.0#ProductStock", + "version": "1.0.0", + "name": "ProductStock", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.quality_task:1.0.0#QualityTask", + "version": "1.0.0", + "name": "QualityTask", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.refurbishing_certificate:1.0.0#RefurbishingCertificate", + "version": "1.0.0", + "name": "RefurbishingCertificate", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.remanufacturing_certificate:1.0.0#RemanufacturingCertificate", + "version": "1.0.0", + "name": "RemanufacturingCertificate", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.return_request:1.1.1#ReturnRequest", + "version": "1.1.1", + "name": "ReturnRequest", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.return_request:1.1.2#ReturnRequest", + "version": "1.1.2", + "name": "ReturnRequest", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.reuse_certificate:1.0.0#ReuseCertificate", + "version": "1.0.0", + "name": "ReuseCertificate", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.rul:1.0.0#RemainingUsefulLife", + "version": "1.0.0", + "name": "RemainingUsefulLife", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.sealant.sealant_pass:1.0.0#SealantPass", + "version": "1.0.0", + "name": "SealantPass", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.address_characteristic:1.0.1#AddressAspect", + "version": "1.0.1", + "name": "AddressAspect", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.address_characteristic:2.0.0#AddressAspect", + "version": "2.0.0", + "name": "AddressAspect", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.contact_information:1.0.0#ContactInformation", + "version": "1.0.0", + "name": "ContactInformation", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.contact_information:2.0.0#ContactInformation", + "version": "2.0.0", + "name": "ContactInformation", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.physical_dimension:1.0.0#PhysicalDimensions", + "version": "1.0.0", + "name": "PhysicalDimensions", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.physical_dimension:2.0.0#PhysicalDimensions", + "version": "2.0.0", + "name": "PhysicalDimensions", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.shared.recycling_strategy_certificate:1.0.0#RecyclingStrategyCertificate", + "version": "1.0.0", + "name": "RecyclingStrategyCertificate", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.single_level_bom_as_specified:1.0.0#SingleLevelBomAsSpecified", + "version": "1.0.0", + "name": "SingleLevelBomAsSpecified", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned", + "version": "1.1.0", + "name": "SingleLevelUsageAsPlanned", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.time_series_reference:1.0.0#TimeSeriesReference", + "version": "1.0.0", + "name": "TimeSeriesReference", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.traction_battery_code:1.0.0#TractionBatteryCode", + "version": "1.0.0", + "name": "TractionBatteryCode", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.user_estimated_loading:1.0.0#UserEstimatedLoading", + "version": "1.0.0", + "name": "UserEstimatedLoading", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.vehicle.product_description:1.0.0#ProductDescription", + "version": "1.0.0", + "name": "ProductDescription", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.vehicle.product_description:2.0.0#ProductDescription", + "version": "2.0.0", + "name": "ProductDescription", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.waste:1.0.0#Waste", + "version": "1.0.0", + "name": "Waste", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.week_based_capacity_group:1.0.1#WeekBasedCapacityGroup", + "version": "1.0.1", + "name": "WeekBasedCapacityGroup", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.week_based_material_demand:1.0.1#WeekBasedMaterialDemand", + "version": "1.0.1", + "name": "WeekBasedMaterialDemand", + "type": "BAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.essincident:2.0.0#EssIncident", + "version": "2.0.0", + "name": "EssIncident", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles", + "version": "1.0.0", + "name": "Vehicles", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.id_based_comment:1.0.0#IdBasedComment", + "version": "1.0.0", + "name": "IdBasedComment", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.id_based_request_for_update:1.0.0#IdBasedRequestForUpdate", + "version": "1.0.0", + "name": "IdBasedRequestForUpdate", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.id_based_request_for_update:2.0.0#IdBasedRequestForUpdate", + "version": "2.0.0", + "name": "IdBasedRequestForUpdate", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.manufacturing_capability:2.0.0#ManufacturingCapability", + "version": "2.0.0", + "name": "ManufacturingCapability", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.material_flow_simulation_result:2.0.0#MaterialFlowSimulationResultAspect", + "version": "2.0.0", + "name": "MaterialFlowSimulationResultAspect", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses", + "version": "2.0.0", + "name": "PartsAnalyses", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.planned_production_output:1.0.0#PlannedProductionOutput", + "version": "1.0.0", + "name": "PlannedProductionOutput", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.secondary_material_content:1.0.0#SecondaryMaterialContent", + "version": "1.0.0", + "name": "SecondaryMaterialContent", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.address_characteristic:3.0.0#AddressAspect", + "version": "3.0.0", + "name": "AddressAspect", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.business_partner_number:1.0.0#BusinessPartnerNumber", + "version": "1.0.0", + "name": "BusinessPartnerNumber", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.contact_information:3.0.0#ContactInformation", + "version": "3.0.0", + "name": "ContactInformation", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.part_site_information_as_built:1.0.0#PartSiteInformationAsBuilt", + "version": "1.0.0", + "name": "PartSiteInformationAsBuilt", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.quantity:1.0.0#Quantity", + "version": "1.0.0", + "name": "Quantity", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.recycling_strategy_certificate:2.0.0#RecyclingStrategyCertificate", + "version": "2.0.0", + "name": "RecyclingStrategyCertificate", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.secondary_material_content:1.0.0#SecondaryMaterialContent", + "version": "1.0.0", + "name": "SecondaryMaterialContent", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#ShopfloorInformationTypes", + "version": "1.0.0", + "name": "ShopfloorInformationTypes", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.shared.uuid:1.0.0#Uuid", + "version": "1.0.0", + "name": "Uuid", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.single_level_bom_as_specified:2.0.0#SingleLevelBomAsSpecified", + "version": "2.0.0", + "name": "SingleLevelBomAsSpecified", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription", + "version": "3.0.0", + "name": "ProductDescription", + "type": "SAMM", + "status": "RELEASED" + }, + { + "urn": "urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt", + "version": "1.0.0", + "name": "SingleLevelBomAsBuilt", + "type": "BAMM", + "status": "DEPRECATED" + }, + { + "urn": "urn:samm:io.catenax.batch:2.0.0#Batch", + "version": "2.0.0", + "name": "Batch", + "type": "SAMM", + "status": "DEPRECATED" + }, + { + "urn": "urn:bamm:io.catenax.serial_part:1.0.1#SerialPart", + "version": "1.0.1", + "name": "SerialPart", + "type": "BAMM", + "status": "DEPRECATED" + } + ], + "totalItems": 78, + "currentPage": 0, + "totalPages": 1, + "itemCount": 78 +} \ No newline at end of file From efb20ddea8d3e23ae03e992fc33b04d528e88e86 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 23 Jan 2024 18:40:01 +0100 Subject: [PATCH 041/116] feat(imp):[#214] fix license header and merge conflict compile problem --- .../irs/common/util/concurrent/ResultFinder.java | 4 ++-- .../irs/common/util/concurrent/ResultFinderTest.java | 6 +++--- .../DecentralDigitalTwinRegistryServiceTest.java | 11 +++++++---- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 655494eb1b..27d08284a4 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -1,8 +1,8 @@ /******************************************************************************** - * Copyright (c) 2021,2022,2023 + * Copyright (c) 2022,2024 * 2022: ZF Friedrichshafen AG * 2022: ISTOS GmbH - * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * 2022,2023: BOSCH AG * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index 7e92ae1f5b..c98ea5e83c 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -1,10 +1,10 @@ /******************************************************************************** - * Copyright (c) 2021,2022,2023 + * Copyright (c) 2022,2024 * 2022: ZF Friedrichshafen AG * 2022: ISTOS GmbH - * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * 2022,2023: BOSCH AG - * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional * information regarding copyright ownership. diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index 7111d085a0..76b26d5008 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -225,9 +225,12 @@ void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { expectedShell); // when - final var assetAdministrationShellDescriptors = sut.lookupGlobalAssetIds(digitalTwinRegistryKey.bpn()); + final var assetAdministrationShellDescriptors = sut.lookupShellsByBPN(digitalTwinRegistryKey.bpn()); - String actualGlobalAssetId = assetAdministrationShellDescriptors.stream().findFirst().map(AssetAdministrationShellDescriptor::getGlobalAssetId).get();// then + String actualGlobalAssetId = assetAdministrationShellDescriptors.stream() + .findFirst() + .map(AssetAdministrationShellDescriptor::getGlobalAssetId) + .get();// then assertThat(actualGlobalAssetId).isEqualTo(expectedGlobalAssetId); } @@ -237,7 +240,7 @@ void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedExce simulateResultFinderInterrupted(); // when - final ThrowingCallable call = () -> sut.lookupGlobalAssetIds("dummyBpn"); + final ThrowingCallable call = () -> sut.lookupShellsByBPN("dummyBpn"); // then assertThatThrownBy(call).isInstanceOf(ShellNotFoundException.class) @@ -251,7 +254,7 @@ void whenExecutionExceptionOccurs() { // when final var bpn = "dummyBpn"; - final ThrowingCallable call = () -> sut.lookupGlobalAssetIds(bpn); + final ThrowingCallable call = () -> sut.lookupShellsByBPN(bpn); // then assertThatThrownBy(call).isInstanceOf(RegistryServiceRuntimeException.class) From 8dbff36bc6ea6f29f753a89367ab2b92385d5cc7 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 23 Jan 2024 19:44:36 +0100 Subject: [PATCH 042/116] feat(imp):[#214] add some error logging --- .../decentral/DecentralDigitalTwinRegistryService.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 3a41bdf2a4..bd43f9f800 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -127,7 +127,9 @@ private List fetchShellDescriptorsForConnect log.debug("InterruptedException occurred while fetching shells for bpn '%s'".formatted(bpn), e); Thread.currentThread().interrupt(); return emptyList(); - } catch (ExecutionException e) { + } catch (ResultFinder.CompletionExceptions | ExecutionException e) { + // TODO do not log and throw, this is just for temporary debugging + log.error(e.getMessage(), e); throw new RegistryServiceRuntimeException( "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); } finally { @@ -194,7 +196,9 @@ private Collection lookupShellIds(final String bpn) { log.debug("InterruptedException occurred while looking up shells ids for bpn '%s'".formatted(bpn), e); Thread.currentThread().interrupt(); return emptyList(); - } catch (ExecutionException e) { + } catch (ResultFinder.CompletionExceptions | ExecutionException e) { + // TODO do not log and throw, this is just for temporary debugging + log.error(e.getMessage(), e); throw new RegistryServiceRuntimeException( "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } From d51f6ab88715067fd878faa03b99fa441088ef41 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Tue, 23 Jan 2024 23:10:20 +0100 Subject: [PATCH 043/116] feat(imp):[#214] debug logging for investigation on DEV --- .../common/util/concurrent/ResultFinder.java | 26 ++-- .../DecentralDigitalTwinRegistryService.java | 145 +++++++++++++----- .../EndpointDataForConnectorsService.java | 29 +++- 3 files changed, 143 insertions(+), 57 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 27d08284a4..04d1020e7e 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -54,11 +54,11 @@ public class ResultFinder { public CompletableFuture getFastestResult(final List> futures) { if (futures == null || futures.isEmpty()) { - log.warn("Called getFastestResult with empty list of futures"); + log.warn("getFastestResult#0 Called getFastestResult with empty list of futures"); return CompletableFuture.completedFuture(null); } - log.debug("Trying to get fastest result from list of futures"); + log.debug("getFastestResult#1 Trying to get fastest result from list of futures"); final CompletableFuture fastestResultPromise = new CompletableFuture<>(); @@ -69,17 +69,19 @@ public CompletableFuture getFastestResult(final List .handle(completingOnFirstSuccessful(fastestResultPromise))) .toList(); + log.debug("getFastestResult#2"); + allOf(toArray(futuresList)).whenComplete((value, ex) -> { - log.debug("List of futures completed"); + log.debug("getFastestResult#3 List of futures completed"); if (ex != null) { - log.error("Exception occurred: " + ex.getMessage(), ex); + log.error("getFastestResult#4 Exception occurred: " + ex.getMessage(), ex); fastestResultPromise.completeExceptionally(new CompletionExceptions(exceptions)); } else if (fastestResultPromise.isDone()) { - log.debug("Fastest result already found, ignoring the others"); + log.debug("getFastestResult#5 Fastest result already found, ignoring the others"); } else { - log.debug("Completing"); + log.debug("getFastestResult#6 Completing"); fastestResultPromise.complete(null); } }); @@ -96,20 +98,26 @@ private static BiFunction completingOnFirstSuccessful return (value, throwable) -> { + log.debug("completingOnFirstSuccessful#1 value: {}, throwable: {}", value, throwable); + final boolean notFinishedByOtherFuture = !resultPromise.isDone(); + log.debug("completingOnFirstSuccessful#2 notFinishedByOtherFuture {} ", notFinishedByOtherFuture); + final boolean currentFutureSuccessful = throwable == null && value != null; if (notFinishedByOtherFuture && currentFutureSuccessful) { // first future that completes successfully completes the overall future - log.debug("First future that completed successfully"); + log.debug("completingOnFirstSuccessful#3 First future that completed successfully"); resultPromise.complete(value); return true; } else { if (throwable != null) { - log.warn("Exception occurred: " + throwable.getMessage(), throwable); + log.warn("completingOnFirstSuccessful#4 Exception occurred: " + throwable.getMessage(), throwable); throw new CompletionException(throwable.getMessage(), throwable); + } else { + log.debug("completingOnFirstSuccessful#5 log just for debugging"); } return false; } @@ -118,7 +126,7 @@ private static BiFunction completingOnFirstSuccessful private static Function collectingExceptionsAndThrow(final List exceptions) { return t -> { - log.error("Exception occurred: " + t.getMessage(), t); + log.error("collectingExceptionsAndThrow -- Exception occurred: " + t.getMessage(), t); exceptions.add(t); throw new CompletionException(t); }; diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index bd43f9f800..3e83edfcaf 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -81,17 +81,25 @@ private static Stream>> groupKeys public Collection fetchShells(final Collection keys) throws RegistryServiceException { - log.info("Fetching shell(s) for {} key(s)", keys.size()); + try { + + log.info("fetchShells#1 Fetching shell(s) for {} key(s)", keys.size()); - final var calledEndpoints = new HashSet(); - final var collectedShells = groupKeysByBpn(keys).flatMap( - entry -> fetchShellDescriptors(calledEndpoints, entry.getKey(), entry.getValue()).stream()).toList(); + final var calledEndpoints = new HashSet(); + final var collectedShells = groupKeysByBpn(keys).flatMap( + entry -> fetchShellDescriptors(calledEndpoints, entry.getKey(), entry.getValue()).stream()) + .toList(); - if (collectedShells.isEmpty()) { - throw new ShellNotFoundException("Unable to find any of the requested shells", calledEndpoints); - } else { - log.info("Found {} shell(s) for {} key(s)", collectedShells.size(), keys.size()); - return collectedShells; + if (collectedShells.isEmpty()) { + log.debug("fetchShells#2 no shells found"); + throw new ShellNotFoundException("Unable to find any of the requested shells", calledEndpoints); + } else { + log.info("fetchShells#3 Found {} shell(s) for {} key(s)", collectedShells.size(), keys.size()); + return collectedShells; + } + + } finally { + log.debug("fetchShells#4 finally"); } } @@ -99,11 +107,11 @@ public Collection fetchShells(final Collecti private List fetchShellDescriptors(final Set calledEndpoints, final String bpn, final List keys) { - log.info("Fetching {} shells for bpn {}", keys.size(), bpn); + log.info("fetchShellDescriptors#1 Fetching {} shells for bpn {}", keys.size(), bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.debug("Found {} connector endpoints for bpn {}", connectorEndpoints.size(), bpn); + log.debug("fetchShellDescriptors#2 Found {} connector endpoints for bpn {}", connectorEndpoints.size(), bpn); calledEndpoints.addAll(connectorEndpoints); @@ -113,6 +121,8 @@ private List fetchShellDescriptors(final Set private List fetchShellDescriptorsForConnectorEndpoints(final String bpn, final List keys, final List connectorEndpoints) { + log.debug("fetchShellDescriptorsForConnectorEndpoints#1"); + final EndpointDataForConnectorsService service = endpointDataForConnectorsService; try { final var futures = service.createFindEndpointDataForConnectorsFutures(connectorEndpoints) @@ -121,19 +131,33 @@ private List fetchShellDescriptorsForConnect edr -> supplyAsync(() -> fetchShellDescriptorsForKey(keys, edr)))) .toList(); + log.debug("fetchShellDescriptorsForConnectorEndpoints#2"); + return resultFinder.getFastestResult(futures).get(); } catch (InterruptedException e) { - log.debug("InterruptedException occurred while fetching shells for bpn '%s'".formatted(bpn), e); + log.debug( + "fetchShellDescriptorsForConnectorEndpoints#3 InterruptedException occurred while fetching shells for bpn '%s'".formatted( + bpn), e); Thread.currentThread().interrupt(); return emptyList(); - } catch (ResultFinder.CompletionExceptions | ExecutionException e) { - // TODO do not log and throw, this is just for temporary debugging - log.error(e.getMessage(), e); + } catch (ResultFinder.CompletionExceptions e) { + + log.debug("fetchShellDescriptorsForConnectorEndpoints#4 " + e.getMessage(), e); + e.getCauses() + .forEach(ex -> log.debug("fetchShellDescriptorsForConnectorEndpoints#5 " + ex.getMessage(), ex)); + throw new RegistryServiceRuntimeException( "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + + } catch (ExecutionException e) { + + log.error("fetchShellDescriptorsForConnectorEndpoints#6 " + e.getMessage(), e); + throw new RegistryServiceRuntimeException( + "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + } finally { - log.debug("End fetchShellDescriptorsForConnectorEndpoints"); + log.debug("fetchShellDescriptorsForConnectorEndpoints#7 finally"); } } @@ -145,11 +169,15 @@ private List fetchShellDescriptorsForKey( private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDataReference endpointDataReference, final DigitalTwinRegistryKey key) { - log.info("Retrieving AAS Identification for DigitalTwinRegistryKey: {}", key); - final String aaShellIdentification = mapToShellId(endpointDataReference, key.shellId()); - log.debug("aaShellIdentification: {}", aaShellIdentification); - return decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(endpointDataReference, - aaShellIdentification); + try { + log.info("fetchShellDescriptor#1 Retrieving AAS Identification for DigitalTwinRegistryKey: {}", key); + final String aaShellIdentification = mapToShellId(endpointDataReference, key.shellId()); + log.debug("fetchShellDescriptor#2 aaShellIdentification: {}", aaShellIdentification); + return decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(endpointDataReference, + aaShellIdentification); + } finally { + log.debug("fetchShellDescriptor#3 finally"); + } } /** @@ -163,25 +191,47 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa */ @NotNull private String mapToShellId(final EndpointDataReference endpointDataReference, final String key) { - final var identifierKeyValuePair = IdentifierKeyValuePair.builder().name("globalAssetId").value(key).build(); - final var aaShellIdentification = decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( - endpointDataReference, List.of(identifierKeyValuePair)).getResult().stream().findFirst().orElse(key); - - if (key.equals(aaShellIdentification)) { - log.info("Found shell with shellId {} in registry", aaShellIdentification); - } else { - log.info("Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); + + log.debug("mapToShellId#1"); + + try { + + final var identifierKeyValuePair = IdentifierKeyValuePair.builder() + .name("globalAssetId") + .value(key) + .build(); + final var aaShellIdentification = decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( + endpointDataReference, List.of(identifierKeyValuePair)) + .getResult() + .stream() + .findFirst() + .orElse(key); + + log.debug("mapToShellId#2"); + + if (key.equals(aaShellIdentification)) { + log.info("mapToShellId#3 Found shell with shellId {} in registry", aaShellIdentification); + } else { + log.info("mapToShellId#4 Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); + } + return aaShellIdentification; + } finally { + log.debug("mapToShellId#5 finally"); } - return aaShellIdentification; } private Collection lookupShellIds(final String bpn) { - log.info("Looking up shell ids for bpn {}", bpn); + + log.info("lookupShellIds#1 Looking up shell ids for bpn {}", bpn); + final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.debug("Looking up shell ids for bpn {} with connector endpoints {}", bpn, connectorEndpoints); + log.debug("lookupShellIds#2 Looking up shell ids for bpn {} with connector endpoints {}", bpn, + connectorEndpoints); final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( connectorEndpoints); + log.debug("lookupShellIds#3 created futures"); + try { final var futures = endpointDataReferenceFutures.stream() .map(edrFuture -> edrFuture.thenCompose( @@ -189,25 +239,40 @@ private Collection lookupShellIds(final String bpn) { .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); - log.info("Found {} shell id(s) in total", shellIds.size()); + log.info("lookupShellIds#4 Found {} shell id(s) in total", shellIds.size()); return shellIds; } catch (InterruptedException e) { - log.debug("InterruptedException occurred while looking up shells ids for bpn '%s'".formatted(bpn), e); + log.debug( + "lookupShellIds#5 InterruptedException occurred while looking up shells ids for bpn '%s'".formatted( + bpn), e); Thread.currentThread().interrupt(); return emptyList(); - } catch (ResultFinder.CompletionExceptions | ExecutionException e) { - // TODO do not log and throw, this is just for temporary debugging - log.error(e.getMessage(), e); + } catch (ResultFinder.CompletionExceptions e) { + + log.debug("lookupShellIds#6" + e.getMessage(), e); + e.getCauses().forEach(ex -> log.debug("lookupShellIds#7 " + ex.getMessage(), ex)); + + throw new RegistryServiceRuntimeException( + "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + + } catch (ExecutionException e) { + log.error("lookupShellIds#8 " + e.getMessage(), e); throw new RegistryServiceRuntimeException( "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } } private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { - log.debug("lookupShellIds for bpn {} with endpointDataReference {}", bpn, endpointDataReference); - return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(endpointDataReference, - List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); + log.debug("lookupShellIds#1 look up shell IDs for bpn {} with endpointDataReference {}", bpn, + endpointDataReference); + try { + return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( + endpointDataReference, + List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); + } finally { + log.debug("lookupShellIds#2 finally"); + } } @Override diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 5fbad38a31..28a7edd321 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -25,6 +25,7 @@ import static java.util.concurrent.CompletableFuture.supplyAsync; +import java.util.Collections; import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionException; @@ -49,25 +50,37 @@ public class EndpointDataForConnectorsService { public List> createFindEndpointDataForConnectorsFutures( final List connectorEndpoints) { - log.debug("createFindEndpointDataForConnectorsFutures for connector endpoints: {}", connectorEndpoints); - return connectorEndpoints.stream() - .map(connectorEndpoint -> supplyAsync( - () -> getEndpointReferenceForAsset(connectorEndpoint))) - .toList(); + List> futures = Collections.emptyList(); + try { + log.debug( + "createFindEndpointDataForConnectorsFutures#1 creating futures to get EndpointDataReferences for endpoints: {}", + connectorEndpoints); + futures = connectorEndpoints.stream() + .map(connectorEndpoint -> supplyAsync( + () -> getEndpointReferenceForAsset(connectorEndpoint))) + .toList(); + return futures; + } finally { + log.debug("createFindEndpointDataForConnectorsFutures#2 created {} futures", futures.size()); + } } private EndpointDataReference getEndpointReferenceForAsset(final String connector) { - log.info("Trying to retrieve EndpointDataReference for connector {}", connector); + log.info("getEndpointReferenceForAsset#1 Trying to retrieve EndpointDataReference for connector {}", connector); try { final var endpointDataReference = edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, DT_REGISTRY_ASSET_VALUE); - log.debug("Got EndpointDataReference for connector {}", connector); + log.debug("getEndpointReferenceForAsset#2 Got EndpointDataReference for connector {}", connector); return endpointDataReference; } catch (EdcRetrieverException e) { - log.warn("Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); + log.warn( + "getEndpointReferenceForAsset#3 Exception occurred when retrieving EndpointDataReference from connector {}", + connector, e); throw new CompletionException(e.getMessage(), e); + } finally { + log.debug("getEndpointReferenceForAsset#4 finally"); } } From 7a7324b76736b8c0d5e36cbe73d19e2c6074238c Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 24 Jan 2024 00:14:19 +0100 Subject: [PATCH 044/116] feat(imp):[#214] fix checkstyle warning --- .../decentral/DecentralDigitalTwinRegistryService.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 3e83edfcaf..b3a22e3759 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -144,8 +144,8 @@ private List fetchShellDescriptorsForConnect } catch (ResultFinder.CompletionExceptions e) { log.debug("fetchShellDescriptorsForConnectorEndpoints#4 " + e.getMessage(), e); - e.getCauses() - .forEach(ex -> log.debug("fetchShellDescriptorsForConnectorEndpoints#5 " + ex.getMessage(), ex)); + e.getCauses().forEach(ex -> log.debug("fetchShellDescriptorsForConnectorEndpoints#5 " // + + ex.getMessage(), ex)); throw new RegistryServiceRuntimeException( "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); From 824d1d9bc965e8c69a5c33e0136e63d354ef53a2 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 24 Jan 2024 11:32:22 +0100 Subject: [PATCH 045/116] feat(imp):[#214] debug logging (to be removed/adapted after debugging) switch log.debug to info because debug does not seem to get logged and add special marker "#214@" to filter the logs for debugging the story --- .../common/util/concurrent/ResultFinder.java | 25 ++++--- .../DecentralDigitalTwinRegistryService.java | 75 ++++++++++--------- .../EndpointDataForConnectorsService.java | 15 ++-- 3 files changed, 59 insertions(+), 56 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 04d1020e7e..bedc992554 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -54,11 +54,11 @@ public class ResultFinder { public CompletableFuture getFastestResult(final List> futures) { if (futures == null || futures.isEmpty()) { - log.warn("getFastestResult#0 Called getFastestResult with empty list of futures"); + log.warn("#214@getFastestResult#0 Called getFastestResult with empty list of futures"); return CompletableFuture.completedFuture(null); } - log.debug("getFastestResult#1 Trying to get fastest result from list of futures"); + log.info("#214@getFastestResult#1 Trying to get fastest result from list of futures"); final CompletableFuture fastestResultPromise = new CompletableFuture<>(); @@ -69,19 +69,19 @@ public CompletableFuture getFastestResult(final List .handle(completingOnFirstSuccessful(fastestResultPromise))) .toList(); - log.debug("getFastestResult#2"); + log.info("#214@getFastestResult#2"); allOf(toArray(futuresList)).whenComplete((value, ex) -> { - log.debug("getFastestResult#3 List of futures completed"); + log.info("#214@getFastestResult#3 List of futures completed"); if (ex != null) { - log.error("getFastestResult#4 Exception occurred: " + ex.getMessage(), ex); + log.error("g#214@etFastestResult#4 Exception occurred: " + ex.getMessage(), ex); fastestResultPromise.completeExceptionally(new CompletionExceptions(exceptions)); } else if (fastestResultPromise.isDone()) { - log.debug("getFastestResult#5 Fastest result already found, ignoring the others"); + log.info("#214@getFastestResult#5 Fastest result already found, ignoring the others"); } else { - log.debug("getFastestResult#6 Completing"); + log.info("#214@getFastestResult#6 Completing"); fastestResultPromise.complete(null); } }); @@ -98,26 +98,27 @@ private static BiFunction completingOnFirstSuccessful return (value, throwable) -> { - log.debug("completingOnFirstSuccessful#1 value: {}, throwable: {}", value, throwable); + log.info("#214@completingOnFirstSuccessful#1 value: {}, throwable: {}", value, throwable); final boolean notFinishedByOtherFuture = !resultPromise.isDone(); - log.debug("completingOnFirstSuccessful#2 notFinishedByOtherFuture {} ", notFinishedByOtherFuture); + log.info("#214@completingOnFirstSuccessful#2 notFinishedByOtherFuture {} ", notFinishedByOtherFuture); final boolean currentFutureSuccessful = throwable == null && value != null; if (notFinishedByOtherFuture && currentFutureSuccessful) { // first future that completes successfully completes the overall future - log.debug("completingOnFirstSuccessful#3 First future that completed successfully"); + log.info("#214@completingOnFirstSuccessful#3 First future that completed successfully"); resultPromise.complete(value); return true; } else { if (throwable != null) { - log.warn("completingOnFirstSuccessful#4 Exception occurred: " + throwable.getMessage(), throwable); + log.warn("#214@completingOnFirstSuccessful#4 Exception occurred: " + throwable.getMessage(), + throwable); throw new CompletionException(throwable.getMessage(), throwable); } else { - log.debug("completingOnFirstSuccessful#5 log just for debugging"); + log.info("#214@completingOnFirstSuccessful#5 log just for debugging"); } return false; } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index b3a22e3759..4517823598 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -83,7 +83,7 @@ public Collection fetchShells(final Collecti try { - log.info("fetchShells#1 Fetching shell(s) for {} key(s)", keys.size()); + log.info("#214@fetchShells#1 Fetching shell(s) for {} key(s)", keys.size()); final var calledEndpoints = new HashSet(); final var collectedShells = groupKeysByBpn(keys).flatMap( @@ -91,15 +91,15 @@ public Collection fetchShells(final Collecti .toList(); if (collectedShells.isEmpty()) { - log.debug("fetchShells#2 no shells found"); + log.info("#214@fetchShells#2 no shells found"); throw new ShellNotFoundException("Unable to find any of the requested shells", calledEndpoints); } else { - log.info("fetchShells#3 Found {} shell(s) for {} key(s)", collectedShells.size(), keys.size()); + log.info("#214@fetchShells#3 Found {} shell(s) for {} key(s)", collectedShells.size(), keys.size()); return collectedShells; } } finally { - log.debug("fetchShells#4 finally"); + log.info("#214@fetchShells#4 finally"); } } @@ -107,11 +107,12 @@ public Collection fetchShells(final Collecti private List fetchShellDescriptors(final Set calledEndpoints, final String bpn, final List keys) { - log.info("fetchShellDescriptors#1 Fetching {} shells for bpn {}", keys.size(), bpn); + log.info("#214@fetchShellDescriptors#1 Fetching {} shells for bpn {}", keys.size(), bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.debug("fetchShellDescriptors#2 Found {} connector endpoints for bpn {}", connectorEndpoints.size(), bpn); + log.info("#214@fetchShellDescriptors#2 Found {} connector endpoints for bpn {}", connectorEndpoints.size(), + bpn); calledEndpoints.addAll(connectorEndpoints); @@ -121,7 +122,7 @@ private List fetchShellDescriptors(final Set private List fetchShellDescriptorsForConnectorEndpoints(final String bpn, final List keys, final List connectorEndpoints) { - log.debug("fetchShellDescriptorsForConnectorEndpoints#1"); + log.info("#214@fetchShellDescriptorsForConnectorEndpoints#1"); final EndpointDataForConnectorsService service = endpointDataForConnectorsService; try { @@ -131,33 +132,33 @@ private List fetchShellDescriptorsForConnect edr -> supplyAsync(() -> fetchShellDescriptorsForKey(keys, edr)))) .toList(); - log.debug("fetchShellDescriptorsForConnectorEndpoints#2"); + log.info("#214@fetchShellDescriptorsForConnectorEndpoints#2"); return resultFinder.getFastestResult(futures).get(); } catch (InterruptedException e) { - log.debug( - "fetchShellDescriptorsForConnectorEndpoints#3 InterruptedException occurred while fetching shells for bpn '%s'".formatted( + log.warn( + "#214@fetchShellDescriptorsForConnectorEndpoints#3 InterruptedException occurred while fetching shells for bpn '%s'".formatted( bpn), e); Thread.currentThread().interrupt(); return emptyList(); } catch (ResultFinder.CompletionExceptions e) { - log.debug("fetchShellDescriptorsForConnectorEndpoints#4 " + e.getMessage(), e); - e.getCauses().forEach(ex -> log.debug("fetchShellDescriptorsForConnectorEndpoints#5 " // + log.warn("#214@fetchShellDescriptorsForConnectorEndpoints#4 " + e.getMessage(), e); + e.getCauses().forEach(ex -> log.warn("#214@fetchShellDescriptorsForConnectorEndpoints#5 " // + ex.getMessage(), ex)); throw new RegistryServiceRuntimeException( - "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + "#214@ Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); } catch (ExecutionException e) { - log.error("fetchShellDescriptorsForConnectorEndpoints#6 " + e.getMessage(), e); + log.error("#214@fetchShellDescriptorsForConnectorEndpoints#6 " + e.getMessage(), e); throw new RegistryServiceRuntimeException( - "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + "#214@ Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); } finally { - log.debug("fetchShellDescriptorsForConnectorEndpoints#7 finally"); + log.info("#214@fetchShellDescriptorsForConnectorEndpoints#7 finally"); } } @@ -170,13 +171,13 @@ private List fetchShellDescriptorsForKey( private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDataReference endpointDataReference, final DigitalTwinRegistryKey key) { try { - log.info("fetchShellDescriptor#1 Retrieving AAS Identification for DigitalTwinRegistryKey: {}", key); + log.info("#214@fetchShellDescriptor#1 Retrieving AAS Identification for DigitalTwinRegistryKey: {}", key); final String aaShellIdentification = mapToShellId(endpointDataReference, key.shellId()); - log.debug("fetchShellDescriptor#2 aaShellIdentification: {}", aaShellIdentification); + log.info("#214@fetchShellDescriptor#2 aaShellIdentification: {}", aaShellIdentification); return decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(endpointDataReference, aaShellIdentification); } finally { - log.debug("fetchShellDescriptor#3 finally"); + log.info("#214@fetchShellDescriptor#3 finally"); } } @@ -192,7 +193,7 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa @NotNull private String mapToShellId(final EndpointDataReference endpointDataReference, final String key) { - log.debug("mapToShellId#1"); + log.info("#214@mapToShellId#1"); try { @@ -207,30 +208,30 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f .findFirst() .orElse(key); - log.debug("mapToShellId#2"); + log.info("#214@mapToShellId#2"); if (key.equals(aaShellIdentification)) { - log.info("mapToShellId#3 Found shell with shellId {} in registry", aaShellIdentification); + log.info("#214@mapToShellId#3 Found shell with shellId {} in registry", aaShellIdentification); } else { - log.info("mapToShellId#4 Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); + log.info("#214@mapToShellId#4 Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); } return aaShellIdentification; } finally { - log.debug("mapToShellId#5 finally"); + log.info("#214@mapToShellId#5 finally"); } } private Collection lookupShellIds(final String bpn) { - log.info("lookupShellIds#1 Looking up shell ids for bpn {}", bpn); + log.info("#214@lookupShellIds#1 Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.debug("lookupShellIds#2 Looking up shell ids for bpn {} with connector endpoints {}", bpn, + log.info("#214@lookupShellIds#2 Looking up shell ids for bpn {} with connector endpoints {}", bpn, connectorEndpoints); final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( connectorEndpoints); - log.debug("lookupShellIds#3 created futures"); + log.info("#214@lookupShellIds#3 created futures"); try { final var futures = endpointDataReferenceFutures.stream() @@ -239,39 +240,39 @@ private Collection lookupShellIds(final String bpn) { .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); - log.info("lookupShellIds#4 Found {} shell id(s) in total", shellIds.size()); + log.info("#214@lookupShellIds#4 Found {} shell id(s) in total", shellIds.size()); return shellIds; } catch (InterruptedException e) { - log.debug( - "lookupShellIds#5 InterruptedException occurred while looking up shells ids for bpn '%s'".formatted( + log.info( + "#214@lookupShellIds#5 InterruptedException occurred while looking up shells ids for bpn '%s'".formatted( bpn), e); Thread.currentThread().interrupt(); return emptyList(); } catch (ResultFinder.CompletionExceptions e) { - log.debug("lookupShellIds#6" + e.getMessage(), e); - e.getCauses().forEach(ex -> log.debug("lookupShellIds#7 " + ex.getMessage(), ex)); + log.warn("#214@lookupShellIds#6" + e.getMessage(), e); + e.getCauses().forEach(ex -> log.warn("lookupShellIds#7 " + ex.getMessage(), ex)); throw new RegistryServiceRuntimeException( - "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + "#214@ Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } catch (ExecutionException e) { - log.error("lookupShellIds#8 " + e.getMessage(), e); + log.error("#214@lookupShellIds#8 " + e.getMessage(), e); throw new RegistryServiceRuntimeException( - "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + "#214@ Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } } private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { - log.debug("lookupShellIds#1 look up shell IDs for bpn {} with endpointDataReference {}", bpn, + log.info("#214@lookupShellIds#1 look up shell IDs for bpn {} with endpointDataReference {}", bpn, endpointDataReference); try { return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( endpointDataReference, List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); } finally { - log.debug("lookupShellIds#2 finally"); + log.info("#214@lookupShellIds#2 finally"); } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 28a7edd321..95183596da 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -52,8 +52,8 @@ public List> createFindEndpointDataForC List> futures = Collections.emptyList(); try { - log.debug( - "createFindEndpointDataForConnectorsFutures#1 creating futures to get EndpointDataReferences for endpoints: {}", + log.info( + "#214#createFindEndpointDataForConnectorsFutures#1 creating futures to get EndpointDataReferences for endpoints: {}", connectorEndpoints); futures = connectorEndpoints.stream() .map(connectorEndpoint -> supplyAsync( @@ -61,26 +61,27 @@ public List> createFindEndpointDataForC .toList(); return futures; } finally { - log.debug("createFindEndpointDataForConnectorsFutures#2 created {} futures", futures.size()); + log.info("#214@createFindEndpointDataForConnectorsFutures#2 created {} futures", futures.size()); } } private EndpointDataReference getEndpointReferenceForAsset(final String connector) { - log.info("getEndpointReferenceForAsset#1 Trying to retrieve EndpointDataReference for connector {}", connector); + log.info("#214@getEndpointReferenceForAsset#1 Trying to retrieve EndpointDataReference for connector {}", + connector); try { final var endpointDataReference = edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, DT_REGISTRY_ASSET_VALUE); - log.debug("getEndpointReferenceForAsset#2 Got EndpointDataReference for connector {}", connector); + log.info("#214@getEndpointReferenceForAsset#2 Got EndpointDataReference for connector {}", connector); return endpointDataReference; } catch (EdcRetrieverException e) { log.warn( - "getEndpointReferenceForAsset#3 Exception occurred when retrieving EndpointDataReference from connector {}", + "#214@getEndpointReferenceForAsset#3 Exception occurred when retrieving EndpointDataReference from connector {}", connector, e); throw new CompletionException(e.getMessage(), e); } finally { - log.debug("getEndpointReferenceForAsset#4 finally"); + log.info("#214@getEndpointReferenceForAsset#4 finally"); } } From e3bb440ca0a3ed307d41a3eb295f72ca8b7f12df Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 24 Jan 2024 22:32:51 +0100 Subject: [PATCH 046/116] feat(imp):[#214] add stop watches for analyzing performance --- .../common/util/concurrent/ResultFinder.java | 47 +++-- .../util/concurrent/StopwatchUtils.java | 52 ++++++ .../DecentralDigitalTwinRegistryService.java | 161 +++++++++++------- .../EndpointDataForConnectorsService.java | 31 ++-- 4 files changed, 199 insertions(+), 92 deletions(-) create mode 100644 irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index bedc992554..28b585da3f 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -35,6 +35,7 @@ import lombok.Getter; import lombok.ToString; import lombok.extern.slf4j.Slf4j; +import org.slf4j.Logger; /** * Helper class to find the relevant result from a list of futures. @@ -42,6 +43,9 @@ @Slf4j public class ResultFinder { + // TODO (mfischer): Remove when #214 is tested + public static final String LOGPREFIX_TO_BE_REMOVED_LATER = "#214@ "; + /** * Returns a new {@link CompletableFuture} which completes * when at least one of the given futures completes successfully or all fail. @@ -53,12 +57,14 @@ public class ResultFinder { */ public CompletableFuture getFastestResult(final List> futures) { + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "getFastestResult - "; + if (futures == null || futures.isEmpty()) { - log.warn("#214@getFastestResult#0 Called getFastestResult with empty list of futures"); + log.warn(logPrefix + "Called getFastestResult with empty list of futures"); return CompletableFuture.completedFuture(null); } - log.info("#214@getFastestResult#1 Trying to get fastest result from list of futures"); + log.info(logPrefix + "Trying to get fastest result from list of futures"); final CompletableFuture fastestResultPromise = new CompletableFuture<>(); @@ -69,19 +75,17 @@ public CompletableFuture getFastestResult(final List .handle(completingOnFirstSuccessful(fastestResultPromise))) .toList(); - log.info("#214@getFastestResult#2"); - allOf(toArray(futuresList)).whenComplete((value, ex) -> { - log.info("#214@getFastestResult#3 List of futures completed"); + log.info(logPrefix + "All of the futures completed"); if (ex != null) { - log.error("g#214@etFastestResult#4 Exception occurred: " + ex.getMessage(), ex); + log.error(logPrefix + "Exception occurred: " + ex.getMessage(), ex); fastestResultPromise.completeExceptionally(new CompletionExceptions(exceptions)); } else if (fastestResultPromise.isDone()) { - log.info("#214@getFastestResult#5 Fastest result already found, ignoring the others"); + log.info(logPrefix + "Fastest result already found, ignoring the others"); } else { - log.info("#214@getFastestResult#6 Completing"); + log.info(logPrefix + "Completing"); fastestResultPromise.complete(null); } }); @@ -96,29 +100,28 @@ private static CompletableFuture[] toArray(final List BiFunction completingOnFirstSuccessful( final CompletableFuture resultPromise) { + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "completingOnFirstSuccessful - "; + return (value, throwable) -> { - log.info("#214@completingOnFirstSuccessful#1 value: {}, throwable: {}", value, throwable); + log.info(logPrefix + "value: '{}', throwable: {}", value, throwable); final boolean notFinishedByOtherFuture = !resultPromise.isDone(); - log.info("#214@completingOnFirstSuccessful#2 notFinishedByOtherFuture {} ", notFinishedByOtherFuture); + log.info(logPrefix + "notFinishedByOtherFuture {} ", notFinishedByOtherFuture); final boolean currentFutureSuccessful = throwable == null && value != null; if (notFinishedByOtherFuture && currentFutureSuccessful) { // first future that completes successfully completes the overall future - log.info("#214@completingOnFirstSuccessful#3 First future that completed successfully"); + log.info(logPrefix + "First future that completed successfully"); resultPromise.complete(value); return true; } else { if (throwable != null) { - log.warn("#214@completingOnFirstSuccessful#4 Exception occurred: " + throwable.getMessage(), - throwable); + log.warn(logPrefix + "Exception occurred: " + throwable.getMessage(), throwable); throw new CompletionException(throwable.getMessage(), throwable); - } else { - log.info("#214@completingOnFirstSuccessful#5 log just for debugging"); } return false; } @@ -127,7 +130,8 @@ private static BiFunction completingOnFirstSuccessful private static Function collectingExceptionsAndThrow(final List exceptions) { return t -> { - log.error("collectingExceptionsAndThrow -- Exception occurred: " + t.getMessage(), t); + log.error(LOGPREFIX_TO_BE_REMOVED_LATER + "collectingExceptionsAndThrow - " + "Exception occurred: " + + t.getMessage(), t); exceptions.add(t); throw new CompletionException(t); }; @@ -143,9 +147,18 @@ public static class CompletionExceptions extends CompletionException { private final List causes; public CompletionExceptions(final List causes) { - super("All failing, use getCauses() for details"); + super(LOGPREFIX_TO_BE_REMOVED_LATER + "All failing, use getCauses() for details"); this.causes = causes; } + public void logWarn(final Logger log, final String prefix) { + + log.warn("{}{}", prefix, this.getMessage(), this.getCause()); + + for (final Throwable cause : this.getCauses()) { + log.warn(prefix + cause.getMessage(), cause); + } + } + } } diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java new file mode 100644 index 0000000000..2c02d897b2 --- /dev/null +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java @@ -0,0 +1,52 @@ +/******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.common.util.concurrent; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.springframework.util.StopWatch; + +/** + * Utilities for stop watches. + */ +public final class StopwatchUtils { + + /** + * utility class, therefore private constructor + */ + private StopwatchUtils() { + super(); + } + + public static void startWatch(final Logger log, final StopWatch stopWatch, final String msg) { + stopWatch.start(msg); + log.info(msg); + } + + public static void stopWatch(final Logger log, final StopWatch stopWatch) { + stopWatch(log, stopWatch, ""); + } + + public static void stopWatch(final Logger log, final StopWatch stopWatch, final String messagePrefix) { + stopWatch.stop(); + final String prefix = StringUtils.isNotBlank(messagePrefix) ? messagePrefix + " - " : ""; + log.info("{}{} took {} ms", prefix, stopWatch.getLastTaskName(), stopWatch.getLastTaskTimeMillis()); + } +} diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 4517823598..94e380436a 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -23,14 +23,15 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; -import static java.util.Collections.emptyList; -import static java.util.concurrent.CompletableFuture.supplyAsync; +import static org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder.LOGPREFIX_TO_BE_REMOVED_LATER; import java.util.Collection; +import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -39,6 +40,7 @@ import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder; +import org.eclipse.tractusx.irs.common.util.concurrent.StopwatchUtils; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; @@ -48,12 +50,14 @@ import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceRuntimeException; import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; import org.jetbrains.annotations.NotNull; +import org.springframework.util.StopWatch; /** * Decentral implementation of DigitalTwinRegistryService */ @RequiredArgsConstructor @Slf4j +@SuppressWarnings("PMD.TooManyMethods") public class DecentralDigitalTwinRegistryService implements DigitalTwinRegistryService { private final ConnectorEndpointsService connectorEndpointsService; @@ -81,9 +85,11 @@ private static Stream>> groupKeys public Collection fetchShells(final Collection keys) throws RegistryServiceException { - try { + final var watch = new StopWatch(); + StopwatchUtils.startWatch(log, watch, + LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching shell(s) for %s key(s)".formatted(keys.size())); - log.info("#214@fetchShells#1 Fetching shell(s) for {} key(s)", keys.size()); + try { final var calledEndpoints = new HashSet(); final var collectedShells = groupKeysByBpn(keys).flatMap( @@ -91,15 +97,16 @@ public Collection fetchShells(final Collecti .toList(); if (collectedShells.isEmpty()) { - log.info("#214@fetchShells#2 no shells found"); + log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "No shells found"); throw new ShellNotFoundException("Unable to find any of the requested shells", calledEndpoints); } else { - log.info("#214@fetchShells#3 Found {} shell(s) for {} key(s)", collectedShells.size(), keys.size()); + log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "Found {} shell(s) for {} key(s)", collectedShells.size(), + keys.size()); return collectedShells; } } finally { - log.info("#214@fetchShells#4 finally"); + StopwatchUtils.stopWatch(log, watch); } } @@ -107,77 +114,93 @@ public Collection fetchShells(final Collecti private List fetchShellDescriptors(final Set calledEndpoints, final String bpn, final List keys) { - log.info("#214@fetchShellDescriptors#1 Fetching {} shells for bpn {}", keys.size(), bpn); + final var watch = new StopWatch(); + StopwatchUtils.startWatch(log, watch, + LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching %s shells for bpn '%s'".formatted(keys.size(), bpn)); - final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); + try { + final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.info("#214@fetchShellDescriptors#2 Found {} connector endpoints for bpn {}", connectorEndpoints.size(), - bpn); + log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "Found {} connector endpoints for bpn '{}'", + connectorEndpoints.size(), bpn); + calledEndpoints.addAll(connectorEndpoints); - calledEndpoints.addAll(connectorEndpoints); + return fetchShellDescriptorsForConnectorEndpoints(bpn, keys, connectorEndpoints); - return fetchShellDescriptorsForConnectorEndpoints(bpn, keys, connectorEndpoints); + } finally { + StopwatchUtils.stopWatch(log, watch); + } } private List fetchShellDescriptorsForConnectorEndpoints(final String bpn, final List keys, final List connectorEndpoints) { - log.info("#214@fetchShellDescriptorsForConnectorEndpoints#1"); + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "fetchShellDescriptorsForConnectorEndpoints - "; final EndpointDataForConnectorsService service = endpointDataForConnectorsService; try { final var futures = service.createFindEndpointDataForConnectorsFutures(connectorEndpoints) .stream() - .map(edrFuture -> edrFuture.thenCompose( - edr -> supplyAsync(() -> fetchShellDescriptorsForKey(keys, edr)))) + .map(edrFuture -> edrFuture.thenCompose(edr -> CompletableFuture.supplyAsync( + () -> fetchShellDescriptorsForKey(keys, edr)))) .toList(); - log.info("#214@fetchShellDescriptorsForConnectorEndpoints#2"); + log.info(logPrefix + " Created {} futures", futures.size()); return resultFinder.getFastestResult(futures).get(); } catch (InterruptedException e) { - log.warn( - "#214@fetchShellDescriptorsForConnectorEndpoints#3 InterruptedException occurred while fetching shells for bpn '%s'".formatted( - bpn), e); - Thread.currentThread().interrupt(); - return emptyList(); + + handleInterruptedException(e, + logPrefix + "InterruptedException occurred while fetching shells for bpn '%s'".formatted(bpn)); + return Collections.emptyList(); + } catch (ResultFinder.CompletionExceptions e) { - log.warn("#214@fetchShellDescriptorsForConnectorEndpoints#4 " + e.getMessage(), e); - e.getCauses().forEach(ex -> log.warn("#214@fetchShellDescriptorsForConnectorEndpoints#5 " // - + ex.getMessage(), ex)); + e.logWarn(log, logPrefix); throw new RegistryServiceRuntimeException( - "#214@ Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); } catch (ExecutionException e) { - log.error("#214@fetchShellDescriptorsForConnectorEndpoints#6 " + e.getMessage(), e); + log.error(logPrefix + e.getMessage(), e); throw new RegistryServiceRuntimeException( - "#214@ Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); + "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); - } finally { - log.info("#214@fetchShellDescriptorsForConnectorEndpoints#7 finally"); } } private List fetchShellDescriptorsForKey( final List keys, final EndpointDataReference endpointDataReference) { - log.info("Fetching shell descriptors for keys {}", keys); - return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); + + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptorsForKey - "; + + final var watch = new StopWatch(); + StopwatchUtils.startWatch(log, watch, + logPrefix + "Fetching shell descriptors for keys %s from endpoint '%s'".formatted(keys, + endpointDataReference.getEndpoint())); + try { + return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); + } finally { + StopwatchUtils.stopWatch(log, watch); + } } private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDataReference endpointDataReference, final DigitalTwinRegistryKey key) { + + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptor - "; + + final var watch = new StopWatch(); + StopwatchUtils.startWatch(log, watch, + logPrefix + "Retrieving AAS identification for DigitalTwinRegistryKey: '%s'".formatted(key)); try { - log.info("#214@fetchShellDescriptor#1 Retrieving AAS Identification for DigitalTwinRegistryKey: {}", key); final String aaShellIdentification = mapToShellId(endpointDataReference, key.shellId()); - log.info("#214@fetchShellDescriptor#2 aaShellIdentification: {}", aaShellIdentification); return decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(endpointDataReference, aaShellIdentification); } finally { - log.info("#214@fetchShellDescriptor#3 finally"); + StopwatchUtils.stopWatch(log, watch); } } @@ -193,7 +216,11 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa @NotNull private String mapToShellId(final EndpointDataReference endpointDataReference, final String key) { - log.info("#214@mapToShellId#1"); + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "mapToShellId - "; + + final var watch = new StopWatch(); + StopwatchUtils.startWatch(log, watch, logPrefix + "Mapping '%s' to shell ID for endpoint '%s'".formatted(key, + endpointDataReference.getEndpoint())); try { @@ -208,71 +235,77 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f .findFirst() .orElse(key); - log.info("#214@mapToShellId#2"); - if (key.equals(aaShellIdentification)) { - log.info("#214@mapToShellId#3 Found shell with shellId {} in registry", aaShellIdentification); + log.info(logPrefix + "Found shell with shellId {} in registry", aaShellIdentification); } else { - log.info("#214@mapToShellId#4 Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); + log.info(logPrefix + "Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); } + return aaShellIdentification; + } finally { - log.info("#214@mapToShellId#5 finally"); + StopwatchUtils.stopWatch(log, watch); } } private Collection lookupShellIds(final String bpn) { - log.info("#214@lookupShellIds#1 Looking up shell ids for bpn {}", bpn); + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; + log.info(logPrefix + "Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.info("#214@lookupShellIds#2 Looking up shell ids for bpn {} with connector endpoints {}", bpn, - connectorEndpoints); + log.info(logPrefix + "Looking up shell ids for bpn '{}' with connector endpoints {}", bpn, connectorEndpoints); final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( connectorEndpoints); - log.info("#214@lookupShellIds#3 created futures"); + log.info(logPrefix + "Created endpointDataReferenceFutures"); try { final var futures = endpointDataReferenceFutures.stream() .map(edrFuture -> edrFuture.thenCompose( - edr -> supplyAsync(() -> lookupShellIds(bpn, edr)))) + edr -> CompletableFuture.supplyAsync( + () -> lookupShellIds(bpn, edr)))) .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); - log.info("#214@lookupShellIds#4 Found {} shell id(s) in total", shellIds.size()); + log.info(logPrefix + "Found {} shell id(s) in total", shellIds.size()); return shellIds; } catch (InterruptedException e) { - log.info( - "#214@lookupShellIds#5 InterruptedException occurred while looking up shells ids for bpn '%s'".formatted( - bpn), e); - Thread.currentThread().interrupt(); - return emptyList(); + + handleInterruptedException(e, + logPrefix + "InterruptedException occurred while looking up shells ids for bpn '%s'".formatted( + bpn)); + return Collections.emptyList(); + } catch (ResultFinder.CompletionExceptions e) { - log.warn("#214@lookupShellIds#6" + e.getMessage(), e); - e.getCauses().forEach(ex -> log.warn("lookupShellIds#7 " + ex.getMessage(), ex)); + e.logWarn(log, logPrefix); - throw new RegistryServiceRuntimeException( - "#214@ Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + throw new RegistryServiceRuntimeException(LOGPREFIX_TO_BE_REMOVED_LATER + + "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } catch (ExecutionException e) { - log.error("#214@lookupShellIds#8 " + e.getMessage(), e); - throw new RegistryServiceRuntimeException( - "#214@ Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + log.error(logPrefix + e.getMessage(), e); + throw new RegistryServiceRuntimeException(LOGPREFIX_TO_BE_REMOVED_LATER + + "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } } private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { - log.info("#214@lookupShellIds#1 look up shell IDs for bpn {} with endpointDataReference {}", bpn, - endpointDataReference); + + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; + final var watch = new StopWatch(); + StopwatchUtils.startWatch(log, watch, + logPrefix + "Looking up shell IDs for bpn '%s' with endpointDataReference '%s'".formatted(bpn, + endpointDataReference)); + try { return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( endpointDataReference, List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); } finally { - log.info("#214@lookupShellIds#2 finally"); + StopwatchUtils.stopWatch(log, watch); } } @@ -281,4 +314,8 @@ public Collection lookupShellIdentifiers(final String bp return lookupShellIds(bpn).stream().map(id -> new DigitalTwinRegistryKey(id, bpn)).toList(); } + private void handleInterruptedException(final InterruptedException interruptedException, final String msg) { + log.warn(msg, interruptedException); + Thread.currentThread().interrupt(); + } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index 95183596da..e9262c6820 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -24,6 +24,9 @@ package org.eclipse.tractusx.irs.registryclient.decentral; import static java.util.concurrent.CompletableFuture.supplyAsync; +import static org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder.LOGPREFIX_TO_BE_REMOVED_LATER; +import static org.eclipse.tractusx.irs.common.util.concurrent.StopwatchUtils.startWatch; +import static org.eclipse.tractusx.irs.common.util.concurrent.StopwatchUtils.stopWatch; import java.util.Collections; import java.util.List; @@ -33,6 +36,7 @@ import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.springframework.util.StopWatch; /** * Service that use edc client to make calls to edc connector endpoints @@ -50,10 +54,11 @@ public class EndpointDataForConnectorsService { public List> createFindEndpointDataForConnectorsFutures( final List connectorEndpoints) { + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "createFindEndpointDataForConnectorsFutures - "; + List> futures = Collections.emptyList(); try { - log.info( - "#214#createFindEndpointDataForConnectorsFutures#1 creating futures to get EndpointDataReferences for endpoints: {}", + log.info(logPrefix + "Creating futures to get EndpointDataReferences for endpoints: {}", connectorEndpoints); futures = connectorEndpoints.stream() .map(connectorEndpoint -> supplyAsync( @@ -61,27 +66,27 @@ public List> createFindEndpointDataForC .toList(); return futures; } finally { - log.info("#214@createFindEndpointDataForConnectorsFutures#2 created {} futures", futures.size()); + log.info(logPrefix + "Created {} futures", futures.size()); } } private EndpointDataReference getEndpointReferenceForAsset(final String connector) { - log.info("#214@getEndpointReferenceForAsset#1 Trying to retrieve EndpointDataReference for connector {}", - connector); - try { - final var endpointDataReference = edcSubmodelFacade.getEndpointReferenceForAsset(connector, - DT_REGISTRY_ASSET_TYPE, DT_REGISTRY_ASSET_VALUE); - log.info("#214@getEndpointReferenceForAsset#2 Got EndpointDataReference for connector {}", connector); + final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "getEndpointReferenceForAsset - "; - return endpointDataReference; + final var watch = new StopWatch(); + startWatch(log, watch, + logPrefix + "Trying to retrieve EndpointDataReference for connector '%s'".formatted(connector)); + + try { + return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, + DT_REGISTRY_ASSET_VALUE); } catch (EdcRetrieverException e) { - log.warn( - "#214@getEndpointReferenceForAsset#3 Exception occurred when retrieving EndpointDataReference from connector {}", + log.warn(logPrefix + "Exception occurred when retrieving EndpointDataReference from connector '{}'", connector, e); throw new CompletionException(e.getMessage(), e); } finally { - log.info("#214@getEndpointReferenceForAsset#4 finally"); + stopWatch(log, watch); } } From 0d306135f5541176ee8abbc54e896f77d8530fd9 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 25 Jan 2024 11:18:37 +0100 Subject: [PATCH 047/116] feat(irs-test):[#344] Create reusable wiremock config --- .../tractusx/irs/WireMockTestConfig.java | 17 +- .../tractusx/irs/bpdm/BpdmWiremockTest.java | 15 +- .../semanticshub/SemanticHubWiremockTest.java | 87 ++++-- .../{ => semantichub}/all-models-page-IT.json | 0 .../semantichub/batch-2.0.0-schema.json | 143 ++++++++++ .../client/SubmodelFacadeWiremockConfig.java | 265 ++++++++++++++++++ .../client/SubmodelFacadeWiremockTest.java | 120 ++------ ...igitalTwinRegistryServiceWiremockTest.java | 43 +-- .../DiscoveryServiceWiremockConfig.java | 93 ++++++ .../testing/wiremock}/DtrWiremockConfig.java | 114 ++------ .../irs/testing/wiremock/WireMockConfig.java | 7 + 11 files changed, 674 insertions(+), 230 deletions(-) rename irs-api/src/test/resources/__files/{ => semantichub}/all-models-page-IT.json (100%) create mode 100644 irs-api/src/test/resources/__files/semantichub/batch-2.0.0-schema.json create mode 100644 irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java create mode 100644 irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java rename {irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral => irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock}/DtrWiremockConfig.java (58%) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java index 4e7d14c48a..16e9e92c3c 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java @@ -26,11 +26,17 @@ import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.SEMHUB_REST_TEMPLATE; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; +import java.util.List; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.eclipse.edc.policy.model.PolicyRegistrationTypes; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Primary; import org.springframework.context.annotation.Profile; +import org.springframework.http.converter.HttpMessageConverter; +import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; import org.springframework.web.client.RestTemplate; @TestConfiguration @@ -49,7 +55,16 @@ RestTemplate dtrRestTemplate() { @Profile("integrationtest") @Bean(EDC_REST_TEMPLATE) RestTemplate edcRestTemplate() { - return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + final RestTemplate edcRestTemplate = restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); + final List> messageConverters = edcRestTemplate.getMessageConverters(); + for (final HttpMessageConverter converter : messageConverters) { + if (converter instanceof final MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter) { + final ObjectMapper mappingJackson2HttpMessageConverterObjectMapper = mappingJackson2HttpMessageConverter.getObjectMapper(); + PolicyRegistrationTypes.TYPES.forEach( + mappingJackson2HttpMessageConverterObjectMapper::registerSubtypes); + } + } + return edcRestTemplate; } @Primary diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java index 325c97cfd4..e9e107cd8d 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java @@ -23,6 +23,8 @@ import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import java.util.Optional; @@ -31,6 +33,7 @@ import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.springframework.web.client.HttpClientErrorException; import org.springframework.web.client.RestTemplate; @WireMockTest @@ -114,13 +117,11 @@ void shouldResolveManufacturerName() { @Test void shouldReturnEmptyOnNotFound() { // Arrange - givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn( - aResponse().withStatus(404).withHeader("Content-Type", "application/json;charset=UTF-8"))); + givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn(responseWithStatus(404))); - // Act - final Optional manufacturerName = bpdmFacade.findManufacturerName("BPNL00000000TEST"); - - // Assert - assertThat(manufacturerName).isEmpty(); + // Act & Assert + // TODO fix implementation to not throw HttpClientErrorException$NotFound + assertThatExceptionOfType(HttpClientErrorException.class).isThrownBy( + () -> bpdmFacade.findManufacturerName("BPNL00000000TEST")); } } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java index 1106c18891..321f4d6fef 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java @@ -23,15 +23,21 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.semanticshub; -import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; -import static com.github.tomakehurst.wiremock.client.WireMock.configureFor; import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; +import static com.github.tomakehurst.wiremock.client.WireMock.exactly; import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; +import com.github.tomakehurst.wiremock.client.MappingBuilder; import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.eclipse.tractusx.irs.configuration.SemanticsHubConfiguration; @@ -45,6 +51,15 @@ class SemanticHubWiremockTest { private static final String PROXY_SERVER_HOST = "127.0.0.1"; private SemanticsHubFacade semanticsHubFacade; + private static MappingBuilder getAllModels200() { + return get(urlPathEqualTo("/models")).withHost(equalTo("semantic.hub")) + .willReturn(responseWithStatus(200).withBodyFile("all-models-page.json")); + } + + private static void verifyGetAllModels(final int times) { + verify(exactly(times), getRequestedFor(urlPathEqualTo("/models"))); + } + @BeforeEach void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); @@ -60,35 +75,75 @@ void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { @Test void shouldReturn1Page() throws SchemaNotFoundException { - givenThat(get(urlPathEqualTo("/models")).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBodyFile("all-models-page.json"))); + givenThat(getAllModels200()); final AspectModels allAspectModels = semanticsHubFacade.getAllAspectModels(); assertThat(allAspectModels.models()).isNotEmpty(); assertThat(allAspectModels.models().get(0).name()).isEqualTo("SerialPartTypization"); + verifyGetAllModels(1); } @Test void shouldReturn2Pages() throws SchemaNotFoundException { - givenThat(get(urlPathEqualTo("/models")).withQueryParam("page", equalTo("0")) + givenThat(get(urlPathEqualTo("/models")).withHost(equalTo("semantic.hub")) + .withQueryParam("page", equalTo("0")) .withQueryParam("pageSize", equalTo("10")) - .willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBodyFile("all-models-page1.json"))); - givenThat(get(urlPathEqualTo("/models")).withQueryParam("page", equalTo("1")) + .willReturn( + responseWithStatus(200).withBodyFile("all-models-page1.json"))); + givenThat(get(urlPathEqualTo("/models")).withHost(equalTo("semantic.hub")) + .withQueryParam("page", equalTo("1")) .withQueryParam("pageSize", equalTo("10")) - .willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBodyFile("all-models-page2.json"))); + .willReturn( + responseWithStatus(200).withBodyFile("all-models-page2.json"))); final AspectModels allAspectModels = semanticsHubFacade.getAllAspectModels(); assertThat(allAspectModels.models()).hasSize(20); assertThat(allAspectModels.models().get(0).name()).isEqualTo("SerialPartTypization"); + verifyGetAllModels(2); + } + + @Test + void shouldReturnJsonSchema() throws SchemaNotFoundException { + // Arrange + stubFor(get(urlPathMatching("/models/urn:samm:io.catenax.batch:2.0.0%23Batch/json-schema")).withHost( + equalTo("semantic.hub")) + .willReturn( + responseWithStatus( + 200).withBodyFile( + "semantichub/batch-2.0.0-schema.json"))); + + // Act + final String modelJsonSchema = semanticsHubFacade.getModelJsonSchema("urn:samm:io.catenax.batch:2.0.0#Batch"); + + // Assert + assertThat(modelJsonSchema).contains("urn_samm_io.catenax.batch_2.0.0_CatenaXIdTrait") + .contains("A batch is a quantity of (semi-) finished products or (raw) material"); + verify(exactly(1), + getRequestedFor(urlPathMatching("/models/urn:samm:io.catenax.batch:2.0.0%23Batch/json-schema"))); + } + + @Test + void shouldThrowSchemaExceptionWhenSchemaNotFound() { + // Arrange + final String url = "/models/%s/json-schema".formatted( + "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0%23SingleLevelBomAsBuilt"); + final String errorBody = """ + { + "timestamp": "2024-01-24T12:06:23.390+00:00", + "status": 500, + "error": "Internal Server Error", + "path": "/api/v1/models/urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt/json-schema" + } + """; + System.out.println(url); + stubFor(get(urlPathEqualTo(url)).withHost(equalTo("semantic.hub")) + .willReturn(responseWithStatus(500).withBody(errorBody))); + + // Act & Assert + assertThatExceptionOfType(SchemaNotFoundException.class).isThrownBy(() -> semanticsHubFacade.getModelJsonSchema( + "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt")); + verify(exactly(1), getRequestedFor(urlPathEqualTo(url))); } } diff --git a/irs-api/src/test/resources/__files/all-models-page-IT.json b/irs-api/src/test/resources/__files/semantichub/all-models-page-IT.json similarity index 100% rename from irs-api/src/test/resources/__files/all-models-page-IT.json rename to irs-api/src/test/resources/__files/semantichub/all-models-page-IT.json diff --git a/irs-api/src/test/resources/__files/semantichub/batch-2.0.0-schema.json b/irs-api/src/test/resources/__files/semantichub/batch-2.0.0-schema.json new file mode 100644 index 0000000000..4ff694cd76 --- /dev/null +++ b/irs-api/src/test/resources/__files/semantichub/batch-2.0.0-schema.json @@ -0,0 +1,143 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "description": "A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID.", + "type": "object", + "components": { + "schemas": { + "urn_samm_io.catenax.batch_2.0.0_CatenaXIdTrait": { + "type": "string", + "description": "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern": "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_io.catenax.batch_2.0.0_KeyTrait": { + "type": "string", + "description": "Constraint that ensures that the predefined keys are used.", + "pattern": "^(manufacturerId|batchId)$" + }, + "urn_samm_io.catenax.batch_2.0.0_ValueCharacteristic": { + "type": "string", + "description": "The value of an identifier." + }, + "urn_samm_io.catenax.batch_2.0.0_KeyValueList": { + "description": "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.", + "type": "object", + "properties": { + "key": { + "description": "The key of a local identifier.", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_KeyTrait" + }, + "value": { + "description": "The value of an identifier.", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_ValueCharacteristic" + } + }, + "required": [ + "key", + "value" + ] + }, + "urn_samm_io.catenax.batch_2.0.0_LocalIdentifierCharacteristic": { + "description": "A batch may have multiple attributes, which uniquely identify that batch in a specific dataspace (e.g. the manufacturer`s dataspace)", + "type": "array", + "items": { + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_KeyValueList" + }, + "uniqueItems": true + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp": { + "type": "string", + "pattern": "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", + "description": "Describes a Property which contains the date and time with an optional timezone." + }, + "urn_samm_io.catenax.batch_2.0.0_ProductionCountryCodeTrait": { + "type": "string", + "description": "Regular Expression that ensures a three-letter code", + "pattern": "^[A-Z]{3}$" + }, + "urn_samm_io.catenax.batch_2.0.0_ManufacturingCharacteristic": { + "description": "Characteristic to describe manufacturing related data", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)", + "$ref": "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "country": { + "description": "Country code where the part was manufactured", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_ProductionCountryCodeTrait" + } + }, + "required": [ + "date" + ] + }, + "urn_samm_io.catenax.batch_2.0.0_PartIdCharacteristic": { + "type": "string", + "description": "The part ID is a multi-character string, ususally assigned by an ERP system" + }, + "urn_samm_io.catenax.batch_2.0.0_PartNameCharacteristic": { + "type": "string", + "description": "Part Name in string format from the respective system in the value chain" + }, + "urn_samm_io.catenax.batch_2.0.0_ClassificationCharacteristic": { + "type": "string", + "description": "A part type must be placed into one of the following classes: 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'.", + "enum": [ + "product", + "raw material", + "software", + "assembly", + "tool", + "component" + ] + }, + "urn_samm_io.catenax.batch_2.0.0_PartTypeInformationCharacteristic": { + "description": "The characteristics of the part type", + "type": "object", + "properties": { + "manufacturerPartId": { + "description": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number or batch number.", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_PartIdCharacteristic" + }, + "nameAtManufacturer": { + "description": "Name of the part as assigned by the manufacturer", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_PartNameCharacteristic" + }, + "classification": { + "description": "The classification of the part type according to STEP standard definition", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_ClassificationCharacteristic" + } + }, + "required": [ + "manufacturerPartId", + "nameAtManufacturer", + "classification" + ] + } + } + }, + "properties": { + "catenaXId": { + "description": "The fully anonymous Catena-X ID of the batch, valid for the Catena-X dataspace.", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_CatenaXIdTrait" + }, + "localIdentifiers": { + "description": "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_LocalIdentifierCharacteristic" + }, + "manufacturingInformation": { + "description": "Information from manufacturing process, such as manufacturing date and manufacturing country", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_ManufacturingCharacteristic" + }, + "partTypeInformation": { + "description": "The part type of which the batch has been instantiated of.", + "$ref": "#/components/schemas/urn_samm_io.catenax.batch_2.0.0_PartTypeInformationCharacteristic" + } + }, + "required": [ + "catenaXId", + "localIdentifiers", + "manufacturingInformation", + "partTypeInformation" + ] +} \ No newline at end of file diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java new file mode 100644 index 0000000000..762ddeaef1 --- /dev/null +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java @@ -0,0 +1,265 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.edc.client; + +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; +import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; + +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.List; +import java.util.Map; + +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.data.StringMapper; +import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; +import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; +import org.jetbrains.annotations.NotNull; + +public class SubmodelFacadeWiremockConfig { + + public static final String PATH_CATALOG = "/catalog/request"; + public static final String PATH_NEGOTIATE = "/contractnegotiations"; + public static final String PATH_TRANSFER = "/transferprocesses"; + public static final String PATH_STATE = "/state"; + public static final String PATH_DATAPLANE_PUBLIC = "/api/public"; + public static final String DATAPLANE_HOST = "http://provider.dataplane"; + public static final String CONTEXT = """ + { + "dct": "https://purl.org/dc/terms/", + "tx": "https://w3id.org/tractusx/v0.0.1/ns/", + "edc": "https://w3id.org/edc/v0.0.1/ns/", + "dcat": "https://www.w3.org/ns/dcat/", + "odrl": "http://www.w3.org/ns/odrl/2/", + "dspace": "https://w3id.org/dspace/v0.8/" + }"""; + public static final String EDC_PROVIDER_DUMMY_URL = "https://edc.io/api/v1/dsp"; + public static final String IRS_INTERNAL_CALLBACK_URL = "https://irs.test/internal/endpoint-data-reference"; + + // TODO move to irs-testing + + public static void prepareNegotiation(final EndpointDataReferenceStorage storage) { + prepareNegotiation(storage, "1bbaec6e-c316-4e1e-8258-c07a648cc43c", "1b21e963-0bc5-422a-b30d-fd3511861d88", + "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", + "5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7"); + } + + public static void prepareNegotiation(final EndpointDataReferenceStorage storage, final String negotiationId, + final String transferProcessId, final String contractAgreementId, final String edcAssetId) { + givenThat(post(urlPathEqualTo(PATH_CATALOG)).willReturn( + responseWithStatus(200).withBody(getCatalogResponse(edcAssetId, "USE", "BPNL00000003CRHK")))); + System.out.println(getCatalogResponse(edcAssetId, "USE", "BPNL00000003CRHK")); + givenThat(post(urlPathEqualTo(PATH_NEGOTIATE)).willReturn( + responseWithStatus(200).withBody(startNegotiationResponse(negotiationId)))); + + final String negotiationState = "FINALIZED"; + givenThat(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId)).willReturn(responseWithStatus(200).withBody( + getNegotiationConfirmedResponse(negotiationId, negotiationState, contractAgreementId)))); + + givenThat(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId + PATH_STATE)).willReturn( + responseWithStatus(200).withBody(getNegotiationStateResponse(negotiationState)))); + + givenThat(post(urlPathEqualTo(PATH_TRANSFER)).willReturn( + responseWithStatus(200).withBody(startTransferProcessResponse(transferProcessId)) + + )); + final String transferProcessState = "COMPLETED"; + givenThat(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId + PATH_STATE)).willReturn( + responseWithStatus(200).withBody(getTransferProcessStateResponse(transferProcessState)) + + )); + givenThat(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId)).willReturn( + responseWithStatus(200).withBody( + getTransferConfirmedResponse(transferProcessId, transferProcessState, edcAssetId, + contractAgreementId)))); + + final EndpointDataReference ref = createEndpointDataReference(contractAgreementId); + storage.put(contractAgreementId, ref); + } + + private static String startTransferProcessResponse(final String transferProcessId) { + return startNegotiationResponse(transferProcessId); + } + + private static String startNegotiationResponse(final String negotiationId) { + return """ + { + "@type": "edc:IdResponseDto", + "@id": "%s", + "edc:createdAt": 1686830151573, + "@context": %s + } + """.formatted(negotiationId, CONTEXT); + } + + private static String getNegotiationStateResponse(final String negotiationState) { + return stateResponseTemplate("edc:NegotiationState", negotiationState); + } + + private static String getTransferProcessStateResponse(final String transferProcessState) { + return stateResponseTemplate("edc:TransferState", transferProcessState); + } + + private static String stateResponseTemplate(final String responseType, final String negotiationState) { + return """ + { + "@type": "%s", + "edc:state": "%s", + "@context": %s + } + """.formatted(responseType, negotiationState, CONTEXT); + } + + private static String getNegotiationConfirmedResponse(final String negotiationId, final String negotiationState, + final String contractAgreementId) { + return """ + { + "@type": "edc:ContractNegotiationDto", + "@id": "%s", + "edc:type": "CONSUMER", + "edc:protocol": "dataspace-protocol-http", + "edc:state": "%s", + "edc:counterPartyAddress": "%s", + "edc:callbackAddresses": [], + "edc:contractAgreementId": "%s", + "@context": %s + } + """.formatted(negotiationId, negotiationState, EDC_PROVIDER_DUMMY_URL, contractAgreementId, CONTEXT); + } + + private static String getTransferConfirmedResponse(final String transferProcessId, final String transferState, + final String edcAssetId, final String contractAgreementId) { + return """ + { + "@id": "%s", + "@type": "edc:TransferProcessDto", + "edc:state": "%s", + "edc:stateTimestamp": 1688024335567, + "edc:type": "CONSUMER", + "edc:callbackAddresses": [], + "edc:dataDestination": { + "edc:type": "HttpProxy" + }, + "edc:dataRequest": { + "@type": "edc:DataRequestDto", + "@id": "%s", + "edc:assetId": "%s", + "edc:contractId": "%s", + "edc:connectorId": "BPNL00000003CRHK" + }, + "edc:receiverHttpEndpoint": "%s", + "@context": %s + } + """.formatted(transferProcessId, transferState, transferProcessId, edcAssetId, contractAgreementId, + IRS_INTERNAL_CALLBACK_URL, CONTEXT); + } + + private static String getCatalogResponse(final String edcAssetId, final String permissionType, + final String edcProviderBpn) { + return """ + { + "@id": "78ff625c-0c05-4014-965c-bd3d0a6a0de0", + "@type": "dcat:Catalog", + "dcat:dataset": { + "@id": "58505404-4da1-427a-82aa-b79482bcd1f0", + "@type": "dcat:Dataset", + "odrl:hasPolicy": { + "@id": "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:66131c58-32af-4df0-825d-77f7df6017c1", + "@type": "odrl:Set", + "odrl:permission": { + "odrl:target": "%s", + "odrl:action": { + "odrl:type": "%s" + }, + "odrl:constraint": %s + }, + "odrl:prohibition": [], + "odrl:obligation": [], + "odrl:target": "%s" + }, + "dcat:distribution": [ + { + "@type": "dcat:Distribution", + "dct:format": { + "@id": "HttpProxy" + }, + "dcat:accessService": "4ba1faa1-7f1a-4fb7-a41c-317f450e7443" + } + ], + "edc:description": "IRS EDC Test Asset", + "edc:id": "%s" + }, + "dcat:service": { + "@id": "4ba1faa1-7f1a-4fb7-a41c-317f450e7443", + "@type": "dcat:DataService", + "dct:terms": "connector", + "dct:endpointUrl": "%s" + }, + "edc:participantId": "%s", + "@context": %s + } + """.formatted(edcAssetId, permissionType, createConstraints(), edcAssetId, edcAssetId, + EDC_PROVIDER_DUMMY_URL, edcProviderBpn, CONTEXT); + } + + @NotNull + private static String createConstraints() { + final List atomitConstraints = List.of(createAtomicConstraint("Membership", "active"), + createAtomicConstraint("FrameworkAgreement.traceability", "active")); + return """ + { + "odrl:and": [ + %s + ] + }""".formatted(String.join(",\n", atomitConstraints)); + } + + private static String createAtomicConstraint(final String leftOperand, final String rightOperand) { + return """ + { + "odrl:leftOperand": "%s", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "%s" + }""".formatted(leftOperand, rightOperand); + } + + public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + return EndpointDataReference.Builder.newInstance() + .authKey("testkey") + .authCode(jwtToken) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) + .build(); + } +} \ No newline at end of file diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java index 7471135414..43ef624320 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java @@ -23,17 +23,13 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client; -import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; -import static com.github.tomakehurst.wiremock.client.WireMock.configureFor; import static com.github.tomakehurst.wiremock.client.WireMock.get; import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; -import static com.github.tomakehurst.wiremock.client.WireMock.post; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration.NAMESPACE_EDC_CID; import static org.eclipse.tractusx.irs.edc.client.testutil.TestMother.createEdcTransformer; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; @@ -43,19 +39,16 @@ import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.List; -import java.util.Map; import java.util.concurrent.ExecutionException; import java.util.concurrent.Executors; import java.util.concurrent.TimeUnit; import com.fasterxml.jackson.databind.ObjectMapper; -import com.github.tomakehurst.wiremock.WireMockServer; import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; import com.github.tomakehurst.wiremock.junit5.WireMockTest; import io.github.resilience4j.retry.RetryRegistry; import org.assertj.core.api.ThrowableAssert; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; -import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.cache.endpointdatareference.EndpointDataReferenceCacheService; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.eclipse.tractusx.irs.edc.client.exceptions.UsagePolicyException; @@ -68,10 +61,8 @@ import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.PolicyCheckerService; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; -import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; import org.springframework.web.client.RestClientException; @@ -119,7 +110,8 @@ void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { final EdcDataPlaneClient dataPlaneClient = new EdcDataPlaneClient(restTemplate); final EDCCatalogFacade catalogFacade = new EDCCatalogFacade(controlPlaneClient, config); - final EndpointDataReferenceCacheService endpointDataReferenceCacheService = new EndpointDataReferenceCacheService(new EndpointDataReferenceStorage(Duration.ofMinutes(1))); + final EndpointDataReferenceCacheService endpointDataReferenceCacheService = new EndpointDataReferenceCacheService( + new EndpointDataReferenceStorage(Duration.ofMinutes(1))); acceptedPoliciesProvider = mock(AcceptedPoliciesProvider.class); when(acceptedPoliciesProvider.getAcceptedPolicies()).thenReturn(List.of(new AcceptedPolicy(policy("IRS Policy", @@ -141,12 +133,9 @@ void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { void shouldReturnAssemblyPartRelationshipAsString() throws EdcClientException, ExecutionException, InterruptedException { // Arrange - prepareNegotiation(); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBodyFile( - "singleLevelBomAsBuilt.json"))); + SubmodelFacadeWiremockConfig.prepareNegotiation(storage); + givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + responseWithStatus(200).withBodyFile("singleLevelBomAsBuilt.json"))); // Act final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, @@ -156,69 +145,13 @@ void shouldReturnAssemblyPartRelationshipAsString() assertThat(submodel).contains("\"catenaXId\": \"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\""); } - private void prepareNegotiation() { - final var contentType = "application/json;charset=UTF-8"; - final var pathCatalog = "/catalog/request"; - final var pathNegotiate = "/contractnegotiations"; - final var pathTransfer = "/transferprocesses"; - givenThat(post(urlPathEqualTo(pathCatalog)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", contentType) - .withBodyFile("edc/responseCatalog.json"))); - - givenThat(post(urlPathEqualTo(pathNegotiate)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", contentType) - .withBodyFile( - "edc/responseStartNegotiation.json"))); - - final var negotiationId = "1bbaec6e-c316-4e1e-8258-c07a648cc43c"; - givenThat(get(urlPathEqualTo(pathNegotiate + "/" + negotiationId)).willReturn(aResponse().withStatus(200) - .withHeader( - "Content-Type", - contentType) - .withBodyFile( - "edc/responseGetNegotiationConfirmed.json"))); - givenThat(get(urlPathEqualTo(pathNegotiate + "/" + negotiationId + "/state")).willReturn( - aResponse().withStatus(200) - .withHeader("Content-Type", contentType) - .withBodyFile("edc/responseGetNegotiationState.json"))); - - givenThat(post(urlPathEqualTo(pathTransfer)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", contentType) - .withBodyFile( - "edc/responseStartTransferprocess.json"))); - final var transferProcessId = "1b21e963-0bc5-422a-b30d-fd3511861d88"; - givenThat(get(urlPathEqualTo(pathTransfer + "/" + transferProcessId + "/state")).willReturn( - aResponse().withStatus(200) - .withHeader("Content-Type", contentType) - .withBodyFile("edc/responseGetTransferState.json"))); - givenThat(get(urlPathEqualTo(pathTransfer + "/" + transferProcessId)).willReturn(aResponse().withStatus(200) - .withHeader( - "Content-Type", - contentType) - .withBodyFile( - "edc/responseGetTransferConfirmed.json"))); - - final var contractAgreementId = "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:a6144a2e-c1b1-4ec6-96e1-a221da134e4f"; - final EndpointDataReference ref = EndpointDataReference.Builder.newInstance() - .authKey("testkey") - .authCode("testcode") - .properties(Map.of(NAMESPACE_EDC_CID, - contractAgreementId)) - .endpoint("http://provider.dataplane/api/public") - .build(); - storage.put(contractAgreementId, ref); - } - @Test void shouldReturnMaterialForRecyclingAsString() throws EdcClientException, ExecutionException, InterruptedException { // Arrange - prepareNegotiation(); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBodyFile( - "materialForRecycling.json"))); + SubmodelFacadeWiremockConfig.prepareNegotiation(storage); + givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + responseWithStatus(200).withBodyFile("materialForRecycling.json"))); // Act final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, @@ -232,11 +165,8 @@ void shouldReturnMaterialForRecyclingAsString() void shouldReturnObjectAsStringWhenResponseNotJSON() throws EdcClientException, ExecutionException, InterruptedException { // Arrange - prepareNegotiation(); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBody("test"))); + SubmodelFacadeWiremockConfig.prepareNegotiation(storage); + givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(responseWithStatus(200).withBody("test"))); // Act final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, @@ -259,27 +189,22 @@ void shouldThrowExceptionWhenPoliciesAreNotAccepted() { when(acceptedPoliciesProvider.getAcceptedPolicies()).thenReturn(List.of(acceptedPolicy)); - prepareNegotiation(); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBody("test"))); + SubmodelFacadeWiremockConfig.prepareNegotiation(storage); + givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(responseWithStatus(200).withBody("test"))); // Act & Assert final String errorMessage = "Consumption of asset '58505404-4da1-427a-82aa-b79482bcd1f0' is not permitted as the required catalog offer policies do not comply with defined IRS policies."; assertThatExceptionOfType(UsagePolicyException.class).isThrownBy( - () -> edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId) - .get()).withMessageEndingWith(errorMessage); + () -> edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get()) + .withMessageEndingWith(errorMessage); } @Test void shouldThrowExceptionWhenResponse_400() { // Arrange - prepareNegotiation(); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(aResponse().withStatus(400) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBody("{ error: '400'}"))); + SubmodelFacadeWiremockConfig.prepareNegotiation(storage); + givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + responseWithStatus(400).withBody("{ error: '400'}"))); // Act final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( @@ -293,11 +218,9 @@ void shouldThrowExceptionWhenResponse_400() { @Test void shouldThrowExceptionWhenResponse_500() { // Arrange - prepareNegotiation(); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(aResponse().withStatus(500) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBody("{ error: '500'}"))); + SubmodelFacadeWiremockConfig.prepareNegotiation(storage); + givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + responseWithStatus(500).withBody("{ error: '500'}"))); // Act final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( @@ -308,7 +231,6 @@ void shouldThrowExceptionWhenResponse_500() { .withCauseInstanceOf(RestClientException.class); } - private org.eclipse.tractusx.irs.edc.client.policy.Policy policy(String policyId, List permissions) { return new org.eclipse.tractusx.irs.edc.client.policy.Policy(policyId, OffsetDateTime.now(), OffsetDateTime.now().plusYears(1), permissions); diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index e00704f8c8..1072ea7e6d 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -27,24 +27,24 @@ import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.DATAPLANE_URL; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.DISCOVERY_FINDER_PATH; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.DISCOVERY_FINDER_URL; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.EDC_DISCOVERY_PATH; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.LOOKUP_SHELLS_PATH; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.SHELL_DESCRIPTORS_PATH; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.TEST_BPN; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getLookupShells200; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getLookupShells200Empty; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getLookupShells404; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getShellDescriptor200; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.getShellDescriptor404; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postDiscoveryFinder200; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postDiscoveryFinder404; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postEdcDiscovery200; -import static org.eclipse.tractusx.irs.registryclient.decentral.DtrWiremockConfig.postEdcDiscovery404; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder404; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery404; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200Empty; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells404; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor404; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; @@ -121,6 +121,7 @@ void shouldThrowHttpClientExceptionInCaseOfDiscoveryError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert + // TODO fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -134,6 +135,7 @@ void shouldThrowHttpClientExceptionInCaseOfEdcDiscoveryError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert + // TODO fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -149,6 +151,7 @@ void shouldThrowHttpClientExceptionInCaseOfLookupShellsError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert + // TODO fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -166,6 +169,7 @@ void shouldThrowHttpClientExceptionInCaseOfShellDescriptorsError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert + // TODO fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -184,11 +188,12 @@ void shouldThrowExceptionOnEmptyShells() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert + // TODO fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); - verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); + verify(exactly(1), getRequestedFor(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*"))); } } diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java new file mode 100644 index 0000000000..6130c1501d --- /dev/null +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java @@ -0,0 +1,93 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.testing.wiremock; + +import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.*; + +import java.util.List; + +import com.github.tomakehurst.wiremock.client.MappingBuilder; + +public class DiscoveryServiceWiremockConfig { + public static final String CONTROLPLANE_PUBLIC_URL = "https://controlplane.test"; + public static final String EDC_DISCOVERY_PATH = "/edcDiscovery"; + public static final String TEST_BPN = "BPNL00000000TEST"; + public static final String DISCOVERY_FINDER_PATH = "/discoveryFinder"; + public static final String DISCOVERY_HOST = "http://discovery.finder"; + public static final String EDC_DISCOVERY_URL = DISCOVERY_HOST + EDC_DISCOVERY_PATH; + public static final String DISCOVERY_FINDER_URL = DISCOVERY_HOST + DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; + + public static MappingBuilder postEdcDiscovery200() { + return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn( + responseWithStatus(200).withBody(edcDiscoveryResponse(TEST_BPN, List.of(CONTROLPLANE_PUBLIC_URL)))); + } + + public static String edcDiscoveryResponse(final String bpn, final List connectorEndpoints) { + return """ + [ + { + "bpn": "%s", + "connectorEndpoint": [ + %s + ] + } + ] + """.formatted(bpn, String.join(",\n", connectorEndpoints.stream().map(s -> "\"" + s + "\"").toList())); + } + + public static MappingBuilder postDiscoveryFinder200() { + return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn( + responseWithStatus(200).withBody(discoveryFinderResponse(EDC_DISCOVERY_URL))); + } + + public static String discoveryFinderResponse(final String discoveryFinderUrl) { + return """ + { + "endpoints": [ + { + "type": "bpn", + "description": "Service to discover EDC to a particular BPN", + "endpointAddress": "%s", + "documentation": "http://.../swagger/index.html", + "resourceId": "316417cd-0fb5-4daf-8dfa-8f68125923f1" + } + ] + } + """.formatted(discoveryFinderUrl); + } + + public static String discoveryFinderEmtpyResponse() { + return """ + { + "endpoints": [ + ] + } + """; + } + + public static MappingBuilder postDiscoveryFinder404() { + return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn(responseWithStatus(404)); + } + + public static MappingBuilder postEdcDiscovery404() { + return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn(responseWithStatus(404)); + } +} diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java similarity index 58% rename from irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java rename to irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java index 00f1719e82..4f29f1fbd1 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DtrWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java @@ -16,60 +16,54 @@ * * SPDX-License-Identifier: Apache-2.0 ********************************************************************************/ -package org.eclipse.tractusx.irs.registryclient.decentral; +package org.eclipse.tractusx.irs.testing.wiremock; -import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.post; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import java.util.List; import com.github.tomakehurst.wiremock.client.MappingBuilder; -import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder; public class DtrWiremockConfig { + public static final String DATAPLANE_URL = "http://dataplane.test"; + public static final String DATAPLANE_PUBLIC_URL = DATAPLANE_URL + "/api/public/data/"; public static final String SHELL_DESCRIPTORS_PATH = "/shell-descriptors/"; public static final String SHELL_DESCRIPTORS_TEMPLATE = SHELL_DESCRIPTORS_PATH + "{aasIdentifier}"; public static final String LOOKUP_SHELLS_PATH = "/lookup/shells"; public static final String LOOKUP_SHELLS_TEMPLATE = LOOKUP_SHELLS_PATH + "?assetIds={assetIds}"; - public static final String DISCOVERY_FINDER_PATH = "/discoveryFinder"; - public static final String EDC_DISCOVERY_PATH = "/edcDiscovery"; - public static final String TEST_BPN = "BPNL00000000TEST"; - public static final String DISCOVERY_HOST = "http://discovery.finder"; - public static final String DATAPLANE_URL = "http://dataplane.test"; - public static final String DISCOVERY_FINDER_URL = DISCOVERY_HOST + DISCOVERY_FINDER_PATH; - static ResponseDefinitionBuilder responseWithStatus(final int statusCode) { - return aResponse().withStatus(statusCode).withHeader("Content-Type", "application/json;charset=UTF-8"); + private DtrWiremockConfig() { } - static MappingBuilder getShellDescriptor200() { - final String materialForRecycling = submodel("https://dataplane.test/api/public/data/", - "urn:uuid:19b0338f-6d03-4198-b3b8-5c43f8958d60", "https://controlplane.test", "MaterialForRecycling", - "urn:uuid:cf06d5d5-e3f8-4bd4-bfcf-81815310701f", + public static MappingBuilder getShellDescriptor200() { + final String materialForRecycling = submodelDescriptor(DATAPLANE_PUBLIC_URL, + "urn:uuid:19b0338f-6d03-4198-b3b8-5c43f8958d60", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, + "MaterialForRecycling", "urn:uuid:cf06d5d5-e3f8-4bd4-bfcf-81815310701f", "urn:bamm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling"); - final String batch = submodel("https://dataplane.test/api/public/data/", - "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", "https://controlplane.test", "Batch", + final String batch = submodelDescriptor(DATAPLANE_PUBLIC_URL, "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", + DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "Batch", "urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf", "urn:samm:io.catenax.batch:2.0.0#Batch"); - final String singleLevelUsageAsBuilt = submodel("https://dataplane.test/api/public/data/", - "urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26", "https://controlplane.test", "SingleLevelUsageAsBuilt", - "urn:uuid:e2899f43-eca8-4aec-b877-4a69691f0487", + final String singleLevelUsageAsBuilt = submodelDescriptor(DATAPLANE_PUBLIC_URL, + "urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, + "SingleLevelUsageAsBuilt", "urn:uuid:e2899f43-eca8-4aec-b877-4a69691f0487", "urn:bamm:io.catenax.single_level_usage_as_built:2.0.0#SingleLevelUsageAsBuilt"); final List submodelDescriptors = List.of(materialForRecycling, batch, singleLevelUsageAsBuilt); final List specificAssetIds = List.of(specificAssetId("manufacturerId", "BPNL00000003B0Q0"), specificAssetId("batchId", "BID12345678")); return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn(responseWithStatus(200).withBody( - assetAdministrationShell(submodelDescriptors, "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", + assetAdministrationShellResponse(submodelDescriptors, "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", "EngineeringPlastics", "urn:uuid:9ce43b21-75e3-4cea-b13e-9a34f4f6822a", specificAssetIds))); } - public static String assetAdministrationShell(final List submodelDescriptors, final String globalAssetId, - final String idShort, final String shellId, final List specificAssetIds) { + public static String assetAdministrationShellResponse(final List submodelDescriptors, + final String globalAssetId, final String idShort, final String shellId, + final List specificAssetIds) { return """ { "description": [], @@ -107,7 +101,7 @@ public static String specificAssetId(final String key, final String value) { """.formatted(key, value); } - public static String submodel(final String dataplaneUrl, final String assetId, final String dspEndpoint, + public static String submodelDescriptor(final String dataplaneUrl, final String assetId, final String dspEndpoint, final String idShort, final String submodelDescriptorId, final String semanticId) { final String href = dataplaneUrl + submodelDescriptorId; return """ @@ -152,73 +146,17 @@ public static String submodel(final String dataplaneUrl, final String assetId, f """.formatted(href, assetId, dspEndpoint, idShort, submodelDescriptorId, semanticId); } - static MappingBuilder postEdcDiscovery200() { - return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn( - responseWithStatus(200).withBody(edcDiscovery("BPNL00000000TEST", List.of("http://edc.test/edc")))); - } - - public static String edcDiscovery(final String bpn, final List connectorEndpoints) { - return """ - [ - { - "bpn": "%s", - "connectorEndpoint": [ - %s - ] - } - ] - """.formatted(bpn, String.join(",\n", connectorEndpoints.stream().map(s -> "\"" + s + "\"").toList())); - } - - static MappingBuilder postDiscoveryFinder200() { - return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn( - responseWithStatus(200).withBody(discoveryFinder("http://discovery.finder/edcDiscovery"))); - } - - public static String discoveryFinder(final String discoveryFinderUrl) { - return """ - { - "endpoints": [ - { - "type": "bpn", - "description": "Service to discover EDC to a particular BPN", - "endpointAddress": "%s", - "documentation": "http://.../swagger/index.html", - "resourceId": "316417cd-0fb5-4daf-8dfa-8f68125923f1" - } - ] - } - """.formatted(discoveryFinderUrl); - } - - private static String discoveryFinderEmtpy() { - return """ - { - "endpoints": [ - ] - } - """; - } - - static MappingBuilder postDiscoveryFinder404() { - return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn(responseWithStatus(404)); - } - - static MappingBuilder postEdcDiscovery404() { - return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn(responseWithStatus(404)); - } - - static MappingBuilder getLookupShells200() { + public static MappingBuilder getLookupShells200() { return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(200).withBody( - lookupShells(List.of("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf")))); + lookupShellsResponse(List.of("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf")))); } - static MappingBuilder getLookupShells200Empty() { + public static MappingBuilder getLookupShells200Empty() { return get(urlPathMatching(LOOKUP_SHELLS_PATH + ".*")).willReturn( - responseWithStatus(200).withBody(lookupShells(List.of()))); + responseWithStatus(200).withBody(lookupShellsResponse(List.of()))); } - public static String lookupShells(final List shellIds) { + public static String lookupShellsResponse(final List shellIds) { return """ { "paging_metadata": {}, @@ -229,11 +167,11 @@ public static String lookupShells(final List shellIds) { """.formatted(String.join(",\n", shellIds.stream().map(s -> "\"" + s + "\"").toList())); } - static MappingBuilder getLookupShells404() { + public static MappingBuilder getLookupShells404() { return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(404)); } - static MappingBuilder getShellDescriptor404() { + public static MappingBuilder getShellDescriptor404() { return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn(responseWithStatus(404)); } } \ No newline at end of file diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java index 9ff8b9562c..21598577df 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java @@ -18,9 +18,12 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.testing.wiremock; +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; + import java.net.InetSocketAddress; import java.net.Proxy; +import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder; import org.springframework.http.client.SimpleClientHttpRequestFactory; import org.springframework.web.client.RestTemplate; @@ -44,4 +47,8 @@ public static RestTemplate restTemplateProxy(final String proxyServerHost, final requestFactory.setProxy(proxy); return new RestTemplate(requestFactory); } + + public static ResponseDefinitionBuilder responseWithStatus(final int statusCode) { + return aResponse().withStatus(statusCode).withHeader("Content-Type", "application/json;charset=UTF-8"); + } } From 3a8469c06c4ec572f73e2160836445384ed072a2 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Thu, 25 Jan 2024 14:47:44 +0100 Subject: [PATCH 048/116] feat(irs):[#249] extend policies structure --- docs/src/api/irs-api.yaml | 132 +++++++++++++----- .../irs/edc/client/policy/Constraint.java | 16 ++- .../policy/ConstraintCheckerService.java | 8 +- .../irs/edc/client/policy/Constraints.java | 3 + .../irs/edc/client/policy/Operator.java | 44 ++++++ .../irs/edc/client/policy/OperatorType.java | 13 +- .../irs/edc/client/policy/Permission.java | 12 +- .../irs/edc/client/policy/Policy.java | 4 + .../client/transformer/EdcTransformer.java | 7 + .../JsonObjectToPolicyTransformer.java | 65 +++++++++ .../client/SubmodelFacadeWiremockTest.java | 13 +- .../policy/ConstraintCheckerServiceTest.java | 11 +- .../policy/PolicyCheckerServiceTest.java | 38 ++--- .../config/PolicyConfiguration.java | 7 + .../controllers/PolicyStoreController.java | 10 +- .../models/CreatePolicyRequest.java | 54 +++++-- .../services/PolicyStoreService.java | 28 ++-- .../PolicyStoreControllerTest.java | 71 ++++++++-- .../services/PolicyStoreServiceTest.java | 39 +++--- 19 files changed, 430 insertions(+), 145 deletions(-) create mode 100644 irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Operator.java create mode 100644 irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml index 67879e47ea..11394feaca 100644 --- a/docs/src/api/irs-api.yaml +++ b/docs/src/api/irs-api.yaml @@ -1676,28 +1676,11 @@ components: leftOperand: type: string example: string - operator: + 'odrl:rightOperand': type: string - example: eq - enum: - - eq - - neq - - lt - - gt - - in - - lteq - - gteq - - isA - - hasPart - - isPartOf - - isOneOf - - isAllOf - - isNoneOf - rightOperand: - type: array - items: - type: string - example: [string] + example: string + operator: + $ref: '#/components/schemas/Operator' Constraints: type: object additionalProperties: false @@ -1715,21 +1698,48 @@ components: additionalProperties: false description: Request to add a policy properties: - permissions: - type: array - description: List of permissions that will be added to the Policy on creation. - items: - $ref: '#/components/schemas/Permission' - policyId: - type: string - description: The ID of the policy to add + payload: + type: object + additionalProperties: + $ref: '#/components/schemas/JsonValue' + example: + payload: + '@context': + odrl: http://www.w3.org/ns/odrl/2/ + '@id': policy-id + policy: + 'odrl:permission': + - 'odrl:action': USE + 'odrl:constraint': + 'odrl:and': + - 'odrl:leftOperand': Membership + 'odrl:operator': + '@id': 'odrl:eq' + 'odrl:rightOperand': active + - 'odrl:leftOperand': PURPOSE + 'odrl:operator': + '@id': 'odrl:eq' + 'odrl:rightOperand': ID 3.1 Trace + validUntil: '2025-12-12T23:59:59.999Z' + properties: + empty: + type: boolean + valueType: + type: string + enum: + - 'ARRAY' + - 'OBJECT' + - 'STRING' + - 'NUMBER' + - 'TRUE' + - 'FALSE' + - 'NULL' validUntil: type: string format: date-time description: Timestamp after which the policy will no longer be accepted in negotiations required: - - permissions - - policyId + - payload - validUntil EdcNotificationResponseNotificationContent: type: object @@ -2071,6 +2081,39 @@ components: items: $ref: '#/components/schemas/Tombstone' maxItems: 2147483647 + JsonValue: + type: object + additionalProperties: false + properties: + valueType: + type: string + enum: + - 'ARRAY' + - 'OBJECT' + - 'STRING' + - 'NUMBER' + - 'TRUE' + - 'FALSE' + - 'NULL' + example: + payload: + '@context': + odrl: http://www.w3.org/ns/odrl/2/ + '@id': policy-id + policy: + 'odrl:permission': + - 'odrl:action': USE + 'odrl:constraint': + 'odrl:and': + - 'odrl:leftOperand': Membership + 'odrl:operator': + '@id': 'odrl:eq' + 'odrl:rightOperand': active + - 'odrl:leftOperand': PURPOSE + 'odrl:operator': + '@id': 'odrl:eq' + 'odrl:rightOperand': ID 3.1 Trace + validUntil: '2025-12-12T23:59:59.999Z' LangString: type: object additionalProperties: false @@ -2129,6 +2172,27 @@ components: lexicalValue: type: string example: piece + Operator: + type: object + additionalProperties: false + properties: + '@id': + type: string + example: 'odrl:eq' + enum: + - eq + - neq + - lt + - gt + - in + - lteq + - gteq + - isA + - hasPart + - isPartOf + - isOneOf + - isAllOf + - isNoneOf PageResult: type: object additionalProperties: false @@ -2182,10 +2246,8 @@ components: enum: - ACCESS - USE - constraints: - type: array - items: - $ref: '#/components/schemas/Constraints' + constraint: + $ref: '#/components/schemas/Constraints' Policy: type: object additionalProperties: false diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraint.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraint.java index 1438a22760..9608b4d25f 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraint.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraint.java @@ -23,9 +23,8 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client.policy; -import java.util.List; - -import io.swagger.v3.oas.annotations.media.ArraySchema; +import com.fasterxml.jackson.annotation.JsonAlias; +import com.fasterxml.jackson.annotation.JsonProperty; import io.swagger.v3.oas.annotations.media.Schema; import lombok.AllArgsConstructor; import lombok.Getter; @@ -40,10 +39,13 @@ public class Constraint { @Schema(implementation = String.class, example = "string") + @JsonAlias({"odrl:leftOperand"}) private String leftOperand; - @Schema(implementation = OperatorType.class, example = "eq") - private OperatorType operator; - @ArraySchema(arraySchema = @Schema(example = "[\"string\"]", implementation = String.class)) - private List rightOperand; + @JsonAlias("odrl:operator") + @Schema + private Operator operator; + @Schema(implementation = String.class, example = "string") + @JsonProperty("odrl:rightOperand") + private String rightOperand; } diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerService.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerService.java index 9cb07b86fb..56eb3aabf4 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerService.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerService.java @@ -23,7 +23,6 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client.policy; -import java.util.Collection; import java.util.List; import lombok.extern.slf4j.Slf4j; @@ -45,8 +44,7 @@ public class ConstraintCheckerService { public boolean hasAllConstraint(final Policy acceptedPolicy, final List constraints) { final List acceptedConstraintsList = acceptedPolicy.getPermissions() .stream() - .map(Permission::getConstraints) - .flatMap(Collection::stream) + .map(Permission::getConstraint) .toList(); return constraints.stream().allMatch(constraint -> isValidOnList(constraint, acceptedConstraintsList)); @@ -90,8 +88,8 @@ private boolean isSameAs(final AtomicConstraint atomicConstraint, .atomicConstraint(atomicConstraint) .leftExpressionValue(acceptedConstraint.getLeftOperand()) .rightExpressionValue( - acceptedConstraint.getRightOperand().stream().findFirst().orElse("")) - .expectedOperator(Operator.valueOf(acceptedConstraint.getOperator().name())) + acceptedConstraint.getRightOperand()) + .expectedOperator(Operator.valueOf(acceptedConstraint.getOperator().getOperatorType().name())) .build() .isValid(); } diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraints.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraints.java index 014dd17b60..eb1d637b4e 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraints.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Constraints.java @@ -25,6 +25,7 @@ import java.util.List; +import com.fasterxml.jackson.annotation.JsonAlias; import io.swagger.v3.oas.annotations.media.ArraySchema; import lombok.AllArgsConstructor; import lombok.Builder; @@ -42,8 +43,10 @@ public class Constraints { @ArraySchema + @JsonAlias({"odrl:and"}) private List and; @ArraySchema + @JsonAlias({"odrl:or"}) private List or; } diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Operator.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Operator.java new file mode 100644 index 0000000000..fd5896edda --- /dev/null +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Operator.java @@ -0,0 +1,44 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2023 + * 2022: ZF Friedrichshafen AG + * 2022: ISTOS GmbH + * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2023: BOSCH AG + * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.edc.client.policy; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.v3.oas.annotations.media.Schema; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +/** + * Wrapper for OperatorType + */ +@Getter +@AllArgsConstructor +@NoArgsConstructor +@Schema +public class Operator { + + @JsonProperty("@id") + @Schema(implementation = OperatorType.class, example = "odrl:eq") + private OperatorType operatorType; +} diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/OperatorType.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/OperatorType.java index db298622e8..536fcd6788 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/OperatorType.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/OperatorType.java @@ -55,6 +55,8 @@ public enum OperatorType { private final String code; private final String label; + private static final int ODRL_PREFIX_INDEX = 5; + OperatorType(final String code, final String label) { this.code = code; this.label = label; @@ -62,10 +64,17 @@ public enum OperatorType { @JsonCreator public static OperatorType fromValue(final String value) { + String operator; + if (value.startsWith("odrl:")) { + operator = value.substring(ODRL_PREFIX_INDEX); + } else { + operator = value; + } + return Stream.of(OperatorType.values()) - .filter(operatorType -> operatorType.code.equals(value)) + .filter(operatorType -> operatorType.code.equals(operator)) .findFirst() - .orElseThrow(() -> new NoSuchElementException("Unsupported OperatorType: " + value)); + .orElseThrow(() -> new NoSuchElementException("Unsupported OperatorType: " + operator)); } /** diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Permission.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Permission.java index f6fdd3ea2e..4b328f432b 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Permission.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Permission.java @@ -23,9 +23,8 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client.policy; -import java.util.List; - -import io.swagger.v3.oas.annotations.media.ArraySchema; +import com.fasterxml.jackson.annotation.JsonAlias; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import io.swagger.v3.oas.annotations.media.Schema; import lombok.AllArgsConstructor; import lombok.Builder; @@ -39,11 +38,14 @@ @AllArgsConstructor @NoArgsConstructor @Builder +@JsonIgnoreProperties(ignoreUnknown = true) public class Permission { @Schema(implementation = PolicyType.class, example = "USE") + @JsonAlias({"odrl:action"}) private PolicyType action; - @ArraySchema - private List constraints; + @Schema + @JsonAlias({"odrl:constraint"}) + private Constraints constraint; } diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Policy.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Policy.java index 356e8dfbac..11b0cdefe7 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Policy.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/policy/Policy.java @@ -26,18 +26,21 @@ import java.time.OffsetDateTime; import java.util.List; +import com.fasterxml.jackson.annotation.JsonAlias; import io.swagger.v3.oas.annotations.media.ArraySchema; import io.swagger.v3.oas.annotations.media.Schema; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Getter; import lombok.NoArgsConstructor; +import lombok.Setter; import lombok.extern.jackson.Jacksonized; /** * A stored policy object. */ @Getter +@Setter @AllArgsConstructor @NoArgsConstructor @Builder @@ -52,6 +55,7 @@ public class Policy { @Schema(implementation = OffsetDateTime.class) private OffsetDateTime validUntil; @ArraySchema(schema = @Schema) + @JsonAlias({ "odrl:permission" }) private List permissions; public Policy update(final OffsetDateTime validUntil) { diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java index b48ad6ea50..1d96d2c6dd 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java @@ -67,6 +67,7 @@ import org.eclipse.tractusx.irs.edc.client.model.ContractOfferDescription; import org.eclipse.tractusx.irs.edc.client.model.NegotiationRequest; import org.eclipse.tractusx.irs.edc.client.model.TransferProcessRequest; +import org.eclipse.tractusx.irs.edc.client.policy.Policy; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.stereotype.Component; @@ -81,6 +82,7 @@ public class EdcTransformer { private final JsonObjectFromTransferProcessRequestTransformer jsonObjectFromTransferProcessRequestTransformer; private final JsonObjectFromContractOfferDescriptionTransformer jsonObjectFromContractOfferDescriptionTransformer; private final JsonObjectFromCatalogRequestTransformer jsonObjectFromCatalogRequestTransformer; + private final org.eclipse.tractusx.irs.edc.client.transformer.JsonObjectToPolicyTransformer jsonObjectToPolicyTransformer; private final TitaniumJsonLd titaniumJsonLd; private final TransformerContextImpl transformerContext; @@ -97,6 +99,7 @@ public EdcTransformer(@Qualifier("jsonLdObjectMapper") final ObjectMapper object jsonObjectFromContractOfferDescriptionTransformer = new JsonObjectFromContractOfferDescriptionTransformer( jsonBuilderFactory); jsonObjectFromCatalogRequestTransformer = new JsonObjectFromCatalogRequestTransformer(jsonBuilderFactory); + jsonObjectToPolicyTransformer = new org.eclipse.tractusx.irs.edc.client.transformer.JsonObjectToPolicyTransformer(objectMapper); final TypeTransformerRegistry typeTransformerRegistry = new TypeTransformerRegistryImpl(); transformerContext = new TransformerContextImpl(typeTransformerRegistry); @@ -167,4 +170,8 @@ public JsonObject transformCatalogRequestToJson(final CatalogRequest catalogRequ transformerContext); return titaniumJsonLd.compact(transform).asOptional().orElseThrow(); } + + public Policy transformToPolicy(final JsonObject body) { + return jsonObjectToPolicyTransformer.transform(body, transformerContext); + } } diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java new file mode 100644 index 0000000000..e9d1dc6ad0 --- /dev/null +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java @@ -0,0 +1,65 @@ +/******************************************************************************** + * Copyright (c) 2021,2022,2023 + * 2022: ZF Friedrichshafen AG + * 2022: ISTOS GmbH + * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * 2022,2023: BOSCH AG + * Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.edc.client.transformer; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import jakarta.json.JsonObject; +import org.eclipse.edc.jsonld.spi.transformer.AbstractJsonLdTransformer; +import org.eclipse.edc.transform.spi.TransformerContext; +import org.eclipse.tractusx.irs.data.JsonParseException; +import org.eclipse.tractusx.irs.edc.client.policy.Policy; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +/** + * Transformer to convert JSON-LD to Policy. + */ +public class JsonObjectToPolicyTransformer extends AbstractJsonLdTransformer { + + private final ObjectMapper objectMapper; + + protected JsonObjectToPolicyTransformer(final ObjectMapper objectMapper) { + super(JsonObject.class, Policy.class); + this.objectMapper = objectMapper; + } + + @Override + public @Nullable Policy transform(@NotNull final JsonObject jsonObject, + @NotNull final TransformerContext transformerContext) { + final Policy.PolicyBuilder builder = Policy.builder(); + builder.policyId(jsonObject.get("@id").toString()); + + this.visitProperties(jsonObject, (key) -> v -> { + try { + final Object result = objectMapper.readerFor(Policy.class).readValue(v.asJsonObject().toString()); + builder.permissions(((Policy) result).getPermissions()); + } catch (JsonProcessingException e) { + throw new JsonParseException(e); + } + }); + + return builder.build(); + } +} diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java index a6fdc2217e..75f11352d8 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java @@ -60,6 +60,7 @@ import org.eclipse.tractusx.irs.edc.client.policy.Constraint; import org.eclipse.tractusx.irs.edc.client.policy.ConstraintCheckerService; import org.eclipse.tractusx.irs.edc.client.policy.Constraints; +import org.eclipse.tractusx.irs.edc.client.policy.Operator; import org.eclipse.tractusx.irs.edc.client.policy.OperatorType; import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.PolicyCheckerService; @@ -121,10 +122,10 @@ void configureSystemUnderTest() { acceptedPoliciesProvider = mock(AcceptedPoliciesProvider.class); when(acceptedPoliciesProvider.getAcceptedPolicies()).thenReturn(List.of(new AcceptedPolicy(policy("IRS Policy", - List.of(new Permission(PolicyType.USE, List.of(new Constraints( - List.of(new Constraint("Membership", OperatorType.EQ, List.of("active")), - new Constraint("FrameworkAgreement.traceability", OperatorType.EQ, List.of("active"))), - new ArrayList<>()))))), OffsetDateTime.now().plusYears(1)))); + List.of(new Permission(PolicyType.USE, new Constraints( + List.of(new Constraint("Membership", new Operator(OperatorType.EQ), "active"), + new Constraint("FrameworkAgreement.traceability", new Operator(OperatorType.EQ), "active")), + new ArrayList<>())))), OffsetDateTime.now().plusYears(1)))); final PolicyCheckerService policyCheckerService = new PolicyCheckerService(acceptedPoliciesProvider, new ConstraintCheckerService()); final ContractNegotiationService contractNegotiationService = new ContractNegotiationService(controlPlaneClient, @@ -253,10 +254,10 @@ void shouldReturnObjectAsStringWhenResponseNotJSON() void shouldThrowExceptionWhenPoliciesAreNotAccepted() { // Arrange final List andConstraints = List.of( - new Constraint("Membership", OperatorType.EQ, List.of("active"))); + new Constraint("Membership", new Operator(OperatorType.EQ), "active")); final ArrayList orConstraints = new ArrayList<>(); final Permission permission = new Permission(PolicyType.USE, - List.of(new Constraints(andConstraints, orConstraints))); + new Constraints(andConstraints, orConstraints)); final AcceptedPolicy acceptedPolicy = new AcceptedPolicy(policy("IRS Policy", List.of(permission)), OffsetDateTime.now().plusYears(1)); diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerServiceTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerServiceTest.java index 7ddb4d04fc..07771e81b2 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerServiceTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/ConstraintCheckerServiceTest.java @@ -168,8 +168,8 @@ void shouldRejectOrConstraintIfAnyMatch() { private Policy createPolicyWithAndConstraint(List operands) { List and = operands.stream() - .map(operand -> new Constraint(operand.left, OperatorType.EQ, - List.of(operand.right))) + .map(operand -> new Constraint(operand.left, new Operator(OperatorType.EQ), + operand.right)) .toList(); Constraints constraints = new Constraints(and, new ArrayList<>()); return createPolicyWithConstraint(constraints); @@ -177,16 +177,15 @@ private Policy createPolicyWithAndConstraint(List operands) { private Policy createPolicyWithOrConstraint(List operands) { List or = operands.stream() - .map(operand -> new Constraint(operand.left, OperatorType.EQ, - List.of(operand.right))) + .map(operand -> new Constraint(operand.left, new Operator(OperatorType.EQ), + operand.right)) .toList(); Constraints constraints = new Constraints(new ArrayList<>(), or); return createPolicyWithConstraint(constraints); } private Policy createPolicyWithConstraint(Constraints constraints) { - List constraintsList = List.of(constraints); - Permission permission = new Permission(PolicyType.ACCESS, constraintsList); + Permission permission = new Permission(PolicyType.ACCESS, constraints); List permissions = List.of(permission); final String policyId = "policyId"; return new Policy(policyId, OffsetDateTime.now(), OffsetDateTime.now().plusYears(1), permissions); diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/PolicyCheckerServiceTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/PolicyCheckerServiceTest.java index cd39c4e503..f7baba0fec 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/PolicyCheckerServiceTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/policy/PolicyCheckerServiceTest.java @@ -106,12 +106,12 @@ void shouldRejectAndConstraintsWhenOnlyOneMatch() { @Test void shouldAcceptAndConstraintsWhenAcceptedPolicyContainsMoreConstraintsSuperSetOfProvidedPolicy() { // given - final Constraint constraint1 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_TRACEABILITY, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); - final Constraint constraint2 = new Constraint(TestConstants.MEMBERSHIP, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); - final Constraint constraint3 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_DISMANTLER, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); + final Constraint constraint1 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_TRACEABILITY, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); + final Constraint constraint2 = new Constraint(TestConstants.MEMBERSHIP, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); + final Constraint constraint3 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_DISMANTLER, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); final var policyList = List.of( new AcceptedPolicy(policy("and-policy", List.of(constraint1, constraint2, constraint3), List.of()), OffsetDateTime.now().plusYears(1))); @@ -131,12 +131,12 @@ void shouldAcceptAndConstraintsWhenAcceptedPolicyContainsMoreConstraintsSuperSet @Test void shouldAcceptOrConstraintsWhenAcceptedPolicyContainsMoreConstraintsSuperSetOfProvidedPolicy() { // given - final Constraint constraint1 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_TRACEABILITY, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); - final Constraint constraint2 = new Constraint(TestConstants.MEMBERSHIP, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); - final Constraint constraint3 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_DISMANTLER, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); + final Constraint constraint1 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_TRACEABILITY, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); + final Constraint constraint2 = new Constraint(TestConstants.MEMBERSHIP, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); + final Constraint constraint3 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_DISMANTLER, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); final var policyList = List.of( new AcceptedPolicy(policy("and-policy", List.of(), List.of(constraint1, constraint2, constraint3)), OffsetDateTime.now().plusYears(1))); @@ -156,12 +156,12 @@ void shouldAcceptOrConstraintsWhenAcceptedPolicyContainsMoreConstraintsSuperSetO @Test void shouldAcceptConstraintsWithDefaultPolicy() { // given - final Constraint constraint1 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_TRACEABILITY, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); - final Constraint constraint2 = new Constraint(TestConstants.MEMBERSHIP, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); - final Constraint constraint3 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_DISMANTLER, OperatorType.EQ, - List.of(TestConstants.STATUS_ACTIVE)); + final Constraint constraint1 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_TRACEABILITY, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); + final Constraint constraint2 = new Constraint(TestConstants.MEMBERSHIP, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); + final Constraint constraint3 = new Constraint(TestConstants.FRAMEWORK_AGREEMENT_DISMANTLER, new Operator(OperatorType.EQ), + TestConstants.STATUS_ACTIVE); final var policyList = List.of(new AcceptedPolicy( policy("default-policy", List.of(constraint1, constraint2, constraint3), @@ -242,7 +242,7 @@ private org.eclipse.tractusx.irs.edc.client.policy.Policy policy(final String po private org.eclipse.tractusx.irs.edc.client.policy.Policy policy(final String policyId, final List andConstraint, final List orConstraint) { - final List constraints = List.of(new Constraints(andConstraint, orConstraint)); + final Constraints constraints = new Constraints(andConstraint, orConstraint); final List permissions = List.of(new Permission(PolicyType.USE, constraints)); return new org.eclipse.tractusx.irs.edc.client.policy.Policy(policyId, OffsetDateTime.now(), OffsetDateTime.now().plusYears(1), permissions); diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/config/PolicyConfiguration.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/config/PolicyConfiguration.java index c37e750834..93dee00b08 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/config/PolicyConfiguration.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/config/PolicyConfiguration.java @@ -23,6 +23,8 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.policystore.config; +import org.eclipse.edc.core.transform.TypeTransformerRegistryImpl; +import org.eclipse.edc.transform.spi.TypeTransformerRegistry; import org.eclipse.tractusx.irs.common.persistence.BlobPersistence; import org.eclipse.tractusx.irs.common.persistence.BlobPersistenceException; import org.eclipse.tractusx.irs.common.persistence.MinioBlobPersistence; @@ -44,4 +46,9 @@ public BlobPersistence blobStore(final PolicyBlobstoreConfiguration config) thro return new MinioBlobPersistence(config.getEndpoint(), config.getAccessKey(), config.getSecretKey(), config.getBucketName(), config.getDaysToLive()); } + + @Bean + public TypeTransformerRegistry typeTransformerRegistry() { + return new TypeTransformerRegistryImpl(); + } } diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java index ad18b47f6a..52a8c06aed 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java @@ -42,8 +42,9 @@ import lombok.extern.slf4j.Slf4j; import org.eclipse.tractusx.irs.common.auth.IrsRoles; import org.eclipse.tractusx.irs.dtos.ErrorResponse; -import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; import org.eclipse.tractusx.irs.edc.client.policy.Policy; +import org.eclipse.tractusx.irs.edc.client.transformer.EdcTransformer; +import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; import org.eclipse.tractusx.irs.policystore.models.UpdatePolicyRequest; import org.eclipse.tractusx.irs.policystore.services.PolicyStoreService; import org.springframework.http.HttpStatus; @@ -71,6 +72,7 @@ public class PolicyStoreController { private final PolicyStoreService service; + private final EdcTransformer edcTransformer; @Operation(operationId = "registerAllowedPolicy", summary = "Register a policy that should be accepted in EDC negotiation.", @@ -100,8 +102,10 @@ public class PolicyStoreController { @PostMapping("/policies") @ResponseStatus(HttpStatus.CREATED) @PreAuthorize("hasAuthority('" + IrsRoles.ADMIN_IRS + "')") - public void registerAllowedPolicy(final @Valid @RequestBody CreatePolicyRequest request) { - service.registerPolicy(request); + public void registerAllowedPolicy(final @RequestBody CreatePolicyRequest request) { + final Policy policy = edcTransformer.transformToPolicy(request.payload()); + policy.setValidUntil(request.validUntil()); + service.registerPolicy(policy); } @Operation(operationId = "getAllowedPolicies", diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java index b1a83f7de3..d3e64d5f88 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java @@ -24,23 +24,53 @@ package org.eclipse.tractusx.irs.policystore.models; import java.time.OffsetDateTime; -import java.util.List; import io.swagger.v3.oas.annotations.media.Schema; +import jakarta.json.JsonObject; import jakarta.validation.constraints.NotNull; -import org.eclipse.tractusx.irs.edc.client.policy.Permission; /** - * Request object for policy creation - * - * @param policyId the ID of the policy - * @param validUntil the timestamp after which the policy should no longer be accepted + * Object for API to create policty */ +@SuppressWarnings("FileTabCharacter") @Schema(description = "Request to add a policy") -public record CreatePolicyRequest(@Schema(description = "The ID of the policy to add") @NotNull String policyId, - - @Schema(description = "Timestamp after which the policy will no longer be accepted in negotiations") @NotNull OffsetDateTime validUntil, - @Schema(description = "List of permissions that will be added to the Policy on creation.") @NotNull List permissions - ) { - +public record CreatePolicyRequest( + @NotNull @Schema(description = "Timestamp after which the policy will no longer be accepted in negotiations") OffsetDateTime validUntil, + @NotNull @Schema(example = CreatePolicyRequest.EXAMPLE_PAYLOAD) JsonObject payload) { + public static final String EXAMPLE_PAYLOAD = """ + { + "validUntil": "2025-12-12T23:59:59.999Z", + "payload": { + "@context": { + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "USE", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + } + """; } diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java index 07d99425af..a86c250a55 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java @@ -23,7 +23,6 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.policystore.services; -import java.time.Clock; import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.List; @@ -33,13 +32,13 @@ import org.eclipse.tractusx.irs.edc.client.policy.AcceptedPolicy; import org.eclipse.tractusx.irs.edc.client.policy.Constraint; import org.eclipse.tractusx.irs.edc.client.policy.Constraints; +import org.eclipse.tractusx.irs.edc.client.policy.Operator; import org.eclipse.tractusx.irs.edc.client.policy.OperatorType; import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.Policy; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; import org.eclipse.tractusx.irs.policystore.config.DefaultAcceptedPoliciesConfig; import org.eclipse.tractusx.irs.policystore.exceptions.PolicyStoreException; -import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; import org.eclipse.tractusx.irs.policystore.models.UpdatePolicyRequest; import org.eclipse.tractusx.irs.policystore.persistence.PolicyPersistence; import org.springframework.beans.factory.annotation.Value; @@ -56,27 +55,22 @@ public class PolicyStoreService implements AcceptedPoliciesProvider { public static final int DEFAULT_POLICY_LIFETIME_YEARS = 5; private final String apiAllowedBpn; - private final Clock clock; private final List allowedPoliciesFromConfig; private final PolicyPersistence persistence; public PolicyStoreService(@Value("${apiAllowedBpn:}") final String apiAllowedBpn, - final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig, final PolicyPersistence persistence, - final Clock clock) { + final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig, final PolicyPersistence persistence) { this.apiAllowedBpn = apiAllowedBpn; this.allowedPoliciesFromConfig = createDefaultPolicyFromConfig(defaultAcceptedPoliciesConfig); this.persistence = persistence; - this.clock = clock; } - public void registerPolicy(final CreatePolicyRequest request) { - log.info("Registering new policy with id {}, valid until {}", request.policyId(), request.validUntil()); + public void registerPolicy(final Policy policy) { + log.info("Registering new policy with id {}, valid until {}", policy.getPolicyId(), policy.getValidUntil()); try { - persistence.save(apiAllowedBpn, - new Policy(request.policyId(), OffsetDateTime.now(clock), request.validUntil(), - request.permissions())); + persistence.save(apiAllowedBpn, policy); } catch (final PolicyStoreException e) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, e.getMessage(), e); } @@ -121,15 +115,17 @@ private AcceptedPolicy toAcceptedPolicy(final Policy policy) { return new AcceptedPolicy(policy, policy.getValidUntil()); } - private List createDefaultPolicyFromConfig(final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig) { + private List createDefaultPolicyFromConfig( + final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig) { final List constraints = new ArrayList<>(); defaultAcceptedPoliciesConfig.getAcceptedPolicies() - .forEach(acceptedPolicy -> constraints.add(new Constraint(acceptedPolicy.getLeftOperand(), - OperatorType.fromValue(acceptedPolicy.getOperator()), - List.of(acceptedPolicy.getRightOperand())))); + .forEach(acceptedPolicy -> constraints.add( + new Constraint(acceptedPolicy.getLeftOperand(), + new Operator(OperatorType.fromValue(acceptedPolicy.getOperator())), + acceptedPolicy.getRightOperand()))); final Policy policy = new Policy("default-policy", OffsetDateTime.now(), OffsetDateTime.now().plusYears(DEFAULT_POLICY_LIFETIME_YEARS), - List.of(new Permission(PolicyType.USE, List.of(new Constraints(constraints, constraints))))); + List.of(new Permission(PolicyType.USE, new Constraints(constraints, constraints)))); return List.of(policy); } diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java index 270d0cf4d2..3089981294 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java @@ -24,20 +24,29 @@ package org.eclipse.tractusx.irs.policystore.controllers; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; +import java.io.StringReader; import java.time.OffsetDateTime; import java.util.Collections; import java.util.List; +import jakarta.json.Json; +import jakarta.json.JsonObject; +import jakarta.json.JsonReader; +import org.eclipse.edc.jsonld.TitaniumJsonLd; +import org.eclipse.edc.spi.monitor.ConsoleMonitor; import org.eclipse.tractusx.irs.edc.client.policy.Constraint; import org.eclipse.tractusx.irs.edc.client.policy.Constraints; -import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; +import org.eclipse.tractusx.irs.edc.client.policy.Operator; import org.eclipse.tractusx.irs.edc.client.policy.OperatorType; import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.Policy; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; +import org.eclipse.tractusx.irs.edc.client.transformer.EdcTransformer; +import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; import org.eclipse.tractusx.irs.policystore.models.UpdatePolicyRequest; import org.eclipse.tractusx.irs.policystore.services.PolicyStoreService; import org.junit.jupiter.api.BeforeEach; @@ -49,26 +58,68 @@ @ExtendWith(MockitoExtension.class) class PolicyStoreControllerTest { + public static final String EXAMPLE_PAYLOAD = """ + { + "validUntil": "2025-12-12T23:59:59.999Z", + "payload": { + "@context": { + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "USE", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + } + """; + private PolicyStoreController testee; + private final TitaniumJsonLd titaniumJsonLd = new TitaniumJsonLd(new ConsoleMonitor()); + private final EdcTransformer edcTransformer = new EdcTransformer(new com.fasterxml.jackson.databind.ObjectMapper(), titaniumJsonLd); @Mock private PolicyStoreService service; @BeforeEach void setUp() { - testee = new PolicyStoreController(service); + testee = new PolicyStoreController(service, edcTransformer); } @Test void registerAllowedPolicy() { // arrange - final CreatePolicyRequest request = new CreatePolicyRequest("policyId", OffsetDateTime.now(), createPermissions()); + final OffsetDateTime now = OffsetDateTime.now(); + JsonReader jsonReader = Json.createReader(new StringReader(EXAMPLE_PAYLOAD)); + JsonObject jsonObject = jsonReader.readObject(); + jsonReader.close(); // act - testee.registerAllowedPolicy(request); + testee.registerAllowedPolicy(new CreatePolicyRequest(now.plusMinutes(1), jsonObject.get("payload").asJsonObject())); // assert - verify(service).registerPolicy(request); + verify(service).registerPolicy(any()); } @Test @@ -108,8 +159,8 @@ void updateAllowedPolicy() { private List createPermissions() { return List.of( - new Permission(PolicyType.USE, List.of(createConstraints())), - new Permission(PolicyType.ACCESS, List.of(createConstraints())) + new Permission(PolicyType.USE, createConstraints()), + new Permission(PolicyType.ACCESS, createConstraints()) ); } @@ -117,9 +168,9 @@ private Constraints createConstraints() { return new Constraints( Collections.emptyList(), List.of( - new Constraint("Membership", OperatorType.EQ, List.of("active")), - new Constraint("FrameworkAgreement.traceability", OperatorType.EQ, List.of("active")), - new Constraint("PURPOSE", OperatorType.EQ, List.of("ID 3.1 Trace"))) + new Constraint("Membership", new Operator(OperatorType.EQ), "active"), + new Constraint("FrameworkAgreement.traceability", new Operator(OperatorType.EQ), "active"), + new Constraint("PURPOSE", new Operator(OperatorType.EQ), "ID 3.1 Trace")) ); } } \ No newline at end of file diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java index c778a75aef..7475ba1383 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java @@ -39,13 +39,13 @@ import org.eclipse.tractusx.irs.edc.client.policy.Constraint; import org.eclipse.tractusx.irs.edc.client.policy.Constraints; +import org.eclipse.tractusx.irs.edc.client.policy.Operator; import org.eclipse.tractusx.irs.edc.client.policy.OperatorType; import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.Policy; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; import org.eclipse.tractusx.irs.policystore.config.DefaultAcceptedPoliciesConfig; import org.eclipse.tractusx.irs.policystore.exceptions.PolicyStoreException; -import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; import org.eclipse.tractusx.irs.policystore.models.UpdatePolicyRequest; import org.eclipse.tractusx.irs.policystore.persistence.PolicyPersistence; import org.junit.jupiter.api.BeforeEach; @@ -74,16 +74,17 @@ class PolicyStoreServiceTest { void setUp() { final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig = new DefaultAcceptedPoliciesConfig(); defaultAcceptedPoliciesConfig.setAcceptedPolicies(List.of()); - testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence, clock); + testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence); } @Test void registerPolicy() { // arrange - final var req = new CreatePolicyRequest("testId", OffsetDateTime.now(clock).plusMinutes(1), emptyList()); + final OffsetDateTime now = OffsetDateTime.now(clock); + final Policy policy = new Policy("testId", now, now.plusMinutes(1), emptyList()); // act - testee.registerPolicy(req); + testee.registerPolicy(policy); // assert verify(persistence).save(eq(BPN), any()); @@ -92,11 +93,11 @@ void registerPolicy() { @Test void registerPolicyWithPermission() { // arrange - final var req = new CreatePolicyRequest("testId", OffsetDateTime.now(clock).plusMinutes(1), - createPermissions()); + final OffsetDateTime now = OffsetDateTime.now(clock); + final Policy policy = new Policy("testId", now, now.plusMinutes(1), createPermissions()); // act - testee.registerPolicy(req); + testee.registerPolicy(policy); // assert verify(persistence).save(eq(BPN), policyCaptor.capture()); @@ -112,11 +113,12 @@ void registerPolicyWithPermission() { void registerPolicyShouldThrowResponseStatusException() { // act final String policyId = "testId"; + final OffsetDateTime now = OffsetDateTime.now(clock); + final Policy policy = new Policy(policyId, now, now.plusMinutes(1), createPermissions()); doThrow(new PolicyStoreException("")).when(persistence).save(eq(BPN), any()); - final CreatePolicyRequest request = new CreatePolicyRequest(policyId, OffsetDateTime.now(), emptyList()); // assert - assertThrows(ResponseStatusException.class, () -> testee.registerPolicy(request)); + assertThrows(ResponseStatusException.class, () -> testee.registerPolicy(policy)); } @Test @@ -141,7 +143,7 @@ void getDefaultStoredPoliciesWhenEmpty() { EXAMPLE_ACCEPTED_LEFT_OPERAND, "eq", EXAMPLE_ALLOWED_NAME); final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig = new DefaultAcceptedPoliciesConfig(); defaultAcceptedPoliciesConfig.setAcceptedPolicies(List.of(acceptedPolicy1, acceptedPolicy2)); - testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence, clock); + testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence); // act final var defaultPolicies = testee.getStoredPolicies(); @@ -150,10 +152,9 @@ void getDefaultStoredPoliciesWhenEmpty() { assertThat(defaultPolicies).hasSize(1); final List permissionList = defaultPolicies.get(0).getPermissions(); assertThat(permissionList).hasSize(1); - final List constraints = permissionList.get(0).getConstraints(); - assertThat(constraints).hasSize(1); - assertThat(constraints.get(0).getOr()).hasSize(2); - assertThat(constraints.get(0).getAnd()).hasSize(2); + final Constraints constraints = permissionList.get(0).getConstraint(); + assertThat(constraints.getOr()).hasSize(2); + assertThat(constraints.getAnd()).hasSize(2); } private Policy createPolicy(final String policyId) { @@ -161,15 +162,15 @@ private Policy createPolicy(final String policyId) { } private List createPermissions() { - return List.of(new Permission(PolicyType.USE, List.of(createConstraints())), - new Permission(PolicyType.ACCESS, List.of(createConstraints()))); + return List.of(new Permission(PolicyType.USE, createConstraints()), + new Permission(PolicyType.ACCESS, createConstraints())); } private Constraints createConstraints() { return new Constraints(Collections.emptyList(), - List.of(new Constraint("Membership", OperatorType.EQ, List.of("active")), - new Constraint("FrameworkAgreement.traceability", OperatorType.EQ, List.of("active")), - new Constraint(EXAMPLE_ACCEPTED_LEFT_OPERAND, OperatorType.EQ, List.of("ID 3.1 Trace")))); + List.of(new Constraint("Membership", new Operator(OperatorType.EQ), "active"), + new Constraint("FrameworkAgreement.traceability", new Operator(OperatorType.EQ), "active"), + new Constraint(EXAMPLE_ACCEPTED_LEFT_OPERAND, new Operator(OperatorType.EQ), "ID 3.1 Trace"))); } @Test From 90995dddd1d0884e0b8d316562c8ab99de0c058c Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 25 Jan 2024 22:54:29 +0100 Subject: [PATCH 049/116] feat(imp):[#214] catching any runtime exception to avoid hanging jobs --- .../job/delegate/DigitalTwinDelegate.java | 17 +- .../common/util/concurrent/ResultFinder.java | 29 ++-- .../DecentralDigitalTwinRegistryService.java | 150 ++++++++++-------- .../exceptions/RegistryServiceException.java | 4 + .../RegistryServiceRuntimeException.java | 30 ---- ...centralDigitalTwinRegistryServiceTest.java | 31 ++-- .../RegistryServiceRuntimeExceptionTest.java | 36 ----- 7 files changed, 128 insertions(+), 169 deletions(-) delete mode 100644 irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java delete mode 100644 irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java index af4392bfce..468a221ba6 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java @@ -37,7 +37,6 @@ import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryService; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; -import org.springframework.web.client.RestClientException; /** * Retrieves AAShell from Digital Twin Registry service and storing it inside {@link ItemContainer}. @@ -55,8 +54,10 @@ public DigitalTwinDelegate(final AbstractDelegate nextStep, } @Override - public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContainerBuilder, final JobParameter jobData, - final AASTransferProcess aasTransferProcess, final PartChainIdentificationKey itemId) { + @SuppressWarnings("PMD.AvoidCatchingGenericException") + public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContainerBuilder, + final JobParameter jobData, final AASTransferProcess aasTransferProcess, + final PartChainIdentificationKey itemId) { if (StringUtils.isBlank(itemId.getBpn())) { log.warn("Could not process item with id {} because no BPN was provided. Creating Tombstone.", @@ -65,7 +66,9 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai Tombstone.from(itemId.getGlobalAssetId(), null, "Can't get relationship without a BPN", 0, ProcessStep.DIGITAL_TWIN_REQUEST)).build(); } + try { + final AssetAdministrationShellDescriptor shell = digitalTwinRegistryService.fetchShells( List.of(new DigitalTwinRegistryKey(itemId.getGlobalAssetId(), itemId.getBpn()))) .stream() @@ -79,9 +82,13 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai // filter submodel descriptors if next delegate will not be executed itemContainerBuilder.shell(shell.withFilteredSubmodelDescriptors(jobData.getAspects())); } - } catch (final RestClientException | RegistryServiceException e) { + + } catch (final RegistryServiceException | RuntimeException e) { + // catching generic exception is intended here, + // otherwise Jobs stay in state RUNNING forever log.info("Shell Endpoint could not be retrieved for Item: {}. Creating Tombstone.", itemId); - itemContainerBuilder.tombstone(Tombstone.from(itemId.getGlobalAssetId(), null, e, retryCount, ProcessStep.DIGITAL_TWIN_REQUEST)); + itemContainerBuilder.tombstone( + Tombstone.from(itemId.getGlobalAssetId(), null, e, retryCount, ProcessStep.DIGITAL_TWIN_REQUEST)); } if (expectedDepthOfTreeIsNotReached(jobData.getDepth(), aasTransferProcess.getDepth())) { diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 28b585da3f..2c9e44c2e5 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -31,11 +31,12 @@ import java.util.concurrent.CompletionException; import java.util.function.BiFunction; import java.util.function.Function; +import java.util.stream.Collectors; import lombok.Getter; import lombok.ToString; import lombok.extern.slf4j.Slf4j; -import org.slf4j.Logger; +import org.apache.commons.lang3.exception.ExceptionUtils; /** * Helper class to find the relevant result from a list of futures. @@ -80,8 +81,15 @@ public CompletableFuture getFastestResult(final List log.info(logPrefix + "All of the futures completed"); if (ex != null) { - log.error(logPrefix + "Exception occurred: " + ex.getMessage(), ex); - fastestResultPromise.completeExceptionally(new CompletionExceptions(exceptions)); + + log.warn("All failed: " + System.lineSeparator() // + + exceptions.stream() + .map(ExceptionUtils::getStackTrace) + .collect(Collectors.joining(System.lineSeparator())), ex); + + fastestResultPromise.completeExceptionally( + new CompletionExceptions(LOGPREFIX_TO_BE_REMOVED_LATER + "None successful", exceptions)); + } else if (fastestResultPromise.isDone()) { log.info(logPrefix + "Fastest result already found, ignoring the others"); } else { @@ -145,20 +153,11 @@ private static Function collectingExceptionsAndThrow(final Lis public static class CompletionExceptions extends CompletionException { private final List causes; - - public CompletionExceptions(final List causes) { - super(LOGPREFIX_TO_BE_REMOVED_LATER + "All failing, use getCauses() for details"); + + public CompletionExceptions(final String msg, final List causes) { + super(msg); this.causes = causes; } - public void logWarn(final Logger log, final String prefix) { - - log.warn("{}{}", prefix, this.getMessage(), this.getCause()); - - for (final Throwable cause : this.getCauses()) { - log.warn(prefix + cause.getMessage(), cause); - } - } - } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 94e380436a..7f27851fc2 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -26,7 +26,6 @@ import static org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder.LOGPREFIX_TO_BE_REMOVED_LATER; import java.util.Collection; -import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; @@ -47,7 +46,6 @@ import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryService; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; -import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceRuntimeException; import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; import org.jetbrains.annotations.NotNull; import org.springframework.util.StopWatch; @@ -82,6 +80,7 @@ private static Stream>> groupKeys } @Override + @SuppressWarnings("PMD.AvoidCatchingGenericException") public Collection fetchShells(final Collection keys) throws RegistryServiceException { @@ -90,11 +89,20 @@ public Collection fetchShells(final Collecti LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching shell(s) for %s key(s)".formatted(keys.size())); try { - final var calledEndpoints = new HashSet(); - final var collectedShells = groupKeysByBpn(keys).flatMap( - entry -> fetchShellDescriptors(calledEndpoints, entry.getKey(), entry.getValue()).stream()) - .toList(); + + final var collectedShells = groupKeysByBpn(keys).flatMap(entry -> { + + try { + return fetchShellDescriptors(entry, calledEndpoints); + } catch (RuntimeException e) { + // catching generic exception is intended here, + // otherwise Jobs stay in state RUNNING forever + log.warn(e.getMessage(), e); + return Stream.empty(); + } + + }).toList(); if (collectedShells.isEmpty()) { log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "No shells found"); @@ -110,9 +118,27 @@ public Collection fetchShells(final Collecti } } - @NotNull - private List fetchShellDescriptors(final Set calledEndpoints, - final String bpn, final List keys) { + private Stream fetchShellDescriptors( + final Map.Entry> entry, final Set calledEndpoints) { + + try { + + final var futures = fetchShellDescriptors(calledEndpoints, entry.getKey(), entry.getValue()); + final var shellDescriptors = futures.get(); + return shellDescriptors.stream(); + + } catch (InterruptedException e) { + log.error(e.getMessage(), e); + Thread.currentThread().interrupt(); + return Stream.empty(); + } catch (ExecutionException e) { + log.warn(e.getMessage(), e); + return Stream.empty(); + } + } + + private CompletableFuture> fetchShellDescriptors( + final Set calledEndpoints, final String bpn, final List keys) { final var watch = new StopWatch(); StopwatchUtils.startWatch(log, watch, @@ -125,56 +151,34 @@ private List fetchShellDescriptors(final Set connectorEndpoints.size(), bpn); calledEndpoints.addAll(connectorEndpoints); - return fetchShellDescriptorsForConnectorEndpoints(bpn, keys, connectorEndpoints); + return fetchShellDescriptorsForConnectorEndpoints(keys, connectorEndpoints); } finally { StopwatchUtils.stopWatch(log, watch); } } - private List fetchShellDescriptorsForConnectorEndpoints(final String bpn, + private CompletableFuture> fetchShellDescriptorsForConnectorEndpoints( final List keys, final List connectorEndpoints) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "fetchShellDescriptorsForConnectorEndpoints - "; - - final EndpointDataForConnectorsService service = endpointDataForConnectorsService; - try { - final var futures = service.createFindEndpointDataForConnectorsFutures(connectorEndpoints) - .stream() - .map(edrFuture -> edrFuture.thenCompose(edr -> CompletableFuture.supplyAsync( - () -> fetchShellDescriptorsForKey(keys, edr)))) - .toList(); - - log.info(logPrefix + " Created {} futures", futures.size()); - - return resultFinder.getFastestResult(futures).get(); - - } catch (InterruptedException e) { - - handleInterruptedException(e, - logPrefix + "InterruptedException occurred while fetching shells for bpn '%s'".formatted(bpn)); - return Collections.emptyList(); + final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "fetchShellDescriptorsForConnectorEndpoints - "; - } catch (ResultFinder.CompletionExceptions e) { + final var service = endpointDataForConnectorsService; + final var futures = service.createFindEndpointDataForConnectorsFutures(connectorEndpoints) + .stream() + .map(edrFuture -> edrFuture.thenCompose(edr -> CompletableFuture.supplyAsync( + () -> fetchShellDescriptorsForKey(keys, edr)))) + .toList(); - e.logWarn(log, logPrefix); + log.info(logPrefix + " Created {} futures", futures.size()); - throw new RegistryServiceRuntimeException( - "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); - - } catch (ExecutionException e) { - - log.error(logPrefix + e.getMessage(), e); - throw new RegistryServiceRuntimeException( - "Exception occurred while fetching shells for bpn '%s'".formatted(bpn), e); - - } + return resultFinder.getFastestResult(futures); } private List fetchShellDescriptorsForKey( final List keys, final EndpointDataReference endpointDataReference) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptorsForKey - "; + final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptorsForKey - "; final var watch = new StopWatch(); StopwatchUtils.startWatch(log, watch, @@ -190,7 +194,7 @@ private List fetchShellDescriptorsForKey( private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDataReference endpointDataReference, final DigitalTwinRegistryKey key) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptor - "; + final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptor - "; final var watch = new StopWatch(); StopwatchUtils.startWatch(log, watch, @@ -216,7 +220,7 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa @NotNull private String mapToShellId(final EndpointDataReference endpointDataReference, final String key) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "mapToShellId - "; + final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "mapToShellId - "; final var watch = new StopWatch(); StopwatchUtils.startWatch(log, watch, logPrefix + "Mapping '%s' to shell ID for endpoint '%s'".formatted(key, @@ -248,9 +252,10 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f } } - private Collection lookupShellIds(final String bpn) { + @SuppressWarnings("PMD.AvoidCatchingGenericException") + private Collection lookupShellIds(final String bpn) throws RegistryServiceException { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; + final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; log.info(logPrefix + "Looking up shell ids for bpn {}", bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); @@ -260,6 +265,25 @@ private Collection lookupShellIds(final String bpn) { connectorEndpoints); log.info(logPrefix + "Created endpointDataReferenceFutures"); + try { + + return lookupShellIds(bpn, endpointDataReferenceFutures, logPrefix); + + } catch (RuntimeException e) { + // catching generic exception is intended here, + // otherwise Jobs stay in state RUNNING forever + log.error(logPrefix + e.getMessage(), e); // TODO (mfischer) #214 do not log and throw + final var msg = logPrefix + e.getClass().getSimpleName() + + " occurred while looking up shell ids for bpn '%s'".formatted(bpn); + throw new RegistryServiceException(msg, e); + } + } + + @NotNull + private Collection lookupShellIds(final String bpn, + final List> endpointDataReferenceFutures, final String logPrefix) + throws RegistryServiceException { + try { final var futures = endpointDataReferenceFutures.stream() .map(edrFuture -> edrFuture.thenCompose( @@ -272,27 +296,19 @@ private Collection lookupShellIds(final String bpn) { return shellIds; } catch (InterruptedException e) { - - handleInterruptedException(e, - logPrefix + "InterruptedException occurred while looking up shells ids for bpn '%s'".formatted( - bpn)); - return Collections.emptyList(); - - } catch (ResultFinder.CompletionExceptions e) { - - e.logWarn(log, logPrefix); - - throw new RegistryServiceRuntimeException(LOGPREFIX_TO_BE_REMOVED_LATER - + "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); - + log.error(logPrefix + "InterruptedException occurred while looking up shells ids for bpn '%s': ".formatted( + bpn) + e.getMessage(), e); // #214 do not log and throw + Thread.currentThread().interrupt(); + throw new RegistryServiceException(LOGPREFIX_TO_BE_REMOVED_LATER + e.getClass().getSimpleName() + + " occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } catch (ExecutionException e) { - log.error(logPrefix + e.getMessage(), e); - throw new RegistryServiceRuntimeException(LOGPREFIX_TO_BE_REMOVED_LATER - + "Exception occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + log.error(logPrefix + e.getMessage(), e); // TODO (mfischer) #214 do not log and throw + throw new RegistryServiceException(LOGPREFIX_TO_BE_REMOVED_LATER + e.getClass().getSimpleName() + + " occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } } - private List lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { + private Collection lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; final var watch = new StopWatch(); @@ -310,12 +326,8 @@ private List lookupShellIds(final String bpn, final EndpointDataReferenc } @Override - public Collection lookupShellIdentifiers(final String bpn) { + public Collection lookupShellIdentifiers(final String bpn) throws RegistryServiceException { return lookupShellIds(bpn).stream().map(id -> new DigitalTwinRegistryKey(id, bpn)).toList(); } - private void handleInterruptedException(final InterruptedException interruptedException, final String msg) { - log.warn(msg, interruptedException); - Thread.currentThread().interrupt(); - } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceException.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceException.java index 1aebfdad34..3995b27a30 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceException.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceException.java @@ -31,4 +31,8 @@ public class RegistryServiceException extends Exception { public RegistryServiceException(final String msg) { super(msg); } + + public RegistryServiceException(final String msg, final Throwable cause) { + super(msg, cause); + } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java deleted file mode 100644 index 8ce90c32f3..0000000000 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeException.java +++ /dev/null @@ -1,30 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.registryclient.exceptions; - -/** - * Base runtime exception for the registry client - */ -public class RegistryServiceRuntimeException extends RuntimeException { - - public RegistryServiceRuntimeException(final String msg, final Throwable cause) { - super(msg, cause); - } - -} diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index 76b26d5008..5d182a3f38 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -45,12 +45,14 @@ import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; -import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceRuntimeException; import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.DisplayNameGeneration; +import org.junit.jupiter.api.DisplayNameGenerator; import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; +@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class) class DecentralDigitalTwinRegistryServiceTest { private final ConnectorEndpointsService connectorEndpointsService = mock(ConnectorEndpointsService.class); @@ -80,7 +82,7 @@ public static AssetAdministrationShellDescriptor shellDescriptor( class FetchShellsTests { @Test - void shouldReturnExpectedShell() throws RegistryServiceException { + void should_return_expected_shell() throws RegistryServiceException { // given final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); @@ -107,7 +109,7 @@ void shouldReturnExpectedShell() throws RegistryServiceException { } @Test - void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedException { + void when_InterruptedException_occurs() throws ExecutionException, InterruptedException { // given simulateResultFinderInterrupted(); @@ -141,7 +143,7 @@ void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedExce } @Test - void whenExecutionExceptionOccurs() { + void when_ExecutionException_occurs() { // given simulateGetFastestResultFailedFuture(); @@ -166,14 +168,13 @@ void whenExecutionExceptionOccurs() { List.of(new DigitalTwinRegistryKey("dummyShellId", bpn))); // then - assertThatThrownBy(call).isInstanceOf(RegistryServiceRuntimeException.class) - .hasMessageContaining("Exception occurred while fetching shells for bpn") - .hasMessageContaining("'" + bpn + "'"); + assertThatThrownBy(call).isInstanceOf(ShellNotFoundException.class) + .hasMessageContaining("Unable to find any of the requested shells"); } @Test - void shouldThrowShellNotFound_IfNoDigitalTwinRegistryKeys() { + void should_throw_ShellNotFoundException_if_no_digital_twin_registry_keys_given() { assertThatThrownBy(() -> sut.fetchShells(emptyList())).isInstanceOf(ShellNotFoundException.class); } @@ -203,7 +204,7 @@ private static EndpointDataReference endpointDataReference(final String url) { class LookupGlobalAssetIdsTests { @Test - void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { + void should_return_the_expected_globalAssetId() throws RegistryServiceException { // given final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); @@ -235,7 +236,7 @@ void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { } @Test - void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedException { + void when_InterruptedException_occurs() throws ExecutionException, InterruptedException { // given simulateResultFinderInterrupted(); @@ -243,12 +244,14 @@ void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedExce final ThrowingCallable call = () -> sut.lookupShellsByBPN("dummyBpn"); // then - assertThatThrownBy(call).isInstanceOf(ShellNotFoundException.class) - .hasMessage("Unable to find any of the requested shells"); + assertThatThrownBy(call).isInstanceOf(RegistryServiceException.class) + .hasMessageContaining( + "InterruptedException occurred while looking up shell ids for bpn") + .hasMessageContaining("dummyBpn"); } @Test - void whenExecutionExceptionOccurs() { + void when_ExecutionException_occurs() { // given simulateGetFastestResultFailedFuture(); @@ -257,7 +260,7 @@ void whenExecutionExceptionOccurs() { final ThrowingCallable call = () -> sut.lookupShellsByBPN(bpn); // then - assertThatThrownBy(call).isInstanceOf(RegistryServiceRuntimeException.class) + assertThatThrownBy(call).isInstanceOf(RegistryServiceException.class) .hasMessageContaining("Exception occurred while looking up shell ids for bpn") .hasMessageContaining("'" + bpn + "'"); } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java deleted file mode 100644 index 40c0a99f30..0000000000 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/exceptions/RegistryServiceRuntimeExceptionTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2021,2022,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.registryclient.exceptions; - -import static org.assertj.core.api.Assertions.assertThat; - -import org.junit.jupiter.api.Test; - -class RegistryServiceRuntimeExceptionTest { - - @Test - void test() { - final IllegalArgumentException expectedCause = new IllegalArgumentException("original cause"); - final RegistryServiceRuntimeException exception = new RegistryServiceRuntimeException("message", expectedCause); - - assertThat(exception).hasMessage("message") - .hasCauseInstanceOf(IllegalArgumentException.class) - .hasCause(expectedCause); - } -} \ No newline at end of file From 30b3d9b21e7597fcc561a8ddfb0594b81a6ed1e4 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Fri, 26 Jan 2024 11:53:28 +0100 Subject: [PATCH 050/116] feat(irs):[#249] added tests --- .../client/transformer/EdcTransformer.java | 3 +- .../JsonObjectToPolicyTransformer.java | 12 +- .../irs/edc/client/testutil/TestMother.java | 3 +- .../transformer/EdcTransformerTest.java | 3 +- .../JsonObjectToPolicyTransformerTest.java | 117 ++++++++++++++++++ .../PolicyStoreControllerTest.java | 3 +- .../policystore/models/OperatorTypeTest.java | 24 ++++ 7 files changed, 159 insertions(+), 6 deletions(-) create mode 100644 irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java index 801301d0eb..461abff19e 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java @@ -87,7 +87,7 @@ public class EdcTransformer { private final TransformerContextImpl transformerContext; public EdcTransformer(@Qualifier("jsonLdObjectMapper") final ObjectMapper objectMapper, - final TitaniumJsonLd titaniumJsonLd) { + final TitaniumJsonLd titaniumJsonLd, final TypeTransformerRegistry typeTransformerRegistry) { this.titaniumJsonLd = titaniumJsonLd; final JsonBuilderFactory jsonBuilderFactory = Json.createBuilderFactory(Map.of()); @@ -101,7 +101,6 @@ public EdcTransformer(@Qualifier("jsonLdObjectMapper") final ObjectMapper object jsonObjectFromCatalogRequestTransformer = new JsonObjectFromCatalogRequestTransformer(jsonBuilderFactory); jsonObjectToPolicyTransformer = new org.eclipse.tractusx.irs.edc.client.transformer.JsonObjectToPolicyTransformer(objectMapper); - final TypeTransformerRegistry typeTransformerRegistry = new TypeTransformerRegistryImpl(); transformerContext = new TransformerContextImpl(typeTransformerRegistry); // JSON to Object diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java index 4dcb56e8f4..1e991fba8e 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java @@ -24,6 +24,7 @@ package org.eclipse.tractusx.irs.edc.client.transformer; import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import jakarta.json.JsonObject; import org.eclipse.edc.jsonld.spi.transformer.AbstractJsonLdTransformer; @@ -49,7 +50,7 @@ protected JsonObjectToPolicyTransformer(final ObjectMapper objectMapper) { public @Nullable Policy transform(@NotNull final JsonObject jsonObject, @NotNull final TransformerContext transformerContext) { final Policy.PolicyBuilder builder = Policy.builder(); - builder.policyId(jsonObject.get("@id").toString()); + builder.policyId(getId(jsonObject)); this.visitProperties(jsonObject, (key) -> v -> { try { @@ -62,4 +63,13 @@ protected JsonObjectToPolicyTransformer(final ObjectMapper objectMapper) { return builder.build(); } + + private String getId(final JsonObject jsonObject) { + try { + final JsonNode jsonNode = objectMapper.readTree(jsonObject.toString()); + return jsonNode.path("@id").asText(); + } catch (JsonProcessingException e) { + throw new JsonParseException(e); + } + } } diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java index 72e368dc6a..8e329a7a31 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java @@ -48,6 +48,7 @@ import org.eclipse.edc.catalog.spi.DataService; import org.eclipse.edc.catalog.spi.Dataset; import org.eclipse.edc.catalog.spi.Distribution; +import org.eclipse.edc.core.transform.TypeTransformerRegistryImpl; import org.eclipse.edc.jsonld.TitaniumJsonLd; import org.eclipse.edc.policy.model.Action; import org.eclipse.edc.policy.model.AndConstraint; @@ -73,7 +74,7 @@ public static EdcTransformer createEdcTransformer() { titaniumJsonLd.registerNamespace("edc", NAMESPACE_EDC); titaniumJsonLd.registerNamespace("dcat", NAMESPACE_DCAT); titaniumJsonLd.registerNamespace("dspace", NAMESPACE_DSPACE); - return new EdcTransformer(objectMapper(), titaniumJsonLd); + return new EdcTransformer(objectMapper(), titaniumJsonLd, new TypeTransformerRegistryImpl()); } public static ObjectMapper objectMapper() { diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformerTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformerTest.java index 7d982c5902..bd9a1af69e 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformerTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformerTest.java @@ -42,6 +42,7 @@ import org.eclipse.edc.catalog.spi.DataService; import org.eclipse.edc.catalog.spi.Dataset; import org.eclipse.edc.catalog.spi.Distribution; +import org.eclipse.edc.core.transform.TypeTransformerRegistryImpl; import org.eclipse.edc.jsonld.TitaniumJsonLd; import org.eclipse.edc.policy.model.Action; import org.eclipse.edc.policy.model.AtomicConstraint; @@ -211,7 +212,7 @@ void setUp() { jsonLd.registerNamespace("dspace", "https://w3id.org/dspace/v0.8/"); ObjectMapper objectMapper = objectMapper(); - edcTransformer = new EdcTransformer(objectMapper, jsonLd); + edcTransformer = new EdcTransformer(objectMapper, jsonLd, new TypeTransformerRegistryImpl()); } @Test diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java new file mode 100644 index 0000000000..78072ee29b --- /dev/null +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java @@ -0,0 +1,117 @@ +/* + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + */ + +package org.eclipse.tractusx.irs.edc.client.transformer; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.io.StringReader; +import java.util.List; + +import com.fasterxml.jackson.databind.ObjectMapper; +import jakarta.json.Json; +import jakarta.json.JsonObject; +import jakarta.json.JsonReader; +import org.eclipse.edc.core.transform.TransformerContextImpl; +import org.eclipse.edc.core.transform.TypeTransformerRegistryImpl; +import org.eclipse.edc.transform.spi.TransformerContext; +import org.eclipse.tractusx.irs.edc.client.policy.Constraint; +import org.eclipse.tractusx.irs.edc.client.policy.OperatorType; +import org.eclipse.tractusx.irs.edc.client.policy.Permission; +import org.eclipse.tractusx.irs.edc.client.policy.Policy; +import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.junit.jupiter.MockitoExtension; + +@ExtendWith(MockitoExtension.class) +class JsonObjectToPolicyTransformerTest { + + public static final String EXAMPLE_PAYLOAD = """ + { + "@context": { + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "USE", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + """; + + private JsonObjectToPolicyTransformer jsonObjectToPolicyTransformer; + private TransformerContext transformerContext; + + @BeforeEach + public void setUp() { + jsonObjectToPolicyTransformer = new JsonObjectToPolicyTransformer(new ObjectMapper()); + transformerContext = new TransformerContextImpl(new TypeTransformerRegistryImpl()); + } + + @Test + public void shouldTransformJsonObjectToPolicyCorrectly() { + // given + JsonReader jsonReader = Json.createReader(new StringReader(EXAMPLE_PAYLOAD)); + JsonObject jsonObject = jsonReader.readObject(); + jsonReader.close(); + + // when + final Policy transformed = jsonObjectToPolicyTransformer.transform(jsonObject, transformerContext); + + // then + assertThat(transformed.getPolicyId()).isEqualTo("policy-id"); + final Permission permission = transformed.getPermissions().get(0); + assertThat(permission.getAction()).isEqualTo(PolicyType.USE); + final List and = permission.getConstraint().getAnd(); + final Constraint and1 = and.get(0); + final Constraint and2 = and.get(1); + + assertThat(and1.getLeftOperand()).isEqualTo("Membership"); + assertThat(and1.getRightOperand()).isEqualTo("active"); + assertThat(and1.getOperator().getOperatorType()).isEqualTo(OperatorType.EQ); + + assertThat(and2.getLeftOperand()).isEqualTo("PURPOSE"); + assertThat(and2.getRightOperand()).isEqualTo("ID 3.1 Trace"); + assertThat(and2.getOperator().getOperatorType()).isEqualTo(OperatorType.EQ); + } +} \ No newline at end of file diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java index 8f2e393a90..fcccff5225 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java @@ -36,6 +36,7 @@ import jakarta.json.Json; import jakarta.json.JsonObject; import jakarta.json.JsonReader; +import org.eclipse.edc.core.transform.TypeTransformerRegistryImpl; import org.eclipse.edc.jsonld.TitaniumJsonLd; import org.eclipse.edc.spi.monitor.ConsoleMonitor; import org.eclipse.tractusx.irs.edc.client.policy.Constraint; @@ -97,7 +98,7 @@ class PolicyStoreControllerTest { private PolicyStoreController testee; private final TitaniumJsonLd titaniumJsonLd = new TitaniumJsonLd(new ConsoleMonitor()); - private final EdcTransformer edcTransformer = new EdcTransformer(new com.fasterxml.jackson.databind.ObjectMapper(), titaniumJsonLd); + private final EdcTransformer edcTransformer = new EdcTransformer(new com.fasterxml.jackson.databind.ObjectMapper(), titaniumJsonLd, new TypeTransformerRegistryImpl()); @Mock private PolicyStoreService service; diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/models/OperatorTypeTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/models/OperatorTypeTest.java index 7cee4b39c6..4ea74c66f1 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/models/OperatorTypeTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/models/OperatorTypeTest.java @@ -27,4 +27,28 @@ void shouldPrintProperString() { assertThat(OperatorType.GTEQ.toString()).isEqualTo(OperatorType.GTEQ.getCode()); } + @Test + void whenFromValueShouldRemovePrefixIfPresent() { + // given + final String prefix = "odrl:"; + final String operator = "eq"; + + // when + final OperatorType result = OperatorType.fromValue(prefix + operator); + + // then + assertThat(result.toString().toLowerCase()).isEqualTo(operator); + } + + @Test + void whenFromValueShouldNotRemovePrefixIfNotPresent() { + // given + final String operator = "eq"; + + // when + final OperatorType result = OperatorType.fromValue(operator); + + // then + assertThat(result.toString().toLowerCase()).isEqualTo(operator); + } } \ No newline at end of file From 34b1f36d904d3005c5895348ea749e4041fc620f Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Fri, 26 Jan 2024 12:00:36 +0100 Subject: [PATCH 051/116] feat(irs):[#249] removed unused import --- .../tractusx/irs/edc/client/transformer/EdcTransformer.java | 1 - 1 file changed, 1 deletion(-) diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java index 461abff19e..da9b59f4f8 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java @@ -36,7 +36,6 @@ import org.eclipse.edc.catalog.spi.Catalog; import org.eclipse.edc.catalog.spi.CatalogRequest; import org.eclipse.edc.core.transform.TransformerContextImpl; -import org.eclipse.edc.core.transform.TypeTransformerRegistryImpl; import org.eclipse.edc.core.transform.transformer.from.JsonObjectFromAssetTransformer; import org.eclipse.edc.core.transform.transformer.from.JsonObjectFromCatalogTransformer; import org.eclipse.edc.core.transform.transformer.from.JsonObjectFromCriterionTransformer; From dc7b67e9dbf4179c0d47b50542b46e28b64592bc Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Fri, 26 Jan 2024 12:10:32 +0100 Subject: [PATCH 052/116] feat(irs):[#249] updated changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 57c9c48532..2f3e599b29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" - Changed lookupGlobalAssetIds to lookupShellsByBPN, which provides full object. +- Changed structure of Policy creation to match EDC format ## [4.4.0] - 2024-01-15 ### Added From 672d797d0b22efc7ac1de117dc34f408264ef19a Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 26 Jan 2024 13:18:48 +0100 Subject: [PATCH 053/116] feat(imp):[#214] improve exception handling --- .../DecentralDigitalTwinRegistryService.java | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 7f27851fc2..29a74348a5 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -258,14 +258,15 @@ private Collection lookupShellIds(final String bpn) throws RegistryServi final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; log.info(logPrefix + "Looking up shell ids for bpn {}", bpn); - final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.info(logPrefix + "Looking up shell ids for bpn '{}' with connector endpoints {}", bpn, connectorEndpoints); + try { - final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( - connectorEndpoints); - log.info(logPrefix + "Created endpointDataReferenceFutures"); + final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); + log.info(logPrefix + "Looking up shell ids for bpn '{}' with connector endpoints {}", bpn, + connectorEndpoints); - try { + final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( + connectorEndpoints); + log.info(logPrefix + "Created endpointDataReferenceFutures"); return lookupShellIds(bpn, endpointDataReferenceFutures, logPrefix); From d1fd503620a36f1d0272f0928730d2ed07a8bc73 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Fri, 26 Jan 2024 14:49:21 +0100 Subject: [PATCH 054/116] feat(irs-api):[#344] Add Irs WireMock Test simulating one level --- .../eclipse/tractusx/irs/IrsWireMockIT.java | 189 ++++++++++++++++-- .../tractusx/irs/WireMockTestConfig.java | 28 +++ .../tractusx/irs/bpdm/BpdmWireMockConfig.java | 86 ++++++++ .../tractusx/irs/bpdm/BpdmWiremockTest.java | 60 +----- .../SemanticHubWireMockConfig.java | 52 +++++ .../semanticshub/SemanticHubWiremockTest.java | 11 +- .../__files/integrationtesting/batch-1.json | 22 ++ .../singleLevelBomAsBuilt-1.json | 16 ++ .../singleLevelBomAsBuilt-2.0.0-schema.json | 102 ++++++++++ .../client/SubmodelFacadeWiremockTest.java | 87 +++++--- .../DiscoveryServiceWiremockConfig.java | 28 +-- .../testing/wiremock/DtrWiremockConfig.java | 34 +++- .../SubmodelFacadeWiremockConfig.java | 99 ++++----- 13 files changed, 620 insertions(+), 194 deletions(-) create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java create mode 100644 irs-api/src/test/resources/__files/integrationtesting/batch-1.json create mode 100644 irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-1.json create mode 100644 irs-api/src/test/resources/__files/semantichub/singleLevelBomAsBuilt-2.0.0-schema.json rename {irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client => irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock}/SubmodelFacadeWiremockConfig.java (67%) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java index d7970bdee4..7de5396ebe 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java @@ -23,24 +23,62 @@ ********************************************************************************/ package org.eclipse.tractusx.irs; -import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.containing; import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; +import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; +import static org.eclipse.tractusx.irs.WireMockTestConfig.createEndpointDataReference; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.bpdmResponse; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.batchSchemaResponse200; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.singleLevelBomAsBuiltSchemaResponse200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_LOOKUP_SHELLS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_SHELL_DESCRIPTORS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.lookupShellsResponse; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_CATALOG; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_NEGOTIATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_STATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_TRANSFER; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; +import java.nio.charset.StandardCharsets; +import java.time.Duration; import java.util.List; import com.github.tomakehurst.wiremock.junit5.WireMockTest; +import org.apache.commons.codec.binary.Base64; +import org.awaitility.Awaitility; +import org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig; import org.eclipse.tractusx.irs.component.JobHandle; +import org.eclipse.tractusx.irs.component.Jobs; import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; import org.eclipse.tractusx.irs.component.RegisterJob; import org.eclipse.tractusx.irs.component.enums.Direction; +import org.eclipse.tractusx.irs.component.enums.JobState; +import org.eclipse.tractusx.irs.edc.client.EndpointDataReferenceStorage; import org.eclipse.tractusx.irs.semanticshub.AspectModels; +import org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig; import org.eclipse.tractusx.irs.services.IrsItemGraphQueryService; import org.eclipse.tractusx.irs.services.SemanticHubService; import org.eclipse.tractusx.irs.services.validation.SchemaNotFoundException; import org.eclipse.tractusx.irs.testing.containers.MinioContainer; +import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; @@ -57,34 +95,29 @@ @WireMockTest(httpPort = 8085) @Testcontainers -@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = WireMockTestConfig.class - /*, properties = "spring.main.allow-bean-definition-overriding=true"*/) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = WireMockTestConfig.class) @ContextConfiguration(initializers = IrsWireMockIT.MinioConfigInitializer.class) -//@Import({ WireMockTestConfig.class }) @ActiveProfiles("integrationtest") class IrsWireMockIT { - public static final String BPDM_TEST = "http://bpdm.test/legal-entities/{partnerId}?idType={idType}"; - public static final String DISCOVERY_TEST = "http://discovery.test"; public static final String SEMANTIC_HUB_URL = "http://semantic.hub/models"; - public static final String SEMANTIC_HUB_SCHEMA_URL = "http://semantic.hub/models/{urn}/json-schema"; + public static final String EDC_URL = "http://edc.test"; private static final String ACCESS_KEY = "accessKey"; private static final String SECRET_KEY = "secretKey"; private static final MinioContainer minioContainer = new MinioContainer( new MinioContainer.CredentialsProvider(ACCESS_KEY, SECRET_KEY)).withReuse(true); - public static final String EDC_URL = "http://edc.test:8081/management"; @Autowired private IrsItemGraphQueryService irsService; @Autowired private SemanticHubService semanticHubService; + @Autowired + private EndpointDataReferenceStorage endpointDataReferenceStorage; @BeforeAll static void startContainer() { minioContainer.start(); - givenThat(get(urlPathEqualTo("/models")).willReturn(aResponse().withStatus(200) - .withHeader("Content-Type", - "application/json;charset=UTF-8") - .withBodyFile("all-models-page-IT.json"))); + givenThat(get(urlPathEqualTo("/models")).willReturn( + responseWithStatus(200).withBodyFile("semantichub/all-models-page-IT.json"))); } @AfterAll @@ -94,11 +127,21 @@ static void stopContainer() { @DynamicPropertySource static void configureProperties(DynamicPropertyRegistry registry) { - registry.add("bpdm.bpnEndpoint", () -> BPDM_TEST); - registry.add("digitalTwinRegistry.discoveryFinderUrl", () -> DISCOVERY_TEST); + registry.add("bpdm.bpnEndpoint", () -> BpdmWireMockConfig.BPDM_TEST); + registry.add("digitalTwinRegistry.discoveryFinderUrl", () -> DISCOVERY_FINDER_URL); + registry.add("digitalTwinRegistry.shellDescriptorTemplate", () -> SHELL_DESCRIPTORS_TEMPLATE); + registry.add("digitalTwinRegistry.lookupShellsTemplate", () -> LOOKUP_SHELLS_TEMPLATE); + registry.add("digitalTwinRegistry.type", () -> "decentral"); registry.add("semanticshub.url", () -> SEMANTIC_HUB_URL); - registry.add("semanticshub.modelJsonSchemaEndpoint", () -> SEMANTIC_HUB_SCHEMA_URL); + registry.add("semanticshub.modelJsonSchemaEndpoint", () -> SemanticHubWireMockConfig.SEMANTIC_HUB_SCHEMA_URL); registry.add("irs-edc-client.controlplane.endpoint.data", () -> EDC_URL); + registry.add("irs-edc-client.controlplane.endpoint.catalog", () -> PATH_CATALOG); + registry.add("irs-edc-client.controlplane.endpoint.contract-negotiation", () -> PATH_NEGOTIATE); + registry.add("irs-edc-client.controlplane.endpoint.transfer-process", () -> PATH_TRANSFER); + registry.add("irs-edc-client.controlplane.endpoint.state-suffix", () -> PATH_STATE); + registry.add("irs-edc-client.controlplane.api-key.header", () -> "X-Api-Key"); + registry.add("irs-edc-client.controlplane.api-key.secret", () -> "test"); + registry.add("resilience4j.retry.configs.default.waitDuration", () -> "1s"); } @Test @@ -113,13 +156,25 @@ void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundExcep @Test void shouldStartJob() { // Arrange + final String startId = "globalAssetId"; + + successfulSemanticHubRequests(); + successfulDiscovery(); + successfulRegistryNegotiation(); + successfulDtrRequest(startId); + successfulAssetNegotiation(); + + successfulDataRequests(); + + successfulBpdmRequests(); + final RegisterJob request = RegisterJob.builder() .key(PartChainIdentificationKey.builder() - .bpn("BPNTEST") - .globalAssetId("globalAssetId") + .bpn(TEST_BPN) + .globalAssetId(startId) .build()) - .depth(2) - .aspects(List.of("SerialPart", "Batch", "SingleLevelBomAsBuilt")) + .depth(1) + .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) .collectAspects(true) .lookupBPNs(true) .direction(Direction.DOWNWARD) @@ -127,9 +182,103 @@ void shouldStartJob() { // Act final JobHandle jobHandle = irsService.registerItemJob(request); + assertThat(jobHandle.getId()).isNotNull(); + Awaitility.await() + .timeout(Duration.ofSeconds(35)) + .pollInterval(Duration.ofSeconds(1)) + .until(() -> irsService.getJobForJobId(jobHandle.getId(), false) + .getJob() + .getState() + .equals(JobState.COMPLETED)); + + Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); // Assert - assertThat(jobHandle.getId()).isNotNull(); + verifyDiscoveryCalls(1); + verifyNegotiationCalls(3); + + assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); + assertThat(jobForJobId.getShells()).hasSize(2); + assertThat(jobForJobId.getRelationships()).hasSize(1); + assertThat(jobForJobId.getTombstones()).isEmpty(); + } + + private void successfulRegistryNegotiation() { + final String negotiationId = "1bbaec6e-c316-4e1e-8258-c07a648cc43c"; + final String transferProcessId = "1b21e963-0bc5-422a-b30d-fd3511861d88"; + final String edcAssetId = "registry-asset"; + final String contractAgreementId = SubmodelFacadeWiremockConfig.prepareNegotiation(negotiationId, + transferProcessId, + "7681f966-36ea-4542-b5ea-0d0db81967de:registry-asset:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", edcAssetId); + endpointDataReferenceStorage.put(contractAgreementId, createEndpointDataReference(contractAgreementId)); + } + + private void successfulAssetNegotiation() { + final String negotiationId = "1bbaec6e-c316-4e1e-8258-c07a648cc43c"; + final String transferProcessId = "1b21e963-0bc5-422a-b30d-fd3511861d88"; + final String edcAssetId = "urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26"; + final String contractAgreementId = SubmodelFacadeWiremockConfig.prepareNegotiation(negotiationId, + transferProcessId, + "7681f966-36ea-4542-b5ea-0d0db81967de:urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", + edcAssetId); + endpointDataReferenceStorage.put(contractAgreementId, createEndpointDataReference(contractAgreementId)); + } + + private static void successfulDiscovery() { + stubFor(postDiscoveryFinder200()); + stubFor(postEdcDiscovery200()); + } + + private static String encodedId(final String secondDTR) { + return Base64.encodeBase64String(secondDTR.getBytes(StandardCharsets.UTF_8)); + } + + private static void verifyDiscoveryCalls(final int times) { + verify(times, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(times, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + } + + private static void verifyNegotiationCalls(final int times) { + verify(times, postRequestedFor(urlPathEqualTo(PATH_NEGOTIATE))); + verify(times, postRequestedFor(urlPathEqualTo(PATH_CATALOG))); + verify(times * 2, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*"))); + verify(times, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*" + PATH_STATE))); + verify(times, postRequestedFor(urlPathEqualTo(PATH_TRANSFER))); + verify(times * 2, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*"))); + verify(times, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*" + PATH_STATE))); + } + + private static void successfulBpdmRequests() { + stubFor(get(urlPathMatching("/legal-entities/.*")).willReturn( + responseWithStatus(200).withBody(bpdmResponse(TEST_BPN, "Company Name")))); + } + + private static void successfulDataRequests() { + givenThat(get(urlPathMatching( + DATAPLANE_PUBLIC_PATH + "/urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf")).willReturn( + responseWithStatus(200).withBodyFile("integrationtesting/batch-1.json"))); + givenThat(get(urlPathMatching( + DATAPLANE_PUBLIC_PATH + "/urn:uuid:0e413809-966b-4107-aae5-aeb28bcdaadf")).willReturn( + responseWithStatus(200).withBodyFile("integrationtesting/singleLevelBomAsBuilt-1.json"))); + } + + private static void successfulSemanticHubRequests() { + stubFor(batchSchemaResponse200()); + stubFor(singleLevelBomAsBuiltSchemaResponse200()); + } + + private static void successfulDtrRequest(final String startId) { + stubFor(getLookupShells200(PUBLIC_LOOKUP_SHELLS_PATH).withQueryParam("assetIds", containing(startId))); + stubFor(getShellDescriptor200( + PUBLIC_SHELL_DESCRIPTORS_PATH + encodedId("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf"))); + + final String secondDTR = "urn:uuid:6d505432-8b31-4966-9514-4b753372683f"; + stubFor(get(urlPathEqualTo(PUBLIC_LOOKUP_SHELLS_PATH)).withQueryParam("assetIds", + containing("urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5")) + .willReturn(responseWithStatus(200).withBody( + lookupShellsResponse(List.of(secondDTR))))); + + stubFor(getShellDescriptor200(PUBLIC_SHELL_DESCRIPTORS_PATH + encodedId(secondDTR))); } public static class MinioConfigInitializer diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java index 16e9e92c3c..5cc1adcf9d 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java @@ -24,12 +24,21 @@ import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.EDC_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.NO_ERROR_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.SEMHUB_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.DATAPLANE_HOST; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_DATAPLANE_PUBLIC; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; +import java.nio.charset.StandardCharsets; +import java.util.Base64; import java.util.List; +import java.util.Map; import com.fasterxml.jackson.databind.ObjectMapper; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.data.StringMapper; +import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; +import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; @@ -44,6 +53,25 @@ public class WireMockTestConfig { public static final int HTTP_PORT = 8085; private static final String PROXY_SERVER_HOST = "127.0.0.1"; + public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + return EndpointDataReference.Builder.newInstance() + .authKey("testkey") + .authCode(jwtToken) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) + .build(); + } + @Primary @Profile("integrationtest") @Bean(DTR_REST_TEMPLATE) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java new file mode 100644 index 0000000000..8a1089c5ce --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java @@ -0,0 +1,86 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.bpdm; + +/** + * WireMock configurations and requests used for testing BPDM flow. + */ +public final class BpdmWireMockConfig { + + public static final String BPDM_TEST = "http://bpdm.test/legal-entities/{partnerId}?idType={idType}"; + + private BpdmWireMockConfig() { + } + + public static String bpdmResponse(final String bpn, final String companyName) { + return """ + { + "bpn": "%s", + "identifiers": [ + { + "value": "%s", + "type": { + "technicalKey": "BPN", + "name": "Business Partner Number", + "url": "" + }, + "issuingBody": { + "technicalKey": "CATENAX", + "name": "Catena-X", + "url": "" + }, + "status": { + "technicalKey": "UNKNOWN", + "name": "Unknown" + } + } + ], + "names": [ + { + "value": "%s", + "shortName": null, + "type": { + "technicalKey": "OTHER", + "name": "Any other alternative name used for a company, such as a specific language variant.", + "url": "" + }, + "language": { + "technicalKey": "undefined", + "name": "Undefined" + } + } + ], + "legalForm": null, + "status": null, + "profileClassifications": [], + "types": [ + { + "technicalKey": "UNKNOWN", + "name": "Unknown", + "url": "" + } + ], + "bankAccounts": [], + "roles": [], + "relations": [], + "currentness": "2022-07-26T08:17:38.737578Z" + } + """.formatted(bpn, bpn, companyName); + } +} \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java index e9e107cd8d..fc963f6163 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java @@ -18,12 +18,13 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.bpdm; -import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; import static com.github.tomakehurst.wiremock.client.WireMock.get; import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.BPDM_TEST; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.bpdmResponse; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; @@ -45,67 +46,14 @@ class BpdmWiremockTest { void setUp(WireMockRuntimeInfo wireMockRuntimeInfo) { final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); - bpdmFacade = new BpdmFacade( - new BpdmClientImpl(restTemplate, "http://bpdm.test/legal-entities/{partnerId}?idType={idType}")); + bpdmFacade = new BpdmFacade(new BpdmClientImpl(restTemplate, BPDM_TEST)); } @Test void shouldResolveManufacturerName() { // Arrange givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn( - aResponse().withStatus(200).withHeader("Content-Type", "application/json;charset=UTF-8").withBody(""" - { - "bpn": "BPNL00000000TEST", - "identifiers": [ - { - "value": "BPNL00000000TEST", - "type": { - "technicalKey": "BPN", - "name": "Business Partner Number", - "url": "" - }, - "issuingBody": { - "technicalKey": "CATENAX", - "name": "Catena-X", - "url": "" - }, - "status": { - "technicalKey": "UNKNOWN", - "name": "Unknown" - } - } - ], - "names": [ - { - "value": "TEST_BPN_DFT_1", - "shortName": null, - "type": { - "technicalKey": "OTHER", - "name": "Any other alternative name used for a company, such as a specific language variant.", - "url": "" - }, - "language": { - "technicalKey": "undefined", - "name": "Undefined" - } - } - ], - "legalForm": null, - "status": null, - "profileClassifications": [], - "types": [ - { - "technicalKey": "UNKNOWN", - "name": "Unknown", - "url": "" - } - ], - "bankAccounts": [], - "roles": [], - "relations": [], - "currentness": "2022-07-26T08:17:38.737578Z" - } - """))); + responseWithStatus(200).withBody(bpdmResponse("BPNL00000000TEST", "TEST_BPN_DFT_1")))); // Act final Optional manufacturerName = bpdmFacade.findManufacturerName("BPNL00000000TEST"); diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java new file mode 100644 index 0000000000..16120c02cb --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java @@ -0,0 +1,52 @@ +/******************************************************************************** + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.semanticshub; + +import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; + +import com.github.tomakehurst.wiremock.client.MappingBuilder; + +/** + * WireMock configurations and requests used for testing Semantic Hub fLow. + */ +public final class SemanticHubWireMockConfig { + public static final String BATCH_URN = "urn:samm:io.catenax.batch:2.0.0%23Batch"; + public static final String SEMANTIC_HUB_SCHEMA_URL = "http://semantic.hub/models/{urn}/json-schema"; + private static final String SINGLE_LEVEL_BOM_AS_BUILT_URN = "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0%23SingleLevelBomAsBuilt"; + + private SemanticHubWireMockConfig() { + } + + public static MappingBuilder batchSchemaResponse200() { + return schemaResponse200("/models/" + BATCH_URN + "/json-schema", "semantichub/batch-2.0.0-schema.json"); + } + + public static MappingBuilder singleLevelBomAsBuiltSchemaResponse200() { + return schemaResponse200("/models/" + SINGLE_LEVEL_BOM_AS_BUILT_URN + "/json-schema", + "semantichub/singleLevelBomAsBuilt-2.0.0-schema.json"); + } + + private static MappingBuilder schemaResponse200(final String urlRegex, final String fileName) { + return get(urlPathMatching(urlRegex)).withHost(equalTo("semantic.hub")) + .willReturn(responseWithStatus(200).withBodyFile(fileName)); + } +} \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java index 321f4d6fef..2a52ef68d7 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java @@ -34,6 +34,8 @@ import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.SEMANTIC_HUB_SCHEMA_URL; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.batchSchemaResponse200; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; @@ -67,7 +69,7 @@ void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { final SemanticsHubConfiguration config = new SemanticsHubConfiguration(); config.setPageSize(10); config.setUrl("http://semantic.hub/models"); - config.setModelJsonSchemaEndpoint("http://semantic.hub/models/{urn}/json-schema"); + config.setModelJsonSchemaEndpoint(SEMANTIC_HUB_SCHEMA_URL); final SemanticsHubClient semanticsHubClient = new SemanticsHubClientImpl(restTemplate, config); semanticsHubFacade = new SemanticsHubFacade(semanticsHubClient); @@ -107,12 +109,7 @@ void shouldReturn2Pages() throws SchemaNotFoundException { @Test void shouldReturnJsonSchema() throws SchemaNotFoundException { // Arrange - stubFor(get(urlPathMatching("/models/urn:samm:io.catenax.batch:2.0.0%23Batch/json-schema")).withHost( - equalTo("semantic.hub")) - .willReturn( - responseWithStatus( - 200).withBodyFile( - "semantichub/batch-2.0.0-schema.json"))); + stubFor(batchSchemaResponse200()); // Act final String modelJsonSchema = semanticsHubFacade.getModelJsonSchema("urn:samm:io.catenax.batch:2.0.0#Batch"); diff --git a/irs-api/src/test/resources/__files/integrationtesting/batch-1.json b/irs-api/src/test/resources/__files/integrationtesting/batch-1.json new file mode 100644 index 0000000000..76e6d99956 --- /dev/null +++ b/irs-api/src/test/resources/__files/integrationtesting/batch-1.json @@ -0,0 +1,22 @@ +{ + "localIdentifiers": [ + { + "value": "BPNL00000000TEST", + "key": "manufacturerId" + }, + { + "value": "BID12345678", + "key": "batchId" + } + ], + "manufacturingInformation": { + "date": "2022-02-04T14:48:54", + "country": "HUR" + }, + "catenaXId": "urn:uuid:334cce52-1f52-4bc9-9dd1-410bbe497bbc", + "partTypeInformation": { + "manufacturerPartId": "123-0.740-3434-A", + "classification": "product", + "nameAtManufacturer": "Glue" + } +} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-1.json b/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-1.json new file mode 100644 index 0000000000..167a940ce7 --- /dev/null +++ b/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-1.json @@ -0,0 +1,16 @@ +{ + "catenaXId": "urn:uuid:334cce52-1f52-4bc9-9dd1-410bbe497bbc", + "childItems": [ + { + "catenaXId": "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", + "quantity": { + "quantityNumber": 0.2014, + "measurementUnit": "unit:kilogram" + }, + "hasAlternatives": true, + "businessPartner": "BPNL00000000TEST", + "createdOn": "2022-02-03T14:48:54.709Z", + "lastModifiedOn": "2022-02-03T14:48:54.709Z" + } + ] +} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/semantichub/singleLevelBomAsBuilt-2.0.0-schema.json b/irs-api/src/test/resources/__files/semantichub/singleLevelBomAsBuilt-2.0.0-schema.json new file mode 100644 index 0000000000..70fbf22bb0 --- /dev/null +++ b/irs-api/src/test/resources/__files/semantichub/singleLevelBomAsBuilt-2.0.0-schema.json @@ -0,0 +1,102 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The single-level bill of material represents one sub-level of an assembly and does not include any lower-level subassemblies. The as-built lifecycle references all child items as manufactured by the manufacturer referencing only child items in an as-built lifecycle themselves (e.g. serial parts or batches), unless parts can only be tracked by an part ID (on a type level).\n\nIf it is unclear which item has been built-in into the parent item, all potential parts must be listed. This is the case when, e.g. the same item is supplied by two suppliers and the item is only tracked by a customer part ID during assembly, these items can not be differentiated from each other.\n", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_CatenaXIdTraitCharacteristic" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" : { + "type" : "string", + "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", + "description" : "Describes a Property which contains the date and time with an optional timezone." + }, + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_NumberOfObjects" : { + "type" : "number", + "description" : "Quantifiable number of objects in reference to the measurementUnit" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Describes a Property containing a reference to one of the units in the Unit Catalog." + }, + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_QuantityCharacteristic" : { + "description" : "Describes the quantity in which the child item is assembled in the given parent item by providing a quantity value and the measurement unit in which the quantity is measured.", + "type" : "object", + "properties" : { + "quantityNumber" : { + "description" : "The number of objects related to the measurement unit", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_NumberOfObjects" + }, + "measurementUnit" : { + "description" : "Unit of Measurement for the quantity of serialized objects", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference" + } + }, + "required" : [ "quantityNumber", "measurementUnit" ] + }, + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_BpnTrait" : { + "type" : "string", + "description" : "Business Partner Number Regular Expression allowing only BPNL which stands for a legal entity.", + "pattern" : "^(BPNL)([0-9]{8})([a-zA-Z0-9]{4})$" + }, + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_HasAlternativesCharacteristic" : { + "type" : "boolean", + "description" : "Describes the value whether the child data has alternatives." + }, + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_ChildData" : { + "description" : "Catena-X ID and meta data of the assembled child item.", + "type" : "object", + "properties" : { + "createdOn" : { + "description" : "Timestamp when the relation between the parent item and the child item was created, e.g. when the serialized child part was assembled into the given part.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "quantity" : { + "description" : "Quantity of which the child item is assembled into the parent item. In general it is '1' for serialized parts.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_QuantityCharacteristic" + }, + "lastModifiedOn" : { + "description" : "Timestamp when the assembly relationship between parent item and child item was last modified.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "catenaXId" : { + "description" : "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_CatenaXIdTraitCharacteristic" + }, + "businessPartner" : { + "description" : "The supplier of the given child item.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_BpnTrait" + }, + "hasAlternatives" : { + "description" : "Expresses wether the part is built-in or wether it is one of several options. If the value is false, it can be assumend this exact item is built-in. If the value is true, it is unknown wether this or an alternative item is built-in.\nThis is the case when, e.g. the same item is supplied by two suppliers, the item is only tracked by a customer part ID during assembly. Thus, these items can not be differentiated from each other.\n\n", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_HasAlternativesCharacteristic" + } + }, + "required" : [ "createdOn", "quantity", "catenaXId", "businessPartner", "hasAlternatives" ] + }, + "urn_samm_io.catenax.single_level_bom_as_built_2.0.0_SetOfChildItemsCharacteristic" : { + "description" : "Set of child items the parent item is assembled by (one structural level down).", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_ChildData" + }, + "uniqueItems" : true + } + } + }, + "properties" : { + "catenaXId" : { + "description" : "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_CatenaXIdTraitCharacteristic" + }, + "childItems" : { + "description" : "Set of child items, of which the given parent item is assembled by (one structural level down).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.single_level_bom_as_built_2.0.0_SetOfChildItemsCharacteristic" + } + }, + "required" : [ "catenaXId", "childItems" ] +} \ No newline at end of file diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java index 43ef624320..44effe1593 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java @@ -29,16 +29,21 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.eclipse.tractusx.irs.edc.client.testutil.TestMother.createEdcTransformer; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.DATAPLANE_HOST; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_DATAPLANE_PUBLIC; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; +import java.nio.charset.StandardCharsets; import java.time.Clock; import java.time.Duration; import java.time.OffsetDateTime; import java.util.ArrayList; +import java.util.Base64; import java.util.List; +import java.util.Map; import java.util.concurrent.ExecutionException; import java.util.concurrent.Executors; import java.util.concurrent.TimeUnit; @@ -49,9 +54,13 @@ import io.github.resilience4j.retry.RetryRegistry; import org.assertj.core.api.ThrowableAssert; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.data.StringMapper; import org.eclipse.tractusx.irs.edc.client.cache.endpointdatareference.EndpointDataReferenceCacheService; +import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.eclipse.tractusx.irs.edc.client.exceptions.UsagePolicyException; +import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.eclipse.tractusx.irs.edc.client.policy.AcceptedPoliciesProvider; import org.eclipse.tractusx.irs.edc.client.policy.AcceptedPolicy; import org.eclipse.tractusx.irs.edc.client.policy.Constraint; @@ -61,6 +70,7 @@ import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.PolicyCheckerService; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; +import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.http.converter.HttpMessageConverter; @@ -71,10 +81,10 @@ @WireMockTest class SubmodelFacadeWiremockTest { private static final String PROXY_SERVER_HOST = "127.0.0.1"; - private final static String connectorEndpoint = "https://connector.endpoint.com"; - private final static String submodelDataplanePath = "/api/public/shells/12345/submodels/5678/submodel"; - private final static String submodelDataplaneUrl = "http://dataplane.test" + submodelDataplanePath; - private final static String assetId = "12345"; + private final static String CONNECTOR_ENDPOINT_URL = "https://connector.endpoint.com"; + private final static String SUBMODEL_DATAPLANE_PATH = "/api/public/shells/12345/submodels/5678/submodel"; + private final static String SUBMODEL_DATAPLANE_URL = "http://dataplane.test" + SUBMODEL_DATAPLANE_PATH; + private final static String ASSET_ID = "12345"; private final EdcConfiguration config = new EdcConfiguration(); private final EndpointDataReferenceStorage storage = new EndpointDataReferenceStorage(Duration.ofMinutes(1)); private EdcSubmodelClient edcSubmodelClient; @@ -133,13 +143,13 @@ void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { void shouldReturnAssemblyPartRelationshipAsString() throws EdcClientException, ExecutionException, InterruptedException { // Arrange - SubmodelFacadeWiremockConfig.prepareNegotiation(storage); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + prepareNegotiation(); + givenThat(get(urlPathEqualTo(SUBMODEL_DATAPLANE_PATH)).willReturn( responseWithStatus(200).withBodyFile("singleLevelBomAsBuilt.json"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, - assetId).get(); + final String submodel = edcSubmodelClient.getSubmodelRawPayload(CONNECTOR_ENDPOINT_URL, SUBMODEL_DATAPLANE_URL, + ASSET_ID).get(); // Assert assertThat(submodel).contains("\"catenaXId\": \"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\""); @@ -149,13 +159,13 @@ void shouldReturnAssemblyPartRelationshipAsString() void shouldReturnMaterialForRecyclingAsString() throws EdcClientException, ExecutionException, InterruptedException { // Arrange - SubmodelFacadeWiremockConfig.prepareNegotiation(storage); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + prepareNegotiation(); + givenThat(get(urlPathEqualTo(SUBMODEL_DATAPLANE_PATH)).willReturn( responseWithStatus(200).withBodyFile("materialForRecycling.json"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, - assetId).get(); + final String submodel = edcSubmodelClient.getSubmodelRawPayload(CONNECTOR_ENDPOINT_URL, SUBMODEL_DATAPLANE_URL, + ASSET_ID).get(); // Assert assertThat(submodel).contains("\"materialName\": \"Cooper\","); @@ -165,12 +175,12 @@ void shouldReturnMaterialForRecyclingAsString() void shouldReturnObjectAsStringWhenResponseNotJSON() throws EdcClientException, ExecutionException, InterruptedException { // Arrange - SubmodelFacadeWiremockConfig.prepareNegotiation(storage); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(responseWithStatus(200).withBody("test"))); + prepareNegotiation(); + givenThat(get(urlPathEqualTo(SUBMODEL_DATAPLANE_PATH)).willReturn(responseWithStatus(200).withBody("test"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, - assetId).get(); + final String submodel = edcSubmodelClient.getSubmodelRawPayload(CONNECTOR_ENDPOINT_URL, SUBMODEL_DATAPLANE_URL, + ASSET_ID).get(); // Assert assertThat(submodel).isEqualTo("test"); @@ -189,26 +199,26 @@ void shouldThrowExceptionWhenPoliciesAreNotAccepted() { when(acceptedPoliciesProvider.getAcceptedPolicies()).thenReturn(List.of(acceptedPolicy)); - SubmodelFacadeWiremockConfig.prepareNegotiation(storage); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn(responseWithStatus(200).withBody("test"))); + prepareNegotiation(); + givenThat(get(urlPathEqualTo(SUBMODEL_DATAPLANE_PATH)).willReturn(responseWithStatus(200).withBody("test"))); // Act & Assert final String errorMessage = "Consumption of asset '58505404-4da1-427a-82aa-b79482bcd1f0' is not permitted as the required catalog offer policies do not comply with defined IRS policies."; assertThatExceptionOfType(UsagePolicyException.class).isThrownBy( - () -> edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get()) - .withMessageEndingWith(errorMessage); + () -> edcSubmodelClient.getSubmodelRawPayload(CONNECTOR_ENDPOINT_URL, SUBMODEL_DATAPLANE_URL, ASSET_ID) + .get()).withMessageEndingWith(errorMessage); } @Test void shouldThrowExceptionWhenResponse_400() { // Arrange - SubmodelFacadeWiremockConfig.prepareNegotiation(storage); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + prepareNegotiation(); + givenThat(get(urlPathEqualTo(SUBMODEL_DATAPLANE_PATH)).willReturn( responseWithStatus(400).withBody("{ error: '400'}"))); // Act final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( - connectorEndpoint, submodelDataplaneUrl, assetId).get(5, TimeUnit.SECONDS); + CONNECTOR_ENDPOINT_URL, SUBMODEL_DATAPLANE_URL, ASSET_ID).get(5, TimeUnit.SECONDS); // Assert assertThatExceptionOfType(ExecutionException.class).isThrownBy(throwingCallable) @@ -218,19 +228,44 @@ void shouldThrowExceptionWhenResponse_400() { @Test void shouldThrowExceptionWhenResponse_500() { // Arrange - SubmodelFacadeWiremockConfig.prepareNegotiation(storage); - givenThat(get(urlPathEqualTo(submodelDataplanePath)).willReturn( + prepareNegotiation(); + givenThat(get(urlPathEqualTo(SUBMODEL_DATAPLANE_PATH)).willReturn( responseWithStatus(500).withBody("{ error: '500'}"))); // Act final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( - connectorEndpoint, submodelDataplaneUrl, assetId).get(5, TimeUnit.SECONDS); + CONNECTOR_ENDPOINT_URL, SUBMODEL_DATAPLANE_URL, ASSET_ID).get(5, TimeUnit.SECONDS); // Assert assertThatExceptionOfType(ExecutionException.class).isThrownBy(throwingCallable) .withCauseInstanceOf(RestClientException.class); } + private void prepareNegotiation() { + final String contractAgreementId = SubmodelFacadeWiremockConfig.prepareNegotiation(); + final EndpointDataReference ref = createEndpointDataReference(contractAgreementId); + storage.put(contractAgreementId, ref); + } + + public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + return EndpointDataReference.Builder.newInstance() + .authKey("testkey") + .authCode(jwtToken) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) + .build(); + } + private org.eclipse.tractusx.irs.edc.client.policy.Policy policy(String policyId, List permissions) { return new org.eclipse.tractusx.irs.edc.client.policy.Policy(policyId, OffsetDateTime.now(), OffsetDateTime.now().plusYears(1), permissions); diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java index 6130c1501d..db505bf240 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java @@ -20,24 +20,33 @@ import static com.github.tomakehurst.wiremock.client.WireMock.post; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.*; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import java.util.List; import com.github.tomakehurst.wiremock.client.MappingBuilder; -public class DiscoveryServiceWiremockConfig { - public static final String CONTROLPLANE_PUBLIC_URL = "https://controlplane.test"; +/** + * WireMock configurations and requests used for testing the Discovery Service flow. + */ +public final class DiscoveryServiceWiremockConfig { + public static final String CONTROLPLANE_PUBLIC_URL = "https://test.edc.io"; public static final String EDC_DISCOVERY_PATH = "/edcDiscovery"; public static final String TEST_BPN = "BPNL00000000TEST"; public static final String DISCOVERY_FINDER_PATH = "/discoveryFinder"; public static final String DISCOVERY_HOST = "http://discovery.finder"; public static final String EDC_DISCOVERY_URL = DISCOVERY_HOST + EDC_DISCOVERY_PATH; - public static final String DISCOVERY_FINDER_URL = DISCOVERY_HOST + DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; + public static final String DISCOVERY_FINDER_URL = DISCOVERY_HOST + DISCOVERY_FINDER_PATH; + private DiscoveryServiceWiremockConfig() { + } public static MappingBuilder postEdcDiscovery200() { + return postEdcDiscovery200(TEST_BPN, List.of(CONTROLPLANE_PUBLIC_URL)); + } + + public static MappingBuilder postEdcDiscovery200(final String bpn, final List edcUrls) { return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn( - responseWithStatus(200).withBody(edcDiscoveryResponse(TEST_BPN, List.of(CONTROLPLANE_PUBLIC_URL)))); + responseWithStatus(200).withBody(edcDiscoveryResponse(bpn, edcUrls))); } public static String edcDiscoveryResponse(final String bpn, final List connectorEndpoints) { @@ -74,15 +83,6 @@ public static String discoveryFinderResponse(final String discoveryFinderUrl) { """.formatted(discoveryFinderUrl); } - public static String discoveryFinderEmtpyResponse() { - return """ - { - "endpoints": [ - ] - } - """; - } - public static MappingBuilder postDiscoveryFinder404() { return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn(responseWithStatus(404)); } diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java index 4f29f1fbd1..a4f743d578 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java @@ -27,18 +27,28 @@ import com.github.tomakehurst.wiremock.client.MappingBuilder; -public class DtrWiremockConfig { +/** + * WireMock configurations and requests used for testing the decentralized DigitalTwinRegistry flow. + */ +public final class DtrWiremockConfig { public static final String DATAPLANE_URL = "http://dataplane.test"; - public static final String DATAPLANE_PUBLIC_URL = DATAPLANE_URL + "/api/public/data/"; + public static final String DATAPLANE_PUBLIC_PATH = "/api/public"; + public static final String DATAPLANE_PUBLIC_URL = DATAPLANE_URL + DATAPLANE_PUBLIC_PATH; public static final String SHELL_DESCRIPTORS_PATH = "/shell-descriptors/"; + public static final String PUBLIC_SHELL_DESCRIPTORS_PATH = DATAPLANE_PUBLIC_PATH + SHELL_DESCRIPTORS_PATH; public static final String SHELL_DESCRIPTORS_TEMPLATE = SHELL_DESCRIPTORS_PATH + "{aasIdentifier}"; public static final String LOOKUP_SHELLS_PATH = "/lookup/shells"; + public static final String PUBLIC_LOOKUP_SHELLS_PATH = DATAPLANE_PUBLIC_PATH + LOOKUP_SHELLS_PATH; public static final String LOOKUP_SHELLS_TEMPLATE = LOOKUP_SHELLS_PATH + "?assetIds={assetIds}"; private DtrWiremockConfig() { } public static MappingBuilder getShellDescriptor200() { + return getShellDescriptor200(SHELL_DESCRIPTORS_PATH + ".*"); + } + + public static MappingBuilder getShellDescriptor200(final String urlRegex) { final String materialForRecycling = submodelDescriptor(DATAPLANE_PUBLIC_URL, "urn:uuid:19b0338f-6d03-4198-b3b8-5c43f8958d60", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "MaterialForRecycling", "urn:uuid:cf06d5d5-e3f8-4bd4-bfcf-81815310701f", @@ -48,15 +58,15 @@ public static MappingBuilder getShellDescriptor200() { DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "Batch", "urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf", "urn:samm:io.catenax.batch:2.0.0#Batch"); - final String singleLevelUsageAsBuilt = submodelDescriptor(DATAPLANE_PUBLIC_URL, - "urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, - "SingleLevelUsageAsBuilt", "urn:uuid:e2899f43-eca8-4aec-b877-4a69691f0487", - "urn:bamm:io.catenax.single_level_usage_as_built:2.0.0#SingleLevelUsageAsBuilt"); + final String singleLevelBomAsBuilt = submodelDescriptor(DATAPLANE_PUBLIC_URL, + "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, + "SingleLevelBomAsBuilt", "urn:uuid:0e413809-966b-4107-aae5-aeb28bcdaadf", + "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt"); - final List submodelDescriptors = List.of(materialForRecycling, batch, singleLevelUsageAsBuilt); + final List submodelDescriptors = List.of(batch, singleLevelBomAsBuilt, materialForRecycling); final List specificAssetIds = List.of(specificAssetId("manufacturerId", "BPNL00000003B0Q0"), specificAssetId("batchId", "BID12345678")); - return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn(responseWithStatus(200).withBody( + return get(urlPathMatching(urlRegex)).willReturn(responseWithStatus(200).withBody( assetAdministrationShellResponse(submodelDescriptors, "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", "EngineeringPlastics", "urn:uuid:9ce43b21-75e3-4cea-b13e-9a34f4f6822a", specificAssetIds))); } @@ -103,7 +113,7 @@ public static String specificAssetId(final String key, final String value) { public static String submodelDescriptor(final String dataplaneUrl, final String assetId, final String dspEndpoint, final String idShort, final String submodelDescriptorId, final String semanticId) { - final String href = dataplaneUrl + submodelDescriptorId; + final String href = dataplaneUrl + "/" + submodelDescriptorId; return """ { "endpoints": [ @@ -147,7 +157,11 @@ public static String submodelDescriptor(final String dataplaneUrl, final String } public static MappingBuilder getLookupShells200() { - return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(200).withBody( + return getLookupShells200(LOOKUP_SHELLS_PATH); + } + + public static MappingBuilder getLookupShells200(final String lookupShellsPath) { + return get(urlPathEqualTo(lookupShellsPath)).willReturn(responseWithStatus(200).withBody( lookupShellsResponse(List.of("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf")))); } diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java similarity index 67% rename from irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java rename to irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java index 762ddeaef1..6c3453b6f5 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java @@ -16,27 +16,19 @@ * * SPDX-License-Identifier: Apache-2.0 ********************************************************************************/ -package org.eclipse.tractusx.irs.edc.client; +package org.eclipse.tractusx.irs.testing.wiremock; import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; -import java.nio.charset.StandardCharsets; -import java.util.Base64; import java.util.List; -import java.util.Map; - -import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; -import org.eclipse.tractusx.irs.data.StringMapper; -import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; -import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; -import org.jetbrains.annotations.NotNull; - -public class SubmodelFacadeWiremockConfig { +/** + * WireMock configurations and requests used for testing the EDC Flow. + */ +public final class SubmodelFacadeWiremockConfig { public static final String PATH_CATALOG = "/catalog/request"; public static final String PATH_NEGOTIATE = "/contractnegotiations"; public static final String PATH_TRANSFER = "/transferprocesses"; @@ -54,46 +46,50 @@ public class SubmodelFacadeWiremockConfig { }"""; public static final String EDC_PROVIDER_DUMMY_URL = "https://edc.io/api/v1/dsp"; public static final String IRS_INTERNAL_CALLBACK_URL = "https://irs.test/internal/endpoint-data-reference"; + public static final String EDC_PROVIDER_BPN = "BPNL00000003CRHK"; - // TODO move to irs-testing + private SubmodelFacadeWiremockConfig() { + } - public static void prepareNegotiation(final EndpointDataReferenceStorage storage) { - prepareNegotiation(storage, "1bbaec6e-c316-4e1e-8258-c07a648cc43c", "1b21e963-0bc5-422a-b30d-fd3511861d88", + public static String prepareNegotiation() { + return prepareNegotiation("1bbaec6e-c316-4e1e-8258-c07a648cc43c", "1b21e963-0bc5-422a-b30d-fd3511861d88", "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", "5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7"); } - public static void prepareNegotiation(final EndpointDataReferenceStorage storage, final String negotiationId, - final String transferProcessId, final String contractAgreementId, final String edcAssetId) { - givenThat(post(urlPathEqualTo(PATH_CATALOG)).willReturn( - responseWithStatus(200).withBody(getCatalogResponse(edcAssetId, "USE", "BPNL00000003CRHK")))); - System.out.println(getCatalogResponse(edcAssetId, "USE", "BPNL00000003CRHK")); - givenThat(post(urlPathEqualTo(PATH_NEGOTIATE)).willReturn( - responseWithStatus(200).withBody(startNegotiationResponse(negotiationId)))); + public static String prepareNegotiation(final String negotiationId, final String transferProcessId, + final String contractAgreementId, final String edcAssetId) { + stubFor(post(urlPathEqualTo(PATH_CATALOG)).willReturn(WireMockConfig.responseWithStatus(200) + .withBody(getCatalogResponse(edcAssetId, + "USE", EDC_PROVIDER_BPN)))); + + stubFor(post(urlPathEqualTo(PATH_NEGOTIATE)).willReturn( + WireMockConfig.responseWithStatus(200).withBody(startNegotiationResponse(negotiationId)))); final String negotiationState = "FINALIZED"; - givenThat(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId)).willReturn(responseWithStatus(200).withBody( - getNegotiationConfirmedResponse(negotiationId, negotiationState, contractAgreementId)))); + stubFor(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId)).willReturn( + WireMockConfig.responseWithStatus(200) + .withBody(getNegotiationConfirmedResponse(negotiationId, negotiationState, + contractAgreementId)))); - givenThat(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId + PATH_STATE)).willReturn( - responseWithStatus(200).withBody(getNegotiationStateResponse(negotiationState)))); + stubFor(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId + PATH_STATE)).willReturn( + WireMockConfig.responseWithStatus(200).withBody(getNegotiationStateResponse(negotiationState)))); - givenThat(post(urlPathEqualTo(PATH_TRANSFER)).willReturn( - responseWithStatus(200).withBody(startTransferProcessResponse(transferProcessId)) + stubFor(post(urlPathEqualTo(PATH_TRANSFER)).willReturn( + WireMockConfig.responseWithStatus(200).withBody(startTransferProcessResponse(transferProcessId)) )); final String transferProcessState = "COMPLETED"; - givenThat(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId + PATH_STATE)).willReturn( - responseWithStatus(200).withBody(getTransferProcessStateResponse(transferProcessState)) + stubFor(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId + PATH_STATE)).willReturn( + WireMockConfig.responseWithStatus(200).withBody(getTransferProcessStateResponse(transferProcessState)) )); - givenThat(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId)).willReturn( - responseWithStatus(200).withBody( - getTransferConfirmedResponse(transferProcessId, transferProcessState, edcAssetId, - contractAgreementId)))); - - final EndpointDataReference ref = createEndpointDataReference(contractAgreementId); - storage.put(contractAgreementId, ref); + stubFor(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId)).willReturn( + WireMockConfig.responseWithStatus(200) + .withBody( + getTransferConfirmedResponse(transferProcessId, transferProcessState, edcAssetId, + contractAgreementId)))); + return contractAgreementId; } private static String startTransferProcessResponse(final String transferProcessId) { @@ -164,16 +160,16 @@ private static String getTransferConfirmedResponse(final String transferProcessI "@id": "%s", "edc:assetId": "%s", "edc:contractId": "%s", - "edc:connectorId": "BPNL00000003CRHK" + "edc:connectorId": "%s" }, "edc:receiverHttpEndpoint": "%s", "@context": %s } """.formatted(transferProcessId, transferState, transferProcessId, edcAssetId, contractAgreementId, - IRS_INTERNAL_CALLBACK_URL, CONTEXT); + EDC_PROVIDER_BPN, IRS_INTERNAL_CALLBACK_URL, CONTEXT); } - private static String getCatalogResponse(final String edcAssetId, final String permissionType, + public static String getCatalogResponse(final String edcAssetId, final String permissionType, final String edcProviderBpn) { return """ { @@ -221,7 +217,6 @@ private static String getCatalogResponse(final String edcAssetId, final String p EDC_PROVIDER_DUMMY_URL, edcProviderBpn, CONTEXT); } - @NotNull private static String createConstraints() { final List atomitConstraints = List.of(createAtomicConstraint("Membership", "active"), createAtomicConstraint("FrameworkAgreement.traceability", "active")); @@ -244,22 +239,4 @@ private static String createAtomicConstraint(final String leftOperand, final Str }""".formatted(leftOperand, rightOperand); } - public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { - final EDRAuthCode edrAuthCode = EDRAuthCode.builder() - .cid(contractAgreementId) - .dad("test") - .exp(9999999999L) - .build(); - final String b64EncodedAuthCode = Base64.getUrlEncoder() - .encodeToString(StringMapper.mapToString(edrAuthCode) - .getBytes(StandardCharsets.UTF_8)); - final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; - return EndpointDataReference.Builder.newInstance() - .authKey("testkey") - .authCode(jwtToken) - .properties( - Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) - .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) - .build(); - } } \ No newline at end of file From 265a177759441ff7d14b40c29a27716043a1a4cc Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Fri, 26 Jan 2024 15:09:41 +0100 Subject: [PATCH 055/116] feat(irs):[#249] added missing white space --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d56f3c367..e4a813ccd9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - CVE-2023-6378 serialization vulnerability in logback - CVE-2023-51074 json-path v2.8.0 stack overflow - CVE-2024-22233 Spring Framework server Web DoS Vulnerability + - ## [4.4.0] - 2024-01-15 ### Added - Added EDR token cache to reuse token after contract negotiation From 002b5d0467ede25cfc7b6d5035af8d82adbe0d51 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Fri, 26 Jan 2024 15:10:07 +0100 Subject: [PATCH 056/116] feat(irs):[#249] added missing white space --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e4a813ccd9..0eda53ad65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - CVE-2023-6378 serialization vulnerability in logback - CVE-2023-51074 json-path v2.8.0 stack overflow - CVE-2024-22233 Spring Framework server Web DoS Vulnerability - - + ## [4.4.0] - 2024-01-15 ### Added - Added EDR token cache to reuse token after contract negotiation From ff326e0a0427bc941950940707556bd68cb66498 Mon Sep 17 00:00:00 2001 From: ds-ext-kmassalski <100765908+ds-ext-kmassalski@users.noreply.github.com> Date: Fri, 26 Jan 2024 16:11:57 +0100 Subject: [PATCH 057/116] Revert "Revert "feat(impl):[#378] separate credentials config"" --- charts/irs-helm/CHANGELOG.md | 5 ++ .../configmap-spring-app-config.yaml | 23 ++++++---- charts/irs-helm/templates/deployment.yaml | 26 +++++++---- charts/irs-helm/templates/secrets.yaml | 10 ++-- charts/irs-helm/values.yaml | 17 ++++--- docs/src/api/irs-api.yaml | 46 +++++++++---------- .../docs/administration/configuration.adoc | 20 ++++++-- .../configuration/OpenApiConfiguration.java | 21 ++++----- .../irs/controllers/BatchController.java | 10 ++-- .../irs/controllers/IrsController.java | 10 ++-- .../irs/ess/controller/EssController.java | 4 +- irs-api/src/main/resources/application.yml | 33 +++++++------ .../controllers/PolicyStoreController.java | 8 ++-- 13 files changed, 134 insertions(+), 99 deletions(-) diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md index 28169057dd..1a763d03c5 100644 --- a/charts/irs-helm/CHANGELOG.md +++ b/charts/irs-helm/CHANGELOG.md @@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Added +- Added configuration parameters `oauth2.semantics.clientId`,`oauth2.semantics.clientSecret`, `oauth2.discovery.clientId`,`oauth2.discovery.clientSecret`, `oauth2.bpdm.clientId`,`oauth2.bpdm.clientSecret` + +### Removed +- Removed configuration parameters `oauth2.clientId`,`oauth2.clientSecret`, `portal.oauth2.clientId`,`portal.oauth2.clientSecret` ## [6.13.0] - 2024-01-15 - Update IRS version to 4.4.0 diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index bad14f82a5..b43e15ce64 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -56,16 +56,21 @@ data: oauth2: client: registration: - common: - client-id: "${OAUTH2_CLIENT_ID}" # taken from secret ENV - client-secret: "${OAUTH2_CLIENT_SECRET}" # taken from secret ENV - portal: - client-id: ${PORTAL_OAUTH2_CLIENT_ID} # taken from secret ENV - client-secret: ${PORTAL_OAUTH2_CLIENT_SECRET} # taken from secret ENV + semantics: + client-id: "${SEMANTICS_OAUTH2_CLIENT_ID}" # taken from secret ENV + client-secret: "${SEMANTICS_OAUTH2_CLIENT_SECRET}" # taken from secret ENV + discovery: + client-id: ${DISCOVERY_OAUTH2_CLIENT_ID} # taken from secret ENV + client-secret: ${DISCOVERY_OAUTH2_CLIENT_SECRET} # taken from secret ENV + bpdm: + client-id: ${BPDM_OAUTH2_CLIENT_ID} # taken from secret ENV + client-secret: ${BPDM_OAUTH2_CLIENT_SECRET} # taken from secret ENV provider: - common: + semantics: token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }} - portal: + discovery: + token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }} + bpdm: token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }} digitalTwinRegistry: @@ -129,7 +134,7 @@ data: irs: url: {{ tpl (.Values.irsUrl | default "") . | quote }} discovery: - oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} + oAuthClientId: {{ .Values.discovery.oAuthClientId | default "discovery" }} {{- if .Values.ess.mockEdcResult }} mockEdcResult: {{- tpl (toYaml .Values.ess.mockEdcResult) . | nindent 10 }} diff --git a/charts/irs-helm/templates/deployment.yaml b/charts/irs-helm/templates/deployment.yaml index 785961cfe5..e30f10c7e8 100644 --- a/charts/irs-helm/templates/deployment.yaml +++ b/charts/irs-helm/templates/deployment.yaml @@ -81,26 +81,36 @@ spec: secretKeyRef: name: {{ template "irs.secretName" . }} key: minioPassword - - name: OAUTH2_CLIENT_ID + - name: SEMANTICS_OAUTH2_CLIENT_ID valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: clientId - - name: OAUTH2_CLIENT_SECRET + key: semanticsId + - name: SEMANTICS_OAUTH2_CLIENT_SECRET valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: clientSecret - - name: PORTAL_OAUTH2_CLIENT_ID + key: semanticsSecret + - name: DISCOVERY_OAUTH2_CLIENT_ID valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: portalClientId - - name: PORTAL_OAUTH2_CLIENT_SECRET + key: discoveryClientId + - name: DISCOVERY_OAUTH2_CLIENT_SECRET valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: portalClientSecret + key: discoveryClientSecret + - name: BPDM_OAUTH2_CLIENT_ID + valueFrom: + secretKeyRef: + name: {{ template "irs.secretName" . }} + key: bpdmClientId + - name: BPDM_OAUTH2_CLIENT_SECRET + valueFrom: + secretKeyRef: + name: {{ template "irs.secretName" . }} + key: bpdmClientSecret - name: EDC_API_KEY_SECRET valueFrom: secretKeyRef: diff --git a/charts/irs-helm/templates/secrets.yaml b/charts/irs-helm/templates/secrets.yaml index c9f8741a28..d9488ae665 100644 --- a/charts/irs-helm/templates/secrets.yaml +++ b/charts/irs-helm/templates/secrets.yaml @@ -35,10 +35,12 @@ type: Opaque data: minioUser: {{ .Values.minioUser | default "minio" | b64enc | quote }} minioPassword: {{ .Values.minioPassword | default "minioPass" | b64enc | quote }} - clientId: {{ .Values.oauth2.clientId | default "clientId" | b64enc | quote }} - clientSecret: {{ .Values.oauth2.clientSecret | default "clientSecret" | b64enc | quote }} - portalClientId: {{ .Values.portal.oauth2.clientId | default "portalClientId" | b64enc | quote }} - portalClientSecret: {{ .Values.portal.oauth2.clientSecret | default "portalClientSecret" | b64enc | quote }} + semanticsId: {{ .Values.oauth2.semantics.clientId | default "semanticsId" | b64enc | quote }} + semanticsSecret: {{ .Values.oauth2.semantics.clientSecret | default "semanticsSecret" | b64enc | quote }} + discoveryClientId: {{ .Values.oauth2.discovery.clientId | default "discoveryClientId" | b64enc | quote }} + discoveryClientSecret: {{ .Values.oauth2.discovery.clientSecret | default "discoveryClientSecret" | b64enc | quote }} + bpdmClientId: {{ .Values.oauth2.bpdm.clientId | default "bpdmClientId" | b64enc | quote }} + bpdmClientSecret: {{ .Values.oauth2.bpdm.clientSecret | default "bpdmClientSecret" | b64enc | quote }} edcApiSecret: {{ .Values.edc.controlplane.apikey.secret | toString | default "" | b64enc | quote }} {{- if .Values.grafana.enabled }} grafanaUser: {{ .Values.grafana.user | default "grafana" | b64enc | quote }} diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml index 9744cd5efd..c436def741 100644 --- a/charts/irs-helm/values.yaml +++ b/charts/irs-helm/values.yaml @@ -152,13 +152,16 @@ minioUser: "minio" # minioPassword: # minioUrl: "http://{{ .Release.Name }}-minio:9000" oauth2: - clientId: # - clientSecret: # clientTokenUri: # -portal: - oauth2: - clientId: # - clientSecret: # + semantics: + clientId: # + clientSecret: # + discovery: + clientId: # + clientSecret: # + bpdm: + clientId: # + clientSecret: # edc: controlplane: endpoint: @@ -207,7 +210,7 @@ edc: cacheTTL: PT24H # Time to live for ConnectorEndpointService for fetchConnectorEndpoints method cache discovery: - oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: discovery # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client ess: edc: diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml index 67879e47ea..1655a04f7b 100644 --- a/docs/src/api/irs-api.yaml +++ b/docs/src/api/irs-api.yaml @@ -7,7 +7,7 @@ info: servers: - url: http://localhost:8080 security: - - oAuth2: [] + - api_key: [] paths: /ess/bpn/investigations: post: @@ -58,7 +58,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. tags: @@ -123,7 +123,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job with the requested jobId not found. security: - - oAuth2: [] + - api_key: [] summary: Return job with additional supplyChainImpacted information. tags: - Environmental and Social Standards @@ -202,7 +202,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." tags: @@ -292,7 +292,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Returns paginated jobs with state and execution times. tags: - Item Relationship Service @@ -343,7 +343,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}." tags: - Item Relationship Service @@ -427,7 +427,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job with the requested jobId not found. security: - - oAuth2: [] + - api_key: [] summary: Return job with optional item graph result for requested id. tags: - Item Relationship Service @@ -492,7 +492,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job for requested jobId not found. security: - - oAuth2: [] + - api_key: [] summary: Cancel job for requested jobId. tags: - Item Relationship Service @@ -529,7 +529,7 @@ paths: $ref: "#/components/schemas/ErrorResponse" description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Get all available aspect models from semantic hub or local models. tags: - Aspect Models @@ -582,7 +582,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: "Registers an IRS order with an array of {globalAssetIds}.\ \ Each globalAssetId will be processed in an IRS Job, grouped in batches." tags: @@ -649,7 +649,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch Order with the requested orderId not found. security: - - oAuth2: [] + - api_key: [] summary: Get a batch order for a given orderId. tags: - Item Relationship Service @@ -714,7 +714,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch Order with the requested orderId not found. security: - - oAuth2: [] + - api_key: [] summary: Cancel a batch order for a given orderId. tags: - Item Relationship Service @@ -790,7 +790,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch with the requested orderId and batchId not found. security: - - oAuth2: [] + - api_key: [] summary: Get a batch with a given batchId for a given orderId. tags: - Item Relationship Service @@ -826,7 +826,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Lists the registered policies that should be accepted in EDC negotiation. tags: - Item Relationship Service @@ -870,7 +870,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Register a policy that should be accepted in EDC negotiation. tags: - Item Relationship Service @@ -915,7 +915,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Removes a policy that should no longer be accepted in EDC negotiation. tags: - Item Relationship Service @@ -965,7 +965,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - oAuth2: [] + - api_key: [] summary: Updates an existing policy with new validUntil value. tags: - Item Relationship Service @@ -2639,10 +2639,8 @@ components: required: - validUntil securitySchemes: - oAuth2: - flows: - clientCredentials: - scopes: - {} - tokenUrl: https://localhost - type: oauth2 + api_key: + description: Api Key access + in: header + name: X-API-KEY + type: apiKey diff --git a/docs/src/docs/administration/configuration.adoc b/docs/src/docs/administration/configuration.adoc index 5c4bbc6241..d3430cc7b9 100644 --- a/docs/src/docs/administration/configuration.adoc +++ b/docs/src/docs/administration/configuration.adoc @@ -156,11 +156,23 @@ This is a list of all secrets used in the deployment. WARNING: Keep the values for these settings safe and do not publish them! -=== -Client ID for OAuth2 provider. Request this from your OAuth2 operator. +=== +Semantic Hub client ID for OAuth2 provider. Request this from your OAuth2 operator. -=== -Client secret for OAuth2 provider. Request this from your OAuth2 operator. +=== +Semantic Hub client secret for OAuth2 provider. Request this from your OAuth2 operator. + +=== +Dataspace Discovery client ID for OAuth2 provider. Request this from your OAuth2 operator. + +=== +Dataspace Discovery client secret for OAuth2 provider. Request this from your OAuth2 operator. + +=== +BPDM client ID for OAuth2 provider. Request this from your OAuth2 operator. + +=== +BPDM client secret for OAuth2 provider. Request this from your OAuth2 operator. === Login username for Minio. To be defined by you. diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java index 837d9d9810..991ab57564 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java @@ -26,16 +26,12 @@ import io.swagger.v3.oas.models.Components; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Info; -import io.swagger.v3.oas.models.security.OAuthFlow; -import io.swagger.v3.oas.models.security.OAuthFlows; -import io.swagger.v3.oas.models.security.Scopes; import io.swagger.v3.oas.models.security.SecurityRequirement; import io.swagger.v3.oas.models.security.SecurityScheme; import io.swagger.v3.oas.models.servers.Server; import lombok.RequiredArgsConstructor; import org.eclipse.tractusx.irs.IrsApplication; import org.springdoc.core.customizers.OpenApiCustomizer; -import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -59,7 +55,7 @@ public class OpenApiConfiguration { @Bean public OpenAPI customOpenAPI() { return new OpenAPI().addServersItem(new Server().url(irsConfiguration.getApiUrl().toString())) - .addSecurityItem(new SecurityRequirement().addList("oAuth2")) + .addSecurityItem(new SecurityRequirement().addList("api_key")) .info(new Info().title("IRS API") .version(IrsApplication.API_VERSION) .description( @@ -69,20 +65,19 @@ public OpenAPI customOpenAPI() { /** * Generates example values in Swagger * - * @param tokenUri the OAuth2 token uri loaded from application.yaml * @return the customizer */ @Bean - public OpenApiCustomizer customizer( - @Value("${spring.security.oauth2.client.provider.common.token-uri}") final String tokenUri) { + public OpenApiCustomizer customizer() { return openApi -> { final Components components = openApi.getComponents(); - components.addSecuritySchemes("oAuth2", new SecurityScheme().type(SecurityScheme.Type.OAUTH2) - .flows(new OAuthFlows().clientCredentials( - new OAuthFlow().scopes( - new Scopes()) - .tokenUrl(tokenUri)))); + components.addSecuritySchemes("api_key", new SecurityScheme().type(SecurityScheme.Type.APIKEY) + .description("Api Key access") + .in(SecurityScheme.In.HEADER) + .name("X-API-KEY") + ); openApi.getComponents().getSchemas().values().forEach(s -> s.setAdditionalProperties(false)); + new OpenApiExamples().createExamples(components); }; } diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java index cfb85c6231..c8ff5c60f2 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java @@ -81,7 +81,7 @@ public class BatchController { @Operation(operationId = "registerOrder", summary = "Registers an IRS order with an array of {globalAssetIds}. " + "Each globalAssetId will be processed in an IRS Job, grouped in batches.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, description = "Registers an IRS order with an array of {globalAssetIds}. " + "Each globalAssetId will be processed in an IRS Job, grouped in batches.") @ApiResponses( @@ -121,7 +121,7 @@ public BatchOrderCreated registerBatchOrder(final @Valid @RequestBody RegisterBa @Operation(operationId = "registerESSInvestigationOrder", summary = "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Environmental and Social Standards" }, + security = @SecurityRequirement(name = "api_key"), tags = { "Environmental and Social Standards" }, description = "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.") @ApiResponses( value = { @ApiResponse(responseCode = "201", description = "Returns orderId of registered Batch order.", @@ -160,7 +160,7 @@ public BatchOrderCreated registerESSInvestigationOrder( } @Operation(description = "Get a batch order for a given orderId.", operationId = "getBatchOrder", - summary = "Get a batch order for a given orderId.", security = @SecurityRequirement(name = "oAuth2"), + summary = "Get a batch order for a given orderId.", security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Get a batch order for a given orderId.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, schema = @Schema( @@ -206,7 +206,7 @@ public BatchOrderResponse getBatchOrder( @Operation(description = "Get a batch with a given batchId for a given orderId.", operationId = "getBatch", summary = "Get a batch with a given batchId for a given orderId.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Get a batch with a given batchId for a given orderId.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -255,7 +255,7 @@ public BatchResponse getBatch( } @Operation(description = "Cancel a batch order for a given orderId.", operationId = "cancelBatchOrder", - summary = "Cancel a batch order for a given orderId.", security = @SecurityRequirement(name = "oAuth2"), + summary = "Cancel a batch order for a given orderId.", security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) @ApiResponses( value = { @ApiResponse(responseCode = "200", description = "Cancel a batch order for a given orderId.", diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java index 60166e2c87..a8a23c11c4 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java @@ -93,7 +93,7 @@ public class IrsController { @Operation(operationId = "registerJobForGlobalAssetId", summary = "Register an IRS job to retrieve an item graph for given {globalAssetId}.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, description = "Register an IRS job to retrieve an item graph for given {globalAssetId}.") @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns id of registered job.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -131,7 +131,7 @@ public JobHandle registerJobForGlobalAssetId(final @Valid @RequestBody RegisterJ @Operation(description = "Return job with optional item graph result for requested id.", operationId = "getJobForJobId", summary = "Return job with optional item graph result for requested id.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Return job with item graph for the requested id.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -190,7 +190,7 @@ public ResponseEntity getJobById( } @Operation(description = "Cancel job for requested jobId.", operationId = "cancelJobByJobId", - summary = "Cancel job for requested jobId.", security = @SecurityRequirement(name = "oAuth2"), + summary = "Cancel job for requested jobId.", security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Job with requested jobId canceled.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -236,7 +236,7 @@ public Job cancelJobByJobId( @Operation(description = "Returns paginated jobs with state and execution times.", operationId = "getJobsByJobStates", summary = "Returns paginated jobs with state and execution times.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Paginated list of jobs with state and execution times for requested job states.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -280,7 +280,7 @@ public PageResult getJobsByState( @Operation(operationId = "getAllAspectModels", summary = "Get all available aspect models from semantic hub or local models.", - security = @SecurityRequirement(name = "oAuth2"), tags = { "Aspect Models" }, + security = @SecurityRequirement(name = "api_key"), tags = { "Aspect Models" }, description = "Get all available aspect models from semantic hub or local models.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Returns all available aspect models.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java index 9414172ec8..ca6720b605 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java @@ -75,7 +75,7 @@ class EssController { @Operation(operationId = "registerBPNInvestigation", summary = "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.", - security = @SecurityRequirement(name = "oAuth2"), + security = @SecurityRequirement(name = "api_key"), tags = { "Environmental and Social Standards" }, description = "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.") @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns id of registered job.", @@ -114,7 +114,7 @@ public JobHandle registerBPNInvestigation(final @Valid @RequestBody RegisterBpnI @Operation(description = "Return job with additional supplyChainImpacted information.", operationId = "getBPNInvestigation", summary = "Return job with additional supplyChainImpacted information.", - security = @SecurityRequirement(name = "oAuth2"), + security = @SecurityRequirement(name = "api_key"), tags = { "Environmental and Social Standards" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Return job with item graph for the requested id.", diff --git a/irs-api/src/main/resources/application.yml b/irs-api/src/main/resources/application.yml index ecf233bb2b..52df8d461c 100644 --- a/irs-api/src/main/resources/application.yml +++ b/irs-api/src/main/resources/application.yml @@ -9,20 +9,25 @@ spring: oauth2: client: registration: - common: + semantics : authorization-grant-type: client_credentials - client-id: ${OAUTH2_CLIENT_ID} # OAuth2 client ID used to authenticate with the IAM - client-secret: ${OAUTH2_CLIENT_SECRET} # OAuth2 client secret used to authenticate with the IAM - portal: + client-id: ${SEMANTICS_OAUTH2_CLIENT_ID} # Semantic Hub OAuth2 client ID used to authenticate with the IAM + client-secret: ${SEMANTICS_OAUTH2_CLIENT_SECRET} # Semantic Hub OAuth2 client secret used to authenticate with the IAM + discovery: authorization-grant-type: client_credentials - client-id: ${PORTAL_OAUTH2_CLIENT_ID} # OAuth2 client ID used to authenticate with the IAM - client-secret: ${PORTAL_OAUTH2_CLIENT_SECRET} # OAuth2 client secret used to authenticate with the IAM + client-id: ${DISCOVERY_OAUTH2_CLIENT_ID} # Dataspace Discovery OAuth2 client ID used to authenticate with the IAM + client-secret: ${DISCOVERY_OAUTH2_CLIENT_SECRET} # Dataspace Discovery OAuth2 client secret used to authenticate with the IAM + bpdm: + authorization-grant-type: client_credentials + client-id: ${BPDM_OAUTH2_CLIENT_ID} # BPDM Pool OAuth2 client ID used to authenticate with the IAM + client-secret: ${BPDM_OAUTH2_CLIENT_SECRET} # BPDM Pool OAuth2 client secret used to authenticate with the IAM provider: - common: - token-uri: ${OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials - portal: - token-uri: ${PORTAL_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials - + semantics: + token-uri: ${SEMANTICS_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials + discovery: + token-uri: ${DISCOVERY_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials + bpdm: + token-uri: ${BPDM_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials management: # Spring management API config, see https://spring.io/guides/gs/centralized-configuration/ endpoints: @@ -211,7 +216,7 @@ semanticshub: # │ │ │ │ │ │ scheduler: 0 0 23 * * * # How often to clear the semantic model cache defaultUrns: "${SEMANTICSHUB_DEFAULT_URNS:urn:bamm:io.catenax.serial_part:1.0.0#SerialPart}" # IDs of models to cache at IRS startup - oAuthClientId: common # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: semantics # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client timeout: read: PT90S # HTTP read timeout for the semantic hub client connect: PT90S # HTTP connect timeout for the semantic hub client @@ -219,7 +224,7 @@ semanticshub: bpdm: bpnEndpoint: "${BPDM_URL:}" # Endpoint to resolve BPNs, must contain the placeholders {partnerId} and {idType} - oAuthClientId: common # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: bpdm # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client timeout: read: PT90S # HTTP read timeout for the bpdm client connect: PT90S # HTTP connect timeout for the bpdm client @@ -234,7 +239,7 @@ ess: irs: url: "${IRS_URL:}" # IRS Url to connect with discovery: - oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: discovery # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client timeout: read: PT90S # HTTP read timeout for the discovery client connect: PT90S # HTTP connect timeout for the discovery client diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java index 2c18570427..9365e0f13a 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java @@ -74,7 +74,7 @@ public class PolicyStoreController { @Operation(operationId = "registerAllowedPolicy", summary = "Register a policy that should be accepted in EDC negotiation.", - security = @SecurityRequirement(name = "oAuth2"), + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, description = "Register a policy that should be accepted in EDC negotiation.") @ApiResponses(value = { @ApiResponse(responseCode = "201"), @@ -106,7 +106,7 @@ public void registerAllowedPolicy(final @Valid @RequestBody CreatePolicyRequest @Operation(operationId = "getAllowedPolicies", summary = "Lists the registered policies that should be accepted in EDC negotiation.", - security = @SecurityRequirement(name = "oAuth2"), + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, description = "Lists the registered policies that should be accepted in EDC negotiation.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Returns the policies.", @@ -135,7 +135,7 @@ public List getPolicies() { @Operation(operationId = "deleteAllowedPolicy", summary = "Removes a policy that should no longer be accepted in EDC negotiation.", - security = @SecurityRequirement(name = "oAuth2"), + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, description = "Removes a policy that should no longer be accepted in EDC negotiation.") @ApiResponses(value = { @ApiResponse(responseCode = "200"), @@ -166,7 +166,7 @@ public void deleteAllowedPolicy(@PathVariable("policyId") final String policyId) } @Operation(operationId = "updateAllowedPolicy", summary = "Updates an existing policy with new validUntil value.", - security = @SecurityRequirement(name = "oAuth2"), + security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, description = "Updates an existing policy with new validUntil value.") @ApiResponses(value = { @ApiResponse(responseCode = "200"), From a262bab710042e99648829b8ab503ba96a0694a9 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 29 Jan 2024 09:57:18 +0100 Subject: [PATCH 058/116] feat(irs-testing):[#344] Fix code smells --- .../DiscoveryServiceWiremockConfig.java | 11 +++++--- .../testing/wiremock/DtrWiremockConfig.java | 16 +++++++----- .../SubmodelFacadeWiremockConfig.java | 26 ++++++++++--------- 3 files changed, 31 insertions(+), 22 deletions(-) diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java index db505bf240..6377a0d3d2 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java @@ -37,6 +37,9 @@ public final class DiscoveryServiceWiremockConfig { public static final String DISCOVERY_HOST = "http://discovery.finder"; public static final String EDC_DISCOVERY_URL = DISCOVERY_HOST + EDC_DISCOVERY_PATH; public static final String DISCOVERY_FINDER_URL = DISCOVERY_HOST + DISCOVERY_FINDER_PATH; + public static final int STATUS_CODE_OK = 200; + public static final int STATUS_CODE_NOT_FOUND = 404; + private DiscoveryServiceWiremockConfig() { } @@ -46,7 +49,7 @@ public static MappingBuilder postEdcDiscovery200() { public static MappingBuilder postEdcDiscovery200(final String bpn, final List edcUrls) { return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn( - responseWithStatus(200).withBody(edcDiscoveryResponse(bpn, edcUrls))); + responseWithStatus(STATUS_CODE_OK).withBody(edcDiscoveryResponse(bpn, edcUrls))); } public static String edcDiscoveryResponse(final String bpn, final List connectorEndpoints) { @@ -64,7 +67,7 @@ public static String edcDiscoveryResponse(final String bpn, final List c public static MappingBuilder postDiscoveryFinder200() { return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn( - responseWithStatus(200).withBody(discoveryFinderResponse(EDC_DISCOVERY_URL))); + responseWithStatus(STATUS_CODE_OK).withBody(discoveryFinderResponse(EDC_DISCOVERY_URL))); } public static String discoveryFinderResponse(final String discoveryFinderUrl) { @@ -84,10 +87,10 @@ public static String discoveryFinderResponse(final String discoveryFinderUrl) { } public static MappingBuilder postDiscoveryFinder404() { - return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn(responseWithStatus(404)); + return post(urlPathEqualTo(DISCOVERY_FINDER_PATH)).willReturn(responseWithStatus(STATUS_CODE_NOT_FOUND)); } public static MappingBuilder postEdcDiscovery404() { - return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn(responseWithStatus(404)); + return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn(responseWithStatus(STATUS_CODE_NOT_FOUND)); } } diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java index a4f743d578..692c4dd798 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java @@ -40,6 +40,8 @@ public final class DtrWiremockConfig { public static final String LOOKUP_SHELLS_PATH = "/lookup/shells"; public static final String PUBLIC_LOOKUP_SHELLS_PATH = DATAPLANE_PUBLIC_PATH + LOOKUP_SHELLS_PATH; public static final String LOOKUP_SHELLS_TEMPLATE = LOOKUP_SHELLS_PATH + "?assetIds={assetIds}"; + public static final int STATUS_CODE_OK = 200; + public static final int STATUS_CODE_NOT_FOUND = 404; private DtrWiremockConfig() { } @@ -66,7 +68,7 @@ public static MappingBuilder getShellDescriptor200(final String urlRegex) { final List submodelDescriptors = List.of(batch, singleLevelBomAsBuilt, materialForRecycling); final List specificAssetIds = List.of(specificAssetId("manufacturerId", "BPNL00000003B0Q0"), specificAssetId("batchId", "BID12345678")); - return get(urlPathMatching(urlRegex)).willReturn(responseWithStatus(200).withBody( + return get(urlPathMatching(urlRegex)).willReturn(responseWithStatus(STATUS_CODE_OK).withBody( assetAdministrationShellResponse(submodelDescriptors, "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", "EngineeringPlastics", "urn:uuid:9ce43b21-75e3-4cea-b13e-9a34f4f6822a", specificAssetIds))); } @@ -111,6 +113,7 @@ public static String specificAssetId(final String key, final String value) { """.formatted(key, value); } + @SuppressWarnings("PMD.UseObjectForClearerAPI") // used only for testing public static String submodelDescriptor(final String dataplaneUrl, final String assetId, final String dspEndpoint, final String idShort, final String submodelDescriptorId, final String semanticId) { final String href = dataplaneUrl + "/" + submodelDescriptorId; @@ -161,13 +164,13 @@ public static MappingBuilder getLookupShells200() { } public static MappingBuilder getLookupShells200(final String lookupShellsPath) { - return get(urlPathEqualTo(lookupShellsPath)).willReturn(responseWithStatus(200).withBody( + return get(urlPathEqualTo(lookupShellsPath)).willReturn(responseWithStatus(STATUS_CODE_OK).withBody( lookupShellsResponse(List.of("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf")))); } public static MappingBuilder getLookupShells200Empty() { return get(urlPathMatching(LOOKUP_SHELLS_PATH + ".*")).willReturn( - responseWithStatus(200).withBody(lookupShellsResponse(List.of()))); + responseWithStatus(STATUS_CODE_OK).withBody(lookupShellsResponse(List.of()))); } public static String lookupShellsResponse(final List shellIds) { @@ -182,10 +185,11 @@ public static String lookupShellsResponse(final List shellIds) { } public static MappingBuilder getLookupShells404() { - return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(404)); + return get(urlPathEqualTo(LOOKUP_SHELLS_PATH)).willReturn(responseWithStatus(STATUS_CODE_NOT_FOUND)); } public static MappingBuilder getShellDescriptor404() { - return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn(responseWithStatus(404)); + return get(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*")).willReturn( + responseWithStatus(STATUS_CODE_NOT_FOUND)); } -} \ No newline at end of file +} diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java index 6c3453b6f5..9ef6e5862d 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java @@ -47,6 +47,7 @@ public final class SubmodelFacadeWiremockConfig { public static final String EDC_PROVIDER_DUMMY_URL = "https://edc.io/api/v1/dsp"; public static final String IRS_INTERNAL_CALLBACK_URL = "https://irs.test/internal/endpoint-data-reference"; public static final String EDC_PROVIDER_BPN = "BPNL00000003CRHK"; + public static final int STATUS_CODE_OK = 200; private SubmodelFacadeWiremockConfig() { } @@ -57,35 +58,37 @@ public static String prepareNegotiation() { "5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7"); } + @SuppressWarnings("PMD.UseObjectForClearerAPI") // used only for testing public static String prepareNegotiation(final String negotiationId, final String transferProcessId, final String contractAgreementId, final String edcAssetId) { - stubFor(post(urlPathEqualTo(PATH_CATALOG)).willReturn(WireMockConfig.responseWithStatus(200) + stubFor(post(urlPathEqualTo(PATH_CATALOG)).willReturn(WireMockConfig.responseWithStatus(STATUS_CODE_OK) .withBody(getCatalogResponse(edcAssetId, "USE", EDC_PROVIDER_BPN)))); stubFor(post(urlPathEqualTo(PATH_NEGOTIATE)).willReturn( - WireMockConfig.responseWithStatus(200).withBody(startNegotiationResponse(negotiationId)))); + WireMockConfig.responseWithStatus(STATUS_CODE_OK).withBody(startNegotiationResponse(negotiationId)))); final String negotiationState = "FINALIZED"; stubFor(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId)).willReturn( - WireMockConfig.responseWithStatus(200) + WireMockConfig.responseWithStatus(STATUS_CODE_OK) .withBody(getNegotiationConfirmedResponse(negotiationId, negotiationState, contractAgreementId)))); stubFor(get(urlPathEqualTo(PATH_NEGOTIATE + "/" + negotiationId + PATH_STATE)).willReturn( - WireMockConfig.responseWithStatus(200).withBody(getNegotiationStateResponse(negotiationState)))); + WireMockConfig.responseWithStatus(STATUS_CODE_OK) + .withBody(getNegotiationStateResponse(negotiationState)))); - stubFor(post(urlPathEqualTo(PATH_TRANSFER)).willReturn( - WireMockConfig.responseWithStatus(200).withBody(startTransferProcessResponse(transferProcessId)) + stubFor(post(urlPathEqualTo(PATH_TRANSFER)).willReturn(WireMockConfig.responseWithStatus(STATUS_CODE_OK) + .withBody(startTransferProcessResponse( + transferProcessId)) )); final String transferProcessState = "COMPLETED"; stubFor(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId + PATH_STATE)).willReturn( - WireMockConfig.responseWithStatus(200).withBody(getTransferProcessStateResponse(transferProcessState)) - - )); + WireMockConfig.responseWithStatus(STATUS_CODE_OK) + .withBody(getTransferProcessStateResponse(transferProcessState)))); stubFor(get(urlPathEqualTo(PATH_TRANSFER + "/" + transferProcessId)).willReturn( - WireMockConfig.responseWithStatus(200) + WireMockConfig.responseWithStatus(STATUS_CODE_OK) .withBody( getTransferConfirmedResponse(transferProcessId, transferProcessState, edcAssetId, contractAgreementId)))); @@ -238,5 +241,4 @@ private static String createAtomicConstraint(final String leftOperand, final Str "odrl:rightOperand": "%s" }""".formatted(leftOperand, rightOperand); } - -} \ No newline at end of file +} From b557774f7254a6532fb133a1aacbe14aa0c70551 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 29 Jan 2024 15:27:14 +0100 Subject: [PATCH 059/116] feat(irs-api):[#344] Fix test execution and added test cases --- ...T.java => IrsWireMockIntegrationTest.java} | 125 ++++++++++++++---- .../DiscoveryServiceWiremockConfig.java | 4 + 2 files changed, 100 insertions(+), 29 deletions(-) rename irs-api/src/test/java/org/eclipse/tractusx/irs/{IrsWireMockIT.java => IrsWireMockIntegrationTest.java} (79%) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java similarity index 79% rename from irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java rename to irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java index 7de5396ebe..709da794ef 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIT.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java @@ -26,7 +26,6 @@ import static com.github.tomakehurst.wiremock.client.WireMock.containing; import static com.github.tomakehurst.wiremock.client.WireMock.get; import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; -import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; @@ -42,7 +41,9 @@ import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder404; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscoveryEmpty200; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_LOOKUP_SHELLS_PATH; @@ -86,6 +87,7 @@ import org.springframework.boot.test.context.SpringBootTest; import org.springframework.context.ApplicationContextInitializer; import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.ActiveProfiles; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.DynamicPropertyRegistry; @@ -96,9 +98,10 @@ @WireMockTest(httpPort = 8085) @Testcontainers @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = WireMockTestConfig.class) -@ContextConfiguration(initializers = IrsWireMockIT.MinioConfigInitializer.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD) +@ContextConfiguration(initializers = IrsWireMockIntegrationTest.MinioConfigInitializer.class) @ActiveProfiles("integrationtest") -class IrsWireMockIT { +class IrsWireMockIntegrationTest { public static final String SEMANTIC_HUB_URL = "http://semantic.hub/models"; public static final String EDC_URL = "http://edc.test"; private static final String ACCESS_KEY = "accessKey"; @@ -116,8 +119,7 @@ class IrsWireMockIT { @BeforeAll static void startContainer() { minioContainer.start(); - givenThat(get(urlPathEqualTo("/models")).willReturn( - responseWithStatus(200).withBodyFile("semantichub/all-models-page-IT.json"))); + successfulSemanticModelRequest(); } @AfterAll @@ -134,6 +136,7 @@ static void configureProperties(DynamicPropertyRegistry registry) { registry.add("digitalTwinRegistry.type", () -> "decentral"); registry.add("semanticshub.url", () -> SEMANTIC_HUB_URL); registry.add("semanticshub.modelJsonSchemaEndpoint", () -> SemanticHubWireMockConfig.SEMANTIC_HUB_SCHEMA_URL); + registry.add("semanticshub.defaultUrns", () -> ""); registry.add("irs-edc-client.controlplane.endpoint.data", () -> EDC_URL); registry.add("irs-edc-client.controlplane.endpoint.catalog", () -> PATH_CATALOG); registry.add("irs-edc-client.controlplane.endpoint.contract-negotiation", () -> PATH_NEGOTIATE); @@ -146,6 +149,9 @@ static void configureProperties(DynamicPropertyRegistry registry) { @Test void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundException { + // Arrange + successfulSemanticModelRequest(); + // Act final AspectModels allAspectModels = semanticHubService.getAllAspectModels(); @@ -156,40 +162,25 @@ void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundExcep @Test void shouldStartJob() { // Arrange - final String startId = "globalAssetId"; + final String globalAssetId = "globalAssetId"; + successfulSemanticModelRequest(); successfulSemanticHubRequests(); successfulDiscovery(); successfulRegistryNegotiation(); - successfulDtrRequest(startId); + successfulDtrRequest(globalAssetId); successfulAssetNegotiation(); successfulDataRequests(); successfulBpdmRequests(); - final RegisterJob request = RegisterJob.builder() - .key(PartChainIdentificationKey.builder() - .bpn(TEST_BPN) - .globalAssetId(startId) - .build()) - .depth(1) - .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) - .collectAspects(true) - .lookupBPNs(true) - .direction(Direction.DOWNWARD) - .build(); + final RegisterJob request = jobRequest(globalAssetId, TEST_BPN); // Act final JobHandle jobHandle = irsService.registerItemJob(request); assertThat(jobHandle.getId()).isNotNull(); - Awaitility.await() - .timeout(Duration.ofSeconds(35)) - .pollInterval(Duration.ofSeconds(1)) - .until(() -> irsService.getJobForJobId(jobHandle.getId(), false) - .getJob() - .getState() - .equals(JobState.COMPLETED)); + waitForCompletion(jobHandle); Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); @@ -203,6 +194,82 @@ void shouldStartJob() { assertThat(jobForJobId.getTombstones()).isEmpty(); } + @Test + void shouldCreateTombstoneWhenDiscoveryServiceNotAvailable() { + // Arrange + successfulSemanticModelRequest(); + stubFor(postDiscoveryFinder404()); + final String globalAssetId = "globalAssetId"; + final RegisterJob request = jobRequest(globalAssetId, TEST_BPN); + + // Act + final JobHandle jobHandle = irsService.registerItemJob(request); + + // Assert + assertThat(jobHandle.getId()).isNotNull(); + waitForCompletion(jobHandle); + final Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); + + verify(1, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(0, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + + assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); + assertThat(jobForJobId.getShells()).isEmpty(); + assertThat(jobForJobId.getRelationships()).isEmpty(); + assertThat(jobForJobId.getTombstones()).hasSize(1); + } + + @Test + void shouldCreateTombstoneWhenEdcDiscoveryIsEmpty() { + // Arrange + successfulSemanticModelRequest(); + stubFor(postDiscoveryFinder200()); + stubFor(postEdcDiscoveryEmpty200()); + final String globalAssetId = "globalAssetId"; + final RegisterJob request = jobRequest(globalAssetId, TEST_BPN); + // Act + final JobHandle jobHandle = irsService.registerItemJob(request); + + // Assert + assertThat(jobHandle.getId()).isNotNull(); + waitForCompletion(jobHandle); + final Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); + + verify(1, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(1, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + + assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); + assertThat(jobForJobId.getShells()).isEmpty(); + assertThat(jobForJobId.getRelationships()).isEmpty(); + assertThat(jobForJobId.getTombstones()).hasSize(1); + } + + private static void successfulSemanticModelRequest() { + stubFor(get(urlPathEqualTo("/models")).willReturn( + responseWithStatus(200).withBodyFile("semantichub/all-models-page-IT.json"))); + } + + private static RegisterJob jobRequest(final String globalAssetId, final String bpn) { + return RegisterJob.builder() + .key(PartChainIdentificationKey.builder().bpn(bpn).globalAssetId(globalAssetId).build()) + .depth(1) + .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) + .collectAspects(true) + .lookupBPNs(true) + .direction(Direction.DOWNWARD) + .build(); + } + + private void waitForCompletion(final JobHandle jobHandle) { + Awaitility.await() + .timeout(Duration.ofSeconds(35)) + .pollInterval(Duration.ofSeconds(1)) + .until(() -> irsService.getJobForJobId(jobHandle.getId(), false) + .getJob() + .getState() + .equals(JobState.COMPLETED)); + } + private void successfulRegistryNegotiation() { final String negotiationId = "1bbaec6e-c316-4e1e-8258-c07a648cc43c"; final String transferProcessId = "1b21e963-0bc5-422a-b30d-fd3511861d88"; @@ -254,11 +321,11 @@ private static void successfulBpdmRequests() { } private static void successfulDataRequests() { - givenThat(get(urlPathMatching( - DATAPLANE_PUBLIC_PATH + "/urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf")).willReturn( + stubFor(get( + urlPathMatching(DATAPLANE_PUBLIC_PATH + "/urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf")).willReturn( responseWithStatus(200).withBodyFile("integrationtesting/batch-1.json"))); - givenThat(get(urlPathMatching( - DATAPLANE_PUBLIC_PATH + "/urn:uuid:0e413809-966b-4107-aae5-aeb28bcdaadf")).willReturn( + stubFor(get( + urlPathMatching(DATAPLANE_PUBLIC_PATH + "/urn:uuid:0e413809-966b-4107-aae5-aeb28bcdaadf")).willReturn( responseWithStatus(200).withBodyFile("integrationtesting/singleLevelBomAsBuilt-1.json"))); } diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java index 6377a0d3d2..54297357ab 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java @@ -47,6 +47,10 @@ public static MappingBuilder postEdcDiscovery200() { return postEdcDiscovery200(TEST_BPN, List.of(CONTROLPLANE_PUBLIC_URL)); } + public static MappingBuilder postEdcDiscoveryEmpty200() { + return postEdcDiscovery200(TEST_BPN, List.of()); + } + public static MappingBuilder postEdcDiscovery200(final String bpn, final List edcUrls) { return post(urlPathEqualTo(EDC_DISCOVERY_PATH)).willReturn( responseWithStatus(STATUS_CODE_OK).withBody(edcDiscoveryResponse(bpn, edcUrls))); From 9d2e29422aa4f250d90ff9e26300bb2943962ac1 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 29 Jan 2024 15:41:53 +0100 Subject: [PATCH 060/116] chore(foss):[#344] Fix license headers --- .../eclipse/tractusx/irs/IrsWireMockIntegrationTest.java | 6 +----- .../java/org/eclipse/tractusx/irs/WireMockTestConfig.java | 1 + .../org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java | 1 + .../org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java | 1 + .../irs/semanticshub/SemanticHubWireMockConfig.java | 1 + .../DecentralDigitalTwinRegistryServiceWiremockTest.java | 1 + .../testing/wiremock/DiscoveryServiceWiremockConfig.java | 1 + .../tractusx/irs/testing/wiremock/DtrWiremockConfig.java | 1 + .../irs/testing/wiremock/SubmodelFacadeWiremockConfig.java | 1 + .../tractusx/irs/testing/wiremock/WireMockConfig.java | 1 + 10 files changed, 10 insertions(+), 5 deletions(-) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java index 709da794ef..0aa067bb31 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java @@ -1,9 +1,5 @@ /******************************************************************************** - * Copyright (c) 2021,2022,2023 - * 2022: ZF Friedrichshafen AG - * 2022: ISTOS GmbH - * 2022,2023: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * 2022,2023: BOSCH AG + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java index 5cc1adcf9d..24968aee88 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java index 8a1089c5ce..45bcb93a89 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java index fc963f6163..bc375f55b2 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java index 16120c02cb..cd250f8a7c 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index 1072ea7e6d..bd512c7cde 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java index 54297357ab..585803c1b4 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java index 692c4dd798..17332ce160 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java index 9ef6e5862d..3269322ab1 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java index 21598577df..5da7750813 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/WireMockConfig.java @@ -1,4 +1,5 @@ /******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional From 60d78103ca6de599a36c29958a8002d2e64ed58a Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 29 Jan 2024 16:32:59 +0100 Subject: [PATCH 061/116] chore(foss):[#344] Update DEPENDENCIES --- DEPENDENCIES | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index cc0f92a3fe..9e90a62f07 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -325,11 +325,11 @@ maven/mavencentral/org.eclipse.jetty/jetty-xml/11.0.17, EPL-2.0 OR Apache-2.0, a maven/mavencentral/org.eclipse.jetty/jetty-xml/11.0.19, EPL-2.0 OR Apache-2.0, approved, rt.jetty maven/mavencentral/org.eclipse.tractusx.irs/irs-api/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx maven/mavencentral/org.eclipse.tractusx.irs/irs-common/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx -maven/mavencentral/org.eclipse.tractusx.irs/irs-edc-client/1.5.1-SNAPSHOT, Apache-2.0, approved, automotive.tractusx -maven/mavencentral/org.eclipse.tractusx.irs/irs-models/1.5.1-SNAPSHOT, Apache-2.0, approved, automotive.tractusx +maven/mavencentral/org.eclipse.tractusx.irs/irs-edc-client/1.5.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx +maven/mavencentral/org.eclipse.tractusx.irs/irs-models/1.5.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx maven/mavencentral/org.eclipse.tractusx.irs/irs-policy-store/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx -maven/mavencentral/org.eclipse.tractusx.irs/irs-registry-client/1.5.1-SNAPSHOT, Apache-2.0, approved, automotive.tractusx -maven/mavencentral/org.eclipse.tractusx.irs/irs-testing/1.5.1-SNAPSHOT, Apache-2.0, approved, automotive.tractusx +maven/mavencentral/org.eclipse.tractusx.irs/irs-registry-client/1.5.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx +maven/mavencentral/org.eclipse.tractusx.irs/irs-testing/1.5.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx maven/mavencentral/org.glassfish.hk2.external/aopalliance-repackaged/3.0.4, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish maven/mavencentral/org.glassfish.hk2.external/aopalliance-repackaged/3.0.5, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish maven/mavencentral/org.glassfish.hk2/hk2-api/3.0.4, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish @@ -473,7 +473,7 @@ maven/mavencentral/org.testcontainers/testcontainers/1.19.1, Apache-2.0 AND MIT, maven/mavencentral/org.typelevel/spire-macros_2.13/0.17.0, MIT, approved, clearlydefined maven/mavencentral/org.unbescape/unbescape/1.1.6.RELEASE, Apache-2.0, approved, CQ18904 maven/mavencentral/org.webjars/swagger-ui/5.2.0, Apache-2.0, approved, #10221 -maven/mavencentral/org.wiremock/wiremock-standalone/3.2.0, MIT AND Apache-2.0, approved, #10919 +maven/mavencentral/org.wiremock/wiremock-standalone/3.3.1, , restricted, clearlydefined maven/mavencentral/org.xerial.snappy/snappy-java/1.1.10.5, Apache-2.0 AND (Apache-2.0 AND BSD-3-Clause), approved, #9098 maven/mavencentral/org.xmlunit/xmlunit-core/2.9.1, Apache-2.0, approved, #6272 maven/mavencentral/org.yaml/snakeyaml/1.33, Apache-2.0, approved, clearlydefined From 91c4e88f55333ac225f6d6c3c3be6f5d9bf13d61 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 29 Jan 2024 16:33:39 +0100 Subject: [PATCH 062/116] chore(foss):[#344] Update dash license-tool-plugin --- pom.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pom.xml b/pom.xml index d91480e11c..8be9e7d052 100644 --- a/pom.xml +++ b/pom.xml @@ -121,7 +121,7 @@ 4.3.0 3.3.0 3.1.0 - 1.0.3-SNAPSHOT + 1.1.0 1.1.10.5 @@ -158,10 +158,10 @@ - dash-licenses-snapshots - https://repo.eclipse.org/content/repositories/dash-licenses-snapshots/ + dash-licenses-releases + https://repo.eclipse.org/content/repositories/dash-licenses-releases/ - true + false From 9b119bbf6023ae7c9308b3413698d2ecbf096995 Mon Sep 17 00:00:00 2001 From: ds-mkanal <100209308+mkanal@users.noreply.github.com> Date: Tue, 30 Jan 2024 13:28:46 +0100 Subject: [PATCH 063/116] Add contact section to Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 53664b07d4..a0afa14415 100644 --- a/README.md +++ b/README.md @@ -152,3 +152,10 @@ from the base distribution, along with any direct or indirect dependencies of th As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within. + +## Contact + +Contact the project developers via the project's "dev" list. + +* https://accounts.eclipse.org/mailing-list/tractusx-dev +* Eclipse Matrix Chat https://chat.eclipse.org/#/room/#tractusx-trace-x:matrix.eclipse.org From 44bed78d19ca957ff1c7a7da7ac6f58268685e21 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 30 Jan 2024 14:32:47 +0100 Subject: [PATCH 064/116] feat(irs-api):[#344] Add test case for recursive IRS flow --- .../irs/IrsWireMockIntegrationTest.java | 235 ++++++++---------- .../tractusx/irs/WireMockTestConfig.java | 127 ++++++++-- .../testing/wiremock/DtrWiremockConfig.java | 13 + .../SubmodelFacadeWiremockConfig.java | 9 +- 4 files changed, 236 insertions(+), 148 deletions(-) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java index 0aa067bb31..1b93697317 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java @@ -20,54 +20,46 @@ package org.eclipse.tractusx.irs; import static com.github.tomakehurst.wiremock.client.WireMock.containing; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.WireMockTestConfig.createEndpointDataReference; -import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.bpdmResponse; -import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.batchSchemaResponse200; -import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.singleLevelBomAsBuiltSchemaResponse200; +import static org.eclipse.tractusx.irs.WireMockTestConfig.randomUUID; +import static org.eclipse.tractusx.irs.WireMockTestConfig.successfulDataRequests; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_URL; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder404; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscoveryEmpty200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_URL; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_LOOKUP_SHELLS_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_SHELL_DESCRIPTORS_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200; import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.lookupShellsResponse; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.submodelDescriptor; import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_CATALOG; import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_NEGOTIATE; import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_STATE; import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_TRANSFER; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; -import java.nio.charset.StandardCharsets; import java.time.Duration; import java.util.List; +import java.util.Objects; import com.github.tomakehurst.wiremock.junit5.WireMockTest; -import org.apache.commons.codec.binary.Base64; import org.awaitility.Awaitility; import org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig; import org.eclipse.tractusx.irs.component.JobHandle; import org.eclipse.tractusx.irs.component.Jobs; -import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; import org.eclipse.tractusx.irs.component.RegisterJob; -import org.eclipse.tractusx.irs.component.enums.Direction; import org.eclipse.tractusx.irs.component.enums.JobState; +import org.eclipse.tractusx.irs.data.StringMapper; import org.eclipse.tractusx.irs.edc.client.EndpointDataReferenceStorage; import org.eclipse.tractusx.irs.semanticshub.AspectModels; import org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig; @@ -75,15 +67,17 @@ import org.eclipse.tractusx.irs.services.SemanticHubService; import org.eclipse.tractusx.irs.services.validation.SchemaNotFoundException; import org.eclipse.tractusx.irs.testing.containers.MinioContainer; +import org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig; import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig; import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cache.CacheManager; import org.springframework.context.ApplicationContextInitializer; import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.ActiveProfiles; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.DynamicPropertyRegistry; @@ -94,7 +88,6 @@ @WireMockTest(httpPort = 8085) @Testcontainers @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = WireMockTestConfig.class) -@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD) @ContextConfiguration(initializers = IrsWireMockIntegrationTest.MinioConfigInitializer.class) @ActiveProfiles("integrationtest") class IrsWireMockIntegrationTest { @@ -111,11 +104,19 @@ class IrsWireMockIntegrationTest { private SemanticHubService semanticHubService; @Autowired private EndpointDataReferenceStorage endpointDataReferenceStorage; + @Autowired + private CacheManager cacheManager; @BeforeAll static void startContainer() { minioContainer.start(); - successfulSemanticModelRequest(); + WireMockTestConfig.successfulSemanticModelRequest(); + } + + @AfterEach + void tearDown() { + cacheManager.getCacheNames() + .forEach(cacheName -> Objects.requireNonNull(cacheManager.getCache(cacheName)).clear()); } @AfterAll @@ -146,7 +147,7 @@ static void configureProperties(DynamicPropertyRegistry registry) { @Test void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundException { // Arrange - successfulSemanticModelRequest(); + WireMockTestConfig.successfulSemanticModelRequest(); // Act final AspectModels allAspectModels = semanticHubService.getAllAspectModels(); @@ -156,22 +157,23 @@ void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundExcep } @Test - void shouldStartJob() { + void shouldStopJobAfterDepthIsReached() { // Arrange - final String globalAssetId = "globalAssetId"; + final String globalAssetIdLevel1 = "globalAssetId"; + final String globalAssetIdLevel2 = "urn:uuid:6d505432-8b31-4966-9514-4b753372683f"; - successfulSemanticModelRequest(); - successfulSemanticHubRequests(); - successfulDiscovery(); - successfulRegistryNegotiation(); - successfulDtrRequest(globalAssetId); - successfulAssetNegotiation(); + WireMockTestConfig.successfulSemanticModelRequest(); + WireMockTestConfig.successfulSemanticHubRequests(); + WireMockTestConfig.successfulDiscovery(); - successfulDataRequests(); + successfulRegistryAndDataRequest(globalAssetIdLevel1, "Cathode", TEST_BPN, "integrationtesting/batch-1.json", + "integrationtesting/singleLevelBomAsBuilt-1.json"); + successfulRegistryAndDataRequest(globalAssetIdLevel2, "Polyamid", TEST_BPN, "integrationtesting/batch-2.json", + "integrationtesting/singleLevelBomAsBuilt-2.json"); - successfulBpdmRequests(); + WireMockTestConfig.successfulBpdmRequests(); - final RegisterJob request = jobRequest(globalAssetId, TEST_BPN); + final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetIdLevel1, TEST_BPN, 1); // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -181,8 +183,8 @@ void shouldStartJob() { Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); // Assert - verifyDiscoveryCalls(1); - verifyNegotiationCalls(3); + WireMockTestConfig.verifyDiscoveryCalls(1); + WireMockTestConfig.verifyNegotiationCalls(3); assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); assertThat(jobForJobId.getShells()).hasSize(2); @@ -193,10 +195,10 @@ void shouldStartJob() { @Test void shouldCreateTombstoneWhenDiscoveryServiceNotAvailable() { // Arrange - successfulSemanticModelRequest(); + WireMockTestConfig.successfulSemanticModelRequest(); stubFor(postDiscoveryFinder404()); final String globalAssetId = "globalAssetId"; - final RegisterJob request = jobRequest(globalAssetId, TEST_BPN); + final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetId, TEST_BPN, 1); // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -218,11 +220,12 @@ void shouldCreateTombstoneWhenDiscoveryServiceNotAvailable() { @Test void shouldCreateTombstoneWhenEdcDiscoveryIsEmpty() { // Arrange - successfulSemanticModelRequest(); + WireMockTestConfig.successfulSemanticModelRequest(); stubFor(postDiscoveryFinder200()); stubFor(postEdcDiscoveryEmpty200()); final String globalAssetId = "globalAssetId"; - final RegisterJob request = jobRequest(globalAssetId, TEST_BPN); + final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetId, TEST_BPN, 1); + // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -231,8 +234,7 @@ void shouldCreateTombstoneWhenEdcDiscoveryIsEmpty() { waitForCompletion(jobHandle); final Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); - verify(1, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); - verify(1, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + WireMockTestConfig.verifyDiscoveryCalls(1); assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); assertThat(jobForJobId.getShells()).isEmpty(); @@ -240,108 +242,91 @@ void shouldCreateTombstoneWhenEdcDiscoveryIsEmpty() { assertThat(jobForJobId.getTombstones()).hasSize(1); } - private static void successfulSemanticModelRequest() { - stubFor(get(urlPathEqualTo("/models")).willReturn( - responseWithStatus(200).withBodyFile("semantichub/all-models-page-IT.json"))); - } + @Test + void shouldStartRecursiveProcesses() { + // Arrange + final String globalAssetIdLevel1 = "urn:uuid:334cce52-1f52-4bc9-9dd1-410bbe497bbc"; + final String globalAssetIdLevel2 = "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5"; + final String globalAssetIdLevel3 = "urn:uuid:a314ad6b-77ea-417e-ae2d-193b3e249e99"; - private static RegisterJob jobRequest(final String globalAssetId, final String bpn) { - return RegisterJob.builder() - .key(PartChainIdentificationKey.builder().bpn(bpn).globalAssetId(globalAssetId).build()) - .depth(1) - .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) - .collectAspects(true) - .lookupBPNs(true) - .direction(Direction.DOWNWARD) - .build(); - } + WireMockTestConfig.successfulSemanticModelRequest(); + WireMockTestConfig.successfulSemanticHubRequests(); + WireMockTestConfig.successfulDiscovery(); - private void waitForCompletion(final JobHandle jobHandle) { - Awaitility.await() - .timeout(Duration.ofSeconds(35)) - .pollInterval(Duration.ofSeconds(1)) - .until(() -> irsService.getJobForJobId(jobHandle.getId(), false) - .getJob() - .getState() - .equals(JobState.COMPLETED)); - } + successfulRegistryAndDataRequest(globalAssetIdLevel1, "Cathode", TEST_BPN, "integrationtesting/batch-1.json", + "integrationtesting/singleLevelBomAsBuilt-1.json"); + successfulRegistryAndDataRequest(globalAssetIdLevel2, "Polyamid", TEST_BPN, "integrationtesting/batch-2.json", + "integrationtesting/singleLevelBomAsBuilt-2.json"); + successfulRegistryAndDataRequest(globalAssetIdLevel3, "GenericChemical", TEST_BPN, + "integrationtesting/batch-3.json", "integrationtesting/singleLevelBomAsBuilt-3.json"); - private void successfulRegistryNegotiation() { - final String negotiationId = "1bbaec6e-c316-4e1e-8258-c07a648cc43c"; - final String transferProcessId = "1b21e963-0bc5-422a-b30d-fd3511861d88"; - final String edcAssetId = "registry-asset"; - final String contractAgreementId = SubmodelFacadeWiremockConfig.prepareNegotiation(negotiationId, - transferProcessId, - "7681f966-36ea-4542-b5ea-0d0db81967de:registry-asset:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", edcAssetId); - endpointDataReferenceStorage.put(contractAgreementId, createEndpointDataReference(contractAgreementId)); - } + WireMockTestConfig.successfulBpdmRequests(); - private void successfulAssetNegotiation() { - final String negotiationId = "1bbaec6e-c316-4e1e-8258-c07a648cc43c"; - final String transferProcessId = "1b21e963-0bc5-422a-b30d-fd3511861d88"; - final String edcAssetId = "urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26"; - final String contractAgreementId = SubmodelFacadeWiremockConfig.prepareNegotiation(negotiationId, - transferProcessId, - "7681f966-36ea-4542-b5ea-0d0db81967de:urn:uuid:f8196d6a-1664-4531-bdee-f15dbb1daf26:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", - edcAssetId); - endpointDataReferenceStorage.put(contractAgreementId, createEndpointDataReference(contractAgreementId)); - } + final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetIdLevel1, TEST_BPN, 4); - private static void successfulDiscovery() { - stubFor(postDiscoveryFinder200()); - stubFor(postEdcDiscovery200()); - } - - private static String encodedId(final String secondDTR) { - return Base64.encodeBase64String(secondDTR.getBytes(StandardCharsets.UTF_8)); - } + // Act + final JobHandle jobHandle = irsService.registerItemJob(request); - private static void verifyDiscoveryCalls(final int times) { - verify(times, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); - verify(times, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); - } + // Assert + assertThat(jobHandle.getId()).isNotNull(); + waitForCompletion(jobHandle); + final Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), false); + System.out.println(StringMapper.mapToString(jobForJobId)); - private static void verifyNegotiationCalls(final int times) { - verify(times, postRequestedFor(urlPathEqualTo(PATH_NEGOTIATE))); - verify(times, postRequestedFor(urlPathEqualTo(PATH_CATALOG))); - verify(times * 2, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*"))); - verify(times, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*" + PATH_STATE))); - verify(times, postRequestedFor(urlPathEqualTo(PATH_TRANSFER))); - verify(times * 2, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*"))); - verify(times, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*" + PATH_STATE))); - } + assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); + assertThat(jobForJobId.getShells()).hasSize(3); + assertThat(jobForJobId.getRelationships()).hasSize(2); + assertThat(jobForJobId.getTombstones()).isEmpty(); + assertThat(jobForJobId.getSubmodels()).hasSize(6); - private static void successfulBpdmRequests() { - stubFor(get(urlPathMatching("/legal-entities/.*")).willReturn( - responseWithStatus(200).withBody(bpdmResponse(TEST_BPN, "Company Name")))); + WireMockTestConfig.verifyDiscoveryCalls(1); + WireMockTestConfig.verifyNegotiationCalls(6); } - private static void successfulDataRequests() { - stubFor(get( - urlPathMatching(DATAPLANE_PUBLIC_PATH + "/urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf")).willReturn( - responseWithStatus(200).withBodyFile("integrationtesting/batch-1.json"))); - stubFor(get( - urlPathMatching(DATAPLANE_PUBLIC_PATH + "/urn:uuid:0e413809-966b-4107-aae5-aeb28bcdaadf")).willReturn( - responseWithStatus(200).withBodyFile("integrationtesting/singleLevelBomAsBuilt-1.json"))); + private void successfulRegistryAndDataRequest(final String globalAssetId, final String idShort, final String bpn, + final String batchFileName, final String sbomFileName) { + + final String edcAssetId = WireMockTestConfig.randomUUIDwithPrefix(); + final String batchId = WireMockTestConfig.randomUUIDwithPrefix(); + final String batch = submodelDescriptor(DATAPLANE_PUBLIC_URL, edcAssetId, + DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "Batch", batchId, + "urn:samm:io.catenax.batch:2.0.0#Batch"); + successfulDataRequests(batchId, batchFileName); + + final String sbomId = WireMockTestConfig.randomUUIDwithPrefix(); + final String singleLevelBomAsBuilt = submodelDescriptor(DATAPLANE_PUBLIC_URL, edcAssetId, + DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "SingleLevelBomAsBuilt", sbomId, + "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt"); + final List submodelDescriptors = List.of(batch, singleLevelBomAsBuilt); + successfulDataRequests(sbomId, sbomFileName); + successfulNegotiation(edcAssetId); + + final String shellId = WireMockTestConfig.randomUUIDwithPrefix(); + final String registryEdcAssetId = "registry-asset"; + successfulNegotiation(registryEdcAssetId); + stubFor(getLookupShells200(PUBLIC_LOOKUP_SHELLS_PATH, List.of(shellId)).withQueryParam("assetIds", + containing(globalAssetId))); + stubFor(getShellDescriptor200(PUBLIC_SHELL_DESCRIPTORS_PATH + WireMockTestConfig.encodedId(shellId), bpn, + submodelDescriptors, globalAssetId, shellId, idShort)); } - private static void successfulSemanticHubRequests() { - stubFor(batchSchemaResponse200()); - stubFor(singleLevelBomAsBuiltSchemaResponse200()); + private void successfulNegotiation(final String edcAssetId) { + final String negotiationId = randomUUID(); + final String transferProcessId = randomUUID(); + final String contractAgreementId = "%s:%s:%s".formatted(randomUUID(), edcAssetId, randomUUID()); + SubmodelFacadeWiremockConfig.prepareNegotiation(negotiationId, transferProcessId, contractAgreementId, + edcAssetId); + endpointDataReferenceStorage.put(contractAgreementId, createEndpointDataReference(contractAgreementId)); } - private static void successfulDtrRequest(final String startId) { - stubFor(getLookupShells200(PUBLIC_LOOKUP_SHELLS_PATH).withQueryParam("assetIds", containing(startId))); - stubFor(getShellDescriptor200( - PUBLIC_SHELL_DESCRIPTORS_PATH + encodedId("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf"))); - - final String secondDTR = "urn:uuid:6d505432-8b31-4966-9514-4b753372683f"; - stubFor(get(urlPathEqualTo(PUBLIC_LOOKUP_SHELLS_PATH)).withQueryParam("assetIds", - containing("urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5")) - .willReturn(responseWithStatus(200).withBody( - lookupShellsResponse(List.of(secondDTR))))); - - stubFor(getShellDescriptor200(PUBLIC_SHELL_DESCRIPTORS_PATH + encodedId(secondDTR))); + private void waitForCompletion(final JobHandle jobHandle) { + Awaitility.await() + .timeout(Duration.ofSeconds(35)) + .pollInterval(Duration.ofSeconds(1)) + .until(() -> irsService.getJobForJobId(jobHandle.getId(), false) + .getJob() + .getState() + .equals(JobState.COMPLETED)); } public static class MinioConfigInitializer diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java index 24968aee88..2db79977e6 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java @@ -19,24 +19,49 @@ ********************************************************************************/ package org.eclipse.tractusx.irs; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.bpdmResponse; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.BPDM_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.DISCOVERY_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.DTR_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.EDC_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.NO_ERROR_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.SEMHUB_REST_TEMPLATE; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.batchSchemaResponse200; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.singleLevelBomAsBuiltSchemaResponse200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_PATH; import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.DATAPLANE_HOST; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_CATALOG; import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_DATAPLANE_PUBLIC; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_NEGOTIATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_STATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_TRANSFER; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import java.nio.charset.StandardCharsets; import java.util.Base64; import java.util.List; import java.util.Map; +import java.util.UUID; import com.fasterxml.jackson.databind.ObjectMapper; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; +import org.eclipse.tractusx.irs.component.RegisterJob; +import org.eclipse.tractusx.irs.component.enums.Direction; import org.eclipse.tractusx.irs.data.StringMapper; import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; @@ -54,25 +79,6 @@ public class WireMockTestConfig { public static final int HTTP_PORT = 8085; private static final String PROXY_SERVER_HOST = "127.0.0.1"; - public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { - final EDRAuthCode edrAuthCode = EDRAuthCode.builder() - .cid(contractAgreementId) - .dad("test") - .exp(9999999999L) - .build(); - final String b64EncodedAuthCode = Base64.getUrlEncoder() - .encodeToString(StringMapper.mapToString(edrAuthCode) - .getBytes(StandardCharsets.UTF_8)); - final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; - return EndpointDataReference.Builder.newInstance() - .authKey("testkey") - .authCode(jwtToken) - .properties( - Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) - .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) - .build(); - } - @Primary @Profile("integrationtest") @Bean(DTR_REST_TEMPLATE) @@ -124,4 +130,87 @@ RestTemplate bpdmRestTemplate() { RestTemplate semanticHubRestTemplate() { return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); } + + public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + return EndpointDataReference.Builder.newInstance() + .authKey("testkey") + .authCode(jwtToken) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) + .build(); + } + + static void successfulSemanticModelRequest() { + stubFor(get(urlPathEqualTo("/models")).willReturn( + responseWithStatus(200).withBodyFile("semantichub/all-models-page-IT.json"))); + } + + static RegisterJob jobRequest(final String globalAssetId, final String bpn, final int depth) { + return RegisterJob.builder() + .key(PartChainIdentificationKey.builder().bpn(bpn).globalAssetId(globalAssetId).build()) + .depth(depth) + .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) + .collectAspects(true) + .lookupBPNs(true) + .direction(Direction.DOWNWARD) + .build(); + } + + static void successfulDiscovery() { + stubFor(postDiscoveryFinder200()); + stubFor(postEdcDiscovery200()); + } + + static String encodedId(final String shellId) { + return org.apache.commons.codec.binary.Base64.encodeBase64String(shellId.getBytes(StandardCharsets.UTF_8)); + } + + static void verifyDiscoveryCalls(final int times) { + verify(times, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); + verify(times, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); + } + + static void verifyNegotiationCalls(final int times) { + verify(times, postRequestedFor(urlPathEqualTo(PATH_NEGOTIATE))); + verify(times, postRequestedFor(urlPathEqualTo(PATH_CATALOG))); + verify(times * 2, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*"))); + verify(times, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*" + PATH_STATE))); + verify(times, postRequestedFor(urlPathEqualTo(PATH_TRANSFER))); + verify(times * 2, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*"))); + verify(times, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*" + PATH_STATE))); + } + + static void successfulBpdmRequests() { + stubFor(get(urlPathMatching("/legal-entities/.*")).willReturn( + responseWithStatus(200).withBody(bpdmResponse(TEST_BPN, "Company Name")))); + } + + static void successfulDataRequests(final String assetId, final String fileName) { + stubFor(get(urlPathMatching(DATAPLANE_PUBLIC_PATH + "/" + assetId)).willReturn( + responseWithStatus(200).withBodyFile(fileName))); + } + + static void successfulSemanticHubRequests() { + stubFor(batchSchemaResponse200()); + stubFor(singleLevelBomAsBuiltSchemaResponse200()); + } + + static String randomUUIDwithPrefix() { + final String uuidPrefix = "urn:uuid:"; + return uuidPrefix + randomUUID(); + } + + static String randomUUID() { + return UUID.randomUUID().toString(); + } } diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java index 17332ce160..30367044e2 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java @@ -74,6 +74,14 @@ public static MappingBuilder getShellDescriptor200(final String urlRegex) { "EngineeringPlastics", "urn:uuid:9ce43b21-75e3-4cea-b13e-9a34f4f6822a", specificAssetIds))); } + @SuppressWarnings("PMD.UseObjectForClearerAPI") // used only for testing + public static MappingBuilder getShellDescriptor200(final String urlRegex, final String bpn, final List submodelDescriptors, + final String globalAssetId, final String shellId, final String idShort) { + final List specificAssetIds = List.of(specificAssetId("manufacturerId", bpn)); + return get(urlPathMatching(urlRegex)).willReturn(responseWithStatus(STATUS_CODE_OK).withBody( + assetAdministrationShellResponse(submodelDescriptors, globalAssetId, idShort, shellId, specificAssetIds))); + } + public static String assetAdministrationShellResponse(final List submodelDescriptors, final String globalAssetId, final String idShort, final String shellId, final List specificAssetIds) { @@ -169,6 +177,11 @@ public static MappingBuilder getLookupShells200(final String lookupShellsPath) { lookupShellsResponse(List.of("urn:uuid:21f7ebea-fa8a-410c-a656-bd9082e67dcf")))); } + public static MappingBuilder getLookupShells200(final String lookupShellsPath, final List shellIds) { + return get(urlPathEqualTo(lookupShellsPath)).willReturn(responseWithStatus(STATUS_CODE_OK).withBody( + lookupShellsResponse(shellIds))); + } + public static MappingBuilder getLookupShells200Empty() { return get(urlPathMatching(LOOKUP_SHELLS_PATH + ".*")).willReturn( responseWithStatus(STATUS_CODE_OK).withBody(lookupShellsResponse(List.of()))); diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java index 3269322ab1..361423cf05 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java @@ -54,13 +54,15 @@ private SubmodelFacadeWiremockConfig() { } public static String prepareNegotiation() { - return prepareNegotiation("1bbaec6e-c316-4e1e-8258-c07a648cc43c", "1b21e963-0bc5-422a-b30d-fd3511861d88", - "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:a6144a2e-c1b1-4ec6-96e1-a221da134e4f", + final String contractAgreementId = "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:a6144a2e-c1b1-4ec6-96e1-a221da134e4f"; + prepareNegotiation("1bbaec6e-c316-4e1e-8258-c07a648cc43c", "1b21e963-0bc5-422a-b30d-fd3511861d88", + contractAgreementId, "5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7"); + return contractAgreementId; } @SuppressWarnings("PMD.UseObjectForClearerAPI") // used only for testing - public static String prepareNegotiation(final String negotiationId, final String transferProcessId, + public static void prepareNegotiation(final String negotiationId, final String transferProcessId, final String contractAgreementId, final String edcAssetId) { stubFor(post(urlPathEqualTo(PATH_CATALOG)).willReturn(WireMockConfig.responseWithStatus(STATUS_CODE_OK) .withBody(getCatalogResponse(edcAssetId, @@ -93,7 +95,6 @@ public static String prepareNegotiation(final String negotiationId, final String .withBody( getTransferConfirmedResponse(transferProcessId, transferProcessState, edcAssetId, contractAgreementId)))); - return contractAgreementId; } private static String startTransferProcessResponse(final String transferProcessId) { From 607faa0bb3ae437f5a1f6584831d49388b293f32 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 30 Jan 2024 14:33:39 +0100 Subject: [PATCH 065/116] chore(docs):[#344] Add changes to CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 458cdcad76..acf6f5d589 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Added helper script for building documentation locally. +- Added Integration Tests for the entire IRS flow using stubbed responses of Discovery Service, Semantic Hub, EDC, Digital Twin Registry and BPDM Pool ### Changed - Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" From c455751fec4ee4a1af09010d0b89d5f4cd526633 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 30 Jan 2024 14:33:55 +0100 Subject: [PATCH 066/116] chore(foss):[#344] Update DEPENDENCIES --- DEPENDENCIES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index 9e90a62f07..4e8646dda6 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -473,7 +473,7 @@ maven/mavencentral/org.testcontainers/testcontainers/1.19.1, Apache-2.0 AND MIT, maven/mavencentral/org.typelevel/spire-macros_2.13/0.17.0, MIT, approved, clearlydefined maven/mavencentral/org.unbescape/unbescape/1.1.6.RELEASE, Apache-2.0, approved, CQ18904 maven/mavencentral/org.webjars/swagger-ui/5.2.0, Apache-2.0, approved, #10221 -maven/mavencentral/org.wiremock/wiremock-standalone/3.3.1, , restricted, clearlydefined +maven/mavencentral/org.wiremock/wiremock-standalone/3.3.1, MIT AND Apache-2.0, approved, #12941 maven/mavencentral/org.xerial.snappy/snappy-java/1.1.10.5, Apache-2.0 AND (Apache-2.0 AND BSD-3-Clause), approved, #9098 maven/mavencentral/org.xmlunit/xmlunit-core/2.9.1, Apache-2.0, approved, #6272 maven/mavencentral/org.yaml/snakeyaml/1.33, Apache-2.0, approved, clearlydefined From 2964eecd8e88d0d65a6b4eec751818cb610815c2 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 30 Jan 2024 14:34:25 +0100 Subject: [PATCH 067/116] feat(irs-api):[#344] Delete unused files --- .../__files/edc/responseCatalog.json | 119 ------------------ .../edc/responseGetNegotiationConfirmed.json | 11 -- .../__files/edc/responseStartNegotiation.json | 3 - .../edc/responseStartTransferprocess.json | 3 - 4 files changed, 136 deletions(-) delete mode 100644 irs-api/src/test/resources/__files/edc/responseCatalog.json delete mode 100644 irs-api/src/test/resources/__files/edc/responseGetNegotiationConfirmed.json delete mode 100644 irs-api/src/test/resources/__files/edc/responseStartNegotiation.json delete mode 100644 irs-api/src/test/resources/__files/edc/responseStartTransferprocess.json diff --git a/irs-api/src/test/resources/__files/edc/responseCatalog.json b/irs-api/src/test/resources/__files/edc/responseCatalog.json deleted file mode 100644 index e6ba0d04c1..0000000000 --- a/irs-api/src/test/resources/__files/edc/responseCatalog.json +++ /dev/null @@ -1,119 +0,0 @@ -{ - "id": "default", - "contractOffers": [ - { - "id": "3:afb3dca6-e7cc-42b6-98bb-c6f948121c7a", - "policy": { - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "uid": null, - "target": "urn:uuid:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-urn:uuid:31b614f5-ec14-4ed2-a509-e7b7780083e7", - "action": { - "type": "USE", - "includedIn": null, - "constraint": null - }, - "assignee": null, - "assigner": null, - "constraints": [], - "duties": [] - } - ], - "prohibitions": [], - "obligations": [], - "extensibleProperties": {}, - "inheritsFrom": null, - "assigner": null, - "assignee": null, - "target": "urn:uuid:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-urn:uuid:31b614f5-ec14-4ed2-a509-e7b7780083e7", - "@type": { - "@policytype": "set" - } - }, - "asset": { - "id": "urn:uuid:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-urn:uuid:31b614f5-ec14-4ed2-a509-e7b7780083e7", - "createdAt": 1669196292759, - "properties": { - "asset:prop:byteSize": null, - "asset:prop:description": "product description", - "asset:prop:contenttype": "application/json", - "asset:prop:policy-id": "use-eu", - "asset:prop:id": "urn:uuid:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-urn:uuid:31b614f5-ec14-4ed2-a509-e7b7780083e7", - "asset:prop:fileName": null - } - }, - "assetId": null, - "provider": "urn:connector:provider", - "consumer": "urn:connector:consumer", - "offerStart": null, - "offerEnd": null, - "contractStart": null, - "contractEnd": null - }, - { - "id": "notification-receipt-cd:b3693bd7-192e-4b2f-b24b-a1d3e3518dee", - "policy": { - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "uid": null, - "target": "notification-receipt", - "action": { - "type": "USE", - "includedIn": null, - "constraint": null - }, - "assignee": null, - "assigner": null, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "idsc:PURPOSE" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "Investigation" - }, - "operator": "EQ" - } - ], - "duties": [] - } - ], - "prohibitions": [], - "obligations": [], - "extensibleProperties": {}, - "inheritsFrom": null, - "assigner": null, - "assignee": null, - "target": "notification-receipt", - "@type": { - "@policytype": "set" - } - }, - "asset": { - "id": "notification-receipt", - "createdAt": 1680088494977, - "properties": { - "asset:prop:byteSize": null, - "asset:prop:name": "Asset to receive investigations", - "asset:prop:contenttype": "application/json", - "asset:prop:notificationtype": "investigation", - "asset:prop:notificationmethod": "receive", - "asset:prop:id": "notification-receipt", - "asset:prop:fileName": null - } - }, - "assetId": null, - "provider": "urn:connector:provider", - "consumer": "urn:connector:consumer", - "offerStart": null, - "offerEnd": null, - "contractStart": null, - "contractEnd": null - } - ] -} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/edc/responseGetNegotiationConfirmed.json b/irs-api/src/test/resources/__files/edc/responseGetNegotiationConfirmed.json deleted file mode 100644 index 4d0c6ae3cc..0000000000 --- a/irs-api/src/test/resources/__files/edc/responseGetNegotiationConfirmed.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "createdAt": 1669197004371, - "updatedAt": 1669197045765, - "contractAgreementId": "1bbaec6e-c316-4e1e-8258-c07a648cc43c", - "counterPartyAddress": "http://edc.io/BPNL0000000BB2OK/api/v1/ids/data", - "errorDetail": "", - "id": "1cbaec6e-c316-4e3e-8258-c07a648cc44a", - "protocol": "ids-multipart", - "state": "CONFIRMED", - "type": "CONSUMER" -} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/edc/responseStartNegotiation.json b/irs-api/src/test/resources/__files/edc/responseStartNegotiation.json deleted file mode 100644 index 083246511f..0000000000 --- a/irs-api/src/test/resources/__files/edc/responseStartNegotiation.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "id": "1cbaec6e-c316-4e3e-8258-c07a648cc44a" -} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/edc/responseStartTransferprocess.json b/irs-api/src/test/resources/__files/edc/responseStartTransferprocess.json deleted file mode 100644 index 88f6783778..0000000000 --- a/irs-api/src/test/resources/__files/edc/responseStartTransferprocess.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "id": "1b21e963-0bc5-422a-b30d-fd3511861d88" -} \ No newline at end of file From 505fa27daf9493d2357c6b79471957609ca30d6a Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 30 Jan 2024 14:34:43 +0100 Subject: [PATCH 068/116] feat(irs-api):[#344] Add test case for recursive IRS flow --- .../__files/integrationtesting/batch-1.json | 2 +- .../__files/integrationtesting/batch-2.json | 22 +++++++++++++++++++ .../__files/integrationtesting/batch-3.json | 22 +++++++++++++++++++ .../singleLevelBomAsBuilt-2.json | 16 ++++++++++++++ .../singleLevelBomAsBuilt-3.json | 4 ++++ 5 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 irs-api/src/test/resources/__files/integrationtesting/batch-2.json create mode 100644 irs-api/src/test/resources/__files/integrationtesting/batch-3.json create mode 100644 irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-2.json create mode 100644 irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-3.json diff --git a/irs-api/src/test/resources/__files/integrationtesting/batch-1.json b/irs-api/src/test/resources/__files/integrationtesting/batch-1.json index 76e6d99956..b044897ad0 100644 --- a/irs-api/src/test/resources/__files/integrationtesting/batch-1.json +++ b/irs-api/src/test/resources/__files/integrationtesting/batch-1.json @@ -17,6 +17,6 @@ "partTypeInformation": { "manufacturerPartId": "123-0.740-3434-A", "classification": "product", - "nameAtManufacturer": "Glue" + "nameAtManufacturer": "Cathode" } } \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/integrationtesting/batch-2.json b/irs-api/src/test/resources/__files/integrationtesting/batch-2.json new file mode 100644 index 0000000000..d86f962cb3 --- /dev/null +++ b/irs-api/src/test/resources/__files/integrationtesting/batch-2.json @@ -0,0 +1,22 @@ +{ + "localIdentifiers": [ + { + "value": "BPNL00000000TEST", + "key": "manufacturerId" + }, + { + "value": "BID12345678", + "key": "batchId" + } + ], + "manufacturingInformation": { + "date": "2022-02-04T14:48:54", + "country": "HUR" + }, + "catenaXId": "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", + "partTypeInformation": { + "manufacturerPartId": "123-0.740-3434-A", + "classification": "product", + "nameAtManufacturer": "Polyamid" + } +} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/integrationtesting/batch-3.json b/irs-api/src/test/resources/__files/integrationtesting/batch-3.json new file mode 100644 index 0000000000..f62643532a --- /dev/null +++ b/irs-api/src/test/resources/__files/integrationtesting/batch-3.json @@ -0,0 +1,22 @@ +{ + "localIdentifiers": [ + { + "value": "BPNL00000000TEST", + "key": "manufacturerId" + }, + { + "value": "BID12345678", + "key": "batchId" + } + ], + "manufacturingInformation": { + "date": "2022-02-04T14:48:54", + "country": "HUR" + }, + "catenaXId": "urn:uuid:a314ad6b-77ea-417e-ae2d-193b3e249e99", + "partTypeInformation": { + "manufacturerPartId": "123-0.740-3434-A", + "classification": "product", + "nameAtManufacturer": "Generic Chemical" + } +} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-2.json b/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-2.json new file mode 100644 index 0000000000..594e51a4f2 --- /dev/null +++ b/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-2.json @@ -0,0 +1,16 @@ +{ + "catenaXId": "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5", + "childItems": [ + { + "catenaXId": "urn:uuid:a314ad6b-77ea-417e-ae2d-193b3e249e99", + "quantity": { + "quantityNumber": 0.2014, + "measurementUnit": "unit:kilogram" + }, + "hasAlternatives": true, + "businessPartner": "BPNL00000000TEST", + "createdOn": "2022-02-03T14:48:54.709Z", + "lastModifiedOn": "2022-02-03T14:48:54.709Z" + } + ] +} \ No newline at end of file diff --git a/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-3.json b/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-3.json new file mode 100644 index 0000000000..69e7778525 --- /dev/null +++ b/irs-api/src/test/resources/__files/integrationtesting/singleLevelBomAsBuilt-3.json @@ -0,0 +1,4 @@ +{ + "catenaXId": "urn:uuid:a314ad6b-77ea-417e-ae2d-193b3e249e99", + "childItems": [] +} \ No newline at end of file From 1d7fce60b9822552b60b4bac749f6a72ede2f884 Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Tue, 30 Jan 2024 16:11:39 +0100 Subject: [PATCH 069/116] feat(impl):[#370] impl adding contract agreement id --- docs/src/api/irs-api.yaml | 49 +- .../irs/aaswrapper/job/ItemContainer.java | 4 +- .../aaswrapper/job/ItemTreesAssembler.java | 4 +- .../job/delegate/AbstractDelegate.java | 9 +- .../job/delegate/DigitalTwinDelegate.java | 21 +- .../job/delegate/RelationshipDelegate.java | 6 +- .../job/delegate/SubmodelDelegate.java | 24 +- .../irs/configuration/OpenApiExamples.java | 20 +- .../services/IrsItemGraphQueryService.java | 6 +- .../job/delegate/AbstractDelegateTest.java | 27 +- .../job/delegate/DigitalTwinDelegateTest.java | 9 +- .../delegate/RelationshipDelegateTest.java | 36 +- .../job/delegate/SubmodelDelegateTest.java | 36 +- .../validation/BPNIncidentValidationTest.java | 52 +- ...igationJobProcessingEventListenerTest.java | 56 +- .../irs/util/JobResponseAnalyzerTest.java | 107 - .../eclipse/tractusx/irs/util/TestMother.java | 5 + .../test/resources/__files/jobResponse.json | 2682 ----------------- .../client/ContractNegotiationService.java | 8 +- .../irs/edc/client/EdcDataPlaneClient.java | 31 +- .../irs/edc/client/EdcSubmodelClient.java | 3 +- .../irs/edc/client/EdcSubmodelClientImpl.java | 14 +- .../client/EdcSubmodelClientLocalStub.java | 7 +- .../irs/edc/client/EdcSubmodelFacade.java | 5 +- .../exceptions/UsagePolicyException.java | 10 +- .../edc/client/model/SubmodelDescriptor.java | 21 +- .../edc/client/CxTestDataAnalyzerTest.java | 2 +- .../EdcSubmodelClientLocalStubTest.java | 2 +- .../irs/edc/client/EdcSubmodelClientTest.java | 56 +- .../irs/edc/client/EdcSubmodelFacadeTest.java | 17 +- .../client/SubmodelFacadeWiremockTest.java | 31 +- .../irs/edc/client/SubmodelRetryerTest.java | 4 +- .../irs/edc/client/testutil/TestMother.java | 28 + .../irs/smoketest/ItemGraphSmokeTest.java | 6 +- .../irs/component/GenericDescription.java | 54 - .../tractusx/irs/component/JobParameter.java | 4 + .../eclipse/tractusx/irs/component/Jobs.java | 3 +- .../irs/component/ProtocolInformation.java | 49 - .../tractusx/irs/component/RegisterJob.java | 3 + .../tractusx/irs/component/SemanticId.java | 57 - .../eclipse/tractusx/irs/component/Shell.java | 53 +- .../tractusx/irs/component/Submodel.java | 4 +- .../irs/component/SubmodelDescriptor.java | 69 - .../tractusx/irs/component/Tombstone.java | 16 +- .../DigitalTwinRegistryService.java | 6 +- .../CentralDigitalTwinRegistryService.java | 6 +- .../DecentralDigitalTwinRegistryService.java | 18 +- ...CentralDigitalTwinRegistryServiceTest.java | 8 +- ...centralDigitalTwinRegistryServiceTest.java | 29 +- 49 files changed, 427 insertions(+), 3350 deletions(-) delete mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/util/JobResponseAnalyzerTest.java delete mode 100644 irs-api/src/test/resources/__files/jobResponse.json rename irs-models/src/main/java/org/eclipse/tractusx/irs/component/Endpoint.java => irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/model/SubmodelDescriptor.java (68%) delete mode 100644 irs-models/src/main/java/org/eclipse/tractusx/irs/component/GenericDescription.java delete mode 100644 irs-models/src/main/java/org/eclipse/tractusx/irs/component/ProtocolInformation.java delete mode 100644 irs-models/src/main/java/org/eclipse/tractusx/irs/component/SemanticId.java delete mode 100644 irs-models/src/main/java/org/eclipse/tractusx/irs/component/SubmodelDescriptor.java diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml index 67879e47ea..0e10eb2f02 100644 --- a/docs/src/api/irs-api.yaml +++ b/docs/src/api/irs-api.yaml @@ -996,6 +996,7 @@ components: aspects: - SerialPart - AddressAspect + auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false depth: 1 @@ -1046,6 +1047,7 @@ components: aspects: - SerialPart - AddressAspect + auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false depth: 1 @@ -1075,7 +1077,9 @@ components: lexicalValue: piece quantityNumber: 1.0 shells: - - description: + - contractAgreementId: a787aa13-2bd7-488f-9e25-40682003901b + payload: + description: - language: en text: The shell for a vehicle globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 @@ -1168,6 +1172,7 @@ components: aspects: - SerialPart - AddressAspect + auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false depth: 1 @@ -1194,9 +1199,11 @@ components: lexicalValue: piece quantityNumber: 1.0 shells: - - description: - - language: en - text: The shell for a vehicle + - contractAgreementId: a787aa13-2bd7-488f-9e25-40682003901b + payload: + description: + - language: en + text: The shell for a vehicle globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 idShort: future concept x @@ -1318,6 +1325,7 @@ components: aspects: - SerialPart - AddressAspect + auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false depth: 1 @@ -1355,6 +1363,7 @@ components: aspects: - SerialPart - AddressAspect + auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false depth: 1 @@ -1381,9 +1390,11 @@ components: lexicalValue: piece quantityNumber: 1.0 shells: - - description: - - language: en - text: The shell for a vehicle + - contractAgreementId: a787aa13-2bd7-488f-9e25-40682003901b + payload: + description: + - language: en + text: The shell for a vehicle globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 idShort: future concept x @@ -1469,6 +1480,7 @@ components: aspects: - SerialPart - AddressAspect + auditContractNegotiation: false bomLifecycle: asBuilt collectAspects: false depth: 1 @@ -1975,6 +1987,9 @@ components: aspects: type: string example: SerialPart + auditContractNegotiation: + type: boolean + example: false bomLifecycle: type: string example: asBuilt @@ -2056,7 +2071,7 @@ components: type: array description: AAS shells. items: - $ref: '#/components/schemas/AssetAdministrationShellDescriptor' + $ref: '#/components/schemas/Shell' maxItems: 2147483647 submodels: type: array @@ -2461,6 +2476,10 @@ components: items: type: string maxItems: 2147483647 + auditContractNegotiation: + type: boolean + description: Flag enables and disables auditing, including provisioning + of ContractAgreementId inside submodels and shells objects. Default is true. bomLifecycle: type: string description: The lifecycle context in which the child part was assembled @@ -2541,6 +2560,14 @@ components: value: type: string example: Submodel + Shell: + type: object + additionalProperties: false + properties: + contractAgreementId: + type: string + payload: + $ref: '#/components/schemas/AssetAdministrationShellDescriptor' Submodel: type: object additionalProperties: false @@ -2549,6 +2576,8 @@ components: properties: aspectType: type: string + contractAgreementId: + type: string identification: type: string payload: @@ -2600,6 +2629,10 @@ components: pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" endpointURL: type: string + policy: + type: object + additionalProperties: + type: object processingError: $ref: '#/components/schemas/ProcessingError' AspectModel: diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemContainer.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemContainer.java index 135dd58c4e..5cfc633757 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemContainer.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemContainer.java @@ -33,9 +33,9 @@ import org.apache.commons.lang3.StringUtils; import org.eclipse.tractusx.irs.component.Bpn; import org.eclipse.tractusx.irs.component.Relationship; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.Submodel; import org.eclipse.tractusx.irs.component.Tombstone; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; /** * Container class to store item data @@ -52,7 +52,7 @@ public class ItemContainer { private List tombstones; @Singular - private List shells; + private List shells; @Singular private List submodels; diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemTreesAssembler.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemTreesAssembler.java index e726fba40b..75fe3eaacd 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemTreesAssembler.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemTreesAssembler.java @@ -34,9 +34,9 @@ import lombok.extern.slf4j.Slf4j; import org.eclipse.tractusx.irs.component.Bpn; import org.eclipse.tractusx.irs.component.Relationship; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.Submodel; import org.eclipse.tractusx.irs.component.Tombstone; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; /** * Assembles multiple partial item graphs into one overall item graph. @@ -55,7 +55,7 @@ public class ItemTreesAssembler { final var relationships = new LinkedHashSet(); final var numberOfPartialTrees = new AtomicInteger(); final ArrayList tombstones = new ArrayList<>(); - final ArrayList shells = new ArrayList<>(); + final ArrayList shells = new ArrayList<>(); final ArrayList submodels = new ArrayList<>(); final Set bpns = new HashSet<>(); diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java index 2a033b8c6d..00a2c20503 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java @@ -40,6 +40,7 @@ import org.eclipse.tractusx.irs.component.assetadministrationshell.Endpoint; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; /** @@ -85,14 +86,14 @@ protected ItemContainer next(final ItemContainer.ItemContainerBuilder itemContai return itemContainerBuilder.build(); } - protected String requestSubmodelAsString(final EdcSubmodelFacade submodelFacade, + protected SubmodelDescriptor requestSubmodel(final EdcSubmodelFacade submodelFacade, final ConnectorEndpointsService connectorEndpointsService, final Endpoint endpoint, final String bpn) throws EdcClientException { final String subprotocolBody = endpoint.getProtocolInformation().getSubprotocolBody(); final Optional dspEndpoint = extractDspEndpoint(subprotocolBody); if (dspEndpoint.isPresent()) { log.debug("Using dspEndpoint of subprotocolBody '{}' to get submodel payload", subprotocolBody); - return submodelFacade.getSubmodelRawPayload(dspEndpoint.get(), endpoint.getProtocolInformation().getHref(), + return submodelFacade.getSubmodelPayload(dspEndpoint.get(), endpoint.getProtocolInformation().getHref(), extractAssetId(subprotocolBody)); } else { log.info("SubprotocolBody does not contain '{}'. Using Discovery Service as fallback.", DSP_ENDPOINT); @@ -101,11 +102,11 @@ protected String requestSubmodelAsString(final EdcSubmodelFacade submodelFacade, } } - private String getSubmodel(final EdcSubmodelFacade submodelFacade, final Endpoint endpoint, + private SubmodelDescriptor getSubmodel(final EdcSubmodelFacade submodelFacade, final Endpoint endpoint, final List connectorEndpoints) throws EdcClientException { for (final String connectorEndpoint : connectorEndpoints) { try { - return submodelFacade.getSubmodelRawPayload(connectorEndpoint, + return submodelFacade.getSubmodelPayload(connectorEndpoint, endpoint.getProtocolInformation().getHref(), extractAssetId(endpoint.getProtocolInformation().getSubprotocolBody())); } catch (EdcClientException e) { diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java index af4392bfce..8237359ee1 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java @@ -31,8 +31,8 @@ import org.eclipse.tractusx.irs.aaswrapper.job.ItemContainer; import org.eclipse.tractusx.irs.component.JobParameter; import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.Tombstone; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.enums.ProcessStep; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryService; @@ -65,20 +65,19 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai Tombstone.from(itemId.getGlobalAssetId(), null, "Can't get relationship without a BPN", 0, ProcessStep.DIGITAL_TWIN_REQUEST)).build(); } + try { - final AssetAdministrationShellDescriptor shell = digitalTwinRegistryService.fetchShells( - List.of(new DigitalTwinRegistryKey(itemId.getGlobalAssetId(), itemId.getBpn()))) - .stream() - .findFirst() - .orElseThrow(); + final Shell shell = digitalTwinRegistryService.fetchShells(List.of(new DigitalTwinRegistryKey(itemId.getGlobalAssetId(), itemId.getBpn()))) + .stream() + .findFirst() + .orElseThrow(); - if (expectedDepthOfTreeIsNotReached(jobData.getDepth(), aasTransferProcess.getDepth())) { - // traversal submodel descriptors are needed in next Delegate, and will be filtered out there - itemContainerBuilder.shell(shell); - } else { + if (!expectedDepthOfTreeIsNotReached(jobData.getDepth(), aasTransferProcess.getDepth())) { // filter submodel descriptors if next delegate will not be executed - itemContainerBuilder.shell(shell.withFilteredSubmodelDescriptors(jobData.getAspects())); + shell.payload().withFilteredSubmodelDescriptors(jobData.getAspects()); } + + itemContainerBuilder.shell(jobData.isAuditContractNegotiation() ? shell : shell.withoutContractAgreementId()); } catch (final RestClientException | RegistryServiceException e) { log.info("Shell Endpoint could not be retrieved for Item: {}. Creating Tombstone.", itemId); itemContainerBuilder.tombstone(Tombstone.from(itemId.getGlobalAssetId(), null, e, retryCount, ProcessStep.DIGITAL_TWIN_REQUEST)); diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java index 86b47191d3..68c4f32ee4 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java @@ -76,7 +76,7 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai .getShells() .stream() .findFirst() - .ifPresent(shell -> shell.findRelationshipEndpointAddresses( + .ifPresent(shell -> shell.payload().findRelationshipEndpointAddresses( AspectType.fromValue(relationshipAspect.getName())) .forEach(endpoint -> processEndpoint(endpoint, relationshipAspect, aasTransferProcess, itemContainerBuilder, itemId))); @@ -98,8 +98,8 @@ private void processEndpoint(final Endpoint endpoint, final RelationshipAspect r } try { - final String submodelRawPayload = requestSubmodelAsString(submodelFacade, connectorEndpointsService, - endpoint, itemId.getBpn()); + final String submodelRawPayload = requestSubmodel(submodelFacade, connectorEndpointsService, + endpoint, itemId.getBpn()).getPayload(); final var relationships = jsonUtil.fromString(submodelRawPayload, relationshipAspect.getSubmodelClazz()) .asRelationships(); diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java index ae74fb4e3c..cc3fe3e6bb 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java @@ -82,22 +82,22 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai final PartChainIdentificationKey itemId) { itemContainerBuilder.build().getShells().stream().findFirst().ifPresent(shell -> { - final List aasSubmodelDescriptors = shell.getSubmodelDescriptors(); + final List aasSubmodelDescriptors = shell.payload().getSubmodelDescriptors(); log.info("Retrieved {} SubmodelDescriptor for itemId {}", aasSubmodelDescriptors.size(), itemId); - final List filteredSubmodelDescriptorsByAspectType = shell.filterDescriptorsByAspectTypes( + final List filteredSubmodelDescriptorsByAspectType = shell.payload().filterDescriptorsByAspectTypes( jobData.getAspects()); if (jobData.isCollectAspects()) { log.info("Collecting Submodels."); filteredSubmodelDescriptorsByAspectType.forEach(submodelDescriptor -> itemContainerBuilder.submodels( getSubmodels(submodelDescriptor, itemContainerBuilder, itemId.getGlobalAssetId(), - itemId.getBpn()))); + itemId.getBpn(), jobData.isAuditContractNegotiation()))); } log.debug("Unfiltered SubmodelDescriptor: {}", aasSubmodelDescriptors); log.debug("Filtered SubmodelDescriptor: {}", filteredSubmodelDescriptorsByAspectType); - shell.setSubmodelDescriptors(filteredSubmodelDescriptorsByAspectType); + shell.payload().setSubmodelDescriptors(filteredSubmodelDescriptorsByAspectType); }); @@ -105,7 +105,8 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai } private List getSubmodels(final SubmodelDescriptor submodelDescriptor, - final ItemContainer.ItemContainerBuilder itemContainerBuilder, final String itemId, final String bpn) { + final ItemContainer.ItemContainerBuilder itemContainerBuilder, final String itemId, final String bpn, + final boolean auditContractNegotiation) { final List submodels = new ArrayList<>(); submodelDescriptor.getEndpoints().forEach(endpoint -> { @@ -118,15 +119,16 @@ private List getSubmodels(final SubmodelDescriptor submodelDescriptor, try { final String jsonSchema = semanticsHubFacade.getModelJsonSchema(submodelDescriptor.getAspectType()); - final String submodelRawPayload = requestSubmodelAsString(submodelFacade, connectorEndpointsService, - endpoint, bpn); + final org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor submodel = requestSubmodel( + submodelFacade, connectorEndpointsService, endpoint, bpn); + final String submodelRawPayload = submodel.getPayload(); + final String cid = auditContractNegotiation ? submodel.getCid() : null; final ValidationResult validationResult = jsonValidatorService.validate(jsonSchema, submodelRawPayload); if (validationResult.isValid()) { - final Submodel submodel = Submodel.from(submodelDescriptor.getId(), - submodelDescriptor.getAspectType(), jsonUtil.fromString(submodelRawPayload, Map.class)); - submodels.add(submodel); + submodels.add(Submodel.from(submodelDescriptor.getId(), submodelDescriptor.getAspectType(), + cid, jsonUtil.fromString(submodelRawPayload, Map.class))); } else { final String errors = String.join(", ", validationResult.getValidationErrors()); itemContainerBuilder.tombstone(Tombstone.from(itemId, endpoint.getProtocolInformation().getHref(), @@ -144,7 +146,7 @@ private List getSubmodels(final SubmodelDescriptor submodelDescriptor, } catch (final UsagePolicyException e) { log.info("Encountered usage policy exception: {}. Creating Tombstone.", e.getMessage()); itemContainerBuilder.tombstone(Tombstone.from(itemId, endpoint.getProtocolInformation().getHref(), e, 0, - ProcessStep.USAGE_POLICY_VALIDATION)); + ProcessStep.USAGE_POLICY_VALIDATION, jsonUtil.asMap(e.getPolicy()))); } catch (final EdcClientException e) { log.info("Submodel Endpoint could not be retrieved for Item: {}. Creating Tombstone.", itemId); itemContainerBuilder.tombstone(Tombstone.from(itemId, endpoint.getProtocolInformation().getHref(), e, 0, diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiExamples.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiExamples.java index 4314cea529..7365543464 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiExamples.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiExamples.java @@ -48,6 +48,7 @@ import org.eclipse.tractusx.irs.component.ProcessingError; import org.eclipse.tractusx.irs.component.Quantity; import org.eclipse.tractusx.irs.component.Relationship; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.Submodel; import org.eclipse.tractusx.irs.component.Summary; import org.eclipse.tractusx.irs.component.Tombstone; @@ -371,22 +372,23 @@ private Tombstone createTombstone() { .build(); } - private AssetAdministrationShellDescriptor createShell() { - return AssetAdministrationShellDescriptor.builder() - .description(List.of(LangString.builder() + private Shell createShell() { + return new Shell("a787aa13-2bd7-488f-9e25-40682003901b", + AssetAdministrationShellDescriptor.builder() + .description(List.of(LangString.builder() .language("en") .text("The shell for a vehicle") .build())) - .globalAssetId("urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9") - .idShort("future concept x") - .id("urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8") - .specificAssetIds(List.of(IdentifierKeyValuePair.builder() + .globalAssetId("urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9") + .idShort("future concept x") + .id("urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8") + .specificAssetIds(List.of(IdentifierKeyValuePair.builder() .name("engineserialid") .value("12309481209312") .build())) - .submodelDescriptors(List.of(createBaseSubmodelDescriptor(), + .submodelDescriptors(List.of(createBaseSubmodelDescriptor(), createPartSubmodelDescriptor())) - .build(); + .build()); } private Relationship createRelationship() { diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/services/IrsItemGraphQueryService.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/services/IrsItemGraphQueryService.java index 6943370891..c8510d6849 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/services/IrsItemGraphQueryService.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/services/IrsItemGraphQueryService.java @@ -57,10 +57,10 @@ import org.eclipse.tractusx.irs.component.PageResult; import org.eclipse.tractusx.irs.component.RegisterJob; import org.eclipse.tractusx.irs.component.Relationship; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.Submodel; import org.eclipse.tractusx.irs.component.Summary; import org.eclipse.tractusx.irs.component.Tombstone; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.enums.BomLifecycle; import org.eclipse.tractusx.irs.component.enums.Direction; import org.eclipse.tractusx.irs.component.enums.JobState; @@ -245,7 +245,7 @@ public Jobs getJobForJobId(final UUID jobId, final boolean includePartialResults public Jobs getJobForJobId(final MultiTransferJob multiJob, final boolean includePartialResults) { final var relationships = new ArrayList(); final var tombstones = new ArrayList(); - final var shells = new ArrayList(); + final var shells = new ArrayList(); final var submodels = new ArrayList(); final var bpns = new ArrayList(); @@ -332,7 +332,7 @@ private ItemContainer retrievePartialResults(final MultiTransferJob multiJob) { final var relationships = new ArrayList(); final var tombstones = new ArrayList(); - final var shells = new ArrayList(); + final var shells = new ArrayList(); final var submodels = new ArrayList(); final var metrics = new ArrayList(); final var bpns = new ArrayList(); diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegateTest.java index fea1b5f30a..f38685a3a8 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegateTest.java @@ -37,6 +37,7 @@ import org.eclipse.tractusx.irs.component.assetadministrationshell.ProtocolInformation; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -61,7 +62,7 @@ void setUp() { @Test void shouldUseDspEndpointIfPresent() throws EdcClientException { // Arrange - when(submodelFacade.getSubmodelRawPayload(any(), any(), any())).thenReturn("test"); + when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenReturn(new SubmodelDescriptor("cid", "test")); final Endpoint endpoint = Endpoint.builder() .protocolInformation(ProtocolInformation.builder() .href("http://dataplane.test/123") @@ -72,11 +73,11 @@ void shouldUseDspEndpointIfPresent() throws EdcClientException { final String bpn = "BPN123"; // Act - final String submodel = submodelDelegate.requestSubmodelAsString(submodelFacade, null, endpoint, bpn); + final String submodel = submodelDelegate.requestSubmodel(submodelFacade, null, endpoint, bpn).getPayload(); // Assert assertThat(submodel).isEqualTo("test"); - verify(submodelFacade, times(1)).getSubmodelRawPayload("http://edc.test", "http://dataplane.test/123", "123"); + verify(submodelFacade, times(1)).getSubmodelPayload("http://edc.test", "http://dataplane.test/123", "123"); } @Test @@ -84,9 +85,9 @@ void shouldUseDiscoveryFinderIfDspEndpointNotPresent() throws EdcClientException // Arrange final String connector1 = "http://edc.test1"; final String connector2 = "http://edc.test2"; - when(submodelFacade.getSubmodelRawPayload(eq(connector1), any(), any())).thenThrow( + when(submodelFacade.getSubmodelPayload(eq(connector1), any(), any())).thenThrow( new EdcClientException("test")); - when(submodelFacade.getSubmodelRawPayload(eq(connector2), any(), any())).thenReturn("test"); + when(submodelFacade.getSubmodelPayload(eq(connector2), any(), any())).thenReturn(new SubmodelDescriptor("cid", "test")); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of(connector1, connector2)); final String dataplaneUrl = "http://dataplane.test/123"; final Endpoint endpoint = Endpoint.builder() @@ -98,13 +99,13 @@ void shouldUseDiscoveryFinderIfDspEndpointNotPresent() throws EdcClientException final String bpn = "BPN123"; // Act - final String submodel = submodelDelegate.requestSubmodelAsString(submodelFacade, connectorEndpointsService, - endpoint, bpn); + final String submodel = submodelDelegate.requestSubmodel(submodelFacade, connectorEndpointsService, + endpoint, bpn).getPayload(); // Assert assertThat(submodel).isEqualTo("test"); - verify(submodelFacade, times(1)).getSubmodelRawPayload(connector1, dataplaneUrl, "123"); - verify(submodelFacade, times(1)).getSubmodelRawPayload(connector2, dataplaneUrl, "123"); + verify(submodelFacade, times(1)).getSubmodelPayload(connector1, dataplaneUrl, "123"); + verify(submodelFacade, times(1)).getSubmodelPayload(connector2, dataplaneUrl, "123"); verify(connectorEndpointsService, times(1)).fetchConnectorEndpoints(bpn); } @@ -113,7 +114,7 @@ void shouldThrowGenericEdcClientExceptionIfAllEndpointsThrowExceptions() throws // Arrange final String connector1 = "http://edc.test1"; final String connector2 = "http://edc.test2"; - when(submodelFacade.getSubmodelRawPayload(any(), any(), any())).thenThrow(new EdcClientException("test")); + when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenThrow(new EdcClientException("test")); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of(connector1, connector2)); final String dataplaneUrl = "http://dataplane.test/123"; final Endpoint endpoint = Endpoint.builder() @@ -126,12 +127,12 @@ void shouldThrowGenericEdcClientExceptionIfAllEndpointsThrowExceptions() throws // Act assertThatExceptionOfType(EdcClientException.class).isThrownBy( - () -> submodelDelegate.requestSubmodelAsString(submodelFacade, connectorEndpointsService, endpoint, + () -> submodelDelegate.requestSubmodel(submodelFacade, connectorEndpointsService, endpoint, bpn)); // Assert - verify(submodelFacade, times(1)).getSubmodelRawPayload(connector1, dataplaneUrl, "123"); - verify(submodelFacade, times(1)).getSubmodelRawPayload(connector2, dataplaneUrl, "123"); + verify(submodelFacade, times(1)).getSubmodelPayload(connector1, dataplaneUrl, "123"); + verify(submodelFacade, times(1)).getSubmodelPayload(connector2, dataplaneUrl, "123"); verify(connectorEndpointsService, times(1)).fetchConnectorEndpoints(bpn); } } \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java index 1530905038..410da33597 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java @@ -25,6 +25,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.util.TestMother.jobParameter; +import static org.eclipse.tractusx.irs.util.TestMother.shell; import static org.eclipse.tractusx.irs.util.TestMother.shellDescriptor; import static org.eclipse.tractusx.irs.util.TestMother.submodelDescriptorWithoutHref; import static org.mockito.ArgumentMatchers.any; @@ -53,7 +54,7 @@ class DigitalTwinDelegateTest { void shouldFillItemContainerWithShell() throws RegistryServiceException { // given when(digitalTwinRegistryService.fetchShells(any())).thenReturn( - List.of(shellDescriptor(List.of(submodelDescriptorWithoutHref("any"))))); + List.of(shell("", shellDescriptor(List.of(submodelDescriptorWithoutHref("any")))))); // when final ItemContainer result = digitalTwinDelegate.process(ItemContainer.builder(), jobParameter(), @@ -62,14 +63,14 @@ void shouldFillItemContainerWithShell() throws RegistryServiceException { // then assertThat(result).isNotNull(); assertThat(result.getShells()).isNotEmpty(); - assertThat(result.getShells().get(0).getSubmodelDescriptors()).isNotEmpty(); + assertThat(result.getShells().get(0).payload().getSubmodelDescriptors()).isNotEmpty(); } @Test void shouldFillItemContainerWithShellAndFilteredSubmodelDescriptorsWhenDepthReached() throws RegistryServiceException { // given when(digitalTwinRegistryService.fetchShells(any())).thenReturn( - List.of(shellDescriptor(List.of(submodelDescriptorWithoutHref("any"))))); + List.of(shell("", shellDescriptor(List.of(submodelDescriptorWithoutHref("any")))))); final JobParameter jobParameter = JobParameter.builder().depth(1).aspects(List.of()).build(); // when @@ -79,7 +80,7 @@ void shouldFillItemContainerWithShellAndFilteredSubmodelDescriptorsWhenDepthReac // then assertThat(result).isNotNull(); assertThat(result.getShells()).isNotEmpty(); - assertThat(result.getShells().get(0).getSubmodelDescriptors()).isEmpty(); + assertThat(result.getShells().get(0).payload().getSubmodelDescriptors()).isEmpty(); } @Test diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java index bf9443a765..cb49659bb2 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java @@ -26,6 +26,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.util.TestMother.jobParameter; import static org.eclipse.tractusx.irs.util.TestMother.jobParameterUpward; +import static org.eclipse.tractusx.irs.util.TestMother.shell; import static org.eclipse.tractusx.irs.util.TestMother.shellDescriptor; import static org.eclipse.tractusx.irs.util.TestMother.submodelDescriptorWithDspEndpoint; import static org.mockito.ArgumentMatchers.any; @@ -46,6 +47,7 @@ import org.eclipse.tractusx.irs.component.enums.ProcessStep; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.util.JsonUtil; import org.junit.jupiter.api.Test; @@ -69,15 +71,16 @@ private static PartChainIdentificationKey createKey() { void shouldFillItemContainerWithRelationshipAndAddChildIdsToProcess() throws EdcClientException, URISyntaxException, IOException { // given - when(submodelFacade.getSubmodelRawPayload(anyString(), anyString(), anyString())).thenReturn(Files.readString( - Paths.get(Objects.requireNonNull(getClass().getResource("/singleLevelBomAsBuilt.json")).toURI()))); + final String payload = Files.readString( + Paths.get(Objects.requireNonNull(getClass().getResource("/singleLevelBomAsBuilt.json")).toURI())); + when(submodelFacade.getSubmodelPayload(anyString(), anyString(), anyString())).thenReturn(new SubmodelDescriptor("cid", payload)); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("http://localhost")); final ItemContainer.ItemContainerBuilder itemContainerWithShell = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( singleLevelBomAsBuiltAspectName, - "address")))); + "address"))))); final AASTransferProcess aasTransferProcess = new AASTransferProcess(); // when @@ -95,15 +98,16 @@ void shouldFillItemContainerWithRelationshipAndAddChildIdsToProcess() void shouldFillItemContainerWithUpwardRelationshipAndAddChildIdsToProcess() throws EdcClientException, URISyntaxException, IOException { // given - when(submodelFacade.getSubmodelRawPayload(anyString(), anyString(), anyString())).thenReturn(Files.readString( - Paths.get(Objects.requireNonNull(getClass().getResource("/singleLevelUsageAsBuilt.json")).toURI()))); + final String payload = Files.readString( + Paths.get(Objects.requireNonNull(getClass().getResource("/singleLevelUsageAsBuilt.json")).toURI())); + when(submodelFacade.getSubmodelPayload(anyString(), anyString(), anyString())).thenReturn(new SubmodelDescriptor("cid", payload)); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("http://localhost")); final ItemContainer.ItemContainerBuilder itemContainerWithShell = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( singleLevelUsageAsBuiltAspectName, - "address")))); + "address"))))); final AASTransferProcess aasTransferProcess = new AASTransferProcess(); // when @@ -121,10 +125,10 @@ void shouldFillItemContainerWithUpwardRelationshipAndAddChildIdsToProcess() @Test void shouldPutTombstoneForMissingBpn() { final ItemContainer.ItemContainerBuilder itemContainerWithShell = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( singleLevelBomAsBuiltAspectName, - "address")))); + "address"))))); // when final ItemContainer result = relationshipDelegate.process(itemContainerWithShell, jobParameter(), new AASTransferProcess(), PartChainIdentificationKey.builder().globalAssetId("testId").build()); @@ -140,15 +144,15 @@ void shouldPutTombstoneForMissingBpn() { @Test void shouldCatchRestClientExceptionAndPutTombstone() throws EdcClientException { // given - when(submodelFacade.getSubmodelRawPayload(anyString(), anyString(), anyString())).thenThrow( + when(submodelFacade.getSubmodelPayload(anyString(), anyString(), anyString())).thenThrow( new EdcClientException("Unable to call endpoint")); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("http://localhost")); final ItemContainer.ItemContainerBuilder itemContainerWithShell = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( singleLevelBomAsBuiltAspectName, - "address")))); + "address"))))); // when final ItemContainer result = relationshipDelegate.process(itemContainerWithShell, jobParameter(), @@ -165,14 +169,14 @@ void shouldCatchRestClientExceptionAndPutTombstone() throws EdcClientException { @Test void shouldCatchJsonParseExceptionAndPutTombstone() throws EdcClientException { // given - when(submodelFacade.getSubmodelRawPayload(anyString(), anyString(), anyString())).thenThrow( + when(submodelFacade.getSubmodelPayload(anyString(), anyString(), anyString())).thenThrow( new EdcClientException(new Exception("Payload did not match expected submodel"))); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("http://localhost")); final ItemContainer.ItemContainerBuilder itemContainerWithShell = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( singleLevelBomAsBuiltAspectName, - "address")))); + "address"))))); // when final ItemContainer result = relationshipDelegate.process(itemContainerWithShell, jobParameter(), diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java index 8997f69352..b699283080 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java @@ -26,6 +26,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.util.TestMother.jobParameterCollectAspects; import static org.eclipse.tractusx.irs.util.TestMother.jobParameterFilter; +import static org.eclipse.tractusx.irs.util.TestMother.shell; import static org.eclipse.tractusx.irs.util.TestMother.shellDescriptor; import static org.eclipse.tractusx.irs.util.TestMother.submodelDescriptor; import static org.eclipse.tractusx.irs.util.TestMother.submodelDescriptorWithDspEndpoint; @@ -44,6 +45,7 @@ import org.eclipse.tractusx.irs.edc.client.ItemNotFoundInCatalogException; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.eclipse.tractusx.irs.edc.client.exceptions.UsagePolicyException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.semanticshub.SemanticsHubFacade; import org.eclipse.tractusx.irs.services.validation.InvalidSchemaException; @@ -71,13 +73,13 @@ private static PartChainIdentificationKey createKey() { void shouldFilterSubmodelDescriptorsByAspectTypeFilter() { // given final ItemContainer.ItemContainerBuilder itemContainerShellWithTwoSubmodels = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.serial_part_typization:1.0.0#SerialPartTypization", "testSerialPartTypizationEndpoint"), submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.assembly_part_relationship:1.0.0#AssemblyPartRelationship", - "testAssemblyPartRelationshipEndpoint")))); + "testAssemblyPartRelationshipEndpoint"))))); // when final ItemContainer result = submodelDelegate.process(itemContainerShellWithTwoSubmodels, jobParameterFilter(), @@ -85,20 +87,20 @@ void shouldFilterSubmodelDescriptorsByAspectTypeFilter() { // then assertThat(result).isNotNull(); - assertThat(result.getShells().get(0).getSubmodelDescriptors()).isEmpty(); + assertThat(result.getShells().get(0).payload().getSubmodelDescriptors()).isEmpty(); } @Test void shouldCatchJsonParseExceptionAndPutTombstone() throws SchemaNotFoundException { // given final ItemContainer.ItemContainerBuilder itemContainerShellWithTwoSubmodels = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.serial_part:1.0.0#SerialPart", "testSerialPartEndpoint"), submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt", - "testSingleLevelBomAsBuiltEndpoint")))); + "testSingleLevelBomAsBuiltEndpoint"))))); // when when(semanticsHubFacade.getModelJsonSchema(any())).thenThrow( @@ -117,13 +119,13 @@ void shouldCatchJsonParseExceptionAndPutTombstone() throws SchemaNotFoundExcepti @Test void shouldPutTombstoneForMissingBpn() { final ItemContainer.ItemContainerBuilder itemContainerShellWithTwoSubmodels = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.serial_part:1.0.0#SerialPart", "testSerialPartEndpoint"), submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt", - "testSingleLevelBomAsBuiltEndpoint")))); + "testSingleLevelBomAsBuiltEndpoint"))))); // when final ItemContainer result = submodelDelegate.process(itemContainerShellWithTwoSubmodels, @@ -142,16 +144,16 @@ void shouldPutTombstoneForMissingBpn() { void shouldCatchUsagePolicyExceptionAndPutTombstone() throws EdcClientException { // given final ItemContainer.ItemContainerBuilder itemContainerShellWithTwoSubmodels = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.serial_part:1.0.0#SerialPart", "testSerialPartEndpoint"), submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt", - "testSingleLevelBomAsBuiltEndpoint")))); + "testSingleLevelBomAsBuiltEndpoint"))))); // when - when(submodelFacade.getSubmodelRawPayload(any(), any(), any())).thenThrow(new UsagePolicyException("itemId")); + when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenThrow(new UsagePolicyException("itemId", null)); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("connector.endpoint.nl")); final ItemContainer result = submodelDelegate.process(itemContainerShellWithTwoSubmodels, jobParameterCollectAspects(), new AASTransferProcess(), createKey()); @@ -168,17 +170,17 @@ void shouldCatchUsagePolicyExceptionAndPutTombstone() throws EdcClientException void shouldRequestForAllEndpoints() throws EdcClientException, InvalidSchemaException { // given final ItemContainer.ItemContainerBuilder itemContainerShellWithOneSubmodel = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptor( "urn:bamm:com.catenax.serial_part:1.0.0#SerialPart", "testSerialPartEndpoint", - "")))); + ""))))); // when - when(submodelFacade.getSubmodelRawPayload(any(), any(), any())).thenThrow( - new ItemNotFoundInCatalogException("test", "itemId")).thenReturn(""" + when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenThrow( + new ItemNotFoundInCatalogException("test", "itemId")).thenReturn(new SubmodelDescriptor("cid", """ {"test": "test"} - """); + """)); when(jsonValidatorService.validate(any(), any())).thenReturn(ValidationResult.builder().valid(true).build()); when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn( List.of("connector.endpoint.n1", "connector.endpoint.n2")); @@ -197,13 +199,13 @@ void shouldRequestForAllEndpoints() throws EdcClientException, InvalidSchemaExce void shouldCatchRestClientExceptionAndPutTombstone() throws SchemaNotFoundException { // given final ItemContainer.ItemContainerBuilder itemContainerShellWithTwoSubmodels = ItemContainer.builder() - .shell(shellDescriptor( + .shell(shell("", shellDescriptor( List.of(submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.serial_part:1.0.0#SerialPart", "testSerialPartEndpoint"), submodelDescriptorWithDspEndpoint( "urn:bamm:com.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt", - "testSingleLevelBomAsBuiltEndpoint")))); + "testSingleLevelBomAsBuiltEndpoint"))))); // when when(semanticsHubFacade.getModelJsonSchema(any())).thenThrow( diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/bpn/validation/BPNIncidentValidationTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/bpn/validation/BPNIncidentValidationTest.java index 99aac4453d..3b59380ce6 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/bpn/validation/BPNIncidentValidationTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/bpn/validation/BPNIncidentValidationTest.java @@ -24,6 +24,7 @@ package org.eclipse.tractusx.irs.ess.bpn.validation; import static org.assertj.core.api.Assertions.assertThat; +import static org.eclipse.tractusx.irs.util.TestMother.shell; import java.time.ZonedDateTime; import java.util.ArrayList; @@ -33,6 +34,7 @@ import org.eclipse.tractusx.irs.component.GlobalAssetIdentification; import org.eclipse.tractusx.irs.component.Job; import org.eclipse.tractusx.irs.component.Jobs; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.component.partasplanned.PartAsPlanned; @@ -44,24 +46,6 @@ class BPNIncidentValidationTest { - private static Jobs jobResult(final String parentId, final Map cxIdBPNMap) { - final List shells = new ArrayList<>(); - cxIdBPNMap.forEach((s, s2) -> shells.add(createShell(s, s2))); - final GlobalAssetIdentification globalAssetId = GlobalAssetIdentification.of(parentId); - final Job job = Job.builder().globalAssetId(globalAssetId).build(); - return Jobs.builder().job(job).shells(shells).build(); - } - - private static AssetAdministrationShellDescriptor createShell(final String catenaXId, final String bpn) { - return AssetAdministrationShellDescriptor.builder() - .globalAssetId(catenaXId) - .specificAssetIds(List.of(IdentifierKeyValuePair.builder() - .name("manufacturerId") - .value(bpn) - .build())) - .build(); - } - @Test void shouldReturnNoWhenBPNsDoNotContainShellBPNs() { // Arrange @@ -77,7 +61,7 @@ void shouldReturnNoWhenBPNsDoNotContainShellBPNs() { final Jobs jobs = jobResult(parentId, cxIdBPNMap); // Act - final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells(), bpns); + final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells().stream().map(Shell::payload).toList(), bpns); // Assert assertThat(actual).isEqualTo(SupplyChainImpacted.NO); @@ -98,7 +82,7 @@ void shouldReturnYesWhenBPNsContainShellBPNs() { final Jobs jobs = jobResult(parentId, cxIdBPNMap); // Act - final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells(), bpns); + final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells().stream().map(Shell::payload).toList(), bpns); // Assert assertThat(actual).isEqualTo(SupplyChainImpacted.YES); @@ -114,7 +98,7 @@ void shouldReturnYesWhenNoChildrenAndParentContainsBPN() { final Jobs jobs = jobResult(parentId, cxIdBPNMap); // Act - final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells(), bpns); + final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells().stream().map(Shell::payload).toList(), bpns); // Assert assertThat(actual).isEqualTo(SupplyChainImpacted.YES); @@ -130,7 +114,7 @@ void shouldReturnNoWhenNoChildrenAndParentDoesNotContainBPN() { final Jobs jobs = jobResult(parentId, cxIdBPNMap); // Act - final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells(), bpns); + final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells().stream().map(Shell::payload).toList(), bpns); // Assert assertThat(actual).isEqualTo(SupplyChainImpacted.NO); @@ -145,7 +129,7 @@ void shouldReturnUnknownWhenJobContainsNoShells() { final Jobs jobs = jobResult(parentId, cxIdBPNMap); // Act - final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells(), bpns); + final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells().stream().map(Shell::payload).toList(), bpns); // Assert assertThat(actual).isEqualTo(SupplyChainImpacted.UNKNOWN); @@ -163,11 +147,11 @@ void shouldReturnUnknownWhenJobContainsShellWithoutBPN() { .build(); final Jobs jobs = Jobs.builder() .job(Job.builder().globalAssetId(GlobalAssetIdentification.of(parentId)).build()) - .shells(List.of(shellDescriptor)) + .shells(List.of(shell("", shellDescriptor))) .build(); // Act - final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells(), bpns); + final SupplyChainImpacted actual = BPNIncidentValidation.jobContainsIncidentBPNs(jobs.getShells().stream().map(Shell::payload).toList(), bpns); // Assert assertThat(actual).isEqualTo(SupplyChainImpacted.UNKNOWN); @@ -284,4 +268,22 @@ void shouldReturnYesWhenNowBeforeValidityPeriod() { // Assert assertThat(supplyChainImpacted).isEqualTo(SupplyChainImpacted.YES); } + + private static Jobs jobResult(final String parentId, final Map cxIdBPNMap) { + final List shells = new ArrayList<>(); + cxIdBPNMap.forEach((s, s2) -> shells.add(shell("", createShell(s, s2)))); + final GlobalAssetIdentification globalAssetId = GlobalAssetIdentification.of(parentId); + final Job job = Job.builder().globalAssetId(globalAssetId).build(); + return Jobs.builder().job(job).shells(shells).build(); + } + + private static AssetAdministrationShellDescriptor createShell(final String catenaXId, final String bpn) { + return AssetAdministrationShellDescriptor.builder() + .globalAssetId(catenaXId) + .specificAssetIds(List.of(IdentifierKeyValuePair.builder() + .name("manufacturerId") + .value(bpn) + .build())) + .build(); + } } \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/service/InvestigationJobProcessingEventListenerTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/service/InvestigationJobProcessingEventListenerTest.java index f0fbdaa709..c811a1817f 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/service/InvestigationJobProcessingEventListenerTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/ess/service/InvestigationJobProcessingEventListenerTest.java @@ -25,6 +25,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.ess.service.EdcRegistration.ASSET_ID_REQUEST_RECURSIVE; +import static org.eclipse.tractusx.irs.util.TestMother.shell; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; @@ -46,6 +47,7 @@ import org.eclipse.tractusx.irs.component.Jobs; import org.eclipse.tractusx.irs.component.LinkedItem; import org.eclipse.tractusx.irs.component.Relationship; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.Submodel; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; @@ -88,27 +90,6 @@ class InvestigationJobProcessingEventListenerTest { @Captor ArgumentCaptor> edcNotificationCaptor; - private static AssetAdministrationShellDescriptor createShell(final String catenaXId, final String bpn) { - return AssetAdministrationShellDescriptor.builder() - .globalAssetId(catenaXId) - .specificAssetIds(List.of(IdentifierKeyValuePair.builder() - .name("manufacturerId") - .value(bpn) - .build())) - .build(); - } - - private static Relationship createRelationship(final String lifecycle, final String bpn, final String parentId, - final String childId) { - return Relationship.builder() - .aspectType(lifecycle) - .bpn(bpn) - .catenaXId(GlobalAssetIdentification.of(parentId)) - .linkedItem( - LinkedItem.builder().childCatenaXId(GlobalAssetIdentification.of(childId)).build()) - .build(); - } - @BeforeEach void mockInit() { createMockForJobIdAndShell(jobId, "bpn", List.of(createRelationship("SingleLevelBomAsPlanned", "BPN123", @@ -345,7 +326,7 @@ private void createMockForJobIdAndShell(final UUID mockedJobId, final String moc private void createMockForJobIdAndShell(final UUID mockedJobId, final String mockedShell, final List relationships, final List incindentBPNSs, final List submodels) { createMockJob(mockedJobId, relationships, incindentBPNSs, submodels, - List.of(createShell(UUID.randomUUID().toString(), mockedShell))); + List.of(shell("", createShell(UUID.randomUUID().toString(), mockedShell)))); } private void createMockForJobIdAndShell(final UUID mockedJobId, final String mockedShell, @@ -364,12 +345,12 @@ private void createMockForJobIdAndShellsWithMissingSiteIt(final UUID mockedJobId private void createMockForJobIdAndShells(final UUID mockedJobId, final List bpns, final List submodels) { createMockJob(mockedJobId, List.of(), List.of("BPNS000000000DDD"), submodels, - bpns.stream().map(bpn -> createShell(UUID.randomUUID().toString(), bpn)).toList()); + bpns.stream().map(bpn -> shell("", createShell(UUID.randomUUID().toString(), bpn))).toList()); } private void createMockJob(final UUID mockedJobId, final List relationships, final List incindentBPNSs, final List submodels, - final List shells) { + final List shells) { final Jobs jobs = Jobs.builder() .job(Job.builder() .id(mockedJobId) @@ -403,7 +384,7 @@ private static Submodel getPartSiteInformationAsPlanned() { } """; return Submodel.from("test2", - "urn:bamm:io.catenax.part_site_information_as_planned:1.0.0#PartSiteInformationAsPlanned", + "urn:bamm:io.catenax.part_site_information_as_planned:1.0.0#PartSiteInformationAsPlanned", "cid", StringMapper.mapFromString(partSiteInformationAsPlannedRaw, Map.class)); } @@ -421,7 +402,7 @@ private static Submodel getPartSiteInformationAsPlannedWithoutSiteId() { } """; return Submodel.from("test2", - "urn:bamm:io.catenax.part_site_information_as_planned:1.0.0#PartSiteInformationAsPlanned", + "urn:bamm:io.catenax.part_site_information_as_planned:1.0.0#PartSiteInformationAsPlanned", "cid", StringMapper.mapFromString(partSiteInformationAsPlannedRaw, Map.class)); } @@ -440,8 +421,29 @@ private static Submodel getPartAsPlanned() { } } """; - return Submodel.from("test1", "urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned", + return Submodel.from("test1", "urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned", "cid", StringMapper.mapFromString(partAsPlannedRaw, Map.class)); } + private static AssetAdministrationShellDescriptor createShell(final String catenaXId, final String bpn) { + return AssetAdministrationShellDescriptor.builder() + .globalAssetId(catenaXId) + .specificAssetIds(List.of(IdentifierKeyValuePair.builder() + .name("manufacturerId") + .value(bpn) + .build())) + .build(); + } + + private static Relationship createRelationship(final String lifecycle, final String bpn, final String parentId, + final String childId) { + return Relationship.builder() + .aspectType(lifecycle) + .bpn(bpn) + .catenaXId(GlobalAssetIdentification.of(parentId)) + .linkedItem( + LinkedItem.builder().childCatenaXId(GlobalAssetIdentification.of(childId)).build()) + .build(); + } + } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/util/JobResponseAnalyzerTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/util/JobResponseAnalyzerTest.java deleted file mode 100644 index c2c7e4e692..0000000000 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/util/JobResponseAnalyzerTest.java +++ /dev/null @@ -1,107 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 - * 2022: ZF Friedrichshafen AG - * 2022: ISTOS GmbH - * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * 2022,2023: BOSCH AG - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.util; - -import static org.assertj.core.api.Assertions.assertThat; - -import java.io.File; -import java.io.IOException; -import java.util.List; -import java.util.stream.Collectors; - -import com.fasterxml.jackson.databind.DeserializationFeature; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.SerializationFeature; -import com.fasterxml.jackson.datatype.jdk8.Jdk8Module; -import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; -import org.eclipse.tractusx.irs.component.Jobs; -import org.eclipse.tractusx.irs.component.ProcessingError; -import org.eclipse.tractusx.irs.component.Tombstone; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; -import org.junit.jupiter.api.Test; - -class JobResponseAnalyzerTest { - - @Test - void parseAndPrintJobResponseResults() throws IOException { - final String rootGlobalAssetId = "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af"; - final int rootDepth = 0; - final Jobs jobs = this.loadJobsResponseFromFile("src/test/resources/__files/jobResponse.json"); - - this.findAndPrintChildOf(jobs, rootGlobalAssetId, rootDepth); - - assertThat(jobs).isNotNull(); - } - - private List findAndPrintChildOf(final Jobs jobs, final String globalAssetId, final int depth) { - final List childGlobalIds = jobs.getRelationships() - .stream() - .filter(rel -> rel.getCatenaXId() - .getGlobalAssetId() - .equals(globalAssetId)) - .map(rel -> rel.getLinkedItem().getChildCatenaXId().getGlobalAssetId()) - .collect(Collectors.toList()); - - System.out.println(); - System.out.println("Depth: " + depth); - System.out.println("GlobalAssetId: " + globalAssetId); - System.out.println("BPN: " + this.findBpnOf(jobs.getShells(), globalAssetId)); - System.out.println("Child GlobalAssetId's: " + childGlobalIds); - System.out.println("Tombstones: "); - this.findTombstoneOf(jobs.getTombstones(), globalAssetId).forEach(System.out::println); - - childGlobalIds.forEach(child -> this.findAndPrintChildOf(jobs, child, depth + 1)); - - return childGlobalIds; - } - - private String findBpnOf(final List shells, final String globalAssetId) { - return shells.stream() - .filter(shell -> shell.getGlobalAssetId().equals(globalAssetId)) - .findFirst() - .flatMap(AssetAdministrationShellDescriptor::findManufacturerId) - .orElse(""); - } - - private List findTombstoneOf(final List tombstones, final String globalAssetId) { - return tombstones.stream() - .filter(tombstone -> tombstone.getCatenaXId().equals(globalAssetId)) - .map(Tombstone::getProcessingError) - .map(ProcessingError::getErrorDetail) - .collect(Collectors.toList()); - } - - private Jobs loadJobsResponseFromFile(final String filePath) throws IOException { - final File file = new File(filePath); - - final ObjectMapper objectMapper = new ObjectMapper(); - objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); - objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); - objectMapper.registerModule(new Jdk8Module()); - objectMapper.registerModule(new JavaTimeModule()); - - return objectMapper.readValue(file, Jobs.class); - } - -} \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java index 87fb365b4e..a75ae4bf88 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java @@ -44,6 +44,7 @@ import org.eclipse.tractusx.irs.component.RegisterBpnInvestigationBatchOrder; import org.eclipse.tractusx.irs.component.RegisterJob; import org.eclipse.tractusx.irs.component.Relationship; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.Endpoint; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; @@ -251,6 +252,10 @@ public static SubmodelDescriptor submodelDescriptorWithoutHref(final String sema return submodelDescriptorWithDspEndpoint(semanticId, null); } + public static Shell shell(String contractAgreementId, AssetAdministrationShellDescriptor shell) { + return new Shell(contractAgreementId, shell); + } + public static AssetAdministrationShellDescriptor shellDescriptor( final List submodelDescriptors) { return AssetAdministrationShellDescriptor.builder() diff --git a/irs-api/src/test/resources/__files/jobResponse.json b/irs-api/src/test/resources/__files/jobResponse.json deleted file mode 100644 index 63b69bbe62..0000000000 --- a/irs-api/src/test/resources/__files/jobResponse.json +++ /dev/null @@ -1,2682 +0,0 @@ -{ - "job": { - "jobId": "be315f9c-769e-4cc6-a07b-78b94c521923", - "globalAssetId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "jobState": "COMPLETED", - "exception": null, - "createdOn": "2022-11-08T08:35:49.123735015Z", - "startedOn": "2022-11-08T08:35:49.123946811Z", - "lastModifiedOn": "2022-11-08T08:40:41.659932496Z", - "jobCompleted": "2022-11-08T08:40:41.659935596Z", - "owner": "sa-cl6-cx-9", - "summary": { - "asyncFetchedItems": { - "running": 0, - "completed": 38, - "failed": 6 - } - }, - "jobParameter": { - "bomLifecycle": "asBuilt", - "aspects": [ - "SerialPartTypization" - ], - "depth": 100, - "direction": "downward", - "collectAspects": false, - "callbackUrl": null - } - }, - "relationships": [ - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:8ae3c8a9-2c80-4223-a798-db94c854465b" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:9abcceb1-02ed-4384-83bb-e3f5b3be77d4" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:ef4ef0e2-4658-464c-ad1e-eae5afb77942" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:18f9d1ef-100e-4c0a-bb83-a407c644fcba" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:73477f4a-f49f-4306-b30f-3ab36ef72e6f" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:3940c819-dd95-422b-aa32-f7d3f1930de8" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:ec215159-fae3-47d8-98c6-d67b7ffe7c0c" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:6c2f4f41-3924-43da-969d-1afee232194c" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:b32a9cda-b026-4715-b253-c08a7d11b840" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:0391b219-9bf5-44cc-89af-e5db399a7d21" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:7b2484b1-21b5-434a-aa2b-fd5434cc7ae3" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:868df1e0-b497-4059-a0d3-3899630020da" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:67885579-9ddc-4daa-b59e-d7348e9581d3" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:8fc21b03-1796-44af-bd52-c6998bfae1bb" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:d3ab8367-7d12-4991-bd89-cea117a62297" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:087372bf-e9f0-49e6-98e8-0ce98140605c" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:f3f33eec-d7ed-44b5-8cf2-752b6c2c22ca" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:ad1f1627-a57e-481f-9cff-10990674f486" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:643ff5cd-4468-4041-95d9-eeb2cc42c487" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:fbd019cc-6eda-4416-a668-e5d83271781d" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:00ce78e5-3bf3-4847-92c1-28771e83f998" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:09c48e81-5c73-4e1a-85a2-0bf2fff4dada" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:e35161e7-803d-4746-9528-db9d9814c692" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:5c48d1a1-bc81-4a9d-84db-53fc9c69e677" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:8c21d03f-b15e-427f-9cd0-c23701ed8f9c" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:98484975-27ed-4c79-ad94-c82c2c0360e8" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:e83c5a1f-7558-4978-990f-9c796224ce63" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:b995cae9-0196-4ab5-b768-798eda1b5726" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:867a1fd9-6a8b-4f56-a5ef-2b61f12f8bce" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:a9d00358-d560-4a4b-98cc-d3a4d61c253b" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:d7d61cd8-27b2-4707-a4c2-d735cf1a0dcd" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:9abcceb1-02ed-4384-83bb-e3f5b3be77d4", - "linkedItem": { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:9abcceb1-02ed-4384-83bb-e3f5b3be77d4", - "linkedItem": { - "quantity": { - "quantityNumber": 0.2001, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:kilogram" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:68c9b1bf-b2c1-456a-883c-2aac5f5cb5f4" - }, - "aspectType": "AssemblyPartRelationship" - }, - { - "catenaXId": "urn:uuid:9abcceb1-02ed-4384-83bb-e3f5b3be77d4", - "linkedItem": { - "quantity": { - "quantityNumber": 0.3301, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#curie", - "lexicalValue": "unit:kilogram" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:816f9c8d-6ef1-439e-89de-ef1d34481c17" - }, - "aspectType": "AssemblyPartRelationship" - } - ], - "shells": [ - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:8ae3c8a9-2c80-4223-a798-db94c854465b", - "idShort": "Taillight front_BPNL00000003AYRE_NO-577666297086581459258590", - "identification": "urn:uuid:858951f5-fb9c-4ec2-93be-e49fcc2c9361", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-577666297086581459258590", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "78744126-74", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:3b9fd040-5eb1-42f7-b35c-fc1fe48899ff", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:858951f5-fb9c-4ec2-93be-e49fcc2c9361-urn:uuid:3b9fd040-5eb1-42f7-b35c-fc1fe48899ff/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:73477f4a-f49f-4306-b30f-3ab36ef72e6f", - "idShort": "Exterior mirror left_BPNL00000003AYRE_NO-637839747432704841361574", - "identification": "urn:uuid:21527461-ab6d-4e52-b703-39c656f92d75", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-637839747432704841361574", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "65529521-37", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:594bf514-ec44-479d-90d6-d1544450a759", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:21527461-ab6d-4e52-b703-39c656f92d75-urn:uuid:594bf514-ec44-479d-90d6-d1544450a759/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:ef4ef0e2-4658-464c-ad1e-eae5afb77942", - "idShort": "Rims_BPNL00000003AYRE_NO-698813188915827969458218", - "identification": "urn:uuid:73ed3cf8-c124-444b-9524-95d1e17185e3", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-698813188915827969458218", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "08901347-87", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:a025a127-82e2-4361-84da-b94305e7191f", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:73ed3cf8-c124-444b-9524-95d1e17185e3-urn:uuid:a025a127-82e2-4361-84da-b94305e7191f/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:ec215159-fae3-47d8-98c6-d67b7ffe7c0c", - "idShort": "Bumper rear_BPNL00000003AYRE_NO-182909772702645317572786", - "identification": "urn:uuid:66e8a142-dcf6-47d7-8a9a-03c45187b0ee", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-182909772702645317572786", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "22768257-25", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:39960158-4d7c-4361-b043-e833c6dc1629", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:66e8a142-dcf6-47d7-8a9a-03c45187b0ee-urn:uuid:39960158-4d7c-4361-b043-e833c6dc1629/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:67885579-9ddc-4daa-b59e-d7348e9581d3", - "idShort": "Catalysator_BPNL00000003AYRE_NO-699623586834062230296181", - "identification": "urn:uuid:5d403d5d-adc8-4acd-8393-78473eaa8138", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-699623586834062230296181", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "73849201-61", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:7d83fe06-34cd-4cb3-b354-1cc16965c95e", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:5d403d5d-adc8-4acd-8393-78473eaa8138-urn:uuid:7d83fe06-34cd-4cb3-b354-1cc16965c95e/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:868df1e0-b497-4059-a0d3-3899630020da", - "idShort": "Indicator left_BPNL00000003AYRE_NO-263034085930445959442824", - "identification": "urn:uuid:aec68fca-ff25-433e-8816-dc2a74a3d0e2", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-263034085930445959442824", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "20125432-59", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:56922085-f377-46c0-88d3-4410431dbfd4", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:aec68fca-ff25-433e-8816-dc2a74a3d0e2-urn:uuid:56922085-f377-46c0-88d3-4410431dbfd4/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:087372bf-e9f0-49e6-98e8-0ce98140605c", - "idShort": "AC compressor_BPNL00000003AYRE_NO-990379220039630047372226", - "identification": "urn:uuid:030d6ff6-1410-4600-a072-ba10e658e067", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-990379220039630047372226", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "57929013-09", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:ee9c7192-5a31-4e37-9e21-9e10e689c833", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:030d6ff6-1410-4600-a072-ba10e658e067-urn:uuid:ee9c7192-5a31-4e37-9e21-9e10e689c833/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:f3f33eec-d7ed-44b5-8cf2-752b6c2c22ca", - "idShort": "Fender left_BPNL00000003AYRE_NO-825143168313832059901794", - "identification": "urn:uuid:c0fecc9b-0d9e-4482-b873-fa4205b5a51b", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-825143168313832059901794", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "13769860-47", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:7f7112ca-74b8-46ef-9950-08f1b42de144", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:c0fecc9b-0d9e-4482-b873-fa4205b5a51b-urn:uuid:7f7112ca-74b8-46ef-9950-08f1b42de144/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:6c2f4f41-3924-43da-969d-1afee232194c", - "idShort": "Door r-r_BPNL00000003AYRE_NO-521971425971587921853227", - "identification": "urn:uuid:2dfce279-eebe-4ccb-aad1-18df9e5e73ef", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-521971425971587921853227", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "28673126-98", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:bbc75609-9643-4b3b-bf17-1757afdf83fd", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:2dfce279-eebe-4ccb-aad1-18df9e5e73ef-urn:uuid:bbc75609-9643-4b3b-bf17-1757afdf83fd/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:d3ab8367-7d12-4991-bd89-cea117a62297", - "idShort": "Chassis_BPNL00000003AYRE_NO-446614016547833512657672", - "identification": "urn:uuid:4db46718-42cc-4e5d-a801-ce4409a50933", - "specificAssetIds": [ - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "00871379-44", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-446614016547833512657672", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:61f0f858-42a9-4f97-9d47-6e498042ec40", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:4db46718-42cc-4e5d-a801-ce4409a50933-urn:uuid:61f0f858-42a9-4f97-9d47-6e498042ec40/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:3940c819-dd95-422b-aa32-f7d3f1930de8", - "idShort": "Led headlight_BPNL00000003AYRE_NO-085197958619364691310676", - "identification": "urn:uuid:c9cc717e-89f1-4f31-9626-0c633e93e3b0", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "45415162-57", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-085197958619364691310676", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:593c2438-7023-4ab3-bcee-0499612f6afa", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:c9cc717e-89f1-4f31-9626-0c633e93e3b0-urn:uuid:593c2438-7023-4ab3-bcee-0499612f6afa/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:b32a9cda-b026-4715-b253-c08a7d11b840", - "idShort": "Differential Gear_BPNL00000003AYRE_NO-864558822157392253912002", - "identification": "urn:uuid:d7b8d6d5-b564-44e6-bc31-4b70f734362d", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-864558822157392253912002", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "32494586-73", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:0d99f1f4-be57-40df-83ca-5dc294410fa1", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:d7b8d6d5-b564-44e6-bc31-4b70f734362d-urn:uuid:0d99f1f4-be57-40df-83ca-5dc294410fa1/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:0391b219-9bf5-44cc-89af-e5db399a7d21", - "idShort": "Engine hood_BPNL00000003AYRE_NO-090051782799791537084391", - "identification": "urn:uuid:6efe2455-8927-4bab-9fe6-f71b911a04e4", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-090051782799791537084391", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "94421589-82", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:c9dd6460-c83e-453c-821e-3e95f1f50837", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:6efe2455-8927-4bab-9fe6-f71b911a04e4-urn:uuid:c9dd6460-c83e-453c-821e-3e95f1f50837/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:18f9d1ef-100e-4c0a-bb83-a407c644fcba", - "idShort": "Exterior mirror right_BPNL00000003AYRE_NO-653368825144313419172899", - "identification": "urn:uuid:5e2e6ae0-bcb1-487e-9133-937010263c77", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-653368825144313419172899", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "58471477-24", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:62d03e40-dfa0-411e-a230-3fac6ed8786e", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:5e2e6ae0-bcb1-487e-9133-937010263c77-urn:uuid:62d03e40-dfa0-411e-a230-3fac6ed8786e/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:7b2484b1-21b5-434a-aa2b-fd5434cc7ae3", - "idShort": "Turbocharger_BPNL00000003AYRE_NO-517977969951032933278547", - "identification": "urn:uuid:d2400778-0674-4b8a-a855-c5e54cb21643", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-517977969951032933278547", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "67034319-44", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:6c40e92d-0598-469b-b281-565cfbe462d8", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:d2400778-0674-4b8a-a855-c5e54cb21643-urn:uuid:6c40e92d-0598-469b-b281-565cfbe462d8/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:8fc21b03-1796-44af-bd52-c6998bfae1bb", - "idShort": "Taillight rear_BPNL00000003AYRE_NO-031797809646836273892252", - "identification": "urn:uuid:f806d532-2446-4717-a087-cd77037ce638", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-031797809646836273892252", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "61184040-23", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:57e14eba-eac3-4266-b38a-38bf9bde35de", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:f806d532-2446-4717-a087-cd77037ce638-urn:uuid:57e14eba-eac3-4266-b38a-38bf9bde35de/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:09c48e81-5c73-4e1a-85a2-0bf2fff4dada", - "idShort": "Door r-l_BPNL00000003AYRE_NO-357763365151675109323378", - "identification": "urn:uuid:7d8e404a-5fec-4942-884e-32d5883218a4", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-357763365151675109323378", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "15635759-16", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:cefc374b-ebeb-4238-89e3-2f3b18bae8f8", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:7d8e404a-5fec-4942-884e-32d5883218a4-urn:uuid:cefc374b-ebeb-4238-89e3-2f3b18bae8f8/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:643ff5cd-4468-4041-95d9-eeb2cc42c487", - "idShort": "Alternator_BPNL00000003AYRE_NO-234089394021291722206714", - "identification": "urn:uuid:85c0a681-278c-4653-8e31-a7c1c4c874d0", - "specificAssetIds": [ - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "81324139-23", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-234089394021291722206714", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:133dd88f-31be-4cbb-a8b8-ec19654fe95b", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:85c0a681-278c-4653-8e31-a7c1c4c874d0-urn:uuid:133dd88f-31be-4cbb-a8b8-ec19654fe95b/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:ad1f1627-a57e-481f-9cff-10990674f486", - "idShort": "Bumper front_BPNL00000003AYRE_NO-515224917844344882891590", - "identification": "urn:uuid:ba5dacdf-5f43-4ea6-a901-ade29e7371eb", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "54165444-59", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-515224917844344882891590", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:a017f0cf-7e81-4977-ad0c-1c18afb7611c", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:ba5dacdf-5f43-4ea6-a901-ade29e7371eb-urn:uuid:a017f0cf-7e81-4977-ad0c-1c18afb7611c/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:e35161e7-803d-4746-9528-db9d9814c692", - "idShort": "Fender right_BPNL00000003AYRE_NO-531750159545557912983689", - "identification": "urn:uuid:70ab8baf-eb87-47df-818b-e8f68fbf3ca9", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-531750159545557912983689", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "36643162-35", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:0a3bc1cc-eb6b-4715-9212-45a2791b938e", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:70ab8baf-eb87-47df-818b-e8f68fbf3ca9-urn:uuid:0a3bc1cc-eb6b-4715-9212-45a2791b938e/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:fbd019cc-6eda-4416-a668-e5d83271781d", - "idShort": "Trailer coupling_BPNL00000003AYRE_NO-741711117019957866246192", - "identification": "urn:uuid:f2af6d36-a18f-4361-82dd-2574d0060911", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-741711117019957866246192", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "09002013-68", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:3702e0dc-908d-4a5a-92bb-9578d849eee5", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:f2af6d36-a18f-4361-82dd-2574d0060911-urn:uuid:3702e0dc-908d-4a5a-92bb-9578d849eee5/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:00ce78e5-3bf3-4847-92c1-28771e83f998", - "idShort": "Tires_BPNL00000003AYRE_NO-383688996769055538071023", - "identification": "urn:uuid:b2e7eef0-0114-4fe8-bbdf-31a93a70f46b", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-383688996769055538071023", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "45863316-60", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:092c6537-0e92-4ad4-b79b-c3c4f3f3bdc7", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:b2e7eef0-0114-4fe8-bbdf-31a93a70f46b-urn:uuid:092c6537-0e92-4ad4-b79b-c3c4f3f3bdc7/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:5c48d1a1-bc81-4a9d-84db-53fc9c69e677", - "idShort": "Engine_BPNL00000003AYRE_NO-498815506813804675206852", - "identification": "urn:uuid:7b6f3b9d-1c43-4faa-985c-541231e4f4c2", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "10030939-59", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-498815506813804675206852", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:f3a5401b-db30-46ec-a3c8-ca676a0df69a", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:7b6f3b9d-1c43-4faa-985c-541231e4f4c2-urn:uuid:f3a5401b-db30-46ec-a3c8-ca676a0df69a/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:8c21d03f-b15e-427f-9cd0-c23701ed8f9c", - "idShort": "Tailgate_BPNL00000003AYRE_NO-623352977854691316219658", - "identification": "urn:uuid:99887bc8-7e62-4b22-b01f-c7ec4a6242bc", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-623352977854691316219658", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "85023955-75", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:95347a8d-6541-4b83-99a0-119499e84c41", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:99887bc8-7e62-4b22-b01f-c7ec4a6242bc-urn:uuid:95347a8d-6541-4b83-99a0-119499e84c41/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:98484975-27ed-4c79-ad94-c82c2c0360e8", - "idShort": "Dashboard_BPNL00000003AYRE_NO-775119044565305680099730", - "identification": "urn:uuid:900ed7b7-1f3b-4051-83c1-f778cbf9ed9e", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-775119044565305680099730", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "43501996-98", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:72719cdf-5def-41f4-8f2e-b69435c423df", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:900ed7b7-1f3b-4051-83c1-f778cbf9ed9e-urn:uuid:72719cdf-5def-41f4-8f2e-b69435c423df/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:e83c5a1f-7558-4978-990f-9c796224ce63", - "idShort": "Axle part front_BPNL00000003AYRE_NO-619372392092235773470630", - "identification": "urn:uuid:396d4426-0982-49be-a0eb-efbd0fec2722", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "12093297-03", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-619372392092235773470630", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:eb18c41a-1548-4c3d-a12a-eb1f9fff1262", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:396d4426-0982-49be-a0eb-efbd0fec2722-urn:uuid:eb18c41a-1548-4c3d-a12a-eb1f9fff1262/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:f1f14335-bda1-4dea-8818-0a1042bef7af", - "idShort": "Vehicle Combustion_BPNL00000003AYRE_OMAXALZZSKVQLDQYW", - "identification": "urn:uuid:b8d4f010-ab02-4e98-9ca6-b760846ac837", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "OMAXALZZSKVQLDQYW", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "van", - "subjectId": null, - "value": "OMAXALZZSKVQLDQYW", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "CW-84", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:71b71999-092d-4938-9eee-ada6085cea89", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:b8d4f010-ab02-4e98-9ca6-b760846ac837-urn:uuid:71b71999-092d-4938-9eee-ada6085cea89/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:b995cae9-0196-4ab5-b768-798eda1b5726", - "idShort": "Indicator right_BPNL00000003AYRE_NO-704843739978034957603374", - "identification": "urn:uuid:8b50909d-91ef-4797-ac19-fa27bd53bde3", - "specificAssetIds": [ - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "19073706-76", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-704843739978034957603374", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:ae249a4e-e14a-470b-bb87-0667aa729ebd", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:8b50909d-91ef-4797-ac19-fa27bd53bde3-urn:uuid:ae249a4e-e14a-470b-bb87-0667aa729ebd/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:867a1fd9-6a8b-4f56-a5ef-2b61f12f8bce", - "idShort": "Starter motor_BPNL00000003AYRE_NO-308048468179502884344759", - "identification": "urn:uuid:f50b671f-2dfa-4145-af1e-36eec69b46f2", - "specificAssetIds": [ - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "78141846-87", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-308048468179502884344759", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:6835125a-6575-4f46-b1e0-1e0eb4a91ce6", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:f50b671f-2dfa-4145-af1e-36eec69b46f2-urn:uuid:6835125a-6575-4f46-b1e0-1e0eb4a91ce6/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:d7d61cd8-27b2-4707-a4c2-d735cf1a0dcd", - "idShort": "Steering wheel_BPNL00000003AYRE_NO-940456958374895706746333", - "identification": "urn:uuid:65be17f0-3ef1-4ae8-b8e4-a00cf728c6d2", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-940456958374895706746333", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "77795937-13", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:6fd2cb7f-9350-48b8-b91e-c74b8d024f5f", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:65be17f0-3ef1-4ae8-b8e4-a00cf728c6d2-urn:uuid:6fd2cb7f-9350-48b8-b91e-c74b8d024f5f/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:a9d00358-d560-4a4b-98cc-d3a4d61c253b", - "idShort": "Axle part rear_BPNL00000003AYRE_NO-679687669439872282538739", - "identification": "urn:uuid:ac449c62-f160-42e6-b22e-054a3d9bb84f", - "specificAssetIds": [ - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "88111709-49", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AYRE", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-679687669439872282538739", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:53814187-0f3d-40b0-8499-73cb99136086", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://connector.cx-rel.edc.aws.bmw.cloud/BPNL00000003AYRE/urn:uuid:ac449c62-f160-42e6-b22e-054a3d9bb84f-urn:uuid:53814187-0f3d-40b0-8499-73cb99136086/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1-SNAPSHOT"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:9abcceb1-02ed-4384-83bb-e3f5b3be77d4", - "idShort": "urn:uuid:9abcceb1-02ed-4384-83bb-e3f5b3be77d4", - "identification": "urn:uuid:58a1b78a-e3cb-4bc9-b3a6-e5bdb3caba3b", - "specificAssetIds": [ - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003B5MJ", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-642718300945788010337776", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "62986Q6-51", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:3dd5a4eb-ba85-499b-8f3a-1de84014d82e", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "http://cxdev.germanywestcentral.cloudapp.azure.com:8185/BPNL00000003B5MJ/urn:uuid:58a1b78a-e3cb-4bc9-b3a6-e5bdb3caba3b-urn:uuid:3dd5a4eb-ba85-499b-8f3a-1de84014d82e/submodel?content=value&extent=withBlobValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.0"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:816f9c8d-6ef1-439e-89de-ef1d34481c17", - "idShort": "urn:uuid:816f9c8d-6ef1-439e-89de-ef1d34481c17", - "identification": "urn:uuid:816f9c8d-6ef1-439e-89de-ef1d34481c17", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-583510554514808021817274", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003AXS3", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "33906S3-94", - "semanticId": null - } - ], - "submodelDescriptors": [] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4", - "idShort": "BPNL00000003B3NX_urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4", - "identification": "urn:uuid:62040498-b48c-40ee-9522-dded6d10cff7", - "specificAssetIds": [ - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-171010696449453874507690", - "semanticId": null - }, - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "80833J7-99", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003B3NX", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "SerialPartTypization", - "id": "urn:uuid:18910f3e-f051-48e7-bd7a-b61d2e9c420e", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://subtier-a-edc-ocp0900009.apps.c7von4sy.westeurope.aroapp.io/BPNL00000003B3NX/urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4-urn:uuid:18910f3e-f051-48e7-bd7a-b61d2e9c420e/submodel?content=value&extent=withBlobValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "SUBMODEL-1.0RC02" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768", - "idShort": "urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768", - "identification": "urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768", - "specificAssetIds": [ - { - "key": "PartInstanceID", - "subjectId": null, - "value": "NO-456254855447445013274141", - "semanticId": null - }, - { - "key": "ManufacturerID", - "subjectId": null, - "value": "BPNL00000003CSGV", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:ea2193b6-72e4-439b-9e7f-f582eb20f56d", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://catenax.apps.demonstrator.dps.oncite.cloud/BPNL00000003CSGV/urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768-urn:uuid:ea2193b6-72e4-439b-9e7f-f582eb20f56d/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.1.1"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c", - "idShort": "urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c", - "identification": "urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c", - "specificAssetIds": [ - { - "key": "ManufacturerID", - "subjectId": null, - "value": "BPNL00000003CSGV", - "semanticId": null - }, - { - "key": "PartInstanceID", - "subjectId": null, - "value": "NO-119744543834558117845033", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "serialPartTypization", - "id": "urn:uuid:618b1b64-72e4-439b-9e7f-f582eb20f56d", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://catenax.apps.demonstrator.dps.oncite.cloud/BPNL00000003CSGV/urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c-urn:uuid:618b1b64-72e4-439b-9e7f-f582eb20f56d/submodel?content=value&extent=WithBLOBValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.1.1"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "EDC" - } - ] - } - ] - }, - { - "administration": null, - "description": [], - "globalAssetId": "urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b", - "idShort": "BPNL00000003B2OM_urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b", - "identification": "urn:uuid:af3a3d93-124b-42c1-9c4e-e1078840fbba", - "specificAssetIds": [ - { - "key": "manufacturerPartId", - "subjectId": null, - "value": "1O222E8-43", - "semanticId": null - }, - { - "key": "partInstanceId", - "subjectId": null, - "value": "NO-262893229514686288047560", - "semanticId": null - }, - { - "key": "manufacturerId", - "subjectId": null, - "value": "BPNL00000003B2OM", - "semanticId": null - } - ], - "submodelDescriptors": [ - { - "administration": null, - "description": [], - "idShort": "SerialPartTypization", - "id": "urn:uuid:9926c5c1-81e4-44bb-b2c1-7fed197777de", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" - ] - }, - "endpoints": [ - { - "protocolInformation": { - "href": "https://edc-ocp0900009.apps.c7von4sy.westeurope.aroapp.io/BPNL00000003B2OM/urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b-urn:uuid:9926c5c1-81e4-44bb-b2c1-7fed197777de/submodel?content=value&extent=withBlobValue", - "endpointProtocol": "IDS/ECLIPSE DATASPACE CONNECTOR", - "endpointProtocolVersion": ["0.0.1"], - "subprotocol": null, - "subprotocolBody": null, - "subprotocolBodyEncoding": null - }, - "interface": "SUBMODEL-1.0RC02" - } - ] - } - ] - } - ], - "tombstones": [ - { - "catenaXId": "urn:uuid:68c9b1bf-b2c1-456a-883c-2aac5f5cb5f4", - "endpointURL": null, - "processingError": { - "processStep": "DigitalTwinRequest", - "errorDetail": "404 : \"{\"error\":{\"message\":\"Shell for identifier urn:uuid:68c9b1bf-b2c1-456a-883c-2aac5f5cb5f4 not found\",\"path\":\"/registry/registry/shell-descriptors/urn:uuid:68c9b1bf-b2c1-456a-883c-2aac5f5cb5f4\",\"details\":{}}}\"", - "lastAttempt": "2022-11-08T08:37:18.724490618Z", - "retryCounter": 3 - } - }, - { - "catenaXId": "urn:uuid:68c9b1bf-b2c1-456a-883c-2aac5f5cb5f4", - "endpointURL": null, - "processingError": { - "processStep": "BpdmRequest", - "errorDetail": "Cannot find ManufacturerId for CatenaXId: urn:uuid:68c9b1bf-b2c1-456a-883c-2aac5f5cb5f4", - "lastAttempt": "2022-11-08T08:37:18.724609316Z", - "retryCounter": 0 - } - }, - { - "catenaXId": "urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4", - "endpointURL": "https://subtier-a-edc-ocp0900009.apps.c7von4sy.westeurope.aroapp.io/BPNL00000003B3NX/urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4-urn:uuid:f6f15bca-c901-4dca-bdb0-6abea6fae5fd/submodel?content=value&extent=withBlobValue", - "processingError": { - "processStep": "SubmodelRequest", - "errorDetail": "400 Bad Request: \"HTTP ERROR 400 Bad RequestURI: /api/service/urn:uuid:68766b51-f794-4033-bcb1-f635ed309cd4-urn:uuid:f6f15bca-c901-4dca-bdb0-6abea6fae5fd/submodelSTATUS: 400MESSAGE: Bad RequestSERVLET: EDC-default\"", - "lastAttempt": "2022-11-08T08:38:48.752558896Z", - "retryCounter": 3 - } - }, - { - "catenaXId": "urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768", - "endpointURL": "https://catenax.apps.demonstrator.dps.oncite.cloud/BPNL00000003CSGV/urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768-urn:uuid:53ab1d7d-3f1d-4caa-9733-83c3e9b3bd64/submodel?content=value&extent=WithBLOBValue", - "processingError": { - "processStep": "SubmodelRequest", - "errorDetail": "500 Server Error: \"HTTP ERROR 500 Internal Server ErrorURI: /api/service/urn:uuid:50edf0fc-95a7-40b3-ad43-9156f3b81768-urn:uuid:53ab1d7d-3f1d-4caa-9733-83c3e9b3bd64/submodelSTATUS: 500MESSAGE: Internal Server ErrorSERVLET: EDC-default\"", - "lastAttempt": "2022-11-08T08:39:19.657273145Z", - "retryCounter": 3 - } - }, - { - "catenaXId": "urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c", - "endpointURL": "https://catenax.apps.demonstrator.dps.oncite.cloud/BPNL00000003CSGV/urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c-urn:uuid:4ca5b6eb-3f1d-4caa-9733-83c3e9b3bd64/submodel?content=value&extent=WithBLOBValue", - "processingError": { - "processStep": "SubmodelRequest", - "errorDetail": "500 Server Error: \"HTTP ERROR 500 Internal Server ErrorURI: /api/service/urn:uuid:f2e6d0cd-5a9a-451d-a583-510c5209f64c-urn:uuid:4ca5b6eb-3f1d-4caa-9733-83c3e9b3bd64/submodelSTATUS: 500MESSAGE: Internal Server ErrorSERVLET: EDC-default\"", - "lastAttempt": "2022-11-08T08:39:45.123118683Z", - "retryCounter": 3 - } - }, - { - "catenaXId": "urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b", - "endpointURL": "https://edc-ocp0900009.apps.c7von4sy.westeurope.aroapp.io/BPNL00000003B2OM/urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b-urn:uuid:39c6697f-cf4b-427e-8520-dbf0918020ec/submodel?content=value&extent=withBlobValue", - "processingError": { - "processStep": "SubmodelRequest", - "errorDetail": "500 Server Error: \"HTTP ERROR 500 Internal Server ErrorURI: /api/service/urn:uuid:57ced45e-4f98-4aa4-bb67-6f7c51b90a4b-urn:uuid:39c6697f-cf4b-427e-8520-dbf0918020ec/submodelSTATUS: 500MESSAGE: Internal Server ErrorSERVLET: EDC-default\"", - "lastAttempt": "2022-11-08T08:40:41.572188451Z", - "retryCounter": 3 - } - } - ], - "submodels": [], - "bpns": [ - { - "manufacturerId": "BPNL00000003B2OM", - "manufacturerName": "Tier A" - }, - { - "manufacturerId": "BPNL00000003B5MJ", - "manufacturerName": "Tier B" - }, - { - "manufacturerId": "BPNL00000003CSGV", - "manufacturerName": "TEST_BPN_TIER_3" - }, - { - "manufacturerId": "BPNL00000003AXS3", - "manufacturerName": "Sub Tier B" - }, - { - "manufacturerId": "BPNL00000003B3NX", - "manufacturerName": "Sub Tier A" - }, - { - "manufacturerId": "BPNL00000003AYRE", - "manufacturerName": "OEM A" - } - ] -} \ No newline at end of file diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationService.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationService.java index 545f14e830..63def1d591 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationService.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationService.java @@ -62,12 +62,6 @@ public class ContractNegotiationService { private final PolicyCheckerService policyCheckerService; private final EdcConfiguration config; - public NegotiationResponse negotiate(final String providerConnectorUrl, final CatalogItem catalogItem) - throws ContractNegotiationException, UsagePolicyException, TransferProcessException { - return this.negotiate(providerConnectorUrl, catalogItem, - new EndpointDataReferenceStatus(null, EndpointDataReferenceStatus.TokenStatus.REQUIRED_NEW)); - } - public NegotiationResponse negotiate(final String providerConnectorUrl, final CatalogItem catalogItem, final EndpointDataReferenceStatus endpointDataReferenceStatus) throws ContractNegotiationException, UsagePolicyException, TransferProcessException { @@ -130,7 +124,7 @@ private CompletableFuture startNewNegotiation(final String if (!policyCheckerService.isValid(catalogItem.getPolicy())) { log.info("Policy was not allowed, canceling negotiation."); - throw new UsagePolicyException(catalogItem.getItemId()); + throw new UsagePolicyException(catalogItem.getItemId(), catalogItem.getPolicy()); } final NegotiationRequest negotiationRequest = createNegotiationRequestFromCatalogItem(providerConnectorUrl, diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcDataPlaneClient.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcDataPlaneClient.java index 545d80dddd..2bd8848407 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcDataPlaneClient.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcDataPlaneClient.java @@ -57,12 +57,24 @@ public EdcDataPlaneClient(@Qualifier("edcClientRestTemplate") final RestTemplate } public String getData(final EndpointDataReference dataReference, final String submodelDataplaneUrl) { - final String response = edcRestTemplate.exchange(submodelDataplaneUrl, HttpMethod.GET, new HttpEntity<>(null, headers(dataReference)), String.class).getBody(); log.info("Extracting raw embeddedData from EDC data plane response"); - return extractData(response); + return extractEmbeddedData(response); + } + + public EdcNotificationResponse sendData(final EndpointDataReference dataReference, + final EdcNotification notification) { + final String url = dataReference.getEndpoint(); + final HttpHeaders headers = headers(dataReference); + headers.setContentType(MediaType.APPLICATION_JSON); + + final ResponseEntity response = edcRestTemplate.exchange(url, HttpMethod.POST, + new HttpEntity<>(StringMapper.mapToString(notification), headers), String.class); + log.info("Call to {} returned with status code {}", url, response.getStatusCode()); + + return () -> response.getStatusCode().is2xxSuccessful(); } private HttpHeaders headers(final EndpointDataReference dataReference) { @@ -75,7 +87,7 @@ private HttpHeaders headers(final EndpointDataReference dataReference) { return headers; } - private String extractData(final String response) { + private String extractEmbeddedData(final String response) { String modifiedResponse = response; Matcher dataMatcher = RESPONSE_PATTERN.matcher(modifiedResponse); while (dataMatcher.matches()) { @@ -85,17 +97,4 @@ private String extractData(final String response) { } return modifiedResponse; } - - public EdcNotificationResponse sendData(final EndpointDataReference dataReference, - final EdcNotification notification) { - final String url = dataReference.getEndpoint(); - final HttpHeaders headers = headers(dataReference); - headers.setContentType(MediaType.APPLICATION_JSON); - - final ResponseEntity response = edcRestTemplate.exchange(url, HttpMethod.POST, - new HttpEntity<>(StringMapper.mapToString(notification), headers), String.class); - log.info("Call to {} returned with status code {}", url, response.getStatusCode()); - - return () -> response.getStatusCode().is2xxSuccessful(); - } } diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClient.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClient.java index a053e05da5..ccc37dd532 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClient.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClient.java @@ -28,6 +28,7 @@ import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.cache.endpointdatareference.EndpointDataReferenceStatus; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotification; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.eclipse.tractusx.irs.edc.client.model.notification.NotificationContent; @@ -38,7 +39,7 @@ @SuppressWarnings("PMD.ExcessiveImports") public interface EdcSubmodelClient { - CompletableFuture getSubmodelRawPayload(String connectorEndpoint, String submodelDataplaneUrl, + CompletableFuture getSubmodelPayload(String connectorEndpoint, String submodelDataplaneUrl, String assetId) throws EdcClientException; CompletableFuture sendNotification(String submodelEndpointAddress, String assetId, diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java index 72252ebc00..a32d2830ca 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java @@ -44,6 +44,7 @@ import org.eclipse.tractusx.irs.edc.client.model.CatalogItem; import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.eclipse.tractusx.irs.edc.client.model.NegotiationResponse; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotification; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.eclipse.tractusx.irs.edc.client.model.notification.NotificationContent; @@ -86,14 +87,15 @@ private CompletableFuture sendNotificationAsync(final S .schedule(); } - private Optional retrieveSubmodelData(final String submodelDataplaneUrl, final StopWatch stopWatch, + private Optional retrieveSubmodelData(final String submodelDataplaneUrl, final StopWatch stopWatch, final EndpointDataReference endpointDataReference) { if (endpointDataReference != null) { log.info("Retrieving data from EDC data plane for dataReference with id {}", endpointDataReference.getId()); - final String data = edcDataPlaneClient.getData(endpointDataReference, submodelDataplaneUrl); + final String payload = edcDataPlaneClient.getData(endpointDataReference, submodelDataplaneUrl); stopWatchOnEdcTask(stopWatch); + final String cid = EDRAuthCode.fromAuthCodeToken(endpointDataReference.getAuthCode()).getCid(); - return Optional.of(data); + return Optional.of(new SubmodelDescriptor(cid, payload)); } return Optional.empty(); @@ -129,7 +131,7 @@ private Optional sendSubmodelNotification(final String } @Override - public CompletableFuture getSubmodelRawPayload(final String connectorEndpoint, + public CompletableFuture getSubmodelPayload(final String connectorEndpoint, final String submodelDataplaneUrl, final String assetId) throws EdcClientException { return execute(connectorEndpoint, () -> { log.info("Requesting raw SubmodelPayload for endpoint '{}'.", connectorEndpoint); @@ -138,7 +140,7 @@ public CompletableFuture getSubmodelRawPayload(final String connectorEnd final EndpointDataReference endpointDataReference = getEndpointDataReference(connectorEndpoint, assetId); - return pollingService.createJob() + return pollingService.createJob() .action(() -> retrieveSubmodelData(submodelDataplaneUrl, stopWatch, endpointDataReference)) .timeToLive(config.getSubmodel().getRequestTtl()) @@ -150,7 +152,7 @@ public CompletableFuture getSubmodelRawPayload(final String connectorEnd private EndpointDataReference getEndpointDataReference(final String connectorEndpoint, final String assetId) throws EdcClientException { - log.info("Retrieving endpoint data reference from cache for assed id: {}", assetId); + log.info("Retrieving endpoint data reference from cache for asset id: {}", assetId); final EndpointDataReferenceStatus cachedEndpointDataReference = endpointDataReferenceCacheService.getEndpointDataReference( assetId); EndpointDataReference endpointDataReference; diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStub.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStub.java index f0a4a2e826..7e0e37275a 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStub.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStub.java @@ -24,6 +24,7 @@ package org.eclipse.tractusx.irs.edc.client; import java.util.Map; +import java.util.UUID; import java.util.concurrent.CompletableFuture; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; @@ -31,6 +32,7 @@ import org.eclipse.tractusx.irs.data.StringMapper; import org.eclipse.tractusx.irs.edc.client.cache.endpointdatareference.EndpointDataReferenceStatus; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotification; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.eclipse.tractusx.irs.edc.client.model.notification.NotificationContent; @@ -48,13 +50,14 @@ public EdcSubmodelClientLocalStub(final CxTestDataContainer cxTestDataContainer) } @Override - public CompletableFuture getSubmodelRawPayload(final String connectorEndpoint, + public CompletableFuture getSubmodelPayload(final String connectorEndpoint, final String submodelDataplaneUrl, final String assetId) throws EdcClientException { if ("urn:uuid:c35ee875-5443-4a2d-bc14-fdacd64b9446".equals(assetId)) { throw new EdcClientException("Dummy Exception"); } final Map submodel = testdataCreator.createSubmodelForId(assetId + "_" + submodelDataplaneUrl); - return CompletableFuture.completedFuture(StringMapper.mapToString(submodel)); + return CompletableFuture.completedFuture(new SubmodelDescriptor(UUID.randomUUID().toString(), + StringMapper.mapToString(submodel))); } @Override diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacade.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacade.java index 4e1646e8a9..0b5e0558f5 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacade.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacade.java @@ -29,6 +29,7 @@ import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotification; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.eclipse.tractusx.irs.edc.client.model.notification.NotificationContent; @@ -44,10 +45,10 @@ public class EdcSubmodelFacade { private final EdcSubmodelClient client; @SuppressWarnings("PMD.PreserveStackTrace") - public String getSubmodelRawPayload(final String connectorEndpoint, final String submodelDataplaneUrl, + public SubmodelDescriptor getSubmodelPayload(final String connectorEndpoint, final String submodelDataplaneUrl, final String assetId) throws EdcClientException { try { - return client.getSubmodelRawPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get(); + return client.getSubmodelPayload(connectorEndpoint, submodelDataplaneUrl, assetId).get(); } catch (InterruptedException e) { log.debug("InterruptedException occurred.", e); Thread.currentThread().interrupt(); diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java index c3b704a890..4e2e73b4c8 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java @@ -23,12 +23,20 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client.exceptions; +import lombok.Getter; +import org.eclipse.edc.policy.model.Policy; + /** * Usage Policy Exception errors in the contract negotiation. */ public class UsagePolicyException extends EdcClientException { - public UsagePolicyException(final String itemId) { + + @Getter + private final Policy policy; + + public UsagePolicyException(final String itemId, final Policy policy) { super("Consumption of asset '" + itemId + "' is not permitted as the required catalog offer policies do not comply with defined IRS policies."); + this.policy = policy; } } diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Endpoint.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/model/SubmodelDescriptor.java similarity index 68% rename from irs-models/src/main/java/org/eclipse/tractusx/irs/component/Endpoint.java rename to irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/model/SubmodelDescriptor.java index 0a6f490d6e..7045bb2bad 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Endpoint.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/model/SubmodelDescriptor.java @@ -21,27 +21,22 @@ * * SPDX-License-Identifier: Apache-2.0 ********************************************************************************/ -package org.eclipse.tractusx.irs.component; +package org.eclipse.tractusx.irs.edc.client.model; -import io.swagger.v3.oas.annotations.media.Schema; import lombok.Builder; +import lombok.RequiredArgsConstructor; import lombok.Value; import lombok.extern.jackson.Jacksonized; /** - * Communication endpoint + * SubmodelDescriptor */ -@Schema(description = "Communication endpoint.") @Value -@Builder(toBuilder = true) +@Builder @Jacksonized -public class Endpoint { - - @Schema(description = "Communication interface type.", example = "HTTP", implementation = String.class, - defaultValue = "HTTP") - private String interfaceType; - - @Schema(description = "Information to the interface used.", implementation = ProtocolInformation.class) - private ProtocolInformation protocolInformation; +@RequiredArgsConstructor +public class SubmodelDescriptor { + private final String cid; + private final String payload; } diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/CxTestDataAnalyzerTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/CxTestDataAnalyzerTest.java index 99d5d69c5a..c6ec277d58 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/CxTestDataAnalyzerTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/CxTestDataAnalyzerTest.java @@ -348,7 +348,7 @@ private void checkAndIncrementCounter(final boolean shouldCountSubmodel, private void checkAndAddSubmodel(final boolean shouldCountSubmodel, final Optional> payload, final List submodels, final String aspectType) { if (shouldCountSubmodel && payload.isPresent()) { - submodels.add(Submodel.from(UUID.randomUUID().toString(), aspectType, payload.get())); + submodels.add(Submodel.from(UUID.randomUUID().toString(), aspectType, UUID.randomUUID().toString(), payload.get())); } } diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStubTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStubTest.java index af0c4ebc3b..9be5557c9c 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStubTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientLocalStubTest.java @@ -47,6 +47,6 @@ void shouldThrowExceptionFor() { String assetId = "urn:uuid:c35ee875-5443-4a2d-bc14-fdacd64b9446"; // when - assertThrows(EdcClientException.class, () -> edcSubmodelClientLocalStub.getSubmodelRawPayload("", "", assetId)); + assertThrows(EdcClientException.class, () -> edcSubmodelClientLocalStub.getSubmodelPayload("", "", assetId)); } } \ No newline at end of file diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientTest.java index 3f0a921243..5e2b06ea4b 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientTest.java @@ -72,6 +72,7 @@ import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotification; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.eclipse.tractusx.irs.edc.client.model.notification.NotificationContent; +import org.eclipse.tractusx.irs.edc.client.testutil.TestMother; import org.eclipse.tractusx.irs.testing.containers.LocalTestDataConfigurationAware; import org.jetbrains.annotations.NotNull; import org.junit.jupiter.api.BeforeEach; @@ -137,7 +138,7 @@ void shouldRetrieveValidRelationship() throws Exception { when(contractNegotiationService.negotiate(any(), any(), eq(new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)))).thenReturn( NegotiationResponse.builder().contractAgreementId("agreementId").build()); - final EndpointDataReference ref = mock(EndpointDataReference.class); + final EndpointDataReference ref = TestMother.endpointDataReference("agreementId"); endpointDataReferenceStorage.put("agreementId", ref); final String singleLevelBomAsBuiltJson = readSingleLevelBomAsBuiltData(); when(edcDataPlaneClient.getData(eq(ref), any())).thenReturn(singleLevelBomAsBuiltJson); @@ -145,8 +146,8 @@ void shouldRetrieveValidRelationship() throws Exception { new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); // act - final var result = testee.getSubmodelRawPayload(ENDPOINT_ADDRESS, "suffix", "assetId"); - final String resultingRelationships = result.get(5, TimeUnit.SECONDS); + final var result = testee.getSubmodelPayload(ENDPOINT_ADDRESS, "suffix", "assetId"); + final String resultingRelationships = result.get(5, TimeUnit.SECONDS).getPayload(); // assert assertThat(resultingRelationships).isNotNull().isEqualTo(singleLevelBomAsBuiltJson); @@ -194,8 +195,8 @@ void shouldReturnRelationshipsWhenRequestingWithCatenaXIdAndSingleLevelBomAsBuil when(endpointDataReferenceCacheService.getEndpointDataReference(any())).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("http://localhost/", "/submodel", ASSET_ID) - .get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("http://localhost/", "/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).contains(existingCatenaXId); } @@ -209,8 +210,8 @@ void shouldReturnRelationshipsWhenRequestingWithCatenaXIdAndSingleLevelBomAsPlan when(endpointDataReferenceCacheService.getEndpointDataReference(any())).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("http://localhost/", "/submodel", ASSET_ID) - .get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("http://localhost/", "/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).contains("urn:uuid:e5c96ab5-896a-482c-8761-efd74777ca97"); } @@ -224,8 +225,8 @@ void shouldReturnRelationshipsWhenRequestingWithCatenaXIdAndSingleLevelBomAsSpec when(endpointDataReferenceCacheService.getEndpointDataReference(any())).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("http://localhost/", "/submodel", ASSET_ID) - .get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("http://localhost/", "/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).contains("urn:uuid:2afbac90-a662-4f16-9058-4f030e692631"); } @@ -239,8 +240,8 @@ void shouldReturnEmptyRelationshipsWhenRequestingWithCatenaXIdAndSingleLevelUsag when(endpointDataReferenceCacheService.getEndpointDataReference(any())).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("http://localhost/", "/submodel", ASSET_ID) - .get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("http://localhost/", "/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).isNotEmpty(); } @@ -255,8 +256,8 @@ void shouldReturnEmptyRelationshipsWhenRequestingWithNotExistingCatenaXIdAndSing when(endpointDataReferenceCacheService.getEndpointDataReference(ASSET_ID)).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("http://localhost/", "/submodel", ASSET_ID) - .get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("http://localhost/", "/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).isEqualTo("{}"); } @@ -270,8 +271,9 @@ void shouldReturnRawSerialPartWhenExisting() throws Exception { when(endpointDataReferenceCacheService.getEndpointDataReference(ASSET_ID)).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("https://connector.endpoint.com", - "/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel", ASSET_ID).get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("https://connector.endpoint.com", + "/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).startsWith( "{\"localIdentifiers\":[{\"value\":\"BPNL00000003AVTH\",\"key\":\"manufacturerId\"}"); @@ -287,8 +289,9 @@ void shouldUseDecodedTargetId() throws Exception { when(endpointDataReferenceCacheService.getEndpointDataReference(ASSET_ID)).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String submodelResponse = testee.getSubmodelRawPayload("https://connector.endpoint.com", - "/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel", ASSET_ID).get(5, TimeUnit.SECONDS); + final String submodelResponse = testee.getSubmodelPayload("https://connector.endpoint.com", + "/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel", ASSET_ID) + .get(5, TimeUnit.SECONDS).getPayload(); assertThat(submodelResponse).startsWith( "{\"localIdentifiers\":[{\"value\":\"BPNL00000003AVTH\",\"key\":\"manufacturerId\"}"); @@ -303,8 +306,8 @@ void shouldReturnSameRelationshipsForDifferentDirections() throws Exception { prepareTestdata(parentCatenaXId, "_singleLevelBomAsBuilt"); when(endpointDataReferenceCacheService.getEndpointDataReference(ASSET_ID)).thenReturn( new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); - final String relationshipsJson = testee.getSubmodelRawPayload("http://localhost/", "_singleLevelBomAsBuilt", - ASSET_ID).get(5, TimeUnit.SECONDS); + final String relationshipsJson = testee.getSubmodelPayload("http://localhost/", "_singleLevelBomAsBuilt", + ASSET_ID).get(5, TimeUnit.SECONDS).getPayload(); final var relationships = StringMapper.mapFromString(relationshipsJson, RelationshipAspect.from(asBuilt, Direction.DOWNWARD).getSubmodelClazz()).asRelationships(); @@ -316,8 +319,8 @@ void shouldReturnSameRelationshipsForDifferentDirections() throws Exception { .orElseThrow(); prepareTestdata(childCatenaXId.getGlobalAssetId(), "_singleLevelUsageAsBuilt"); - final String singleLevelUsageRelationshipsJson = testee.getSubmodelRawPayload("http://localhost/", - "_singleLevelUsageAsBuilt", ASSET_ID).get(5, TimeUnit.SECONDS); + final String singleLevelUsageRelationshipsJson = testee.getSubmodelPayload("http://localhost/", + "_singleLevelUsageAsBuilt", ASSET_ID).get(5, TimeUnit.SECONDS).getPayload(); final var singleLevelUsageRelationships = StringMapper.mapFromString(singleLevelUsageRelationshipsJson, RelationshipAspect.from(asBuilt, Direction.UPWARD).getSubmodelClazz()).asRelationships(); @@ -378,17 +381,16 @@ void shouldUseCachedEndpointReferenceValueWhenTokenIsValid() throws EdcClientException, ExecutionException, InterruptedException { // given when(endpointDataReferenceCacheService.getEndpointDataReference(any())).thenReturn( - new EndpointDataReferenceStatus( - EndpointDataReference.Builder.newInstance().endpoint("").authKey("").authCode("").build(), + new EndpointDataReferenceStatus(TestMother.endpointDataReference("assetId"), TokenStatus.VALID)); final String value = "result"; when(edcDataPlaneClient.getData(any(), any())).thenReturn(value); // when - final var resultFuture = testee.getSubmodelRawPayload(ENDPOINT_ADDRESS, "suffix", "assetId"); + final var resultFuture = testee.getSubmodelPayload(ENDPOINT_ADDRESS, "suffix", "assetId"); // then - final String result = resultFuture.get(); + final String result = resultFuture.get().getPayload(); verify(contractNegotiationService, never()).negotiate(any(), any(), any()); assertThat(result).isEqualTo(value); } @@ -407,7 +409,7 @@ void shouldCreateCacheRecordWhenTokenIsNotValid() throws EdcClientException { new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)); // when - testee.getSubmodelRawPayload(ENDPOINT_ADDRESS, "suffix", "assetId"); + testee.getSubmodelPayload(ENDPOINT_ADDRESS, "suffix", "assetId"); // then final Optional referenceFromStorage = endpointDataReferenceStorage.get("assetId"); @@ -420,7 +422,7 @@ private void prepareTestdata(final String catenaXId, final String submodelDataSu when(contractNegotiationService.negotiate(any(), any(), eq(new EndpointDataReferenceStatus(null, TokenStatus.REQUIRED_NEW)))).thenReturn( NegotiationResponse.builder().contractAgreementId("agreementId").build()); - final EndpointDataReference ref = mock(EndpointDataReference.class); + final EndpointDataReference ref = TestMother.endpointDataReference("agreementId"); endpointDataReferenceStorage.put("agreementId", ref); final SubmodelTestdataCreator submodelTestdataCreator = new SubmodelTestdataCreator( localTestDataConfiguration.cxTestDataContainer()); diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java index a0430a84d9..38f7f281a4 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelFacadeTest.java @@ -35,6 +35,7 @@ import org.assertj.core.api.ThrowableAssert; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; @@ -60,11 +61,11 @@ class EdcSubmodelFacadeTest { void shouldThrowExecutionExceptionForSubmodel() throws EdcClientException { // arrange final ExecutionException e = new ExecutionException(new EdcClientException("test")); - final CompletableFuture future = CompletableFuture.failedFuture(e); - when(client.getSubmodelRawPayload(any(), any(), any())).thenReturn(future); + final CompletableFuture future = CompletableFuture.failedFuture(e); + when(client.getSubmodelPayload(any(), any(), any())).thenReturn(future); // act - ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); + ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); // assert assertThatThrownBy(action).isInstanceOf(EdcClientException.class); @@ -74,10 +75,10 @@ void shouldThrowExecutionExceptionForSubmodel() throws EdcClientException { void shouldThrowEdcClientExceptionForSubmodel() throws EdcClientException { // arrange final EdcClientException e = new EdcClientException("test"); - when(client.getSubmodelRawPayload(any(), any(), any())).thenThrow(e); + when(client.getSubmodelPayload(any(), any(), any())).thenThrow(e); // act - ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); + ThrowableAssert.ThrowingCallable action = () -> testee.getSubmodelPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); // assert assertThatThrownBy(action).isInstanceOf(EdcClientException.class); @@ -87,13 +88,13 @@ void shouldThrowEdcClientExceptionForSubmodel() throws EdcClientException { void shouldRestoreInterruptOnInterruptExceptionForSubmodel() throws EdcClientException, ExecutionException, InterruptedException { // arrange - final CompletableFuture future = mock(CompletableFuture.class); + final CompletableFuture future = mock(CompletableFuture.class); final InterruptedException e = new InterruptedException(); when(future.get()).thenThrow(e); - when(client.getSubmodelRawPayload(any(), any(), any())).thenReturn(future); + when(client.getSubmodelPayload(any(), any(), any())).thenReturn(future); // act - testee.getSubmodelRawPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); + testee.getSubmodelPayload(CONNECTOR_ENDPOINT, SUBMODEL_SUFIX, ASSET_ID); // assert assertThat(Thread.currentThread().isInterrupted()).isTrue(); diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java index 033fe200f5..be407d70a9 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java @@ -37,10 +37,12 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; +import java.nio.charset.StandardCharsets; import java.time.Clock; import java.time.Duration; import java.time.OffsetDateTime; import java.util.ArrayList; +import java.util.Base64; import java.util.List; import java.util.Map; import java.util.concurrent.ExecutionException; @@ -53,6 +55,7 @@ import org.assertj.core.api.ThrowableAssert; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.data.StringMapper; import org.eclipse.tractusx.irs.edc.client.cache.endpointdatareference.EndpointDataReferenceCacheService; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; import org.eclipse.tractusx.irs.edc.client.exceptions.UsagePolicyException; @@ -65,6 +68,7 @@ import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.PolicyCheckerService; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; +import org.eclipse.tractusx.irs.edc.client.testutil.TestMother; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -141,7 +145,7 @@ void tearDown() { } @Test - void shouldReturnAssemblyPartRelationshipAsString() + void shouldReturnAssemblyPartRelationshipPayloadAsString() throws EdcClientException, ExecutionException, InterruptedException { // Arrange prepareNegotiation(); @@ -152,8 +156,8 @@ void shouldReturnAssemblyPartRelationshipAsString() "singleLevelBomAsBuilt.json"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), - assetId).get(); + final String submodel = edcSubmodelClient.getSubmodelPayload(connectorEndpoint, buildWiremockDataplaneUrl(), + assetId).get().getPayload(); // Assert assertThat(submodel).contains("\"catenaXId\": \"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\""); @@ -202,9 +206,10 @@ private void prepareNegotiation() { "edc/responseGetTransferConfirmed.json"))); final var contractAgreementId = "7681f966-36ea-4542-b5ea-0d0db81967de:5a7ab616-989f-46ae-bdf2-32027b9f6ee6-31b614f5-ec14-4ed2-a509-e7b7780083e7:a6144a2e-c1b1-4ec6-96e1-a221da134e4f"; + final EndpointDataReference ref = EndpointDataReference.Builder.newInstance() .authKey("testkey") - .authCode("testcode") + .authCode(TestMother.edrAuthCode(contractAgreementId)) .properties(Map.of(NAMESPACE_EDC_CID, contractAgreementId)) .endpoint("http://provider.dataplane/api/public") @@ -213,7 +218,7 @@ private void prepareNegotiation() { } @Test - void shouldReturnMaterialForRecyclingAsString() + void shouldReturnMaterialForRecyclingPayloadAsString() throws EdcClientException, ExecutionException, InterruptedException { // Arrange prepareNegotiation(); @@ -224,15 +229,15 @@ void shouldReturnMaterialForRecyclingAsString() "materialForRecycling.json"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), - assetId).get(); + final String submodel = edcSubmodelClient.getSubmodelPayload(connectorEndpoint, buildWiremockDataplaneUrl(), + assetId).get().getPayload(); // Assert assertThat(submodel).contains("\"materialName\": \"Cooper\","); } @Test - void shouldReturnObjectAsStringWhenResponseNotJSON() + void shouldReturnPayloadObjectAsStringWhenResponseNotJSON() throws EdcClientException, ExecutionException, InterruptedException { // Arrange prepareNegotiation(); @@ -242,8 +247,8 @@ void shouldReturnObjectAsStringWhenResponseNotJSON() .withBody("test"))); // Act - final String submodel = edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), - assetId).get(); + final String submodel = edcSubmodelClient.getSubmodelPayload(connectorEndpoint, buildWiremockDataplaneUrl(), + assetId).get().getPayload(); // Assert assertThat(submodel).isEqualTo("test"); @@ -271,7 +276,7 @@ void shouldThrowExceptionWhenPoliciesAreNotAccepted() { // Act & Assert final String errorMessage = "Consumption of asset '58505404-4da1-427a-82aa-b79482bcd1f0' is not permitted as the required catalog offer policies do not comply with defined IRS policies."; assertThatExceptionOfType(UsagePolicyException.class).isThrownBy( - () -> edcSubmodelClient.getSubmodelRawPayload(connectorEndpoint, buildWiremockDataplaneUrl(), assetId) + () -> edcSubmodelClient.getSubmodelPayload(connectorEndpoint, buildWiremockDataplaneUrl(), assetId) .get()).withMessageEndingWith(errorMessage); } @@ -285,7 +290,7 @@ void shouldThrowExceptionWhenResponse_400() { .withBody("{ error: '400'}"))); // Act - final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( + final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelPayload( connectorEndpoint, buildWiremockDataplaneUrl(), assetId).get(5, TimeUnit.SECONDS); // Assert @@ -303,7 +308,7 @@ void shouldThrowExceptionWhenResponse_500() { .withBody("{ error: '500'}"))); // Act - final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelRawPayload( + final ThrowableAssert.ThrowingCallable throwingCallable = () -> edcSubmodelClient.getSubmodelPayload( connectorEndpoint, buildWiremockDataplaneUrl(), assetId).get(5, TimeUnit.SECONDS); // Assert diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelRetryerTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelRetryerTest.java index 3ac9de4f3b..7758811e42 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelRetryerTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelRetryerTest.java @@ -97,7 +97,7 @@ void shouldRetryExecutionOfGetSubmodelOnClientMaxAttemptTimes() { when(endpointDataReferenceCacheService.getEndpointDataReference("9300395e-c0a5-4e88-bc57-a3973fec4c26")).thenReturn(new EndpointDataReferenceStatus(null, EndpointDataReferenceStatus.TokenStatus.REQUIRED_NEW)); // Act - assertThatThrownBy(() -> testee.getSubmodelRawPayload( + assertThatThrownBy(() -> testee.getSubmodelPayload( "https://connector.endpoint.com", "/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel", "9300395e-c0a5-4e88-bc57-a3973fec4c26")).hasCauseInstanceOf( @@ -116,7 +116,7 @@ void shouldRetryOnAnyRuntimeException() { when(endpointDataReferenceCacheService.getEndpointDataReference("9300395e-c0a5-4e88-bc57-a3973fec4c26")).thenReturn(new EndpointDataReferenceStatus(null, EndpointDataReferenceStatus.TokenStatus.REQUIRED_NEW)); // Act - assertThatThrownBy(() -> testee.getSubmodelRawPayload( + assertThatThrownBy(() -> testee.getSubmodelPayload( "https://connector.endpoint.com", "/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel", "9300395e-c0a5-4e88-bc57-a3973fec4c26")).hasCauseInstanceOf(RuntimeException.class); diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java index 72e368dc6a..c0683c2a4f 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/testutil/TestMother.java @@ -33,6 +33,8 @@ import static org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration.NAMESPACE_TRACTUSX; import static org.mockito.Mockito.mock; +import java.nio.charset.StandardCharsets; +import java.util.Base64; import java.util.List; import java.util.Map; import java.util.UUID; @@ -60,6 +62,10 @@ import org.eclipse.edc.policy.model.Policy; import org.eclipse.edc.policy.model.XoneConstraint; import org.eclipse.edc.spi.monitor.ConsoleMonitor; +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.data.StringMapper; +import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; +import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.eclipse.tractusx.irs.edc.client.transformer.EdcTransformer; import org.jetbrains.annotations.NotNull; @@ -149,4 +155,26 @@ public static Policy createXOneConstraintPolicy(final List constrain final Permission permission = createUsePermission(orConstraint); return Policy.Builder.newInstance().permission(permission).build(); } + + public static EndpointDataReference endpointDataReference(final String contractAgreementId) { + return EndpointDataReference.Builder.newInstance() + .authKey("testkey") + .authCode(edrAuthCode(contractAgreementId)) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint("http://provider.dataplane/api/public") + .build(); + } + + public static String edrAuthCode(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + return "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + } } diff --git a/irs-integration-tests/src/test/java/org/eclipse/tractusx/irs/smoketest/ItemGraphSmokeTest.java b/irs-integration-tests/src/test/java/org/eclipse/tractusx/irs/smoketest/ItemGraphSmokeTest.java index 3421228bd1..47298d74c1 100644 --- a/irs-integration-tests/src/test/java/org/eclipse/tractusx/irs/smoketest/ItemGraphSmokeTest.java +++ b/irs-integration-tests/src/test/java/org/eclipse/tractusx/irs/smoketest/ItemGraphSmokeTest.java @@ -43,7 +43,7 @@ import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; import org.eclipse.tractusx.irs.component.RegisterJob; import org.eclipse.tractusx.irs.component.Relationship; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.SubmodelDescriptor; import org.eclipse.tractusx.irs.component.enums.AspectType; import org.eclipse.tractusx.irs.component.enums.BomLifecycle; @@ -178,8 +178,8 @@ void shouldCreateAndCompleteJob() { assertThat(completedJobs.getTombstones().size()).isNotNegative(); assertThat(completedJobs.getBpns()).isNotEmpty(); - final AssetAdministrationShellDescriptor assDescriptor = completedJobs.getShells().get(0); - final List submodelDescriptors = assDescriptor.getSubmodelDescriptors(); + final Shell assDescriptor = completedJobs.getShells().get(0); + final List submodelDescriptors = assDescriptor.payload().getSubmodelDescriptors(); assertThat(submodelDescriptors).isNotEmpty(); } diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/GenericDescription.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/GenericDescription.java deleted file mode 100644 index 197ee49740..0000000000 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/GenericDescription.java +++ /dev/null @@ -1,54 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 - * 2022: ZF Friedrichshafen AG - * 2022: ISTOS GmbH - * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * 2022,2023: BOSCH AG - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.component; - -import java.util.List; -import java.util.Map; - -import com.fasterxml.jackson.databind.annotation.JsonDeserialize; -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.Builder; -import lombok.Value; - -/** - * GenericDescription - */ -@Schema(description = "") -@Value -@Builder(toBuilder = true) -@JsonDeserialize(builder = GenericDescription.GenericDescriptionBuilder.class) -public class GenericDescription { - - @Schema(description = "Identification string") - private String identification; - - @Schema(description = "Identification short form") - private String idShort; - - @Schema(description = "Key value pair for specific asset id") - private Map specificAssetId; - - @Schema(description = "Description") - private List descriptions; -} diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/JobParameter.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/JobParameter.java index 38eabd73dd..a06333f1a1 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/JobParameter.java +++ b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/JobParameter.java @@ -72,6 +72,9 @@ public class JobParameter { @Schema(implementation = Boolean.class, example = "false") private boolean lookupBPNs; + @Schema(implementation = Boolean.class, example = "false") + private boolean auditContractNegotiation; + @Schema(implementation = String.class, example = "https://hostname.com/callback?id={id}&state={state}") private String callbackUrl; @@ -91,6 +94,7 @@ public static JobParameter create(final @NonNull RegisterJob request) { : aspectTypeValues) .collectAspects(request.isCollectAspects()) .lookupBPNs(request.isLookupBPNs()) + .auditContractNegotiation(request.isAuditContractNegotiation()) .callbackUrl(request.getCallbackUrl()) .build(); } diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Jobs.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Jobs.java index 4dd413f1e2..42b53f46b5 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Jobs.java +++ b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Jobs.java @@ -33,7 +33,6 @@ import lombok.Singular; import lombok.Value; import lombok.extern.jackson.Jacksonized; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; /** * List of Job and relationship to parts @@ -54,7 +53,7 @@ public class Jobs { private List relationships; @ArraySchema(arraySchema = @Schema(description = "AAS shells."), maxItems = Integer.MAX_VALUE) - private List shells; + private List shells; @ArraySchema(arraySchema = @Schema(description = "Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL."), maxItems = Integer.MAX_VALUE) @Singular diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/ProtocolInformation.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/ProtocolInformation.java deleted file mode 100644 index 7b5d6eab57..0000000000 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/ProtocolInformation.java +++ /dev/null @@ -1,49 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 - * 2022: ZF Friedrichshafen AG - * 2022: ISTOS GmbH - * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * 2022,2023: BOSCH AG - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.component; - -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.Builder; -import lombok.Value; -import lombok.extern.jackson.Jacksonized; - -/** - * ProtocolInformation - */ -@Value -@Jacksonized -@Builder(toBuilder = true) -public class ProtocolInformation { - - @Schema(description = "Uniform resource identifier of endpoint.", - example = "https://catena-x.net/vehicle/basedetails/", implementation = java.net.URI.class) - private String endpointAddress; - - @Schema(description = "Protocol used to access the endpoint.", example = "HTTP or HTTPS", - implementation = String.class) - private String endpointProtocol; - - @Schema(description = "Protocol version.", example = "1.0", implementation = String.class) - private String enpointProtocolVersion; -} diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/RegisterJob.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/RegisterJob.java index 87b574b47c..82b978ab50 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/RegisterJob.java +++ b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/RegisterJob.java @@ -81,6 +81,9 @@ public class RegisterJob { @Schema(description = "Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false.") private boolean lookupBPNs; + @Schema(description = "Flag enables and disables auditing, including provisioning of ContractAgreementId inside submodels and shells objects. Default is true.") + private boolean auditContractNegotiation = true; + @URL(regexp = "^(http|https).*") @Schema(description = "Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: id and state.", example = "https://hostname.com/callback?id={id}&state={state}") diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/SemanticId.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/SemanticId.java deleted file mode 100644 index 76375a2e0b..0000000000 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/SemanticId.java +++ /dev/null @@ -1,57 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 - * 2022: ZF Friedrichshafen AG - * 2022: ISTOS GmbH - * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * 2022,2023: BOSCH AG - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.component; - -import java.util.List; - -import com.fasterxml.jackson.databind.annotation.JsonDeserialize; -import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.AllArgsConstructor; -import lombok.Builder; -import lombok.Singular; -import lombok.Value; - -/** - * SemanticId - */ -@Value -@Builder(toBuilder = true) -@Schema(description = "") -@AllArgsConstructor -@JsonDeserialize(builder = SemanticId.SemanticIdBuilder.class) -public class SemanticId { - - @Schema() - @Singular - private List values; - - /** - * User to build SemanticId - */ - @Schema(description = "User to build async fetched items") - @JsonPOJOBuilder(withPrefix = "") - public static class SemanticIdBuilder { - } -} diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Shell.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Shell.java index 68063e1bae..dc0284159c 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Shell.java +++ b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Shell.java @@ -23,54 +23,19 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.component; -import java.util.List; -import java.util.Map; - -import com.fasterxml.jackson.databind.annotation.JsonDeserialize; -import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.AllArgsConstructor; import lombok.Builder; -import lombok.Singular; -import lombok.Value; +import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; /** - * An AAS shell. + * Shell container + * + * @param contractAgreementId + * @param payload */ -@Value -@Builder(toBuilder = true) -@Schema(description = "") -@AllArgsConstructor -@JsonDeserialize(builder = Shell.ShellBuilder.class) -public class Shell { - - @Schema(implementation = String.class) - private String identification; - - @Schema(implementation = String.class) - private String idShort; - - @Schema() - @Singular - private Map specificAssetIds; - - @Schema() - @Singular - private List descriptions; - - @Schema() - @Singular - private List globalAssetIds; - - @Schema() - @Singular - private List submodelDescriptors; +@Builder +public record Shell(String contractAgreementId, AssetAdministrationShellDescriptor payload) { - /** - * User to build Shell - */ - @Schema(description = "User to build shell items") - @JsonPOJOBuilder(withPrefix = "") - public static class ShellBuilder { + public Shell withoutContractAgreementId() { + return Shell.builder().payload(this.payload()).build(); } } diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Submodel.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Submodel.java index f3b9a8dccf..38df73789e 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Submodel.java +++ b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Submodel.java @@ -40,12 +40,14 @@ public class Submodel { private String identification; private String aspectType; + private String contractAgreementId; private Map payload; - public static Submodel from(final String identification, final String aspectType, final Map payload) { + public static Submodel from(final String identification, final String aspectType, final String contractAgreementId, final Map payload) { return Submodel.builder() .identification(identification) .aspectType(aspectType) + .contractAgreementId(contractAgreementId) .payload(payload) .build(); } diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/SubmodelDescriptor.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/SubmodelDescriptor.java deleted file mode 100644 index f762fffa38..0000000000 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/SubmodelDescriptor.java +++ /dev/null @@ -1,69 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 - * 2022: ZF Friedrichshafen AG - * 2022: ISTOS GmbH - * 2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * 2022,2023: BOSCH AG - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.component; - -import java.util.List; - -import com.fasterxml.jackson.databind.annotation.JsonDeserialize; -import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.AllArgsConstructor; -import lombok.Builder; -import lombok.Singular; -import lombok.Value; - -/** - * SubmodelDescriptor description - */ -@Value -@Builder(toBuilder = true) -@AllArgsConstructor -@JsonDeserialize(builder = SubmodelDescriptor.SubmodelDescriptorBuilder.class) -public class SubmodelDescriptor { - - @Schema(implementation = String.class) - private String identification; - - @Schema(implementation = String.class) - private String idShort; - - @Schema() - @Singular - private List descriptions; - - @Schema(implementation = SemanticId.class) - private SemanticId semanticId; - - @Schema() - @Singular - private List endpoints; - - /** - * User to build SubmodelDescriptor - */ - @Schema(description = "User to build async fetched items") - @JsonPOJOBuilder(withPrefix = "") - public static class SubmodelDescriptorBuilder { - } -} diff --git a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Tombstone.java b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Tombstone.java index f34a6901a0..268a33c8c4 100644 --- a/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Tombstone.java +++ b/irs-models/src/main/java/org/eclipse/tractusx/irs/component/Tombstone.java @@ -25,6 +25,7 @@ import java.time.ZoneOffset; import java.time.ZonedDateTime; +import java.util.Map; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Builder; @@ -51,14 +52,25 @@ public class Tombstone { private final String catenaXId; private final String endpointURL; private final ProcessingError processingError; + private final Map policy; public static Tombstone from(final String catenaXId, final String endpointURL, final Exception exception, final int retryCount, final ProcessStep processStep) { - return from(catenaXId, endpointURL, exception.getMessage(), retryCount, processStep); + return from(catenaXId, endpointURL, exception.getMessage(), retryCount, processStep, null); } public static Tombstone from(final String catenaXId, final String endpointURL, final String errorDetails, final int retryCount, final ProcessStep processStep) { + return from(catenaXId, endpointURL, errorDetails, retryCount, processStep, null); + } + + public static Tombstone from(final String catenaXId, final String endpointURL, final Exception exception, + final int retryCount, final ProcessStep processStep, final Map policy) { + return from(catenaXId, endpointURL, exception.getMessage(), retryCount, processStep, policy); + } + + public static Tombstone from(final String catenaXId, final String endpointURL, final String errorDetails, + final int retryCount, final ProcessStep processStep, final Map policy) { final ProcessingError processingError = ProcessingError.builder() .withProcessStep(processStep) @@ -70,6 +82,8 @@ public static Tombstone from(final String catenaXId, final String endpointURL, f .endpointURL(endpointURL) .catenaXId(catenaXId) .processingError(processingError) + .policy(policy) .build(); } + } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/DigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/DigitalTwinRegistryService.java index 1afd1d3bb2..153acd3140 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/DigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/DigitalTwinRegistryService.java @@ -25,7 +25,7 @@ import java.util.Collection; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; /** @@ -39,7 +39,7 @@ public interface DigitalTwinRegistryService { * @param bpn the BPN to retrieve the shells for * @return the collection of asset administration shells */ - default Collection lookupShellsByBPN(final String bpn) throws RegistryServiceException { + default Collection lookupShellsByBPN(final String bpn) throws RegistryServiceException { return fetchShells(lookupShellIdentifiers(bpn)).stream().toList(); } @@ -69,6 +69,6 @@ default Collection lookupShells(final String bpn) throws * @param identifiers the shell identifiers * @return the shell descriptors */ - Collection fetchShells(Collection identifiers) + Collection fetchShells(Collection identifiers) throws RegistryServiceException; } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryService.java index 78b709bd4d..538e8cfce6 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryService.java @@ -29,7 +29,7 @@ import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryService; @@ -44,12 +44,12 @@ public class CentralDigitalTwinRegistryService implements DigitalTwinRegistrySer private final DigitalTwinRegistryClient digitalTwinRegistryClient; @Override - public Collection fetchShells(final Collection keys) { + public Collection fetchShells(final Collection keys) { return keys.stream().map(key -> { final String aaShellIdentification = getAAShellIdentificationOrGlobalAssetId(key.shellId()); log.info("Retrieved AAS Identification {} for globalAssetId {}", aaShellIdentification, key.shellId()); - return digitalTwinRegistryClient.getAssetAdministrationShellDescriptor(aaShellIdentification); + return new Shell("", digitalTwinRegistryClient.getAssetAdministrationShellDescriptor(aaShellIdentification)); }).toList(); } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index f372c21668..fec9d47106 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -29,6 +29,7 @@ import java.util.HashSet; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.Set; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -36,6 +37,7 @@ import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; @@ -63,7 +65,7 @@ private static Stream>> groupKeys } @Override - public Collection fetchShells(final Collection keys) + public Collection fetchShells(final Collection keys) throws RegistryServiceException { log.info("Fetching shell(s) for {} key(s)", keys.size()); final var calledEndpoints = new HashSet(); @@ -78,19 +80,20 @@ public Collection fetchShells(final Collecti } @NotNull - private Stream fetchShellDescriptors(final Set calledEndpoints, + private Stream fetchShellDescriptors(final Set calledEndpoints, final String bpn, final List keys) { log.info("Fetching {} shells for bpn {}", keys.size(), bpn); final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); calledEndpoints.addAll(connectorEndpoints); - final List descriptors = new ArrayList<>(); + final List descriptors = new ArrayList<>(); EndpointDataReference endpointDataReference = null; for (final DigitalTwinRegistryKey key : keys) { endpointDataReference = renewIfNecessary(endpointDataReference, connectorEndpoints); - descriptors.add(fetchShellDescriptor(endpointDataReference, key)); + descriptors.add(new Shell(contractNegotiationId(endpointDataReference.getAuthCode()), + fetchShellDescriptor(endpointDataReference, key))); } return descriptors.stream(); @@ -110,6 +113,13 @@ private EndpointDataReference renewIfNecessary(final EndpointDataReference endpo } } + private String contractNegotiationId(final String token) { + return Optional.ofNullable(token) + .map(EDRAuthCode::fromAuthCodeToken) + .map(EDRAuthCode::getCid) + .orElse(""); + } + private Instant extractTokenExpiration(final String token) { return Instant.ofEpochSecond(EDRAuthCode.fromAuthCodeToken(token).getExp()); } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryServiceTest.java index 0e4e9d1410..0d88ade1b3 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/central/CentralDigitalTwinRegistryServiceTest.java @@ -37,6 +37,7 @@ import java.util.Collections; import java.util.List; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.Endpoint; import org.eclipse.tractusx.irs.component.assetadministrationshell.SubmodelDescriptor; @@ -78,11 +79,12 @@ void setUp() throws IOException { void shouldReturnSubmodelEndpointsWhenRequestingWithCatenaXId() throws RegistryServiceException { final String existingCatenaXId = "urn:uuid:a65c35a8-8d31-4a86-899b-57912de33675"; - final Collection aasShellDescriptor = digitalTwinRegistryService.fetchShells( + final Collection aasShellDescriptor = digitalTwinRegistryService.fetchShells( List.of(new DigitalTwinRegistryKey(existingCatenaXId, ""))); final List shellEndpoints = aasShellDescriptor.stream() .findFirst() .get() + .payload() .getSubmodelDescriptors(); assertThat(shellEndpoints).isNotNull().isNotEmpty(); @@ -119,7 +121,7 @@ void shouldReturnTombstoneWhenClientReturnsEmptyDescriptor() { LookupShellsResponse.builder().result(Collections.emptyList()).build()); final List submodelEndpoints = dtRegistryFacadeWithMock.fetchShells( - List.of(new DigitalTwinRegistryKey(catenaXId, ""))).stream().findFirst().get().getSubmodelDescriptors(); + List.of(new DigitalTwinRegistryKey(catenaXId, ""))).stream().findFirst().get().payload().getSubmodelDescriptors(); assertThat(submodelEndpoints).isEmpty(); } @@ -155,6 +157,7 @@ void shouldReturnAssetAdministrationShellDescriptorForFoundIdentification() { .stream() .findFirst() .get() + .payload() .getSubmodelDescriptors(); assertThat(submodelEndpoints).isEmpty(); } @@ -178,6 +181,7 @@ void shouldReturnSubmodelEndpointsWhenFilteringByAspectType() throws RegistrySer .stream() .findFirst() .get() + .payload() .getSubmodelDescriptors(); assertThat(shellEndpoints).isNotNull().isNotEmpty(); diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index 5df9a62db4..c6f67966d0 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -40,6 +40,7 @@ import org.assertj.core.api.Assertions; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.component.assetadministrationshell.SubmodelDescriptor; @@ -87,7 +88,7 @@ void shouldReturnExpectedShell() throws RegistryServiceException { // given final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final AssetAdministrationShellDescriptor expectedShell = shellDescriptor(Collections.emptyList()); + final Shell expectedShell = new Shell("", shellDescriptor(Collections.emptyList())); EndpointDataReference endpointDataReference = EndpointDataReference.Builder.newInstance() .endpoint("url.to.host") .build(); @@ -100,10 +101,10 @@ void shouldReturnExpectedShell() throws RegistryServiceException { when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); + expectedShell.payload()); // when - final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( + final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( List.of(digitalTwinRegistryKey)); // then @@ -115,7 +116,7 @@ void shouldRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceE // given final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final AssetAdministrationShellDescriptor expectedShell = shellDescriptor(Collections.emptyList()); + final Shell expectedShell = new Shell("", shellDescriptor(Collections.emptyList())); final var authCode = "test." + createAuthCode(exp -> exp.minus(1, ChronoUnit.DAYS)); EndpointDataReference endpointDataReference = EndpointDataReference.Builder.newInstance() .endpoint("url.to.host") @@ -134,10 +135,10 @@ void shouldRenewEndpointDataReferenceForMultipleAssets() throws RegistryServiceE when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); + expectedShell.payload()); // when - final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( + final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( List.of(digitalTwinRegistryKey, digitalTwinRegistryKey)); // then @@ -151,7 +152,7 @@ void shouldNotRenewEndpointDataReferenceForMultipleAssets() throws RegistryServi // given final DigitalTwinRegistryKey digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); - final AssetAdministrationShellDescriptor expectedShell = shellDescriptor(Collections.emptyList()); + final Shell expectedShell = new Shell("", shellDescriptor(Collections.emptyList())); final var authCode = "test." + createAuthCode(exp -> exp.plus(1, ChronoUnit.DAYS)); EndpointDataReference endpointDataReference = EndpointDataReference.Builder.newInstance() .endpoint("url.to.host") @@ -167,10 +168,10 @@ void shouldNotRenewEndpointDataReferenceForMultipleAssets() throws RegistryServi when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); + expectedShell.payload()); // when - final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( + final Collection actualShell = decentralDigitalTwinRegistryService.fetchShells( List.of(digitalTwinRegistryKey, digitalTwinRegistryKey, digitalTwinRegistryKey)); // then @@ -186,9 +187,9 @@ void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); final String expectedGlobalAssetId = "urn:uuid:4132cd2b-cbe7-4881-a6b4-aaaaaaaaaaaa"; - final var expectedShell = shellDescriptor(Collections.emptyList()).toBuilder() + final var expectedShell = new Shell("", shellDescriptor(Collections.emptyList()).toBuilder() .globalAssetId(expectedGlobalAssetId) - .build(); + .build()); final var endpointDataReference = EndpointDataReference.Builder.newInstance().endpoint("url.to.host").build(); final LookupShellsResponse lookupShellsResponse = LookupShellsResponse.builder() .result(List.of( @@ -200,14 +201,14 @@ void shouldReturnExpectedGlobalAssetId() throws RegistryServiceException { when(decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink(any(), ArgumentMatchers.anyList())).thenReturn(lookupShellsResponse); when(decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(any(), any())).thenReturn( - expectedShell); + expectedShell.payload()); // when - final Collection assetAdministrationShellDescriptors = decentralDigitalTwinRegistryService.lookupShellsByBPN( + final Collection shell = decentralDigitalTwinRegistryService.lookupShellsByBPN( digitalTwinRegistryKey.bpn()); - String actualGlobalAssetId = assetAdministrationShellDescriptors.stream().findFirst().map(AssetAdministrationShellDescriptor::getGlobalAssetId).get(); // then + String actualGlobalAssetId = shell.stream().findFirst().map(Shell::payload).map(AssetAdministrationShellDescriptor::getGlobalAssetId).get(); Assertions.assertThat(actualGlobalAssetId).isEqualTo(expectedGlobalAssetId); } From b3915c0b5ed48b8b655e500a17ee0ae5fa2a127f Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Tue, 30 Jan 2024 16:16:56 +0100 Subject: [PATCH 070/116] feat(impl):[#370] changelog --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 458cdcad76..d346cc6e7d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,11 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Added helper script for building documentation locally. +- Added new job parameter flag "auditContractNegotiation" which toggles setting contractAgreementId in Shells and Submodels +- Added "contractAgreementId" field to Submodel model ### Changed - Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" - Changed lookupGlobalAssetIds to lookupShellsByBPN, which provides full object. - Suppressed CVE-2024-20932 from graal-sdk-21.2.0.jar because this is not applicable for IRS. +- Redesigned Shell object - wrapped payload and added "contractAgreementId" field ### Fixed - Update to Spring Boot 3.1.8. This fixes the following CVEs: From d9fc95096d7bd99445b1c7328f35a6a239b8770c Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 31 Jan 2024 09:27:00 +0100 Subject: [PATCH 071/116] feat(impl):[#370] fix pmd --- .../irs/aaswrapper/job/delegate/SubmodelDelegate.java | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java index cc3fe3e6bb..a75fcb400a 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegate.java @@ -49,6 +49,7 @@ import org.eclipse.tractusx.irs.services.validation.SchemaNotFoundException; import org.eclipse.tractusx.irs.services.validation.ValidationResult; import org.eclipse.tractusx.irs.util.JsonUtil; +import org.jetbrains.annotations.Nullable; import org.springframework.web.client.RestClientException; /** @@ -122,13 +123,13 @@ private List getSubmodels(final SubmodelDescriptor submodelDescriptor, final org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor submodel = requestSubmodel( submodelFacade, connectorEndpointsService, endpoint, bpn); final String submodelRawPayload = submodel.getPayload(); - final String cid = auditContractNegotiation ? submodel.getCid() : null; + final String contractAgreementId = getContractAgreementId(auditContractNegotiation, submodel); final ValidationResult validationResult = jsonValidatorService.validate(jsonSchema, submodelRawPayload); if (validationResult.isValid()) { submodels.add(Submodel.from(submodelDescriptor.getId(), submodelDescriptor.getAspectType(), - cid, jsonUtil.fromString(submodelRawPayload, Map.class))); + contractAgreementId, jsonUtil.fromString(submodelRawPayload, Map.class))); } else { final String errors = String.join(", ", validationResult.getValidationErrors()); itemContainerBuilder.tombstone(Tombstone.from(itemId, endpoint.getProtocolInformation().getHref(), @@ -156,4 +157,10 @@ private List getSubmodels(final SubmodelDescriptor submodelDescriptor, return submodels; } + @Nullable + private String getContractAgreementId(final boolean auditContractNegotiation, + final org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor submodel) { + return auditContractNegotiation ? submodel.getCid() : null; + } + } From 62ccdb9b8c8ee906d10e6ffc3fb9fee87c2be390 Mon Sep 17 00:00:00 2001 From: ds-mkanal <100209308+mkanal@users.noreply.github.com> Date: Wed, 31 Jan 2024 09:58:16 +0100 Subject: [PATCH 072/116] chore():[#000] Add contact information to Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 53664b07d4..c0cfc7d648 100644 --- a/README.md +++ b/README.md @@ -152,3 +152,13 @@ from the base distribution, along with any direct or indirect dependencies of th As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within. + +## Contact + +Contact the project developers via the project's "dev" list. + +* https://accounts.eclipse.org/mailing-list/tractusx-dev + +Contact the project developers via eclipse matrix chat. + +* Eclipse Matrix Chat https://chat.eclipse.org/#/room/#tractusx-irs:matrix.eclipse.org From eb69da9a1dc83a3a711d0655d9070d4f2f588aa8 Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 31 Jan 2024 10:25:15 +0100 Subject: [PATCH 073/116] feat(impl):[#370] fix spotbugs --- .../tractusx/irs/edc/client/EdcSubmodelClientImpl.java | 10 ++++++++-- .../edc/client/exceptions/UsagePolicyException.java | 4 ++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java index a32d2830ca..3cee65c88a 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java @@ -36,6 +36,7 @@ import io.github.resilience4j.retry.RetryRegistry; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.StringUtils; import org.apache.commons.validator.routines.UrlValidator; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.edc.client.cache.endpointdatareference.EndpointDataReferenceCacheService; @@ -49,6 +50,7 @@ import org.eclipse.tractusx.irs.edc.client.model.notification.EdcNotificationResponse; import org.eclipse.tractusx.irs.edc.client.model.notification.NotificationContent; import org.eclipse.tractusx.irs.edc.client.util.Masker; +import org.jetbrains.annotations.Nullable; import org.springframework.util.StopWatch; /** @@ -93,14 +95,18 @@ private Optional retrieveSubmodelData(final String submodelD log.info("Retrieving data from EDC data plane for dataReference with id {}", endpointDataReference.getId()); final String payload = edcDataPlaneClient.getData(endpointDataReference, submodelDataplaneUrl); stopWatchOnEdcTask(stopWatch); - final String cid = EDRAuthCode.fromAuthCodeToken(endpointDataReference.getAuthCode()).getCid(); - return Optional.of(new SubmodelDescriptor(cid, payload)); + return Optional.of(new SubmodelDescriptor(getContractAgreementId(endpointDataReference.getAuthCode()), payload)); } return Optional.empty(); } + @Nullable + private String getContractAgreementId(final String authCode) { + return StringUtils.isNotBlank(authCode) ? EDRAuthCode.fromAuthCodeToken(authCode).getCid() : null; + } + private Optional retrieveEndpointReference(final String storageId, final StopWatch stopWatch) { final Optional dataReference = retrieveEndpointDataReferenceByContractAgreementId( diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java index 4e2e73b4c8..dcf419790b 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/exceptions/UsagePolicyException.java @@ -29,10 +29,10 @@ /** * Usage Policy Exception errors in the contract negotiation. */ +@Getter public class UsagePolicyException extends EdcClientException { - @Getter - private final Policy policy; + private final transient Policy policy; public UsagePolicyException(final String itemId, final Policy policy) { super("Consumption of asset '" + itemId From 979db2231826c00053afab50215de1c7383c38cd Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Wed, 31 Jan 2024 12:16:23 +0100 Subject: [PATCH 074/116] chore(irs):[#207] prepare concept for redisign metrics used in summary inside job response --- ...ics-used-in-summary-inside-job-response.md | 54 +++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md diff --git a/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md b/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md new file mode 100644 index 0000000000..22c32806d4 --- /dev/null +++ b/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md @@ -0,0 +1,54 @@ +# \[Concept\] \[#ID#\] Summary + +| Key | Value | +|---------------|-------------------------------------------------------------------------------| +| Creation date | 31.01.2024 | +| Ticket Id | #207 https://github.com/eclipse-tractusx/item-relationship-service/issues/207 | +| State | DRAFT | + +## Table of Contents + +1. [Overview](#overview) +2. [Problem Statement](#problem-statement) +3. [Concept](#concept) + +## Overview +Currently summary section of a JobResponse contains information about asyncFetchedItems which covers DigitalTwin Registry requests responses and Submodel Server requests responses. +Results are shown together for both of mentioned responses: +``` +"summary": { + "asyncFetchedItems": { + "completed": 1, + "failed": 0, + "running": 0 + } +} +``` + +## Problem Statement +We would like to have separate summary response for DigitalTwin Registry requests and Submodel Server. +Also there should be information about actual tree depth for given JobResponse. + +## Concept +This diagram shows current flow: +![alt text](https://eclipse-tractusx.github.io/item-relationship-service/docs/arc42/architecture-constraints/execute-job.svg) + +Steps number 4 and 6 are respectively requesting AAS and Submodel. Then both are stored in BlobStore by method `addTransferProcess` in `JobStore`. +They should be distinguished by the type, so when step 12 (complete) is executed we can query the store for completed, failed and running items and add them to the response by type. +``` +"summary": { + "asyncFetchedItemsRegistry": { + "running": 0, + "completed": 1, + "failed": 1 + }, + "asyncFetchedItemsSubmodelServer": { + "running": 0, + "completed": 1, + "failed": 1 + } +}, +``` +Tree is stored as list of nodes in list of Relationships as filed `private List relationships;` in `ItemContainer`. +Tree is assebmled in class `ItemTreesAssembler` in method `retrieveItemGraph`. +We should get the depth of the tree and add it to the response. Consider using https://www.geeksforgeeks.org/depth-n-ary-tree/ From 296ce9763c44a8a8349831d1102c998ebbfe6818 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Wed, 31 Jan 2024 12:19:28 +0100 Subject: [PATCH 075/116] chore(irs):[#207] added title --- ...#207-redisign-metrics-used-in-summary-inside-job-response.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md b/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md index 22c32806d4..d060dc208d 100644 --- a/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md +++ b/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md @@ -1,4 +1,4 @@ -# \[Concept\] \[#ID#\] Summary +# \[Concept\] \[#207\] Redesign metrics used in summary inside Job Response | Key | Value | |---------------|-------------------------------------------------------------------------------| From 86b7662683a328cddf3509340aae0b5a1fa6a829 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:27:54 +0100 Subject: [PATCH 076/116] fix(charts): Add missing configuration for discovery oAuthClientId --- charts/irs-helm/templates/configmap-spring-app-config.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index bad14f82a5..7ae30b5866 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -75,6 +75,7 @@ data: shellDescriptorTemplate: {{ .Values.digitalTwinRegistry.shellDescriptorTemplate | default "" | quote }} lookupShellsTemplate: {{ .Values.digitalTwinRegistry.lookupShellsTemplate | default "" | quote }} type: {{ tpl (.Values.digitalTwinRegistry.type | default "") . | quote }} + oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} semanticshub: url: {{ tpl (.Values.semanticshub.url | default "") . | quote }} From a0995eff8401c2613efa2c77c8480e81512c2418 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:28:31 +0100 Subject: [PATCH 077/116] fix(irs-api): Change default oAuthClientId of digitalTwinRegistry to portal --- irs-api/src/main/resources/application.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irs-api/src/main/resources/application.yml b/irs-api/src/main/resources/application.yml index ecf233bb2b..ddd99c4cc5 100644 --- a/irs-api/src/main/resources/application.yml +++ b/irs-api/src/main/resources/application.yml @@ -186,7 +186,7 @@ digitalTwinRegistry: shellLookupEndpoint: ${DIGITALTWINREGISTRY_SHELL_LOOKUP_URL:} # The endpoint to lookup shells from the DTR, must contain the placeholder {assetIds} shellDescriptorTemplate: ${DIGITALTWINREGISTRY_SHELL_DESCRIPTOR_TEMPLATE:/shell-descriptors/{aasIdentifier}} # The path to retrieve AAS descriptors from the decentral DTR, must contain the placeholder {aasIdentifier} lookupShellsTemplate: ${DIGITALTWINREGISTRY_QUERY_SHELLS_PATH:/lookup/shells?assetIds={assetIds}} # The path to lookup shells from the decentral DTR, must contain the placeholder {assetIds} - oAuthClientId: common # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client discoveryFinderUrl: ${DIGITALTWINREGISTRY_DISCOVERY_FINDER_URL:} # The endpoint to discover EDC endpoints to a particular BPN. timeout: read: PT90S # HTTP read timeout for the digital twin registry client From ddb1f2e48d274f2d32a0ad6cfc9b9765b7cf65a4 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:38:36 +0100 Subject: [PATCH 078/116] fix(irs-api): Add separate configuration for discovery finder rest template --- .../irs/configuration/RegistryConfiguration.java | 4 ++-- .../irs/configuration/RestTemplateConfig.java | 6 +++--- irs-api/src/main/resources/application.yml | 11 ++++++----- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java index 7b398b26b0..db7de31bb7 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java @@ -86,14 +86,14 @@ public DecentralDigitalTwinRegistryService decentralDigitalTwinRegistryService( @Bean public ConnectorEndpointsService connectorEndpointsService( @Qualifier(RestTemplateConfig.DTR_REST_TEMPLATE) final RestTemplate dtrRestTemplate, - @Value("${digitalTwinRegistry.discoveryFinderUrl:}") final String finderUrl) { + @Value("${digitalTwinRegistry.discovery.discoveryFinderUrl:}") final String finderUrl) { return new ConnectorEndpointsService(discoveryFinderClient(dtrRestTemplate, finderUrl)); } @Bean public DiscoveryFinderClient discoveryFinderClient( @Qualifier(RestTemplateConfig.DTR_REST_TEMPLATE) final RestTemplate dtrRestTemplate, - @Value("${digitalTwinRegistry.discoveryFinderUrl:}") final String finderUrl) { + @Value("${digitalTwinRegistry.discovery.discoveryFinderUrl:}") final String finderUrl) { return new DiscoveryFinderClientImpl(finderUrl, dtrRestTemplate); } diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java index e8204cb21f..c87c13861f 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java @@ -130,9 +130,9 @@ private static ClientHttpRequestInterceptor getRegistryInterceptor( @Bean(DISCOVERY_REST_TEMPLATE) /* package */ RestTemplate discoveryRestTemplate(final RestTemplateBuilder restTemplateBuilder, - @Value("${ess.discovery.timeout.read}") final Duration readTimeout, - @Value("${ess.discovery.timeout.connect}") final Duration connectTimeout, - @Value("${ess.discovery.oAuthClientId}") final String clientRegistrationId) { + @Value("${digitalTwinRegistry.discovery.timeout.read}") final Duration readTimeout, + @Value("${digitalTwinRegistry.discovery.timeout.connect}") final Duration connectTimeout, + @Value("${digitalTwinRegistry.discovery.oAuthClientId}") final String clientRegistrationId) { return oAuthRestTemplate(restTemplateBuilder, readTimeout, connectTimeout, clientRegistrationId).build(); } diff --git a/irs-api/src/main/resources/application.yml b/irs-api/src/main/resources/application.yml index ddd99c4cc5..6f24e3e3a4 100644 --- a/irs-api/src/main/resources/application.yml +++ b/irs-api/src/main/resources/application.yml @@ -187,10 +187,15 @@ digitalTwinRegistry: shellDescriptorTemplate: ${DIGITALTWINREGISTRY_SHELL_DESCRIPTOR_TEMPLATE:/shell-descriptors/{aasIdentifier}} # The path to retrieve AAS descriptors from the decentral DTR, must contain the placeholder {aasIdentifier} lookupShellsTemplate: ${DIGITALTWINREGISTRY_QUERY_SHELLS_PATH:/lookup/shells?assetIds={assetIds}} # The path to lookup shells from the decentral DTR, must contain the placeholder {assetIds} oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - discoveryFinderUrl: ${DIGITALTWINREGISTRY_DISCOVERY_FINDER_URL:} # The endpoint to discover EDC endpoints to a particular BPN. timeout: read: PT90S # HTTP read timeout for the digital twin registry client connect: PT90S # HTTP connect timeout for the digital twin registry client + discovery: + oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + discoveryFinderUrl: ${DIGITALTWINREGISTRY_DISCOVERY_FINDER_URL:} # The endpoint to discover EDC endpoints to a particular BPN. + timeout: + read: PT90S # HTTP read timeout for the discovery client + connect: PT90S # HTTP connect timeout for the discovery client semanticshub: # The endpoint to retrieve the json schema of a model from the semantic hub. If specified, must contain the placeholder {urn}. @@ -234,10 +239,6 @@ ess: irs: url: "${IRS_URL:}" # IRS Url to connect with discovery: - oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the discovery client - connect: PT90S # HTTP connect timeout for the discovery client mockEdcResult: { } # Mocked BPN Investigation results mockRecursiveEdcAsset: # Mocked BPN Recursive Investigation results From 6a27805aac26e21cabd5edb9bd3a762366bbe1e4 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:39:06 +0100 Subject: [PATCH 079/116] fix(charts): Add missing configuration for discovery finder --- .../irs-helm/templates/configmap-spring-app-config.yaml | 6 ++++-- charts/irs-helm/values.yaml | 8 +++++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index 7ae30b5866..996916c5b4 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -71,11 +71,13 @@ data: digitalTwinRegistry: descriptorEndpoint: {{ tpl (.Values.digitalTwinRegistry.descriptorEndpoint | default "") . | quote }} shellLookupEndpoint: {{ tpl (.Values.digitalTwinRegistry.shellLookupEndpoint | default "") . | quote }} - discoveryFinderUrl: {{ tpl (.Values.digitalTwinRegistry.discoveryFinderUrl | default "") . | quote }} shellDescriptorTemplate: {{ .Values.digitalTwinRegistry.shellDescriptorTemplate | default "" | quote }} lookupShellsTemplate: {{ .Values.digitalTwinRegistry.lookupShellsTemplate | default "" | quote }} type: {{ tpl (.Values.digitalTwinRegistry.type | default "") . | quote }} - oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} + oAuthClientId: {{ .Values.digitalTwinRegistry.oAuthClientId | default "portal" }} + discovery: + oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + discoveryFinderUrl: {{ tpl (.Values.discovery.discoveryFinderUrl | default "") . | quote }} # The endpoint to discover EDC endpoints to a particular BPN. semanticshub: url: {{ tpl (.Values.semanticshub.url | default "") . | quote }} diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml index 9744cd5efd..70b86afa7d 100644 --- a/charts/irs-helm/values.yaml +++ b/charts/irs-helm/values.yaml @@ -127,7 +127,12 @@ digitalTwinRegistry: {{ tpl (.Values.digitalTwinRegistry.url | default "") . }}/lookup/shells?assetIds={assetIds} shellDescriptorTemplate: /shell-descriptors/{aasIdentifier} # The path to retrieve AAS descriptors from the decentral DTR, must contain the placeholder {aasIdentifier} lookupShellsTemplate: /lookup/shells?assetIds={assetIds} # The path to lookup shells from the decentral DTR, must contain the placeholder {assetIds} + oAuthClientId: portal + +discovery: + oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client discoveryFinderUrl: # "https:// + semanticshub: url: # https:// pageSize: "100" # Number of aspect models to retrieve per page @@ -206,9 +211,6 @@ edc: connectorEndpointService: cacheTTL: PT24H # Time to live for ConnectorEndpointService for fetchConnectorEndpoints method cache -discovery: - oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - ess: edc: host: # EDC base URL - used for creation of EDC assets for ESS notifications and as sender EDC for sent notifications From a71499636d50fe589e6e7b074c3e98e32ed35ce8 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:45:41 +0100 Subject: [PATCH 080/116] docs(changelog): update CHANGELOG.md --- CHANGELOG.md | 1 + charts/irs-helm/CHANGELOG.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 458cdcad76..df17e2b84f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" - Changed lookupGlobalAssetIds to lookupShellsByBPN, which provides full object. - Suppressed CVE-2024-20932 from graal-sdk-21.2.0.jar because this is not applicable for IRS. +- Updated configuration of `DISCOVERY_REST_TEMPLATE` from `ess.discovery.*` to `digitalTwinRegistry.discovery.*` and discovery finder URL from `digitalTwinRegistry.discoveryFinderUrl` to `digitalTwinRegistry.discovery.discoveryFinderUrl` ### Fixed - Update to Spring Boot 3.1.8. This fixes the following CVEs: diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md index 28169057dd..a2d8bc3c41 100644 --- a/charts/irs-helm/CHANGELOG.md +++ b/charts/irs-helm/CHANGELOG.md @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Changed +- Changed configuration for discovery finder url from `digitalTwinRegistry.discoveryFinderUrl` to `discovery.discoveryFinderUrl` ## [6.13.0] - 2024-01-15 - Update IRS version to 4.4.0 From 8f36c1d1a3bccfbaa8ea61e6956afcd39d14c717 Mon Sep 17 00:00:00 2001 From: ds-mkanal <100209308+mkanal@users.noreply.github.com> Date: Wed, 31 Jan 2024 12:47:00 +0100 Subject: [PATCH 081/116] Update README.md Co-authored-by: Jaro Hartmann <57985712+ds-jhartmann@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0cfc7d648..ca19faf279 100644 --- a/README.md +++ b/README.md @@ -155,7 +155,7 @@ with any relevant licenses for all software contained within. ## Contact -Contact the project developers via the project's "dev" list. +Contact the Eclipse Tractus-X developers via the developer mailing list. * https://accounts.eclipse.org/mailing-list/tractusx-dev From 8b9bbadae7945140bc662e34895d339467a80cbb Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Wed, 31 Jan 2024 12:55:03 +0100 Subject: [PATCH 082/116] feat(irs):[#249] fixed sonar issues --- .../edc/client/transformer/JsonObjectToPolicyTransformer.java | 2 +- .../client/transformer/JsonObjectToPolicyTransformerTest.java | 2 +- .../tractusx/irs/policystore/models/CreatePolicyRequest.java | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java index 1e991fba8e..7e14e41e82 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformer.java @@ -52,7 +52,7 @@ protected JsonObjectToPolicyTransformer(final ObjectMapper objectMapper) { final Policy.PolicyBuilder builder = Policy.builder(); builder.policyId(getId(jsonObject)); - this.visitProperties(jsonObject, (key) -> v -> { + this.visitProperties(jsonObject, key -> v -> { try { final Object result = objectMapper.readerFor(Policy.class).readValue(v.asJsonObject().toString()); builder.permissions(((Policy) result).getPermissions()); diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java index 78072ee29b..1ffb52c740 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/transformer/JsonObjectToPolicyTransformerTest.java @@ -89,7 +89,7 @@ public void setUp() { } @Test - public void shouldTransformJsonObjectToPolicyCorrectly() { + void shouldTransformJsonObjectToPolicyCorrectly() { // given JsonReader jsonReader = Json.createReader(new StringReader(EXAMPLE_PAYLOAD)); JsonObject jsonObject = jsonReader.readObject(); diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java index 3f233547f2..e22bf61753 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java @@ -37,6 +37,7 @@ public record CreatePolicyRequest( @NotNull @Schema(description = "Timestamp after which the policy will no longer be accepted in negotiations") OffsetDateTime validUntil, @NotNull @Schema(example = CreatePolicyRequest.EXAMPLE_PAYLOAD) JsonObject payload) { + @SuppressWarnings("java:S2479") // this value is used by open-api to show example payload, \u0009 character is required for this value to be correctly shown in open-api public static final String EXAMPLE_PAYLOAD = """ { "validUntil": "2025-12-12T23:59:59.999Z", From 171ca9358e70d42815c802fe06f97a6e36713772 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:55:48 +0100 Subject: [PATCH 083/116] fix(charts): Fix config map structure --- charts/irs-helm/templates/configmap-spring-app-config.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index 996916c5b4..3087d05457 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -75,9 +75,9 @@ data: lookupShellsTemplate: {{ .Values.digitalTwinRegistry.lookupShellsTemplate | default "" | quote }} type: {{ tpl (.Values.digitalTwinRegistry.type | default "") . | quote }} oAuthClientId: {{ .Values.digitalTwinRegistry.oAuthClientId | default "portal" }} - discovery: - oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - discoveryFinderUrl: {{ tpl (.Values.discovery.discoveryFinderUrl | default "") . | quote }} # The endpoint to discover EDC endpoints to a particular BPN. + discovery: + oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + discoveryFinderUrl: {{ tpl (.Values.discovery.discoveryFinderUrl | default "") . | quote }} # The endpoint to discover EDC endpoints to a particular BPN. semanticshub: url: {{ tpl (.Values.semanticshub.url | default "") . | quote }} From 565103e46a99a7025ccbc60794913312e442ea6f Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Wed, 31 Jan 2024 12:59:07 +0100 Subject: [PATCH 084/116] fix(irs-api): Change bean name to @Bean(name) instead of @Qualifier(name) --- .../tractusx/irs/configuration/RestTemplateConfig.java | 2 -- .../irs/edc/client/configuration/JsonLdConfiguration.java | 5 ++--- .../tractusx/irs/edc/client/transformer/EdcTransformer.java | 4 +++- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java index c87c13861f..f2d96ce10f 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java @@ -36,7 +36,6 @@ import org.eclipse.edc.policy.model.PolicyRegistrationTypes; import org.eclipse.tractusx.irs.common.OutboundMeterRegistryService; import org.jetbrains.annotations.NotNull; -import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.context.annotation.Bean; @@ -173,7 +172,6 @@ public boolean hasError(final ClientHttpResponse statusCode) { } @Bean(EDC_REST_TEMPLATE) - @Qualifier(EDC_REST_TEMPLATE) /* package */ RestTemplate edcRestTemplate(final RestTemplateBuilder restTemplateBuilder, @Value("${irs-edc-client.submodel.timeout.read}") final Duration readTimeout, @Value("${irs-edc-client.submodel.timeout.connect}") final Duration connectTimeout, diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java index 4508e33068..f4684299eb 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java @@ -34,7 +34,6 @@ import org.eclipse.edc.policy.model.LiteralExpression; import org.eclipse.edc.spi.monitor.ConsoleMonitor; import org.eclipse.edc.spi.monitor.Monitor; -import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -53,6 +52,7 @@ public class JsonLdConfiguration { public static final String NAMESPACE_EDC_ID = NAMESPACE_EDC + "id"; public static final String NAMESPACE_TRACTUSX = "https://w3id.org/tractusx/v0.0.1/ns/"; public static final String NAMESPACE_DCT = "https://purl.org/dc/terms/"; + public static final String JSON_LD_OBJECT_MAPPER = "jsonLdObjectMapper"; @Bean /* package */ TitaniumJsonLd titaniumJsonLd(final Monitor monitor) { final TitaniumJsonLd titaniumJsonLd = new TitaniumJsonLd(monitor); @@ -69,8 +69,7 @@ public class JsonLdConfiguration { return new ConsoleMonitor(); } - @Bean - @Qualifier("jsonLdObjectMapper") + @Bean(JSON_LD_OBJECT_MAPPER) /* package */ ObjectMapper objectMapper() { final ObjectMapper objectMapper = new ObjectMapper(); objectMapper.registerModule(new JavaTimeModule()); diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java index 8e25830fe0..df76b27ae1 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java @@ -23,6 +23,8 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client.transformer; +import static org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration.JSON_LD_OBJECT_MAPPER; + import java.io.ByteArrayInputStream; import java.nio.charset.Charset; import java.util.Map; @@ -84,7 +86,7 @@ public class EdcTransformer { private final TitaniumJsonLd titaniumJsonLd; private final TransformerContextImpl transformerContext; - public EdcTransformer(@Qualifier("jsonLdObjectMapper") final ObjectMapper objectMapper, + public EdcTransformer(@Qualifier(JSON_LD_OBJECT_MAPPER) final ObjectMapper objectMapper, final TitaniumJsonLd titaniumJsonLd) { this.titaniumJsonLd = titaniumJsonLd; final JsonBuilderFactory jsonBuilderFactory = Json.createBuilderFactory(Map.of()); From a6e4288e1c03f29952c514a8990e71cf754a706a Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Wed, 31 Jan 2024 13:07:27 +0100 Subject: [PATCH 085/116] feat(imp):[#214] Cleanup --- .../decentral/DecentralDigitalTwinRegistryService.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 29a74348a5..9e59b9b43f 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -273,7 +273,7 @@ private Collection lookupShellIds(final String bpn) throws RegistryServi } catch (RuntimeException e) { // catching generic exception is intended here, // otherwise Jobs stay in state RUNNING forever - log.error(logPrefix + e.getMessage(), e); // TODO (mfischer) #214 do not log and throw + log.error(logPrefix + e.getMessage(), e); final var msg = logPrefix + e.getClass().getSimpleName() + " occurred while looking up shell ids for bpn '%s'".formatted(bpn); throw new RegistryServiceException(msg, e); @@ -298,12 +298,12 @@ private Collection lookupShellIds(final String bpn, } catch (InterruptedException e) { log.error(logPrefix + "InterruptedException occurred while looking up shells ids for bpn '%s': ".formatted( - bpn) + e.getMessage(), e); // #214 do not log and throw + bpn) + e.getMessage(), e); Thread.currentThread().interrupt(); throw new RegistryServiceException(LOGPREFIX_TO_BE_REMOVED_LATER + e.getClass().getSimpleName() + " occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } catch (ExecutionException e) { - log.error(logPrefix + e.getMessage(), e); // TODO (mfischer) #214 do not log and throw + log.error(logPrefix + e.getMessage(), e); throw new RegistryServiceException(LOGPREFIX_TO_BE_REMOVED_LATER + e.getClass().getSimpleName() + " occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); } From bbc1464924cd9fd5d915ed8d103c48a80e65d777 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Wed, 31 Jan 2024 13:22:47 +0100 Subject: [PATCH 086/116] feat(irs):[#249] pmd fix --- .../tractusx/irs/policystore/models/CreatePolicyRequest.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java index e22bf61753..06fbee3f36 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/CreatePolicyRequest.java @@ -37,7 +37,10 @@ public record CreatePolicyRequest( @NotNull @Schema(description = "Timestamp after which the policy will no longer be accepted in negotiations") OffsetDateTime validUntil, @NotNull @Schema(example = CreatePolicyRequest.EXAMPLE_PAYLOAD) JsonObject payload) { - @SuppressWarnings("java:S2479") // this value is used by open-api to show example payload, \u0009 character is required for this value to be correctly shown in open-api + + @SuppressWarnings("java:S2479") + // this value is used by open-api to show example payload + // \u0009 character is required for this value to be correctly shown in open-api public static final String EXAMPLE_PAYLOAD = """ { "validUntil": "2025-12-12T23:59:59.999Z", From dceda1f85f4cfefb099e133bf1a7f213e97fb11b Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 31 Jan 2024 15:07:18 +0100 Subject: [PATCH 087/116] feat(impl):[#370] add unit test --- .../job/delegate/DigitalTwinDelegateTest.java | 19 +++++++++++++++++++ .../eclipse/tractusx/irs/util/TestMother.java | 12 ++++++++++++ 2 files changed, 31 insertions(+) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java index 410da33597..7a33d5c224 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegateTest.java @@ -25,6 +25,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.util.TestMother.jobParameter; +import static org.eclipse.tractusx.irs.util.TestMother.jobParameterAuditContractNegotiation; import static org.eclipse.tractusx.irs.util.TestMother.shell; import static org.eclipse.tractusx.irs.util.TestMother.shellDescriptor; import static org.eclipse.tractusx.irs.util.TestMother.submodelDescriptorWithoutHref; @@ -64,6 +65,24 @@ void shouldFillItemContainerWithShell() throws RegistryServiceException { assertThat(result).isNotNull(); assertThat(result.getShells()).isNotEmpty(); assertThat(result.getShells().get(0).payload().getSubmodelDescriptors()).isNotEmpty(); + assertThat(result.getShells().get(0).contractAgreementId()).isNull(); + } + + @Test + void shouldFillItemContainerWithShellAndContractAgreementIdWhenAuditFlag() throws RegistryServiceException { + // given + when(digitalTwinRegistryService.fetchShells(any())).thenReturn( + List.of(shell("", shellDescriptor(List.of(submodelDescriptorWithoutHref("any")))))); + + // when + final ItemContainer result = digitalTwinDelegate.process(ItemContainer.builder(), jobParameterAuditContractNegotiation(), + new AASTransferProcess("id", 0), createKey()); + + // then + assertThat(result).isNotNull(); + assertThat(result.getShells()).isNotEmpty(); + assertThat(result.getShells().get(0).payload().getSubmodelDescriptors()).isNotEmpty(); + assertThat(result.getShells().get(0).contractAgreementId()).isNotNull(); } @Test diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java index a75ae4bf88..9d9ac34dee 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/util/TestMother.java @@ -155,6 +155,7 @@ public static JobParameter jobParameter() { .direction(Direction.DOWNWARD) .aspects(List.of(AspectType.SERIAL_PART.toString(), AspectType.SINGLE_LEVEL_BOM_AS_BUILT.toString())) + .auditContractNegotiation(false) .build(); } @@ -197,6 +198,17 @@ public static JobParameter jobParameterCollectBpns() { .build(); } + public static JobParameter jobParameterAuditContractNegotiation() { + return JobParameter.builder() + .depth(5) + .bomLifecycle(BomLifecycle.AS_BUILT) + .direction(Direction.DOWNWARD) + .aspects(List.of(AspectType.SERIAL_PART.toString(), + AspectType.SINGLE_LEVEL_BOM_AS_BUILT.toString())) + .auditContractNegotiation(true) + .build(); + } + public static MeterRegistryService simpleMeterRegistryService() { return new MeterRegistryService(new SimpleMeterRegistry()); } From 7b2b9b4c5dbbdb8375c9d4e9c47bc87bdf3874e3 Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 31 Jan 2024 15:57:30 +0100 Subject: [PATCH 088/116] feat(impl):[#370] try report aggregate --- .../irs/aaswrapper/job/delegate/SubmodelDelegateTest.java | 1 + pom.xml | 1 + 2 files changed, 2 insertions(+) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java index b699283080..0578826baa 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java @@ -192,6 +192,7 @@ void shouldRequestForAllEndpoints() throws EdcClientException, InvalidSchemaExce assertThat(result.getSubmodels()).hasSize(1); assertThat(result.getSubmodels().get(0).getAspectType()).isEqualTo( "urn:bamm:com.catenax.serial_part:1.0.0#SerialPart"); + assertThat(result.getSubmodels().get(0).getContractAgreementId()).isNull(); assertThat(result.getTombstones()).isEmpty(); } diff --git a/pom.xml b/pom.xml index 2e47b76a2d..732f85c498 100644 --- a/pom.xml +++ b/pom.xml @@ -270,6 +270,7 @@ test report + report-aggregate From 622ea73b6d07f9c17ecb7a75f2181d3af4c7a993 Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 31 Jan 2024 16:26:35 +0100 Subject: [PATCH 089/116] feat(impl):[#370] catch UsagePolicyExc in RelationshipDelegate --- .../job/delegate/RelationshipDelegate.java | 10 ++++-- .../delegate/RelationshipDelegateTest.java | 33 ++++++++++++++++--- .../job/delegate/SubmodelDelegateTest.java | 8 ++--- 3 files changed, 41 insertions(+), 10 deletions(-) diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java index 68c4f32ee4..231b6d5b31 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java @@ -42,6 +42,7 @@ import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.RelationshipAspect; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.exceptions.UsagePolicyException; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.util.JsonUtil; @@ -112,17 +113,22 @@ private void processEndpoint(final Endpoint endpoint, final RelationshipAspect r aasTransferProcess.addIdsToProcess(idsToProcess); itemContainerBuilder.relationships(relationships); itemContainerBuilder.bpns(getBpnsFrom(relationships)); + } catch (final UsagePolicyException e) { + log.info("Encountered usage policy exception: {}. Creating Tombstone.", e.getMessage()); + itemContainerBuilder.tombstone( + Tombstone.from(itemId.getGlobalAssetId(), endpoint.getProtocolInformation().getHref(), e, + 0, ProcessStep.USAGE_POLICY_VALIDATION, jsonUtil.asMap(e.getPolicy()))); } catch (final EdcClientException e) { log.info("Submodel Endpoint could not be retrieved for Endpoint: {}. Creating Tombstone.", endpoint.getProtocolInformation().getHref()); itemContainerBuilder.tombstone( Tombstone.from(itemId.getGlobalAssetId(), endpoint.getProtocolInformation().getHref(), e, - retryCount, ProcessStep.SUBMODEL_REQUEST)); + 0, ProcessStep.SUBMODEL_REQUEST)); } catch (final JsonParseException e) { log.info("Submodel payload did not match the expected AspectType. Creating Tombstone."); itemContainerBuilder.tombstone( Tombstone.from(itemId.getGlobalAssetId(), endpoint.getProtocolInformation().getHref(), e, - retryCount, ProcessStep.SUBMODEL_REQUEST)); + 0, ProcessStep.SUBMODEL_REQUEST)); } } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java index cb49659bb2..3b060bd29e 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegateTest.java @@ -25,6 +25,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.eclipse.tractusx.irs.util.TestMother.jobParameter; +import static org.eclipse.tractusx.irs.util.TestMother.jobParameterCollectAspects; import static org.eclipse.tractusx.irs.util.TestMother.jobParameterUpward; import static org.eclipse.tractusx.irs.util.TestMother.shell; import static org.eclipse.tractusx.irs.util.TestMother.shellDescriptor; @@ -47,6 +48,7 @@ import org.eclipse.tractusx.irs.component.enums.ProcessStep; import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade; import org.eclipse.tractusx.irs.edc.client.exceptions.EdcClientException; +import org.eclipse.tractusx.irs.edc.client.exceptions.UsagePolicyException; import org.eclipse.tractusx.irs.edc.client.model.SubmodelDescriptor; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.util.JsonUtil; @@ -63,10 +65,6 @@ class RelationshipDelegateTest { final String singleLevelBomAsBuiltAspectName = "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt"; final String singleLevelUsageAsBuiltAspectName = "urn:bamm:io.catenax.single_level_usage_as_built:2.0.0#SingleLevelUsageAsBuilt"; - private static PartChainIdentificationKey createKey() { - return PartChainIdentificationKey.builder().globalAssetId("itemId").bpn("bpn123").build(); - } - @Test void shouldFillItemContainerWithRelationshipAndAddChildIdsToProcess() throws EdcClientException, URISyntaxException, IOException { @@ -190,4 +188,31 @@ void shouldCatchJsonParseExceptionAndPutTombstone() throws EdcClientException { ProcessStep.SUBMODEL_REQUEST); } + @Test + void shouldCatchUsagePolicyExceptionAndPutTombstone() throws EdcClientException { + // given + final ItemContainer.ItemContainerBuilder itemContainerWithShell = ItemContainer.builder() + .shell(shell("", shellDescriptor( + List.of(submodelDescriptorWithDspEndpoint( + singleLevelBomAsBuiltAspectName, + "address"))))); + + // when + when(submodelFacade.getSubmodelPayload(any(), any(), any())).thenThrow(new UsagePolicyException("itemId", null)); + when(connectorEndpointsService.fetchConnectorEndpoints(any())).thenReturn(List.of("connector.endpoint.nl")); + final ItemContainer result = relationshipDelegate.process(itemContainerWithShell, jobParameter(), + new AASTransferProcess(), createKey()); + + // then + assertThat(result).isNotNull(); + assertThat(result.getTombstones()).hasSize(1); + assertThat(result.getTombstones().get(0).getCatenaXId()).isEqualTo("itemId"); + assertThat(result.getTombstones().get(0).getProcessingError().getProcessStep()).isEqualTo( + ProcessStep.USAGE_POLICY_VALIDATION); + } + + private static PartChainIdentificationKey createKey() { + return PartChainIdentificationKey.builder().globalAssetId("itemId").bpn("bpn123").build(); + } + } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java index 0578826baa..312113d974 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/SubmodelDelegateTest.java @@ -65,10 +65,6 @@ class SubmodelDelegateTest { final SubmodelDelegate submodelDelegate = new SubmodelDelegate(submodelFacade, semanticsHubFacade, jsonValidatorService, new JsonUtil(), connectorEndpointsService); - private static PartChainIdentificationKey createKey() { - return PartChainIdentificationKey.builder().globalAssetId("itemId").bpn("bpn123").build(); - } - @Test void shouldFilterSubmodelDescriptorsByAspectTypeFilter() { // given @@ -222,4 +218,8 @@ void shouldCatchRestClientExceptionAndPutTombstone() throws SchemaNotFoundExcept ProcessStep.SCHEMA_REQUEST); } + private static PartChainIdentificationKey createKey() { + return PartChainIdentificationKey.builder().globalAssetId("itemId").bpn("bpn123").build(); + } + } From 5c5d5c80432f6c1894df288a740e6ed9901dcda3 Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 31 Jan 2024 16:26:46 +0100 Subject: [PATCH 090/116] feat(impl):[#370] catch UsagePolicyExc in RelationshipDelegate --- pom.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/pom.xml b/pom.xml index 732f85c498..2e47b76a2d 100644 --- a/pom.xml +++ b/pom.xml @@ -270,7 +270,6 @@ test report - report-aggregate From cb86a95e98379f3c501f7b7f2ec37960f443570f Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 1 Feb 2024 00:40:41 +0100 Subject: [PATCH 091/116] feat(imp):[#214] Update glossary --- docs/src/docs/arc42/glossary.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/docs/arc42/glossary.adoc b/docs/src/docs/arc42/glossary.adoc index 68eb016e89..5cfa9e203b 100644 --- a/docs/src/docs/arc42/glossary.adoc +++ b/docs/src/docs/arc42/glossary.adoc @@ -6,22 +6,22 @@ |AAS | Asset Administration Shell (Industry 4.0) |Aspect servers (submodel endpoints) |Companies participating in the interorganizational data exchange provides their data over aspect servers. The so called "submodel-descriptors" in the AAS shells are pointing to these AspectServers which provide the data-assets of the participating these companies in Catena-X. -|BoM |Bill of Materials +|Bill of Materials (BoM) |A Bill of Materials is a comprehensive list of materials, components, sub-assemblies, and the quantities of each needed to manufacture or build a product. It serves as a structured document that provides information about the raw materials, parts, and components required for the production process. |BPN | Business Partner Number +|Data Space|Data Spaces are the key concept for a large-scale, cross-border data economy. This is also the vision of the Gaia-X initiative for a data infrastructure in Europe. The International Data Space Association (IDSA) contributes significantly to this with the architectural model, interfaces, and standards. |DT | Digital Twin -|DTR | Digital Twin Registry. The Digital Twin Registry is the central registry which lists all digital twins and references their aspects including information about the underlying asset, asset manufacturer, and access options (e.g. aspect endpoints). -|EDC | Eclipse Dataspace Connector +|DTR | Digital Twin Registry. The Digital Twin Registry is a registry which lists all digital twins and references their aspects including information about the underlying asset, asset manufacturer, and access options (e.g. aspect endpoints). +|Eclipse Dataspace Connector (EDC) | The Eclipse Data Space Connector (EDC) is a standard and policy-compliant connector that can be used within the scope of Catena-X, but also more generally as a connector for Data Spaces. It is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as administration layer and has responsibility of resource management, contract negotiation and administer data transfer. The Data-Plane does the heavy lifting of transferring and receiving data streams. For more information see: https://github.com/eclipse-edc/Connector, https://github.com/eclipse-tractusx/tractusx-edc |Edge |see Traversal Aspect |IRS |Item Relationship Service |Item Graph |The result returned via the IRS. This corresponds to a tree structure in which each node represents a part of a virtual asset. -|MIW | Managed Identity Wallet +|MIW | The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) readiness by providing a wallet hosting platform including a decentralized identifier (DID) resolver, service endpoints and the company wallets itself. For more information see: https://github.com/catenax-ng/tx-managed-identity-wallets |MTPDC |Formerly known Service Name: Multi Tier Parts Data Chain |PRS |Formerly known Service Name: Parts Relationship Service |Traversal Aspect |aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship. Samples: SingleLevelBomAsPlanned, SingleLevelBomAsBuilt and SingleLevelUsageAsBuilt |Verifiable Credential (VC) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2/3.%20Verifiable%20Credentials[Verifiable Credentials] -|Eclipse Dataspace Connector (EDC) | For more information see: https://github.com/eclipse-tractusx/tractusx-edc |Managed Identity Wallet (MIW) | For more information see: https://github.com/eclipse-tractusx/managed-identity-wallet |Self-Sovereign Identity (SSI) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2 |PolicyStore | The Policy Store is an IRS component which provides an interface for getting, adding and deleting accepted IRS EDC policies. These policies will be used to validate EDC contract offers. EDC contract offers must include permissions that are equal to permission defined by an admin user in order to be allowed to use in IRS use cases. For more information see: https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#0-introduction From 5a0280326adfaa7293becc8fecac1b324db8e504 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 1 Feb 2024 00:45:46 +0100 Subject: [PATCH 092/116] feat(imp):[#214] Improve glossary This commit corrects the glossary sort order and adds some missing definitions, explanations and links. --- docs/src/docs/arc42/glossary.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/docs/arc42/glossary.adoc b/docs/src/docs/arc42/glossary.adoc index 5cfa9e203b..a60326ddbd 100644 --- a/docs/src/docs/arc42/glossary.adoc +++ b/docs/src/docs/arc42/glossary.adoc @@ -15,14 +15,14 @@ |Edge |see Traversal Aspect |IRS |Item Relationship Service |Item Graph |The result returned via the IRS. This corresponds to a tree structure in which each node represents a part of a virtual asset. +|Managed Identity Wallet (MIW) | For more information see: https://github.com/eclipse-tractusx/managed-identity-wallet |MIW | The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) readiness by providing a wallet hosting platform including a decentralized identifier (DID) resolver, service endpoints and the company wallets itself. For more information see: https://github.com/catenax-ng/tx-managed-identity-wallets |MTPDC |Formerly known Service Name: Multi Tier Parts Data Chain +|PolicyStore | The Policy Store is an IRS component which provides an interface for getting, adding and deleting accepted IRS EDC policies. These policies will be used to validate EDC contract offers. EDC contract offers must include permissions that are equal to permission defined by an admin user in order to be allowed to use in IRS use cases. For more information see: https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#0-introduction |PRS |Formerly known Service Name: Parts Relationship Service +|Self-Sovereign Identity (SSI) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2 |Traversal Aspect |aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship. Samples: SingleLevelBomAsPlanned, SingleLevelBomAsBuilt and SingleLevelUsageAsBuilt |Verifiable Credential (VC) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2/3.%20Verifiable%20Credentials[Verifiable Credentials] -|Managed Identity Wallet (MIW) | For more information see: https://github.com/eclipse-tractusx/managed-identity-wallet -|Self-Sovereign Identity (SSI) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2 -|PolicyStore | The Policy Store is an IRS component which provides an interface for getting, adding and deleting accepted IRS EDC policies. These policies will be used to validate EDC contract offers. EDC contract offers must include permissions that are equal to permission defined by an admin user in order to be allowed to use in IRS use cases. For more information see: https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#0-introduction |=== \ No newline at end of file From 806dedbdb4a45354548eccfccff783adf3935c1c Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 1 Feb 2024 03:38:42 +0100 Subject: [PATCH 093/116] feat(imp):[#214] Move logging to business classes and remove some debug infos Moved logging from helper class to business class because this way the log entry shows the business class and not the helper class. --- .../util/concurrent/StopwatchUtils.java | 52 ------------------ .../DecentralDigitalTwinRegistryService.java | 54 ++++++++++++------- .../EndpointDataForConnectorsService.java | 23 ++++---- 3 files changed, 48 insertions(+), 81 deletions(-) delete mode 100644 irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java deleted file mode 100644 index 2c02d897b2..0000000000 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/StopwatchUtils.java +++ /dev/null @@ -1,52 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.common.util.concurrent; - -import org.apache.commons.lang3.StringUtils; -import org.slf4j.Logger; -import org.springframework.util.StopWatch; - -/** - * Utilities for stop watches. - */ -public final class StopwatchUtils { - - /** - * utility class, therefore private constructor - */ - private StopwatchUtils() { - super(); - } - - public static void startWatch(final Logger log, final StopWatch stopWatch, final String msg) { - stopWatch.start(msg); - log.info(msg); - } - - public static void stopWatch(final Logger log, final StopWatch stopWatch) { - stopWatch(log, stopWatch, ""); - } - - public static void stopWatch(final Logger log, final StopWatch stopWatch, final String messagePrefix) { - stopWatch.stop(); - final String prefix = StringUtils.isNotBlank(messagePrefix) ? messagePrefix + " - " : ""; - log.info("{}{} took {} ms", prefix, stopWatch.getLastTaskName(), stopWatch.getLastTaskTimeMillis()); - } -} diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index 9e59b9b43f..eebf9836fc 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -39,7 +39,6 @@ import lombok.extern.slf4j.Slf4j; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder; -import org.eclipse.tractusx.irs.common.util.concurrent.StopwatchUtils; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.component.assetadministrationshell.IdentifierKeyValuePair; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; @@ -85,8 +84,9 @@ public Collection fetchShells(final Collecti throws RegistryServiceException { final var watch = new StopWatch(); - StopwatchUtils.startWatch(log, watch, - LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching shell(s) for %s key(s)".formatted(keys.size())); + final String msg = LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching shell(s) for %s key(s)".formatted(keys.size()); + watch.start(msg); + log.info(msg); try { final var calledEndpoints = new HashSet(); @@ -114,7 +114,8 @@ public Collection fetchShells(final Collecti } } finally { - StopwatchUtils.stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -141,8 +142,10 @@ private CompletableFuture> fetchShellDe final Set calledEndpoints, final String bpn, final List keys) { final var watch = new StopWatch(); - StopwatchUtils.startWatch(log, watch, - LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching %s shells for bpn '%s'".formatted(keys.size(), bpn)); + final String msg = + LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching %s shells for bpn '%s'".formatted(keys.size(), bpn); + watch.start(msg); + log.info(msg); try { final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); @@ -154,7 +157,8 @@ private CompletableFuture> fetchShellDe return fetchShellDescriptorsForConnectorEndpoints(keys, connectorEndpoints); } finally { - StopwatchUtils.stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -181,13 +185,15 @@ private List fetchShellDescriptorsForKey( final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptorsForKey - "; final var watch = new StopWatch(); - StopwatchUtils.startWatch(log, watch, - logPrefix + "Fetching shell descriptors for keys %s from endpoint '%s'".formatted(keys, - endpointDataReference.getEndpoint())); + final String msg = logPrefix + "Fetching shell descriptors for keys %s from endpoint '%s'".formatted(keys, + endpointDataReference.getEndpoint()); + watch.start(msg); + log.info(msg); try { return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); } finally { - StopwatchUtils.stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -197,14 +203,16 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptor - "; final var watch = new StopWatch(); - StopwatchUtils.startWatch(log, watch, - logPrefix + "Retrieving AAS identification for DigitalTwinRegistryKey: '%s'".formatted(key)); + final String msg = logPrefix + "Retrieving AAS identification for DigitalTwinRegistryKey: '%s'".formatted(key); + watch.start(msg); + log.info(msg); try { final String aaShellIdentification = mapToShellId(endpointDataReference, key.shellId()); return decentralDigitalTwinRegistryClient.getAssetAdministrationShellDescriptor(endpointDataReference, aaShellIdentification); } finally { - StopwatchUtils.stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -223,8 +231,10 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "mapToShellId - "; final var watch = new StopWatch(); - StopwatchUtils.startWatch(log, watch, logPrefix + "Mapping '%s' to shell ID for endpoint '%s'".formatted(key, - endpointDataReference.getEndpoint())); + final String msg = logPrefix + "Mapping '%s' to shell ID for endpoint '%s'".formatted(key, + endpointDataReference.getEndpoint()); + watch.start(msg); + log.info(msg); try { @@ -248,7 +258,8 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f return aaShellIdentification; } finally { - StopwatchUtils.stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -313,16 +324,19 @@ private Collection lookupShellIds(final String bpn, final EndpointDataRe final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; final var watch = new StopWatch(); - StopwatchUtils.startWatch(log, watch, + final String msg = logPrefix + "Looking up shell IDs for bpn '%s' with endpointDataReference '%s'".formatted(bpn, - endpointDataReference)); + endpointDataReference); + watch.start(msg); + log.info(msg); try { return decentralDigitalTwinRegistryClient.getAllAssetAdministrationShellIdsByAssetLink( endpointDataReference, List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); } finally { - StopwatchUtils.stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index e9262c6820..b11c8b312e 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -25,8 +25,6 @@ import static java.util.concurrent.CompletableFuture.supplyAsync; import static org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder.LOGPREFIX_TO_BE_REMOVED_LATER; -import static org.eclipse.tractusx.irs.common.util.concurrent.StopwatchUtils.startWatch; -import static org.eclipse.tractusx.irs.common.util.concurrent.StopwatchUtils.stopWatch; import java.util.Collections; import java.util.List; @@ -54,19 +52,23 @@ public class EndpointDataForConnectorsService { public List> createFindEndpointDataForConnectorsFutures( final List connectorEndpoints) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "createFindEndpointDataForConnectorsFutures - "; + final var watch = new StopWatch(); + final String msg = "Creating futures to get EndpointDataReferences for endpoints: %s".formatted( + connectorEndpoints); + watch.start(msg); + log.info(msg); List> futures = Collections.emptyList(); try { - log.info(logPrefix + "Creating futures to get EndpointDataReferences for endpoints: {}", - connectorEndpoints); futures = connectorEndpoints.stream() .map(connectorEndpoint -> supplyAsync( () -> getEndpointReferenceForAsset(connectorEndpoint))) .toList(); return futures; } finally { - log.info(logPrefix + "Created {} futures", futures.size()); + log.info("Created {} futures", futures.size()); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -75,8 +77,10 @@ private EndpointDataReference getEndpointReferenceForAsset(final String connecto final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "getEndpointReferenceForAsset - "; final var watch = new StopWatch(); - startWatch(log, watch, - logPrefix + "Trying to retrieve EndpointDataReference for connector '%s'".formatted(connector)); + final String msg = + logPrefix + "Trying to retrieve EndpointDataReference for connector '%s'".formatted(connector); + watch.start(msg); + log.info(msg); try { return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, @@ -86,7 +90,8 @@ private EndpointDataReference getEndpointReferenceForAsset(final String connecto connector, e); throw new CompletionException(e.getMessage(), e); } finally { - stopWatch(log, watch); + watch.stop(); + log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } From f94838ec2d66af17bc78bc3ef232ba921b15c03a Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 1 Feb 2024 05:06:34 +0100 Subject: [PATCH 094/116] feat(imp):[#214] fix MD034 linting errors --- docs/src/docs/arc42/glossary.adoc | 33 +++++++++++++++++++------------ 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/docs/src/docs/arc42/glossary.adoc b/docs/src/docs/arc42/glossary.adoc index a60326ddbd..dbdb67a492 100644 --- a/docs/src/docs/arc42/glossary.adoc +++ b/docs/src/docs/arc42/glossary.adoc @@ -4,25 +4,32 @@ |Term |Description |AAS | Asset Administration Shell (Industry 4.0) -|Aspect servers (submodel endpoints) -|Companies participating in the interorganizational data exchange provides their data over aspect servers. The so called "submodel-descriptors" in the AAS shells are pointing to these AspectServers which provide the data-assets of the participating these companies in Catena-X. -|Bill of Materials (BoM) |A Bill of Materials is a comprehensive list of materials, components, sub-assemblies, and the quantities of each needed to manufacture or build a product. It serves as a structured document that provides information about the raw materials, parts, and components required for the production process. +|Aspect servers (submodel endpoints) | Companies participating in the interorganizational data exchange provides their data over aspect servers. The so called "submodel-descriptors" in the AAS shells are pointing to these AspectServers which provide the data-assets of the participating these companies in Catena-X. +|Bill of Materials (BoM) | A Bill of Materials is a comprehensive list of materials, components, sub-assemblies, and the quantities of each needed to manufacture or build a product. It serves as a structured document that provides information about the raw materials, parts, and components required for the production process. |BPN | Business Partner Number |Data Space|Data Spaces are the key concept for a large-scale, cross-border data economy. This is also the vision of the Gaia-X initiative for a data infrastructure in Europe. The International Data Space Association (IDSA) contributes significantly to this with the architectural model, interfaces, and standards. |DT | Digital Twin |DTR | Digital Twin Registry. The Digital Twin Registry is a registry which lists all digital twins and references their aspects including information about the underlying asset, asset manufacturer, and access options (e.g. aspect endpoints). -|Eclipse Dataspace Connector (EDC) | The Eclipse Data Space Connector (EDC) is a standard and policy-compliant connector that can be used within the scope of Catena-X, but also more generally as a connector for Data Spaces. It is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as administration layer and has responsibility of resource management, contract negotiation and administer data transfer. The Data-Plane does the heavy lifting of transferring and receiving data streams. For more information see: https://github.com/eclipse-edc/Connector, https://github.com/eclipse-tractusx/tractusx-edc -|Edge |see Traversal Aspect -|IRS |Item Relationship Service +|Eclipse Dataspace Connector (EDC) | The Eclipse Data Space Connector (EDC) is a standard and policy-compliant connector that can be used within the scope of Catena-X, but also more generally as a connector for Data Spaces. It is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as administration layer and has responsibility of resource management, contract negotiation and administer data transfer. The Data-Plane does the heavy lifting of transferring and receiving data streams. For more information see: +https://github.com/eclipse-edc/Connector[EDC Connector] , https://github.com/eclipse-tractusx/tractusx-edc[Tractus-X EDC (Eclipse Dataspace Connector)] +|Edge | see Traversal Aspect +|IRS | Item Relationship Service |Item Graph |The result returned via the IRS. This corresponds to a tree structure in which each node represents a part of a virtual asset. -|Managed Identity Wallet (MIW) | For more information see: https://github.com/eclipse-tractusx/managed-identity-wallet -|MIW | The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) readiness by providing a wallet hosting platform including a decentralized identifier (DID) resolver, service endpoints and the company wallets itself. For more information see: https://github.com/catenax-ng/tx-managed-identity-wallets -|MTPDC |Formerly known Service Name: Multi Tier Parts Data Chain -|PolicyStore | The Policy Store is an IRS component which provides an interface for getting, adding and deleting accepted IRS EDC policies. These policies will be used to validate EDC contract offers. EDC contract offers must include permissions that are equal to permission defined by an admin user in order to be allowed to use in IRS use cases. For more information see: https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#0-introduction -|PRS |Formerly known Service Name: Parts Relationship Service -|Self-Sovereign Identity (SSI) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2 +|Managed Identity Wallet (MIW) +| The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) readiness by providing a wallet hosting platform including a decentralized identifier (DID) resolver, service endpoints and the company wallets itself. +For more information see: +https://github.com/eclipse-tractusx/managed-identity-wallet[eclipse-tractusx/managed-identity-wallet] , https://github.com/catenax-ng/tx-managed-identity-wallets[catenax-ng/tx-managed-identity-wallets] +|MTPDC | Formerly known Service Name: Multi Tier Parts Data Chain +|PolicyStore +| The Policy Store is an IRS component which provides an interface for getting, adding and deleting accepted IRS EDC policies. These policies will be used to validate EDC contract offers. EDC contract offers must include permissions that are equal to permission defined by an admin user in order to be allowed to use in IRS use cases. +For more information see: +https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#0-introduction[Policy specification for Catena-X verifiable credentials] +|PRS | Formerly known Service Name: Parts Relationship Service +|Self-Sovereign Identity (SSI) +| For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2[ssi-docu] |Traversal Aspect |aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship. Samples: SingleLevelBomAsPlanned, SingleLevelBomAsBuilt and SingleLevelUsageAsBuilt -|Verifiable Credential (VC) | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2/3.%20Verifiable%20Credentials[Verifiable Credentials] +|Verifiable Credential (VC) +| For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2/3.%20Verifiable%20Credentials[Verifiable Credentials] |=== \ No newline at end of file From b5e29e182c3d19bf421ba02e7770e40afc6adfbb Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Thu, 1 Feb 2024 05:40:31 +0100 Subject: [PATCH 095/116] feat(imp):[#214] cleanup logging --- .../common/util/concurrent/ResultFinder.java | 35 +++----- .../DecentralDigitalTwinRegistryService.java | 90 ++++++++----------- .../EndpointDataForConnectorsService.java | 14 ++- 3 files changed, 53 insertions(+), 86 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 2c9e44c2e5..9430e623df 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -44,9 +44,6 @@ @Slf4j public class ResultFinder { - // TODO (mfischer): Remove when #214 is tested - public static final String LOGPREFIX_TO_BE_REMOVED_LATER = "#214@ "; - /** * Returns a new {@link CompletableFuture} which completes * when at least one of the given futures completes successfully or all fail. @@ -58,14 +55,12 @@ public class ResultFinder { */ public CompletableFuture getFastestResult(final List> futures) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "getFastestResult - "; - if (futures == null || futures.isEmpty()) { - log.warn(logPrefix + "Called getFastestResult with empty list of futures"); + log.warn("Called getFastestResult with empty list of futures"); return CompletableFuture.completedFuture(null); } - log.info(logPrefix + "Trying to get fastest result from list of futures"); + log.debug("Trying to get fastest result from list of futures"); final CompletableFuture fastestResultPromise = new CompletableFuture<>(); @@ -78,22 +73,17 @@ public CompletableFuture getFastestResult(final List allOf(toArray(futuresList)).whenComplete((value, ex) -> { - log.info(logPrefix + "All of the futures completed"); + log.debug("All of the futures completed"); if (ex != null) { - log.warn("All failed: " + System.lineSeparator() // + exceptions.stream() .map(ExceptionUtils::getStackTrace) .collect(Collectors.joining(System.lineSeparator())), ex); - fastestResultPromise.completeExceptionally( - new CompletionExceptions(LOGPREFIX_TO_BE_REMOVED_LATER + "None successful", exceptions)); - - } else if (fastestResultPromise.isDone()) { - log.info(logPrefix + "Fastest result already found, ignoring the others"); + fastestResultPromise.completeExceptionally(new CompletionExceptions("None successful", exceptions)); } else { - log.info(logPrefix + "Completing"); + log.debug("Completing"); fastestResultPromise.complete(null); } }); @@ -108,27 +98,25 @@ private static CompletableFuture[] toArray(final List BiFunction completingOnFirstSuccessful( final CompletableFuture resultPromise) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "completingOnFirstSuccessful - "; - return (value, throwable) -> { - log.info(logPrefix + "value: '{}', throwable: {}", value, throwable); + log.debug("value: '{}', throwable: {}", value, throwable); final boolean notFinishedByOtherFuture = !resultPromise.isDone(); - log.info(logPrefix + "notFinishedByOtherFuture {} ", notFinishedByOtherFuture); + log.debug("notFinishedByOtherFuture {} ", notFinishedByOtherFuture); final boolean currentFutureSuccessful = throwable == null && value != null; if (notFinishedByOtherFuture && currentFutureSuccessful) { // first future that completes successfully completes the overall future - log.info(logPrefix + "First future that completed successfully"); + log.debug("First future that completed successfully"); resultPromise.complete(value); return true; } else { if (throwable != null) { - log.warn(logPrefix + "Exception occurred: " + throwable.getMessage(), throwable); + log.warn("Exception occurred: " + throwable.getMessage(), throwable); throw new CompletionException(throwable.getMessage(), throwable); } return false; @@ -138,8 +126,7 @@ private static BiFunction completingOnFirstSuccessful private static Function collectingExceptionsAndThrow(final List exceptions) { return t -> { - log.error(LOGPREFIX_TO_BE_REMOVED_LATER + "collectingExceptionsAndThrow - " + "Exception occurred: " - + t.getMessage(), t); + log.error("Exception occurred: " + t.getMessage(), t); exceptions.add(t); throw new CompletionException(t); }; @@ -153,7 +140,7 @@ private static Function collectingExceptionsAndThrow(final Lis public static class CompletionExceptions extends CompletionException { private final List causes; - + public CompletionExceptions(final String msg, final List causes) { super(msg); this.causes = causes; diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java index eebf9836fc..603feb0b84 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryService.java @@ -23,8 +23,6 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.registryclient.decentral; -import static org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder.LOGPREFIX_TO_BE_REMOVED_LATER; - import java.util.Collection; import java.util.HashSet; import java.util.List; @@ -57,6 +55,8 @@ @SuppressWarnings("PMD.TooManyMethods") public class DecentralDigitalTwinRegistryService implements DigitalTwinRegistryService { + private static final String TOOK_MS = "{} took {} ms"; + private final ConnectorEndpointsService connectorEndpointsService; private final EndpointDataForConnectorsService endpointDataForConnectorsService; private final DecentralDigitalTwinRegistryClient decentralDigitalTwinRegistryClient; @@ -84,7 +84,7 @@ public Collection fetchShells(final Collecti throws RegistryServiceException { final var watch = new StopWatch(); - final String msg = LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching shell(s) for %s key(s)".formatted(keys.size()); + final String msg = "Fetching shell(s) for %s key(s)".formatted(keys.size()); watch.start(msg); log.info(msg); @@ -105,17 +105,16 @@ public Collection fetchShells(final Collecti }).toList(); if (collectedShells.isEmpty()) { - log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "No shells found"); + log.info("No shells found"); throw new ShellNotFoundException("Unable to find any of the requested shells", calledEndpoints); } else { - log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "Found {} shell(s) for {} key(s)", collectedShells.size(), - keys.size()); + log.info("Found {} shell(s) for {} key(s)", collectedShells.size(), keys.size()); return collectedShells; } } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -142,31 +141,27 @@ private CompletableFuture> fetchShellDe final Set calledEndpoints, final String bpn, final List keys) { final var watch = new StopWatch(); - final String msg = - LOGPREFIX_TO_BE_REMOVED_LATER + "Fetching %s shells for bpn '%s'".formatted(keys.size(), bpn); + final String msg = "Fetching %s shells for bpn '%s'".formatted(keys.size(), bpn); watch.start(msg); log.info(msg); try { final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.info(LOGPREFIX_TO_BE_REMOVED_LATER + "Found {} connector endpoints for bpn '{}'", - connectorEndpoints.size(), bpn); + log.info("Found {} connector endpoints for bpn '{}'", connectorEndpoints.size(), bpn); calledEndpoints.addAll(connectorEndpoints); return fetchShellDescriptorsForConnectorEndpoints(keys, connectorEndpoints); } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } private CompletableFuture> fetchShellDescriptorsForConnectorEndpoints( final List keys, final List connectorEndpoints) { - final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "fetchShellDescriptorsForConnectorEndpoints - "; - final var service = endpointDataForConnectorsService; final var futures = service.createFindEndpointDataForConnectorsFutures(connectorEndpoints) .stream() @@ -174,7 +169,7 @@ private CompletableFuture> fetchShellDe () -> fetchShellDescriptorsForKey(keys, edr)))) .toList(); - log.info(logPrefix + " Created {} futures", futures.size()); + log.debug("Created {} futures", futures.size()); return resultFinder.getFastestResult(futures); } @@ -182,10 +177,8 @@ private CompletableFuture> fetchShellDe private List fetchShellDescriptorsForKey( final List keys, final EndpointDataReference endpointDataReference) { - final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptorsForKey - "; - final var watch = new StopWatch(); - final String msg = logPrefix + "Fetching shell descriptors for keys %s from endpoint '%s'".formatted(keys, + final String msg = "Fetching shell descriptors for keys %s from endpoint '%s'".formatted(keys, endpointDataReference.getEndpoint()); watch.start(msg); log.info(msg); @@ -193,17 +186,15 @@ private List fetchShellDescriptorsForKey( return keys.stream().map(key -> fetchShellDescriptor(endpointDataReference, key)).toList(); } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDataReference endpointDataReference, final DigitalTwinRegistryKey key) { - final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + " fetchShellDescriptor - "; - final var watch = new StopWatch(); - final String msg = logPrefix + "Retrieving AAS identification for DigitalTwinRegistryKey: '%s'".formatted(key); + final String msg = "Retrieving AAS identification for DigitalTwinRegistryKey: '%s'".formatted(key); watch.start(msg); log.info(msg); try { @@ -212,7 +203,7 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa aaShellIdentification); } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @@ -228,10 +219,8 @@ private AssetAdministrationShellDescriptor fetchShellDescriptor(final EndpointDa @NotNull private String mapToShellId(final EndpointDataReference endpointDataReference, final String key) { - final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "mapToShellId - "; - final var watch = new StopWatch(); - final String msg = logPrefix + "Mapping '%s' to shell ID for endpoint '%s'".formatted(key, + final String msg = "Mapping '%s' to shell ID for endpoint '%s'".formatted(key, endpointDataReference.getEndpoint()); watch.start(msg); log.info(msg); @@ -250,50 +239,48 @@ private String mapToShellId(final EndpointDataReference endpointDataReference, f .orElse(key); if (key.equals(aaShellIdentification)) { - log.info(logPrefix + "Found shell with shellId {} in registry", aaShellIdentification); + log.info("Found shell with shellId {} in registry", aaShellIdentification); } else { - log.info(logPrefix + "Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); + log.info("Retrieved shellId {} for globalAssetId {}", aaShellIdentification, key); } return aaShellIdentification; } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } @SuppressWarnings("PMD.AvoidCatchingGenericException") private Collection lookupShellIds(final String bpn) throws RegistryServiceException { - final var logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; - log.info(logPrefix + "Looking up shell ids for bpn {}", bpn); + log.info("Looking up shell ids for bpn {}", bpn); try { final var connectorEndpoints = connectorEndpointsService.fetchConnectorEndpoints(bpn); - log.info(logPrefix + "Looking up shell ids for bpn '{}' with connector endpoints {}", bpn, - connectorEndpoints); + log.info("Looking up shell ids for bpn '{}' with connector endpoints {}", bpn, connectorEndpoints); final var endpointDataReferenceFutures = endpointDataForConnectorsService.createFindEndpointDataForConnectorsFutures( connectorEndpoints); - log.info(logPrefix + "Created endpointDataReferenceFutures"); + log.debug("Created endpointDataReferenceFutures"); - return lookupShellIds(bpn, endpointDataReferenceFutures, logPrefix); + return lookupShellIds(bpn, endpointDataReferenceFutures); } catch (RuntimeException e) { // catching generic exception is intended here, // otherwise Jobs stay in state RUNNING forever - log.error(logPrefix + e.getMessage(), e); - final var msg = logPrefix + e.getClass().getSimpleName() - + " occurred while looking up shell ids for bpn '%s'".formatted(bpn); - throw new RegistryServiceException(msg, e); + log.error(e.getMessage(), e); + throw new RegistryServiceException( + "%s occurred while looking up shell ids for bpn '%s'".formatted(e.getClass().getSimpleName(), bpn), + e); } } @NotNull private Collection lookupShellIds(final String bpn, - final List> endpointDataReferenceFutures, final String logPrefix) + final List> endpointDataReferenceFutures) throws RegistryServiceException { try { @@ -304,29 +291,26 @@ private Collection lookupShellIds(final String bpn, .toList(); final var shellIds = resultFinder.getFastestResult(futures).get(); - log.info(logPrefix + "Found {} shell id(s) in total", shellIds.size()); + log.info("Found {} shell id(s) in total", shellIds.size()); return shellIds; } catch (InterruptedException e) { - log.error(logPrefix + "InterruptedException occurred while looking up shells ids for bpn '%s': ".formatted( - bpn) + e.getMessage(), e); Thread.currentThread().interrupt(); - throw new RegistryServiceException(LOGPREFIX_TO_BE_REMOVED_LATER + e.getClass().getSimpleName() - + " occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + throw new RegistryServiceException( + "%s occurred while looking up shell ids for bpn '%s'".formatted(e.getClass().getSimpleName(), bpn), + e); } catch (ExecutionException e) { - log.error(logPrefix + e.getMessage(), e); - throw new RegistryServiceException(LOGPREFIX_TO_BE_REMOVED_LATER + e.getClass().getSimpleName() - + " occurred while looking up shell ids for bpn '%s'".formatted(bpn), e); + throw new RegistryServiceException( + "%s occurred while looking up shell ids for bpn '%s'".formatted(e.getClass().getSimpleName(), bpn), + e); } } private Collection lookupShellIds(final String bpn, final EndpointDataReference endpointDataReference) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "lookupShellIds - "; final var watch = new StopWatch(); - final String msg = - logPrefix + "Looking up shell IDs for bpn '%s' with endpointDataReference '%s'".formatted(bpn, - endpointDataReference); + final String msg = "Looking up shell IDs for bpn '%s' with endpointDataReference '%s'".formatted(bpn, + endpointDataReference); watch.start(msg); log.info(msg); @@ -336,7 +320,7 @@ private Collection lookupShellIds(final String bpn, final EndpointDataRe List.of(IdentifierKeyValuePair.builder().name("manufacturerId").value(bpn).build())).getResult(); } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } diff --git a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java index b11c8b312e..f6442bdaf2 100644 --- a/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java +++ b/irs-registry-client/src/main/java/org/eclipse/tractusx/irs/registryclient/decentral/EndpointDataForConnectorsService.java @@ -24,7 +24,6 @@ package org.eclipse.tractusx.irs.registryclient.decentral; import static java.util.concurrent.CompletableFuture.supplyAsync; -import static org.eclipse.tractusx.irs.common.util.concurrent.ResultFinder.LOGPREFIX_TO_BE_REMOVED_LATER; import java.util.Collections; import java.util.List; @@ -46,6 +45,7 @@ public class EndpointDataForConnectorsService { private static final String DT_REGISTRY_ASSET_TYPE = "https://w3id.org/edc/v0.0.1/ns/type"; private static final String DT_REGISTRY_ASSET_VALUE = "data.core.digitalTwinRegistry"; + private static final String TOOK_MS = "{} took {} ms"; private final EdcEndpointReferenceRetriever edcSubmodelFacade; @@ -68,17 +68,14 @@ public List> createFindEndpointDataForC } finally { log.info("Created {} futures", futures.size()); watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } private EndpointDataReference getEndpointReferenceForAsset(final String connector) { - final String logPrefix = LOGPREFIX_TO_BE_REMOVED_LATER + "getEndpointReferenceForAsset - "; - final var watch = new StopWatch(); - final String msg = - logPrefix + "Trying to retrieve EndpointDataReference for connector '%s'".formatted(connector); + final String msg = "Trying to retrieve EndpointDataReference for connector '%s'".formatted(connector); watch.start(msg); log.info(msg); @@ -86,12 +83,11 @@ private EndpointDataReference getEndpointReferenceForAsset(final String connecto return edcSubmodelFacade.getEndpointReferenceForAsset(connector, DT_REGISTRY_ASSET_TYPE, DT_REGISTRY_ASSET_VALUE); } catch (EdcRetrieverException e) { - log.warn(logPrefix + "Exception occurred when retrieving EndpointDataReference from connector '{}'", - connector, e); + log.warn("Exception occurred when retrieving EndpointDataReference from connector '{}'", connector, e); throw new CompletionException(e.getMessage(), e); } finally { watch.stop(); - log.info("{} took {} ms", watch.getLastTaskName(), watch.getLastTaskTimeMillis()); + log.info(TOOK_MS, watch.getLastTaskName(), watch.getLastTaskTimeMillis()); } } From 7a8b34df96aeb271108e8f701f58da25144353e2 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Thu, 1 Feb 2024 12:49:31 +0100 Subject: [PATCH 096/116] feat(irs):[#249] added policy for null fields --- .../services/PolicyStoreService.java | 15 +++++++++++ .../services/PolicyStoreServiceTest.java | 25 +++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java index 5c2b390a3f..87f2dad5d2 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java @@ -57,6 +57,7 @@ public class PolicyStoreService implements AcceptedPoliciesProvider { private final String apiAllowedBpn; private final List allowedPoliciesFromConfig; private final PolicyPersistence persistence; + private static final String MISSING_REQUEST_FIELD_MESSAGE = "Request does not contain all required fields. Missing: %s"; public PolicyStoreService(@Value("${apiAllowedBpn:}") final String apiAllowedBpn, final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig, final PolicyPersistence persistence) { @@ -68,6 +69,7 @@ public PolicyStoreService(@Value("${apiAllowedBpn:}") final String apiAllowedBpn } public void registerPolicy(final Policy policy) { + validatePolicy(policy); log.info("Registering new policy with id {}, valid until {}", policy.getPolicyId(), policy.getValidUntil()); try { persistence.save(apiAllowedBpn, policy); @@ -76,6 +78,19 @@ public void registerPolicy(final Policy policy) { } } + /** + * Checks whether policy from register policy request has all required fields + * @param policy policy to register + */ + private void validatePolicy(final Policy policy) { + if (policy.getPermissions() == null) { + throw new ResponseStatusException(HttpStatus.BAD_REQUEST, String.format(MISSING_REQUEST_FIELD_MESSAGE, "odrl:permission")); + } + if (policy.getPermissions().stream().anyMatch(p -> p.getConstraint() == null)) { + throw new ResponseStatusException(HttpStatus.BAD_REQUEST, String.format(MISSING_REQUEST_FIELD_MESSAGE, "odrl:constraint")); + } + } + public List getStoredPolicies() { log.info("Reading all stored polices for BPN {}", apiAllowedBpn); final var storedPolicies = persistence.readAll(apiAllowedBpn); diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java index 672802f65b..f118b99545 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java @@ -214,4 +214,29 @@ void updatePolicyShouldThrowResponseStatusException() { // assert assertThrows(ResponseStatusException.class, () -> testee.updatePolicy(policyId, request)); } + + @Test + void whenRegisterPolicyWithMissingPermissionsShouldThrowException() { + // arrange + final Policy policy = new Policy(); + + // act + // assert + assertThrows(ResponseStatusException.class, () -> testee.registerPolicy(policy)); + } + + @Test + void whenRegisterPolicyWithMissingConstraintShouldThrowException() { + // arrange + final Policy policy = Policy.builder() + .permissions(List.of( + Permission.builder().constraint(new Constraints(emptyList(), emptyList())).build(), + Permission.builder().build() + )) + .build(); + + // act + // assert + assertThrows(ResponseStatusException.class, () -> testee.registerPolicy(policy)); + } } \ No newline at end of file From a72d8756ab31be977d024aecd2aeea36c1c320b3 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Thu, 1 Feb 2024 13:25:15 +0100 Subject: [PATCH 097/116] feat(irs):[#249] changed return type of get all policies to match new format --- .../controllers/PolicyStoreController.java | 8 +- .../irs/policystore/models/Context.java | 31 ++++++ .../irs/policystore/models/Payload.java | 36 +++++++ .../policystore/models/PolicyResponse.java | 43 ++++++++ .../models/UpdatePolicyRequest.java | 5 +- .../PolicyStoreControllerTest.java | 101 +++++++++--------- 6 files changed, 169 insertions(+), 55 deletions(-) create mode 100644 irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Context.java create mode 100644 irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Payload.java create mode 100644 irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java index 7d280e0f95..97cb6cacd3 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java @@ -28,6 +28,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; import java.util.List; +import java.util.stream.Collectors; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.ArraySchema; @@ -45,6 +46,7 @@ import org.eclipse.tractusx.irs.edc.client.policy.Policy; import org.eclipse.tractusx.irs.edc.client.transformer.EdcTransformer; import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; +import org.eclipse.tractusx.irs.policystore.models.PolicyResponse; import org.eclipse.tractusx.irs.policystore.models.UpdatePolicyRequest; import org.eclipse.tractusx.irs.policystore.services.PolicyStoreService; import org.springframework.http.HttpStatus; @@ -133,8 +135,10 @@ public void registerAllowedPolicy(final @RequestBody CreatePolicyRequest request @GetMapping("/policies") @ResponseStatus(HttpStatus.OK) @PreAuthorize("hasAuthority('" + IrsRoles.ADMIN_IRS + "')") - public List getPolicies() { - return service.getStoredPolicies(); + public List getPolicies() { + return service.getStoredPolicies().stream() + .map(PolicyResponse::fromPolicy) + .collect(Collectors.toList()); } @Operation(operationId = "deleteAllowedPolicy", diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Context.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Context.java new file mode 100644 index 0000000000..8e8c7c3a45 --- /dev/null +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Context.java @@ -0,0 +1,31 @@ +/******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.policystore.models; + +/** + * Context representation for get all policies response + */ +public record Context(String odrl) { + private static final String ODRL_VALUE = "http://www.w3.org/ns/odrl/2/"; + + public static Context getDefault() { + return new Context(ODRL_VALUE); + } +} diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Payload.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Payload.java new file mode 100644 index 0000000000..42a29dfde1 --- /dev/null +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/Payload.java @@ -0,0 +1,36 @@ +/******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.policystore.models; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Builder; +import org.eclipse.tractusx.irs.edc.client.policy.Policy; + +/** + * Payload representation for get all policies response + */ +@Builder +public record Payload( + @JsonProperty("@context") Context context, + @JsonProperty("@id") String policyId, + Policy policy +) { + +} diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java new file mode 100644 index 0000000000..36d7d5fe8d --- /dev/null +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java @@ -0,0 +1,43 @@ +/******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.policystore.models; + +import java.time.OffsetDateTime; + +import lombok.Builder; +import org.eclipse.tractusx.irs.edc.client.policy.Policy; + +/** + * Policy representation for get all policies response + */ +@Builder +public record PolicyResponse(OffsetDateTime validUntil, Payload payload) { + + public static PolicyResponse fromPolicy(final Policy policy) { + return PolicyResponse.builder() + .validUntil(policy.getValidUntil()) + .payload(Payload.builder() + .policyId(policy.getPolicyId()) + .context(Context.getDefault()) + .policy(policy) + .build()) + .build(); + } +} diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/UpdatePolicyRequest.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/UpdatePolicyRequest.java index af6749ff85..4b4c455bd3 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/UpdatePolicyRequest.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/UpdatePolicyRequest.java @@ -30,9 +30,8 @@ /** * Request object for policy update - * */ @Schema(description = "Request to add a policy") -public record UpdatePolicyRequest(@Schema(description = "Timestamp after which the policy will no longer be accepted in negotiations") @NotNull OffsetDateTime validUntil) { - +public record UpdatePolicyRequest( + @Schema(description = "Timestamp after which the policy will no longer be accepted in negotiations") @NotNull OffsetDateTime validUntil) { } diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java index fcccff5225..f685cd33ab 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreControllerTest.java @@ -32,6 +32,7 @@ import java.time.OffsetDateTime; import java.util.Collections; import java.util.List; +import java.util.stream.Collectors; import jakarta.json.Json; import jakarta.json.JsonObject; @@ -48,6 +49,7 @@ import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; import org.eclipse.tractusx.irs.edc.client.transformer.EdcTransformer; import org.eclipse.tractusx.irs.policystore.models.CreatePolicyRequest; +import org.eclipse.tractusx.irs.policystore.models.PolicyResponse; import org.eclipse.tractusx.irs.policystore.models.UpdatePolicyRequest; import org.eclipse.tractusx.irs.policystore.services.PolicyStoreService; import org.junit.jupiter.api.BeforeEach; @@ -60,45 +62,46 @@ class PolicyStoreControllerTest { public static final String EXAMPLE_PAYLOAD = """ - { - "validUntil": "2025-12-12T23:59:59.999Z", - "payload": { - "@context": { - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@id": "policy-id", - "policy": { - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": { - "odrl:and": [ - { - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - }, - { - "odrl:leftOperand": "PURPOSE", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "ID 3.1 Trace" - } - ] - } - } - ] - } - } - } - """; + { + "validUntil": "2025-12-12T23:59:59.999Z", + "payload": { + "@context": { + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "USE", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + } + """; private PolicyStoreController testee; private final TitaniumJsonLd titaniumJsonLd = new TitaniumJsonLd(new ConsoleMonitor()); - private final EdcTransformer edcTransformer = new EdcTransformer(new com.fasterxml.jackson.databind.ObjectMapper(), titaniumJsonLd, new TypeTransformerRegistryImpl()); + private final EdcTransformer edcTransformer = new EdcTransformer(new com.fasterxml.jackson.databind.ObjectMapper(), + titaniumJsonLd, new TypeTransformerRegistryImpl()); @Mock private PolicyStoreService service; @@ -117,7 +120,8 @@ void registerAllowedPolicy() { jsonReader.close(); // act - testee.registerAllowedPolicy(new CreatePolicyRequest(now.plusMinutes(1), jsonObject.get("payload").asJsonObject())); + testee.registerAllowedPolicy( + new CreatePolicyRequest(now.plusMinutes(1), jsonObject.get("payload").asJsonObject())); // assert verify(service).registerPolicy(any()); @@ -126,14 +130,16 @@ void registerAllowedPolicy() { @Test void getPolicies() { // arrange - final List policies = List.of(new Policy("testId", OffsetDateTime.now(), OffsetDateTime.now(), createPermissions())); + final List policies = List.of( + new Policy("testId", OffsetDateTime.now(), OffsetDateTime.now(), createPermissions())); when(service.getStoredPolicies()).thenReturn(policies); // act - final var returnedPolicies = testee.getPolicies(); + final List returnedPolicies = testee.getPolicies(); // assert - assertThat(returnedPolicies).isEqualTo(policies); + assertThat(returnedPolicies).isEqualTo( + policies.stream().map(PolicyResponse::fromPolicy).collect(Collectors.toList())); } @Test @@ -159,19 +165,14 @@ void updateAllowedPolicy() { } private List createPermissions() { - return List.of( - new Permission(PolicyType.USE, createConstraints()), - new Permission(PolicyType.ACCESS, createConstraints()) - ); + return List.of(new Permission(PolicyType.USE, createConstraints()), + new Permission(PolicyType.ACCESS, createConstraints())); } private Constraints createConstraints() { - return new Constraints( - Collections.emptyList(), - List.of( - new Constraint("Membership", new Operator(OperatorType.EQ), "active"), + return new Constraints(Collections.emptyList(), + List.of(new Constraint("Membership", new Operator(OperatorType.EQ), "active"), new Constraint("FrameworkAgreement.traceability", new Operator(OperatorType.EQ), "active"), - new Constraint("PURPOSE", new Operator(OperatorType.EQ), "ID 3.1 Trace")) - ); + new Constraint("PURPOSE", new Operator(OperatorType.EQ), "ID 3.1 Trace"))); } } \ No newline at end of file From 090c19265facd5b8a99dd3bb0e727187c1776c75 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 1 Feb 2024 13:40:14 +0100 Subject: [PATCH 098/116] chore(charts): add missing templates for oauth ids --- charts/irs-helm/templates/configmap-spring-app-config.yaml | 6 ++++-- charts/irs-helm/values.yaml | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index 6a9e29d593..c5811fc1a7 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -79,9 +79,9 @@ data: shellDescriptorTemplate: {{ .Values.digitalTwinRegistry.shellDescriptorTemplate | default "" | quote }} lookupShellsTemplate: {{ .Values.digitalTwinRegistry.lookupShellsTemplate | default "" | quote }} type: {{ tpl (.Values.digitalTwinRegistry.type | default "") . | quote }} - oAuthClientId: {{ .Values.digitalTwinRegistry.oAuthClientId | default "portal" }} + oAuthClientId: {{ .Values.digitalTwinRegistry.oAuthClientId | default "discovery" }} discovery: - oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: {{ .Values.discovery.oAuthClientId | default "discovery" }} # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client discoveryFinderUrl: {{ tpl (.Values.discovery.discoveryFinderUrl | default "") . | quote }} # The endpoint to discover EDC endpoints to a particular BPN. semanticshub: @@ -89,11 +89,13 @@ data: pageSize: {{ tpl (.Values.semanticshub.pageSize | default "100") . }} modelJsonSchemaEndpoint: {{ tpl (.Values.semanticshub.modelJsonSchemaEndpoint | default "") . | quote }} defaultUrns: {{ tpl (.Values.semanticshub.defaultUrns | default "") . | quote }} + oAuthClientId: {{ .Values.semanticshub.oAuthClientId | default "semantics" }} {{- if .Values.semanticshub.localModels }} localModelDirectory: /app/semantic-models {{- end }} bpdm: + oAuthClientId: {{ .Values.bpdm.oAuthClientId | default "bpdm" }} bpnEndpoint: {{ tpl (.Values.bpdm.bpnEndpoint | default "") . | quote }} irs-edc-client: diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml index 7c0ecfa608..a62c3cff2e 100644 --- a/charts/irs-helm/values.yaml +++ b/charts/irs-helm/values.yaml @@ -140,6 +140,7 @@ semanticshub: {{- if .Values.semanticshub.url }} {{- tpl (.Values.semanticshub.url | default "" ) . }}/{urn}/json-schema {{- end }} + oAuthClientId: semantics defaultUrns: >- # urn:bamm:io.catenax.serial_part:1.0.0#SerialPart # ,urn:bamm:com.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt @@ -149,6 +150,7 @@ semanticshub: # dXJuOmJhbW06aW8uY2F0ZW5heC5zZXJpYWxfcGFydDoxLjAuMCNTZXJpYWxQYXJ0: {
	"$schema": "http://json-schema.org/draft-04/schema",
	"description": "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)",
	"type": "object",
	"components": {
		"schemas": {
			"urn_bamm_io.catenax.serial_part_1.0.0_CatenaXIdTrait": {
				"type": "string",
				"description": "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.",
				"pattern": "(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic": {
				"type": "string",
				"description": "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value."
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic": {
				"type": "string",
				"description": "The value of an identifier."
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList": {
				"description": "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.",
				"type": "object",
				"properties": {
					"key": {
						"description": "The key of a local identifier. ",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic"
					},
					"value": {
						"description": "The value of an identifier.",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic"
					}
				},
				"required": [
					"key",
					"value"
				]
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic": {
				"description": "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)",
				"type": "array",
				"items": {
					"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList"
				},
				"uniqueItems": true
			},
			"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp": {
				"type": "string",
				"pattern": "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?",
				"description": "Describes a Property which contains the date and time with an optional timezone."
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait": {
				"type": "string",
				"description": "Regular Expression that ensures a three-letter code ",
				"pattern": "^[A-Z][A-Z][A-Z]$"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic": {
				"description": "Characteristic to describe manufacturing related data",
				"type": "object",
				"properties": {
					"date": {
						"description": "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)",
						"$ref": "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
					},
					"country": {
						"description": "Country code where the part was manufactured",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait"
					}
				},
				"required": [
					"date"
				]
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic": {
				"type": "string",
				"description": "The part ID is a multi-character string, ususally assigned by an ERP system"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic": {
				"type": "string",
				"description": "Part Name in string format from the respective system in the value chain"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic": {
				"type": "string",
				"description": "A part type must be placed into one of the following classes: 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'.",
				"enum": [
					"product",
					"raw material",
					"software",
					"assembly",
					"tool",
					"component"
				]
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic": {
				"description": "The characteristics of the part type",
				"type": "object",
				"properties": {
					"manufacturerPartId": {
						"description": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic"
					},
					"customerPartId": {
						"description": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic"
					},
					"nameAtManufacturer": {
						"description": "Name of the part as assigned by the manufacturer",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic"
					},
					"nameAtCustomer": {
						"description": "Name of the part as assigned by the customer",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic"
					},
					"classification": {
						"description": "The classification of the part type according to STEP standard definition",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic"
					}
				},
				"required": [
					"manufacturerPartId",
					"nameAtManufacturer",
					"classification"
				]
			}
		}
	},
	"properties": {
		"catenaXId": {
			"description": "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_CatenaXIdTrait"
		},
		"localIdentifiers": {
			"description": "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic"
		},
		"manufacturingInformation": {
			"description": "Information from manufacturing process, such as manufacturing date and manufacturing country",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic"
		},
		"partTypeInformation": {
			"description": "The part type from which the serialized part has been instantiated",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic"
		}
	},
	"required": [
		"catenaXId",
		"localIdentifiers",
		"manufacturingInformation",
		"partTypeInformation"
	]
} bpdm: url: # https:// + oAuthClientId: bpdm bpnEndpoint: >- {{- if .Values.bpdm.url }} {{- tpl (.Values.bpdm.url | default "") . }}/api/catena/legal-entities/{partnerId}?idType={idType} From 0f20f6cfa55db692d0a974f36270726de0f8496f Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Thu, 1 Feb 2024 13:44:00 +0100 Subject: [PATCH 099/116] feat(irs):[#249] added example payload for get all policies response --- .../policystore/models/PolicyResponse.java | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java index 36d7d5fe8d..bf009dc8cf 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/models/PolicyResponse.java @@ -21,6 +21,7 @@ import java.time.OffsetDateTime; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Builder; import org.eclipse.tractusx.irs.edc.client.policy.Policy; @@ -28,8 +29,50 @@ * Policy representation for get all policies response */ @Builder +@Schema(example = PolicyResponse.EXAMPLE_PAYLOAD) public record PolicyResponse(OffsetDateTime validUntil, Payload payload) { + @SuppressWarnings({"FileTabCharacter", "java:S2479"}) + // required to show correctly example payload in open-api + public static final String EXAMPLE_PAYLOAD = """ + [ + { + "validUntil": "2025-12-12T23:59:59.999Z", + "payload": { + "@context": { + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "USE", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + } + ] + """; + public static PolicyResponse fromPolicy(final Policy policy) { return PolicyResponse.builder() .validUntil(policy.getValidUntil()) From 8be241017e907ebe18c0e54b6bcef5f37ef35b68 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 1 Feb 2024 17:09:35 +0100 Subject: [PATCH 100/116] feat(testing):[#344] Renaming *WireMockConfig to *WireMockSupport, refactoring --- .../irs/IrsWireMockIntegrationTest.java | 122 +++++++-------- .../tractusx/irs/WireMockTestConfig.java | 116 -------------- .../eclipse/tractusx/irs/WiremockSupport.java | 142 ++++++++++++++++++ ...ckConfig.java => BpdmWireMockSupport.java} | 29 +++- .../tractusx/irs/bpdm/BpdmWiremockTest.java | 26 ++-- .../semanticshub/SemanticHubWiremockTest.java | 65 ++------ .../client/SubmodelFacadeWiremockTest.java | 8 +- ...igitalTwinRegistryServiceWiremockTest.java | 36 ++--- ...a => DiscoveryServiceWiremockSupport.java} | 4 +- ...ockConfig.java => DtrWiremockSupport.java} | 10 +- ...ava => SubmodelFacadeWiremockSupport.java} | 4 +- 11 files changed, 283 insertions(+), 279 deletions(-) create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/WiremockSupport.java rename irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/{BpdmWireMockConfig.java => BpdmWireMockSupport.java} (68%) rename irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/{DiscoveryServiceWiremockConfig.java => DiscoveryServiceWiremockSupport.java} (97%) rename irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/{DtrWiremockConfig.java => DtrWiremockSupport.java} (97%) rename irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/{SubmodelFacadeWiremockConfig.java => SubmodelFacadeWiremockSupport.java} (99%) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java index 1b93697317..5bd23a282a 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsWireMockIntegrationTest.java @@ -25,28 +25,25 @@ import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; -import static org.eclipse.tractusx.irs.WireMockTestConfig.createEndpointDataReference; -import static org.eclipse.tractusx.irs.WireMockTestConfig.randomUUID; -import static org.eclipse.tractusx.irs.WireMockTestConfig.successfulDataRequests; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_URL; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder404; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscoveryEmpty200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_URL; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_LOOKUP_SHELLS_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.PUBLIC_SHELL_DESCRIPTORS_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.submodelDescriptor; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_CATALOG; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_NEGOTIATE; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_STATE; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_TRANSFER; +import static org.eclipse.tractusx.irs.WiremockSupport.createEndpointDataReference; +import static org.eclipse.tractusx.irs.WiremockSupport.randomUUID; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.DISCOVERY_FINDER_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.DISCOVERY_FINDER_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.EDC_DISCOVERY_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.TEST_BPN; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postDiscoveryFinder404; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postEdcDiscoveryEmpty200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.LOOKUP_SHELLS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.PUBLIC_LOOKUP_SHELLS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.PUBLIC_SHELL_DESCRIPTORS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.SHELL_DESCRIPTORS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getLookupShells200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getShellDescriptor200; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport.PATH_CATALOG; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport.PATH_NEGOTIATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport.PATH_STATE; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport.PATH_TRANSFER; import java.time.Duration; import java.util.List; @@ -54,7 +51,7 @@ import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.awaitility.Awaitility; -import org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig; +import org.eclipse.tractusx.irs.bpdm.BpdmWireMockSupport; import org.eclipse.tractusx.irs.component.JobHandle; import org.eclipse.tractusx.irs.component.Jobs; import org.eclipse.tractusx.irs.component.RegisterJob; @@ -62,13 +59,13 @@ import org.eclipse.tractusx.irs.data.StringMapper; import org.eclipse.tractusx.irs.edc.client.EndpointDataReferenceStorage; import org.eclipse.tractusx.irs.semanticshub.AspectModels; -import org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig; +import org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockSupport; import org.eclipse.tractusx.irs.services.IrsItemGraphQueryService; import org.eclipse.tractusx.irs.services.SemanticHubService; import org.eclipse.tractusx.irs.services.validation.SchemaNotFoundException; import org.eclipse.tractusx.irs.testing.containers.MinioContainer; -import org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig; -import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig; +import org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport; +import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeAll; @@ -110,7 +107,7 @@ class IrsWireMockIntegrationTest { @BeforeAll static void startContainer() { minioContainer.start(); - WireMockTestConfig.successfulSemanticModelRequest(); + WiremockSupport.successfulSemanticModelRequest(); } @AfterEach @@ -126,13 +123,13 @@ static void stopContainer() { @DynamicPropertySource static void configureProperties(DynamicPropertyRegistry registry) { - registry.add("bpdm.bpnEndpoint", () -> BpdmWireMockConfig.BPDM_TEST); + registry.add("bpdm.bpnEndpoint", () -> BpdmWireMockSupport.BPDM_URL_TEMPLATE); registry.add("digitalTwinRegistry.discoveryFinderUrl", () -> DISCOVERY_FINDER_URL); registry.add("digitalTwinRegistry.shellDescriptorTemplate", () -> SHELL_DESCRIPTORS_TEMPLATE); registry.add("digitalTwinRegistry.lookupShellsTemplate", () -> LOOKUP_SHELLS_TEMPLATE); registry.add("digitalTwinRegistry.type", () -> "decentral"); registry.add("semanticshub.url", () -> SEMANTIC_HUB_URL); - registry.add("semanticshub.modelJsonSchemaEndpoint", () -> SemanticHubWireMockConfig.SEMANTIC_HUB_SCHEMA_URL); + registry.add("semanticshub.modelJsonSchemaEndpoint", () -> SemanticHubWireMockSupport.SEMANTIC_HUB_SCHEMA_URL); registry.add("semanticshub.defaultUrns", () -> ""); registry.add("irs-edc-client.controlplane.endpoint.data", () -> EDC_URL); registry.add("irs-edc-client.controlplane.endpoint.catalog", () -> PATH_CATALOG); @@ -147,7 +144,7 @@ static void configureProperties(DynamicPropertyRegistry registry) { @Test void shouldStartApplicationAndCollectSemanticModels() throws SchemaNotFoundException { // Arrange - WireMockTestConfig.successfulSemanticModelRequest(); + WiremockSupport.successfulSemanticModelRequest(); // Act final AspectModels allAspectModels = semanticHubService.getAllAspectModels(); @@ -162,18 +159,18 @@ void shouldStopJobAfterDepthIsReached() { final String globalAssetIdLevel1 = "globalAssetId"; final String globalAssetIdLevel2 = "urn:uuid:6d505432-8b31-4966-9514-4b753372683f"; - WireMockTestConfig.successfulSemanticModelRequest(); - WireMockTestConfig.successfulSemanticHubRequests(); - WireMockTestConfig.successfulDiscovery(); + WiremockSupport.successfulSemanticModelRequest(); + WiremockSupport.successfulSemanticHubRequests(); + WiremockSupport.successfulDiscovery(); successfulRegistryAndDataRequest(globalAssetIdLevel1, "Cathode", TEST_BPN, "integrationtesting/batch-1.json", "integrationtesting/singleLevelBomAsBuilt-1.json"); successfulRegistryAndDataRequest(globalAssetIdLevel2, "Polyamid", TEST_BPN, "integrationtesting/batch-2.json", "integrationtesting/singleLevelBomAsBuilt-2.json"); - WireMockTestConfig.successfulBpdmRequests(); + BpdmWireMockSupport.bpdmWillReturnCompanyName(DiscoveryServiceWiremockSupport.TEST_BPN, "Company Name"); - final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetIdLevel1, TEST_BPN, 1); + final RegisterJob request = WiremockSupport.jobRequest(globalAssetIdLevel1, TEST_BPN, 1); // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -183,8 +180,8 @@ void shouldStopJobAfterDepthIsReached() { Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); // Assert - WireMockTestConfig.verifyDiscoveryCalls(1); - WireMockTestConfig.verifyNegotiationCalls(3); + WiremockSupport.verifyDiscoveryCalls(1); + WiremockSupport.verifyNegotiationCalls(3); assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); assertThat(jobForJobId.getShells()).hasSize(2); @@ -195,10 +192,10 @@ void shouldStopJobAfterDepthIsReached() { @Test void shouldCreateTombstoneWhenDiscoveryServiceNotAvailable() { // Arrange - WireMockTestConfig.successfulSemanticModelRequest(); + WiremockSupport.successfulSemanticModelRequest(); stubFor(postDiscoveryFinder404()); final String globalAssetId = "globalAssetId"; - final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetId, TEST_BPN, 1); + final RegisterJob request = WiremockSupport.jobRequest(globalAssetId, TEST_BPN, 1); // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -220,11 +217,11 @@ void shouldCreateTombstoneWhenDiscoveryServiceNotAvailable() { @Test void shouldCreateTombstoneWhenEdcDiscoveryIsEmpty() { // Arrange - WireMockTestConfig.successfulSemanticModelRequest(); + WiremockSupport.successfulSemanticModelRequest(); stubFor(postDiscoveryFinder200()); stubFor(postEdcDiscoveryEmpty200()); final String globalAssetId = "globalAssetId"; - final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetId, TEST_BPN, 1); + final RegisterJob request = WiremockSupport.jobRequest(globalAssetId, TEST_BPN, 1); // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -234,7 +231,7 @@ void shouldCreateTombstoneWhenEdcDiscoveryIsEmpty() { waitForCompletion(jobHandle); final Jobs jobForJobId = irsService.getJobForJobId(jobHandle.getId(), true); - WireMockTestConfig.verifyDiscoveryCalls(1); + WiremockSupport.verifyDiscoveryCalls(1); assertThat(jobForJobId.getJob().getState()).isEqualTo(JobState.COMPLETED); assertThat(jobForJobId.getShells()).isEmpty(); @@ -249,9 +246,9 @@ void shouldStartRecursiveProcesses() { final String globalAssetIdLevel2 = "urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5"; final String globalAssetIdLevel3 = "urn:uuid:a314ad6b-77ea-417e-ae2d-193b3e249e99"; - WireMockTestConfig.successfulSemanticModelRequest(); - WireMockTestConfig.successfulSemanticHubRequests(); - WireMockTestConfig.successfulDiscovery(); + WiremockSupport.successfulSemanticModelRequest(); + WiremockSupport.successfulSemanticHubRequests(); + WiremockSupport.successfulDiscovery(); successfulRegistryAndDataRequest(globalAssetIdLevel1, "Cathode", TEST_BPN, "integrationtesting/batch-1.json", "integrationtesting/singleLevelBomAsBuilt-1.json"); @@ -260,9 +257,9 @@ void shouldStartRecursiveProcesses() { successfulRegistryAndDataRequest(globalAssetIdLevel3, "GenericChemical", TEST_BPN, "integrationtesting/batch-3.json", "integrationtesting/singleLevelBomAsBuilt-3.json"); - WireMockTestConfig.successfulBpdmRequests(); + BpdmWireMockSupport.bpdmWillReturnCompanyName(DiscoveryServiceWiremockSupport.TEST_BPN, "Company Name"); - final RegisterJob request = WireMockTestConfig.jobRequest(globalAssetIdLevel1, TEST_BPN, 4); + final RegisterJob request = WiremockSupport.jobRequest(globalAssetIdLevel1, TEST_BPN, 4); // Act final JobHandle jobHandle = irsService.registerItemJob(request); @@ -279,34 +276,29 @@ void shouldStartRecursiveProcesses() { assertThat(jobForJobId.getTombstones()).isEmpty(); assertThat(jobForJobId.getSubmodels()).hasSize(6); - WireMockTestConfig.verifyDiscoveryCalls(1); - WireMockTestConfig.verifyNegotiationCalls(6); + WiremockSupport.verifyDiscoveryCalls(1); + WiremockSupport.verifyNegotiationCalls(6); } private void successfulRegistryAndDataRequest(final String globalAssetId, final String idShort, final String bpn, final String batchFileName, final String sbomFileName) { - final String edcAssetId = WireMockTestConfig.randomUUIDwithPrefix(); - final String batchId = WireMockTestConfig.randomUUIDwithPrefix(); - final String batch = submodelDescriptor(DATAPLANE_PUBLIC_URL, edcAssetId, - DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "Batch", batchId, - "urn:samm:io.catenax.batch:2.0.0#Batch"); - successfulDataRequests(batchId, batchFileName); - - final String sbomId = WireMockTestConfig.randomUUIDwithPrefix(); - final String singleLevelBomAsBuilt = submodelDescriptor(DATAPLANE_PUBLIC_URL, edcAssetId, - DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "SingleLevelBomAsBuilt", sbomId, - "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt"); - final List submodelDescriptors = List.of(batch, singleLevelBomAsBuilt); - successfulDataRequests(sbomId, sbomFileName); + final String edcAssetId = WiremockSupport.randomUUIDwithPrefix(); + final String batch = WiremockSupport.submodelRequest(edcAssetId, "Batch", + "urn:samm:io.catenax.batch:2.0.0#Batch", batchFileName); + + final String singleLevelBomAsBuilt = WiremockSupport.submodelRequest(edcAssetId, "SingleLevelBomAsBuilt", + "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt", sbomFileName); + successfulNegotiation(edcAssetId); + final List submodelDescriptors = List.of(batch, singleLevelBomAsBuilt); - final String shellId = WireMockTestConfig.randomUUIDwithPrefix(); + final String shellId = WiremockSupport.randomUUIDwithPrefix(); final String registryEdcAssetId = "registry-asset"; successfulNegotiation(registryEdcAssetId); stubFor(getLookupShells200(PUBLIC_LOOKUP_SHELLS_PATH, List.of(shellId)).withQueryParam("assetIds", containing(globalAssetId))); - stubFor(getShellDescriptor200(PUBLIC_SHELL_DESCRIPTORS_PATH + WireMockTestConfig.encodedId(shellId), bpn, + stubFor(getShellDescriptor200(PUBLIC_SHELL_DESCRIPTORS_PATH + WiremockSupport.encodedId(shellId), bpn, submodelDescriptors, globalAssetId, shellId, idShort)); } @@ -314,7 +306,7 @@ private void successfulNegotiation(final String edcAssetId) { final String negotiationId = randomUUID(); final String transferProcessId = randomUUID(); final String contractAgreementId = "%s:%s:%s".formatted(randomUUID(), edcAssetId, randomUUID()); - SubmodelFacadeWiremockConfig.prepareNegotiation(negotiationId, transferProcessId, contractAgreementId, + SubmodelFacadeWiremockSupport.prepareNegotiation(negotiationId, transferProcessId, contractAgreementId, edcAssetId); endpointDataReferenceStorage.put(contractAgreementId, createEndpointDataReference(contractAgreementId)); } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java index 2db79977e6..8c41604857 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WireMockTestConfig.java @@ -19,52 +19,18 @@ ********************************************************************************/ package org.eclipse.tractusx.irs; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; -import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; -import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; -import static com.github.tomakehurst.wiremock.client.WireMock.verify; -import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.bpdmResponse; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.BPDM_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.DISCOVERY_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.DTR_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.EDC_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.NO_ERROR_REST_TEMPLATE; import static org.eclipse.tractusx.irs.configuration.RestTemplateConfig.SEMHUB_REST_TEMPLATE; -import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.batchSchemaResponse200; -import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.singleLevelBomAsBuiltSchemaResponse200; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_PUBLIC_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.DATAPLANE_HOST; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_CATALOG; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_DATAPLANE_PUBLIC; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_NEGOTIATE; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_STATE; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_TRANSFER; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; -import java.nio.charset.StandardCharsets; -import java.util.Base64; import java.util.List; -import java.util.Map; -import java.util.UUID; import com.fasterxml.jackson.databind.ObjectMapper; import org.eclipse.edc.policy.model.PolicyRegistrationTypes; -import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; -import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; -import org.eclipse.tractusx.irs.component.RegisterJob; -import org.eclipse.tractusx.irs.component.enums.Direction; -import org.eclipse.tractusx.irs.data.StringMapper; -import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; -import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; @@ -131,86 +97,4 @@ RestTemplate semanticHubRestTemplate() { return restTemplateProxy(PROXY_SERVER_HOST, HTTP_PORT); } - public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { - final EDRAuthCode edrAuthCode = EDRAuthCode.builder() - .cid(contractAgreementId) - .dad("test") - .exp(9999999999L) - .build(); - final String b64EncodedAuthCode = Base64.getUrlEncoder() - .encodeToString(StringMapper.mapToString(edrAuthCode) - .getBytes(StandardCharsets.UTF_8)); - final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; - return EndpointDataReference.Builder.newInstance() - .authKey("testkey") - .authCode(jwtToken) - .properties( - Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) - .endpoint(DATAPLANE_HOST + PATH_DATAPLANE_PUBLIC) - .build(); - } - - static void successfulSemanticModelRequest() { - stubFor(get(urlPathEqualTo("/models")).willReturn( - responseWithStatus(200).withBodyFile("semantichub/all-models-page-IT.json"))); - } - - static RegisterJob jobRequest(final String globalAssetId, final String bpn, final int depth) { - return RegisterJob.builder() - .key(PartChainIdentificationKey.builder().bpn(bpn).globalAssetId(globalAssetId).build()) - .depth(depth) - .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) - .collectAspects(true) - .lookupBPNs(true) - .direction(Direction.DOWNWARD) - .build(); - } - - static void successfulDiscovery() { - stubFor(postDiscoveryFinder200()); - stubFor(postEdcDiscovery200()); - } - - static String encodedId(final String shellId) { - return org.apache.commons.codec.binary.Base64.encodeBase64String(shellId.getBytes(StandardCharsets.UTF_8)); - } - - static void verifyDiscoveryCalls(final int times) { - verify(times, postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); - verify(times, postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); - } - - static void verifyNegotiationCalls(final int times) { - verify(times, postRequestedFor(urlPathEqualTo(PATH_NEGOTIATE))); - verify(times, postRequestedFor(urlPathEqualTo(PATH_CATALOG))); - verify(times * 2, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*"))); - verify(times, getRequestedFor(urlPathMatching(PATH_NEGOTIATE + "/.*" + PATH_STATE))); - verify(times, postRequestedFor(urlPathEqualTo(PATH_TRANSFER))); - verify(times * 2, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*"))); - verify(times, getRequestedFor(urlPathMatching(PATH_TRANSFER + "/.*" + PATH_STATE))); - } - - static void successfulBpdmRequests() { - stubFor(get(urlPathMatching("/legal-entities/.*")).willReturn( - responseWithStatus(200).withBody(bpdmResponse(TEST_BPN, "Company Name")))); - } - - static void successfulDataRequests(final String assetId, final String fileName) { - stubFor(get(urlPathMatching(DATAPLANE_PUBLIC_PATH + "/" + assetId)).willReturn( - responseWithStatus(200).withBodyFile(fileName))); - } - - static void successfulSemanticHubRequests() { - stubFor(batchSchemaResponse200()); - stubFor(singleLevelBomAsBuiltSchemaResponse200()); - } - - static String randomUUIDwithPrefix() { - final String uuidPrefix = "urn:uuid:"; - return uuidPrefix + randomUUID(); - } - - static String randomUUID() { - return UUID.randomUUID().toString(); - } } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/WiremockSupport.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/WiremockSupport.java new file mode 100644 index 0000000000..9698272e7c --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/WiremockSupport.java @@ -0,0 +1,142 @@ +/******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs; + +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; +import static org.apache.commons.codec.binary.Base64.encodeBase64String; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockSupport.semanticHubWillReturnAllModels; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.DATAPLANE_PUBLIC_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.submodelDescriptor; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; + +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.List; +import java.util.Map; +import java.util.UUID; + +import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.component.PartChainIdentificationKey; +import org.eclipse.tractusx.irs.component.RegisterJob; +import org.eclipse.tractusx.irs.component.enums.Direction; +import org.eclipse.tractusx.irs.data.StringMapper; +import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; +import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; +import org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockSupport; +import org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport; +import org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport; +import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport; + +public class WiremockSupport { + public static EndpointDataReference createEndpointDataReference(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + final String jwtToken = "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + return EndpointDataReference.Builder.newInstance() + .authKey("testkey") + .authCode(jwtToken) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint(SubmodelFacadeWiremockSupport.DATAPLANE_HOST + + SubmodelFacadeWiremockSupport.PATH_DATAPLANE_PUBLIC) + .build(); + } + + static void successfulSemanticModelRequest() { + semanticHubWillReturnAllModels("semantichub/all-models-page-IT.json"); + } + + static RegisterJob jobRequest(final String globalAssetId, final String bpn, final int depth) { + return RegisterJob.builder() + .key(PartChainIdentificationKey.builder().bpn(bpn).globalAssetId(globalAssetId).build()) + .depth(depth) + .aspects(List.of("Batch", "SingleLevelBomAsBuilt")) + .collectAspects(true) + .lookupBPNs(true) + .direction(Direction.DOWNWARD) + .build(); + } + + static void successfulDiscovery() { + stubFor(DiscoveryServiceWiremockSupport.postDiscoveryFinder200()); + stubFor(DiscoveryServiceWiremockSupport.postEdcDiscovery200()); + } + + static String encodedId(final String shellId) { + return encodeBase64String(shellId.getBytes(StandardCharsets.UTF_8)); + } + + static void verifyDiscoveryCalls(final int times) { + verify(times, postRequestedFor(urlPathEqualTo(DiscoveryServiceWiremockSupport.DISCOVERY_FINDER_PATH))); + verify(times, postRequestedFor(urlPathEqualTo(DiscoveryServiceWiremockSupport.EDC_DISCOVERY_PATH))); + } + + static void verifyNegotiationCalls(final int times) { + verify(times, postRequestedFor(urlPathEqualTo(SubmodelFacadeWiremockSupport.PATH_NEGOTIATE))); + verify(times, postRequestedFor(urlPathEqualTo(SubmodelFacadeWiremockSupport.PATH_CATALOG))); + verify(times * 2, getRequestedFor(urlPathMatching(SubmodelFacadeWiremockSupport.PATH_NEGOTIATE + "/.*"))); + verify(times, getRequestedFor(urlPathMatching( + SubmodelFacadeWiremockSupport.PATH_NEGOTIATE + "/.*" + SubmodelFacadeWiremockSupport.PATH_STATE))); + verify(times, postRequestedFor(urlPathEqualTo(SubmodelFacadeWiremockSupport.PATH_TRANSFER))); + verify(times * 2, getRequestedFor(urlPathMatching(SubmodelFacadeWiremockSupport.PATH_TRANSFER + "/.*"))); + verify(times, getRequestedFor(urlPathMatching( + SubmodelFacadeWiremockSupport.PATH_TRANSFER + "/.*" + SubmodelFacadeWiremockSupport.PATH_STATE))); + } + + static void successfulDataRequests(final String assetId, final String fileName) { + stubFor(get(urlPathMatching(DtrWiremockSupport.DATAPLANE_PUBLIC_PATH + "/" + assetId)).willReturn( + responseWithStatus(200).withBodyFile(fileName))); + } + + static void successfulSemanticHubRequests() { + SemanticHubWireMockSupport.semanticHubWillReturnBatchSchema(); + SemanticHubWireMockSupport.semanticHubWillReturnSingleLevelBomAsBuiltSchema(); + } + + static String randomUUIDwithPrefix() { + final String uuidPrefix = "urn:uuid:"; + return uuidPrefix + randomUUID(); + } + + static String randomUUID() { + return UUID.randomUUID().toString(); + } + + static String submodelRequest(final String edcAssetId, final String SingleLevelBomAsBuilt, final String semanticId, + final String sbomFileName) { + final String sbomId = randomUUIDwithPrefix(); + final String submoodel = submodelDescriptor(DATAPLANE_PUBLIC_URL, edcAssetId, + DiscoveryServiceWiremockSupport.CONTROLPLANE_PUBLIC_URL, SingleLevelBomAsBuilt, sbomId, semanticId); + successfulDataRequests(sbomId, sbomFileName); + return submoodel; + } +} \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockSupport.java similarity index 68% rename from irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java rename to irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockSupport.java index 45bcb93a89..d7af399fcc 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockConfig.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWireMockSupport.java @@ -19,14 +19,36 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.bpdm; +import static com.github.tomakehurst.wiremock.client.WireMock.exactly; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; + /** * WireMock configurations and requests used for testing BPDM flow. */ -public final class BpdmWireMockConfig { +public final class BpdmWireMockSupport { + + public static final String BPN_PATH = "/legal-entities/"; + public static final String BPDM_URL_TEMPLATE = "http://bpdm.test" + BPN_PATH + "{partnerId}?idType={idType}"; + + private BpdmWireMockSupport() { + } - public static final String BPDM_TEST = "http://bpdm.test/legal-entities/{partnerId}?idType={idType}"; + public static void bpdmWillReturnCompanyName(final String bpn, final String companyName) { + stubFor(get(urlPathEqualTo(BPN_PATH + bpn)).willReturn( + responseWithStatus(200).withBody(bpdmResponse(bpn, companyName)))); + } + + public static void bpdmWillNotFindCompanyName(final String bpn) { + stubFor(get(urlPathEqualTo(BPN_PATH + bpn)).willReturn(responseWithStatus(404))); + } - private BpdmWireMockConfig() { + public static void verifyBpdmWasCalledWithBPN(final String bpn, final int times) { + verify(exactly(times), getRequestedFor(urlPathEqualTo(BPN_PATH + bpn))); } public static String bpdmResponse(final String bpn, final String companyName) { @@ -84,4 +106,5 @@ public static String bpdmResponse(final String bpn, final String companyName) { } """.formatted(bpn, bpn, companyName); } + } \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java index bc375f55b2..5041293e43 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java @@ -19,14 +19,12 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.bpdm; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.BPDM_TEST; -import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockConfig.bpdmResponse; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockSupport.BPDM_URL_TEMPLATE; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockSupport.bpdmWillNotFindCompanyName; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockSupport.bpdmWillReturnCompanyName; +import static org.eclipse.tractusx.irs.bpdm.BpdmWireMockSupport.verifyBpdmWasCalledWithBPN; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import java.util.Optional; @@ -47,30 +45,34 @@ class BpdmWiremockTest { void setUp(WireMockRuntimeInfo wireMockRuntimeInfo) { final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); - bpdmFacade = new BpdmFacade(new BpdmClientImpl(restTemplate, BPDM_TEST)); + bpdmFacade = new BpdmFacade(new BpdmClientImpl(restTemplate, BPDM_URL_TEMPLATE)); } @Test void shouldResolveManufacturerName() { // Arrange - givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn( - responseWithStatus(200).withBody(bpdmResponse("BPNL00000000TEST", "TEST_BPN_DFT_1")))); + final String bpn = "BPNL00000000TEST"; + bpdmWillReturnCompanyName(bpn, "TEST_BPN_DFT_1"); // Act - final Optional manufacturerName = bpdmFacade.findManufacturerName("BPNL00000000TEST"); + final Optional manufacturerName = bpdmFacade.findManufacturerName(bpn); // Assert assertThat(manufacturerName).isPresent().contains("TEST_BPN_DFT_1"); + verifyBpdmWasCalledWithBPN(bpn, 1); } @Test void shouldReturnEmptyOnNotFound() { // Arrange - givenThat(get(urlPathEqualTo("/legal-entities/BPNL00000000TEST")).willReturn(responseWithStatus(404))); + final String bpn = "BPNL00000000TEST"; + bpdmWillNotFindCompanyName(bpn); // Act & Assert // TODO fix implementation to not throw HttpClientErrorException$NotFound assertThatExceptionOfType(HttpClientErrorException.class).isThrownBy( - () -> bpdmFacade.findManufacturerName("BPNL00000000TEST")); + () -> bpdmFacade.findManufacturerName(bpn)); + verifyBpdmWasCalledWithBPN(bpn, 1); } + } diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java index 99ad8e8657..6558c3d523 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWiremockTest.java @@ -23,23 +23,12 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.semanticshub; -import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; -import static com.github.tomakehurst.wiremock.client.WireMock.exactly; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; -import static com.github.tomakehurst.wiremock.client.WireMock.givenThat; -import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; -import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.SEMANTIC_HUB_SCHEMA_URL; -import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockConfig.batchSchemaResponse200; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockSupport.SEMANTIC_HUB_SCHEMA_URL; +import static org.eclipse.tractusx.irs.semanticshub.SemanticHubWireMockSupport.semanticHubWillReturnBatchSchema; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; -import com.github.tomakehurst.wiremock.client.MappingBuilder; import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.eclipse.tractusx.irs.configuration.SemanticsHubConfiguration; @@ -53,15 +42,6 @@ class SemanticHubWiremockTest { private static final String PROXY_SERVER_HOST = "127.0.0.1"; private SemanticsHubFacade semanticsHubFacade; - private static MappingBuilder getAllModels200() { - return get(urlPathEqualTo("/models")).withHost(equalTo("semantic.hub")) - .willReturn(responseWithStatus(200).withBodyFile("all-models-page.json")); - } - - private static void verifyGetAllModels(final int times) { - verify(exactly(times), getRequestedFor(urlPathEqualTo("/models"))); - } - @BeforeEach void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { final RestTemplate restTemplate = restTemplateProxy(PROXY_SERVER_HOST, wireMockRuntimeInfo.getHttpPort()); @@ -77,39 +57,31 @@ void configureSystemUnderTest(WireMockRuntimeInfo wireMockRuntimeInfo) { @Test void shouldReturn1Page() throws SchemaNotFoundException { - givenThat(getAllModels200()); + SemanticHubWireMockSupport.semanticHubWillReturnAllModels("all-models-page.json"); final AspectModels allAspectModels = semanticsHubFacade.getAllAspectModels(); assertThat(allAspectModels.models()).isNotEmpty(); assertThat(allAspectModels.models().get(0).name()).isEqualTo("SerialPartTypization"); - verifyGetAllModels(1); + SemanticHubWireMockSupport.verifySemanticHubWasCalledForAllModels(1); } @Test void shouldReturn2Pages() throws SchemaNotFoundException { - givenThat(get(urlPathEqualTo("/models")).withHost(equalTo("semantic.hub")) - .withQueryParam("page", equalTo("0")) - .withQueryParam("pageSize", equalTo("10")) - .willReturn( - responseWithStatus(200).withBodyFile("all-models-page1.json"))); - givenThat(get(urlPathEqualTo("/models")).withHost(equalTo("semantic.hub")) - .withQueryParam("page", equalTo("1")) - .withQueryParam("pageSize", equalTo("10")) - .willReturn( - responseWithStatus(200).withBodyFile("all-models-page2.json"))); + SemanticHubWireMockSupport.semanticHubWillReturnPagedModels(0, 10, "all-models-page1.json"); + SemanticHubWireMockSupport.semanticHubWillReturnPagedModels(1, 10, "all-models-page2.json"); final AspectModels allAspectModels = semanticsHubFacade.getAllAspectModels(); assertThat(allAspectModels.models()).hasSize(20); assertThat(allAspectModels.models().get(0).name()).isEqualTo("SerialPartTypization"); - verifyGetAllModels(2); + SemanticHubWireMockSupport.verifySemanticHubWasCalledForAllModels(2); } @Test void shouldReturnJsonSchema() throws SchemaNotFoundException { // Arrange - stubFor(batchSchemaResponse200()); + semanticHubWillReturnBatchSchema(); // Act final String modelJsonSchema = semanticsHubFacade.getModelJsonSchema("urn:samm:io.catenax.batch:2.0.0#Batch"); @@ -117,30 +89,19 @@ void shouldReturnJsonSchema() throws SchemaNotFoundException { // Assert assertThat(modelJsonSchema).contains("urn_samm_io.catenax.batch_2.0.0_CatenaXIdTrait") .contains("A batch is a quantity of (semi-) finished products or (raw) material"); - verify(exactly(1), - getRequestedFor(urlPathMatching("/models/urn:samm:io.catenax.batch:2.0.0%23Batch/json-schema"))); + SemanticHubWireMockSupport.verifySemanticHubWasCalledForModel("urn:samm:io.catenax.batch:2.0.0%23Batch", 1); } @Test void shouldThrowSchemaExceptionWhenSchemaNotFound() { // Arrange - final String url = "/models/%s/json-schema".formatted( - "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0%23SingleLevelBomAsBuilt"); - final String errorBody = """ - { - "timestamp": "2024-01-24T12:06:23.390+00:00", - "status": 500, - "error": "Internal Server Error", - "path": "/api/v1/models/urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt/json-schema" - } - """; - System.out.println(url); - stubFor(get(urlPathEqualTo(url)).withHost(equalTo("semantic.hub")) - .willReturn(responseWithStatus(500).withBody(errorBody))); + final String semanticModel = "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0%23SingleLevelBomAsBuilt"; + SemanticHubWireMockSupport.semanticHubWillThrowErrorForSemanticModel(semanticModel); // Act & Assert assertThatExceptionOfType(SchemaNotFoundException.class).isThrownBy(() -> semanticsHubFacade.getModelJsonSchema( "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt")); - verify(exactly(1), getRequestedFor(urlPathEqualTo(url))); + SemanticHubWireMockSupport.verifySemanticHubWasCalledForModel(semanticModel, 1); } + } diff --git a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java index 7f0652c538..7f5a11e4be 100644 --- a/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java +++ b/irs-edc-client/src/test/java/org/eclipse/tractusx/irs/edc/client/SubmodelFacadeWiremockTest.java @@ -29,8 +29,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.eclipse.tractusx.irs.edc.client.testutil.TestMother.createEdcTransformer; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.DATAPLANE_HOST; -import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig.PATH_DATAPLANE_PUBLIC; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport.DATAPLANE_HOST; +import static org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport.PATH_DATAPLANE_PUBLIC; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.Mockito.mock; @@ -70,7 +70,7 @@ import org.eclipse.tractusx.irs.edc.client.policy.Permission; import org.eclipse.tractusx.irs.edc.client.policy.PolicyCheckerService; import org.eclipse.tractusx.irs.edc.client.policy.PolicyType; -import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockConfig; +import org.eclipse.tractusx.irs.testing.wiremock.SubmodelFacadeWiremockSupport; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.http.converter.HttpMessageConverter; @@ -242,7 +242,7 @@ void shouldThrowExceptionWhenResponse_500() { } private void prepareNegotiation() { - final String contractAgreementId = SubmodelFacadeWiremockConfig.prepareNegotiation(); + final String contractAgreementId = SubmodelFacadeWiremockSupport.prepareNegotiation(); final EndpointDataReference ref = createEndpointDataReference(contractAgreementId); storage.put(contractAgreementId, ref); } diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index bd512c7cde..c82e73bb8b 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -28,24 +28,24 @@ import static com.github.tomakehurst.wiremock.client.WireMock.verify; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.DISCOVERY_FINDER_URL; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.EDC_DISCOVERY_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.TEST_BPN; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder200; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postDiscoveryFinder404; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery200; -import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockConfig.postEdcDiscovery404; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.DATAPLANE_URL; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.LOOKUP_SHELLS_TEMPLATE; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_PATH; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.SHELL_DESCRIPTORS_TEMPLATE; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells200Empty; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getLookupShells404; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor200; -import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockConfig.getShellDescriptor404; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.DISCOVERY_FINDER_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.DISCOVERY_FINDER_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.EDC_DISCOVERY_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.TEST_BPN; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postDiscoveryFinder200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postDiscoveryFinder404; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postEdcDiscovery200; +import static org.eclipse.tractusx.irs.testing.wiremock.DiscoveryServiceWiremockSupport.postEdcDiscovery404; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.DATAPLANE_URL; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.LOOKUP_SHELLS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.LOOKUP_SHELLS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.SHELL_DESCRIPTORS_PATH; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.SHELL_DESCRIPTORS_TEMPLATE; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getLookupShells200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getLookupShells200Empty; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getLookupShells404; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getShellDescriptor200; +import static org.eclipse.tractusx.irs.testing.wiremock.DtrWiremockSupport.getShellDescriptor404; import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.restTemplateProxy; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockSupport.java similarity index 97% rename from irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java rename to irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockSupport.java index 585803c1b4..0d11ffb12e 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DiscoveryServiceWiremockSupport.java @@ -30,7 +30,7 @@ /** * WireMock configurations and requests used for testing the Discovery Service flow. */ -public final class DiscoveryServiceWiremockConfig { +public final class DiscoveryServiceWiremockSupport { public static final String CONTROLPLANE_PUBLIC_URL = "https://test.edc.io"; public static final String EDC_DISCOVERY_PATH = "/edcDiscovery"; public static final String TEST_BPN = "BPNL00000000TEST"; @@ -41,7 +41,7 @@ public final class DiscoveryServiceWiremockConfig { public static final int STATUS_CODE_OK = 200; public static final int STATUS_CODE_NOT_FOUND = 404; - private DiscoveryServiceWiremockConfig() { + private DiscoveryServiceWiremockSupport() { } public static MappingBuilder postEdcDiscovery200() { diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockSupport.java similarity index 97% rename from irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java rename to irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockSupport.java index 30367044e2..f269e1713b 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/DtrWiremockSupport.java @@ -31,7 +31,7 @@ /** * WireMock configurations and requests used for testing the decentralized DigitalTwinRegistry flow. */ -public final class DtrWiremockConfig { +public final class DtrWiremockSupport { public static final String DATAPLANE_URL = "http://dataplane.test"; public static final String DATAPLANE_PUBLIC_PATH = "/api/public"; public static final String DATAPLANE_PUBLIC_URL = DATAPLANE_URL + DATAPLANE_PUBLIC_PATH; @@ -44,7 +44,7 @@ public final class DtrWiremockConfig { public static final int STATUS_CODE_OK = 200; public static final int STATUS_CODE_NOT_FOUND = 404; - private DtrWiremockConfig() { + private DtrWiremockSupport() { } public static MappingBuilder getShellDescriptor200() { @@ -53,16 +53,16 @@ public static MappingBuilder getShellDescriptor200() { public static MappingBuilder getShellDescriptor200(final String urlRegex) { final String materialForRecycling = submodelDescriptor(DATAPLANE_PUBLIC_URL, - "urn:uuid:19b0338f-6d03-4198-b3b8-5c43f8958d60", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, + "urn:uuid:19b0338f-6d03-4198-b3b8-5c43f8958d60", DiscoveryServiceWiremockSupport.CONTROLPLANE_PUBLIC_URL, "MaterialForRecycling", "urn:uuid:cf06d5d5-e3f8-4bd4-bfcf-81815310701f", "urn:bamm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling"); final String batch = submodelDescriptor(DATAPLANE_PUBLIC_URL, "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", - DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, "Batch", + DiscoveryServiceWiremockSupport.CONTROLPLANE_PUBLIC_URL, "Batch", "urn:uuid:f53db6ef-7a58-4326-9169-0ae198b85dbf", "urn:samm:io.catenax.batch:2.0.0#Batch"); final String singleLevelBomAsBuilt = submodelDescriptor(DATAPLANE_PUBLIC_URL, - "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", DiscoveryServiceWiremockConfig.CONTROLPLANE_PUBLIC_URL, + "urn:uuid:234edd2f-0223-47c7-9fe4-3984ab14c4f9", DiscoveryServiceWiremockSupport.CONTROLPLANE_PUBLIC_URL, "SingleLevelBomAsBuilt", "urn:uuid:0e413809-966b-4107-aae5-aeb28bcdaadf", "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt"); diff --git a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockSupport.java similarity index 99% rename from irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java rename to irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockSupport.java index 361423cf05..cd38948422 100644 --- a/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockConfig.java +++ b/irs-testing/src/main/java/org/eclipse/tractusx/irs/testing/wiremock/SubmodelFacadeWiremockSupport.java @@ -29,7 +29,7 @@ /** * WireMock configurations and requests used for testing the EDC Flow. */ -public final class SubmodelFacadeWiremockConfig { +public final class SubmodelFacadeWiremockSupport { public static final String PATH_CATALOG = "/catalog/request"; public static final String PATH_NEGOTIATE = "/contractnegotiations"; public static final String PATH_TRANSFER = "/transferprocesses"; @@ -50,7 +50,7 @@ public final class SubmodelFacadeWiremockConfig { public static final String EDC_PROVIDER_BPN = "BPNL00000003CRHK"; public static final int STATUS_CODE_OK = 200; - private SubmodelFacadeWiremockConfig() { + private SubmodelFacadeWiremockSupport() { } public static String prepareNegotiation() { From d3235875590df719999b70b554a009e322566f81 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 1 Feb 2024 17:10:38 +0100 Subject: [PATCH 101/116] feat(testing):[#344] Renaming *WireMockConfig to *WireMockSupport, refactoring --- .../SemanticHubWireMockConfig.java | 53 ------------ .../SemanticHubWireMockSupport.java | 84 +++++++++++++++++++ 2 files changed, 84 insertions(+), 53 deletions(-) delete mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java create mode 100644 irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockSupport.java diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java deleted file mode 100644 index cd250f8a7c..0000000000 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockConfig.java +++ /dev/null @@ -1,53 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ -package org.eclipse.tractusx.irs.semanticshub; - -import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; -import static com.github.tomakehurst.wiremock.client.WireMock.get; -import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; -import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; - -import com.github.tomakehurst.wiremock.client.MappingBuilder; - -/** - * WireMock configurations and requests used for testing Semantic Hub fLow. - */ -public final class SemanticHubWireMockConfig { - public static final String BATCH_URN = "urn:samm:io.catenax.batch:2.0.0%23Batch"; - public static final String SEMANTIC_HUB_SCHEMA_URL = "http://semantic.hub/models/{urn}/json-schema"; - private static final String SINGLE_LEVEL_BOM_AS_BUILT_URN = "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0%23SingleLevelBomAsBuilt"; - - private SemanticHubWireMockConfig() { - } - - public static MappingBuilder batchSchemaResponse200() { - return schemaResponse200("/models/" + BATCH_URN + "/json-schema", "semantichub/batch-2.0.0-schema.json"); - } - - public static MappingBuilder singleLevelBomAsBuiltSchemaResponse200() { - return schemaResponse200("/models/" + SINGLE_LEVEL_BOM_AS_BUILT_URN + "/json-schema", - "semantichub/singleLevelBomAsBuilt-2.0.0-schema.json"); - } - - private static MappingBuilder schemaResponse200(final String urlRegex, final String fileName) { - return get(urlPathMatching(urlRegex)).withHost(equalTo("semantic.hub")) - .willReturn(responseWithStatus(200).withBodyFile(fileName)); - } -} \ No newline at end of file diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockSupport.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockSupport.java new file mode 100644 index 0000000000..640755a10e --- /dev/null +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/semanticshub/SemanticHubWireMockSupport.java @@ -0,0 +1,84 @@ +/******************************************************************************** + * Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ +package org.eclipse.tractusx.irs.semanticshub; + +import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; +import static com.github.tomakehurst.wiremock.client.WireMock.exactly; +import static com.github.tomakehurst.wiremock.client.WireMock.get; +import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor; +import static com.github.tomakehurst.wiremock.client.WireMock.stubFor; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching; +import static com.github.tomakehurst.wiremock.client.WireMock.verify; +import static org.eclipse.tractusx.irs.testing.wiremock.WireMockConfig.responseWithStatus; + +/** + * WireMock configurations and requests used for testing Semantic Hub fLow. + */ +public final class SemanticHubWireMockSupport { + public static final String BATCH_URN = "urn:samm:io.catenax.batch:2.0.0%23Batch"; + private static final String SINGLE_LEVEL_BOM_AS_BUILT_URN = "urn:bamm:io.catenax.single_level_bom_as_built:2.0.0%23SingleLevelBomAsBuilt"; + public static final String SCHEMA_PATH_PLACEHOLDER = "/models/%s/json-schema"; + public static final String SEMANTIC_HUB_SCHEMA_URL = + "http://semantic.hub" + SCHEMA_PATH_PLACEHOLDER.formatted("{urn}"); + public static final String MODELS_PATH = "/models"; + + private SemanticHubWireMockSupport() { + } + + public static void semanticHubWillReturnBatchSchema() { + schemaResponse200(SCHEMA_PATH_PLACEHOLDER.formatted(BATCH_URN), "semantichub/batch-2.0.0-schema.json"); + } + + public static void semanticHubWillReturnSingleLevelBomAsBuiltSchema() { + schemaResponse200(SCHEMA_PATH_PLACEHOLDER.formatted(SINGLE_LEVEL_BOM_AS_BUILT_URN), + "semantichub/singleLevelBomAsBuilt-2.0.0-schema.json"); + } + + private static void schemaResponse200(final String urlRegex, final String fileName) { + stubFor(get(urlPathMatching(urlRegex)).withHost(equalTo("semantic.hub")) + .willReturn(responseWithStatus(200).withBodyFile(fileName))); + } + + static void semanticHubWillReturnPagedModels(final int page, final int pageSize, final String fileName) { + stubFor(get(urlPathEqualTo(MODELS_PATH)).withHost(equalTo("semantic.hub")) + .withQueryParam("page", equalTo(String.valueOf(page))) + .withQueryParam("pageSize", equalTo(String.valueOf(pageSize))) + .willReturn(responseWithStatus(200).withBodyFile(fileName))); + } + + public static void semanticHubWillReturnAllModels(final String fileName) { + stubFor(get(urlPathEqualTo(MODELS_PATH)).withHost(equalTo("semantic.hub")) + .willReturn(responseWithStatus(200).withBodyFile(fileName))); + } + + static void semanticHubWillThrowErrorForSemanticModel(final String semanticModel) { + final String url = SCHEMA_PATH_PLACEHOLDER.formatted(semanticModel); + stubFor(get(urlPathEqualTo(url)).willReturn(responseWithStatus(500))); + } + + static void verifySemanticHubWasCalledForModel(final String model, final int times) { + verify(exactly(times), getRequestedFor(urlPathMatching(SCHEMA_PATH_PLACEHOLDER.formatted(model)))); + } + + static void verifySemanticHubWasCalledForAllModels(final int times) { + verify(exactly(times), getRequestedFor(urlPathEqualTo(MODELS_PATH))); + } +} \ No newline at end of file From c7c4aaf8c7116001f311eda7e7a9b0dba9ab4703 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Fri, 2 Feb 2024 10:55:04 +0100 Subject: [PATCH 102/116] docs(testing):[#344] Add issue id to todos --- .../eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java | 2 +- ...ecentralDigitalTwinRegistryServiceWiremockTest.java | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java index 5041293e43..b0c63f0713 100644 --- a/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java +++ b/irs-api/src/test/java/org/eclipse/tractusx/irs/bpdm/BpdmWiremockTest.java @@ -69,7 +69,7 @@ void shouldReturnEmptyOnNotFound() { bpdmWillNotFindCompanyName(bpn); // Act & Assert - // TODO fix implementation to not throw HttpClientErrorException$NotFound + // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatExceptionOfType(HttpClientErrorException.class).isThrownBy( () -> bpdmFacade.findManufacturerName(bpn)); verifyBpdmWasCalledWithBPN(bpn, 1); diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index c82e73bb8b..7c6bee5b80 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -122,7 +122,7 @@ void shouldThrowHttpClientExceptionInCaseOfDiscoveryError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO fix implementation to not throw HttpClientErrorException$NotFound + // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -136,7 +136,7 @@ void shouldThrowHttpClientExceptionInCaseOfEdcDiscoveryError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO fix implementation to not throw HttpClientErrorException$NotFound + // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -152,7 +152,7 @@ void shouldThrowHttpClientExceptionInCaseOfLookupShellsError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO fix implementation to not throw HttpClientErrorException$NotFound + // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -170,7 +170,7 @@ void shouldThrowHttpClientExceptionInCaseOfShellDescriptorsError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO fix implementation to not throw HttpClientErrorException$NotFound + // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); @@ -189,7 +189,7 @@ void shouldThrowExceptionOnEmptyShells() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO fix implementation to not throw HttpClientErrorException$NotFound + // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( HttpClientErrorException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); From 75a16323ff4c2a72e3d026dd62e5b9533beba75c Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Fri, 2 Feb 2024 14:56:25 +0100 Subject: [PATCH 103/116] feat(impl):[#370] fix test --- .../DecentralDigitalTwinRegistryServiceWiremockTest.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index 7c6bee5b80..6594462667 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -58,6 +58,7 @@ import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo; import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; +import org.eclipse.tractusx.irs.component.Shell; import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; @@ -103,12 +104,12 @@ void shouldDiscoverEDCAndRequestRegistry() throws RegistryServiceException { givenThat(getShellDescriptor200()); // Act - final Collection assetAdministrationShellDescriptors = decentralDigitalTwinRegistryService.fetchShells( + final Collection shells = decentralDigitalTwinRegistryService.fetchShells( List.of(new DigitalTwinRegistryKey("testId", TEST_BPN))); // Assert - assertThat(assetAdministrationShellDescriptors).hasSize(1); - assertThat(assetAdministrationShellDescriptors.stream().findFirst().get().getSubmodelDescriptors()).hasSize(3); + assertThat(shells).hasSize(1); + assertThat(shells.stream().findFirst().get().payload().getSubmodelDescriptors()).hasSize(3); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); From ae63bea73e0c7d210a94c3ba17e0fb073db20f2d Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Fri, 2 Feb 2024 15:12:05 +0100 Subject: [PATCH 104/116] feat(impl):[#370] fix test --- ...igitalTwinRegistryServiceWiremockTest.java | 35 +++++++++++++++---- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index 6594462667..4d882d6f5a 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -51,6 +51,8 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; +import java.nio.charset.StandardCharsets; +import java.util.Base64; import java.util.Collection; import java.util.List; import java.util.Map; @@ -59,7 +61,9 @@ import com.github.tomakehurst.wiremock.junit5.WireMockTest; import org.eclipse.edc.spi.types.domain.edr.EndpointDataReference; import org.eclipse.tractusx.irs.component.Shell; -import org.eclipse.tractusx.irs.component.assetadministrationshell.AssetAdministrationShellDescriptor; +import org.eclipse.tractusx.irs.data.StringMapper; +import org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration; +import org.eclipse.tractusx.irs.edc.client.model.EDRAuthCode; import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey; import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.discovery.DiscoveryFinderClientImpl; @@ -86,12 +90,7 @@ void setUp(WireMockRuntimeInfo wireMockRuntimeInfo) throws EdcRetrieverException SHELL_DESCRIPTORS_TEMPLATE, LOOKUP_SHELLS_TEMPLATE); decentralDigitalTwinRegistryService = new DecentralDigitalTwinRegistryService(connectorEndpointsService, endpointDataForConnectorsService, decentralDigitalTwinRegistryClient); - final var endpointDataReference = EndpointDataReference.Builder.newInstance() - .endpoint(DATAPLANE_URL) - .authCode("TEST") - .authKey("X-API-KEY") - .properties(Map.of()) - .build(); + final var endpointDataReference = endpointDataReference("assetId"); when(edcSubmodelFacadeMock.getEndpointReferenceForAsset(any(), any(), any())).thenReturn(endpointDataReference); } @@ -198,4 +197,26 @@ void shouldThrowExceptionOnEmptyShells() { verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); verify(exactly(1), getRequestedFor(urlPathMatching(SHELL_DESCRIPTORS_PATH + ".*"))); } + + private EndpointDataReference endpointDataReference(final String contractAgreementId) { + return EndpointDataReference.Builder.newInstance() + .authKey("X-API-KEY") + .authCode(edrAuthCode(contractAgreementId)) + .properties( + Map.of(JsonLdConfiguration.NAMESPACE_EDC_CID, contractAgreementId)) + .endpoint(DATAPLANE_URL) + .build(); + } + + private String edrAuthCode(final String contractAgreementId) { + final EDRAuthCode edrAuthCode = EDRAuthCode.builder() + .cid(contractAgreementId) + .dad("test") + .exp(9999999999L) + .build(); + final String b64EncodedAuthCode = Base64.getUrlEncoder() + .encodeToString(StringMapper.mapToString(edrAuthCode) + .getBytes(StandardCharsets.UTF_8)); + return "eyJhbGciOiJSUzI1NiJ9." + b64EncodedAuthCode + ".test"; + } } From 0cfba0fc19a8aae81e1ad17207731cd6b62ab06a Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 2 Feb 2024 15:49:41 +0100 Subject: [PATCH 105/116] feat(imp):[#214] improved variable naming and code comment --- .../common/util/concurrent/ResultFinder.java | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 9430e623df..7d7307e03c 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -62,13 +62,15 @@ public CompletableFuture getFastestResult(final List log.debug("Trying to get fastest result from list of futures"); - final CompletableFuture fastestResultPromise = new CompletableFuture<>(); + // The purpose of this overall future is to track when the first data request is successful. + // This way we do not need to wait for the others to complete. + final CompletableFuture overallFuture = new CompletableFuture<>(); final List exceptions = new ArrayList<>(); final var futuresList = futures.stream() .map(future -> future.exceptionally(collectingExceptionsAndThrow(exceptions)) - .handle(completingOnFirstSuccessful(fastestResultPromise))) + .handle(completingOnFirstSuccessful(overallFuture))) .toList(); allOf(toArray(futuresList)).whenComplete((value, ex) -> { @@ -81,14 +83,14 @@ public CompletableFuture getFastestResult(final List .map(ExceptionUtils::getStackTrace) .collect(Collectors.joining(System.lineSeparator())), ex); - fastestResultPromise.completeExceptionally(new CompletionExceptions("None successful", exceptions)); + overallFuture.completeExceptionally(new CompletionExceptions("None successful", exceptions)); } else { log.debug("Completing"); - fastestResultPromise.complete(null); + overallFuture.complete(null); } }); - return fastestResultPromise; + return overallFuture; } private static CompletableFuture[] toArray(final List> handledFutures) { @@ -96,22 +98,21 @@ private static CompletableFuture[] toArray(final List BiFunction completingOnFirstSuccessful( - final CompletableFuture resultPromise) { + final CompletableFuture overallFuture) { return (value, throwable) -> { log.debug("value: '{}', throwable: {}", value, throwable); - final boolean notFinishedByOtherFuture = !resultPromise.isDone(); + final boolean notFinishedByOtherFuture = !overallFuture.isDone(); log.debug("notFinishedByOtherFuture {} ", notFinishedByOtherFuture); final boolean currentFutureSuccessful = throwable == null && value != null; if (notFinishedByOtherFuture && currentFutureSuccessful) { - // first future that completes successfully completes the overall future log.debug("First future that completed successfully"); - resultPromise.complete(value); + overallFuture.complete(value); return true; } else { From ae79585e7b09231c23a6896d3680b88f14ee0ed5 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 2 Feb 2024 15:57:07 +0100 Subject: [PATCH 106/116] feat(imp):[#214] remove superfluous log --- .../tractusx/irs/common/util/concurrent/ResultFinder.java | 1 - 1 file changed, 1 deletion(-) diff --git a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java index 7d7307e03c..a8fd1fb069 100644 --- a/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java +++ b/irs-common/src/main/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinder.java @@ -85,7 +85,6 @@ public CompletableFuture getFastestResult(final List overallFuture.completeExceptionally(new CompletionExceptions("None successful", exceptions)); } else { - log.debug("Completing"); overallFuture.complete(null); } }); From b635cafe2b65430084023773989cf9516543c591 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Fri, 2 Feb 2024 16:07:33 +0100 Subject: [PATCH 107/116] feat(imp):[#214] fix tests The TODOs concerning #405 are resolved by #214. Also removed the type of exception from the method name because this information is in the assert which is sufficient. No need to duplicate this. --- ...igitalTwinRegistryServiceWiremockTest.java | 24 ++++++++----------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index 7c6bee5b80..5347da5449 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -63,9 +63,9 @@ import org.eclipse.tractusx.irs.registryclient.discovery.ConnectorEndpointsService; import org.eclipse.tractusx.irs.registryclient.discovery.DiscoveryFinderClientImpl; import org.eclipse.tractusx.irs.registryclient.exceptions.RegistryServiceException; +import org.eclipse.tractusx.irs.registryclient.exceptions.ShellNotFoundException; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.springframework.web.client.HttpClientErrorException; import org.springframework.web.client.RestTemplate; @WireMockTest @@ -116,7 +116,7 @@ void shouldDiscoverEDCAndRequestRegistry() throws RegistryServiceException { } @Test - void shouldThrowHttpClientExceptionInCaseOfDiscoveryError() { + void shouldThrowInCaseOfDiscoveryError() { // Arrange givenThat(postDiscoveryFinder404()); final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); @@ -124,27 +124,26 @@ void shouldThrowHttpClientExceptionInCaseOfDiscoveryError() { // Act & Assert // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( - HttpClientErrorException.class); + ShellNotFoundException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); } @Test - void shouldThrowHttpClientExceptionInCaseOfEdcDiscoveryError() { + void shouldThrowInCaseOfEdcDiscoveryError() { // Arrange givenThat(postDiscoveryFinder200()); givenThat(postEdcDiscovery404()); final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( - HttpClientErrorException.class); + ShellNotFoundException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); } @Test - void shouldThrowHttpClientExceptionInCaseOfLookupShellsError() { + void shouldThrowInCaseOfLookupShellsError() { // Arrange givenThat(postDiscoveryFinder200()); givenThat(postEdcDiscovery200()); @@ -152,16 +151,15 @@ void shouldThrowHttpClientExceptionInCaseOfLookupShellsError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( - HttpClientErrorException.class); + ShellNotFoundException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); } @Test - void shouldThrowHttpClientExceptionInCaseOfShellDescriptorsError() { + void shouldThrowInCaseOfShellDescriptorsError() { // Arrange givenThat(postDiscoveryFinder200()); givenThat(postEdcDiscovery200()); @@ -170,9 +168,8 @@ void shouldThrowHttpClientExceptionInCaseOfShellDescriptorsError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( - HttpClientErrorException.class); + ShellNotFoundException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); @@ -189,9 +186,8 @@ void shouldThrowExceptionOnEmptyShells() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( - HttpClientErrorException.class); + ShellNotFoundException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); verify(exactly(1), postRequestedFor(urlPathEqualTo(EDC_DISCOVERY_PATH))); verify(exactly(1), getRequestedFor(urlPathEqualTo(LOOKUP_SHELLS_PATH))); From 8e8caed8a3bf6f3805b0382ab212a66dead13b1d Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Mon, 5 Feb 2024 11:56:00 +0100 Subject: [PATCH 108/116] feat(irs):[#249] added missing createdOn, updated insomnia collection --- .../services/PolicyStoreService.java | 8 +- .../services/PolicyStoreServiceTest.java | 4 +- local/testing/IRS_Request_Collection.json | 458 +++++++++--------- 3 files changed, 231 insertions(+), 239 deletions(-) diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java index 87f2dad5d2..3f16e4a90b 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreService.java @@ -23,6 +23,7 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.policystore.services; +import java.time.Clock; import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.List; @@ -57,19 +58,20 @@ public class PolicyStoreService implements AcceptedPoliciesProvider { private final String apiAllowedBpn; private final List allowedPoliciesFromConfig; private final PolicyPersistence persistence; + private final Clock clock; private static final String MISSING_REQUEST_FIELD_MESSAGE = "Request does not contain all required fields. Missing: %s"; public PolicyStoreService(@Value("${apiAllowedBpn:}") final String apiAllowedBpn, - final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig, final PolicyPersistence persistence) { + final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig, final PolicyPersistence persistence, final Clock clock) { this.apiAllowedBpn = apiAllowedBpn; - this.allowedPoliciesFromConfig = createDefaultPolicyFromConfig(defaultAcceptedPoliciesConfig); - this.persistence = persistence; + this.clock = clock; } public void registerPolicy(final Policy policy) { validatePolicy(policy); + policy.setCreatedOn(OffsetDateTime.now(clock)); log.info("Registering new policy with id {}, valid until {}", policy.getPolicyId(), policy.getValidUntil()); try { persistence.save(apiAllowedBpn, policy); diff --git a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java index f118b99545..e218ca2b94 100644 --- a/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java +++ b/irs-policy-store/src/test/java/org/eclipse/tractusx/irs/policystore/services/PolicyStoreServiceTest.java @@ -74,7 +74,7 @@ class PolicyStoreServiceTest { void setUp() { final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig = new DefaultAcceptedPoliciesConfig(); defaultAcceptedPoliciesConfig.setAcceptedPolicies(List.of()); - testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence); + testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence, clock); } @Test @@ -143,7 +143,7 @@ void getDefaultStoredPoliciesWhenEmpty() { EXAMPLE_ACCEPTED_LEFT_OPERAND, "eq", EXAMPLE_ALLOWED_NAME); final DefaultAcceptedPoliciesConfig defaultAcceptedPoliciesConfig = new DefaultAcceptedPoliciesConfig(); defaultAcceptedPoliciesConfig.setAcceptedPolicies(List.of(acceptedPolicy1, acceptedPolicy2)); - testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence); + testee = new PolicyStoreService(BPN, defaultAcceptedPoliciesConfig, persistence, clock); // act final var defaultPolicies = testee.getStoredPolicies(); diff --git a/local/testing/IRS_Request_Collection.json b/local/testing/IRS_Request_Collection.json index 2223c72d5f..246addc92b 100644 --- a/local/testing/IRS_Request_Collection.json +++ b/local/testing/IRS_Request_Collection.json @@ -1,12 +1,12 @@ { "_type": "export", "__export_format": 4, - "__export_date": "2024-01-23T10:32:11.813Z", + "__export_date": "2024-02-05T09:54:46.629Z", "__export_source": "insomnia.desktop.app:v8.6.0", "resources": [ { - "_id": "req_1267e02eed7b49a28ea7e8b70bfe1cf6", - "parentId": "fld_9988da1681c94a2a8ce76b85d744325f", + "_id": "req_168bf1cb28a043d18f376c8d93c82d1a", + "parentId": "fld_ce20d8a3c9d441178febcb303a052551", "modified": 1705006817408, "created": 1705005887617, "url": "{{IRS_HOST}}/irs/policies", @@ -35,8 +35,8 @@ "_type": "request" }, { - "_id": "fld_9988da1681c94a2a8ce76b85d744325f", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_ce20d8a3c9d441178febcb303a052551", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1687243055015, "created": 1687243055015, "name": "Policy Store", @@ -47,8 +47,8 @@ "_type": "request_group" }, { - "_id": "fld_1810e742cdde46ab9d50b692c5b8da98", - "parentId": "wrk_565df8abe30f4da29d8bffcde97927d7", + "_id": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", + "parentId": "wrk_dbeadb1e56e942299e6c920265e6c667", "modified": 1691572726194, "created": 1680682418636, "name": "IRS DEMO Collection", @@ -59,18 +59,18 @@ "_type": "request_group" }, { - "_id": "wrk_565df8abe30f4da29d8bffcde97927d7", + "_id": "wrk_dbeadb1e56e942299e6c920265e6c667", "parentId": null, - "modified": 1680682438221, - "created": 1680682419747, + "modified": 1706524702729, + "created": 1706524692257, "name": "IRS", "description": "", "scope": "collection", "_type": "workspace" }, { - "_id": "req_f4ed2f142c40439998f72e2ceb85380e", - "parentId": "fld_9988da1681c94a2a8ce76b85d744325f", + "_id": "req_d9aec188d27d4e26922788e029f48cb3", + "parentId": "fld_ce20d8a3c9d441178febcb303a052551", "modified": 1702990529632, "created": 1687243204155, "url": "{{IRS_HOST}}/irs/policies/{% prompt 'policyId', '', 'traceability-test', '', false, true %}", @@ -99,8 +99,8 @@ "_type": "request" }, { - "_id": "req_990267ff2ba049fa8e0bfff912088b84", - "parentId": "fld_9988da1681c94a2a8ce76b85d744325f", + "_id": "req_f23abf2cce914010bc0a1b6cca091ad2", + "parentId": "fld_ce20d8a3c9d441178febcb303a052551", "modified": 1702990565006, "created": 1693576003390, "url": "{{IRS_HOST}}/irs/policies/{% prompt 'id', '', 'traceability-test', '', false, true %}", @@ -137,9 +137,9 @@ "_type": "request" }, { - "_id": "req_73b6af41486b4910883d91dea050839e", - "parentId": "fld_9988da1681c94a2a8ce76b85d744325f", - "modified": 1705006437142, + "_id": "req_5d5596ef316341198185c3dab431235c", + "parentId": "fld_ce20d8a3c9d441178febcb303a052551", + "modified": 1707126688041, "created": 1687243182397, "url": "{{IRS_HOST}}/irs/policies", "name": "Register policy", @@ -147,7 +147,7 @@ "method": "POST", "body": { "mimeType": "application/json", - "text": "{\n \"permissions\": [\n {\n \"action\": \"USE\",\n \"constraints\": [\n {\n \"and\": [\n {\n \"leftOperand\": \"FrameworkAgreement.traceability\",\n \"operator\": \"eq\",\n \"rightOperand\": [\n \"active\"\n ]\n },\n {\n \"leftOperand\": \"Membership\",\n \"operator\": \"eq\",\n \"rightOperand\": [\n \"active\"\n ]\n }\n ]\n }\n ]\n }\n ],\n \"policyId\": \"traceability-test\",\n \"validUntil\": \"2024-12-12T23:59:59.999Z\"\n}" + "text": "{\n\t\"validUntil\": \"2025-12-12T23:59:59.999Z\",\n\t\"payload\": {\n\t\t\"@context\": {\n\t\t\t\"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n\t\t},\n\t\t\"@id\": \"policy-id12\",\n\t\t\"policy\": {\n\t\t\t\"odrl:permission\": [\n\t\t\t\t{\n\t\t\t\t\t\"odrl:action\": \"USE\",\n\t\t\t\t\t\"odrl:constraint\": {\n\t\t\t\t\t\t\"odrl:and\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"odrl:leftOperand\": \"Membership\",\n\t\t\t\t\t\t\t\t\"odrl:operator\": {\n\t\t\t\t\t\t\t\t\t\"@id\": \"odrl:eq\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"odrl:rightOperand\": \"active\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"odrl:leftOperand\": \"PURPOSE\",\n\t\t\t\t\t\t\t\t\"odrl:operator\": {\n\t\t\t\t\t\t\t\t\t\"@id\": \"odrl:eq\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"odrl:rightOperand\": \"ID 3.1 Trace\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}" }, "parameters": [], "headers": [ @@ -175,8 +175,8 @@ "_type": "request" }, { - "_id": "req_d5741df44ed441d39c6b9325e6cb60ee", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_0ea20f07e6384c87aec64b664f1f1936", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003275081, "created": 1680682418619, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/shell-descriptors/{% prompt 'aasIdentifier', '', _.GLOBAL_ASSET_ID, '', false, true %}", @@ -207,8 +207,8 @@ "_type": "request" }, { - "_id": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_4990991deee940668b0772802a92dad7", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1691504187689, "created": 1680682418630, "name": "Digital Twin Registry", @@ -219,8 +219,8 @@ "_type": "request_group" }, { - "_id": "req_c9f7bc41a36e4d41b9bf26073e7feb98", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_645f097057dd4d0b8a94530853402acc", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706002920212, "created": 1690529035794, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/shell-descriptors", @@ -251,8 +251,8 @@ "_type": "request" }, { - "_id": "req_4d2cf605282f41ae82adef74435aec12", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_b3e47af3e76746539ca0bf30c60e39ea", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003278149, "created": 1680682418609, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/lookup/shells", @@ -331,8 +331,8 @@ "_type": "request" }, { - "_id": "req_1619abe9652b4b12b38aa24cbd40a7a1", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_d7172466c4bc48e986679e0895b8a2cc", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003280850, "created": 1680682418595, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/lookup/shells", @@ -369,8 +369,8 @@ "_type": "request" }, { - "_id": "req_d6f383445f204a948970420dcda640d0", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_3e07acae12c54acb94dd7aa9a9237b00", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003354109, "created": 1680682418581, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/lookup/shells", @@ -407,8 +407,8 @@ "_type": "request" }, { - "_id": "req_a6b3fee73a4c43e8a5e0449c3c620da7", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_b2e720c47f6145e9915b098cfb162bf4", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003284715, "created": 1680682418570, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/lookup/shells/query", @@ -446,8 +446,8 @@ "_type": "request" }, { - "_id": "req_7245f1e26dea444f97742f993492e803", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_c25fd37611874fb9b9d614c5119fc9f2", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003286642, "created": 1691408320970, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/lookup/shells/query", @@ -485,8 +485,8 @@ "_type": "request" }, { - "_id": "req_8ac0e8a9fe334e6a96dbb168a304ae18", - "parentId": "fld_bb755d1cb6a244aca3c64d9a7e5ac10b", + "_id": "req_3250e5def5654142a519de4427107bbd", + "parentId": "fld_4990991deee940668b0772802a92dad7", "modified": 1706003289343, "created": 1689167429413, "url": "{{DIGITAL_TWIN_REGISTRY}}/api/v3.0/shell-descriptors/{% prompt 'id', '', '', '', false, true %}", @@ -525,8 +525,8 @@ "_type": "request" }, { - "_id": "req_c1523dcf97d14b58bb72cf3253d4fb4b", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_e1cec062761b4714b9d79f95bfb4f052", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991054859, "created": 1680682418551, "url": "{{IRS_HOST}}/irs/jobs", @@ -563,8 +563,8 @@ "_type": "request" }, { - "_id": "fld_c517b707380249f3bd7290d8d22a9138", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_66bf58dc74c24069a012d954a5fcc046", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418562, "created": 1680682418562, "name": "IRS Test Collection", @@ -575,8 +575,8 @@ "_type": "request_group" }, { - "_id": "req_dc3918d6fa9843ffb4fe8e268888a0c4", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_4c94d946a6ca458baf3953f64eb3d2f1", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991058493, "created": 1680682418539, "url": "{{IRS_HOST}}/irs/jobs", @@ -613,8 +613,8 @@ "_type": "request" }, { - "_id": "req_add3363de5c941c1864c49fa8313468e", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_eecb959367ec45538fed6c82871dff36", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991063641, "created": 1680682418524, "url": "{{IRS_HOST}}/irs/jobs", @@ -651,8 +651,8 @@ "_type": "request" }, { - "_id": "req_daffa8d4fd694e388086286b52583a30", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_0cf1f56543b043e0b6c2d60dc1339efb", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991067797, "created": 1680682418514, "url": "{{IRS_HOST}}/irs/jobs", @@ -689,8 +689,8 @@ "_type": "request" }, { - "_id": "req_4741e3623c0a4649807af10b573a1ffb", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_0dd4702af7f44308ae5fc38b1247ddb9", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991071709, "created": 1680682418504, "url": "{{IRS_HOST}}/irs/jobs", @@ -727,8 +727,8 @@ "_type": "request" }, { - "_id": "req_4103f9f43731449c964103eec0aee11d", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_57f0986d2fbd448a8763203a07f4e538", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991076696, "created": 1695042901876, "url": "{{IRS_HOST}}/irs/jobs", @@ -765,8 +765,8 @@ "_type": "request" }, { - "_id": "req_af000a718cd94c38aecbff4f182f5a0b", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_9eb404e09440411da201197459b718be", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991080833, "created": 1680682418488, "url": "{{IRS_HOST}}/irs/jobs", @@ -803,8 +803,8 @@ "_type": "request" }, { - "_id": "req_60460ded5ba94b33b7f9f2373cdea348", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_803a18dc7154479f99ca3323bc502004", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991084713, "created": 1680682418479, "url": "{{IRS_HOST}}/irs/jobs", @@ -841,8 +841,8 @@ "_type": "request" }, { - "_id": "req_4e91ca97acf14f019fac724fe25e1e6c", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_f4f50dc45f2d447fb198671a25fa554c", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991088495, "created": 1680682418469, "url": "{{IRS_HOST}}/irs/jobs", @@ -879,8 +879,8 @@ "_type": "request" }, { - "_id": "req_f269dfad4827462aae4bea5367b442e7", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_adb8c665373d432eb5868cdb54e005ae", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991094498, "created": 1680682418460, "url": "{{IRS_HOST}}/irs/jobs", @@ -917,8 +917,8 @@ "_type": "request" }, { - "_id": "req_1d5b7da6d6b54735a6166251c0a1edfb", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_4d5b921d3b65463c9413a037e19ae4e0", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991098918, "created": 1680682418451, "url": "{{IRS_HOST}}/irs/jobs", @@ -955,8 +955,8 @@ "_type": "request" }, { - "_id": "req_378c52bc81b64e8b95f641c4f655a1d5", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_c78f55430e3c4caa9db40afa18e0071e", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991103182, "created": 1680682418442, "url": "{{IRS_HOST}}/irs/jobs", @@ -993,8 +993,8 @@ "_type": "request" }, { - "_id": "req_38b875ef05d14595b892e65914a6df24", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_cd096c5dd862469ea857cfbaaec565a7", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991107672, "created": 1680682418432, "url": "{{IRS_HOST}}/irs/jobs", @@ -1031,8 +1031,8 @@ "_type": "request" }, { - "_id": "req_c96be1a03513429184f85283557a8d65", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_75498c5f7f4e49a9aa5eaed3f56efbfe", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991113717, "created": 1695192937155, "url": "{{IRS_HOST}}/irs/jobs", @@ -1069,8 +1069,8 @@ "_type": "request" }, { - "_id": "req_33ea4f68b3904bc6bb7ad50dde23632a", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_2c4bd212e2cc4072a77963d1c15bd3c0", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991120609, "created": 1695192971825, "url": "{{IRS_HOST}}/irs/jobs", @@ -1107,8 +1107,8 @@ "_type": "request" }, { - "_id": "req_e18ad8582e204828b06e0de32d30390e", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_daf9e35ba9f94a4abebba38d62c7ad57", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991125292, "created": 1680682418424, "url": "{{IRS_HOST}}/irs/jobs", @@ -1145,8 +1145,8 @@ "_type": "request" }, { - "_id": "req_d52411aa0a6249449a3e99c91b262e4e", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_e88261d8f4c3408183d52a94fe0f64aa", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991130711, "created": 1680682418414, "url": "{{IRS_HOST}}/irs/jobs", @@ -1183,8 +1183,8 @@ "_type": "request" }, { - "_id": "req_c610dd3176ae49d8a96884de371de3c9", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_253793b503264ec586dd5a3981902934", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991137603, "created": 1680682418401, "url": "{{IRS_HOST}}/irs/jobs", @@ -1221,8 +1221,8 @@ "_type": "request" }, { - "_id": "req_07403288d3394387926cd9f0926b3ea4", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_68fe9a6efec74ee9a167a895c8babb10", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991145487, "created": 1680682418392, "url": "{{IRS_HOST}}/irs/jobs", @@ -1259,8 +1259,8 @@ "_type": "request" }, { - "_id": "req_ae4eeade6f854a3b845f1c4b0d1f351d", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_6aac64b0a99e4ffabeb55f10353c357f", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991149742, "created": 1683184048412, "url": "{{IRS_HOST}}/irs/jobs", @@ -1297,8 +1297,8 @@ "_type": "request" }, { - "_id": "req_d2763c0b68e649debd563be84a2e7ac5", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_4138d3ef7c2842e2866fb9be242c4735", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991154342, "created": 1693493383337, "url": "{{IRS_HOST}}/irs/jobs", @@ -1335,8 +1335,8 @@ "_type": "request" }, { - "_id": "req_67e70efe4a904805b6d8d614401097f5", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_9956e174586d4716b2652ed693518241", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991159838, "created": 1693493584873, "url": "{{IRS_HOST}}/irs/jobs", @@ -1373,8 +1373,8 @@ "_type": "request" }, { - "_id": "req_329716a740284e9d92c0e98b08ef8c4d", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_8cc9f463cd5e456f8cc922b9cbfbf35c", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991164094, "created": 1693493594373, "url": "{{IRS_HOST}}/irs/jobs", @@ -1411,8 +1411,8 @@ "_type": "request" }, { - "_id": "req_1e84830bf707450c9aec67763df4db4d", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_162de6be38a749f99ad80c9d73a5062e", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991168363, "created": 1693493604521, "url": "{{IRS_HOST}}/irs/jobs", @@ -1449,8 +1449,8 @@ "_type": "request" }, { - "_id": "req_846efa768fa4440e92d62d103f8268f0", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_cb39bd2420084559a4b8df34efc0225a", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991173689, "created": 1680682418381, "url": "{{IRS_HOST}}/irs/jobs", @@ -1490,8 +1490,8 @@ "_type": "request" }, { - "_id": "req_f44e4fb2955e45b4822b3579a5953370", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_fa00c41986994e53b60fb66f6a7f9b13", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991177973, "created": 1680682418372, "url": "{{IRS_HOST}}/irs/jobs", @@ -1531,8 +1531,8 @@ "_type": "request" }, { - "_id": "req_94e9199eebac41d4aaa24b79a529e712", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_e4960d3aea4a45098a0ad41783ee8b3e", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991182139, "created": 1680682418358, "url": "{{IRS_HOST}}/irs/jobs", @@ -1572,8 +1572,8 @@ "_type": "request" }, { - "_id": "req_bead38a2831748b0908dea7f60b75fcd", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_fab648d9d45b426886a3f8d5d9e07610", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991186114, "created": 1680682418348, "url": "{{IRS_HOST}}/irs/jobs", @@ -1607,8 +1607,8 @@ "_type": "request" }, { - "_id": "req_3388b98dfadf4ca29be1a8c20eb32540", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_47ad9b23e8f646cfaa67e1c14123ed0b", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991190326, "created": 1680682418339, "url": "{{IRS_HOST}}/irs/jobs", @@ -1648,8 +1648,8 @@ "_type": "request" }, { - "_id": "req_690f2cd5e1ad46e497a8c25694fe37ec", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_097638186ae0403aa04692c9e282e14f", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991196283, "created": 1680682418325, "url": "{{IRS_HOST}}/irs/jobs/{% prompt 'Job ID', '', '', '', false, true %}", @@ -1689,8 +1689,8 @@ "_type": "request" }, { - "_id": "req_a232e153a891470e8b82c7e42a86f95f", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_0bb34d3d1ff547d1abe7f50a31b3f225", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991200399, "created": 1680682418316, "url": "{{IRS_HOST}}/irs/jobs/{% prompt 'Job ID', '', '', '', false, true %}", @@ -1724,8 +1724,8 @@ "_type": "request" }, { - "_id": "req_8448f684adbd409eaeb7c017af4b1508", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_a94ae8d8ebb94f758ab6196c97e9061c", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991205447, "created": 1680682418307, "url": "{{IRS_HOST}}/irs/jobs/test", @@ -1759,8 +1759,8 @@ "_type": "request" }, { - "_id": "req_0a5dc1223ebc49ca9aed7114eb470dd7", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_1b10ff658962459db2c6c1b704ff68b8", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991214202, "created": 1680682418297, "url": "{{IRS_HOST}}/irs/jobs/00000000-0000-0000-0000-000000000000", @@ -1794,8 +1794,8 @@ "_type": "request" }, { - "_id": "req_bc8199a1ea134828a0c61c8ce39e5f94", - "parentId": "fld_c517b707380249f3bd7290d8d22a9138", + "_id": "req_fe2049dcfd6b4c06a36069d0bf530e20", + "parentId": "fld_66bf58dc74c24069a012d954a5fcc046", "modified": 1702991218362, "created": 1680682418280, "url": "{{IRS_HOST}}/irs/jobs/{% prompt 'Job ID', '', '', '', false, true %}", @@ -1829,8 +1829,8 @@ "_type": "request" }, { - "_id": "req_71ca4eb08f894036866e35931ca370c9", - "parentId": "fld_476c769969fd4ad7a5d83e31b2a861d9", + "_id": "req_c1a1e632e4364bf3928104eb2700f8a0", + "parentId": "fld_366bdc4025de4610b245e7bc85b90b58", "modified": 1705942015684, "created": 1682672699249, "url": "{{ _.BPN_DISCOVERY }}/api/administration/connectors/bpnDiscovery/search", @@ -1868,8 +1868,8 @@ "_type": "request" }, { - "_id": "fld_476c769969fd4ad7a5d83e31b2a861d9", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_366bdc4025de4610b245e7bc85b90b58", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1683630931664, "created": 1683630887514, "name": "Discovery", @@ -1880,8 +1880,8 @@ "_type": "request_group" }, { - "_id": "req_d7248e0a7b1f4393a5a390b265482415", - "parentId": "fld_476c769969fd4ad7a5d83e31b2a861d9", + "_id": "req_75de594fc67c4e0e89af774b81c3f0af", + "parentId": "fld_366bdc4025de4610b245e7bc85b90b58", "modified": 1705942027574, "created": 1683031718699, "url": "{{ _.DISCOVERY_FINDER }}/api/administration/connectors/discovery/search", @@ -1919,8 +1919,8 @@ "_type": "request" }, { - "_id": "req_77fa47273bf343c7b674d6f6062a4699", - "parentId": "fld_476c769969fd4ad7a5d83e31b2a861d9", + "_id": "req_afa03ef38dd34df8ad7febd021e97b2a", + "parentId": "fld_366bdc4025de4610b245e7bc85b90b58", "modified": 1705942036978, "created": 1683560906453, "url": "{{ _.EDC_DISCOVERY }}/api/administration/connectors/discovery", @@ -1958,8 +1958,8 @@ "_type": "request" }, { - "_id": "req_b02ac0bfc4704c83a5c5f8b24175d61a", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_9d0281b262424f4b8c1ba62e11bb2fa3", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1705006665175, "created": 1680682418265, "url": "{{IRS_HOST}}/irs/jobs", @@ -1996,8 +1996,8 @@ "_type": "request" }, { - "_id": "fld_a78746c77e5042fe9a16e9c07c428503", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418273, "created": 1680682418273, "name": "IRS Basic API Calls", @@ -2008,8 +2008,8 @@ "_type": "request_group" }, { - "_id": "req_8ba77f0c79bd4a3cbb0b9f661a05b03e", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_54c394982fa249618bb7bb46aea068a7", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1705942154792, "created": 1680682418238, "url": "{{IRS_HOST}}/irs/jobs/{% response 'body', 'req_b02ac0bfc4704c83a5c5f8b24175d61a', 'b64::JC5pZA==::46b', 'never', 60 %} ", @@ -2049,8 +2049,8 @@ "_type": "request" }, { - "_id": "req_58c35dbebe62459182db7768eb9cfe38", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_52cadc4a668a4cd58157a434730da4da", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1702991288793, "created": 1680682418257, "url": "{{IRS_HOST}}/irs/jobs", @@ -2084,8 +2084,8 @@ "_type": "request" }, { - "_id": "req_6e01d4795fcd4ec4be9ca7fdc6922fa8", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_2dbc0c6f7cac4e3d990c8f684045d6d2", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1702991284435, "created": 1680682418247, "url": "{{IRS_HOST}}/irs/jobs", @@ -2139,8 +2139,8 @@ "_type": "request" }, { - "_id": "req_78f9f14b26df47858339421fa25b4692", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_b338f7d3e6ea444ca473353ba38e7bfd", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1703236659047, "created": 1690384427379, "url": "{{IRS_HOST}}/irs/jobs/{% prompt 'Job ID', '', '', '', false, true %}", @@ -2180,8 +2180,8 @@ "_type": "request" }, { - "_id": "req_ed05f65eded245b88f2e0e8d345c3aea", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_b17cbac5c1fb4c039569aaaa7a9a5a4e", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1702991276045, "created": 1680682418229, "url": "{{IRS_HOST}}/irs/jobs/{% prompt 'Job ID', '', '', '', false, true %}", @@ -2215,8 +2215,8 @@ "_type": "request" }, { - "_id": "req_5e18d4a7284c43f5aa60ec7e6123a1c7", - "parentId": "fld_a78746c77e5042fe9a16e9c07c428503", + "_id": "req_f57006fe36314a729d471d4e12f67e7e", + "parentId": "fld_0fe6ae4d2f4e4ce4b370fd2792670219", "modified": 1702991272198, "created": 1682498338739, "url": "{{IRS_HOST}}/irs/aspectmodels", @@ -2250,8 +2250,8 @@ "_type": "request" }, { - "_id": "req_6a09b68cf4244a0cb956df180e5f4c82", - "parentId": "fld_f4db18660b724e548809bade6bfce615", + "_id": "req_f95fff1880e54ba898388804f798f85d", + "parentId": "fld_c51adfe29e5e450eb21effa8f3242d1e", "modified": 1705942066941, "created": 1680682418213, "url": "{{ _.SEMANTIC_HUB_URL }}/hub/api/v1/models", @@ -2293,8 +2293,8 @@ "_type": "request" }, { - "_id": "fld_f4db18660b724e548809bade6bfce615", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_c51adfe29e5e450eb21effa8f3242d1e", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418222, "created": 1680682418222, "name": "Semantics Hub", @@ -2305,8 +2305,8 @@ "_type": "request_group" }, { - "_id": "req_b1a321440a2e4dfe902ecca571dc62f5", - "parentId": "fld_f4db18660b724e548809bade6bfce615", + "_id": "req_ee0b0282d68e47e2b950d8722fb09fd2", + "parentId": "fld_c51adfe29e5e450eb21effa8f3242d1e", "modified": 1705942077015, "created": 1680682418204, "url": "{{ _.SEMANTIC_HUB_URL }}/hub/api/v1/models/urn%3Abamm%3Aio.catenax.serial_part_typization%3A1.0.0%23SerialPartTypization", @@ -2335,8 +2335,8 @@ "_type": "request" }, { - "_id": "req_f7f18c23f9ed4b26ba84b6fa81fd5a30", - "parentId": "fld_f4db18660b724e548809bade6bfce615", + "_id": "req_5144d157e6b14563ac9da40036794278", + "parentId": "fld_c51adfe29e5e450eb21effa8f3242d1e", "modified": 1705942085733, "created": 1680682418192, "url": "{{ _.SEMANTIC_HUB_URL }}/hub/api/v1/models/urn%3Abamm%3Aio.catenax.serial_part_typization%3A1.0.0%23SerialPartTypization/json-schema", @@ -2365,8 +2365,8 @@ "_type": "request" }, { - "_id": "req_76a27e96d5d342e8a7354566da95312a", - "parentId": "fld_91009c5cad114695877a204d8fb6e2d1", + "_id": "req_ae558137943343a6ad929382a8b3a29c", + "parentId": "fld_38ea37e2feb443ecbd02440c7d4dc84c", "modified": 1705942100313, "created": 1680682418174, "url": "{{ _.BPDM_URL }}/v1/api/catena/business-partner/{% prompt 'BPN', '', '', '', false, true %}", @@ -2401,8 +2401,8 @@ "_type": "request" }, { - "_id": "fld_91009c5cad114695877a204d8fb6e2d1", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_38ea37e2feb443ecbd02440c7d4dc84c", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418184, "created": 1680682418184, "name": "Business partner data management", @@ -2413,8 +2413,8 @@ "_type": "request_group" }, { - "_id": "req_281c172641d04743b5f4b916639a0fde", - "parentId": "fld_91e10c4c8a0345d6b3a46c5146c12ceb", + "_id": "req_28227bd00d864bc99f67332ec824083f", + "parentId": "fld_7a89506c3c384d70b9beef7abeefbe55", "modified": 1702991347797, "created": 1680682418157, "url": "{{IRS_HOST}}/esr/esr-statistics/{% prompt 'globalAssetId', 'Provide global asset ID or use default', _.GLOBAL_ASSET_ID, '', false, true %}/{% prompt 'BOM Lifecycle', '', '', '', false, true %}/{% prompt 'Certificate', '', '', '', false, true %}/submodel", @@ -2448,8 +2448,8 @@ "_type": "request" }, { - "_id": "fld_91e10c4c8a0345d6b3a46c5146c12ceb", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_7a89506c3c384d70b9beef7abeefbe55", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418167, "created": 1680682418167, "name": "ESR Spike", @@ -2460,8 +2460,8 @@ "_type": "request_group" }, { - "_id": "req_ec674952c1114bce8fb71ea1ed6d9ef7", - "parentId": "fld_e9093d47fe4445c5b0f7a051e4b0f5ad", + "_id": "req_31c8cd5dd85f4cdc8c3ae3af01b034a0", + "parentId": "fld_47f7596261a24253b451004cd8ba2140", "modified": 1702991361578, "created": 1680682418143, "url": "{{IRS_HOST}}/ess/bpn/investigations", @@ -2498,8 +2498,8 @@ "_type": "request" }, { - "_id": "fld_e9093d47fe4445c5b0f7a051e4b0f5ad", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_47f7596261a24253b451004cd8ba2140", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418151, "created": 1680682418151, "name": "ESS Spike", @@ -2510,8 +2510,8 @@ "_type": "request_group" }, { - "_id": "req_98098b47c80842ee9fa4d8a1c00b90cd", - "parentId": "fld_e9093d47fe4445c5b0f7a051e4b0f5ad", + "_id": "req_143d26188fd341b0aa13f5c4784106f2", + "parentId": "fld_47f7596261a24253b451004cd8ba2140", "modified": 1705942138125, "created": 1680682418134, "url": "{{IRS_HOST}}/ess/bpn/investigations/{% response 'body', 'req_ec674952c1114bce8fb71ea1ed6d9ef7', 'b64::JC5pZA==::46b', 'never', 60 %}", @@ -2545,8 +2545,8 @@ "_type": "request" }, { - "_id": "req_53b8324bea944948ae6156efa74b35a2", - "parentId": "fld_e9093d47fe4445c5b0f7a051e4b0f5ad", + "_id": "req_8a0b5ce9751f470cb590a511ae97fb74", + "parentId": "fld_47f7596261a24253b451004cd8ba2140", "modified": 1702991370481, "created": 1680682418134, "url": "{{IRS_HOST}}/ess/bpn/investigations/{% prompt 'Job ID', '', '', '', false, true %}", @@ -2580,8 +2580,8 @@ "_type": "request" }, { - "_id": "req_92b9561d03a54fe79c34d95a93ba0955", - "parentId": "fld_3112c2de59e04e4ea40e8d82a8844ccc", + "_id": "req_ae50b9e3429249719df0aea840ec9456", + "parentId": "fld_576c196fe0fb4274b90431b1b35ae3a6", "modified": 1702991381651, "created": 1680682418118, "url": "{{IRS_HOST}}/irs/orders", @@ -2618,8 +2618,8 @@ "_type": "request" }, { - "_id": "fld_3112c2de59e04e4ea40e8d82a8844ccc", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_576c196fe0fb4274b90431b1b35ae3a6", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1680682418128, "created": 1680682418128, "name": "Batch Processing", @@ -2630,8 +2630,8 @@ "_type": "request_group" }, { - "_id": "req_7b406e4b799c4c06b26b8989cccdfca9", - "parentId": "fld_3112c2de59e04e4ea40e8d82a8844ccc", + "_id": "req_76bbe66f75cd4deab0452c7e2b281305", + "parentId": "fld_576c196fe0fb4274b90431b1b35ae3a6", "modified": 1702991390349, "created": 1696342619602, "url": "{{IRS_HOST}}/irs/ess/orders", @@ -2668,8 +2668,8 @@ "_type": "request" }, { - "_id": "req_78db20c6fbec4ef4a64a15f2b28fe8b9", - "parentId": "fld_3112c2de59e04e4ea40e8d82a8844ccc", + "_id": "req_e5d03176a6f84e7ba6f9e0a293497c0c", + "parentId": "fld_576c196fe0fb4274b90431b1b35ae3a6", "modified": 1705006936944, "created": 1705006139836, "url": "{{IRS_HOST}}/irs/orders/{% prompt 'Order ID', '', '', '', false, true %}", @@ -2707,8 +2707,8 @@ "_type": "request" }, { - "_id": "req_963d3326f7554d41b6730a3b5f293e21", - "parentId": "fld_3112c2de59e04e4ea40e8d82a8844ccc", + "_id": "req_5f370d022e0b422b967d6c80c8a91e2d", + "parentId": "fld_576c196fe0fb4274b90431b1b35ae3a6", "modified": 1702991398473, "created": 1680682418109, "url": "{{IRS_HOST}}/irs/orders/{% prompt 'Order ID', '', '', '', false, true %}", @@ -2742,8 +2742,8 @@ "_type": "request" }, { - "_id": "req_0b2b42f0de3d445eb2dfebe7338cba2f", - "parentId": "fld_3112c2de59e04e4ea40e8d82a8844ccc", + "_id": "req_cd0d65ae1507433891eb7d2a05d5d366", + "parentId": "fld_576c196fe0fb4274b90431b1b35ae3a6", "modified": 1702991409664, "created": 1680682418099, "url": "{{IRS_HOST}}/irs/orders/{% prompt 'Order ID', '', '', '', false, true %}/batches/{% prompt 'Batch ID', '', '', '', false, true %}", @@ -2777,8 +2777,8 @@ "_type": "request" }, { - "_id": "req_c94c97ae6a724112b590952b9a7a0dea", - "parentId": "fld_d5e9b62b127847188e1e4b518720a102", + "_id": "req_5e7e778b5e6543fcb9eea7b99073c93e", + "parentId": "fld_05b3542403444219baacd303af0aee7d", "modified": 1690472186478, "created": 1678358655308, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/catalog/request", @@ -2815,8 +2815,8 @@ "_type": "request" }, { - "_id": "fld_d5e9b62b127847188e1e4b518720a102", - "parentId": "fld_0839b47b8e964caa9174f954735ab106", + "_id": "fld_05b3542403444219baacd303af0aee7d", + "parentId": "fld_ea70da20cb354243839c8f775fe3bd85", "modified": 1690362660167, "created": 1690362660167, "name": "Catalog", @@ -2827,8 +2827,8 @@ "_type": "request_group" }, { - "_id": "fld_0839b47b8e964caa9174f954735ab106", - "parentId": "fld_1810e742cdde46ab9d50b692c5b8da98", + "_id": "fld_ea70da20cb354243839c8f775fe3bd85", + "parentId": "fld_7ea21da81d7f43b59b1eadd5558a0d4e", "modified": 1690363778601, "created": 1675675609576, "name": "EDC-Requests", @@ -2839,8 +2839,8 @@ "_type": "request_group" }, { - "_id": "req_13e43b7f93484f80b8006c04b582e128", - "parentId": "fld_d5e9b62b127847188e1e4b518720a102", + "_id": "req_d662c03a94f446d2afc6d8ada83bfe3e", + "parentId": "fld_05b3542403444219baacd303af0aee7d", "modified": 1691500654267, "created": 1685521485278, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/catalog/request", @@ -2877,8 +2877,8 @@ "_type": "request" }, { - "_id": "req_d10e25e171d44f0581305ceec28c90bc", - "parentId": "fld_d5e9b62b127847188e1e4b518720a102", + "_id": "req_c32a0a83b43d494e9cbffdfe035badec", + "parentId": "fld_05b3542403444219baacd303af0aee7d", "modified": 1705940987109, "created": 1691654388376, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/catalog/request", @@ -2915,8 +2915,8 @@ "_type": "request" }, { - "_id": "req_080fffcbca8246cca56c1b89e2ee87d7", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_f745598008ad40808cce24fa009d9c4d", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1691578280640, "created": 1675675609557, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/contractnegotiations", @@ -2953,8 +2953,8 @@ "_type": "request" }, { - "_id": "fld_1e28df04607146aa953989fb9b878c79", - "parentId": "fld_0839b47b8e964caa9174f954735ab106", + "_id": "fld_d6f7d906c7fd4203b8c75da059900aa9", + "parentId": "fld_ea70da20cb354243839c8f775fe3bd85", "modified": 1684146626847, "created": 1684146519491, "name": "Negotiation", @@ -2965,8 +2965,8 @@ "_type": "request_group" }, { - "_id": "req_4b81e1450a7044f4b495396a3c6beec5", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_3f181fd162664bb89604fd311628d84e", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1690362123962, "created": 1675675609549, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/contractnegotiations/{% prompt 'id', '', '', '', false, true %}", @@ -3000,8 +3000,8 @@ "_type": "request" }, { - "_id": "req_941858a9157241bdb4b143f49461378e", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_41e49b80380f401ca7ba1c3079e36acf", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1690362117725, "created": 1685444139708, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/contractnegotiations/{% prompt 'id', '', '', '', false, true %}/cancel", @@ -3030,8 +3030,8 @@ "_type": "request" }, { - "_id": "req_d321712166e0404798f4c201b8928aba", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_dd017a01aaef4e6aa43a006a7116cbd2", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1690361721223, "created": 1681911985730, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/contractnegotiations/request", @@ -3068,8 +3068,8 @@ "_type": "request" }, { - "_id": "req_4ef3b469eec84623ba6fb1558baf732d", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_8315d1cf3016462ebaf36b221ff121b7", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1691578311420, "created": 1675675609541, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/transferprocesses", @@ -3106,8 +3106,8 @@ "_type": "request" }, { - "_id": "req_e86d72124f744590931f5cdf6d4ba618", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_475b5dc25a0349a0bdaf1388767009d3", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1691503370103, "created": 1679993996270, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/transferprocesses/{% prompt 'id', '', '', '', false, true %}", @@ -3141,8 +3141,8 @@ "_type": "request" }, { - "_id": "req_a4cd5461e45d44d1b0ce29c5076dd8ab", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_b7d4d2ae87f848d18e09fa9066a64def", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1690361795179, "created": 1675675609525, "url": "{{ _.CONSUMER_CONTROLPLANE }}/management/v2/transferprocesses/request", @@ -3179,8 +3179,8 @@ "_type": "request" }, { - "_id": "req_c13b0227ea6649c185319bddf09e1ff4", - "parentId": "fld_1e28df04607146aa953989fb9b878c79", + "_id": "req_07bb49740fd6490d960262fe773ca273", + "parentId": "fld_d6f7d906c7fd4203b8c75da059900aa9", "modified": 1690361763512, "created": 1681910653593, "url": "{{CONSUMER_CONTROLPLANE}}/management/v2/contractagreements/request", @@ -3217,8 +3217,8 @@ "_type": "request" }, { - "_id": "req_cd795997401045719846198f474ac6c4", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_9c20ac607a1f4dd2ac6fa7d44464ee39", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362947546, "created": 1681907482278, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/assets", @@ -3255,8 +3255,8 @@ "_type": "request" }, { - "_id": "fld_b72920a81fc94ba7ac254f87c04e4bdc", - "parentId": "fld_0839b47b8e964caa9174f954735ab106", + "_id": "fld_cdf7808307974213bddcaa8c454ebfa4", + "parentId": "fld_ea70da20cb354243839c8f775fe3bd85", "modified": 1705940929752, "created": 1684146457388, "name": "Provider", @@ -3267,8 +3267,8 @@ "_type": "request_group" }, { - "_id": "req_1b5a18e8940948b3b0593152919f0f98", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_491fb44312cc49138ce948dffd4342d5", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362407763, "created": 1685444139630, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/assets/{% prompt 'id', '', '', '', false, true %}", @@ -3297,8 +3297,8 @@ "_type": "request" }, { - "_id": "req_b00faefd0be84da8972cfe82c018103f", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_244dee9fd5a64fafa2f5ac5bdaa6994d", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362438115, "created": 1685444139625, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/assets/request", @@ -3335,8 +3335,8 @@ "_type": "request" }, { - "_id": "req_7705a8d515234eeda8a00b72b33c0810", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_27e29ff2819d489ea9248fab518be562", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362400081, "created": 1685444139636, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/assets/{% prompt 'id', '', '', '', false, true %}", @@ -3365,8 +3365,8 @@ "_type": "request" }, { - "_id": "req_b3df4c26f45442b0969e2601ba943f91", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_605ebafb36034d11b783f2c20fe0e764", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362581978, "created": 1685444139641, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/policydefinitions", @@ -3403,8 +3403,8 @@ "_type": "request" }, { - "_id": "req_cccc83c71e834cac9e1e7e1562930645", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_3d746a9c3a52496499bf5bfac31acbad", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362549290, "created": 1685444139647, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/policydefinitions/{% prompt 'id', '', '', '', false, true %}", @@ -3433,8 +3433,8 @@ "_type": "request" }, { - "_id": "req_b628dd4600654a57a3d1c4abd71f032f", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_15a39c3c4029494ca53867d6a3c28a33", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362591799, "created": 1685444139653, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/policydefinitions/request", @@ -3471,8 +3471,8 @@ "_type": "request" }, { - "_id": "req_c2c69580f2014ea0af92c45b3efa1a0a", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_487d7bd02af746db8c6cda9d0f4d662a", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362559324, "created": 1685444139659, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/policydefinitions/{% prompt 'id', '', '', '', false, true %}", @@ -3501,8 +3501,8 @@ "_type": "request" }, { - "_id": "req_9de3020e595e4a79ade1de9bbb5645bd", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_324212ad1f21447880f16ad152d861ab", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690363080444, "created": 1685444139665, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/contractdefinitions", @@ -3539,8 +3539,8 @@ "_type": "request" }, { - "_id": "req_30779ac0b772473094ad1ab750784f72", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_d90aecacb8e446c795a6b0fc8e007e90", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690362691392, "created": 1685444139672, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/contractdefinitions/{% prompt 'id', '', '', '', false, true %}", @@ -3569,8 +3569,8 @@ "_type": "request" }, { - "_id": "req_30af5f472981473c9cfec7fe1cceacd6", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_d0cc3341bce24e3aa7459b319755e918", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690363126919, "created": 1685444139678, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/contractdefinitions/request", @@ -3607,8 +3607,8 @@ "_type": "request" }, { - "_id": "req_dbc8413f51774f0bab4afdbee92b9b21", - "parentId": "fld_b72920a81fc94ba7ac254f87c04e4bdc", + "_id": "req_13b593535b3e46f2904fd938a830bd66", + "parentId": "fld_cdf7808307974213bddcaa8c454ebfa4", "modified": 1690363136216, "created": 1685444139684, "url": "{{ _.PROVIDER_CONTROLPLANE_1 }}/management/v2/contractdefinitions/{% prompt 'id', '', '', '', false, true %}", @@ -3645,8 +3645,8 @@ "_type": "request" }, { - "_id": "env_d2b7eb1621841465ea24b73343568b286aa8ac9a", - "parentId": "wrk_565df8abe30f4da29d8bffcde97927d7", + "_id": "env_0bce3b8371da4128ab2299d44b2e5324", + "parentId": "wrk_dbeadb1e56e942299e6c920265e6c667", "modified": 1683638503332, "created": 1680782486844, "name": "Base Environment", @@ -3658,8 +3658,8 @@ "_type": "environment" }, { - "_id": "jar_d2b7eb1621841465ea24b73343568b286aa8ac9a", - "parentId": "wrk_565df8abe30f4da29d8bffcde97927d7", + "_id": "jar_dbc637bc345d403a8f7dd19f333a3bde", + "parentId": "wrk_dbeadb1e56e942299e6c920265e6c667", "modified": 1705938127468, "created": 1680782486851, "name": "Default Jar", @@ -3788,16 +3788,6 @@ } ], "_type": "cookie_jar" - }, - { - "_id": "spc_22dfe33611af4731965cc2b08febcfdb", - "parentId": "wrk_565df8abe30f4da29d8bffcde97927d7", - "modified": 1680782484284, - "created": 1680782484284, - "fileName": "IRS", - "contents": "", - "contentType": "yaml", - "_type": "api_spec" } ] } \ No newline at end of file From ab0c158f59bb1086cd563b2c0ca9d9cea9c7a7af Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Mon, 5 Feb 2024 12:00:21 +0100 Subject: [PATCH 109/116] feat(irs):[#249] shorten to list in stream in policy controller --- .../irs/policystore/controllers/PolicyStoreController.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java index 97cb6cacd3..10de9f88ff 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java @@ -138,7 +138,7 @@ public void registerAllowedPolicy(final @RequestBody CreatePolicyRequest request public List getPolicies() { return service.getStoredPolicies().stream() .map(PolicyResponse::fromPolicy) - .collect(Collectors.toList()); + .toList(); } @Operation(operationId = "deleteAllowedPolicy", From 465ca2650ab4f4af90ca6b2b54a56aa244435a30 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Mon, 5 Feb 2024 12:11:11 +0100 Subject: [PATCH 110/116] feat(irs):[#249] import fix --- .../irs/policystore/controllers/PolicyStoreController.java | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java index 10de9f88ff..56aa0e1b72 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java @@ -27,9 +27,6 @@ import static org.eclipse.tractusx.irs.common.ApiConstants.UNAUTHORIZED_DESC; import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; -import java.util.List; -import java.util.stream.Collectors; - import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.ArraySchema; import io.swagger.v3.oas.annotations.media.Content; @@ -39,6 +36,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.security.SecurityRequirement; import jakarta.validation.Valid; +import java.util.List; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.eclipse.tractusx.irs.common.auth.IrsRoles; From d1c34aa6b105ab41b1926c01b06285d2c9618c5f Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 5 Feb 2024 13:07:14 +0100 Subject: [PATCH 111/116] feat(imp):[#214] Remove obsolete TODO --- .../DecentralDigitalTwinRegistryServiceWiremockTest.java | 1 - 1 file changed, 1 deletion(-) diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java index 8b1145a2ea..36ce0ff1b6 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceWiremockTest.java @@ -122,7 +122,6 @@ void shouldThrowInCaseOfDiscoveryError() { final List testId = List.of(new DigitalTwinRegistryKey("testId", TEST_BPN)); // Act & Assert - // TODO (#405) fix implementation to not throw HttpClientErrorException$NotFound assertThatThrownBy(() -> decentralDigitalTwinRegistryService.fetchShells(testId)).isInstanceOf( ShellNotFoundException.class); verify(exactly(1), postRequestedFor(urlPathEqualTo(DISCOVERY_FINDER_PATH))); From e7a4ef85f761dd2590f15e9ea6373b6d9674ad01 Mon Sep 17 00:00:00 2001 From: Pawel Sosnowski Date: Mon, 5 Feb 2024 15:42:38 +0100 Subject: [PATCH 112/116] feat(irs):[#207] added more info to concept --- ...207-redisign-metrics-used-in-summary-inside-job-response.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md b/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md index d060dc208d..49217d4ec4 100644 --- a/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md +++ b/docs/concept/#207-redisign-metrics-used-in-summary-inside-job-response/#207-redisign-metrics-used-in-summary-inside-job-response.md @@ -51,4 +51,5 @@ They should be distinguished by the type, so when step 12 (complete) is executed ``` Tree is stored as list of nodes in list of Relationships as filed `private List relationships;` in `ItemContainer`. Tree is assebmled in class `ItemTreesAssembler` in method `retrieveItemGraph`. -We should get the depth of the tree and add it to the response. Consider using https://www.geeksforgeeks.org/depth-n-ary-tree/ +We should get the depth of the tree and add it to the response. Consider using https://www.geeksforgeeks.org/depth-n-ary-tree/ +Important to note that determining the depth of a running job like this is only suitable as some sort of progress bar. The actual "completion by depth" criteria still has to be evaluated in the DigitalTwinDelegate and needs to be done independently for every branch of the tree From 868cd524455fc00217a6815b0c79ead80a7a6a16 Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 5 Feb 2024 16:19:06 +0100 Subject: [PATCH 113/116] chore(tests):[#xxx] Test method naming following Google Style Guide --- .../irs/common/util/concurrent/ResultFinderTest.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java index c98ea5e83c..90c783f276 100644 --- a/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java +++ b/irs-common/src/test/java/org/eclipse/tractusx/irs/common/util/concurrent/ResultFinderTest.java @@ -52,14 +52,14 @@ class ResultFinderTest { @NullAndEmptySource @ParameterizedTest - void with_null_or_empty_input_list_it_should_return_null(final List> list) + void withNullOrEmptyInputList_nullShouldBeReturned(final List> list) throws ExecutionException, InterruptedException { final var result = sut.getFastestResult(list).get(); assertThat(result).isNull(); } @Test - void with_one_successful_CompletableFuture_it_should_return_the_successful_result() + void withOneSuccessfulCompletableFuture_theSuccessfulResultShouldBeReturned() throws ExecutionException, InterruptedException { final var futures = List.of(supplyAsync(() -> "ok")); final String result = sut.getFastestResult(futures).get(); @@ -67,7 +67,7 @@ void with_one_successful_CompletableFuture_it_should_return_the_successful_resul } @Test - void with_only_successful_and_other_CompletableFutures_failing_it_should_return_the_successful_result() + void withOnlyOneSuccessful_andOtherCompletableFuturesFailing_theSuccessfulResultShouldBeReturned() throws ExecutionException, InterruptedException { // given @@ -88,7 +88,7 @@ void with_only_successful_and_other_CompletableFutures_failing_it_should_return_ } @Test - void with_all_CompletableFutures_failing_it_should_throw() { + void withAllCompletableFuturesFailing_itShouldThrow() { // given final List> futures = List.of( // @@ -117,7 +117,7 @@ void with_all_CompletableFutures_failing_it_should_throw() { } @Test - void with_multiple_successful_CompletableFutures_it_should_return_fastest_successful_result() + void withMultipleSuccessfulCompletableFutures_theFastestSuccessfulResultShouldBeReturned() throws ExecutionException, InterruptedException { // given From d0c51c3ab8cee6b658a5ea4bea74cddbb41eb35d Mon Sep 17 00:00:00 2001 From: Matthias Fischer Date: Mon, 5 Feb 2024 16:24:02 +0100 Subject: [PATCH 114/116] chore(tests):[#xxx] Test method naming following Google Style Guide --- .../DecentralDigitalTwinRegistryServiceTest.java | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java index 850281176e..926b9de649 100644 --- a/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java +++ b/irs-registry-client/src/test/java/org/eclipse/tractusx/irs/registryclient/decentral/DecentralDigitalTwinRegistryServiceTest.java @@ -83,7 +83,7 @@ public static AssetAdministrationShellDescriptor shellDescriptor( class FetchShellsTests { @Test - void should_return_expected_shell() throws RegistryServiceException { + void shouldReturnExpectedShell() throws RegistryServiceException { // given final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); @@ -110,7 +110,7 @@ void should_return_expected_shell() throws RegistryServiceException { } @Test - void when_InterruptedException_occurs() throws ExecutionException, InterruptedException { + void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedException { // given simulateResultFinderInterrupted(); @@ -144,7 +144,7 @@ void when_InterruptedException_occurs() throws ExecutionException, InterruptedEx } @Test - void when_ExecutionException_occurs() { + void whenExecutionExceptionOccurs() { // given simulateGetFastestResultFailedFuture(); @@ -175,7 +175,7 @@ void when_ExecutionException_occurs() { } @Test - void should_throw_ShellNotFoundException_if_no_digital_twin_registry_keys_given() { + void shouldThrowShellNotFoundException_ifNoDigitalTwinRegistryKeysGiven() { assertThatThrownBy(() -> sut.fetchShells(emptyList())).isInstanceOf(ShellNotFoundException.class); } @@ -205,7 +205,7 @@ private static EndpointDataReference endpointDataReference(final String url) { class LookupGlobalAssetIdsTests { @Test - void should_return_the_expected_globalAssetId() throws RegistryServiceException { + void shouldReturnTheExpectedGlobalAssetId() throws RegistryServiceException { // given final var digitalTwinRegistryKey = new DigitalTwinRegistryKey( "urn:uuid:4132cd2b-cbe7-4881-a6b4-39fdc31cca2b", "bpn"); @@ -238,7 +238,7 @@ void should_return_the_expected_globalAssetId() throws RegistryServiceException } @Test - void when_InterruptedException_occurs() throws ExecutionException, InterruptedException { + void whenInterruptedExceptionOccurs() throws ExecutionException, InterruptedException { // given simulateResultFinderInterrupted(); @@ -253,7 +253,7 @@ void when_InterruptedException_occurs() throws ExecutionException, InterruptedEx } @Test - void when_ExecutionException_occurs() { + void whenExecutionExceptionOccurs() { // given simulateGetFastestResultFailedFuture(); From c1116db8d8b92b869507d06e16fd0e4436314c8f Mon Sep 17 00:00:00 2001 From: ds-alexander-bulgakov Date: Tue, 6 Feb 2024 08:10:36 +0100 Subject: [PATCH 115/116] feat(testing):[370] created tavern tests for checking contractAgreementIds in shells and submodels --- .../api-tests/irs-api-tests.tavern.yaml | 114 ++++++++++++++++++ local/testing/api-tests/tavern_helpers.py | 35 +++++- 2 files changed, 147 insertions(+), 2 deletions(-) diff --git a/local/testing/api-tests/irs-api-tests.tavern.yaml b/local/testing/api-tests/irs-api-tests.tavern.yaml index c9de2ed681..e76a085bfd 100644 --- a/local/testing/api-tests/irs-api-tests.tavern.yaml +++ b/local/testing/api-tests/irs-api-tests.tavern.yaml @@ -3200,5 +3200,119 @@ stages: status_code: 200 verify_response_with: function: local.testing.api-tests.tavern_helpers:check_batches_are_canceled_correctly + headers: + content-type: application/json + + +--- + + +test_name: Make sure jobs are responsed with contractAgreementIds in shells and submodels if auditContractNegotiation activated + +strict: + - headers:off + - json:off + +stages: + - name: create a job and check for success + request: + url: "{tavern.env_vars.IRS_HOST}/irs/jobs" + json: + key: + globalAssetId: "{tavern.env_vars.GLOBAL_ASSET_ID_AS_BUILT}" + bpn: "{tavern.env_vars.BPN_AS_BUILT}" + collectAspects: true + auditContractNegotiation: true + depth: 2 + aspects: + - SerialPart + direction: "downward" + method: POST + headers: + content-type: application/json + $ext: + function: local.testing.api-tests.tavern_helpers:create_api_key + response: + status_code: 201 + headers: + content-type: application/json + save: + json: + job_id: id + + - *verify_job_is_running_and_wait_up_to_15_minutes_for_COMPLETED + + - name: verify job response with desired test steps + request: + url: "{tavern.env_vars.IRS_HOST}/irs/jobs/{job_id}" + params: + returnUncompletedJob: true + method: GET + headers: + content-type: application/json + $ext: + function: local.testing.api-tests.tavern_helpers:create_api_key + response: + status_code: 200 + verify_response_with: + - function: local.testing.api-tests.tavern_helpers:contractAgreementId_in_shells_existing + - function: local.testing.api-tests.tavern_helpers:contractAgreementId_in_submodels_existing + headers: + content-type: application/json + + +--- + + +test_name: Make sure jobs are not responsed with contractAgreementIds in shells and submodels if auditContractNegotiation deactivated + +strict: + - headers:off + - json:off + +stages: + - name: create a job and check for success + request: + url: "{tavern.env_vars.IRS_HOST}/irs/jobs" + json: + key: + globalAssetId: "{tavern.env_vars.GLOBAL_ASSET_ID_AS_BUILT}" + bpn: "{tavern.env_vars.BPN_AS_BUILT}" + collectAspects: true + auditContractNegotiation: false + depth: 2 + aspects: + - SerialPart + direction: "downward" + method: POST + headers: + content-type: application/json + $ext: + function: local.testing.api-tests.tavern_helpers:create_api_key + response: + status_code: 201 + headers: + content-type: application/json + save: + json: + job_id: id + + - *verify_job_is_running_and_wait_up_to_15_minutes_for_COMPLETED + + - name: verify job response with desired test steps + request: + url: "{tavern.env_vars.IRS_HOST}/irs/jobs/{job_id}" + params: + returnUncompletedJob: true + method: GET + headers: + content-type: application/json + $ext: + function: local.testing.api-tests.tavern_helpers:create_api_key + response: + status_code: 200 + verify_response_with: + - function: local.testing.api-tests.tavern_helpers:contractAgreementId_in_shells_not_existing + - function: local.testing.api-tests.tavern_helpers:contractAgreementId_in_submodels_not_existing headers: content-type: application/json \ No newline at end of file diff --git a/local/testing/api-tests/tavern_helpers.py b/local/testing/api-tests/tavern_helpers.py index 22f7c934d2..50a0a0164e 100644 --- a/local/testing/api-tests/tavern_helpers.py +++ b/local/testing/api-tests/tavern_helpers.py @@ -1,4 +1,3 @@ -# testing_utils.py from datetime import datetime import os @@ -354,4 +353,36 @@ def create_api_key(): def create_api_key_ess(): api_key = os.getenv('ADMIN_USER_API_KEY_ESS') - return {"X-API-KEY": api_key} \ No newline at end of file + return {"X-API-KEY": api_key} + + +def contractAgreementId_in_shells_existing(response): + shells = response.json().get("shells") + print("shells ", shells) + assert len(shells) >= 1 + for i in shells: + assert i.get("contractAgreementId") is not None + + +def contractAgreementId_in_submodels_existing(response): + submodels = response.json().get("submodels") + print("submodels ", submodels) + assert len(submodels) >= 1 + for i in submodels: + assert i.get("contractAgreementId") is not None + + +def contractAgreementId_in_shells_not_existing(response): + shells = response.json().get("shells") + print("shells ", shells) + assert len(shells) >= 1 + for i in shells: + assert i.get("contractAgreementId") is None + + +def contractAgreementId_in_submodels_not_existing(response): + submodels = response.json().get("submodels") + print("submodels ", submodels) + assert len(submodels) >= 1 + for i in submodels: + assert i.get("contractAgreementId") is None From 4c28b2917b892f3663a05437449d79b3478bf133 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann <57985712+ds-jhartmann@users.noreply.github.com> Date: Tue, 6 Feb 2024 10:49:43 +0100 Subject: [PATCH 116/116] Revert "Revert "Revert "feat(impl):[#378] separate credentials config""" --- CHANGELOG.md | 1 - charts/irs-helm/CHANGELOG.md | 8 ---- .../configmap-spring-app-config.yaml | 30 ++++-------- charts/irs-helm/templates/deployment.yaml | 26 ++++------- charts/irs-helm/templates/secrets.yaml | 10 ++-- charts/irs-helm/values.yaml | 25 ++++------ docs/src/api/irs-api.yaml | 46 ++++++++++--------- .../docs/administration/configuration.adoc | 20 ++------ .../configuration/OpenApiConfiguration.java | 21 +++++---- .../configuration/RegistryConfiguration.java | 4 +- .../irs/configuration/RestTemplateConfig.java | 8 ++-- .../irs/controllers/BatchController.java | 10 ++-- .../irs/controllers/IrsController.java | 10 ++-- .../irs/ess/controller/EssController.java | 4 +- irs-api/src/main/resources/application.yml | 44 ++++++++---------- .../configuration/JsonLdConfiguration.java | 5 +- .../client/transformer/EdcTransformer.java | 4 +- .../controllers/PolicyStoreController.java | 8 ++-- 18 files changed, 118 insertions(+), 166 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e5a7076fd6..3fee6872e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" - Changed lookupGlobalAssetIds to lookupShellsByBPN, which provides full object. - Suppressed CVE-2024-20932 from graal-sdk-21.2.0.jar because this is not applicable for IRS. -- Updated configuration of `DISCOVERY_REST_TEMPLATE` from `ess.discovery.*` to `digitalTwinRegistry.discovery.*` and discovery finder URL from `digitalTwinRegistry.discoveryFinderUrl` to `digitalTwinRegistry.discovery.discoveryFinderUrl` - Redesigned Shell object - wrapped payload and added "contractAgreementId" field - Changed structure of Policy creation to match EDC format diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md index b782d71a16..28169057dd 100644 --- a/charts/irs-helm/CHANGELOG.md +++ b/charts/irs-helm/CHANGELOG.md @@ -5,14 +5,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] -### Added -- Added configuration parameters `oauth2.semantics.clientId`,`oauth2.semantics.clientSecret`, `oauth2.discovery.clientId`,`oauth2.discovery.clientSecret`, `oauth2.bpdm.clientId`,`oauth2.bpdm.clientSecret` - -### Removed -- Removed configuration parameters `oauth2.clientId`,`oauth2.clientSecret`, `portal.oauth2.clientId`,`portal.oauth2.clientSecret` - -### Changed -- Changed configuration for discovery finder url from `digitalTwinRegistry.discoveryFinderUrl` to `discovery.discoveryFinderUrl` ## [6.13.0] - 2024-01-15 - Update IRS version to 4.4.0 diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index c5811fc1a7..bad14f82a5 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -56,46 +56,36 @@ data: oauth2: client: registration: - semantics: - client-id: "${SEMANTICS_OAUTH2_CLIENT_ID}" # taken from secret ENV - client-secret: "${SEMANTICS_OAUTH2_CLIENT_SECRET}" # taken from secret ENV - discovery: - client-id: ${DISCOVERY_OAUTH2_CLIENT_ID} # taken from secret ENV - client-secret: ${DISCOVERY_OAUTH2_CLIENT_SECRET} # taken from secret ENV - bpdm: - client-id: ${BPDM_OAUTH2_CLIENT_ID} # taken from secret ENV - client-secret: ${BPDM_OAUTH2_CLIENT_SECRET} # taken from secret ENV + common: + client-id: "${OAUTH2_CLIENT_ID}" # taken from secret ENV + client-secret: "${OAUTH2_CLIENT_SECRET}" # taken from secret ENV + portal: + client-id: ${PORTAL_OAUTH2_CLIENT_ID} # taken from secret ENV + client-secret: ${PORTAL_OAUTH2_CLIENT_SECRET} # taken from secret ENV provider: - semantics: + common: token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }} - discovery: - token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }} - bpdm: + portal: token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }} digitalTwinRegistry: descriptorEndpoint: {{ tpl (.Values.digitalTwinRegistry.descriptorEndpoint | default "") . | quote }} shellLookupEndpoint: {{ tpl (.Values.digitalTwinRegistry.shellLookupEndpoint | default "") . | quote }} + discoveryFinderUrl: {{ tpl (.Values.digitalTwinRegistry.discoveryFinderUrl | default "") . | quote }} shellDescriptorTemplate: {{ .Values.digitalTwinRegistry.shellDescriptorTemplate | default "" | quote }} lookupShellsTemplate: {{ .Values.digitalTwinRegistry.lookupShellsTemplate | default "" | quote }} type: {{ tpl (.Values.digitalTwinRegistry.type | default "") . | quote }} - oAuthClientId: {{ .Values.digitalTwinRegistry.oAuthClientId | default "discovery" }} - discovery: - oAuthClientId: {{ .Values.discovery.oAuthClientId | default "discovery" }} # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - discoveryFinderUrl: {{ tpl (.Values.discovery.discoveryFinderUrl | default "") . | quote }} # The endpoint to discover EDC endpoints to a particular BPN. semanticshub: url: {{ tpl (.Values.semanticshub.url | default "") . | quote }} pageSize: {{ tpl (.Values.semanticshub.pageSize | default "100") . }} modelJsonSchemaEndpoint: {{ tpl (.Values.semanticshub.modelJsonSchemaEndpoint | default "") . | quote }} defaultUrns: {{ tpl (.Values.semanticshub.defaultUrns | default "") . | quote }} - oAuthClientId: {{ .Values.semanticshub.oAuthClientId | default "semantics" }} {{- if .Values.semanticshub.localModels }} localModelDirectory: /app/semantic-models {{- end }} bpdm: - oAuthClientId: {{ .Values.bpdm.oAuthClientId | default "bpdm" }} bpnEndpoint: {{ tpl (.Values.bpdm.bpnEndpoint | default "") . | quote }} irs-edc-client: @@ -139,7 +129,7 @@ data: irs: url: {{ tpl (.Values.irsUrl | default "") . | quote }} discovery: - oAuthClientId: {{ .Values.discovery.oAuthClientId | default "discovery" }} + oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }} {{- if .Values.ess.mockEdcResult }} mockEdcResult: {{- tpl (toYaml .Values.ess.mockEdcResult) . | nindent 10 }} diff --git a/charts/irs-helm/templates/deployment.yaml b/charts/irs-helm/templates/deployment.yaml index e30f10c7e8..785961cfe5 100644 --- a/charts/irs-helm/templates/deployment.yaml +++ b/charts/irs-helm/templates/deployment.yaml @@ -81,36 +81,26 @@ spec: secretKeyRef: name: {{ template "irs.secretName" . }} key: minioPassword - - name: SEMANTICS_OAUTH2_CLIENT_ID + - name: OAUTH2_CLIENT_ID valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: semanticsId - - name: SEMANTICS_OAUTH2_CLIENT_SECRET + key: clientId + - name: OAUTH2_CLIENT_SECRET valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: semanticsSecret - - name: DISCOVERY_OAUTH2_CLIENT_ID + key: clientSecret + - name: PORTAL_OAUTH2_CLIENT_ID valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: discoveryClientId - - name: DISCOVERY_OAUTH2_CLIENT_SECRET + key: portalClientId + - name: PORTAL_OAUTH2_CLIENT_SECRET valueFrom: secretKeyRef: name: {{ template "irs.secretName" . }} - key: discoveryClientSecret - - name: BPDM_OAUTH2_CLIENT_ID - valueFrom: - secretKeyRef: - name: {{ template "irs.secretName" . }} - key: bpdmClientId - - name: BPDM_OAUTH2_CLIENT_SECRET - valueFrom: - secretKeyRef: - name: {{ template "irs.secretName" . }} - key: bpdmClientSecret + key: portalClientSecret - name: EDC_API_KEY_SECRET valueFrom: secretKeyRef: diff --git a/charts/irs-helm/templates/secrets.yaml b/charts/irs-helm/templates/secrets.yaml index d9488ae665..c9f8741a28 100644 --- a/charts/irs-helm/templates/secrets.yaml +++ b/charts/irs-helm/templates/secrets.yaml @@ -35,12 +35,10 @@ type: Opaque data: minioUser: {{ .Values.minioUser | default "minio" | b64enc | quote }} minioPassword: {{ .Values.minioPassword | default "minioPass" | b64enc | quote }} - semanticsId: {{ .Values.oauth2.semantics.clientId | default "semanticsId" | b64enc | quote }} - semanticsSecret: {{ .Values.oauth2.semantics.clientSecret | default "semanticsSecret" | b64enc | quote }} - discoveryClientId: {{ .Values.oauth2.discovery.clientId | default "discoveryClientId" | b64enc | quote }} - discoveryClientSecret: {{ .Values.oauth2.discovery.clientSecret | default "discoveryClientSecret" | b64enc | quote }} - bpdmClientId: {{ .Values.oauth2.bpdm.clientId | default "bpdmClientId" | b64enc | quote }} - bpdmClientSecret: {{ .Values.oauth2.bpdm.clientSecret | default "bpdmClientSecret" | b64enc | quote }} + clientId: {{ .Values.oauth2.clientId | default "clientId" | b64enc | quote }} + clientSecret: {{ .Values.oauth2.clientSecret | default "clientSecret" | b64enc | quote }} + portalClientId: {{ .Values.portal.oauth2.clientId | default "portalClientId" | b64enc | quote }} + portalClientSecret: {{ .Values.portal.oauth2.clientSecret | default "portalClientSecret" | b64enc | quote }} edcApiSecret: {{ .Values.edc.controlplane.apikey.secret | toString | default "" | b64enc | quote }} {{- if .Values.grafana.enabled }} grafanaUser: {{ .Values.grafana.user | default "grafana" | b64enc | quote }} diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml index a62c3cff2e..9744cd5efd 100644 --- a/charts/irs-helm/values.yaml +++ b/charts/irs-helm/values.yaml @@ -127,12 +127,7 @@ digitalTwinRegistry: {{ tpl (.Values.digitalTwinRegistry.url | default "") . }}/lookup/shells?assetIds={assetIds} shellDescriptorTemplate: /shell-descriptors/{aasIdentifier} # The path to retrieve AAS descriptors from the decentral DTR, must contain the placeholder {aasIdentifier} lookupShellsTemplate: /lookup/shells?assetIds={assetIds} # The path to lookup shells from the decentral DTR, must contain the placeholder {assetIds} - oAuthClientId: discovery - -discovery: - oAuthClientId: discovery # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client discoveryFinderUrl: # "https:// - semanticshub: url: # https:// pageSize: "100" # Number of aspect models to retrieve per page @@ -140,7 +135,6 @@ semanticshub: {{- if .Values.semanticshub.url }} {{- tpl (.Values.semanticshub.url | default "" ) . }}/{urn}/json-schema {{- end }} - oAuthClientId: semantics defaultUrns: >- # urn:bamm:io.catenax.serial_part:1.0.0#SerialPart # ,urn:bamm:com.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt @@ -150,7 +144,6 @@ semanticshub: # dXJuOmJhbW06aW8uY2F0ZW5heC5zZXJpYWxfcGFydDoxLjAuMCNTZXJpYWxQYXJ0: {
	"$schema": "http://json-schema.org/draft-04/schema",
	"description": "A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial number or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number)",
	"type": "object",
	"components": {
		"schemas": {
			"urn_bamm_io.catenax.serial_part_1.0.0_CatenaXIdTrait": {
				"type": "string",
				"description": "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.",
				"pattern": "(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic": {
				"type": "string",
				"description": "The key characteristic of a local identifier. A specific subset of keys is predefined, but additionally any other custom key is allowed. Predefined keys (to be used when applicable):\n- \"manufacturerId\" - The Business Partner Number (BPN) of the manufacturer. Value: BPN-Nummer\n- \"partInstanceId\" - The identifier of the manufacturer for the serialized instance of the part, e.g. the serial number\n- \"batchId\" - The identifier of the batch, to which the serialzed part belongs\n- \"van\" - The anonymized vehicle identification number (VIN). Value: anonymized VIN according to OEM anonymization rules. Note: If the key \"van\" is available, \"partInstanceId\" must also be available and hold the identical value."
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic": {
				"type": "string",
				"description": "The value of an identifier."
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList": {
				"description": "A list of key value pairs for local identifiers, which are composed of a key and a corresponding value.",
				"type": "object",
				"properties": {
					"key": {
						"description": "The key of a local identifier. ",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyCharacteristic"
					},
					"value": {
						"description": "The value of an identifier.",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ValueCharacteristic"
					}
				},
				"required": [
					"key",
					"value"
				]
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic": {
				"description": "A single serialized part may have multiple attributes, that uniquely identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)",
				"type": "array",
				"items": {
					"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_KeyValueList"
				},
				"uniqueItems": true
			},
			"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp": {
				"type": "string",
				"pattern": "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?",
				"description": "Describes a Property which contains the date and time with an optional timezone."
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait": {
				"type": "string",
				"description": "Regular Expression that ensures a three-letter code ",
				"pattern": "^[A-Z][A-Z][A-Z]$"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic": {
				"description": "Characteristic to describe manufacturing related data",
				"type": "object",
				"properties": {
					"date": {
						"description": "Timestamp of the manufacturing date as the final step in production process (e.g. final quality check, ready-for-shipment event)",
						"$ref": "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
					},
					"country": {
						"description": "Country code where the part was manufactured",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ProductionCountryCodeTrait"
					}
				},
				"required": [
					"date"
				]
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic": {
				"type": "string",
				"description": "The part ID is a multi-character string, ususally assigned by an ERP system"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic": {
				"type": "string",
				"description": "Part Name in string format from the respective system in the value chain"
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic": {
				"type": "string",
				"description": "A part type must be placed into one of the following classes: 'component', 'product', 'software', 'assembly', 'tool', or 'raw material'.",
				"enum": [
					"product",
					"raw material",
					"software",
					"assembly",
					"tool",
					"component"
				]
			},
			"urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic": {
				"description": "The characteristics of the part type",
				"type": "object",
				"properties": {
					"manufacturerPartId": {
						"description": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic"
					},
					"customerPartId": {
						"description": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the customer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number.",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartIdCharacteristic"
					},
					"nameAtManufacturer": {
						"description": "Name of the part as assigned by the manufacturer",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic"
					},
					"nameAtCustomer": {
						"description": "Name of the part as assigned by the customer",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartNameCharacteristic"
					},
					"classification": {
						"description": "The classification of the part type according to STEP standard definition",
						"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ClassificationCharacteristic"
					}
				},
				"required": [
					"manufacturerPartId",
					"nameAtManufacturer",
					"classification"
				]
			}
		}
	},
	"properties": {
		"catenaXId": {
			"description": "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_CatenaXIdTrait"
		},
		"localIdentifiers": {
			"description": "A local identifier enables identification of a part in a specific dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers may exist.",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_LocalIdentifierCharacteristic"
		},
		"manufacturingInformation": {
			"description": "Information from manufacturing process, such as manufacturing date and manufacturing country",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_ManufacturingCharacteristic"
		},
		"partTypeInformation": {
			"description": "The part type from which the serialized part has been instantiated",
			"$ref": "#/components/schemas/urn_bamm_io.catenax.serial_part_1.0.0_PartTypeInformationCharacteristic"
		}
	},
	"required": [
		"catenaXId",
		"localIdentifiers",
		"manufacturingInformation",
		"partTypeInformation"
	]
} bpdm: url: # https:// - oAuthClientId: bpdm bpnEndpoint: >- {{- if .Values.bpdm.url }} {{- tpl (.Values.bpdm.url | default "") . }}/api/catena/legal-entities/{partnerId}?idType={idType} @@ -159,16 +152,13 @@ minioUser: "minio" # minioPassword: # minioUrl: "http://{{ .Release.Name }}-minio:9000" oauth2: + clientId: # + clientSecret: # clientTokenUri: # - semantics: - clientId: # - clientSecret: # - discovery: - clientId: # - clientSecret: # - bpdm: - clientId: # - clientSecret: # +portal: + oauth2: + clientId: # + clientSecret: # edc: controlplane: endpoint: @@ -216,6 +206,9 @@ edc: connectorEndpointService: cacheTTL: PT24H # Time to live for ConnectorEndpointService for fetchConnectorEndpoints method cache +discovery: + oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + ess: edc: host: # EDC base URL - used for creation of EDC assets for ESS notifications and as sender EDC for sent notifications diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml index f7c25939dc..854d8ef65d 100644 --- a/docs/src/api/irs-api.yaml +++ b/docs/src/api/irs-api.yaml @@ -7,7 +7,7 @@ info: servers: - url: http://localhost:8080 security: - - api_key: [] + - oAuth2: [] paths: /ess/bpn/investigations: post: @@ -58,7 +58,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. tags: @@ -123,7 +123,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job with the requested jobId not found. security: - - api_key: [] + - oAuth2: [] summary: Return job with additional supplyChainImpacted information. tags: - Environmental and Social Standards @@ -202,7 +202,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." tags: @@ -292,7 +292,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Returns paginated jobs with state and execution times. tags: - Item Relationship Service @@ -343,7 +343,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}." tags: - Item Relationship Service @@ -427,7 +427,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job with the requested jobId not found. security: - - api_key: [] + - oAuth2: [] summary: Return job with optional item graph result for requested id. tags: - Item Relationship Service @@ -492,7 +492,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Job for requested jobId not found. security: - - api_key: [] + - oAuth2: [] summary: Cancel job for requested jobId. tags: - Item Relationship Service @@ -529,7 +529,7 @@ paths: $ref: "#/components/schemas/ErrorResponse" description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Get all available aspect models from semantic hub or local models. tags: - Aspect Models @@ -582,7 +582,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: "Registers an IRS order with an array of {globalAssetIds}.\ \ Each globalAssetId will be processed in an IRS Job, grouped in batches." tags: @@ -649,7 +649,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch Order with the requested orderId not found. security: - - api_key: [] + - oAuth2: [] summary: Get a batch order for a given orderId. tags: - Item Relationship Service @@ -714,7 +714,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch Order with the requested orderId not found. security: - - api_key: [] + - oAuth2: [] summary: Cancel a batch order for a given orderId. tags: - Item Relationship Service @@ -790,7 +790,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Batch with the requested orderId and batchId not found. security: - - api_key: [] + - oAuth2: [] summary: Get a batch with a given batchId for a given orderId. tags: - Item Relationship Service @@ -826,7 +826,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Lists the registered policies that should be accepted in EDC negotiation. tags: - Item Relationship Service @@ -870,7 +870,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Register a policy that should be accepted in EDC negotiation. tags: - Item Relationship Service @@ -915,7 +915,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Removes a policy that should no longer be accepted in EDC negotiation. tags: - Item Relationship Service @@ -965,7 +965,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' description: Authorization refused by server. security: - - api_key: [] + - oAuth2: [] summary: Updates an existing policy with new validUntil value. tags: - Item Relationship Service @@ -2734,8 +2734,10 @@ components: required: - validUntil securitySchemes: - api_key: - description: Api Key access - in: header - name: X-API-KEY - type: apiKey + oAuth2: + flows: + clientCredentials: + scopes: + {} + tokenUrl: https://localhost + type: oauth2 diff --git a/docs/src/docs/administration/configuration.adoc b/docs/src/docs/administration/configuration.adoc index d3430cc7b9..5c4bbc6241 100644 --- a/docs/src/docs/administration/configuration.adoc +++ b/docs/src/docs/administration/configuration.adoc @@ -156,23 +156,11 @@ This is a list of all secrets used in the deployment. WARNING: Keep the values for these settings safe and do not publish them! -=== -Semantic Hub client ID for OAuth2 provider. Request this from your OAuth2 operator. +=== +Client ID for OAuth2 provider. Request this from your OAuth2 operator. -=== -Semantic Hub client secret for OAuth2 provider. Request this from your OAuth2 operator. - -=== -Dataspace Discovery client ID for OAuth2 provider. Request this from your OAuth2 operator. - -=== -Dataspace Discovery client secret for OAuth2 provider. Request this from your OAuth2 operator. - -=== -BPDM client ID for OAuth2 provider. Request this from your OAuth2 operator. - -=== -BPDM client secret for OAuth2 provider. Request this from your OAuth2 operator. +=== +Client secret for OAuth2 provider. Request this from your OAuth2 operator. === Login username for Minio. To be defined by you. diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java index 991ab57564..837d9d9810 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java @@ -26,12 +26,16 @@ import io.swagger.v3.oas.models.Components; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.security.OAuthFlow; +import io.swagger.v3.oas.models.security.OAuthFlows; +import io.swagger.v3.oas.models.security.Scopes; import io.swagger.v3.oas.models.security.SecurityRequirement; import io.swagger.v3.oas.models.security.SecurityScheme; import io.swagger.v3.oas.models.servers.Server; import lombok.RequiredArgsConstructor; import org.eclipse.tractusx.irs.IrsApplication; import org.springdoc.core.customizers.OpenApiCustomizer; +import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -55,7 +59,7 @@ public class OpenApiConfiguration { @Bean public OpenAPI customOpenAPI() { return new OpenAPI().addServersItem(new Server().url(irsConfiguration.getApiUrl().toString())) - .addSecurityItem(new SecurityRequirement().addList("api_key")) + .addSecurityItem(new SecurityRequirement().addList("oAuth2")) .info(new Info().title("IRS API") .version(IrsApplication.API_VERSION) .description( @@ -65,19 +69,20 @@ public OpenAPI customOpenAPI() { /** * Generates example values in Swagger * + * @param tokenUri the OAuth2 token uri loaded from application.yaml * @return the customizer */ @Bean - public OpenApiCustomizer customizer() { + public OpenApiCustomizer customizer( + @Value("${spring.security.oauth2.client.provider.common.token-uri}") final String tokenUri) { return openApi -> { final Components components = openApi.getComponents(); - components.addSecuritySchemes("api_key", new SecurityScheme().type(SecurityScheme.Type.APIKEY) - .description("Api Key access") - .in(SecurityScheme.In.HEADER) - .name("X-API-KEY") - ); + components.addSecuritySchemes("oAuth2", new SecurityScheme().type(SecurityScheme.Type.OAUTH2) + .flows(new OAuthFlows().clientCredentials( + new OAuthFlow().scopes( + new Scopes()) + .tokenUrl(tokenUri)))); openApi.getComponents().getSchemas().values().forEach(s -> s.setAdditionalProperties(false)); - new OpenApiExamples().createExamples(components); }; } diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java index db7de31bb7..7b398b26b0 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RegistryConfiguration.java @@ -86,14 +86,14 @@ public DecentralDigitalTwinRegistryService decentralDigitalTwinRegistryService( @Bean public ConnectorEndpointsService connectorEndpointsService( @Qualifier(RestTemplateConfig.DTR_REST_TEMPLATE) final RestTemplate dtrRestTemplate, - @Value("${digitalTwinRegistry.discovery.discoveryFinderUrl:}") final String finderUrl) { + @Value("${digitalTwinRegistry.discoveryFinderUrl:}") final String finderUrl) { return new ConnectorEndpointsService(discoveryFinderClient(dtrRestTemplate, finderUrl)); } @Bean public DiscoveryFinderClient discoveryFinderClient( @Qualifier(RestTemplateConfig.DTR_REST_TEMPLATE) final RestTemplate dtrRestTemplate, - @Value("${digitalTwinRegistry.discovery.discoveryFinderUrl:}") final String finderUrl) { + @Value("${digitalTwinRegistry.discoveryFinderUrl:}") final String finderUrl) { return new DiscoveryFinderClientImpl(finderUrl, dtrRestTemplate); } diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java index d8b50542aa..acc63e6c95 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/RestTemplateConfig.java @@ -36,6 +36,7 @@ import org.eclipse.edc.policy.model.PolicyRegistrationTypes; import org.eclipse.tractusx.irs.common.OutboundMeterRegistryService; import org.jetbrains.annotations.NotNull; +import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.context.annotation.Bean; @@ -131,9 +132,9 @@ private static ClientHttpRequestInterceptor getRegistryInterceptor( @Bean(DISCOVERY_REST_TEMPLATE) /* package */ RestTemplate discoveryRestTemplate(final RestTemplateBuilder restTemplateBuilder, - @Value("${digitalTwinRegistry.discovery.timeout.read}") final Duration readTimeout, - @Value("${digitalTwinRegistry.discovery.timeout.connect}") final Duration connectTimeout, - @Value("${digitalTwinRegistry.discovery.oAuthClientId}") final String clientRegistrationId) { + @Value("${ess.discovery.timeout.read}") final Duration readTimeout, + @Value("${ess.discovery.timeout.connect}") final Duration connectTimeout, + @Value("${ess.discovery.oAuthClientId}") final String clientRegistrationId) { return oAuthRestTemplate(restTemplateBuilder, readTimeout, connectTimeout, clientRegistrationId).build(); } @@ -174,6 +175,7 @@ public boolean hasError(final ClientHttpResponse statusCode) { } @Bean(EDC_REST_TEMPLATE) + @Qualifier(EDC_REST_TEMPLATE) /* package */ RestTemplate edcRestTemplate(final RestTemplateBuilder restTemplateBuilder, @Value("${irs-edc-client.submodel.timeout.read}") final Duration readTimeout, @Value("${irs-edc-client.submodel.timeout.connect}") final Duration connectTimeout, diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java index c8ff5c60f2..cfb85c6231 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java @@ -81,7 +81,7 @@ public class BatchController { @Operation(operationId = "registerOrder", summary = "Registers an IRS order with an array of {globalAssetIds}. " + "Each globalAssetId will be processed in an IRS Job, grouped in batches.", - security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, description = "Registers an IRS order with an array of {globalAssetIds}. " + "Each globalAssetId will be processed in an IRS Job, grouped in batches.") @ApiResponses( @@ -121,7 +121,7 @@ public BatchOrderCreated registerBatchOrder(final @Valid @RequestBody RegisterBa @Operation(operationId = "registerESSInvestigationOrder", summary = "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.", - security = @SecurityRequirement(name = "api_key"), tags = { "Environmental and Social Standards" }, + security = @SecurityRequirement(name = "oAuth2"), tags = { "Environmental and Social Standards" }, description = "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.") @ApiResponses( value = { @ApiResponse(responseCode = "201", description = "Returns orderId of registered Batch order.", @@ -160,7 +160,7 @@ public BatchOrderCreated registerESSInvestigationOrder( } @Operation(description = "Get a batch order for a given orderId.", operationId = "getBatchOrder", - summary = "Get a batch order for a given orderId.", security = @SecurityRequirement(name = "api_key"), + summary = "Get a batch order for a given orderId.", security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Get a batch order for a given orderId.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, schema = @Schema( @@ -206,7 +206,7 @@ public BatchOrderResponse getBatchOrder( @Operation(description = "Get a batch with a given batchId for a given orderId.", operationId = "getBatch", summary = "Get a batch with a given batchId for a given orderId.", - security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Get a batch with a given batchId for a given orderId.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -255,7 +255,7 @@ public BatchResponse getBatch( } @Operation(description = "Cancel a batch order for a given orderId.", operationId = "cancelBatchOrder", - summary = "Cancel a batch order for a given orderId.", security = @SecurityRequirement(name = "api_key"), + summary = "Cancel a batch order for a given orderId.", security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) @ApiResponses( value = { @ApiResponse(responseCode = "200", description = "Cancel a batch order for a given orderId.", diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java index a8a23c11c4..60166e2c87 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java @@ -93,7 +93,7 @@ public class IrsController { @Operation(operationId = "registerJobForGlobalAssetId", summary = "Register an IRS job to retrieve an item graph for given {globalAssetId}.", - security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }, + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, description = "Register an IRS job to retrieve an item graph for given {globalAssetId}.") @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns id of registered job.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -131,7 +131,7 @@ public JobHandle registerJobForGlobalAssetId(final @Valid @RequestBody RegisterJ @Operation(description = "Return job with optional item graph result for requested id.", operationId = "getJobForJobId", summary = "Return job with optional item graph result for requested id.", - security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Return job with item graph for the requested id.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -190,7 +190,7 @@ public ResponseEntity getJobById( } @Operation(description = "Cancel job for requested jobId.", operationId = "cancelJobByJobId", - summary = "Cancel job for requested jobId.", security = @SecurityRequirement(name = "api_key"), + summary = "Cancel job for requested jobId.", security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Job with requested jobId canceled.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -236,7 +236,7 @@ public Job cancelJobByJobId( @Operation(description = "Returns paginated jobs with state and execution times.", operationId = "getJobsByJobStates", summary = "Returns paginated jobs with state and execution times.", - security = @SecurityRequirement(name = "api_key"), tags = { "Item Relationship Service" }) + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Paginated list of jobs with state and execution times for requested job states.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, @@ -280,7 +280,7 @@ public PageResult getJobsByState( @Operation(operationId = "getAllAspectModels", summary = "Get all available aspect models from semantic hub or local models.", - security = @SecurityRequirement(name = "api_key"), tags = { "Aspect Models" }, + security = @SecurityRequirement(name = "oAuth2"), tags = { "Aspect Models" }, description = "Get all available aspect models from semantic hub or local models.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Returns all available aspect models.", content = { @Content(mediaType = APPLICATION_JSON_VALUE, diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java index ca6720b605..9414172ec8 100644 --- a/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java +++ b/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java @@ -75,7 +75,7 @@ class EssController { @Operation(operationId = "registerBPNInvestigation", summary = "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.", - security = @SecurityRequirement(name = "api_key"), + security = @SecurityRequirement(name = "oAuth2"), tags = { "Environmental and Social Standards" }, description = "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.") @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns id of registered job.", @@ -114,7 +114,7 @@ public JobHandle registerBPNInvestigation(final @Valid @RequestBody RegisterBpnI @Operation(description = "Return job with additional supplyChainImpacted information.", operationId = "getBPNInvestigation", summary = "Return job with additional supplyChainImpacted information.", - security = @SecurityRequirement(name = "api_key"), + security = @SecurityRequirement(name = "oAuth2"), tags = { "Environmental and Social Standards" }) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Return job with item graph for the requested id.", diff --git a/irs-api/src/main/resources/application.yml b/irs-api/src/main/resources/application.yml index cfa958d815..ecf233bb2b 100644 --- a/irs-api/src/main/resources/application.yml +++ b/irs-api/src/main/resources/application.yml @@ -9,25 +9,20 @@ spring: oauth2: client: registration: - semantics : + common: authorization-grant-type: client_credentials - client-id: ${SEMANTICS_OAUTH2_CLIENT_ID} # Semantic Hub OAuth2 client ID used to authenticate with the IAM - client-secret: ${SEMANTICS_OAUTH2_CLIENT_SECRET} # Semantic Hub OAuth2 client secret used to authenticate with the IAM - discovery: + client-id: ${OAUTH2_CLIENT_ID} # OAuth2 client ID used to authenticate with the IAM + client-secret: ${OAUTH2_CLIENT_SECRET} # OAuth2 client secret used to authenticate with the IAM + portal: authorization-grant-type: client_credentials - client-id: ${DISCOVERY_OAUTH2_CLIENT_ID} # Dataspace Discovery OAuth2 client ID used to authenticate with the IAM - client-secret: ${DISCOVERY_OAUTH2_CLIENT_SECRET} # Dataspace Discovery OAuth2 client secret used to authenticate with the IAM - bpdm: - authorization-grant-type: client_credentials - client-id: ${BPDM_OAUTH2_CLIENT_ID} # BPDM Pool OAuth2 client ID used to authenticate with the IAM - client-secret: ${BPDM_OAUTH2_CLIENT_SECRET} # BPDM Pool OAuth2 client secret used to authenticate with the IAM + client-id: ${PORTAL_OAUTH2_CLIENT_ID} # OAuth2 client ID used to authenticate with the IAM + client-secret: ${PORTAL_OAUTH2_CLIENT_SECRET} # OAuth2 client secret used to authenticate with the IAM provider: - semantics: - token-uri: ${SEMANTICS_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials - discovery: - token-uri: ${DISCOVERY_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials - bpdm: - token-uri: ${BPDM_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials + common: + token-uri: ${OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials + portal: + token-uri: ${PORTAL_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials + management: # Spring management API config, see https://spring.io/guides/gs/centralized-configuration/ endpoints: @@ -191,16 +186,11 @@ digitalTwinRegistry: shellLookupEndpoint: ${DIGITALTWINREGISTRY_SHELL_LOOKUP_URL:} # The endpoint to lookup shells from the DTR, must contain the placeholder {assetIds} shellDescriptorTemplate: ${DIGITALTWINREGISTRY_SHELL_DESCRIPTOR_TEMPLATE:/shell-descriptors/{aasIdentifier}} # The path to retrieve AAS descriptors from the decentral DTR, must contain the placeholder {aasIdentifier} lookupShellsTemplate: ${DIGITALTWINREGISTRY_QUERY_SHELLS_PATH:/lookup/shells?assetIds={assetIds}} # The path to lookup shells from the decentral DTR, must contain the placeholder {assetIds} - oAuthClientId: discovery # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: common # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + discoveryFinderUrl: ${DIGITALTWINREGISTRY_DISCOVERY_FINDER_URL:} # The endpoint to discover EDC endpoints to a particular BPN. timeout: read: PT90S # HTTP read timeout for the digital twin registry client connect: PT90S # HTTP connect timeout for the digital twin registry client - discovery: - oAuthClientId: discovery # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - discoveryFinderUrl: ${DIGITALTWINREGISTRY_DISCOVERY_FINDER_URL:} # The endpoint to discover EDC endpoints to a particular BPN. - timeout: - read: PT90S # HTTP read timeout for the discovery client - connect: PT90S # HTTP connect timeout for the discovery client semanticshub: # The endpoint to retrieve the json schema of a model from the semantic hub. If specified, must contain the placeholder {urn}. @@ -221,7 +211,7 @@ semanticshub: # │ │ │ │ │ │ scheduler: 0 0 23 * * * # How often to clear the semantic model cache defaultUrns: "${SEMANTICSHUB_DEFAULT_URNS:urn:bamm:io.catenax.serial_part:1.0.0#SerialPart}" # IDs of models to cache at IRS startup - oAuthClientId: semantics # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: common # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client timeout: read: PT90S # HTTP read timeout for the semantic hub client connect: PT90S # HTTP connect timeout for the semantic hub client @@ -229,7 +219,7 @@ semanticshub: bpdm: bpnEndpoint: "${BPDM_URL:}" # Endpoint to resolve BPNs, must contain the placeholders {partnerId} and {idType} - oAuthClientId: bpdm # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + oAuthClientId: common # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client timeout: read: PT90S # HTTP read timeout for the bpdm client connect: PT90S # HTTP connect timeout for the bpdm client @@ -244,6 +234,10 @@ ess: irs: url: "${IRS_URL:}" # IRS Url to connect with discovery: + oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client + timeout: + read: PT90S # HTTP read timeout for the discovery client + connect: PT90S # HTTP connect timeout for the discovery client mockEdcResult: { } # Mocked BPN Investigation results mockRecursiveEdcAsset: # Mocked BPN Recursive Investigation results diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java index f4684299eb..4508e33068 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/configuration/JsonLdConfiguration.java @@ -34,6 +34,7 @@ import org.eclipse.edc.policy.model.LiteralExpression; import org.eclipse.edc.spi.monitor.ConsoleMonitor; import org.eclipse.edc.spi.monitor.Monitor; +import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -52,7 +53,6 @@ public class JsonLdConfiguration { public static final String NAMESPACE_EDC_ID = NAMESPACE_EDC + "id"; public static final String NAMESPACE_TRACTUSX = "https://w3id.org/tractusx/v0.0.1/ns/"; public static final String NAMESPACE_DCT = "https://purl.org/dc/terms/"; - public static final String JSON_LD_OBJECT_MAPPER = "jsonLdObjectMapper"; @Bean /* package */ TitaniumJsonLd titaniumJsonLd(final Monitor monitor) { final TitaniumJsonLd titaniumJsonLd = new TitaniumJsonLd(monitor); @@ -69,7 +69,8 @@ public class JsonLdConfiguration { return new ConsoleMonitor(); } - @Bean(JSON_LD_OBJECT_MAPPER) + @Bean + @Qualifier("jsonLdObjectMapper") /* package */ ObjectMapper objectMapper() { final ObjectMapper objectMapper = new ObjectMapper(); objectMapper.registerModule(new JavaTimeModule()); diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java index 303956cc77..da9b59f4f8 100644 --- a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java +++ b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/transformer/EdcTransformer.java @@ -23,8 +23,6 @@ ********************************************************************************/ package org.eclipse.tractusx.irs.edc.client.transformer; -import static org.eclipse.tractusx.irs.edc.client.configuration.JsonLdConfiguration.JSON_LD_OBJECT_MAPPER; - import java.io.ByteArrayInputStream; import java.nio.charset.Charset; import java.util.Map; @@ -87,7 +85,7 @@ public class EdcTransformer { private final TitaniumJsonLd titaniumJsonLd; private final TransformerContextImpl transformerContext; - public EdcTransformer(@Qualifier(JSON_LD_OBJECT_MAPPER) final ObjectMapper objectMapper, + public EdcTransformer(@Qualifier("jsonLdObjectMapper") final ObjectMapper objectMapper, final TitaniumJsonLd titaniumJsonLd, final TypeTransformerRegistry typeTransformerRegistry) { this.titaniumJsonLd = titaniumJsonLd; final JsonBuilderFactory jsonBuilderFactory = Json.createBuilderFactory(Map.of()); diff --git a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java index 56aa0e1b72..ec06c135e2 100644 --- a/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java +++ b/irs-policy-store/src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java @@ -76,7 +76,7 @@ public class PolicyStoreController { @Operation(operationId = "registerAllowedPolicy", summary = "Register a policy that should be accepted in EDC negotiation.", - security = @SecurityRequirement(name = "api_key"), + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, description = "Register a policy that should be accepted in EDC negotiation.") @ApiResponses(value = { @ApiResponse(responseCode = "201"), @@ -110,7 +110,7 @@ public void registerAllowedPolicy(final @RequestBody CreatePolicyRequest request @Operation(operationId = "getAllowedPolicies", summary = "Lists the registered policies that should be accepted in EDC negotiation.", - security = @SecurityRequirement(name = "api_key"), + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, description = "Lists the registered policies that should be accepted in EDC negotiation.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Returns the policies.", @@ -141,7 +141,7 @@ public List getPolicies() { @Operation(operationId = "deleteAllowedPolicy", summary = "Removes a policy that should no longer be accepted in EDC negotiation.", - security = @SecurityRequirement(name = "api_key"), + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, description = "Removes a policy that should no longer be accepted in EDC negotiation.") @ApiResponses(value = { @ApiResponse(responseCode = "200"), @@ -172,7 +172,7 @@ public void deleteAllowedPolicy(@PathVariable("policyId") final String policyId) } @Operation(operationId = "updateAllowedPolicy", summary = "Updates an existing policy with new validUntil value.", - security = @SecurityRequirement(name = "api_key"), + security = @SecurityRequirement(name = "oAuth2"), tags = { "Item Relationship Service" }, description = "Updates an existing policy with new validUntil value.") @ApiResponses(value = { @ApiResponse(responseCode = "200"),