Skip to content

Commit 7213da5

Browse files
authored
Update README.md
1 parent f022821 commit 7213da5

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,47 @@
11
# Theia Scale Tests
22

3-
This repository provides E2E integration tests for the [Theia Cloud IDE](https://theia-cloud.io) regarding scalability.
3+
[![Playwright Tests](https://github.com/ls1intum/theia-scale-tests/actions/workflows/playwright.yml/badge.svg)](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+
49

510
## Information
611

712
- 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
914

10-
## For Development
15+
## Setup
1116

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+
1522
- To run the tests on the deployed Theia instance, run:
16-
1723
```bash
1824
npx playwright test --project=deployed
1925
```
2026

2127
- To run tests locally using a Theia Instance on localhost, change the environment variable to the corresponding port and run the tests using:
22-
2328
```bash
2429
npx playwright test --project=local
2530
```
2631

27-
- To run every test, simply run:
28-
32+
- To run every test (requires local Theia instance), simply run:
2933
```bash
3034
npx playwright test
3135
```
3236

33-
- Test files that allow local testing (testing without Landing Page and Keycloak) have the following file ending:
3437

35-
```none
36-
*.ide.spec.ts
37-
```
3838

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

Comments
 (0)