391 backend UI api wrapper GET & POST & DELETE contract definition endpoint with 02x

CHANGELOG.md

@@ -18,6 +18,9 @@ All notable changes to this project will be documented in this file.
   - Asset Page
   - Create Asset
   - Delete Asset
+  - Contract Definition Page
+  - Create Contract Definition
+  - Delete Contract Definition
 
 ### Migration Notes
 

e2e-test/src/test/java/de/sovity/edc/extension/e2e/connector/TestConnector.java

@@ -142,7 +142,7 @@ public void createContractDefinition(
                 .add(TYPE, EDC_NAMESPACE + "ContractDefinition")
                 .add(EDC_NAMESPACE + "accessPolicyId", accessPolicyId)
                 .add(EDC_NAMESPACE + "contractPolicyId", contractPolicyId)
-                .add(EDC_NAMESPACE + "assetsSelector", Json.createArrayBuilder()
+                .add(EDC_NAMESPACE + "assetSelector", Json.createArrayBuilder()
                         .add(createObjectBuilder()
                                 .add(TYPE, "CriterionDto")
                                 .add(EDC_NAMESPACE + "operandLeft", EDC_NAMESPACE + "id")

extensions/postgres-flyway/src/main/resources/migration/default/V3__MS8-to-0.2.0.sql

@@ -35,10 +35,10 @@ alter table edc_contract_negotiation add column callback_addresses json;
 alter table edc_contract_definitions rename column selector_expression to assets_selector;
 alter table edc_contract_definitions drop column validity;
 
--- remove criteria parent
+-- remove assetSelector parent
 UPDATE edc_contract_definitions
-SET assets_selector = assets_selector->'criteria'
-WHERE assets_selector::jsonb ? 'criteria';
+SET assets_selector = assets_selector->'assetSelector'
+WHERE assets_selector::jsonb ? 'assetSelector';
 
 -- fix asset_id_operands
 create or replace function migrate_json(criteria_json_array_element jsonb) returns jsonb as

extensions/postgres-flyway/src/main/resources/migration/provider/V1__m8-provider-sample-data.sql

@@ -61,7 +61,7 @@ INSERT INTO public.edc_contract_agreement (agr_id, provider_agent_id, consumer_a
 -- Data for Name: edc_contract_definitions; Type: TABLE DATA; Schema: public; Owner: edc
 --
 
-INSERT INTO public.edc_contract_definitions (contract_definition_id, access_policy_id, contract_policy_id, selector_expression, created_at, validity) VALUES ('test-contract-definition', 'test-policy', 'test-policy', '{"criteria":[{"operandLeft":"asset:prop:id","operator":"in","operandRight":["urn:artifact:test:1.0"]}]}', 1687179311116, 31536000);
+INSERT INTO public.edc_contract_definitions (contract_definition_id, access_policy_id, contract_policy_id, selector_expression, created_at, validity) VALUES ('test-contract-definition', 'test-policy', 'test-policy', '{"assetSelector":[{"operandLeft":"asset:prop:id","operator":"in","operandRight":["urn:artifact:test:1.0"]}]}', 1687179311116, 31536000);
 
 
 --

extensions/wrapper/client/src/test/java/de/sovity/edc/client/ContractDefinitionPageApiServiceTest.java

@@ -0,0 +1,174 @@
+package de.sovity.edc.client;
+
+import de.sovity.edc.client.gen.model.ContractDefinitionEntry;
+import de.sovity.edc.client.gen.model.ContractDefinitionRequest;
+import de.sovity.edc.client.gen.model.UiCriterionDto;
+import de.sovity.edc.client.gen.model.UiCriterionLiteralDto;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.utils.CriterionMapper;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.utils.OperatorMapper;
+import org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition;
+import org.eclipse.edc.connector.spi.contractdefinition.ContractDefinitionService;
+import org.eclipse.edc.junit.annotations.ApiTest;
+import org.eclipse.edc.junit.extensions.EdcExtension;
+import org.eclipse.edc.spi.query.Criterion;
+import org.eclipse.edc.spi.query.QuerySpec;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ApiTest
+@ExtendWith(EdcExtension.class)
+class ContractDefinitionPageApiServiceTest {
+    OperatorMapper operatorMapper;
+    CriterionMapper criterionMapper;
+
+    @BeforeEach
+    void setUp(EdcExtension extension) {
+        TestUtils.setupExtension(extension);
+        operatorMapper = new OperatorMapper();
+        criterionMapper = new CriterionMapper(operatorMapper);
+    }
+
+    @Test
+    void contractDefinitionPage(ContractDefinitionService contractDefinitionService) {
+        // arrange
+        var client = TestUtils.edcClient();
+        var criterion = new Criterion("exampleLeft1", "EQ", "abc");
+        createContractDefinition(contractDefinitionService, "contractPolicy-id-1", "accessPolicy-id-1", criterion);
+
+        // act
+        var result = client.uiApi().contractDefinitionPage();
+
+        // assert
+        var contractDefinitions = result.getContractDefinitions();
+        assertThat(contractDefinitions).hasSize(1);
+        var contractDefinition = contractDefinitions.get(0);
+        assertThat(contractDefinition.getContractPolicyId()).isEqualTo("contractPolicy-id-1");
+        assertThat(contractDefinition.getAccessPolicyId()).isEqualTo("accessPolicy-id-1");
+        assertThat(contractDefinition.getAssetSelector()).hasSize(1);
+
+        var criterionEntry = contractDefinition.getAssetSelector().get(0);
+        assertThat(criterionEntry.getOperandLeft()).isEqualTo("exampleLeft1");
+        assertThat(criterionEntry.getOperator()).isEqualTo(UiCriterionDto.OperatorEnum.EQ);
+        assertThat(criterionEntry.getOperandRight().getType()).isEqualTo(UiCriterionLiteralDto.TypeEnum.VALUE);
+        assertThat(criterionEntry.getOperandRight().getValue()).isEqualTo("abc");
+    }
+
+    @Test
+    void contractDefinitionPageSorting(ContractDefinitionService contractDefinitionService) {
+        // arrange
+        var client = TestUtils.edcClient();
+        createContractDefinition(
+                contractDefinitionService,
+                "contractPolicy-id-1",
+                "accessPolicy-id-1",
+                new Criterion("exampleLeft1", "EQ", "abc"),
+                1628956800000L);
+        createContractDefinition(
+                contractDefinitionService,
+                "contractPolicy-id-2",
+                "accessPolicy-id-2",
+                new Criterion("exampleLeft1", "EQ", "abc"),
+                1628956801000L);
+        createContractDefinition(
+                contractDefinitionService,
+                "contractPolicy-id-3",
+                "accessPolicy-id-3",
+                new Criterion("exampleLeft1", "EQ", "abc"),
+                1628956802000L);
+
+        // act
+        var result = client.uiApi().contractDefinitionPage();
+
+        // assert
+        assertThat(result.getContractDefinitions())
+                .extracting(ContractDefinitionEntry::getContractPolicyId)
+                .containsExactly("contractPolicy-id-3", "contractPolicy-id-2", "contractPolicy-id-1");
+
+    }
+
+    @Test
+    void testContractDefinitionCreation(ContractDefinitionService contractDefinitionService) {
+        // arrange
+        var client = TestUtils.edcClient();
+        var criterion = new UiCriterionDto(
+                "exampleLeft1",
+                UiCriterionDto.OperatorEnum.EQ,
+                new UiCriterionLiteralDto(UiCriterionLiteralDto.TypeEnum.VALUE, "test", null));
+
+        var contractDefinition = ContractDefinitionRequest.builder()
+                .contractPolicyId("contractPolicy-id-1")
+                .accessPolicyId("accessPolicy-id-1")
+                .assetSelector(List.of(criterion))
+                .build();
+
+        // act
+        var response = client.uiApi().createContractDefinition(contractDefinition);
+
+        // assert
+        assertThat(response).isNotNull();
+        var contractDefinitions = contractDefinitionService.query(QuerySpec.max()).getContent().toList();
+        assertThat(contractDefinitions).hasSize(1);
+        var contractDefinitionEntry = contractDefinitions.get(0);
+        assertThat(contractDefinitionEntry.getContractPolicyId()).isEqualTo("contractPolicy-id-1");
+        assertThat(contractDefinitionEntry.getAccessPolicyId()).isEqualTo("accessPolicy-id-1");
+
+        var criterionEntry = contractDefinition.getAssetSelector().get(0);
+        assertThat(criterionEntry.getOperandLeft()).isEqualTo("exampleLeft1");
+        assertThat(criterionEntry.getOperator()).isEqualTo(UiCriterionDto.OperatorEnum.EQ);
+        assertThat(criterionEntry.getOperandRight().getType()).isEqualTo(UiCriterionLiteralDto.TypeEnum.VALUE);
+        assertThat(criterionEntry.getOperandRight().getValue()).isEqualTo("test");
+    }
+
+    @Test
+    void testDeleteContractDefinition(ContractDefinitionService contractDefinitionService) {
+        // arrange
+        var client = TestUtils.edcClient();
+        var criterion = new Criterion("exampleLeft1", "EQ", "exampleRight1");
+        createContractDefinition(contractDefinitionService, "contractPolicy-id-1", "accessPolicy-id-1", criterion);
+        assertThat(contractDefinitionService.query(QuerySpec.max()).getContent().toList()).hasSize(1);
+        var contractDefinition = contractDefinitionService.query(QuerySpec.max()).getContent().toList().get(0);
+
+        // act
+        var response = client.uiApi().deleteContractDefinition(contractDefinition.getId());
+
+        // assert
+        assertThat(response.getId()).isEqualTo(contractDefinition.getId());
+        assertThat(contractDefinitionService.query(QuerySpec.max()).getContent()).isEmpty();
+    }
+
+    private void createContractDefinition(
+            ContractDefinitionService contractDefinitionService,
+            String contractPolicyId,
+            String accessPolicyId,
+            Criterion criteria,
+            long createdAt
+    ) {
+
+        var contractDefinition = ContractDefinition.Builder.newInstance()
+                .contractPolicyId(contractPolicyId)
+                .accessPolicyId(accessPolicyId)
+                .assetsSelector(List.of(criteria))
+                .createdAt(createdAt)
+                .build();
+        contractDefinitionService.create(contractDefinition);
+    }
+
+    private void createContractDefinition(
+            ContractDefinitionService contractDefinitionService,
+            String contractPolicyId,
+            String accessPolicyId,
+            Criterion criteria
+    ) {
+        var contractDefinition = ContractDefinition.Builder.newInstance()
+                .contractPolicyId(contractPolicyId)
+                .accessPolicyId(accessPolicyId)
+                .assetsSelector(List.of(criteria))
+                .build();
+        contractDefinitionService.create(contractDefinition);
+    }
+}

extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/WrapperExtension.java

@@ -20,6 +20,7 @@
 import org.eclipse.edc.connector.policy.spi.store.PolicyDefinitionStore;
 import org.eclipse.edc.connector.spi.asset.AssetService;
 import org.eclipse.edc.connector.spi.contractagreement.ContractAgreementService;
+import org.eclipse.edc.connector.spi.contractdefinition.ContractDefinitionService;
 import org.eclipse.edc.connector.spi.contractnegotiation.ContractNegotiationService;
 import org.eclipse.edc.connector.spi.transferprocess.TransferProcessService;
 import org.eclipse.edc.connector.transfer.spi.store.TransferProcessStore;
@@ -60,6 +61,8 @@ public class WrapperExtension implements ServiceExtension {
     private TypeManager typeManager;
     @Inject
     private WebService webService;
+    @Inject
+    private ContractDefinitionService contractDefinitionService;
 
     @Override
     public String name() {
@@ -82,7 +85,8 @@ public void initialize(ServiceExtensionContext context) {
                 policyDefinitionStore,
                 policyEngine,
                 transferProcessStore,
-                transferProcessService
+                transferProcessService,
+                contractDefinitionService
         );
 
         wrapperExtensionContext.jaxRsResources().forEach(resource ->

extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/WrapperExtensionContextBuilder.java

@@ -22,12 +22,16 @@
 import de.sovity.edc.ext.wrapper.api.ui.pages.asset.services.utils.AssetPropertyMapper;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.ContractAgreementPageApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.ContractAgreementTransferApiService;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.ContractDefinitionApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.ContractAgreementDataFetcher;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.ContractAgreementPageCardBuilder;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.ContractDefinitionBuilder;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.TransferProcessStateService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.TransferRequestBuilder;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.utils.ContractAgreementUtils;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.utils.ContractNegotiationUtils;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.utils.CriterionMapper;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.services.utils.OperatorMapper;
 import de.sovity.edc.ext.wrapper.api.ui.pages.transferhistory.TransferHistoryPageApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.transferhistory.TransferHistoryPageAssetFetcherService;
 import de.sovity.edc.ext.wrapper.api.usecase.UseCaseResource;
@@ -41,6 +45,7 @@
 import org.eclipse.edc.connector.policy.spi.store.PolicyDefinitionStore;
 import org.eclipse.edc.connector.spi.asset.AssetService;
 import org.eclipse.edc.connector.spi.contractagreement.ContractAgreementService;
+import org.eclipse.edc.connector.spi.contractdefinition.ContractDefinitionService;
 import org.eclipse.edc.connector.spi.contractnegotiation.ContractNegotiationService;
 import org.eclipse.edc.connector.spi.transferprocess.TransferProcessService;
 import org.eclipse.edc.connector.transfer.spi.store.TransferProcessStore;
@@ -75,7 +80,8 @@ public static WrapperExtensionContext buildContext(
             PolicyDefinitionStore policyDefinitionStore,
             PolicyEngine policyEngine,
             TransferProcessStore transferProcessStore,
-            TransferProcessService transferProcessService
+            TransferProcessService transferProcessService,
+            ContractDefinitionService contractDefinitionService
     ) {
         // UI API
         var transferProcessStateService = new TransferProcessStateService();
@@ -92,6 +98,10 @@ public static WrapperExtensionContext buildContext(
                 contractAgreementDataFetcher,
                 contractAgreementPageCardBuilder
         );
+        var operatorMapper = new OperatorMapper();
+        var criterionMapper = new CriterionMapper(operatorMapper);
+        var contactDefinitionBuilder = new ContractDefinitionBuilder(criterionMapper);
+        var contractDefinitionApiService = new ContractDefinitionApiService(contractDefinitionService, criterionMapper, contactDefinitionBuilder);
         var transferHistoryPageApiService = new TransferHistoryPageApiService(
                 assetService,
                 contractAgreementService,
@@ -121,7 +131,8 @@ public static WrapperExtensionContext buildContext(
                 contractAgreementTransferApiService,
                 transferHistoryPageApiService,
                 transferHistoryPageAssetFetcherService,
-                assetApiService
+                assetApiService,
+                contractDefinitionApiService
         );
 
         // Use Case API

extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/api/ui/UiResource.java

@@ -19,11 +19,14 @@
 import de.sovity.edc.ext.wrapper.api.ui.model.AssetCreateRequest;
 import de.sovity.edc.ext.wrapper.api.ui.model.ContractAgreementPage;
 import de.sovity.edc.ext.wrapper.api.ui.model.ContractAgreementTransferRequest;
+import de.sovity.edc.ext.wrapper.api.ui.model.ContractDefinitionRequest;
+import de.sovity.edc.ext.wrapper.api.ui.model.ContractDefinitionPage;
 import de.sovity.edc.ext.wrapper.api.ui.model.IdResponseDto;
 import de.sovity.edc.ext.wrapper.api.ui.model.TransferHistoryPage;
 import de.sovity.edc.ext.wrapper.api.ui.pages.asset.AssetApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.ContractAgreementPageApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.ContractAgreementTransferApiService;
+import de.sovity.edc.ext.wrapper.api.ui.pages.contracts.ContractDefinitionApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.transferhistory.TransferHistoryPageApiService;
 import de.sovity.edc.ext.wrapper.api.ui.pages.transferhistory.TransferHistoryPageAssetFetcherService;
 import io.swagger.v3.oas.annotations.Operation;
@@ -49,6 +52,7 @@ public class UiResource {
     private final TransferHistoryPageApiService transferHistoryPageApiService;
     private final TransferHistoryPageAssetFetcherService transferHistoryPageAssetFetcherService;
     private final AssetApiService assetApiService;
+    private final ContractDefinitionApiService contractDefinitionApiService;
 
     @GET
     @Path("pages/contract-agreement-page")
@@ -110,4 +114,28 @@ public IdResponseDto deleteAsset(@PathParam("assetId") String assetId) {
         return assetApiService.deleteAsset(assetId);
     }
 
+    @GET
+    @Path("pages/contract-definition-page")
+    @Produces(MediaType.APPLICATION_JSON)
+    @Operation(description = "Collect all data for Contract Definition Page")
+    public ContractDefinitionPage contractDefinitionPage() {
+        return new ContractDefinitionPage(contractDefinitionApiService.getContractDefinitions());
+    }
+
+    @POST
+    @Path("pages/contract-definition-page/contract-definitions")
+    @Produces(MediaType.APPLICATION_JSON)
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Operation(description = "Create a new Contract Definition")
+    public IdResponseDto createContractDefinition(ContractDefinitionRequest contractDefinitionRequest) {
+        return contractDefinitionApiService.createContractDefinition(contractDefinitionRequest);
+    }
+
+    @DELETE
+    @Path("pages/contract-definition-page/contract-definitions/{contractDefinitionId}")
+    @Produces(MediaType.APPLICATION_JSON)
+    @Operation(description = "Delete a Contract Definition")
+    public IdResponseDto deleteContractDefinition(@PathParam("contractDefinitionId") String contractDefinitionId) {
+        return contractDefinitionApiService.deleteContractDefinition(contractDefinitionId);
+    }
 }

extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/api/ui/model/ContractDefinitionEntry.java

@@ -0,0 +1,34 @@
+/*
+ *  Copyright (c) 2022 sovity GmbH
+ *
+ *  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:
+ *       sovity GmbH - initial API and implementation
+ *
+ */
+
+package de.sovity.edc.ext.wrapper.api.ui.model;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+@Schema(description = "Contract Definition List Entry for Contract Definition Page")
+public class ContractDefinitionEntry {
+
+    @Schema(description = "Access Policy ID", requiredMode = Schema.RequiredMode.REQUIRED)
+    private String accessPolicyId;
+
+    @Schema(description = "Contract Policy ID", requiredMode = Schema.RequiredMode.REQUIRED)
+    private String contractPolicyId;
+
+    @Schema(description = "Criteria for the contract", requiredMode = Schema.RequiredMode.REQUIRED)
+    private List<UiCriterionDto> assetSelector;
+}