EDC - Unit Tests and Coverage #75

.github/workflows/test.yml

@@ -8,9 +8,8 @@ on:
       - alpha
       - development
 
-
 jobs:
-  unit-tests:
+  app-unit-tests:
     runs-on: ubuntu-latest
 
     steps:
@@ -27,3 +26,34 @@ jobs:
         cd clearing-house-app
         cargo build --verbose
         cargo test --verbose
+
+  edc-unit-tests:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write    
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Setup JDK 17
+      uses: actions/setup-java@v2
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    - name: Run Unit Tests
+      run: |
+        cd clearing-house-edc
+        ./gradlew test jacocoTestReport
+
+    - name: Add Coverage Report
+      id: jacoco
+      uses: madrapps/jacoco-report@v1.6.1
+      with:
+        paths: |
+          ${{ github.workspace }}/clearing-house-edc/core/build/reports/jacoco/test/jacocoTestReport.xml,
+          ${{ github.workspace }}clearing-house-edc/extensions/multipart/build/reports/jacoco/test/jacocoTestReport.xml
+        token: ${{ secrets.GITHUB_TOKEN }}
+        min-coverage-overall: 70
+        min-coverage-changed-files: 80

clearing-house-edc/README.md

@@ -0,0 +1,44 @@
+## CLEARING HOUSE EDC
+This repository contains the Clearing House Extension that works with the Eclipse Dataspace Connector
+allowing logging operations.
+
+## Install
+### Configurations
+It is required to configure those parameters:
+
+| Parameter name                         | Description                                  | Default value          |
+|----------------------------------------|----------------------------------------------|------------------------|
+| `truzzt.clearinghouse.jwt.audience`    | Defines the intended recipients of the token | 1                      |
+| `truzzt.clearinghouse.jwt.issuer`      | Person or entity offering the token          | 1                      |
+| `truzzt.clearinghouse.jwt.sign.secret` | Secret key to encode the token               | 123                    |
+| `truzzt.clearinghouse.jwt.expires.at`  | Time to token Expiration (in Seconds)        | 30                     |
+| `truzzt.clearinghouse.app.base.url`    | Base URL from the clearing house app         | http://localhost:8000  |
+
+### Build
+To build the project run the command below:
+
+    ./gradlew build
+
+
+### Running
+Local execution:
+
+    java -Dedc.fs.config=launchers/connector-local/resources/config.properties -Dedc.keystore=launchers/connector-local/resources/keystore.jks -Dedc.keystore.password=password -Dedc.vault=launchers/connector-local/resources/vault.properties -jar launchers/connector-local/build/libs/clearing-house-edc.jar
+
+## Tests
+
+### Running Tests
+To run the unit-tests execute the following command:
+
+    ./gradlew test
+
+
+### Test Coverage
+To generate the tests coverage execute the following command:
+
+    ./gradlew jacocoTestReport
+
+The coverage reports will be available in the following folders:
+
+- [core/build/reports/jacoco/test/html/index.html](./core/build/reports/jacoco/test/html/index.html)
+- [extensions/multipart/build/reports/jacoco/test/html/index.html](./extensions/multipart/build/reports/jacoco/test/html/index.html)

clearing-house-edc/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2022 Microsoft Corporation
+ *  Copyright (c) 2023 Microsoft Corporation
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,12 +8,12 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       Microsoft Corporation - initial implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
 
 plugins {
-    `java-library`
+    `java-base`
 }
 
 val javaVersion: String by project
@@ -22,4 +22,4 @@ java {
    toolchain {
       languageVersion = JavaLanguageVersion.of(javaVersion)
    }
-}
+}

clearing-house-edc/core/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 Microsoft Corporation
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,22 +8,50 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
 
 plugins {
     `java-library`
+    `java-test-fixtures`
+    jacoco
 }
 
 val auth0JWTVersion: String by project
 
+configurations.all {
+    exclude(group = "de.fraunhofer.iais.eis.ids.infomodel", module = "java")
+}
+
 dependencies {
     api(edc.spi.core)
 
     implementation(edc.ids)
     implementation(edc.ids.jsonld.serdes)
     implementation(edc.api.management.config)
-
+    implementation(libs.jersey.multipart)
     implementation("com.auth0:java-jwt:${auth0JWTVersion}")
+
+    implementation(":infomodel-java-4.1.3")
+    implementation(":infomodel-util-4.0.4")
+
+    testImplementation(libs.junit.jupiter.api)
+    testImplementation(libs.mockito.inline)
+    testImplementation(libs.mockito.inline)
+
+    testFixturesImplementation(edc.ids)
+    testFixturesImplementation("com.auth0:java-jwt:${auth0JWTVersion}")
+
+    testRuntimeOnly(libs.junit.jupiter.engine)
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+tasks.jacocoTestReport {
+    reports {
+        xml.required = true
+    }
+    dependsOn(tasks.test)
 }

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/app/AppSender.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2022 sovity GmbH
+ *  Copyright (c) 2023 truzzt GmbH
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,7 +8,7 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       sovity GmbH - initial API and implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
 package de.truzzt.clearinghouse.edc.app;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/app/delegate/AppSenderDelegate.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2022 sovity GmbH
+ *  Copyright (c) 2023 truzzt GmbH
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,7 +8,7 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       sovity GmbH - initial API and implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
 package de.truzzt.clearinghouse.edc.app.delegate;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/app/delegate/LoggingMessageDelegate.java

@@ -1,3 +1,16 @@
+/*
+ *  Copyright (c) 2023 truzzt 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:
+ *       truzzt GmbH - Initial implementation
+ *
+ */
 package de.truzzt.clearinghouse.edc.app.delegate;
 
 import de.truzzt.clearinghouse.edc.dto.HandlerRequest;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/dto/AppSenderRequest.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 truzzt GmbH
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,10 +8,9 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
-
 package de.truzzt.clearinghouse.edc.dto;
 
 import org.jetbrains.annotations.NotNull;
@@ -24,7 +23,7 @@ public class AppSenderRequest<B> {
     private final String token;
     private final B body;
 
-    private AppSenderRequest(@NotNull  String url, @NotNull String token, @NotNull B body) {
+    public AppSenderRequest(@NotNull  String url, @NotNull String token, @NotNull B body) {
         this.url = url;
         this.token = token;
         this.body = body;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/dto/HandlerRequest.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 Microsoft Corporation
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -9,9 +9,9 @@
  *
  *  Contributors:
  *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - EDC extension implementation
  *
  */
-
 package de.truzzt.clearinghouse.edc.dto;
 
 import de.truzzt.clearinghouse.edc.types.ids.Message;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/dto/HandlerResponse.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 Microsoft Corporation
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -9,9 +9,9 @@
  *
  *  Contributors:
  *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - EDC extension implementation
  *
  */
-
 package de.truzzt.clearinghouse.edc.dto;
 
 import de.truzzt.clearinghouse.edc.types.ids.Message;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/dto/LoggingMessageRequest.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 truzzt GmbH
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,10 +8,9 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
-
 package de.truzzt.clearinghouse.edc.dto;
 
 import com.fasterxml.jackson.annotation.JsonProperty;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/dto/LoggingMessageResponse.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 truzzt GmbH
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,10 +8,9 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - Initial implementation
  *
  */
-
 package de.truzzt.clearinghouse.edc.dto;
 
 import com.fasterxml.jackson.annotation.JsonProperty;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/handler/Handler.java

@@ -1,3 +1,17 @@
+/*
+ *  Copyright (c) 2023 Microsoft Corporation
+ *
+ *  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:
+ *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - EDC extension implementation
+ *
+ */
 package de.truzzt.clearinghouse.edc.handler;
 
 import com.auth0.jwt.JWT;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/handler/LogMessageHandler.java

@@ -1,3 +1,16 @@
+/*
+ *  Copyright (c) 2023 truzzt 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:
+ *       truzzt GmbH - Initial implementation
+ *
+ */
 package de.truzzt.clearinghouse.edc.handler;
 
 import de.truzzt.clearinghouse.edc.app.AppSender;

clearing-house-edc/core/src/main/java/de/truzzt/clearinghouse/edc/types/TypeManagerUtil.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2021 Microsoft Corporation
+ *  Copyright (c) 2023 Microsoft Corporation
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -8,10 +8,10 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *       truzzt GmbH - Initial implementation
+ *       Microsoft Corporation - Initial implementation
+ *       truzzt GmbH - EDC extension implementation
  *
  */
-
 package de.truzzt.clearinghouse.edc.types;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -37,9 +37,9 @@ public <T> T parse(InputStream inputStream, Class<T> type) {
         }
     }
 
-    public byte[] toJson(Object object) {
+    public String toJson(Object object) {
         try {
-            return mapper.writeValueAsBytes(object);
+            return mapper.writeValueAsString(object);
         } catch (JsonProcessingException e) {
             throw new EdcException("Error converting to JSON", e);
         }