Chore/merge main to cx envs

ci/checkstyle.xml → .config/checkstyle.xml

@@ -17,12 +17,12 @@ page at http://checkstyle.sourceforge.net/config.html -->
     </module>
 
     <module name="SuppressionFilter">
-        <property name="file" value="ci/checkstyle-suppressions.xml"/>
+        <property name="file" value=".config/checkstyle-suppressions.xml"/>
         <property name="optional" value="true"/>
     </module>
 
     <module name="Header">
-        <property name="headerFile" value="ci/irs.header"/>
+        <property name="headerFile" value=".config/irs.header"/>
         <property name="fileExtensions" value="java"/>
     </module>
 

ci/spectral/restBasicMetaInformation.yml → .config/spectral/restBasicMetaInformation.yml

@@ -6,18 +6,18 @@ rules:
 
   # MUST contain API meta information [218]
   # https://opensource.zalando.com/restful-api-guidelines/#218
-  must-use-x-summary:
-    message: "API MUST have an one-liner #/info/x-summary field"
-    description: "In OAS3.1 you can use the standard `#/info/summary` field."
-    given: $
-    severity: error
-    recommended: true
-    type: style
-    formats:
-      - oas3
-    then:
-      field: "info.x-summary"
-      function: truthy
+#  must-use-x-summary:
+#    message: "API MUST have an one-liner #/info/x-summary field"
+#    description: "In OAS3.1 you can use the standard `#/info/summary` field."
+#    given: $
+#    severity: error
+#    recommended: true
+#    type: style
+#    formats:
+#      - oas3
+#    then:
+#      field: "info.x-summary"
+#      function: truthy
 
   must-have-info-description:
     message: Missing `info.description`.
@@ -29,25 +29,25 @@ rules:
       field: description
       function: truthy
 
-  must-have-info-contact-name:
-    message: Missing `info.contact.name`.
-    description: MUST contain API meta information [218]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#218
-    severity: error
-    given: $.info
-    then:
-      field: contact.name
-      function: truthy
+#  must-have-info-contact-name:
+#    message: Missing `info.contact.name`.
+#    description: MUST contain API meta information [218]
+#    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#218
+#    severity: error
+#    given: $.info
+#    then:
+#      field: contact.name
+#      function: truthy
 
-  must-have-info-contact-url:
-    message: Missing `info.contact.url`.
-    description: MUST contain API meta information [218]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#218
-    severity: error
-    given: $.info
-    then:
-      field: contact.url
-      function: truthy
+#  must-have-info-contact-url:
+#    message: Missing `info.contact.url`.
+#    description: MUST contain API meta information [218]
+#    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#218
+#    severity: error
+#    given: $.info
+#    then:
+#      field: contact.url
+#      function: truthy
 
   info-contact: true
   info-description: true

ci/spectral/restBasicUrls.yml → .config/spectral/restBasicUrls.yml

@@ -103,19 +103,18 @@ rules:
         match: ^\/[^\/]*((\/{[^}]*})*\/[^\/]*(\/{[^}]*})*){0,3}\/?$
 
 
-  # MUST use snake_case (never camelCase) for query parameters [130]
-  # => https://opensource.zalando.com/restful-api-guidelines/#130
+  # MUST use camelCase for query parameters
   use-snake-case-for-query-parameters:
     description: |
-      MUST use snake_case (never camelCase) for query parameters
-    message: '{{property}} use snake_case for query parameters: {{error}}'
+      MUST use camelCase for query parameters
+    message: '{{property}} use camelCase for query parameters: {{error}}'
     severity: error
     recommended: true
     given: $.paths.*.*.parameters[?(@.in=='query')].name
     then:
       function: pattern
       functionOptions:
-        match: "^[a-z0-9]+(?:_[a-z0-9]+)*$"
+        match: "^[a-z]+([A-Z][a-z0-9]+)+"
 
   # MUST pluralize resource names [134]
   # => https://opensource.zalando.com/restful-api-guidelines/#134

ci/spectral/restBasicsHttpRequest.yml → .config/spectral/restBasicsHttpRequest.yml

@@ -56,81 +56,6 @@ rules:
               required:
                 - schema
 
-  must-use-http-methode-put-correctly:
-    message: 'must use standardized response code {{error}}'
-    description: MUST use HTTP methods correctly [148]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#148
-    severity: error
-    given: $.paths.*.[put]
-    then:
-      function: must-use-http-methods-correctly
-      functionOptions:
-        requiredFields:
-          - '200'
-          - '201'
-          - '204'
-          - default
-
-  must-use-http-methode-get-correctly:
-    message: 'must use standardized response code {{error}}'
-    description: MUST use HTTP methods correctly [148]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#148
-    severity: error
-    given: $.paths.*.[get]
-    then:
-      function: must-use-http-methods-correctly
-      functionOptions:
-        requiredFields:
-          - '200'
-          - '404'
-          - default
-
-  must-use-http-methode-post-correctly:
-    message: 'must use standardized response code {{error}}'
-    description: MUST use HTTP methods correctly [148]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#148
-    severity: error
-    given: $.paths.*.[post]
-    then:
-      function: must-use-http-methods-correctly
-      functionOptions:
-        requiredFields:
-          - '200'
-          - '201'
-          - '202'
-          - '204'
-          - default
-
-  must-use-http-methode-patch-correctly:
-    message: 'must use standardized response code {{error}}'
-    description: MUST use HTTP methods correctly [148]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#148
-    severity: error
-    given: $.paths.*.[patch]
-    then:
-      function: must-use-http-methods-correctly
-      functionOptions:
-        requiredFields:
-          - '200'
-          - '204'
-          - default
-
-  must-use-http-methode-delete-correctly:
-    message: 'must use standardized response code {{error}}'
-    description: MUST use HTTP methods correctly [148]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#148
-    severity: error
-    given: $.paths.*.[delete]
-    then:
-      function: must-use-http-methods-correctly
-      functionOptions:
-        requiredFields:
-          - '200'
-          - '204'
-          - '404'
-          - '410'
-          - default
-
   application-json-response-success:
     description: All success responses MUST be of media type application/json
     severity: error

ci/spectral/restBasicsHttpStatusCodes.yml → .config/spectral/restBasicsHttpStatusCodes.yml

@@ -10,15 +10,15 @@ rules:
 
   # MUST specify success and error responses [151]
   # => https://opensource.zalando.com/restful-api-guidelines/#151
-  must-specify-default-response:
-    message: Operation does not contain a default response
-    description: MUST specify success and error responses [151]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#151
-    severity: error
-    given: $.paths.*.*.responses
-    then:
-      field: default
-      function: truthy
+#  must-specify-default-response:
+#    message: Operation does not contain a default response
+#    description: MUST specify success and error responses [151]
+#    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#151
+#    severity: error
+#    given: $.paths.*.*.responses
+#    then:
+#      field: default
+#      function: truthy
 
   must-use-problem-json-as-default-response:
     message: Operation must use problem json as default response
@@ -139,15 +139,15 @@ rules:
 
   # MUST support problem JSON [176]
   # => https://opensource.zalando.com/restful-api-guidelines/#176
-  must-use-problem-json-for-errors:
-    message: Error response must be application/problem+json
-    description: MUST support problem JSON [176]
-    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#176
-    severity: error
-    given: $.paths.*.*.responses[?(@property.match(/^(4|5)/))]
-    then:
-      field: content.application/problem+json
-      function: truthy
+#  must-use-problem-json-for-errors:
+#    message: Error response must be application/problem+json
+#    description: MUST support problem JSON [176]
+#    documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#176
+#    severity: error
+#    given: $.paths.*.*.responses[?(@property.match(/^(4|5)/))]
+#    then:
+#      field: content.application/problem+json
+#      function: truthy
 
   must-use-valid-problem-json-schema:
     message: '{{error}}'

ci/spectral/restBasicsJsonPayload.yml → .config/spectral/restBasicsJsonPayload.yml

@@ -21,18 +21,17 @@ rules:
       functionOptions:
         match: ^application\/(problem\+)?json$|^[a-zA-Z0-9_]+\/[-+.a-zA-Z0-9_]+;(v|version)=[0-9]+$
 
-  # MUST property names must be ASCII snake_case [118]
-  # => https://opensource.zalando.com/restful-api-guidelines/#118
+  # MUST property names must be ASCII camelCase
   must-use-snake-case-for-property-names:
-    message: Property name has to be ASCII snake_case
-    description: MUST property names must be ASCII snake_case [118]
+    message: Property name has to be ASCII camelCase
+    description: MUST property names must be ASCII camelCase
     documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#118
     severity: error
     given: $.paths.*.*[responses,requestBody]..content..schema..properties.*~
     then:
       function: pattern
       functionOptions:
-        match: ^[a-z_][a-z_0-9]*$
+        match: ^[a-z]+([A-Z][a-z0-9]+)+
 
   # SHOULD declare enum values using UPPER_SNAKE_CASE string [240]
   # => https://opensource.zalando.com/restful-api-guidelines/#240
@@ -48,19 +47,18 @@ rules:
       functionOptions:
         match: "^(([A-Z]+)(_[A-Z]+)*)$"
 
-  # SHOULD name date/time properties with _at suffix [235]
-  # => https://opensource.zalando.com/restful-api-guidelines/#235
+  # SHOULD name date/time properties with On suffix [235]
   should-use-name-date-and-time-properties-with-at-suffix:
-    message: 'SHOULD name date/time properties with _at suffix'
-    description: SHOULD name date/time properties with _at suffix [235]
+    message: 'SHOULD name date/time properties with On suffix'
+    description: SHOULD name date/time properties with On suffix [235]
     documentationUrl: https://opensource.zalando.com/restful-api-guidelines/#235
     severity: error
     recommended: true
     given: $..properties[?((@.format == "date-time" || @.format == "date") && @.type == 'string')].~
     then:
       function: pattern
       functionOptions:
-        match: "^(.*[_]at$).*$"
+        match: "^(.*On$).*$"
 
   # MUST not use null for boolean properties [122]
   # => https://opensource.zalando.com/restful-api-guidelines/#122

.github/workflows/BETA-xray-cucumber-integration.yaml

@@ -40,13 +40,13 @@ jobs:
         env:
           KEYCLOAK_CLIENT_SECRET: ${{ secrets.KEYCLOAK_OAUTH2_CLIENT_SECRET_BETA }}
         run: |
-          unzip -o features.zip -d cucumber-tests/src/test/resources/features
-          mvn --batch-mode clean install -pl cucumber-tests,irs-models -D"cucumber.filter.tags"="not @Ignore and @INTEGRATION_TEST"
+          unzip -o features.zip -d irs-cucumber-tests/src/test/resources/features
+          mvn --batch-mode clean install -pl irs-cucumber-tests,irs-models -D"cucumber.filter.tags"="not @Ignore and @INTEGRATION_TEST"
 
       - name: Submit results to Xray
         if: ${{ always() && steps.download.outputs.http_response == '200' }}
         env:
           JIRA_USERNAME: ${{ secrets.ORG_IRS_JIRA_USERNAME }}
           JIRA_PASSWORD: ${{ secrets.ORG_IRS_JIRA_PASSWORD }}
         run: |
-          curl --request POST -u $JIRA_USERNAME:$JIRA_PASSWORD --header 'Content-Type: application/json' --data-binary '@cucumber-tests/report.json' "https://jira.catena-x.net/rest/raven/1.0/import/execution/cucumber"
+          curl --request POST -u $JIRA_USERNAME:$JIRA_PASSWORD --header 'Content-Type: application/json' --data-binary '@irs-cucumber-tests/report.json' "https://jira.catena-x.net/rest/raven/1.0/import/execution/cucumber"

.github/workflows/codeql.yml

@@ -22,15 +22,10 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
-      - 'api/**'
-      - 'api-tests/**'
       - 'charts/**'
-      - 'ci/**'
+      - '.config/**'
       - 'docs/**'
-      - 'dev/**'
-      - 'testdata-transform/**'
-      - 'testing/**'
-      - 'uml-diagrams/**'
+      - 'local/**'
       - 'README.md'
       - 'CHANGELOG.md'
   schedule:

.github/workflows/helm-test.yaml

@@ -56,5 +56,5 @@ jobs:
           helm repo add minio https://charts.min.io/
           helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
           helm repo add grafana https://grafana.github.io/helm-charts
-          ct install --charts charts/irs-helm
+          ct install --charts charts/irs-helm --helm-extra-set-args "--set=image.tag=testing"
         if: steps.list-changed.outputs.changed == 'true'

.github/workflows/helm-upgrade.yaml

@@ -0,0 +1,43 @@
+name: Upgrade Charts
+
+on:
+  pull_request:
+    paths:
+      - 'charts/irs-helm/**'
+  workflow_dispatch:
+
+jobs:
+  upgrade:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Kubernetes KinD Cluster
+        uses: container-tools/kind-action@v2
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.9.3
+
+      - name: Add repos
+        run: |
+          helm repo add bitnami https://charts.bitnami.com/bitnami
+          helm repo add minio https://charts.min.io/
+          helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
+          helm repo add grafana https://grafana.github.io/helm-charts
+          helm repo add irs https://eclipse-tractusx.github.io/item-relationship-service
+
+      - name: Run helm install
+        # Install latest released irs-helm version
+        run: |
+          helm install irs irs/irs-helm
+
+      - name: Run helm upgrade
+        # Upgrade the installed irs-helm version with the locally available charts
+        run: |
+          helm dependency update charts/irs-helm
+          helm upgrade irs charts/irs-helm