New Aspect Model Support ( SerialPart and SingleLevelBomAsBuilt )

.github/workflows/helm-test-backwards-compatability.yaml

@@ -0,0 +1,52 @@
+#    Copyright (c) 2023 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 governing permissions and limitations
+#    under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
+name: Test k8s version compatability
+
+on:
+  workflow_dispatch:
+    inputs:
+      node_image_latest:
+        description: 'First version of kindest/node image for k8s kind cluster'
+        default: 'kindest/node:v1.27.3'
+        required: false
+        type: string
+      node_image_second_latest:
+        description: 'Second version of kindest/node image for k8s kind cluster'
+        default: 'kindest/node:v1.26.6'
+        required: false
+        type: string
+      node_image_third_latest:
+        description: 'Third version of kindest/node image for k8s kind cluster'
+        default: 'kindest/node:v1.25.11'
+        required: false
+        type: string
+
+jobs:
+  test-latest:
+    uses: ./.github/workflows/helm-test.yaml
+    with:
+      node_image: ${{ github.event.inputs.node_image_latest || 'kindest/node:v1.27.3' }}
+
+  test-second-latest:
+    uses: ./.github/workflows/helm-test.yaml
+    with:
+      node_image: ${{ github.event.inputs.node_image_second_latest || 'kindest/node:v1.26.6' }}
+
+  test-third-latest:
+    uses: ./.github/workflows/helm-test.yaml
+    with:
+      node_image: ${{ github.event.inputs.node_image_third_latest || 'kindest/node:v1.25.11' }}

.github/workflows/helm-test.yaml

@@ -21,6 +21,13 @@ on:
     paths:
       - 'charts/**'
   workflow_dispatch:
+  workflow_call: # Trigger by another workflow
+    inputs:
+      node_image:
+        description: 'kindest/node image for k8s kind cluster'
+        default: 'kindest/node:v1.27.3'
+        required: false
+        type: string
 
 env:
   REGISTRY: kind-registry:5000

.github/workflows/helm-upgrade.yaml

@@ -1,3 +1,19 @@
+#    Copyright (c) 2023 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 governing permissions and limitations
+#    under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
 name: Upgrade Charts
 
 on:
@@ -30,14 +46,15 @@ jobs:
           helm repo add postgresql https://charts.bitnami.com/bitnami
           helm repo add tractusx-connector https://eclipse-tractusx.github.io/charts/dev
           helm repo add runix https://helm.runix.net
+          helm repo add tracex https://eclipse-tractusx.github.io/traceability-foss
 
       - name: Run helm install
         # Install latest released traceability-foss version
         run: |
-          helm install traceability-foss traceability-foss
+          helm install tracex tracex/traceability-foss
 
       - name: Run helm upgrade
         # Upgrade the installed traceability-foss version with the locally available charts
         run: |
-          helm dependency update traceability-foss charts/traceability-foss
-          helm upgrade traceability-foss charts/traceability-foss
+          helm dependency update charts/traceability-foss
+          helm upgrade tracex charts/traceability-foss

CHANGELOG.md

@@ -7,17 +7,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [Unreleased]
 
 ### Added
+
 - Added back button in notification detailed view
 - Added alert detail view
 - EDC SPI Dependency for using provided models
 - Added default response types to apis
 - Irs policies support ( on application startup registers policies in irs instance )
+- Added helm upgrade workflow to test upgradeability of the helm charts
+- Added helm test backwards compatability to test the helm charts with the latest kubernetes versions
 
 ### Changed
 - Changed Layout in notification detailed view
 - Changed request parameter for registerjob request to irs to match requirements of irs
 - Migration of edc 0.4.1 endpoints and api flow
 - fixed bug where language switcher did not update to the selected language
+- Changed SerialPartTypization aspect model to SerialPart
+- Changed AssemblyPartRelationship aspect model to SingleLevelBomAsBuilt
 
 ### Removed
 

charts/traceability-foss/Chart.yaml

@@ -39,7 +39,7 @@ dependencies:
     condition: pgadmin4.enabled
   - name: irs-helm
     repository: https://eclipse-tractusx.github.io/item-relationship-service
-    version: 6.0.1
+    version: 6.1.0
     condition: irs-helm.enabled
   - condition: tractusx-connector.enabled
     name: tractusx-connector

dev/README.md

@@ -30,25 +30,25 @@ In order to upload data to EDC Provider, please use [IRS project script](https:/
 Sample invocation (DEV)
 
 ```
-python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server.dev.demo.catena-x.net -edc https://trace-x-edc.dev.demo.catena-x.net -a https://trace-x-registry.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
+python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server.dev.demo.catena-x.net -edc https://trace-x-edc.dev.demo.catena-x.net -a https://trace-x-registry.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
 ```
 
 Sample invocation (TEST)
 
 ```
-python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server-test.dev.demo.catena-x.net -edc https://trace-x-test-edc.dev.demo.catena-x.net -a https://trace-x-registry-test.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
+python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server-test.dev.demo.catena-x.net -edc https://trace-x-test-edc.dev.demo.catena-x.net -a https://trace-x-registry-test.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
 ```
 
 Sample invocation (E2E A)
 
 ```
-python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server-e2e-a.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-a.dev.demo.catena-x.net -a https://trace-x-registry-e2e-a.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
+python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server-e2e-a.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-a.dev.demo.catena-x.net -a https://trace-x-registry-e2e-a.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
 ```
 
 Sample invocation (E2E B)
 
 ```
-python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.3.json -s https://tracex-submodel-server-e2e-b.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-b.dev.demo.catena-x.net -a https://trace-x-registry-e2e-b.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
+python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.4.json -s https://tracex-submodel-server-e2e-b.dev.demo.catena-x.net -edc https://trace-x-edc-e2e-b.dev.demo.catena-x.net -a https://trace-x-registry-e2e-b.dev.demo.catena-x.net/semantics/registry -p id-3.0-trace -k <apiKey>
 ```
 
 where:
@@ -162,7 +162,7 @@ Consists of a List of the following structured entries:
         "childCatenaXId" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd"
       } ]
     } ],
-    "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" : [ {
+    "urn:bamm:io.catenax.serial_part:1.0.0#SerialPart" : [ {
       "localIdentifiers" : [ {
         "value" : "BPNL00000003CML1",
         "key" : "manufacturerId"
@@ -212,10 +212,10 @@ Is achieved by defining the order of the BPNLs of the desired manufacturers. See
   ]
 ```
 ...AZQP -> ...3ML1 -> ...CNKC
-and adding an AssemlyPartRelationship Aspect with the corresponding childCatenaXId:
+and adding an SingleLevelBomAsBuilt Aspect with the corresponding childCatenaXId:
 ```json
 {
-"urn:bamm:io.catenax.assembly_part_relationship:1.1.0#AssemblyPartRelationship" : [ {
+"urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt" : [ {
 "catenaXId" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd",
 "childParts" : [ {
 "quantity" : {
@@ -243,12 +243,12 @@ Is achieved through adding the SingleLevelusageBuilt - Codeblock and the corresp
 [{
   "catenaXId" : "urn:uuid:f11ddc62-3bd5-468f-b7b0-110fe13ed0cd",
   "bpnl" : "BPNL00000003CNKC",
-  "urn:bamm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship": "[...]",
-  "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" : "[...]"
+  "urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt": "[...]",
+  "urn:bamm:io.catenax.serial_part:1.0.0#SerialPart" : "[...]"
   }, {
   "catenaXId" : "urn:uuid:4e390dab-707f-446e-bfbe-653f6f5b1f37",
   "bpnl" : "BPNL00000003AZQP",
-  "urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization" : "",
+  "urn:bamm:io.catenax.serial_part:1.0.0#SerialPart" : "",
   "urn:bamm:io.catenax.single_level_usage_as_built:1.0.1#SingleLevelUsageAsBuilt": [
     {
       "parentParts": [

docs/src/docs/arc42/introduction-goals/requirements.adoc

@@ -10,7 +10,7 @@
 == Essential features
 * List and view manufactured parts based on BoM AsBuild
 * Show detailed information on manufactured parts from AAS description assets and Aspects
-* Uses Submodels SerialPartTypization, AssemblyPartRelationship and Batch
+* Uses Submodels SerialPart, AssemblyPartRelationship and Batch
 * List and view Supplier parts (AssemblyPartRelationship) based on BoM AsBuild lifecycle
 * View parts and parts relations in a visualized parts tree
 * Send and receive top-down notifications (quality investigations) along the supply chain

docs/src/docs/user/user-manual.adoc

@@ -43,7 +43,7 @@ Supported languages:
 
 == Parts
 List view of the own manufactured parts and batches.
-Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the company. This includes data based on the aspect models of Use Case Traceability: SerialPartTypization, AssemblyPartRelationship, Batch.
+Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the company. This includes data based on the aspect models of Use Case Traceability: SerialPart, AssemblyPartRelationship, Batch.
 
 image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/parts-list-detailed-view.PNG[]
 
@@ -72,7 +72,7 @@ Once the quality investigation is created you will get a pop-up and can directly
 
 == Other parts
 List view of the supplied with parts and batches (Supplier parts).
-Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the supplier companies. This includes data that is ingested based on the aspect model AssemblyPartRelationship of the child parts for Use Case Traceability aspect models: SerialPartTypization, Batch.
+Gives detailed information on the assets registered in the Digital Twin Registry of Catena-X for the supplier companies. This includes data that is ingested based on the aspect model AssemblyPartRelationship of the child parts for Use Case Traceability aspect models: SerialPart, Batch.
 
 image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/supplier-parts-list-detailed-view.PNG[]
 

docs/src/uml-diagrams/concept/TRACEFOSS-1423/domain-model.puml

@@ -42,12 +42,12 @@ entity AsBuiltAsset {
 }
 
 note right
-    SerialPartTypization and Batch
+    SerialPart and Batch
 end note
 
 enum SemanticDataModel {
     BATCH,
-    SERIALPARTTYPIZATION
+    SERIALPART
 }
 
 entity AsPlannedAsset {

frontend/src/app/mocks/services/otherParts-mock/otherParts.model.ts

@@ -67,7 +67,7 @@ export const otherPartsAssets = [
     underInvestigation: true,
     qualityType: 'Ok',
     van: 'myvan2',
-    semanticDataModel: 'SERIALPARTTYPIZATION'
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:fccbc75e-6ccd-46e2-ba93-4a3125dfb5a5',
@@ -90,7 +90,7 @@ export const otherPartsAssets = [
     underInvestigation: false,
     qualityType: 'Ok',
     van: 'myvan3',
-    semanticDataModel: 'SERIALPARTTYPIZATION'
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:dad03189-4ce7-47a4-bfc5-e7b77dc6cf68',
@@ -148,7 +148,7 @@ export const otherPartsAssets = [
     underInvestigation: false,
     qualityType: 'Ok',
     van: 'myvan5',
-    semanticDataModel: 'SERIALPARTTYPIZATION'
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:d411568e-d950-44ff-87c2-492ac6beabe9',
@@ -171,7 +171,7 @@ export const otherPartsAssets = [
     underInvestigation: false,
     qualityType: 'Ok',
     van: 'myvanX',
-    semanticDataModel: 'SERIALPARTTYPIZATION'
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:c8504172-21a7-4b02-9cc7-cfaa0fc29bd8',
@@ -252,7 +252,7 @@ export const otherPartsAssets = [
     underInvestigation: false,
     qualityType: 'Ok',
     van: 'myvanX',
-    semanticDataModel: 'SERIALPARTTYPIZATION'
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:6599279a-3fe4-479f-bc11-fcd97bb42607',
@@ -287,7 +287,7 @@ export const otherPartsAssets = [
     underInvestigation: false,
     qualityType: 'Ok',
     van: 'myvanX',
-    semanticDataModel: 'SERIALPARTTYPIZATION'
+    semanticDataModel: 'SERIALPART',
   },
   /* Commented out for now because of amount of effort to change to new structure
   {
@@ -306,7 +306,7 @@ export const otherPartsAssets = [
     specificAssetIds: {},
     childDescriptions: [],
     qualityType: 'Ok',
-    semanticDataModel: 'SERIALPARTTYPIZATION',
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:b8f04288-6685-47cd-b38d-67c88ba1b02d',
@@ -336,7 +336,7 @@ export const otherPartsAssets = [
       { id: 'urn:uuid:24468d86-6718-479a-adc6-f9b65f6ada56', idShort: '--' },
     ],
     qualityType: 'Ok',
-    semanticDataModel: 'SERIALPARTTYPIZATION',
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:09c704a5-c1a7-4b73-9038-e4af72e44dd6',
@@ -372,7 +372,7 @@ export const otherPartsAssets = [
     specificAssetIds: {},
     childDescriptions: [],
     qualityType: 'Ok',
-    semanticDataModel: 'SERIALPARTTYPIZATION',
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:8869d78f-b127-406c-b261-1060e30560f2',
@@ -408,7 +408,7 @@ export const otherPartsAssets = [
     specificAssetIds: {},
     childDescriptions: [],
     qualityType: 'Ok',
-    semanticDataModel: 'SERIALPARTTYPIZATION',
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:0f6b767a-7f8f-4edd-902c-ee563255a5f8',
@@ -438,7 +438,7 @@ export const otherPartsAssets = [
       { id: 'urn:uuid:440e2c89-6db5-4044-9aa3-c020b276ade9', idShort: '--' },
     ],
     qualityType: 'Ok',
-    semanticDataModel: 'SERIALPARTTYPIZATION',
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:06ce2095-d52d-4ab9-a31f-fa6a6b07f685',
@@ -460,7 +460,7 @@ export const otherPartsAssets = [
       { id: 'urn:uuid:5f5bba9c-e24b-4c83-86a0-ec7484f57b7b', idShort: '--' },
     ],
     qualityType: 'Ok',
-    semanticDataModel: 'SERIALPARTTYPIZATION',
+    semanticDataModel: 'SERIALPART',
   },
   {
     id: 'urn:uuid:e35abf46-5a66-47b6-b74b-1753287d576d',