Merge pull request #328 from eclipse-tractusx/feature/irs

Feature/irs: Make IRS compatible to the dpp-backend

charts/digital-product-pass/templates/deployment-backend.yaml

@@ -84,6 +84,11 @@ spec:
                 secretKeyRef:
                   key: xApiKey
                   name: {{ .Release.Name }}-backend-auth
+            - name: "irs.apiKey"
+              valueFrom:
+                secretKeyRef:
+                  key: irsApiKey
+                  name: {{ .Release.Name }}-backend-auth
           volumeMounts:
             {{- toYaml .Values.backend.volumeMounts | nindent 12 }}
           ports:

charts/digital-product-pass/templates/secret-backend.yaml

@@ -35,7 +35,7 @@ stringData:
   clientId: {{ .Values.oauth.techUser.clientId }}
   clientSecret: {{ .Values.oauth.techUser.clientSecret }}
   xApiKey: {{ .Values.oauth.apiKey.secret }}
-
+  irsApiKey: {{ .Values.backend.irs.apiKey }}
 ---
 
 apiVersion: v1

charts/digital-product-pass/values-int.yaml

@@ -57,6 +57,7 @@ backend:
   irs:
     enabled: true
     hostname: "materialpass-irs.int.demo.catena-x.net"
+    apiKey: "<path:material-pass/data/int/irs/apiKey#apiKeyRegular>"
 
   process:
     encryptionKey: "<path:material-pass/data/int/backend/#signKey>"

charts/digital-product-pass/values.yaml

@@ -172,6 +172,7 @@ backend:
   irs:
     enabled: false
     hostname: ""
+    apiKey: "<Add API Key>"
 
   # -- digital twin registry configuration
   process:

dpp-backend/digitalproductpass/src/main/java/org/eclipse/tractusx/digitalproductpass/managers/TreeManager.java

@@ -31,6 +31,7 @@
 import org.eclipse.tractusx.digitalproductpass.config.PassportConfig;
 import org.eclipse.tractusx.digitalproductpass.exceptions.ManagerException;
 import org.eclipse.tractusx.digitalproductpass.models.dtregistry.DigitalTwin;
+import org.eclipse.tractusx.digitalproductpass.models.irs.IrsShell;
 import org.eclipse.tractusx.digitalproductpass.models.irs.JobHistory;
 import org.eclipse.tractusx.digitalproductpass.models.irs.JobResponse;
 import org.eclipse.tractusx.digitalproductpass.models.irs.Relationship;
@@ -236,9 +237,9 @@ public List<NodeComponent> getTreeComponents(String processId){
      * @return  a {@code DigitalTwin} from the search result OR {@code null} if not found
      *
      */
-    public DigitalTwin searchDigitalTwin(List<DigitalTwin> digitalTwinList, String digitalTwinId){
+    public IrsShell searchDigitalTwin(List<IrsShell> digitalTwinList, String digitalTwinId){
         // Use a parallel search to make the search faster
-        return digitalTwinList.parallelStream().filter(digitalTwin -> digitalTwin.getGlobalAssetId().equals(digitalTwinId)).findFirst().orElse(new DigitalTwin());
+        return digitalTwinList.parallelStream().filter(digitalTwin -> digitalTwin.getPayload().getGlobalAssetId().equals(digitalTwinId)).findFirst().orElse(new IrsShell());
     }
     /**
      * Populates a tree with the Job content and the relationships from an specific data model
@@ -264,9 +265,9 @@ public String populateTree(Map<String, Node> treeDataModel, String processId, Jo
             String parentPath = jobHistory.getPath();
             Node parent = this.getNodeByPath(treeDataModel, parentPath);
             // All the relationships will be of depth one, so we just need to add them in the parent
-            List<DigitalTwin> digitalTwinList = null;
+            List<IrsShell> digitalTwinList = null;
             try {
-                digitalTwinList = (List<DigitalTwin>) jsonUtil.bindReferenceType(job.getShells(), new TypeReference<List<DigitalTwin>>() {});
+                digitalTwinList = (List<IrsShell>) jsonUtil.bindReferenceType(job.getShells(), new TypeReference<List<IrsShell>>() {});
             } catch (Exception e) {
                 throw new ManagerException(this.getClass().getName(), e, "Could not bind the reference type for the Digital Twin!");
             }
@@ -280,7 +281,9 @@ public String populateTree(Map<String, Node> treeDataModel, String processId, Jo
             for(Relationship relationship : relationships){
                 String childId = relationship.getLinkedItem().getChildCatenaXId();
                 // Search for the Digital Twin from the child or a new instance
-                DigitalTwin childDigitalTwin = this.searchDigitalTwin(digitalTwinList, childId);
+                IrsShell shell = this.searchDigitalTwin(digitalTwinList, childId);
+                DigitalTwin childDigitalTwin = shell.getPayload();
+//                DigitalTwin childDigitalTwin = jsonUtil.bindReferenceType(this.searchDigitalTwin(digitalTwinList, childId).getPayload(),new DigitalTwin());
                 if(childDigitalTwin.getGlobalAssetId().isEmpty()){
                     childDigitalTwin.setGlobalAssetId(childId);
                 }
@@ -495,9 +498,4 @@ public String setChild(String processId, String parentPath, Node childNode, Stri
             throw new ManagerException(this.getClass().getName()+".setChild()", e, "It was not possible to get the node from the tree");
         }
     }
-
-
-
-
-
 }

dpp-backend/digitalproductpass/src/main/java/org/eclipse/tractusx/digitalproductpass/models/irs/IrsShell.java

@@ -0,0 +1,82 @@
+/*********************************************************************************
+ *
+ * Tractus-X - Digital Product Passport Application
+ *
+ * Copyright (c) 2022, 2024 BMW AG, Henkel AG & Co. KGaA
+ * Copyright (c) 2023, 2024 CGI Deutschland B.V. & Co. KG
+ * Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation
+ *
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * 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.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the
+ * License for the specific language govern in permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ********************************************************************************/
+
+package org.eclipse.tractusx.digitalproductpass.models.irs;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.JsonNode;
+import org.eclipse.tractusx.digitalproductpass.models.dtregistry.DigitalTwin;
+
+import java.util.ArrayList;
+
+/**
+ * This class consists exclusively to define attributes related to the Job Response coming from the IRS.
+ **/
+@JsonIgnoreProperties(ignoreUnknown = true)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class IrsShell {
+
+    /**
+     * ATTRIBUTES
+     **/
+    @JsonProperty("contractAgreementId")
+    public String contractAgreementId;
+    @JsonProperty("payload")
+    public DigitalTwin payload;
+
+
+    /**
+     * CONSTRUCTORS
+     **/
+    public IrsShell() {
+    }
+
+    public IrsShell(String contractAgreementId, DigitalTwin payload) {
+        this.contractAgreementId = contractAgreementId;
+        this.payload = payload;
+    }
+
+    /**
+     * GETTERS AND SETTERS
+     **/
+    public String getContractAgreementId() {
+        return contractAgreementId;
+    }
+
+    public void setContractAgreementId(String contractAgreementId) {
+        this.contractAgreementId = contractAgreementId;
+    }
+
+    public DigitalTwin getPayload() {
+        return payload;
+    }
+
+    public void setPayload(DigitalTwin payload) {
+        this.payload = payload;
+    }
+}

dpp-backend/digitalproductpass/src/main/java/org/eclipse/tractusx/digitalproductpass/models/irs/JobResponse.java

@@ -30,7 +30,6 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
-import org.eclipse.tractusx.digitalproductpass.models.dtregistry.DigitalTwin;
 
 import java.util.ArrayList;
 
@@ -47,7 +46,7 @@ public class JobResponse {
     @JsonProperty("relationships")
     public ArrayList<Relationship> relationships;
     @JsonProperty("shells")
-    public ArrayList<DigitalTwin> shells;
+    public ArrayList<IrsShell> shells;
     @JsonProperty("tombstones")
     public Object tombstones;
     @JsonProperty("submodels")
@@ -56,7 +55,7 @@ public class JobResponse {
     public ArrayList<String> bpns;
 
     /** CONSTRUCTOR(S) **/
-    public JobResponse(Job job, ArrayList<Relationship> relationships, ArrayList<DigitalTwin> shells, Object tombstones, ArrayList<JsonNode> submodels, ArrayList<String> bpns) {
+    public JobResponse(Job job, ArrayList<Relationship> relationships, ArrayList<IrsShell> shells, Object tombstones, ArrayList<JsonNode> submodels, ArrayList<String> bpns) {
         this.job = job;
         this.relationships = relationships;
         this.shells = shells;
@@ -85,11 +84,11 @@ public void setRelationships(ArrayList<Relationship> relationships) {
         this.relationships = relationships;
     }
 
-    public ArrayList<DigitalTwin> getShells() {
+    public ArrayList<IrsShell> getShells() {
         return shells;
     }
 
-    public void setShells(ArrayList<DigitalTwin> shells) {
+    public void setShells(ArrayList<IrsShell> shells) {
         this.shells = shells;
     }
 

dpp-backend/digitalproductpass/src/main/java/org/eclipse/tractusx/digitalproductpass/services/IrsService.java

@@ -65,6 +65,7 @@ public class IrsService extends BaseService {
     String irsEndpoint;
     String irsJobPath;
     String callbackUrl;
+    String apiKey;
     AuthenticationService authService;
     IrsConfig irsConfig;
     ProcessManager processManager;
@@ -96,6 +97,7 @@ public void init(Environment env) {
         this.irsEndpoint = this.irsConfig.getEndpoint();
         this.irsJobPath = this.irsConfig.getPaths().getJob();
         this.callbackUrl = this.irsConfig.getCallbackUrl();
+        this.apiKey = (String) this.vaultService.getLocalSecret("irs.apiKey");
     }
     /**
      * Creates a List of missing variables needed to proceed with the request.
@@ -116,6 +118,9 @@ public List<String> getEmptyVariables() {
         if (this.callbackUrl.isEmpty()) {
             missingVariables.add("irs.callbackUrl");
         }
+        if (this.apiKey.isEmpty()) {
+            missingVariables.add("irs.apiKey");
+        }
         return missingVariables;
     }
     /**
@@ -163,7 +168,7 @@ public Map<String, String> startJob(String processId, String globalAssetId, Stri
     public Map<String, String> startJob(String processId, String globalAssetId,  String searchId, String bpn) {
         try {
             this.checkEmptyVariables();
-            String url = this.irsEndpoint + "/" + this.irsJobPath;
+            String url = this.irsEndpoint + this.irsJobPath;
             // Build the Job request for the IRS
 
             String backendUrl = this.callbackUrl +  "/" + processId + "/" + searchId; // Add process id and search id
@@ -183,7 +188,7 @@ public Map<String, String> startJob(String processId, String globalAssetId,  Str
                     callbackUrl
             );
             body.setKey(globalAssetId, bpn);
-            HttpHeaders headers = httpUtil.getHeadersWithToken(this.authService.getToken().getAccessToken());
+            HttpHeaders headers = httpUtil.getHeadersWithApiKey(this.apiKey);
             headers.add("Content-Type", "application/json");
 
             ResponseEntity<?> response = httpUtil.doPost(url, JsonNode.class, headers, httpUtil.getParams(), body, false, false);
@@ -283,7 +288,7 @@ public JobResponse getJob(String jobId) {
         try {
             String url = this.irsEndpoint + "/" + this.irsJobPath + "/" + jobId;
             Map<String, Object> params = httpUtil.getParams();
-            HttpHeaders headers = httpUtil.getHeadersWithToken(this.authService.getToken().getAccessToken());
+            HttpHeaders headers = httpUtil.getHeadersWithApiKey(this.apiKey);
             ResponseEntity<?> response = httpUtil.doGet(url, String.class, headers, params, true, false);
             String responseBody = (String) response.getBody();
             return (JobResponse) jsonUtil.bindJsonNode(jsonUtil.toJsonNode(responseBody), JobResponse.class);

dpp-backend/digitalproductpass/src/main/java/utils/HttpUtil.java

@@ -1060,6 +1060,11 @@ public  HttpHeaders getHeadersWithToken(String accessToken) {
         headers.add("Authorization", "Bearer " + accessToken);
         return headers;
     }
+    public  HttpHeaders getHeadersWithApiKey(String apiKey) {
+        HttpHeaders headers =  new HttpHeaders();
+        headers.add("X-Api-Key", apiKey);
+        return headers;
+    }
     public  Map<String, Object> getParams() {
         return new HashMap<String, Object>();
     }

dpp-backend/digitalproductpass/src/main/resources/application.yml

@@ -185,6 +185,7 @@ configuration:
       - "edc.apiKey"
       - "edc.participantId"
       - "oauth.apiKey"
+      - "irs.apiKey"
 
 server:
   error:

dpp-backend/digitalproductpass/src/test/java/services/IrsServiceTest.java

@@ -112,7 +112,7 @@ void setUpAll() throws ServiceInitializationException {
         when(vaultService.getLocalSecret("client.id")).thenReturn(mockClientId);
         when(vaultService.getLocalSecret("client.secret")).thenReturn(mockClientTestReturn);
 
-        when(vaultService.getLocalSecret("edc.apiKey")).thenReturn(mockApiKey);
+        when(vaultService.getLocalSecret("irs.apiKey")).thenReturn(mockApiKey);
         when(vaultService.getLocalSecret("edc.participantId")).thenReturn(mockBpn);
 
 

dpp-backend/digitalproductpass/src/test/resources/application-test.yml

@@ -184,6 +184,7 @@ configuration:
       - "edc.apiKey"
       - "edc.participantId"
       - "oauth.apiKey"
+      - "irs.apiKey"
 
 server:
   error: