detox/src/devices/allocation/drivers/android/emulator/AVDValidator.js

E2E tests and automation for mobile

const _ = require('lodash');

const DetoxRuntimeError = require('../../../../../errors/DetoxRuntimeError');
const environment = require('../../../../../utils/environment');
const logger = require('../../../../../utils/logger').child({ cat: 'device' });

const REQUIRED_EMULATOR_MAJOR = 29;

class AVDValidator {
  constructor(avdsResolver, emulatorVersionResolver) {
    this._avdsResolver = avdsResolver;
    this._emulatorVersionResolver = emulatorVersionResolver;
  }

  async validate(avdName, isHeadless) {
    const avds = await this._avdsResolver.resolve(avdName);
    this._assertAVDs(avds);
    await this._assertAVDMatch(avds, avdName);
    await this._validateEmulatorVer(isHeadless);
  }

  _assertAVDs(avds) {
    if (!avds) {
      const usageExample = `${environment.getAvdManagerPath()} create avd --force --name Pixel_API_28 --abi x86_64 --package "system-images;android-28;default;x86_64" --device "pixel"`;
      const message = 'Could not find any configured Android Emulator.';
      const hint = `Try creating a device first (example: ${usageExample}),`
        + ' or go to https://developer.android.com/studio/run/managing-avds.html for details on how to create an Emulator.';
      throw new DetoxRuntimeError({ message, hint });
    }
  }

  _assertAVDMatch(avds, avdName) {
    if (_.indexOf(avds, avdName) === -1) {
      const message = `Cannot boot Android Emulator with the name: '${avdName}'`;
      const hint = `Make sure you choose one of the available emulators: ${avds.toString()}`;
      throw new DetoxRuntimeError({ message, hint });
    }
  }

  async _validateEmulatorVer(isHeadless) {
    const emulatorVersion = await this._emulatorVersionResolver.resolve(isHeadless);
    if (!emulatorVersion) {
      logger.warn({ event: 'AVD_VALIDATION' }, 'Emulator version detection failed (See previous logs)');
      return;
    }

    if (emulatorVersion.major < REQUIRED_EMULATOR_MAJOR) {
      logger.warn({ event: 'AVD_VALIDATION' }, [
          `Your installed emulator binary version (${emulatorVersion}) is too old, and may not be suitable for parallel test execution.`,
          `We strongly recommend you upgrade to the latest version using the SDK manager: ${environment.getAndroidSdkManagerPath()} --list`
        ].join('\n'));
    }
  }
}

module.exports = AVDValidator;