This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes.git
The following commit(s) were added to refs/heads/dev by this push:
new 08bae0a [hotfix] Update readme in directory cypress
08bae0a is described below
commit 08bae0a37b1309a242db85f9ea7f3effc2db44c2
Author: Philipp Zehnder <[email protected]>
AuthorDate: Wed Dec 29 15:31:58 2021 +0100
[hotfix] Update readme in directory cypress
---
ui/cypress/README.md | 39 +++++++++++++++++++++++++++------------
1 file changed, 27 insertions(+), 12 deletions(-)
diff --git a/ui/cypress/README.md b/ui/cypress/README.md
index 99bf847..d777cb9 100644
--- a/ui/cypress/README.md
+++ b/ui/cypress/README.md
@@ -21,29 +21,44 @@ This folder contains a WIP framework for automated E2E
tests of StreamPipes.
## How to run the tests?
1. Set up and install a clean StreamPipes instance.
-2. Start cypress:
-```bash
-npm run test-e2e
-```
-
-**User**: [email protected] **Password**: test1234
-
->**Note:** This can be changed in **support/utils/UserUtils.ts**
-
+2. Run Cypress (Use one of the three options):
+* Open cypress UI:
+ ```bash
+ npm run test-cypress-open
+ ```
+* Run smoke tests (tests with suffix .smoke.spec.ts )
+ ```bash
+ npm run test-cypress-smoke
+ ```
+* Run whole test suite (tests with suffix .spec.ts )
+ ```bash
+ npm run test-cypress-all
+ ```
+
+**User**: [email protected] **Password**: admin
>**Note:** The base URL can be configured in **cypress.json**
## Design guidlines
+* Before each test the whole system is cleaned to have a fresh environment
* Each test sets up its own test environment (e.g. upload files)
-* Once the test is performed all configurations and system changes should be
removed (e.g. delete uploaded files)
* There should not be any dependencies between tests
+* Ensure that all services required for the test are running (e.g. external
data sources, external databases, ...)
+
+## Automated test runs
+* Each night the whole test suite is run within github actions
+ * See:
+ * To add a test to the test suite add the suffix .spec.ts
+* Each PR triggers the smoke tests to detect errors before the branch is
merged into the development
+ * Add suffix .smoke.spec.ts to add test to the smoke tests
+* When no suffix is available the test must be triggered manually
## Directories
* **fixtures**:
* Files that are required for tests
-* **integrations**:
- * Contains the actual tests
* **plugins**:
* Cypress plugins can be added here
* **support**:
* Contains code for the StreamPipes test framework (e.g. model, utils
functions, ...)
+* **tests**:
+ * Contains the actual test cases grouped by streampipes modules (e.g.
connect, pipeline editor, ...)
