Skip to content

Commit

Permalink
feat(docs):[#732] Added documentation describing the Umbrella E2E setup
Browse files Browse the repository at this point in the history
  • Loading branch information
ds-jhartmann committed Jul 5, 2024
1 parent 43b3b7c commit efae970
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/docs/arc42/cross-cutting/full.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ include::architecture-design-patterns.adoc[leveloffset=+1]
include::under-the-hood.adoc[leveloffset=+1]
include::development-concepts.adoc[leveloffset=+1]
include::operational-concepts.adoc[leveloffset=+1]
include::testing.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions docs/src/docs/arc42/cross-cutting/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
- xref:under-the-hood.adoc["Under-the-hood" concepts]
- xref:development-concepts.adoc[Development concepts]
- xref:operational-concepts.adoc[Operational concepts]
- xref:testing.adoc[Testing concepts]
37 changes: 37 additions & 0 deletions docs/src/docs/arc42/cross-cutting/testing.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
= Testing concepts

== Umbrella

The https://github.com/eclipse-tractusx/tractus-x-umbrella[umbrella chart] provides a pre-configured catena-x network which includes all necessary components for the IRS to work.

For IRS this includes:

* Central Idp
* Edc Provider
** Digital Twin Registry
** Submodel Backend
** EDC
** Vault
* EDC Consumer
** EDC
** Vault
* Discovery Service
* EDC Discovery *
* IATP *
* BDRS
* Semantic Hub

Services marked with * are currently mocked, since there is no FOSS-Component available for IATP/DIM and the configuration and data seeding for EDC Discovery is not possible at the moment.

These Service are used together with the IRS Helm Chart to provide a E2E Testing Infrastructure which can be spun up directly in a GitHub Workflow to execute E2E Tests against.

The action https://github.com/eclipse-tractusx/item-relationship-service/blob/main/.github/actions/setup-umbrella-env/action.yaml creates this environment and seeds Testdata for IRS use-cases directly to the EDC Provider components.
After Umbrella setup and seeding, the IRS docker image is built based on the branch, the workflow is run from, and the IRS helm chart from the same branch is installed.
This ensures, that features on branches can be tested as well.

The workflows https://github.com/eclipse-tractusx/item-relationship-service/blob/main/.github/workflows/tavern-UMBRELLA.yml[tavern-UMBRELLA.yaml] and https://github.com/eclipse-tractusx/item-relationship-service/blob/main/.github/workflows/cucumber-integration-test-UMBRELLA.yaml[cucumber-integration-test-UMBRELLA.yaml] use the action to execute the tests.
Test results are automatically added to the workflow summary and in case of the cucumber tests uploaded to the https://reports.cucumber.io/report-collections/b82bcadd-0d19-41c4-ae1a-c623e259c36f[IRS Cucumber Report]

Due to limitations in the IATP mock, the only way of using multiple BPNs in the test data is to spin up multiple EDC provider instances.
However, the chart is used inside GitHub Workflows, so compute resources are limited.
For this reason, the IRS test data was changed to include only data pointing to a single BPN.

0 comments on commit efae970

Please sign in to comment.