[hotfix] Update readme in directory cypress
@@ -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:
+2. Run Cypress (Use one of the three options):
+* Open cypress UI:
```bash
-npm run test-e2e
+ 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**: test@streampipes.apache.org **Password**: test1234
-
->**Note:** This can be changed in **support/utils/UserUtils.ts**
-
+**User**: admin@streampipes.apache.org **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, ...)
