Merge pull request #552 from catenax-ng/main

Publish swagger, fix CVE-2024-22262, improve tavern test readme
eclipse-tractusx · Apr 23, 2024 · 0a145bb · 0a145bb
2 parents fa85eaf + 3f5c59f
commit 0a145bb
Show file tree

Hide file tree

Showing 9 changed files with 139 additions and 127 deletions.
diff --git a/.github/workflows/publish-documentation.yaml b/.github/workflows/publish-documentation.yaml
@@ -45,11 +45,6 @@ jobs:
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
 
-      - name: Build API documentation with Maven
-        run: |
-          mvn clean package -pl irs-common,irs-models,irs-policy-store,irs-testing,irs-edc-client,irs-registry-client,irs-api -DskipTests --batch-mode
-          cp irs-api/target/generated-sources/openapi/index.html docs/src/docs/api-specification/index.html
-
       - name: Build with Maven
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
@@ -112,10 +107,26 @@ jobs:
         run: |
           mv docs/src/diagram-replacer/assets/ docs/target/generated-docs/assets/
 
+      - name: Generate Swagger UI
+        uses: Legion2/swagger-ui-action@v1
+        with:
+          output: swagger-ui
+          spec-file: docs/src/api/irs-api.yaml
+
       - name: Update documentation on GitHub Pages
         if: github.ref == 'refs/heads/main'
-        uses: peaceiris/actions-gh-pages@v3.9.3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: "./docs/target/generated-docs"
           destination_dir: "docs"
+
+      - name: Deploy Swagger UI to GitHub Pages
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: "swagger-ui"
+          destination_dir: "docs/swagger-ui"
+
+
diff --git a/DEPENDENCIES b/DEPENDENCIES
diff --git a/docs/src/docs/api-specification/api-specification.adoc b/docs/src/docs/api-specification/api-specification.adoc
diff --git a/docs/src/docs/api-specification/api.adoc b/docs/src/docs/api-specification/api.adoc
diff --git a/docs/src/docs/api-specification/index.html b/docs/src/docs/api-specification/index.html
diff --git a/docs/src/docs/index.adoc b/docs/src/docs/index.adoc
@@ -3,8 +3,8 @@
 == Administration Guide
 xref:administration/administration-guide.adoc[]
 
-== API-Documentation
-xref:api-specification/api-specification.adoc[OpenApi specification]
+== Swagger-UI
+xref:swagger-ui/index.adoc[Swagger-UI]
 
 == Architecture Documentation (arc42)
 - xref:arc42/index.adoc[Single chapters]

diff --git a/docs/src/docs/swagger-ui/index.adoc b/docs/src/docs/swagger-ui/index.adoc
@@ -0,0 +1,13 @@
+= Swagger-UI
+
+== NOTICE
+
+This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0].
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+- SPDX-FileCopyrightText: 2022, 2023 BOSCH AG
+- SPDX-FileCopyrightText: 2021, 2022 ZF Friedrichshafen AG
+- SPDX-FileCopyrightText: 2022  ISTOS GmbH
+- SPDX-FileCopyrightText: 2021, 2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/item-relationship-service
diff --git a/local/testing/api-tests/README.md b/local/testing/api-tests/README.md
@@ -4,11 +4,11 @@ This folder contains [Tavern](https://tavern.readthedocs.io) API tests for the I
 
 ## Usage 
 
-* Install python
-* Install pytest: ```py -m pip install pytest```
-* Install tavern: ```py -m pip install tavern```
-* Create variable.env in directory api-tests
-* Copy content to variable.env
+1. Install python
+2. Install pytest: ```py -m pip install pytest```
+3. Install tavern: ```py -m pip install tavern```
+4. Create variable.env in directory api-tests
+5. Copy content to variable.env
 ```
 # this is temporary file for local development to setup environments variable such a secrets and URLs
 # to run it just execute in console:
@@ -26,11 +26,18 @@ export ADMIN_USER_API_KEY=
 export REGULAR_USER_API_KEY_ESS=
 export ADMIN_USER_API_KEY_ESS=
 ```
-* Execute command 
-```console
-  source variable.env
-  py -m pytest irs-api-tests.tavern.yaml
-```
-
-
+6. Execute tests
+    
+   1. Run all tests
+        ```console
+          source variable.env
+          py -m pytest local/testing/api-tests/irs-api-tests.tavern.yaml
+        ```
 
+   2. To run a single test:
+        ```console
+          py -m pytest local/testing/api-tests/irs-api-tests.tavern.yaml::"<test name>"
+          
+          # for example:      
+          py -m pytest local/testing/api-tests/irs-api-tests.tavern.yaml::"Make sure job with submodels process with status COMPLETED with asPlanned-id"
+        ```
diff --git a/pom.xml b/pom.xml
@@ -76,7 +76,7 @@
         <irs-registry-client.version>1.10.0-SNAPSHOT</irs-registry-client.version>
 
         <!-- Dependencies -->
-        <springboot.version>3.1.10</springboot.version>
+        <springboot.version>3.1.11</springboot.version>
         <springdoc.version>2.2.0</springdoc.version>
         <micrometer.version>1.11.4</micrometer.version>
         <datafaker.version>1.9.0</datafaker.version>