feat(dsp): support implicit Offer policy type (#4143)

eclipse-edc · Apr 30, 2024 · 0aee8ef · 0aee8ef
1 parent 2b74582
commit 0aee8ef
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 14 deletions.
diff --git a/...g/eclipse/edc/connector/controlplane/transform/odrl/to/JsonObjectToPolicyTransformer.java b/...g/eclipse/edc/connector/controlplane/transform/odrl/to/JsonObjectToPolicyTransformer.java
@@ -27,6 +27,8 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.Optional;
+
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
 import static org.eclipse.edc.jsonld.spi.PropertyAndTypeNames.ODRL_ASSIGNEE_ATTRIBUTE;
 import static org.eclipse.edc.jsonld.spi.PropertyAndTypeNames.ODRL_ASSIGNER_ATTRIBUTE;
@@ -54,23 +56,28 @@ public JsonObjectToPolicyTransformer(ParticipantIdMapper participantIdMapper) {
     public @Nullable Policy transform(@NotNull JsonObject object, @NotNull TransformerContext context) {
         var builder = Policy.Builder.newInstance();
 
-        var type = object.getJsonArray(TYPE).stream().findFirst()
-                .map(JsonString.class::cast)
-                .map(JsonString::getString)
-                .orElse(ODRL_POLICY_TYPE_SET);
+        var policyType = Optional.ofNullable(context.consumeData(Policy.class, TYPE))
+                .map(PolicyType.class::cast)
+                .orElseGet(() -> {
+                    var tp = object.getJsonArray(TYPE).stream().findFirst()
+                            .map(JsonString.class::cast)
+                            .map(JsonString::getString)
+                            .orElse(ODRL_POLICY_TYPE_SET);
 
-        var policyType = switch (type) {
-            case ODRL_POLICY_TYPE_SET -> PolicyType.SET;
-            case ODRL_POLICY_TYPE_OFFER -> PolicyType.OFFER;
-            case ODRL_POLICY_TYPE_AGREEMENT -> PolicyType.CONTRACT;
-            default -> null;
-        };
+                    return switch (tp) {
+                        case ODRL_POLICY_TYPE_SET -> PolicyType.SET;
+                        case ODRL_POLICY_TYPE_OFFER -> PolicyType.OFFER;
+                        case ODRL_POLICY_TYPE_AGREEMENT -> PolicyType.CONTRACT;
+                        default -> null;
+                    };
+                });
 
         if (policyType == null) {
             context.problem()
                     .invalidProperty()
                     .property(TYPE)
-                    .error("Invalid type %s for ODRL policy, should be one of [%s, %s, %s]".formatted(type, ODRL_POLICY_TYPE_SET, ODRL_POLICY_TYPE_OFFER, ODRL_POLICY_TYPE_AGREEMENT))
+                    .value(null)
+                    .error("Invalid type for ODRL policy, should be one of [%s, %s, %s]".formatted(ODRL_POLICY_TYPE_SET, ODRL_POLICY_TYPE_OFFER, ODRL_POLICY_TYPE_AGREEMENT))
                     .report();
             return null;
         }

diff --git a/...lipse/edc/connector/controlplane/transform/odrl/to/JsonObjectToPolicyTransformerTest.java b/...lipse/edc/connector/controlplane/transform/odrl/to/JsonObjectToPolicyTransformerTest.java
@@ -21,6 +21,7 @@
 import org.eclipse.edc.connector.controlplane.transform.TestInput;
 import org.eclipse.edc.policy.model.Duty;
 import org.eclipse.edc.policy.model.Permission;
+import org.eclipse.edc.policy.model.Policy;
 import org.eclipse.edc.policy.model.PolicyType;
 import org.eclipse.edc.policy.model.Prohibition;
 import org.eclipse.edc.spi.agent.ParticipantIdMapper;
@@ -85,7 +86,6 @@ void setUp() {
 
     @Test
     void transform_withAllRuleTypesAsObjects_returnPolicy() {
-        var jsonFactory = Json.createBuilderFactory(Map.of());
         var permissionJson = jsonFactory.createObjectBuilder().add(TYPE, "permission").build();
         var prohibitionJson = jsonFactory.createObjectBuilder().add(TYPE, "prohibition").build();
         var dutyJson = jsonFactory.createObjectBuilder().add(TYPE, "duty").build();
@@ -171,6 +171,20 @@ void transform_invalidType_reportProblem() {
         verify(context).reportProblem(anyString());
     }
 
+    @Test
+    void shouldGetTypeFromContext_whenSet() {
+        when(context.consumeData(Policy.class, TYPE)).thenReturn(CONTRACT);
+
+        var policy = jsonFactory.createObjectBuilder()
+                .add(ODRL_TARGET_ATTRIBUTE, TARGET)
+                .build();
+
+        var result = transformer.transform(TestInput.getExpanded(policy), context);
+
+        assertThat(result).isNotNull();
+        assertThat(result.getType()).isEqualTo(CONTRACT);
+    }
+
     private static class PolicyTypeArguments implements ArgumentsProvider {
 
         @Override

diff --git a/...dc/protocol/dsp/negotiation/transform/to/JsonObjectToContractOfferMessageTransformer.java b/...dc/protocol/dsp/negotiation/transform/to/JsonObjectToContractOfferMessageTransformer.java
@@ -19,11 +19,13 @@
 import org.eclipse.edc.connector.controlplane.contract.spi.types.offer.ContractOffer;
 import org.eclipse.edc.jsonld.spi.transformer.AbstractJsonLdTransformer;
 import org.eclipse.edc.policy.model.Policy;
+import org.eclipse.edc.policy.model.PolicyType;
 import org.eclipse.edc.transform.spi.TransformerContext;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.ID;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
 import static org.eclipse.edc.protocol.dsp.spi.type.DspNegotiationPropertyAndTypeNames.DSPACE_PROPERTY_OFFER;
 import static org.eclipse.edc.protocol.dsp.spi.type.DspNegotiationPropertyAndTypeNames.DSPACE_TYPE_CONTRACT_OFFER_MESSAGE;
 import static org.eclipse.edc.protocol.dsp.spi.type.DspPropertyAndTypeNames.DSPACE_PROPERTY_CALLBACK_ADDRESS;
@@ -66,6 +68,7 @@ public JsonObjectToContractOfferMessageTransformer() {
 
         var contractOffer = returnJsonObject(jsonObject.get(DSPACE_PROPERTY_OFFER), context, DSPACE_PROPERTY_OFFER, false);
         if (contractOffer != null) {
+            context.setData(Policy.class, TYPE, PolicyType.OFFER);
             var policy = transformObject(contractOffer, Policy.class, context);
             if (policy == null) {
                 reportMissingProperty(DSPACE_TYPE_CONTRACT_OFFER_MESSAGE, DSPACE_PROPERTY_OFFER, context);

diff --git a/...rotocol/dsp/negotiation/transform/to/JsonObjectToContractOfferMessageTransformerTest.java b/...rotocol/dsp/negotiation/transform/to/JsonObjectToContractOfferMessageTransformerTest.java
@@ -19,6 +19,7 @@
 import jakarta.json.JsonObject;
 import org.eclipse.edc.jsonld.spi.JsonLdKeywords;
 import org.eclipse.edc.policy.model.Policy;
+import org.eclipse.edc.policy.model.PolicyType;
 import org.eclipse.edc.transform.spi.ProblemBuilder;
 import org.eclipse.edc.transform.spi.TransformerContext;
 import org.junit.jupiter.api.BeforeEach;
@@ -28,6 +29,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.ID;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
 import static org.eclipse.edc.protocol.dsp.spi.type.DspNegotiationPropertyAndTypeNames.DSPACE_PROPERTY_OFFER;
 import static org.eclipse.edc.protocol.dsp.spi.type.DspNegotiationPropertyAndTypeNames.DSPACE_TYPE_CONTRACT_OFFER_MESSAGE;
 import static org.eclipse.edc.protocol.dsp.spi.type.DspPropertyAndTypeNames.DSPACE_PROPERTY_CALLBACK_ADDRESS;
@@ -53,11 +55,10 @@ class JsonObjectToContractOfferMessageTransformerTest {
     private final JsonBuilderFactory jsonFactory = Json.createBuilderFactory(Map.of());
     private final TransformerContext context = mock();
 
-    private JsonObjectToContractOfferMessageTransformer transformer;
+    private final JsonObjectToContractOfferMessageTransformer transformer = new JsonObjectToContractOfferMessageTransformer();
 
     @BeforeEach
     void setUp() {
-        transformer = new JsonObjectToContractOfferMessageTransformer();
         when(context.problem()).thenReturn(new ProblemBuilder(context));
     }
 
@@ -92,6 +93,7 @@ void transform_shouldReturnMessage_whenValidJsonObject() {
         assertThat(contractOffer.getAssetId()).isEqualTo(ASSET_ID);
 
         verify(context, never()).reportProblem(anyString());
+        verify(context).setData(Policy.class, TYPE, PolicyType.OFFER);
     }
 
     @Deprecated(since = "0.4.1")