feature: add reload method to easily reset app state during tests (#114)

* refactor: move adb and xcrun commands into separate utils

* feat: add `reload` support

* docs: add `reload` method to docs

* tests: fix tests

* docs: update `reload` docs and example tests

* chore: dep version updates

* ci: update example package link to try to fix CI

Author: robwalkerco

docs/api/methods.md

@@ -235,3 +235,36 @@ describe('App.tsx', () => {
   });
 });
 ```
+
+### reload()
+
+Terminates the app in the emulator/simulator, and restarts it.
+
+This is useful when you want to complete a set of tests and nove onto a new set of tests.
+
+Depending on your use-case, you could call `reload` in a `beforeAll`, or `beforeEach` callback, or within a test case, to get the app into a clean state before each set of tests for example.
+
+
+#### Example
+
+
+```js title="__tests__/App.owl.tsx"
+import { reload } from 'react-native-owl';
+
+describe('App.tsx', () => {
+  describe('the checkout flow', () => {
+    beforeAll(async () => {
+      // highlight-next-line
+      await reload();
+    }),
+
+    it('adds product to cart', async () => {
+      ...
+    });
+
+    it('starts checkout flow', async () => {
+      ...
+    });
+  });
+});
+```

example/.owl/baseline/android/after-reload.png

@@ -6,56 +6,71 @@ import {
   scrollTo,
   scrollToEnd,
   longPress,
+  reload,
 } from 'react-native-owl';
 
 jest.setTimeout(30000);
 
 describe('App.tsx', () => {
-  it('takes a screenshot of the initial screen', async () => {
-    const screen = await takeScreenshot('initial');
+  describe('Basic navigation', () => {
+    it('takes a screenshot of the initial screen', async () => {
+      const screen = await takeScreenshot('initial');
 
-    expect(screen).toMatchBaseline();
-  });
+      expect(screen).toMatchBaseline();
+    });
 
-  it('longPress a Pressable, then takes a screenshot', async () => {
-    await longPress('Pressable');
+    it('longPress a Pressable, then takes a screenshot', async () => {
+      await longPress('Pressable');
 
-    const screen = await takeScreenshot('long-press');
+      const screen = await takeScreenshot('long-press');
 
-    expect(screen).toMatchBaseline();
-  });
+      expect(screen).toMatchBaseline();
+    });
 
-  it('press a Pressable, waits for an element then takes a screenshot', async () => {
-    await press('Pressable');
+    it('press a Pressable, waits for an element then takes a screenshot', async () => {
+      await press('Pressable');
 
-    await toExist('TextInput');
+      await toExist('TextInput');
 
-    const screen = await takeScreenshot('test-input');
+      const screen = await takeScreenshot('test-input');
 
-    expect(screen).toMatchBaseline();
-  });
+      expect(screen).toMatchBaseline();
+    });
 
-  it('enters some text and takes a screenshot', async () => {
-    await changeText('TextInput', 'Entered text');
+    it('enters some text and takes a screenshot', async () => {
+      await changeText('TextInput', 'Entered text');
 
-    const screen = await takeScreenshot('entered-text');
+      const screen = await takeScreenshot('entered-text');
 
-    expect(screen).toMatchBaseline();
-  });
+      expect(screen).toMatchBaseline();
+    });
+
+    it('scrolls a bit and takes a screenshot', async () => {
+      await scrollTo('ScrollView', { y: 50 });
+
+      const screen = await takeScreenshot('scroll-to');
+
+      expect(screen).toMatchBaseline();
+    });
 
-  it('scrolls a bit and takes a screenshot', async () => {
-    await scrollTo('ScrollView', { y: 50 });
+    it('scrolls to end and takes a screenshot', async () => {
+      await scrollToEnd('ScrollView');
 
-    const screen = await takeScreenshot('scroll-to');
+      const screen = await takeScreenshot('scroll-to-end');
 
-    expect(screen).toMatchBaseline();
+      expect(screen).toMatchBaseline();
+    });
   });
 
-  it('scrolls to end and takes a screenshot', async () => {
-    await scrollToEnd('ScrollView');
+  describe('Reload example', () => {
+    beforeAll(async () => {
+      await reload();
+    });
 
-    const screen = await takeScreenshot('scroll-to-end');
+    it('takes a screenshot of the welcome screen', async () => {
+      const screen = await takeScreenshot('after-reload');
 
-    expect(screen).toMatchBaseline();
+      expect(screen).toMatchBaseline();
+    });
   });
 });

example/.owl/baseline/ios/after-reload.png

@@ -523,4 +523,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 3190b6d7739c1a0f98e11d88f08dd49936f770e0
 
-COCOAPODS: 1.11.2
+COCOAPODS: 1.11.3

example/__tests__/App.owl.tsx

@@ -17,7 +17,7 @@
   "dependencies": {
     "react": "17.0.2",
     "react-native": "0.66.0",
-    "react-native-owl": "link:../"
+    "react-native-owl": "link:.."
   },
   "devDependencies": {
     "@babel/core": "^7.12.9",

example/ios/Podfile.lock

@@ -1,4 +1,10 @@
+import { getConfig } from './cli/config';
+
 import { Logger } from './logger';
+import { CliRunOptions } from './types';
+import { adbLaunch, adbTerminate } from './utils/adb';
+import { waitFor } from './utils/wait-for';
+import { xcrunLaunch, xcrunTerminate, xcrunUi } from './utils/xcrun';
 import { createWebSocketClient } from './websocket';
 import {
   SOCKET_TEST_REQUEST,
@@ -57,3 +63,62 @@ export const scrollToEnd = (testID: string) =>
 
 export const toExist = (testID: string) =>
   sendEvent({ type: 'LAYOUT', action: 'EXISTS', testID });
+
+export const reload = async () => {
+  const args = (global as any).OWL_CLI_ARGS as CliRunOptions;
+
+  if (!args) {
+    return;
+  }
+
+  const config = await getConfig(args.config);
+
+  if (args.platform === 'ios') {
+    if (!config.ios?.device) {
+      return Promise.reject('Missing device name');
+    }
+
+    await xcrunTerminate({
+      debug: config.debug,
+      binaryPath: config.ios?.binaryPath,
+      device: config.ios.device,
+      scheme: config.ios?.scheme,
+      configuration: config.ios?.configuration,
+    });
+
+    await xcrunLaunch({
+      debug: config.debug,
+      binaryPath: config.ios?.binaryPath,
+      device: config.ios.device,
+      scheme: config.ios?.scheme,
+      configuration: config.ios?.configuration,
+    });
+
+    await waitFor(1000);
+
+    await xcrunUi({
+      debug: config.debug,
+      device: config.ios.device,
+      configuration: config.ios.configuration,
+      binaryPath: config.ios.binaryPath,
+    });
+  }
+
+  if (args.platform === 'android') {
+    if (!config.android?.packageName) {
+      return Promise.reject('Missing package name');
+    }
+
+    await adbTerminate({
+      debug: config.debug,
+      packageName: config.android.packageName,
+    });
+
+    await adbLaunch({
+      debug: config.debug,
+      packageName: config.android.packageName,
+    });
+
+    await waitFor(500);
+  }
+};