Update documentation about screenshot test
This commit is contained in:
parent
2a9cdee727
commit
21915f6eb6
1 changed files with 15 additions and 6 deletions
|
|
@ -21,22 +21,31 @@
|
||||||
- Install Git LFS through your package manager of choice (`brew install git-lfs` | `yay -S git-lfs`).
|
- 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.
|
- Install the Git LFS hooks into the project.
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
# with element-android as the current working directory
|
# with element-android as the current working directory
|
||||||
git lfs install --local
|
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
|
## Recording
|
||||||
|
|
||||||
- `./gradlew recordPaparazziDebug`
|
It's recommended to delete the content of the folder `/snapshots` before recording.
|
||||||
- Paparazzi will generate images in `:tests:uitests/src/test/snapshots`, which will need to be committed to the repository using Git LFS.
|
|
||||||
|
```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
|
## Verifying
|
||||||
|
|
||||||
- `./gradlew verifyPaparazziDebug`
|
```shell
|
||||||
- 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.
|
./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
|
## Contributing
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue