mirror of
https://github.com/zoriya/react-native-svg.git
synced 2025-12-05 22:56:11 +00:00
<!-- 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>
36 lines
1.3 KiB
TypeScript
36 lines
1.3 KiB
TypeScript
import { WebSocketServer } from 'ws';
|
|
|
|
// This is little hack, we don't use syntax sugar with `async` here as we need to manually resolve promise
|
|
// whenever a client connects using resolve callback. In result the Jest will wait until some device connects,
|
|
// so it can be used to render test cases.
|
|
const setupJest = () =>
|
|
new Promise<void>((resolve) => {
|
|
const wsServer = new WebSocketServer({ port: 7123 });
|
|
wsServer.on('connection', (client) => {
|
|
global.client = client;
|
|
|
|
// Add handler for one-time handshake message that confirms the client has connected properly
|
|
client.once('message', (message) => {
|
|
const parsedMessage = JSON.parse(message.toString('utf-8'));
|
|
console.log(
|
|
`[react-native-svg] Received handshake from a test client: ${JSON.stringify(
|
|
parsedMessage
|
|
)}`
|
|
);
|
|
|
|
global.os = parsedMessage.os;
|
|
global.arch = parsedMessage.arch;
|
|
|
|
console.log(`[react-native-svg] Running E2E test suites...\n`);
|
|
resolve();
|
|
});
|
|
});
|
|
|
|
console.log(
|
|
'\n\n[react-native-svg] E2E WebSocket server is running, waiting for client connection. Run example app and select E2E from examples list.\n'
|
|
);
|
|
global.server = wsServer;
|
|
});
|
|
|
|
export default setupJest;
|