|
1 | 1 | # Theia Scale Tests
|
2 | 2 |
|
3 |
| -This repository provides E2E integration tests for the [Theia Cloud IDE](https://theia-cloud.io) regarding scalability. |
| 3 | +[](https://github.com/ls1intum/theia-scale-tests/actions/workflows/playwright.yml) |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +This repository provides E2E integration tests for the [Theia Cloud IDE](https://theia-cloud.io). It uses Playwright to simulate real world usage of Online IDE's in large classroom settings. |
| 8 | + |
4 | 9 |
|
5 | 10 | ## Information
|
6 | 11 |
|
7 | 12 | - Tests are written using [Playwright](https://playwright.dev)
|
8 |
| -- Scaled tests run via the Playwright [Artillery](https://artillery.io) Framework (Potentially) |
| 13 | +- Scaled tests (potentially) run via the Playwright [Artillery](https://artillery.io) Framework |
9 | 14 |
|
10 |
| -## For Development |
| 15 | +## Setup |
11 | 16 |
|
12 |
| -- Single User Playwright Tests are run using a Test Account for Keycloak, to change the Test User, change the environment variables in GitHub Secrets \ |
13 |
| --> Settings -> Secrets and variables -> Actions -> Secrets -> Repository Secrets \ |
14 |
| -or [here](https://github.com/ls1intum/theia-scale-tests/settings/secrets/actions) |
| 17 | +- Install dependencies |
| 18 | + ```bash |
| 19 | + npm install |
| 20 | + ``` |
| 21 | + |
15 | 22 | - To run the tests on the deployed Theia instance, run:
|
16 |
| - |
17 | 23 | ```bash
|
18 | 24 | npx playwright test --project=deployed
|
19 | 25 | ```
|
20 | 26 |
|
21 | 27 | - To run tests locally using a Theia Instance on localhost, change the environment variable to the corresponding port and run the tests using:
|
22 |
| - |
23 | 28 | ```bash
|
24 | 29 | npx playwright test --project=local
|
25 | 30 | ```
|
26 | 31 |
|
27 |
| -- To run every test, simply run: |
28 |
| - |
| 32 | +- To run every test (requires local Theia instance), simply run: |
29 | 33 | ```bash
|
30 | 34 | npx playwright test
|
31 | 35 | ```
|
32 | 36 |
|
33 |
| -- Test files that allow local testing (testing without Landing Page and Keycloak) have the following file ending: |
34 | 37 |
|
35 |
| - ```none |
36 |
| - *.ide.spec.ts |
37 |
| - ``` |
38 | 38 |
|
39 |
| -- Set the corresponding URLs in the `global.config.ts` file |
| 39 | +## Development |
| 40 | + |
| 41 | + - Single User Playwright Tests are run using a Test Account for Keycloak, to change the Test User, change the environment variables in GitHub Secrets \ |
| 42 | +-> Settings -> Secrets and variables -> Actions -> Secrets -> Repository Secrets \ |
| 43 | + |
| 44 | + - Test files that allow local testing (testing without Landing Page and Keycloak) have the following file ending: |
| 45 | + ```none |
| 46 | + *.ide.spec.ts |
| 47 | + ``` |
0 commit comments