feat(test): adopt upstream test runtime model

eclipse-tractusx · Jun 10, 2024 · 2e6d247 · 2e6d247
1 parent f05f0f3
commit 2e6d247
Show file tree

Hide file tree

Showing 38 changed files with 616 additions and 548 deletions.
diff --git a/.github/actions/publish-docker-image/action.yml b/.github/actions/publish-docker-image/action.yml
@@ -49,7 +49,7 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - uses: actions/checkout@v3.3.0
+    - uses: actions/checkout@v4
 
     - name: Download OpenTelemetry
       shell: bash

diff --git a/.github/actions/run-deployment-test/action.yml b/.github/actions/run-deployment-test/action.yml
@@ -48,7 +48,7 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - uses: actions/checkout@v3.3.0
+    - uses: actions/checkout@v4
     - uses: ./.github/actions/setup-java
 
     - name: Setup Helm

diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -137,7 +137,7 @@ jobs:
       - name: Run E2E tests (${{ matrix.variant.dir }})
         run: |
           ./gradlew compileJava compileTestJava --refresh-dependencies
-          ./gradlew -p ${{ matrix.variant.dir }} test -DincludeTags="EndToEndTest" 
+          ./gradlew -p ${{ matrix.variant.dir }} test -DincludeTags="EndToEndTest"
 
   postgres-tests:
     runs-on: ubuntu-latest

diff --git a/DEPENDENCIES b/DEPENDENCIES
diff --git a/edc-tests/e2e-tests/src/test/java/org/eclipse/tractusx/edc/lifecycle/ParticipantRuntime.java b/edc-tests/e2e-tests/src/test/java/org/eclipse/tractusx/edc/lifecycle/ParticipantRuntime.java
@@ -22,61 +22,32 @@
 import com.nimbusds.jose.JOSEException;
 import com.nimbusds.jose.jwk.Curve;
 import com.nimbusds.jose.jwk.gen.ECKeyGenerator;
-import org.eclipse.edc.boot.system.injection.InjectionContainer;
-import org.eclipse.edc.junit.extensions.EdcRuntimeExtension;
+import org.eclipse.edc.junit.extensions.EmbeddedRuntime;
+import org.eclipse.edc.junit.extensions.RuntimePerMethodExtension;
 import org.eclipse.edc.spi.security.Vault;
-import org.eclipse.edc.spi.system.ServiceExtension;
-import org.eclipse.edc.spi.system.ServiceExtensionContext;
-import org.junit.jupiter.api.extension.AfterAllCallback;
-import org.junit.jupiter.api.extension.BeforeAllCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
 
-import java.util.List;
 import java.util.Map;
 
-public class ParticipantRuntime extends EdcRuntimeExtension implements BeforeAllCallback, AfterAllCallback {
+public class ParticipantRuntime extends RuntimePerMethodExtension {
 
     private final Map<String, String> properties;
-    private DataWiper wiper;
-
-
-    public ParticipantRuntime(String moduleName, String runtimeName, Map<String, String> properties) {
-        super(moduleName, runtimeName, properties);
-        this.properties = properties;
-    }
 
     public ParticipantRuntime(String runtimeName, Map<String, String> properties, String... modules) {
-        super(runtimeName, properties, modules);
+        super(new EmbeddedRuntime(runtimeName, properties, modules));
         this.properties = properties;
     }
 
 
     @Override
     public void beforeTestExecution(ExtensionContext extensionContext) {
-        //do nothing - we only want to start the runtime once
-        wiper.clearPersistence();
+        registerConsumerPullKeys(properties);
     }
 
     @Override
     public void afterTestExecution(ExtensionContext context) {
-    }
-
-    @Override
-    public void beforeAll(ExtensionContext context) throws Exception {
-        //only run this once
-        super.beforeTestExecution(context);
-    }
-
-    @Override
-    public void afterAll(ExtensionContext context) throws Exception {
-        super.afterTestExecution(context);
-    }
-
-    @Override
-    protected void bootExtensions(ServiceExtensionContext context, List<InjectionContainer<ServiceExtension>> serviceExtensions) {
-        super.bootExtensions(context, serviceExtensions);
-        wiper = new DataWiper(context);
-        registerConsumerPullKeys(properties);
+        var wiper = new DataWiper(runtime.getContext());
+        wiper.clearPersistence();
     }
 
     private void registerConsumerPullKeys(Map<String, String> properties) {
@@ -85,7 +56,7 @@ private void registerConsumerPullKeys(Map<String, String> properties) {
         if (privateAlias != null && publicAlias != null) {
             try {
                 var ecKey = new ECKeyGenerator(Curve.P_256).keyID(publicAlias).generate();
-                var vault = getContext().getService(Vault.class);
+                var vault = getService(Vault.class);
                 vault.storeSecret(privateAlias, ecKey.toJSONString());
                 vault.storeSecret(publicAlias, ecKey.toPublicJWK().toJSONString());
             } catch (JOSEException e) {

diff --git a/...plane/catalog-tests/src/test/java/org/eclipse/tractusx/edc/tests/catalog/CatalogTest.java b/...plane/catalog-tests/src/test/java/org/eclipse/tractusx/edc/tests/catalog/CatalogTest.java
@@ -21,10 +21,9 @@
 
 import org.eclipse.edc.junit.annotations.EndToEndTest;
 import org.eclipse.edc.junit.annotations.PostgresqlIntegrationTest;
+import org.eclipse.edc.junit.extensions.RuntimeExtension;
 import org.eclipse.edc.policy.model.Operator;
 import org.eclipse.tractusx.edc.tests.participant.TransferParticipant;
-import org.eclipse.tractusx.edc.tests.runtimes.ParticipantRuntime;
-import org.eclipse.tractusx.edc.tests.runtimes.PgParticipantRuntime;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
@@ -213,10 +212,10 @@ void requestCatalog_of1000Assets_shouldContainAll() {
     class InMemory extends Tests {
 
         @RegisterExtension
-        protected static final ParticipantRuntime CONSUMER_RUNTIME = memoryRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
+        protected static final RuntimeExtension CONSUMER_RUNTIME = memoryRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
 
         @RegisterExtension
-        protected static final ParticipantRuntime PROVIDER_RUNTIME = memoryRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
+        protected static final RuntimeExtension PROVIDER_RUNTIME = memoryRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
 
     }
 
@@ -225,10 +224,10 @@ class InMemory extends Tests {
     class Postgres extends Tests {
 
         @RegisterExtension
-        protected static final PgParticipantRuntime CONSUMER_RUNTIME = pgRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
+        protected static final RuntimeExtension CONSUMER_RUNTIME = pgRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
 
         @RegisterExtension
-        protected static final PgParticipantRuntime PROVIDER_RUNTIME = pgRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
+        protected static final RuntimeExtension PROVIDER_RUNTIME = pgRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
 
     }
 

diff --git a/...api-tests/src/test/java/org/eclipse/tractusx/edc/tests/edrv2/EdrCacheApiEndToEndTest.java b/...api-tests/src/test/java/org/eclipse/tractusx/edc/tests/edrv2/EdrCacheApiEndToEndTest.java
@@ -35,10 +35,10 @@
 import org.eclipse.edc.edr.spi.store.EndpointDataReferenceStore;
 import org.eclipse.edc.edr.spi.types.EndpointDataReferenceEntry;
 import org.eclipse.edc.junit.annotations.EndToEndTest;
+import org.eclipse.edc.junit.extensions.RuntimeExtension;
 import org.eclipse.edc.spi.types.domain.DataAddress;
 import org.eclipse.tractusx.edc.spi.tokenrefresh.dataplane.model.TokenResponse;
 import org.eclipse.tractusx.edc.tests.participant.TransferParticipant;
-import org.eclipse.tractusx.edc.tests.runtimes.ParticipantRuntime;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
@@ -63,6 +63,7 @@
 import static org.eclipse.tractusx.edc.edr.spi.CoreConstants.EDR_PROPERTY_REFRESH_TOKEN;
 import static org.eclipse.tractusx.edc.tests.TestRuntimeConfiguration.CONSUMER_BPN;
 import static org.eclipse.tractusx.edc.tests.TestRuntimeConfiguration.CONSUMER_NAME;
+import static org.eclipse.tractusx.edc.tests.runtimes.Runtimes.memoryRuntime;
 import static org.mockserver.integration.ClientAndServer.startClientAndServer;
 import static org.mockserver.matchers.Times.exactly;
 import static org.mockserver.model.HttpRequest.request;
@@ -81,11 +82,7 @@ public class EdrCacheApiEndToEndTest {
             .id(CONSUMER_BPN)
             .build();
     @RegisterExtension
-    protected static final ParticipantRuntime CONSUMER_RUNTIME = new ParticipantRuntime(
-            ":edc-tests:runtime:runtime-memory",
-            CONSUMER.getName(),
-            CONSUMER.getId(),
-            with(CONSUMER.getConfiguration(), Map.of("edc.iam.issuer.id", "did:web:consumer")));
+    protected static final RuntimeExtension CONSUMER_RUNTIME = memoryRuntime(CONSUMER.getName(), CONSUMER.getId(), with(CONSUMER.getConfiguration(), Map.of("edc.iam.issuer.id", "did:web:consumer")));
     private final ObjectMapper mapper = new ObjectMapper();
     private String refreshEndpoint;
     private String refreshAudience;

diff --git a/...ne/edr-api-tests/src/test/java/org/eclipse/tractusx/edc/tests/edrv2/NegotiateEdrTest.java b/...ne/edr-api-tests/src/test/java/org/eclipse/tractusx/edc/tests/edrv2/NegotiateEdrTest.java
@@ -31,13 +31,12 @@
 import org.eclipse.edc.connector.controlplane.transfer.spi.event.TransferProcessStarted;
 import org.eclipse.edc.junit.annotations.EndToEndTest;
 import org.eclipse.edc.junit.annotations.PostgresqlIntegrationTest;
+import org.eclipse.edc.junit.extensions.RuntimeExtension;
 import org.eclipse.edc.policy.model.Operator;
 import org.eclipse.tractusx.edc.tests.helpers.EdrNegotiationHelperFunctions;
 import org.eclipse.tractusx.edc.tests.helpers.PolicyHelperFunctions;
 import org.eclipse.tractusx.edc.tests.helpers.ReceivedEvent;
 import org.eclipse.tractusx.edc.tests.participant.TransferParticipant;
-import org.eclipse.tractusx.edc.tests.runtimes.ParticipantRuntime;
-import org.eclipse.tractusx.edc.tests.runtimes.PgParticipantRuntime;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
@@ -191,10 +190,10 @@ void teardown() throws IOException {
     class InMemory extends Tests {
 
         @RegisterExtension
-        protected static final ParticipantRuntime CONSUMER_RUNTIME = memoryRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
+        protected static final RuntimeExtension CONSUMER_RUNTIME = memoryRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
 
         @RegisterExtension
-        protected static final ParticipantRuntime PROVIDER_RUNTIME = memoryRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
+        protected static final RuntimeExtension PROVIDER_RUNTIME = memoryRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
 
     }
 
@@ -203,10 +202,10 @@ class InMemory extends Tests {
     class Postgres extends Tests {
 
         @RegisterExtension
-        protected static final PgParticipantRuntime CONSUMER_RUNTIME = pgRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
+        protected static final RuntimeExtension CONSUMER_RUNTIME = pgRuntime(CONSUMER.getName(), CONSUMER.getBpn(), CONSUMER.getConfiguration());
 
         @RegisterExtension
-        protected static final PgParticipantRuntime PROVIDER_RUNTIME = pgRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
+        protected static final RuntimeExtension PROVIDER_RUNTIME = pgRuntime(PROVIDER.getName(), PROVIDER.getBpn(), PROVIDER.getConfiguration());
 
     }
 }
diff --git a/...Fixtures/java/org/eclipse/tractusx/edc/tests/participant/TractusxIatpParticipantBase.java b/...Fixtures/java/org/eclipse/tractusx/edc/tests/participant/TractusxIatpParticipantBase.java
@@ -44,7 +44,7 @@ public Map<String, String> iatpConfiguration(TractusxIatpParticipantBase... othe
                 put("edc.iam.sts.oauth.client.id", stsClientId);
                 put("edc.iam.sts.oauth.client.secret.alias", "client_secret_alias");
                 put("edc.ih.iam.id", getDid());
-                put("tx.vault.seed.secrets", "client_secret_alias:%s".formatted(stsClientSecret));
+                put("tx.edc.vault.seed.secrets", "client_secret_alias:%s".formatted(stsClientSecret));
                 put("edc.ih.iam.publickey.alias", getFullKeyId());
                 put("edc.agent.identity.key", "client_id");
                 put("edc.iam.trusted-issuer.issuer.id", trustedIssuer);

diff --git a/...testFixtures/java/org/eclipse/tractusx/edc/tests/participant/TractusxParticipantBase.java b/...testFixtures/java/org/eclipse/tractusx/edc/tests/participant/TractusxParticipantBase.java
@@ -198,7 +198,7 @@ public ValidatableResponse getCatalog(TractusxParticipantBase provider) {
                 .contentType(JSON)
                 .when()
                 .body(requestBodyBuilder.build())
-                .post("/v2/catalog/request")
+                .post("/v3/catalog/request")
                 .then();
 
     }

diff --git a/...res/src/testFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/BeforeInitCallback.java b/...res/src/testFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/BeforeInitCallback.java
@@ -19,14 +19,15 @@
 
 package org.eclipse.tractusx.edc.tests.runtimes;
 
-import org.eclipse.edc.junit.extensions.EdcExtension;
+import org.eclipse.edc.junit.extensions.EmbeddedRuntime;
+import org.eclipse.edc.junit.extensions.RuntimeExtension;
 
 /**
- * Callback invoked before the runtime boots with extensions of {@link EdcExtension}. This will allow injecting
- * custom mock services directly in the tests rather than extending the {@link EdcExtension} with custom mocks
+ * Callback invoked before the runtime boots with extensions of {@link RuntimeExtension}. This will allow injecting
+ * custom mock services directly in the tests rather than extending the {@link RuntimeExtension} with custom mocks
  */
 @FunctionalInterface
 public interface BeforeInitCallback {
 
-    void beforeInit(EdcExtension runtime);
+    void beforeInit(EmbeddedRuntime runtime);
 }
diff --git a/...ane/fixtures/src/testFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/DataWiper.java b/...ane/fixtures/src/testFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/DataWiper.java
@@ -35,7 +35,7 @@
  */
 public class DataWiper {
 
-    private final ServiceExtensionContext context;
+    protected final ServiceExtensionContext context;
 
     public DataWiper(ServiceExtensionContext context) {
         this.context = context;

diff --git a/...res/src/testFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/ParticipantRuntime.java b/...res/src/testFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/ParticipantRuntime.java
@@ -27,7 +27,7 @@
 import org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver;
 import org.eclipse.edc.iam.identitytrust.spi.SecureTokenService;
 import org.eclipse.edc.iam.identitytrust.sts.embedded.EmbeddedSecureTokenService;
-import org.eclipse.edc.junit.extensions.EdcRuntimeExtension;
+import org.eclipse.edc.junit.extensions.EmbeddedRuntime;
 import org.eclipse.edc.spi.iam.AudienceResolver;
 import org.eclipse.edc.spi.iam.IdentityService;
 import org.eclipse.edc.spi.result.Result;
@@ -38,17 +38,16 @@
 import org.eclipse.edc.token.JwtGenerationService;
 import org.eclipse.tractusx.edc.spi.identity.mapper.BdrsClient;
 import org.eclipse.tractusx.edc.tests.MockBpnIdentityService;
-import org.junit.jupiter.api.extension.AfterAllCallback;
-import org.junit.jupiter.api.extension.BeforeAllCallback;
-import org.junit.jupiter.api.extension.ExtensionContext;
 
 import java.time.Clock;
 import java.time.Duration;
 import java.util.List;
 import java.util.Map;
 
-
-public class ParticipantRuntime extends EdcRuntimeExtension implements BeforeAllCallback, AfterAllCallback {
+/**
+ * Extends the {@link EmbeddedRuntime} adding a key pair to the runtime as well as adding a facility to purge the database ({@link DataWiper}).
+ */
+public class ParticipantRuntime extends EmbeddedRuntime {
 
     private final Map<String, String> properties;
     private final ECKey runtimeKeyPair;
@@ -59,7 +58,7 @@ public ParticipantRuntime(String moduleName, String runtimeName, String bpn, Map
     }
 
     public ParticipantRuntime(String moduleName, String runtimeName, String bpn, Map<String, String> properties, BeforeInitCallback beforeInitCallback) {
-        super(moduleName, runtimeName, properties);
+        super(runtimeName, properties, moduleName);
         this.properties = properties;
         this.registerServiceMock(IdentityService.class, new MockBpnIdentityService(bpn));
         this.registerServiceMock(AudienceResolver.class, RemoteMessage::getCounterPartyAddress);
@@ -81,25 +80,8 @@ public ParticipantRuntime(String moduleName, String runtimeName, String bpn, Map
         }
     }
 
-    @Override
-    public void beforeTestExecution(ExtensionContext extensionContext) {
-        //do nothing - we only want to start the runtime once
-        wiper.clearPersistence();
-    }
-
-    @Override
-    public void afterTestExecution(ExtensionContext context) {
-    }
-
-    @Override
-    public void beforeAll(ExtensionContext context) throws Exception {
-        //only run this once
-        super.beforeTestExecution(context);
-    }
-
-    @Override
-    public void afterAll(ExtensionContext context) throws Exception {
-        super.afterTestExecution(context);
+    public DataWiper getWiper() {
+        return wiper;
     }
 
     @Override

diff --git a/...estFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/ParticipantRuntimeExtension.java b/...estFixtures/java/org/eclipse/tractusx/edc/tests/runtimes/ParticipantRuntimeExtension.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft
+ *
+ * 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.edc.tests.runtimes;
+
+import org.eclipse.edc.junit.extensions.EmbeddedRuntime;
+import org.eclipse.edc.junit.extensions.RuntimePerClassExtension;
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import java.util.Map;
+
+/**
+ * Cleans up the database after every test to create a clean slate. This is faster than using a {@link org.eclipse.edc.junit.extensions.RuntimePerMethodExtension},
+ * especially with postgres
+ */
+public class ParticipantRuntimeExtension extends RuntimePerClassExtension implements AfterEachCallback {
+
+    public ParticipantRuntimeExtension(String moduleName, String runtimeName, String bpn, Map<String, String> properties, BeforeInitCallback beforeInitCallback) {
+        super(new ParticipantRuntime(moduleName, runtimeName, bpn, properties));
+
+        if (beforeInitCallback != null) {
+            beforeInitCallback.beforeInit(runtime);
+        }
+    }
+
+    public ParticipantRuntimeExtension(EmbeddedRuntime embeddedRuntime) {
+        super(embeddedRuntime);
+    }
+
+    @Override
+    public void afterEach(ExtensionContext extensionContext) {
+        ((ParticipantRuntime) runtime).getWiper().clearPersistence();
+    }
+}