@react-native-harness/cli 1.0.0-alpha.9 → 1.0.0-canary.1761729829908

package/src/errors/errorHandler.ts

@@ -1,196 +0,0 @@
-import {
-  ConfigLoadError,
-  ConfigNotFoundError,
-  ConfigValidationError,
-} from '@react-native-harness/config';
-import { AssertionError } from '../utils.js';
-import {
-  NoRunnerSpecifiedError,
-  RunnerNotFoundError,
-  EnvironmentInitializationError,
-  TestExecutionError,
-  RpcClientError,
-  AppNotInstalledError,
-  BridgeTimeoutError,
-  BundlingFailedError,
-} from './errors.js';
-
-export const handleError = (error: unknown): void => {
-  if (error instanceof AssertionError) {
-    console.error(`\n❌ Assertion Error`);
-    console.error(`\nError: ${error.message}`);
-    console.error(`\nPlease check your configuration and try again.`);
-  } else if (error instanceof ConfigValidationError) {
-    console.error(`\n❌ Configuration Error`);
-    console.error(`\nFile: ${error.filePath}`);
-    console.error(`\nValidation errors:`);
-    error.validationErrors.forEach((err) => {
-      console.error(`  • ${err}`);
-    });
-    console.error(`\nPlease fix the configuration errors and try again.`);
-  } else if (error instanceof ConfigNotFoundError) {
-    console.error(`\n❌ Configuration Not Found`);
-    console.error(
-      `\nCould not find 'rn-harness.config' in '${error.searchPath}' or any parent directories.`
-    );
-    console.error(`\nSupported file extensions: .js, .mjs, .cjs, .json`);
-    console.error(
-      `\nPlease create a configuration file or run from a directory that contains one.`
-    );
-  } else if (error instanceof ConfigLoadError) {
-    console.error(`\n❌ Configuration Load Error`);
-    console.error(`\nFile: ${error.filePath}`);
-    console.error(`Error: ${error.message}`);
-    if (error.cause) {
-      console.error(`\nCause: ${error.cause.message}`);
-    }
-    console.error(
-      `\nPlease check your configuration file syntax and try again.`
-    );
-  } else if (error instanceof NoRunnerSpecifiedError) {
-    console.error('\n❌ No runner specified');
-    console.error(
-      '\nPlease specify a runner name or set a defaultRunner in your config.'
-    );
-    console.error('\nUsage: react-native-harness test [runner-name] [pattern]');
-    console.error('\nAvailable runners:');
-    error.availableRunners.forEach((r) => {
-      console.error(`  • ${r.name} (${r.platform})`);
-    });
-    console.error(
-      '\nTo set a default runner, add "defaultRunner" to your config:'
-    );
-    console.error('  { "defaultRunner": "your-runner-name" }');
-  } else if (error instanceof RunnerNotFoundError) {
-    console.error(`\n❌ Runner "${error.runnerName}" not found`);
-    console.error('\nAvailable runners:');
-    error.availableRunners.forEach((r) => {
-      console.error(`  • ${r.name} (${r.platform})`);
-    });
-    console.error('\nTo add a new runner, update your rn-harness.config file.');
-  } else if (error instanceof EnvironmentInitializationError) {
-    console.error(`\n❌ Environment Initialization Error`);
-    console.error(`\nRunner: ${error.runnerName} (${error.platform})`);
-    console.error(`\nError: ${error.message}`);
-    if (error.details) {
-      console.error(`\nDetails: ${error.details}`);
-    }
-    console.error(`\nTroubleshooting steps:`);
-    console.error(
-      `  • Verify that ${error.platform} development environment is properly set up`
-    );
-    console.error(`  • Check that the app is built and ready for testing`);
-    console.error(`  • Ensure all required dependencies are installed`);
-    if (error.platform === 'ios') {
-      console.error(`  • Verify Xcode and iOS Simulator are working correctly`);
-    } else if (error.platform === 'android') {
-      console.error(
-        `  • Verify Android SDK and emulator are working correctly`
-      );
-    }
-    console.error(
-      `\nPlease check your environment configuration and try again.`
-    );
-  } else if (error instanceof TestExecutionError) {
-    console.error(`\n❌ Test Execution Error`);
-    console.error(`\nFile: ${error.testFile}`);
-    if (error.testSuite) {
-      console.error(`\nSuite: ${error.testSuite}`);
-    }
-    if (error.testName) {
-      console.error(`\nTest: ${error.testName}`);
-    }
-    console.error(`\nError: ${error.message}`);
-    console.error(`\nTroubleshooting steps:`);
-    console.error(`  • Check the test file syntax and logic`);
-    console.error(`  • Verify all test dependencies are available`);
-    console.error(`  • Ensure the app is in the expected state for the test`);
-    console.error(
-      `  • Check device/emulator logs for additional error details`
-    );
-    console.error(`\nPlease check your test file and try again.`);
-  } else if (error instanceof RpcClientError) {
-    console.error(`\n❌ RPC Client Error`);
-    console.error(`\nError: ${error.message}`);
-    if (error.bridgePort) {
-      console.error(`\nBridge Port: ${error.bridgePort}`);
-    }
-    if (error.connectionStatus) {
-      console.error(`\nConnection Status: ${error.connectionStatus}`);
-    }
-    console.error(`\nTroubleshooting steps:`);
-    console.error(`  • Verify the React Native app is running and connected`);
-    console.error(`  • Check that the bridge port is not blocked by firewall`);
-    console.error(
-      `  • Ensure the app has the React Native Harness runtime integrated`
-    );
-    console.error(`  • Try restarting the app and test harness`);
-    console.error(`\nPlease check your bridge connection and try again.`);
-  } else if (error instanceof AppNotInstalledError) {
-    console.error(`\n❌ App Not Installed`);
-    console.error(
-      `\nThe app "${error.bundleId}" is not installed on ${
-        error.platform === 'ios' ? 'simulator' : 'emulator'
-      } "${error.deviceName}".`
-    );
-    console.error(`\nTo resolve this issue:`);
-    if (error.platform === 'ios') {
-      console.error(
-        `  • Build and install the app: npx react-native run-ios --simulator="${error.deviceName}"`
-      );
-      console.error(
-        `  • Or install from Xcode: Open ios/*.xcworkspace and run the project`
-      );
-    } else {
-      console.error(
-        `  • Build and install the app: npx react-native run-android`
-      );
-      console.error(
-        `  • Or build manually: ./gradlew assembleDebug && adb install android/app/build/outputs/apk/debug/app-debug.apk`
-      );
-    }
-    console.error(`\nPlease install the app and try running the tests again.`);
-  } else if (error instanceof BundlingFailedError) {
-    console.error(`\n❌ Test File Bundling Error`);
-    console.error(`\nFile: ${error.modulePath}`);
-    console.error(`\nError: ${error.reason}`);
-    console.error(`\nTroubleshooting steps:`);
-    console.error(`  • Check the test file syntax and imports`);
-    console.error(`  • Verify all imported modules exist and are accessible`);
-    console.error(`  • Ensure the Metro bundler configuration is correct`);
-    console.error(`  • Check for any circular dependencies in the test file`);
-    console.error(`  • Verify that all required packages are installed`);
-    console.error(`\nPlease fix the bundling issues and try again.`);
-  } else if (error instanceof BridgeTimeoutError) {
-    console.error(`\n❌ Bridge Connection Timeout`);
-    console.error(
-      `\nThe bridge connection timed out after ${error.timeout}ms while waiting for the "${error.runnerName}" (${error.platform}) runner to be ready.`
-    );
-    console.error(`\nThis usually indicates that:`);
-    console.error(
-      `  • The React Native app failed to load or connect to the bridge`
-    );
-    console.error(`  • The app crashed during startup`);
-    console.error(
-      `  • Network connectivity issues between the app and the test harness`
-    );
-    console.error(`  • The app is taking longer than expected to initialize`);
-    console.error(`\nTo resolve this issue:`);
-    console.error(
-      `  • Check that the app is properly installed and can start normally`
-    );
-    console.error(
-      `  • Verify that the app has the React Native Harness runtime integrated`
-    );
-    console.error(`  • Check device/emulator logs for any startup errors`);
-    console.error(
-      `  • Ensure the test harness bridge port (3001) is not blocked`
-    );
-    console.error(
-      `\nIf the app needs more time to start, consider increasing the timeout in the configuration.`
-    );
-  } else {
-    console.error(`\n❌ Unexpected Error`);
-    console.error(error);
-  }
-};

package/src/errors/errors.ts

@@ -1,119 +0,0 @@
-import { TestRunnerConfig } from '@react-native-harness/config';
-
-export class NoRunnerSpecifiedError extends Error {
-  constructor(availableRunners: TestRunnerConfig[]) {
-    super('No runner specified');
-    this.name = 'NoRunnerSpecifiedError';
-    this.availableRunners = availableRunners;
-  }
-  availableRunners: TestRunnerConfig[];
-}
-
-export class RunnerNotFoundError extends Error {
-  constructor(runnerName: string, availableRunners: TestRunnerConfig[]) {
-    super(`Runner "${runnerName}" not found`);
-    this.name = 'RunnerNotFoundError';
-    this.runnerName = runnerName;
-    this.availableRunners = availableRunners;
-  }
-  runnerName: string;
-  availableRunners: TestRunnerConfig[];
-}
-
-export class EnvironmentInitializationError extends Error {
-  constructor(
-    message: string,
-    runnerName: string,
-    platform: string,
-    details?: string
-  ) {
-    super(
-      `Failed to initialize environment for "${runnerName}" (${platform}): ${message}`
-    );
-    this.name = 'EnvironmentInitializationError';
-    this.runnerName = runnerName;
-    this.platform = platform;
-    this.details = details;
-  }
-  runnerName: string;
-  platform: string;
-  details?: string;
-}
-
-export class TestExecutionError extends Error {
-  constructor(
-    testFile: string,
-    error: unknown,
-    testSuite?: string,
-    testName?: string
-  ) {
-    const errorMessage = error instanceof Error ? error.message : String(error);
-    const suiteInfo = testSuite ? ` in suite "${testSuite}"` : '';
-    const testInfo = testName ? ` test "${testName}"` : '';
-
-    super(
-      `Test execution failed for ${testFile}${suiteInfo}${testInfo}: ${errorMessage}`
-    );
-    this.name = 'TestExecutionError';
-    this.testFile = testFile;
-    this.testSuite = testSuite;
-    this.testName = testName;
-    this.originalError = error;
-  }
-  testFile: string;
-  testSuite?: string;
-  testName?: string;
-  originalError: unknown;
-}
-
-export class RpcClientError extends Error {
-  constructor(message: string, bridgePort?: number, connectionStatus?: string) {
-    const portInfo = bridgePort ? ` (port ${bridgePort})` : '';
-    const statusInfo = connectionStatus ? ` - Status: ${connectionStatus}` : '';
-
-    super(`RPC client error${portInfo}: ${message}${statusInfo}`);
-    this.name = 'RpcClientError';
-    this.bridgePort = bridgePort;
-    this.connectionStatus = connectionStatus;
-  }
-  bridgePort?: number;
-  connectionStatus?: string;
-}
-
-export class BridgeTimeoutError extends Error {
-  constructor(
-    public readonly timeout: number,
-    public readonly runnerName: string,
-    public readonly platform: string
-  ) {
-    super(
-      `Bridge connection timed out after ${timeout}ms while waiting for "${runnerName}" (${platform}) runner to be ready`
-    );
-    this.name = 'BridgeTimeoutError';
-  }
-}
-
-export class AppNotInstalledError extends Error {
-  constructor(
-    public readonly deviceName: string,
-    public readonly bundleId: string,
-    public readonly platform: 'ios' | 'android'
-  ) {
-    super(
-      `App "${bundleId}" is not installed on ${
-        platform === 'ios' ? 'simulator' : 'emulator'
-      } "${deviceName}"`
-    );
-    this.name = 'AppNotInstalledError';
-  }
-}
-
-export class BundlingFailedError extends Error {
-  constructor(
-    public readonly modulePath: string,
-    public readonly reason: string
-  ) {
-    super(`Bundling of ${modulePath} failed: ${reason}`);
-    this.name = 'BundlingFailedError';
-  }
-}

package/src/platforms/android/build.ts

@@ -1,49 +0,0 @@
-import path from 'node:path';
-import { spawn } from '@react-native-harness/tools';
-
-export const buildAndroidApp = async (): Promise<void> => {
-  await spawn('react-native', ['build-android', '--tasks', 'assembleDebug']);
-};
-
-export const installApp = async (deviceId: string): Promise<void> => {
-  await spawn('adb', [
-    '-s',
-    deviceId,
-    'install',
-    '-r',
-    path.join(
-      process.cwd(),
-      'android',
-      'app',
-      'build',
-      'outputs',
-      'apk',
-      'debug',
-      'app-debug.apk'
-    ),
-  ]);
-};
-
-export const killApp = async (
-  deviceId: string,
-  bundleId: string
-): Promise<void> => {
-  await spawn('adb', ['-s', deviceId, 'shell', 'am', 'force-stop', bundleId]);
-};
-
-export const runApp = async (
-  deviceId: string,
-  bundleId: string,
-  activityName: string
-): Promise<void> => {
-  await killApp(deviceId, bundleId);
-  await spawn('adb', [
-    '-s',
-    deviceId,
-    'shell',
-    'am',
-    'start',
-    '-n',
-    `${bundleId}/${activityName}`,
-  ]);
-};

package/src/platforms/android/device.ts

@@ -1,48 +0,0 @@
-import { spawn } from '@react-native-harness/tools';
-
-export const killApp = async (
-  deviceId: string,
-  bundleId: string
-): Promise<void> => {
-  await spawn('adb', ['-s', deviceId, 'shell', 'am', 'force-stop', bundleId]);
-};
-
-export const runApp = async (
-  deviceId: string,
-  bundleId: string
-): Promise<void> => {
-  await killApp(deviceId, bundleId);
-  await spawn('adb', [
-    '-s',
-    deviceId,
-    'shell',
-    'am',
-    'start',
-    '-n',
-    `${bundleId}/.MainActivity`,
-  ]);
-};
-
-export const isAppInstalled = async (
-  deviceId: string,
-  bundleId: string
-): Promise<boolean> => {
-  try {
-    const { stdout } = await spawn('adb', [
-      '-s',
-      deviceId,
-      'shell',
-      'pm',
-      'list',
-      'packages',
-      bundleId,
-    ]);
-    return stdout.trim() !== '';
-  } catch {
-    return false;
-  }
-};
-
-export const reversePort = async (port: number): Promise<void> => {
-  await spawn('adb', ['reverse', `tcp:${port}`, `tcp:${port}`]);
-};

package/src/platforms/android/emulator.ts

@@ -1,139 +0,0 @@
-import { spawn } from '@react-native-harness/tools';
-import { ChildProcess } from 'node:child_process';
-
-export type AndroidEmulatorStatus = 'running' | 'loading' | 'stopped';
-
-export const getEmulatorNameFromId = async (
-  emulatorId: string
-): Promise<string | null> => {
-  try {
-    const { stdout } = await spawn('adb', ['-s', emulatorId, 'emu', 'avd', 'name']);
-    const avdName = stdout.split('\n')[0].trim();
-    return avdName || null;
-  } catch {
-    return null;
-  }
-};
-
-export const getEmulatorDeviceId = async (
-  avdName: string
-): Promise<string | null> => {
-  try {
-    const { stdout } = await spawn('adb', ['devices']);
-    const lines = stdout.split('\n');
-
-    for (const line of lines) {
-      const parts = line.trim().split('\t');
-      if (parts.length === 2 && parts[0].startsWith('emulator-')) {
-        const emulatorId = parts[0].trim();
-        const name = await getEmulatorNameFromId(emulatorId);
-        if (name === avdName) {
-          return emulatorId;
-        }
-      }
-    }
-    return null;
-  } catch {
-    return null;
-  }
-};
-
-export const getEmulatorStatus = async (
-  avdName: string
-): Promise<AndroidEmulatorStatus> => {
-  const emulatorId = await getEmulatorDeviceId(avdName);
-  if (!emulatorId) {
-    return 'stopped';
-  }
-
-  try {
-    // Check if device is fully booted by checking boot completion
-    const { stdout } = await spawn('adb', ['-s', emulatorId, 'shell', 'getprop', 'sys.boot_completed']);
-    const bootCompleted = stdout.trim() === '1';
-    return bootCompleted ? 'running' : 'loading';
-  } catch {
-    return 'loading';
-  }
-};
-
-export const runEmulator = async (name: string): Promise<ChildProcess> => {
-  // Start the emulator
-  const process = spawn('emulator', ['-avd', name]);
-  const nodeChildProcess = await process.nodeChildProcess;
-
-  // Poll for emulator status until it's fully running
-  const checkStatus = async (): Promise<void> => {
-    const status = await getEmulatorStatus(name);
-
-    if (status === 'running') {
-      return;
-    } else if (status === 'loading') {
-      // Check again in 2 seconds
-      await new Promise(resolve => setTimeout(resolve, 2000));
-      await checkStatus();
-    } else {
-      // Still stopped, check again in 1 second
-      await new Promise(resolve => setTimeout(resolve, 1000));
-      await checkStatus();
-    }
-  };
-
-  // Start checking status after a brief delay to allow emulator to start
-  await new Promise(resolve => setTimeout(resolve, 3000));
-  await checkStatus();
-
-  return nodeChildProcess;
-};
-
-export const stopEmulator = async (avdName: string): Promise<void> => {
-  // First, get the emulator device ID
-  const emulatorId = await getEmulatorDeviceId(avdName);
-  if (!emulatorId) {
-    return; // No emulator running, nothing to stop
-  }
-
-  await stopEmulatorById(emulatorId);
-};
-
-const stopEmulatorById = async (emulatorId: string): Promise<void> => {
-  // Stop the emulator using the found ID
-  await spawn('adb', ['-s', emulatorId, 'emu', 'kill']);
-};
-
-export const isAppInstalled = async (
-  emulatorId: string,
-  bundleId: string
-): Promise<boolean> => {
-  try {
-    const { stdout } = await spawn('adb', ['-s', emulatorId, 'shell', 'pm', 'list', 'packages', bundleId]);
-    return stdout.trim() !== '';
-  } catch {
-    return false;
-  }
-};
-
-export const reversePort = async (port: number): Promise<void> => {
-  await spawn('adb', ['reverse', `tcp:${port}`, `tcp:${port}`]);
-};
-
-export const getEmulatorScreenshot = async (
-  emulatorId: string,
-  name: string = `${emulatorId}-${new Date()
-    .toISOString()
-    .replace(/:/g, '-')
-    .replace(/\//g, '-')}.png`
-): Promise<string> => {
-  // Use screencap to save directly to device, then pull the file
-  const devicePath = '/sdcard/screenshot.png';
-
-  // Take screenshot and save to device
-  await spawn('adb', ['-s', emulatorId, 'shell', 'screencap', '-p', devicePath]);
-
-  // Pull the file from device to local
-  await spawn('adb', ['-s', emulatorId, 'pull', devicePath, name]);
-
-  // Clean up the file on device
-  await spawn('adb', ['-s', emulatorId, 'shell', 'rm', devicePath]);
-
-  return name;
-};

package/src/platforms/android/index.ts

@@ -1,87 +0,0 @@
-import { type ChildProcess } from 'node:child_process';
-import {
-  assertAndroidRunnerConfig,
-  TestRunnerConfig,
-} from '@react-native-harness/config';
-import { logger } from '@react-native-harness/tools';
-
-import { type PlatformAdapter } from '../platform-adapter.js';
-import {
-  runEmulator,
-  getEmulatorDeviceId,
-  reversePort,
-  isAppInstalled,
-  getEmulatorStatus,
-} from './emulator.js';
-import { runApp, killApp } from './build.js';
-import { killWithAwait } from '../../process.js';
-import { runMetro } from '../../bundlers/metro.js';
-import { AppNotInstalledError } from '../../errors/errors.js';
-
-const androidPlatformAdapter: PlatformAdapter = {
-  name: 'android',
-  getEnvironment: async (runner: TestRunnerConfig) => {
-    assertAndroidRunnerConfig(runner);
-
-    let emulator: ChildProcess | null = null;
-    const emulatorStatus = await getEmulatorStatus(runner.deviceId);
-    logger.debug(`Emulator status: ${emulatorStatus}`);
-
-    const metroPromise = runMetro();
-
-    if (emulatorStatus === 'stopped') {
-      logger.debug(`Emulator ${runner.deviceId} is stopped, starting it`);
-      emulator = await runEmulator(runner.deviceId);
-    }
-
-    const deviceId = await getEmulatorDeviceId(runner.deviceId);
-    logger.debug(`Device ID: ${deviceId}`);
-
-    if (!deviceId) {
-      throw new Error('Emulator not found');
-    }
-
-    await Promise.all([
-      reversePort(8081),
-      reversePort(8080),
-      reversePort(3001),
-    ]);
-    logger.debug('Ports reversed');
-
-    const isInstalled = await isAppInstalled(deviceId, runner.bundleId);
-    logger.debug(`App is installed: ${isInstalled}`);
-
-    if (!isInstalled) {
-      throw new AppNotInstalledError(
-        runner.deviceId,
-        runner.bundleId,
-        'android'
-      );
-    }
-
-    logger.debug('Waiting for Metro to start');
-    const metro = await metroPromise;
-    logger.debug('Metro started');
-
-    logger.debug('Running app');
-    await runApp(deviceId, runner.bundleId, runner.activityName);
-    logger.debug('App running');
-
-    return {
-      restart: async () => {
-        await runApp(runner.deviceId, runner.bundleId, runner.activityName);
-      },
-      dispose: async () => {
-        await killApp(deviceId, runner.bundleId);
-
-        if (emulator) {
-          await killWithAwait(emulator);
-        }
-
-        await killWithAwait(metro);
-      },
-    };
-  },
-};
-
-export default androidPlatformAdapter;