react-native/scripts/android-e2e-test.js

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @format
 */

// Used in run-ci-e2e-test.js and executed in Circle CI.
//
// E2e test that verifies that init app can be installed, compiled, started and
// Hot Module reloading and Chrome debugging work.
//
// For other examples of appium refer to:
// https://github.com/appium/sample-code/tree/master/sample-code/examples/node and
// https://www.npmjs.com/package/wd-android
//
// To set up:
// - npm install --save-dev appium@1.11.1 mocha@2.4.5 wd@1.11.1 colors@1.0.3 pretty-data2@0.40.1
// - cp <this file> <to app installation path>
// - keytool -genkey -v -keystore android/app/debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000 -dname "CN=Android Debug,O=Android,C=US"
//
// To run this test:
// - npm start
// - node node_modules/.bin/appium
// - (cd android && ./gradlew :app:copyDownloadableDepsToLibs)
// - react-native run-android
// - node ../node_modules/.bin/_mocha ../android-e2e-test.js

/* eslint-env mocha */

'use strict';

const fs = require('fs');
const path = require('path');
const pd = require('pretty-data2').pd;
const wd = require('wd');

// value in ms to print out screen contents, set this value in CI to debug if tests are failing
const appiumDebugInterval = process.env.APPIUM_DEBUG_INTERVAL;

describe('Android Test App', function () {
  this.timeout(600000);
  let driver;
  let debugIntervalId;

  before(function () {
    driver = wd.promiseChainRemote({
      host: 'localhost',
      port: 4723,
    });
    driver.on('status', function (info) {
      console.log(info.cyan);
    });
    driver.on('command', function (method, command, data) {
      if (command === 'source()' && data) {
        console.log(
          ' > ' + method.yellow,
          'Screen contents'.grey,
          '\n',
          pd.xml(data).yellow,
        );
      } else {
        console.log(' > ' + method.yellow, command.grey, data || '');
      }
    });
    driver.on('http', function (method, urlPath, data) {
      console.log(' > ' + method.magenta, urlPath, (data || '').grey);
    });

    // every interval print what is on the screen
    if (appiumDebugInterval) {
      debugIntervalId = setInterval(() => {
        // it driver.on('command') will log the screen contents
        driver.source();
      }, appiumDebugInterval);
    }

    const desired = {
      platformName: 'Android',
      deviceName: 'Android Emulator',
      app: path.resolve('android/app/build/outputs/apk/debug/app-debug.apk'),
    };

    // React Native in dev mode often starts with Red Box "Can't fibd variable __fbBatchedBridge..."
    // This is fixed by clicking Reload JS which will trigger a request to Metro
    return driver
      .init(desired)
      .setImplicitWaitTimeout(5000)
      .waitForElementByXPath('//android.widget.Button[@text="Reload JS"]')
      .then(
        elem => {
          elem.click();
          driver.sleep(2000);
        },
        // eslint-disable-next-line handle-callback-err
        err => {
          // ignoring if Reload JS button can't be located
        },
      );
  });

  after(function () {
    if (debugIntervalId) {
      clearInterval(debugIntervalId);
    }
    return driver.quit();
  });

  it('should display new content after a refresh', function () {
    const androidAppCode = fs.readFileSync('App.js', 'utf-8');
    let intervalToUpdate;
    return (
      driver
        .waitForElementByXPath(
          '//android.widget.TextView[starts-with(@text, "Welcome to React")]',
        )
        .then(() => {
          fs.writeFileSync(
            'App.js',
            androidAppCode.replace('Step One', 'Step 1'),
            'utf-8',
          );
        })
        .sleep(1000)
        // http://developer.android.com/reference/android/view/KeyEvent.html#KEYCODE_MENU
        .pressDeviceKey(46)
        .pressDeviceKey(46)
        .sleep(2000)
        .waitForElementByXPath(
          '//android.widget.TextView[starts-with(@text, "Step 1")]',
        )
        .finally(() => {
          clearInterval(intervalToUpdate);
          fs.writeFileSync('App.js', androidAppCode, 'utf-8');
          driver.pressDeviceKey(46).pressDeviceKey(46).sleep(2000);
        })
    );
  });

  it('should have the menu available', function () {
    return (
      driver
        .waitForElementByXPath(
          '//android.widget.TextView[starts-with(@text, "Welcome to React")]',
        )
        // http://developer.android.com/reference/android/view/KeyEvent.html#KEYCODE_MENU
        .pressDeviceKey(82)
        .waitForElementByXPath(
          '//android.widget.TextView[starts-with(@text, "Toggle Inspector")]',
        )
    );
  });
});