Skip to content

Commit

Permalink
chore: Add e2e test docs (#172)
Browse files Browse the repository at this point in the history
related issue:
kyma-project/lifecycle-manager#304

---------

Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com>
  • Loading branch information
ruanxin and mmitoraj authored Apr 3, 2024
1 parent 046c1ca commit b9d8084
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
This folder contains documents that relate to the project.

> In this document, provide the list of all documents that this folder contains, together with links to those documents and short information on what they describe.
- [Enhanced Deployment Configuration Template for End-to-End Testing](e2e-test.md) - describes how to configure the template operator to fulfill certain e2e test scenarios.
17 changes: 17 additions & 0 deletions docs/e2e-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Enhanced Deployment Configuration Template for End-to-End Testing

This document outlines how to use arguments to imitate specific module behavior to support certain end-to-end (e2e) test scenarios.

- `final-state`

This argument allows customization of the final state of a Module CR (`sample-yaml`). By default, a Module CR transitions to the `Ready` state. However, the final state can be configured to differ from this default.

For instance, to override the final state to `Warning`, add `--final-state=Warning` as a deployment argument. In this case, once the Module CR is deployed, it remains in the `Warning` state.

- `final-deletion-state`

This argument is used to customize the final state of a Module CR (`sample-yaml`) when the CR is flagged for deletion. The default state in this case is `Deleting`.

## Related End-to-End Tests:

- [Warning Status Propagation](https://github.com/kyma-project/lifecycle-manager/blob/a0c49436f3d11d03c9a7556ec11c7c9f69d621d9/tests/e2e/warning_status_propagation_test.go#L17) - in this test scenario the `final-state` and `final-deletion-state` arguments are used to set the Module CR's final state to `Warning`.

0 comments on commit b9d8084

Please sign in to comment.