Switch CLI to yargs

detox/__tests__/setupJest.js

@@ -0,0 +1,28 @@
+const yargs = require('yargs');
+const path = require('path');
+
+function callCli(modulePath, cmd) {
+  return new Promise((resolve, reject) => {
+    try {
+      yargs
+        .scriptName('detox')
+        .command(require(path.join(__dirname, "../local-cli", modulePath)))
+        .exitProcess(false)
+        .fail((msg, err) => reject(err || msg))
+        .parse(cmd, (err, argv, output) => {
+          err ? reject(err) : setImmediate(() => resolve(output));
+        });
+    } catch (e) {
+      reject(e);
+    }
+  });
+}
+
+function mockPackageJson(mockContent) {
+  jest.mock(path.join(process.cwd(), 'package.json'), () => ({
+    detox: mockContent
+  }));
+}
+
+global.mockPackageJson = mockPackageJson;
+global.callCli = callCli;

detox/local-cli/__snapshots__/build.test.js.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`build fails with multiple configs if none is selected 1`] = `
+"Cannot determine which configuration to use. Use --configuration to choose one of the following:
+* only
+* myconf"
+`;
+
+exports[`build fails without build script 1`] = `"Could not find build script in detox.configurations[\\"only\\"].build"`;
+
+exports[`build fails without build script and configuration 1`] = `"Could not find build script in detox.configurations[\\"only\\"].build"`;
+
+exports[`build fails without configurations 1`] = `"There are no \\"configurations\\" in \\"detox\\" section of package.json"`;

detox/local-cli/__snapshots__/run-server.test.js.snap

@@ -0,0 +1,7 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`run-server throws if the port number is out of range 1`] = `"The port should be between 1 and 65535, got NaN"`;
+
+exports[`run-server throws if the port number is out of range 2`] = `"The port should be between 1 and 65535, got 0"`;
+
+exports[`run-server throws if the port number is out of range 3`] = `"The port should be between 1 and 65535, got 100000"`;

detox/local-cli/__snapshots__/test.test.js.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`test fails with a different runner 1`] = `"ava is not supported in detox cli tools. You can still run your tests with the runner's own cli tool"`;

detox/local-cli/build-framework-cache.js

@@ -0,0 +1,10 @@
+const path = require('path');
+const cp = require('child_process');
+const log = require('../src/utils/logger').child({ __filename });
+
+module.exports.command = 'build-framework-cache';
+module.exports.desc = 'MacOS only. Build Detox.framework to ~/Library/Detox. The framework cache is specific for each combination of Xcode and Detox versions';
+
+module.exports.handler = async function buildFrameworkCache() {
+  cp.execSync(path.join(__dirname, '../scripts/build_framework.ios.sh'), {stdio: 'inherit'});
+};

detox/local-cli/build.js

@@ -0,0 +1,27 @@
+const _ = require('lodash');
+const cp = require('child_process');
+const log = require('../src/utils/logger').child({ __filename });
+const {getDefaultConfiguration, getConfigurationByKey} = require('./utils/configurationUtils');
+
+module.exports.command = 'build';
+module.exports.desc = "Convenience method. Run the command defined in 'build' property of the specified configuration.";
+module.exports.builder = {
+  c: {
+    alias: 'configuration',
+    group: 'Configuration:',
+    describe:
+      "Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it",
+    default: getDefaultConfiguration(),
+  }
+};
+
+module.exports.handler = async function build(argv) {
+  const buildScript = getConfigurationByKey(argv.configuration).build;
+
+  if (buildScript) {
+    log.info(buildScript);
+    cp.execSync(buildScript, { stdio: 'inherit' });
+  } else {
+    throw new Error(`Could not find build script in detox.configurations["${argv.configuration}"].build`);
+  }
+};

detox/local-cli/build.test.js

@@ -0,0 +1,85 @@
+jest.mock('../src/utils/logger');
+
+describe('build', () => {
+  let mockExec;
+  beforeEach(() => {
+    mockExec = jest.fn();
+    jest.mock('child_process', () => ({
+      execSync: mockExec
+    }));
+  });
+
+  it('runs the build script if there is only one config', async () => {
+    mockPackageJson({
+      configurations: {
+        only: {
+          build: 'echo "only"'
+        }
+      }
+    });
+
+    await callCli('./build', 'build');
+    expect(mockExec).toHaveBeenCalledWith(expect.stringContaining('only'), expect.anything());
+  });
+
+  it('runs the build script of selected config', async () => {
+    mockPackageJson({
+      configurations: {
+        only: {
+          build: 'echo "only"'
+        },
+        myconf: {
+          build: 'echo "myconf"'
+        }
+      }
+    });
+
+    await callCli('./build', 'build -c myconf');
+    expect(mockExec).toHaveBeenCalledWith(expect.stringContaining('myconf'), expect.anything());
+  });
+
+  it('fails with multiple configs if none is selected', async () => {
+    mockPackageJson({
+      configurations: {
+        only: {
+          build: 'echo "only"'
+        },
+        myconf: {
+          build: 'echo "myconf"'
+        }
+      }
+    });
+
+    await expect(callCli('./build', 'build')).rejects.toThrowErrorMatchingSnapshot();
+    expect(mockExec).not.toHaveBeenCalled();
+  });
+
+  it('fails without configurations', async () => {
+    mockPackageJson({});
+
+    await expect(callCli('./build', 'build')).rejects.toThrowErrorMatchingSnapshot();
+    expect(mockExec).not.toHaveBeenCalled();
+  });
+
+  it('fails without build script', async () => {
+    mockPackageJson({
+      configurations: {
+        only: {}
+      }
+    });
+
+    await expect(callCli('./build', 'build -c only')).rejects.toThrowErrorMatchingSnapshot();
+    expect(mockExec).not.toHaveBeenCalled();
+  });
+
+  it('fails without build script and configuration', async () => {
+    mockPackageJson({
+      configurations: {
+        only: {}
+      }
+    });
+
+    await expect(callCli('./build', 'build')).rejects.toThrowErrorMatchingSnapshot();
+    expect(mockExec).not.toHaveBeenCalled();
+  });
+});

detox/local-cli/clean-framework-cache.js

@@ -0,0 +1,17 @@
+const fs = require('fs-extra');
+const path = require('path');
+const os = require('os');
+const log = require('../src/utils/logger').child({ __filename });
+
+module.exports.command = 'clean-framework-cache';
+module.exports.desc = "MacOS only. Delete all compiled framework binaries from ~/Library/Detox, they will be rebuilt on 'npm install' or when running 'build-framework-cache'";
+
+module.exports.handler = async function cleanFrameworkCache() {
+  if (os.platform() === 'darwin') {
+    const frameworkPath = path.join(os.homedir(), '/Library/Detox');
+    log.info(`Removing framework binaries from ${frameworkPath}`);
+    await fs.remove(frameworkPath);
+  } else {
+    log.info(`The command is supported only on MacOS, skipping the execution.`);
+  }
+};

detox/local-cli/cli.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+const yargs = require('yargs');
+const logger = require('../src/utils/logger').child({ __filename });
+
+yargs
+  .scriptName('detox')
+  .parserConfiguration({
+    'boolean-negation': false,
+    'dot-notation': false,
+    'duplicate-arguments-array': false,
+  })
+  .commandDir('./', {
+    exclude: function(path) {
+      // This is a test file
+      return /\.test\.js$/.test(path);
+    }
+  })
+  .demandCommand()
+  .recommendCommands()
+  .help()
+  .wrap(yargs.terminalWidth() * 0.9)
+  .fail((_msg, err) => {
+    const lines = (err ? err.toString() : msg).split('\n');
+    for (const line of lines) {
+      logger.error(line);
+    }
+  })
+  .parse();