refactor: move constants to :dsp-core (#3027)

* refactor: move constants to :dsp-core * refactor(dsp): remove error constant from controllers * fix(dsp): change wrong properties and imports in catalog modules * chore(dsp-catalog-api): add missing test dependency * chore(dsp): rename :dsp-core to :dsp-spi
eclipse-edc · May 17, 2023 · 6ef51ac · 6ef51ac
1 parent b3e37dd
commit 6ef51ac
Show file tree

Hide file tree

Showing 68 changed files with 700 additions and 730 deletions.
diff --git a/data-protocols/dsp/dsp-catalog/dsp-catalog-api/build.gradle.kts b/data-protocols/dsp/dsp-catalog/dsp-catalog-api/build.gradle.kts
@@ -18,8 +18,8 @@ plugins {
 
 dependencies {
     api(project(":data-protocols:dsp:dsp-api-configuration"))
-    api(project(":data-protocols:dsp:dsp-catalog:dsp-catalog-transform"))
-    api(project(":data-protocols:dsp:dsp-core"))
+    api(project(":data-protocols:dsp:dsp-spi"))
+    api(project(":data-protocols:dsp:dsp-http-spi"))
     api(project(":data-protocols:dsp:dsp-transform"))
 
     api(project(":spi:common:core-spi"))
@@ -30,5 +30,6 @@ dependencies {
     implementation(libs.jakarta.rsApi)
 
     testImplementation(project(":core:common:junit"))
+    testImplementation(project(":data-protocols:dsp:dsp-catalog:dsp-catalog-transform"))
     testImplementation(libs.restAssured)
 }
diff --git a/...ain/java/org/eclipse/edc/protocol/dsp/catalog/api/controller/DspCatalogApiController.java b/...ain/java/org/eclipse/edc/protocol/dsp/catalog/api/controller/DspCatalogApiController.java
@@ -25,7 +25,6 @@
 import org.eclipse.edc.catalog.spi.CatalogRequestMessage;
 import org.eclipse.edc.connector.spi.catalog.CatalogProtocolService;
 import org.eclipse.edc.jsonld.spi.JsonLd;
-import org.eclipse.edc.jsonld.spi.Namespaces;
 import org.eclipse.edc.protocol.dsp.DspError;
 import org.eclipse.edc.spi.iam.IdentityService;
 import org.eclipse.edc.spi.iam.TokenRepresentation;
@@ -41,8 +40,9 @@
 import static org.eclipse.edc.protocol.dsp.DspErrorDetails.UNAUTHORIZED;
 import static org.eclipse.edc.protocol.dsp.catalog.api.CatalogApiPaths.BASE_PATH;
 import static org.eclipse.edc.protocol.dsp.catalog.api.CatalogApiPaths.CATALOG_REQUEST;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
 import static org.eclipse.edc.protocol.dsp.spi.types.HttpMessageProtocol.DATASPACE_PROTOCOL_HTTP;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_ERROR;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_REQUEST_MESSAGE;
 
 /**
  * Provides the HTTP endpoint for receiving catalog requests.
@@ -52,8 +52,6 @@
 @Path(BASE_PATH)
 public class DspCatalogApiController {
 
-    private static final String DSPACE_CATALOG_ERROR = Namespaces.DSPACE_SCHEMA + "CatalogError"; // TODO move to :dsp-core https://github.com/eclipse-edc/Connector/issues/3014
-
     private final Monitor monitor;
     private final IdentityService identityService;
     private final TypeTransformerRegistry transformerRegistry;
@@ -94,7 +92,7 @@ public Response getCatalog(JsonObject jsonObject, @HeaderParam(AUTHORIZATION) St
         }
 
         var expandedJson = expanded.getContent();
-        if (!isOfExpectedType(expandedJson, DSPACE_CATALOG_REQUEST_TYPE)) {
+        if (!isOfExpectedType(expandedJson, DSPACE_TYPE_CATALOG_REQUEST_MESSAGE)) {
             monitor.debug(String.format("%s, %s", BAD_REQUEST, verificationResult.getFailureMessages()));
             return errorResponse(Response.Status.BAD_REQUEST, BAD_REQUEST);
         }
@@ -138,7 +136,7 @@ public Response getCatalog(JsonObject jsonObject, @HeaderParam(AUTHORIZATION) St
     private Response errorResponse(Response.Status code, String message) {
         return Response.status(code).type(MediaType.APPLICATION_JSON)
                 .entity(DspError.Builder.newInstance()
-                        .type(DSPACE_CATALOG_ERROR)
+                        .type(DSPACE_TYPE_CATALOG_ERROR)
                         .code(Integer.toString(code.getStatusCode()))
                         .messages(List.of(message))
                         .build().toJson())

diff --git a/...lipse/edc/protocol/dsp/catalog/api/controller/DspCatalogApiControllerIntegrationTest.java b/...lipse/edc/protocol/dsp/catalog/api/controller/DspCatalogApiControllerIntegrationTest.java
@@ -23,7 +23,6 @@
 import org.eclipse.edc.catalog.spi.DataServiceRegistry;
 import org.eclipse.edc.connector.spi.catalog.CatalogProtocolService;
 import org.eclipse.edc.jsonld.spi.JsonLdKeywords;
-import org.eclipse.edc.jsonld.spi.Namespaces;
 import org.eclipse.edc.junit.annotations.ApiTest;
 import org.eclipse.edc.junit.extensions.EdcExtension;
 import org.eclipse.edc.service.spi.result.ServiceResult;
@@ -47,7 +46,8 @@
 import static org.eclipse.edc.junit.testfixtures.TestUtils.getFreePort;
 import static org.eclipse.edc.protocol.dsp.catalog.api.CatalogApiPaths.BASE_PATH;
 import static org.eclipse.edc.protocol.dsp.catalog.api.CatalogApiPaths.CATALOG_REQUEST;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_ERROR;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_REQUEST_MESSAGE;
 import static org.eclipse.edc.protocol.dsp.type.DspPropertyAndTypeNames.DSPACE_PROPERTY_CODE;
 import static org.eclipse.edc.protocol.dsp.type.DspPropertyAndTypeNames.DSPACE_PROPERTY_REASON;
 import static org.hamcrest.CoreMatchers.is;
@@ -60,8 +60,6 @@
 @ExtendWith(EdcExtension.class)
 class DspCatalogApiControllerIntegrationTest {
 
-    private static final String DSPACE_CATALOG_ERROR = Namespaces.DSPACE_SCHEMA + "CatalogError";
-
     private final int dspApiPort = getFreePort();
     private final String dspApiPath = "/api/v1/dsp";
     private final String callbackAddress = "http://callback";
@@ -90,7 +88,7 @@ void setUp(EdcExtension extension) {
                 .add(CONTEXT, Json.createObjectBuilder()
                         .add(DSPACE_PREFIX, DSPACE_SCHEMA)
                         .build())
-                .add(TYPE, DSPACE_CATALOG_REQUEST_TYPE)
+                .add(TYPE, DSPACE_TYPE_CATALOG_REQUEST_MESSAGE)
                 .build();
     }
 
@@ -121,7 +119,7 @@ void catalogRequest_authenticationFailed_returnUnauthorized() {
                 .statusCode(401)
                 .extract().as(Map.class);
 
-        assertThat(result.get(JsonLdKeywords.TYPE)).isEqualTo(DSPACE_CATALOG_ERROR);
+        assertThat(result.get(JsonLdKeywords.TYPE)).isEqualTo(DSPACE_TYPE_CATALOG_ERROR);
         assertThat(result.get(DSPACE_PROPERTY_CODE)).isEqualTo("401");
         assertThat(result.get(DSPACE_PROPERTY_REASON)).isNotNull();
     }
@@ -146,7 +144,7 @@ void catalogRequest_requestTransformationFailed_returnBadRequest() {
                 .statusCode(400)
                 .extract().as(Map.class);
 
-        assertThat(result.get(JsonLdKeywords.TYPE)).isEqualTo(DSPACE_CATALOG_ERROR);
+        assertThat(result.get(JsonLdKeywords.TYPE)).isEqualTo(DSPACE_TYPE_CATALOG_ERROR);
         assertThat(result.get(DSPACE_PROPERTY_CODE)).isEqualTo("400");
         assertThat(result.get(DSPACE_PROPERTY_REASON)).isNotNull();
     }

diff --git a/...java/org/eclipse/edc/protocol/dsp/catalog/api/controller/DspCatalogApiControllerTest.java b/...java/org/eclipse/edc/protocol/dsp/catalog/api/controller/DspCatalogApiControllerTest.java
@@ -22,7 +22,6 @@
 import org.eclipse.edc.jsonld.TitaniumJsonLd;
 import org.eclipse.edc.jsonld.spi.JsonLd;
 import org.eclipse.edc.jsonld.spi.JsonLdKeywords;
-import org.eclipse.edc.jsonld.spi.Namespaces;
 import org.eclipse.edc.service.spi.result.ServiceResult;
 import org.eclipse.edc.spi.iam.ClaimToken;
 import org.eclipse.edc.spi.iam.IdentityService;
@@ -43,8 +42,9 @@
 import static org.eclipse.edc.jsonld.spi.Namespaces.DSPACE_SCHEMA;
 import static org.eclipse.edc.jsonld.spi.Namespaces.ODRL_PREFIX;
 import static org.eclipse.edc.jsonld.spi.Namespaces.ODRL_SCHEMA;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
 import static org.eclipse.edc.protocol.dsp.spi.types.HttpMessageProtocol.DATASPACE_PROTOCOL_HTTP;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_ERROR;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_REQUEST_MESSAGE;
 import static org.eclipse.edc.protocol.dsp.type.DspPropertyAndTypeNames.DSPACE_PROPERTY_CODE;
 import static org.eclipse.edc.protocol.dsp.type.DspPropertyAndTypeNames.DSPACE_PROPERTY_REASON;
 import static org.eclipse.edc.service.spi.result.ServiceResult.badRequest;
@@ -57,8 +57,6 @@
 
 class DspCatalogApiControllerTest {
 
-    private static final String DSPACE_CATALOG_ERROR = Namespaces.DSPACE_SCHEMA + "CatalogError";
-
     private final Monitor monitor = mock(Monitor.class);
     private final IdentityService identityService = mock(IdentityService.class);
     private final TypeTransformerRegistry transformerRegistry = mock(TypeTransformerRegistry.class);
@@ -83,7 +81,7 @@ void setUp() {
         controller = new DspCatalogApiController(monitor, identityService, transformerRegistry, callbackAddress, service, jsonLdService);
 
         request = Json.createObjectBuilder()
-                .add(TYPE, DSPACE_CATALOG_REQUEST_TYPE)
+                .add(TYPE, DSPACE_TYPE_CATALOG_REQUEST_MESSAGE)
                 .build();
         requestMessage = CatalogRequestMessage.Builder.newInstance().protocol("protocol").build();
     }
@@ -124,7 +122,7 @@ void getCatalog_invalidTypeInRequest_throwException() {
 
         var errorObject = (JsonObject) response.getEntity();
 
-        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_CATALOG_ERROR);
+        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_TYPE_CATALOG_ERROR);
         assertThat(errorObject.getJsonString(DSPACE_PROPERTY_CODE).getString()).isEqualTo("400");
         assertThat(errorObject.get(DSPACE_PROPERTY_REASON)).isNotNull();
 
@@ -143,7 +141,7 @@ void getCatalog_transformingRequestFails_throwException() {
 
         var errorObject = (JsonObject) response.getEntity();
 
-        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_CATALOG_ERROR);
+        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_TYPE_CATALOG_ERROR);
         assertThat(errorObject.getJsonString(DSPACE_PROPERTY_CODE).getString()).isEqualTo("400");
         assertThat(errorObject.get(DSPACE_PROPERTY_REASON)).isNotNull();
     }
@@ -159,7 +157,7 @@ void getCatalog_authenticationFails_throwException() {
 
         var errorObject = (JsonObject) response.getEntity();
 
-        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_CATALOG_ERROR);
+        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_TYPE_CATALOG_ERROR);
         assertThat(errorObject.getJsonString(DSPACE_PROPERTY_CODE).getString()).isEqualTo("401");
         assertThat(errorObject.get(DSPACE_PROPERTY_REASON)).isNotNull();
     }
@@ -178,7 +176,7 @@ void getCatalog_shouldThrowException_whenServiceCallFails() {
 
         var errorObject = (JsonObject) response.getEntity();
 
-        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_CATALOG_ERROR);
+        assertThat(errorObject.getJsonString(TYPE).getString()).isEqualTo(DSPACE_TYPE_CATALOG_ERROR);
         assertThat(errorObject.getJsonString(DSPACE_PROPERTY_CODE).getString()).isNotNull();
         assertThat(errorObject.get(DSPACE_PROPERTY_REASON)).isNotNull();
 

diff --git a/data-protocols/dsp/dsp-catalog/dsp-catalog-transform/build.gradle.kts b/data-protocols/dsp/dsp-catalog/dsp-catalog-transform/build.gradle.kts
@@ -20,5 +20,6 @@ dependencies {
     api(project(":spi:common:catalog-spi"))
     api(project(":spi:common:json-ld-spi"))
     api(project(":extensions:common:json-ld"))
+    api(project(":data-protocols:dsp:dsp-spi"))
     api(project(":data-protocols:dsp:dsp-http-spi"))
 }
diff --git a/...c/protocol/dsp/catalog/transform/from/JsonObjectFromCatalogRequestMessageTransformer.java b/...c/protocol/dsp/catalog/transform/from/JsonObjectFromCatalogRequestMessageTransformer.java
@@ -23,8 +23,8 @@
 import org.jetbrains.annotations.Nullable;
 
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_FILTER_PROPERTY;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_PROPERTY_FILTER;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_REQUEST_MESSAGE;
 
 /**
  * Transforms a {@link CatalogRequestMessage} to a {@link JsonObject} in JSON-LD expanded form.
@@ -41,10 +41,10 @@ public JsonObjectFromCatalogRequestMessageTransformer(JsonBuilderFactory jsonFac
     @Override
     public @Nullable JsonObject transform(@NotNull CatalogRequestMessage message, @NotNull TransformerContext context) {
         var builder = jsonFactory.createObjectBuilder();
-        builder.add(TYPE, DSPACE_CATALOG_REQUEST_TYPE);
+        builder.add(TYPE, DSPACE_TYPE_CATALOG_REQUEST_MESSAGE);
 
         if (message.getQuerySpec() != null) {
-            builder.add(DSPACE_FILTER_PROPERTY, context.transform(message.getQuerySpec(), JsonObject.class));
+            builder.add(DSPACE_PROPERTY_FILTER, context.transform(message.getQuerySpec(), JsonObject.class));
         }
 
         return builder.build();

diff --git a/...e/edc/protocol/dsp/catalog/transform/to/JsonObjectToCatalogRequestMessageTransformer.java b/...e/edc/protocol/dsp/catalog/transform/to/JsonObjectToCatalogRequestMessageTransformer.java
@@ -23,7 +23,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_FILTER_PROPERTY;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_PROPERTY_FILTER;
 
 /**
  * Transforms a {@link JsonObject} in JSON-LD expanded form to a {@link CatalogRequestMessage}.
@@ -51,7 +51,7 @@ public JsonObjectToCatalogRequestMessageTransformer(ObjectMapper mapper) {
 
     @Nullable
     private QuerySpec transformQuerySpec(JsonObject object, TransformerContext context) {
-        var value = object.get(DSPACE_FILTER_PROPERTY);
+        var value = object.get(DSPACE_PROPERTY_FILTER);
         if (value == null) {
             return null;
         }

diff --git a/...otocol/dsp/catalog/transform/from/JsonObjectFromCatalogRequestMessageTransformerTest.java b/...otocol/dsp/catalog/transform/from/JsonObjectFromCatalogRequestMessageTransformerTest.java
@@ -27,8 +27,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_FILTER_PROPERTY;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_PROPERTY_FILTER;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_REQUEST_MESSAGE;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
@@ -61,8 +61,8 @@ void transform_returnJsonObject() {
         var result = transformer.transform(message, context);
 
         assertThat(result).isNotNull();
-        assertThat(result.getJsonString(TYPE).getString()).isEqualTo(DSPACE_CATALOG_REQUEST_TYPE);
-        assertThat(result.get(DSPACE_FILTER_PROPERTY)).isEqualTo(querySpecJson);
+        assertThat(result.getJsonString(TYPE).getString()).isEqualTo(DSPACE_TYPE_CATALOG_REQUEST_MESSAGE);
+        assertThat(result.get(DSPACE_PROPERTY_FILTER)).isEqualTo(querySpecJson);
         verify(context, never()).reportProblem(anyString());
     }
 }
diff --git a/...c/protocol/dsp/catalog/transform/to/JsonObjectToCatalogRequestMessageTransformerTest.java b/...c/protocol/dsp/catalog/transform/to/JsonObjectToCatalogRequestMessageTransformerTest.java
@@ -26,8 +26,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
-import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_FILTER_PROPERTY;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_PROPERTY_FILTER;
+import static org.eclipse.edc.protocol.dsp.type.DspCatalogPropertyAndTypeNames.DSPACE_TYPE_CATALOG_REQUEST_MESSAGE;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
@@ -54,8 +54,8 @@ void transform_returnCatalogRequestMessage() {
         when(context.transform(querySpecJson, QuerySpec.class)).thenReturn(querySpec);
 
         var message = jsonFactory.createObjectBuilder()
-                .add(TYPE, DSPACE_CATALOG_REQUEST_TYPE)
-                .add(DSPACE_FILTER_PROPERTY, querySpecJson)
+                .add(TYPE, DSPACE_TYPE_CATALOG_REQUEST_MESSAGE)
+                .add(DSPACE_PROPERTY_FILTER, querySpecJson)
                 .build();
 
         var result = transformer.transform(message, context);

diff --git a/data-protocols/dsp/dsp-negotiation/dsp-negotiation-api/build.gradle.kts b/data-protocols/dsp/dsp-negotiation/dsp-negotiation-api/build.gradle.kts
@@ -19,11 +19,8 @@ plugins {
 
 dependencies {
     api(project(":data-protocols:dsp:dsp-api-configuration"))
-    api(project(":data-protocols:dsp:dsp-core"))
-    api(project(":data-protocols:dsp:dsp-http-core"))
-
-    // TODO remove this dependency by moving type constants to another module https://github.com/eclipse-edc/Connector/issues/3014
-    api(project(":data-protocols:dsp:dsp-negotiation:dsp-negotiation-transform"))
+    api(project(":data-protocols:dsp:dsp-spi"))
+    api(project(":data-protocols:dsp:dsp-http-spi"))
 
     api(project(":spi:common:core-spi"))
     api(project(":spi:control-plane:control-plane-spi"))