Sulkta-Coop/element-x-ada
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation about screenshot test

Browse source
This commit is contained in:
Benoit Marty 2023-03-07 23:27:25 +01:00 • committed by Benoit Marty
parent fca8642c11
commit d58a02fdd1
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/screenshot_testing.md
View file

@ -21,22 +21,31 @@
- Install Git LFS through your package manager of choice (`brew install git-lfs` | `yay -S git-lfs`).
- Install the Git LFS hooks into the project.
```bash
```shell
# with element-android as the current working directory
git lfs install --local
```
- If installed correctly, `git push` and `git pull` will now include LFS content.
If installed correctly, `git push` and `git pull` will now include LFS content.
## Recording
- `./gradlew recordPaparazziDebug`
- Paparazzi will generate images in `:tests:uitests/src/test/snapshots`, which will need to be committed to the repository using Git LFS.
It's recommended to delete the content of the folder `/snapshots` before recording.
```shell
rm -rf ./tests/uitests/src/test/snapshots
./gradlew recordPaparazziDebug
```
Paparazzi will generate images in `:tests:uitests/src/test/snapshots`, which will need to be committed to the repository using Git LFS.
## Verifying
- `./gradlew verifyPaparazziDebug`
- In the case of failure, Paparazzi will generate images in `:tests:uitests/out/failure`. The images will show the expected and actual screenshots along with a delta of the two images.
```shell
./gradlew verifyPaparazziDebug
```
In the case of failure, Paparazzi will generate images in `:tests:uitests/out/failure`. The images will show the expected and actual screenshots along with a delta of the two images.
## Contributing