Files
react-native-svg/e2e/generateReferences.ts
Bartosz Stefańczyk a089cc2efc feat: e2e snapshot tests (#2338)
<!-- Thanks for submitting a pull request! We appreciate you spending
the time to work on these changes. Please follow the template so that
the reviewers can easily understand what the code changes affect -->

# Summary

This PR adds E2E tests based on view screenshots done via
`react-native-view-shot`. It only works with devices that have their
[pixel ratio](https://reactnative.dev/docs/pixelratio) equal `3`. If you
want to use device with different pixel ratio, you need to adjust it in
`e2e/generateReferences.ts` viewport and regenerate reference images
(see below).

Steps to run tests:
- Run Metro server for example app via `yarn start` in example app's
directory
- Run `example` app on platform of your choice (currently only Android &
iOS are supported) via `yarn android` or `yarn ios` in example app's
directory
- Run `yarn e2e` in project's root directory to start Jest server
- Select `E2E` tab in example app
- Wait for tests to finish
- You can see test results, as well as diffs (actual rendered svg vs
reference image) in `e2e/diffs` directory

Steps to add new test cases:
- Put SVG of your choice to `e2e/cases` directory
- Run `yarn generateE2eRefrences`, this will open headless chrome
browser via `puppeteer` and snapshot all rendered SVGs to .png files and
later use them as reference in tests
- You should see new .png files in `e2e/references`
- When you run E2E tests again, it will use new test case(s) you've
added

## Test Plan


https://github.com/software-mansion/react-native-svg/assets/41289688/24ee5447-ce9a-43b6-9dde-76229d25a30a


https://github.com/software-mansion/react-native-svg/assets/41289688/71d1873f-8155-4494-80bd-e4c1fa72a065


### What's required for testing (prerequisites)?
See Summary

### What are the steps to reproduce (after prerequisites)?
See Summary

## Compatibility

| OS      | Implemented |
| ------- | :---------: |
| iOS     |    	     |
| Android |         |
| Web | 			 |
## Checklist



<!-- Check completed item, when applicable, via: [X] -->

- [X] I have tested this on a device and a simulator
- [x] I added documentation in `README.md`
- [X] I updated the typed files (typescript)
- [X] I added a test for the API in the `__tests__` folder

---------

Co-authored-by: bohdanprog <bohdan.artiukhov@swmansion.com>
Co-authored-by: Jakub Grzywacz <jakub.grzywacz@swmansion.com>
2024-08-23 13:29:38 +02:00

36 lines
1.2 KiB
TypeScript

const path = require('path');
const puppeteer = require('puppeteer');
const fs = require('fs');
const main = async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.setViewport({
height: 200,
width: 200,
// This is hardcoded value which makes it possible to use only devices with pixel ratio = 3. You can change it
// and regenerate reference images if you want to use device with different pixel ratio
// see: https://reactnative.dev/docs/pixelratio
deviceScaleFactor: 3,
});
const casesPath = path.resolve('e2e', 'cases');
const referencesPath = path.resolve('e2e', 'references');
const cases = fs.readdirSync(casesPath);
for (const testCase of cases) {
const svgPath = path.resolve(casesPath, testCase);
await page.goto(`file://${svgPath}`);
await page.$eval('svg', (ev: Element) => {
ev.setAttribute('width', '200');
ev.setAttribute('height', '200');
});
const svg = await page.waitForSelector('svg');
await svg.screenshot({
path: path.resolve(referencesPath, testCase.replace('.svg', '.png')),
});
}
await browser.close();
};
main();