Skip to content

Commit 0efaa74

Browse files
ala-nyadamskayadshovchko
committed
docs(e2e): fixes for the root e2e submodule README
Co-authored-by: Yuliya Adamska <[email protected]> Co-authored-by: Dmitry Shovchko <[email protected]>
1 parent 928efcd commit 0efaa74

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

e2e/README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
## Introduction
44
This is an internal package for visual automation testing the ESL.
5-
It is designed to be used by the ESL team to test ESL library by checking visual consistency of `@exadel/esl-webside` submodule.
5+
It is designed to be used by the ESL team to test the ESL library by checking the visual consistency of `@exadel/esl-website` submodule.
66

77
## Installation
88

9-
There is no extra pre-conditions to develop new visual tests locally,
9+
There are no extra pre-conditions to develop new visual tests locally,
1010
everything to start will be already installed with root package installation.
1111

12-
**⚠️ Except for one critical thing: all final snapshots should be created on Linux based OS (Ubuntu latest version is recommended) ⚠️**
12+
**⚠️ Except for one critical thing: all final snapshots should be created on Linux based OS (the latest version of Ubuntu is recommended) ⚠️**
1313

14-
Visual testing depends on fonts rendering so snapshots created on different OS may be different.
15-
The main (remote) environment for visual testing runs via GitHub Workflows on Ubuntu latest version.
14+
Visual testing depends on font rendering so snapshots created on different OS may be different.
15+
The main (remote) environment for visual testing runs via GitHub Workflows on the latest version of Ubuntu.
1616

1717
### Creating snapshots and running existing tests on Windows
1818

@@ -28,7 +28,7 @@ To create snapshots on Windows, you need to use WSL (Windows Subsystem for Linux
2828
nvm install node@20
2929
nvm use node@20
3030
```
31-
4. Install cromium browser (https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps#install-google-chrome-for-linux):
31+
4. Install Chromium browser (https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps#install-google-chrome-for-linux):
3232
```bash
3333
sudo apt-get update
3434
sudo apt-get install -y chromium-browser
@@ -38,9 +38,9 @@ To create snapshots on Windows, you need to use WSL (Windows Subsystem for Linux
3838
sudo apt install libgtk-3-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2
3939
```
4040
Note: you might need to restart your subsystem after steps 4 and 5.
41-
6. Open project folder via WSL terminal and run `npm install` to ensure all dependencies are installed.
41+
6. Open the project folder via WSL terminal and run `npm install` to ensure all dependencies are installed.
4242
7. Use `e2e` package scripts to create snapshots and run tests:
43-
- `npm run test:e2e` (in the root package) or `npm run run` (in sub-package) to run all tests (missing snapshots will be created automatically)
43+
- `npm run test:e2e` (in the root package) or `npm run run` (in the sub-package) to run all tests (missing snapshots will be created automatically)
4444
- `npm run test:e2e:update` (in the root package) or `npm run run:update` (in sub-package) to update all snapshots
4545

4646
### Creating snapshots and running existing tests on Mac
@@ -49,10 +49,10 @@ TODO: add instructions for Mac OS
4949

5050
### Creating snapshots and running existing tests on Linux
5151

52-
To create snapshots on Linux, you can use any Linux distribution, but Ubuntu latest version is recommended.
52+
To create snapshots on Linux, you can use any Linux distribution, but the latest version of Ubuntu is recommended.
5353

54-
1. Install ESL root package and all dependencies according to the root package README.md.
55-
2. Ensure you have chromium browser installed:
54+
1. Install the ESL root package and all dependencies according to the root package README.md.
55+
2. Ensure you have Chromium browser installed:
5656
```bash
5757
sudo apt-get update
5858
sudo apt-get install -y chromium-browser
@@ -69,18 +69,17 @@ Use explicit workspace name to run following commands from the root package.
6969

7070
- `npm run run` - run all visual tests (run server automatically, create missing snapshots)
7171
- `npm run run:update` - update all snapshots (run server automatically)
72-
- `npm run run:server` - shortcut to run server for visual tests (uses `esl-webside` package)
72+
- `npm run run:server` - shortcut to run server for visual tests (uses `esl-website` package)
7373
- `npm run run:update:only` - update all snapshots, does not run server (ensure you run server manually)
7474
- `npm run run:server:only` - run server for visual tests, does not run tests
7575

7676
Note: default server port for visual tests is `3007`.
7777

78-
7978
## Updating snapshots using GitHub project workflow
8079

8180
The Automated tests workflow allows you to trigger it manually, it will update all snapshots and commit changes on the branch you specify.
8281

83-
Make sure you have permissions to run workflows in the ESL repository or ask the ESL Maintainers team to run the proper update for you.
82+
Make sure you have permission to run workflows in the ESL repository or ask the ESL Maintainers team to run the proper update for you.
8483

8584
To trigger the workflow manually, follow these steps:
8685

0 commit comments

Comments
 (0)