feat(appium): prepare setup subcommand as shortcut for drivers/plugins installation

packages/appium/lib/cli/parser.js

@@ -11,7 +11,8 @@ import {
   EXT_SUBCOMMAND_UNINSTALL,
   EXT_SUBCOMMAND_UPDATE,
   PLUGIN_TYPE,
-  SERVER_SUBCOMMAND
+  SERVER_SUBCOMMAND,
+  SETUP_SUBCOMMAND
 } from '../constants';
 import {finalizeSchema, getArgSpec, hasArgSpec} from '../schema';
 import {rootDir} from '../config';
@@ -24,7 +25,7 @@ export const EXTRA_ARGS = 'extraArgs';
  * will automatially inject the `server` subcommand.
  */
 const NON_SERVER_ARGS = Object.freeze(
-  new Set([DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND, '-h', '--help', '-v', '--version'])
+  new Set([SETUP_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND, '-h', '--help', '-v', '--version'])
 );
 
 const version = fs.readPackageJsonFrom(rootDir).version;
@@ -76,6 +77,9 @@ class ArgParser {
 
     const subParsers = parser.add_subparsers({dest: 'subcommand'});
 
+    // add the 'setup' command
+    ArgParser._addSetupToParser(subParsers);
+
     // add the 'server' subcommand, and store the raw arguments on the parser
     // object as a way for other parts of the code to work with the arguments
     // conceptually rather than just through argparse
@@ -280,6 +284,35 @@ class ArgParser {
       }
     }
   }
+
+  /**
+   *
+   * @param {import('argparse').SubParser} subParser
+   */
+    static _addSetupToParser(subParser) {
+      const setupParser = subParser.add_parser('setup', {
+        add_help: true,
+        help: 'Install latest uiautomator2 and xcuitest driver if no APPIUM_HOME was empty',
+      });
+
+      ArgParser._patchExit(setupParser);
+      const extSubParsers = setupParser.add_subparsers({
+        dest: `setupCommand`,
+      });
+
+      const parserSpecs = [
+        {
+          command: 'all',
+          help: `Install all available known drivers and plugins`,
+          aliases: ['a'],
+        },
+      ];
+
+      for (const {command, help, aliases} of parserSpecs) {
+        const parser = extSubParsers.add_parser(command, {help, aliases: aliases ?? []});
+        ArgParser._patchExit(parser);
+      }
+    }
 }
 
 /**

packages/appium/lib/cli/setup-command.js

@@ -0,0 +1,71 @@
+import _ from 'lodash';
+import { KNOWN_DRIVERS, KNOWN_PLUGINS, SETUP_SUBCOMMAND } from '../constants';
+import {runExtensionCommand} from './extension';
+
+const DEFAULT_DRIVERS = ['uiautomator2', 'xcuitest'];
+const DEFAULT_PLUGINS = ['images'];
+
+const SUBCOMMAND_ALL = 'all';
+
+export async function setupCommand(appiumHome, configArgs, driverConfig, pluginConfig) {
+  if (!_.isEmpty(driverConfig.installedExtensions) || !_.isEmpty(pluginConfig.installedExtensions)) {
+    throw new Error(`'${SETUP_SUBCOMMAND}' will not run because '${appiumHome}' already has drivers: ${
+      _.isEmpty(driverConfig.installedExtensions)
+      ? '(no drivers)'
+      : _.join(_.keys(driverConfig.installedExtensions), ',')
+    }, plugins: ${
+      _.isEmpty(pluginConfig.installedExtensions)
+      ? '(no plugins)'
+      : _.join(_.keys(pluginConfig.installedExtensions), ',')
+    }`);
+  }
+
+  if (configArgs.setupCommand == SUBCOMMAND_ALL) {
+    await setupDriverFull(configArgs, driverConfig);
+    await setupPluginFull(configArgs, pluginConfig);
+    return;
+  }
+
+  await setupDriverDefault(configArgs, driverConfig);
+  await setupPluginDefault(configArgs, pluginConfig);
+};
+
+async function setupDriverDefault(configArgs, driverConfig) {
+  for (const driverName of DEFAULT_DRIVERS) {
+    await setupDriver(driverName, configArgs, driverConfig);
+  }
+}
+
+async function setupDriverFull(configArgs, driverConfig) {
+  for (const driver of _.keys(KNOWN_DRIVERS)) {
+    await setupDriver(driver, configArgs, driverConfig);
+  }
+}
+
+async function setupDriver(driverName, configArgs, driverConfig) {
+  const driverConfigArgs = configArgs;
+  driverConfigArgs.subcommand = 'driver';
+  driverConfigArgs.driverCommand = 'install';
+  driverConfigArgs.driver = driverName;
+  await runExtensionCommand(driverConfigArgs, driverConfig);
+}
+
+async function setupPluginDefault(configArgs, pluginConfig) {
+  for (const pluginName of DEFAULT_PLUGINS) {
+    await setupPlugin(pluginName, configArgs, pluginConfig);
+  }
+}
+
+async function setupPluginFull(configArgs, driverConfig) {
+  for (const pluginName of _.keys(KNOWN_PLUGINS)) {
+    await setupPlugin(pluginName, configArgs, driverConfig);
+  }
+}
+
+async function setupPlugin(pluginName, configArgs, pluginConfig) {
+  const pluginConfigArgs = configArgs;
+  pluginConfigArgs.subcommand = 'plugin';
+  pluginConfigArgs.pluginCommand = 'install';
+  pluginConfigArgs.plugin = pluginName;
+  await runExtensionCommand(pluginConfigArgs, pluginConfig);
+}

packages/appium/lib/constants.js

@@ -15,6 +15,12 @@ export const PLUGIN_TYPE = 'plugin';
  */
 export const SERVER_SUBCOMMAND = 'server';
 
+/**
+ * The `setup` command of the `appium` CLI
+ */
+export const SETUP_SUBCOMMAND = 'setup'
+
+
 /**
  * The value of `--use-plugins` if _all_ plugins should be loaded
  */

packages/appium/lib/main.js

@@ -13,6 +13,7 @@ import {asyncify} from 'asyncbox';
 import _ from 'lodash';
 import {AppiumDriver} from './appium';
 import {runExtensionCommand} from './cli/extension';
+import { setupCommand } from './cli/setup-command';
 import {getParser} from './cli/parser';
 import {
   APPIUM_VER,
@@ -25,7 +26,7 @@ import {
 } from './config';
 import {readConfigFile} from './config-file';
 import {loadExtensions, getActivePlugins, getActiveDrivers} from './extension';
-import {SERVER_SUBCOMMAND, LONG_STACKTRACE_LIMIT} from './constants';
+import {SERVER_SUBCOMMAND, LONG_STACKTRACE_LIMIT, SETUP_SUBCOMMAND} from './constants';
 import registerNode from './grid-register';
 import {getDefaultsForSchema, validate as validateSchema} from './schema/schema';
 import {
@@ -38,6 +39,7 @@ import {
   fetchInterfaces,
   V4_BROADCAST_IP,
   V6_BROADCAST_IP,
+  isSetupCommandArgs,
 } from './utils';
 import net from 'node:net';
 
@@ -216,7 +218,7 @@ async function init(args) {
   }
 
   // merge config and apply defaults.
-  // the order of precendece is:
+  // the order of precedence is:
   // 1. command line args
   // 2. config file
   // 3. defaults from config file.
@@ -276,6 +278,9 @@ async function init(args) {
       pluginConfig,
       appiumHome,
     });
+  } else if (isSetupCommandArgs(preConfigArgs)) {
+    await setupCommand(appiumHome, preConfigArgs, driverConfig, pluginConfig);
+    return /** @type {InitResult<Cmd>} */ ({});
   } else {
     await requireDir(appiumHome, true, appiumHomeSourceName);
     if (isExtensionCommandArgs(preConfigArgs)) {

packages/appium/lib/utils.js

@@ -4,7 +4,7 @@ import {processCapabilities, PROTOCOLS, STANDARD_CAPS, errors} from '@appium/bas
 import {inspect as dump} from 'util';
 import {node, fs} from '@appium/support';
 import path from 'path';
-import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE} from './constants';
+import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE, SETUP_SUBCOMMAND} from './constants';
 import os from 'node:os';
 
 const W3C_APPIUM_PREFIX = 'appium';
@@ -330,6 +330,10 @@ export function isServerCommandArgs(args) {
   return args.subcommand === SERVER_SUBCOMMAND;
 }
 
+export function isSetupCommandArgs(args) {
+  return args.subcommand === SETUP_SUBCOMMAND;
+}
+
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
  * @template {CliExtensionSubcommand|void} [SubCmd=void]