Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update e2e test device documentation #49441

Merged
merged 3 commits into from
Mar 29, 2023
Merged

docs: Update e2e test device documentation #49441

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02d8f1c
docs: Document visual regression testing emulator/simulator requirements
dcalhoun Mar 29, 2023
f66ffdd
docs: Fix typo
dcalhoun Mar 29, 2023
8d90461
docs: Document physical device usage for e2e tests
dcalhoun Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions packages/react-native-editor/__device-tests__/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,21 @@ SauceLabs is a cloud hosting platform that provides access to a variety of simul

## Getting set up to run the tests

### Emulators && Simulators
### Emulators & Simulators

iOS: Once you've already set up XCode and the simulators you should be good to go to run the tests on an iOS simulator.
> **Note**
>
> Visual regression tests that rely upon screenshots require specific devices and OS versions for Android and iOS, respectively, otherwise the tests will fail due to subtle OS differences. To run or update visual regression tests, install the emulators/simulators listed in the test suite [configuration files](https://github.com/WordPress/gutenberg/blob/trunk/packages/react-native-editor/__device-tests__/helpers/caps.js#L30-L31).

Android: You'll need to have created the emulator images and fired up the desired emulator before running the tests against an Android emulator.
**iOS:** If you have completed the [React Native Getting Started](https://reactnative.dev/docs/environment-setup) guide you should already have XCode installed and the simulators set up.

### Real Devices
**Android:** If you have completed the [React Native Getting Started](https://reactnative.dev/docs/environment-setup) guide you should already have Android Studio installed and the Android SDK installed. You'll also need to have the [Android Emulator](https://developer.android.com/studio/run/emulator) installed and set up. The emulator needs to be running prior to running the tests.

TBA
### Physical Devices

**iOS:** Currently unsupported.

**Android:** Connect your device to your computer via USB and [enable USB debugging](https://developer.android.com/studio/debug/dev-options).

## Running the tests locally

Expand Down