From efae9703871abe62ccb78f816b2abaaffaac80be Mon Sep 17 00:00:00 2001 From: jhartmann Date: Fri, 5 Jul 2024 15:51:06 +0200 Subject: [PATCH] feat(docs):[#732] Added documentation describing the Umbrella E2E setup --- docs/src/docs/arc42/cross-cutting/full.adoc | 1 + docs/src/docs/arc42/cross-cutting/index.adoc | 1 + .../src/docs/arc42/cross-cutting/testing.adoc | 37 +++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 docs/src/docs/arc42/cross-cutting/testing.adoc diff --git a/docs/src/docs/arc42/cross-cutting/full.adoc b/docs/src/docs/arc42/cross-cutting/full.adoc index 3892a86cbb..142e20bac2 100644 --- a/docs/src/docs/arc42/cross-cutting/full.adoc +++ b/docs/src/docs/arc42/cross-cutting/full.adoc @@ -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] diff --git a/docs/src/docs/arc42/cross-cutting/index.adoc b/docs/src/docs/arc42/cross-cutting/index.adoc index bf85a8fe28..c8d5654cfc 100644 --- a/docs/src/docs/arc42/cross-cutting/index.adoc +++ b/docs/src/docs/arc42/cross-cutting/index.adoc @@ -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] diff --git a/docs/src/docs/arc42/cross-cutting/testing.adoc b/docs/src/docs/arc42/cross-cutting/testing.adoc new file mode 100644 index 0000000000..56d135914f --- /dev/null +++ b/docs/src/docs/arc42/cross-cutting/testing.adoc @@ -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. \ No newline at end of file