refactor: extract validator-data-address-s3 module

eclipse-edc · Jun 21, 2024 · 5b8b629 · 5b8b629
1 parent 484fb46
commit 5b8b629
Show file tree

Hide file tree

Showing 35 changed files with 330 additions and 438 deletions.
diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -17,11 +17,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+
   Checkstyle:
-    permissions:
-      id-token: write
-      checks: write
-      pull-requests: write
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -43,81 +40,23 @@ jobs:
         with:
           command: ./gradlew test jacocoTestReport
 
-  Component-Tests:
-    env:
-      JACOCO: true
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: eclipse-edc/.github/.github/actions/setup-build@main
-
-      - name: Component Tests
-        uses: eclipse-edc/.github/.github/actions/run-tests@main
-        with:
-          command: ./gradlew jacocoTestReport -DincludeTags="ComponentTest"
-
   End-To-End-Tests:
     runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: eclipse-edc/.github/.github/actions/setup-build@main
-
-      - name: End to End Integration Tests
-        uses: eclipse-edc/.github/.github/actions/run-tests@main
-        with:
-          command: ./gradlew test -DincludeTags="EndToEndTest"
-
-  API-Tests:
     env:
       JACOCO: true
-    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: eclipse-edc/.github/.github/actions/setup-build@main
 
-      - name: Component Tests
-        uses: eclipse-edc/.github/.github/actions/run-tests@main
-        with:
-          command: ./gradlew test jacocoTestReport -DincludeTags="ApiTest"
-
-  Aws-Integration-Tests:
-    runs-on: ubuntu-latest
-
-    env:
-      S3_ACCESS_KEY_ID: root
-      S3_SECRET_ACCESS_KEY: password
-
-    services:
-      minio-source:
-        image: bitnami/minio:latest
-        ports:
-          - 9000:9000
-        env:
-          MINIO_ROOT_USER: root
-          MINIO_ROOT_PASSWORD: password
-      minio-destination:
-        image: bitnami/minio:latest
-        ports:
-          - 9002:9000
-        env:
-          MINIO_ROOT_USER: root
-          MINIO_ROOT_PASSWORD: password
-
-    steps:
-      - uses: actions/checkout@v4
-      - uses: eclipse-edc/.github/.github/actions/setup-build@main
-
-      - name: AWS Tests
+      - name: End to End Integration Tests
         uses: eclipse-edc/.github/.github/actions/run-tests@main
         with:
-          command: ./gradlew -p extensions test -DincludeTags="AwsS3IntegrationTest"
+          command: ./gradlew test -DincludeTags="EndToEndTest"
 
   Upload-Test-Report:
     needs:
       - Unit-Tests
-      - Aws-Integration-Tests
       - End-To-End-Tests
-      - Component-Tests
 
     permissions:
       checks: write
@@ -139,8 +78,7 @@ jobs:
   Upload-Coverage-Report-To-Codecov:
     needs:
       - Unit-Tests
-      - Component-Tests
-      - API-Tests
+      - End-To-End-Tests
     runs-on: ubuntu-latest
     if: always()
     steps:

diff --git a/extensions/common/aws/aws-s3-core/build.gradle.kts b/extensions/common/aws/aws-s3-core/build.gradle.kts
@@ -17,6 +17,7 @@ plugins {
 }
 
 dependencies {
+    api(project(":spi:common:aws-spi"))
     api(libs.edc.spi.transfer)
     api(libs.edc.spi.validation)
 

diff --git a/...re/src/main/java/org/eclipse/edc/aws/s3/validation/S3DataAddressCredentialsValidator.java b/...re/src/main/java/org/eclipse/edc/aws/s3/validation/S3DataAddressCredentialsValidator.java
@@ -21,8 +21,8 @@
 import java.util.Objects;
 import java.util.stream.Stream;
 
-import static org.eclipse.edc.aws.s3.S3BucketSchema.ACCESS_KEY_ID;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.SECRET_ACCESS_KEY;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.ACCESS_KEY_ID;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.SECRET_ACCESS_KEY;
 import static org.eclipse.edc.validator.spi.Violation.violation;
 
 /**

diff --git a/...-s3-core/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension b/...-s3-core/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension
@@ -13,4 +13,3 @@
 #
 
 org.eclipse.edc.aws.s3.S3CoreExtension
-org.eclipse.edc.aws.s3.S3DataAddressValidatorExtension
diff --git a/...rc/test/java/org/eclipse/edc/aws/s3/validation/S3DataAddressCredentialsValidatorTest.java b/...rc/test/java/org/eclipse/edc/aws/s3/validation/S3DataAddressCredentialsValidatorTest.java
@@ -20,9 +20,9 @@
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.ACCESS_KEY_ID;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.SECRET_ACCESS_KEY;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.TYPE;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.ACCESS_KEY_ID;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.SECRET_ACCESS_KEY;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.TYPE;
 import static org.eclipse.edc.junit.assertions.AbstractResultAssert.assertThat;
 
 public class S3DataAddressCredentialsValidatorTest {

diff --git a/extensions/common/aws/aws-s3-test/README.md b/extensions/common/aws/aws-s3-test/README.md
@@ -25,7 +25,7 @@ for running integration tests against AWS S3 by environment variable:
 $ IT_AWS_ENDPOINT=https://s3.us-east-1.amazonaws.com/ \
   IT_AWS_REGION=us-east-1 \
   IT_AWS_PROFILE=myprofie \
-  ./gradlew clean test -DincludeTags="AwsS3IntegrationTest"
+  ./gradlew clean test -DincludeTags="EndToEndTest"
 ```
 
 `IT_AWS_REGION` must be set to your region code in order to avoid

diff --git a/...aws-s3-test/src/testFixtures/java/org/eclipse/edc/aws/s3/testfixtures/AbstractS3Test.java b/...aws-s3-test/src/testFixtures/java/org/eclipse/edc/aws/s3/testfixtures/AbstractS3Test.java
@@ -16,7 +16,6 @@
 package org.eclipse.edc.aws.s3.testfixtures;
 
 import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import software.amazon.awssdk.regions.Region;
 
@@ -30,7 +29,10 @@
 
 /**
  * Base class for tests that need an S3 bucket created and deleted on every test run.
+ *
+ * @deprecated it is not used anymore in the Technology-Aws repository, so it will be removed.
  */
+@Deprecated(since = "0.7.1")
 public abstract class AbstractS3Test {
 
     protected static final String REGION = propOrEnv("it.aws.region", Region.US_EAST_1.id());
@@ -46,16 +48,13 @@ public abstract class AbstractS3Test {
     protected String bucketName = "test-bucket-" + UUID.randomUUID() + "-" + REGION;
 
     protected S3TestClient sourceClient = S3TestClient.create(SOURCE_MINIO_ENDPOINT, REGION);
-
     protected S3TestClient destinationClient = S3TestClient.create(DESTINATION_MINIO_ENDPOINT, REGION);
 
     protected static final String OBJECT_PREFIX = "object-prefix/";
-
     protected static final String OBJECT_NAME = "text-document.txt";
-
     protected static final String KEY_NAME = "key-name";
 
-    @BeforeAll
+    @BeforeEach
     void prepareAll() {
         await().atLeast(Duration.ofSeconds(2))
             .atMost(Duration.ofSeconds(15))

diff --git a/...s/aws-s3-test/src/testFixtures/java/org/eclipse/edc/aws/s3/testfixtures/S3TestClient.java b/...s/aws-s3-test/src/testFixtures/java/org/eclipse/edc/aws/s3/testfixtures/S3TestClient.java
@@ -62,7 +62,7 @@ public class S3TestClient {
     private S3TestClient(String url, String region) {
         this.url = url;
         this.s3Endpoint = URI.create(propOrEnv("it.aws.endpoint", url));
-        AwsClientProviderConfiguration configuration = AwsClientProviderConfiguration.Builder.newInstance()
+        var configuration = AwsClientProviderConfiguration.Builder.newInstance()
                 .credentialsProvider(this::getCredentials)
                 .endpointOverride(this.s3Endpoint)
                 .build();
@@ -93,7 +93,7 @@ public static S3TestClient create(String url, String region) {
      *
      * @return true if HTTP status [200..300[
      */
-    protected boolean isAvailable()  throws IOException {
+    public boolean isAvailable()  throws IOException {
         var httpClient = testHttpClient();
         var healthRq = new Request.Builder().url(s3Endpoint + "/minio/health/live").get().build();
         try (var response = httpClient.execute(healthRq)) {
@@ -178,7 +178,7 @@ public CompletableFuture<ResponseBytes<GetObjectResponse>> getObject(String buck
              .getObject(GetObjectRequest.builder().bucket(bucketName).key(key).build(), new ByteArrayAsyncResponseTransformer<>());
     }
 
-    protected boolean isMinio() {
+    public boolean isMinio() {
         return url.equals(s3Endpoint.toString());
     }
 

diff --git a/...stFixtures/java/org/eclipse/edc/aws/s3/testfixtures/annotations/AwsS3IntegrationTest.java b/...stFixtures/java/org/eclipse/edc/aws/s3/testfixtures/annotations/AwsS3IntegrationTest.java
@@ -24,10 +24,13 @@
 
 /**
  * Annotation for AWS S3 integration testing.  It applies specific Junit Tag.
+ *
+ * @deprecated not used anymore, please use {@link org.eclipse.edc.junit.annotations.EndToEndTest}.
  */
 @Target({ ElementType.TYPE })
 @Retention(RetentionPolicy.RUNTIME)
 @IntegrationTest
 @Tag("AwsS3IntegrationTest")
+@Deprecated(since = "0.7.1")
 public @interface AwsS3IntegrationTest {
 }
diff --git a/extensions/common/validator/validator-data-address-s3/build.gradle.kts b/extensions/common/validator/validator-data-address-s3/build.gradle.kts
@@ -0,0 +1,26 @@
+/*
+ *  Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+ *
+ *  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
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
+ *
+ */
+
+plugins {
+    `java-library`
+}
+
+dependencies {
+    api(project(":spi:common:aws-spi"))
+    api(libs.edc.spi.validation)
+
+    testImplementation(libs.edc.junit)
+}
+
+
diff --git a/...s/s3/S3DataAddressValidatorExtension.java → ...ator/S3DataAddressValidatorExtension.java b/...s/s3/S3DataAddressValidatorExtension.java → ...ator/S3DataAddressValidatorExtension.java
@@ -12,17 +12,16 @@
  *
  */
 
-package org.eclipse.edc.aws.s3;
+package org.eclipse.edc.aws.s3.validator;
 
-import org.eclipse.edc.aws.s3.validation.S3DestinationDataAddressValidator;
-import org.eclipse.edc.aws.s3.validation.S3SourceDataAddressValidator;
+import org.eclipse.edc.aws.s3.spi.S3BucketSchema;
 import org.eclipse.edc.runtime.metamodel.annotation.Extension;
 import org.eclipse.edc.runtime.metamodel.annotation.Inject;
 import org.eclipse.edc.spi.system.ServiceExtension;
 import org.eclipse.edc.spi.system.ServiceExtensionContext;
 import org.eclipse.edc.validator.spi.DataAddressValidatorRegistry;
 
-import static org.eclipse.edc.aws.s3.S3DataAddressValidatorExtension.NAME;
+import static org.eclipse.edc.aws.s3.validator.S3DataAddressValidatorExtension.NAME;
 
 @Extension(NAME)
 public class S3DataAddressValidatorExtension implements ServiceExtension {

diff --git a/...on/S3DestinationDataAddressValidator.java → ...or/S3DestinationDataAddressValidator.java b/...on/S3DestinationDataAddressValidator.java → ...or/S3DestinationDataAddressValidator.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.aws.s3.validation;
+package org.eclipse.edc.aws.s3.validator;
 
 import org.eclipse.edc.spi.types.domain.DataAddress;
 import org.eclipse.edc.validator.spi.ValidationResult;
@@ -21,8 +21,8 @@
 import java.util.Objects;
 import java.util.stream.Stream;
 
-import static org.eclipse.edc.aws.s3.S3BucketSchema.BUCKET_NAME;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.REGION;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.BUCKET_NAME;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.REGION;
 import static org.eclipse.edc.validator.spi.Violation.violation;
 
 /**

diff --git a/...idation/S3SourceDataAddressValidator.java → ...lidator/S3SourceDataAddressValidator.java b/...idation/S3SourceDataAddressValidator.java → ...lidator/S3SourceDataAddressValidator.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.aws.s3.validation;
+package org.eclipse.edc.aws.s3.validator;
 
 import org.eclipse.edc.spi.types.domain.DataAddress;
 import org.eclipse.edc.validator.spi.ValidationResult;
@@ -22,12 +22,12 @@
 import java.util.ArrayList;
 import java.util.stream.Stream;
 
-import static org.eclipse.edc.aws.s3.S3BucketSchema.BUCKET_NAME;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.KEY_NAME;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.KEY_PREFIX;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.OBJECT_NAME;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.OBJECT_PREFIX;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.REGION;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.BUCKET_NAME;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.KEY_NAME;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.KEY_PREFIX;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.OBJECT_NAME;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.OBJECT_PREFIX;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.REGION;
 import static org.eclipse.edc.validator.spi.Violation.violation;
 
 /**

diff --git a/...dress-s3/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension b/...dress-s3/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension
@@ -0,0 +1,15 @@
+#
+#  Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+#
+#  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
+#
+#  SPDX-License-Identifier: Apache-2.0
+#
+#  Contributors:
+#       Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+#
+#
+
+org.eclipse.edc.aws.s3.validator.S3DataAddressValidatorExtension
diff --git a/...ionDataAddressValidatorExtensionTest.java → .../S3DataAddressValidatorExtensionTest.java b/...ionDataAddressValidatorExtensionTest.java → .../S3DataAddressValidatorExtensionTest.java
@@ -12,11 +12,10 @@
  *
  */
 
-package org.eclipse.edc.aws.s3;
+package org.eclipse.edc.aws.s3.validator;
 
 
-import org.eclipse.edc.aws.s3.validation.S3DestinationDataAddressValidator;
-import org.eclipse.edc.aws.s3.validation.S3SourceDataAddressValidator;
+import org.eclipse.edc.aws.s3.spi.S3BucketSchema;
 import org.eclipse.edc.junit.extensions.DependencyInjectionExtension;
 import org.eclipse.edc.spi.system.ServiceExtensionContext;
 import org.eclipse.edc.validator.spi.DataAddressValidatorRegistry;
@@ -31,7 +30,7 @@
 import static org.mockito.Mockito.verify;
 
 @ExtendWith(DependencyInjectionExtension.class)
-public class S3DestinationDataAddressValidatorExtensionTest {
+public class S3DataAddressValidatorExtensionTest {
 
     private final DataAddressValidatorRegistry registry = mock();
 

diff --git a/...3DestinationDataAddressValidatorTest.java → ...3DestinationDataAddressValidatorTest.java b/...3DestinationDataAddressValidatorTest.java → ...3DestinationDataAddressValidatorTest.java
@@ -12,17 +12,17 @@
  *
  */
 
-package org.eclipse.edc.aws.s3.validation;
+package org.eclipse.edc.aws.s3.validator;
 
 import org.eclipse.edc.spi.types.domain.DataAddress;
 import org.eclipse.edc.validator.spi.ValidationFailure;
 import org.eclipse.edc.validator.spi.Violation;
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.BUCKET_NAME;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.REGION;
-import static org.eclipse.edc.aws.s3.S3BucketSchema.TYPE;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.BUCKET_NAME;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.REGION;
+import static org.eclipse.edc.aws.s3.spi.S3BucketSchema.TYPE;
 import static org.eclipse.edc.junit.assertions.AbstractResultAssert.assertThat;
 
 public class S3DestinationDataAddressValidatorTest {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,4 +13,3 @@
		#

		org.eclipse.edc.aws.s3.S3CoreExtension
		org.eclipse.edc.aws.s3.S3DataAddressValidatorExtension