How to use parseSecurityFeatures method in Appium

1import fs from 'fs';2import path from 'path';3import _ from 'lodash';4import { ArgumentParser } from 'argparse';5import { rootDir } from './utils';6import { DEFAULT_BASE_PATH } from 'appium-base-driver';7import {8  StoreDeprecatedAction, StoreDeprecatedTrueAction,9  StoreDeprecatedDefaultCapabilityAction, StoreDeprecatedDefaultCapabilityTrueAction,10  DEFAULT_CAPS_ARG,11} from './argsparse-actions';12const args = [13  [['--shell'], {14    required: false,15    default: false,16    action: 'store_true',17    help: 'Enter REPL mode',18    dest: 'shell',19  }],20  [['--allow-cors'], {21    required: false,22    default: false,23    action: 'store_true',24    help: 'Whether the Appium server should allow web browser connections from any host',25    dest: 'allowCors',26  }],27  [['--reboot'], {28    default: false,29    dest: 'reboot',30    action: 'store_true',31    required: false,32    help: '(Android-only) reboot emulator after each session and kill it at the end',33  }],34  [['--ipa'], {35    required: false,36    default: null,37    help: '(IOS-only) abs path to compiled .ipa file',38    dest: 'ipa',39  }],40  [['-a', '--address'], {41    default: '0.0.0.0',42    required: false,43    help: 'IP Address to listen on',44    dest: 'address',45  }],46  [['-p', '--port'], {47    default: 4723,48    required: false,49    type: 'int',50    help: 'port to listen on',51    dest: 'port',52  }],53  [['-pa', '--base-path'], {54    required: false,55    default: DEFAULT_BASE_PATH,56    dest: 'basePath',57    help: 'Base path to use as the prefix for all webdriver routes running' +58          'on this server'59  }],60  [['-ka', '--keep-alive-timeout'], {61    required: false,62    default: null,63    dest: 'keepAliveTimeout',64    type: 'int',65    help: 'Number of seconds the Appium server should apply as both the keep-alive timeout ' +66          'and the connection timeout for all requests. Defaults to 600 (10 minutes).'67  }],68  [['-ca', '--callback-address'], {69    required: false,70    dest: 'callbackAddress',71    default: null,72    help: 'callback IP Address (default: same as --address)',73  }],74  [['-cp', '--callback-port'], {75    required: false,76    dest: 'callbackPort',77    default: null,78    type: 'int',79    help: 'callback port (default: same as port)',80  }],81  [['-bp', '--bootstrap-port'], {82    default: 4724,83    dest: 'bootstrapPort',84    required: false,85    type: 'int',86    help: '(Android-only) port to use on device to talk to Appium',87  }],88  [['-r', '--backend-retries'], {89    default: 3,90    dest: 'backendRetries',91    required: false,92    type: 'int',93    help: '(iOS-only) How many times to retry launching Instruments ' +94          'before saying it crashed or timed out',95  }],96  [['--session-override'], {97    default: false,98    dest: 'sessionOverride',99    action: 'store_true',100    required: false,101    help: 'Enables session override (clobbering)',102  }],103  [['-l', '--pre-launch'], {104    default: false,105    dest: 'launch',106    action: 'store_true',107    required: false,108    help: 'Pre-launch the application before allowing the first session ' +109          '(Requires --app and, for Android, --app-pkg and --app-activity)',110  }],111  [['-g', '--log'], {112    default: null,113    dest: 'logFile',114    required: false,115    help: 'Also send log output to this file',116  }],117  [['--log-level'], {118    choices: [119      'info', 'info:debug', 'info:info', 'info:warn', 'info:error',120      'warn', 'warn:debug', 'warn:info', 'warn:warn', 'warn:error',121      'error', 'error:debug', 'error:info', 'error:warn', 'error:error',122      'debug', 'debug:debug', 'debug:info', 'debug:warn', 'debug:error',123    ],124    default: 'debug',125    dest: 'loglevel',126    required: false,127    help: 'log level; default (console[:file]): debug[:debug]',128  }],129  [['--log-timestamp'], {130    default: false,131    required: false,132    help: 'Show timestamps in console output',133    action: 'store_true',134    dest: 'logTimestamp',135  }],136  [['--local-timezone'], {137    default: false,138    required: false,139    help: 'Use local timezone for timestamps',140    action: 'store_true',141    dest: 'localTimezone',142  }],143  [['--log-no-colors'], {144    default: false,145    required: false,146    help: 'Do not use colors in console output',147    action: 'store_true',148    dest: 'logNoColors',149  }],150  [['-G', '--webhook'], {151    default: null,152    required: false,153    dest: 'webhook',154    help: 'Also send log output to this HTTP listener, for example localhost:9876',155  }],156  [['--safari'], {157    default: false,158    action: 'store_true',159    dest: 'safari',160    required: false,161    help: '(IOS-Only) Use the safari app',162  }],163  [['--default-device', '-dd'], {164    dest: 'defaultDevice',165    default: false,166    action: 'store_true',167    required: false,168    help: '(IOS-Simulator-only) use the default simulator that instruments ' +169          'launches on its own',170  }],171  [['--force-iphone'], {172    default: false,173    dest: 'forceIphone',174    action: 'store_true',175    required: false,176    help: '(IOS-only) Use the iPhone Simulator no matter what the app wants',177  }],178  [['--force-ipad'], {179    default: false,180    dest: 'forceIpad',181    action: 'store_true',182    required: false,183    help: '(IOS-only) Use the iPad Simulator no matter what the app wants',184  }],185  [['--tracetemplate'], {186    default: null,187    dest: 'automationTraceTemplatePath',188    required: false,189    help: '(IOS-only) .tracetemplate file to use with Instruments',190  }],191  [['--instruments'], {192    default: null,193    dest: 'instrumentsPath',194    required: false,195    help: '(IOS-only) path to instruments binary',196  }],197  [['--nodeconfig'], {198    required: false,199    default: null,200    dest: 'nodeconfig',201    help: 'Configuration JSON file to register appium with selenium grid',202  }],203  [['-ra', '--robot-address'], {204    default: '0.0.0.0',205    dest: 'robotAddress',206    required: false,207    help: 'IP Address of robot',208  }],209  [['-rp', '--robot-port'], {210    default: -1,211    dest: 'robotPort',212    required: false,213    type: 'int',214    help: 'port for robot',215  }],216  [['--chromedriver-executable'], {217    default: null,218    dest: 'chromedriverExecutable',219    required: false,220    help: 'ChromeDriver executable full path',221  }],222  [['--show-config'], {223    default: false,224    dest: 'showConfig',225    action: 'store_true',226    required: false,227    help: 'Show info about the appium server configuration and exit',228  }],229  [['--no-perms-check'], {230    default: false,231    dest: 'noPermsCheck',232    action: 'store_true',233    required: false,234    help: 'Bypass Appium\'s checks to ensure we can read/write necessary files',235  }],236  [['--strict-caps'], {237    default: false,238    dest: 'enforceStrictCaps',239    action: 'store_true',240    required: false,241    help: 'Cause sessions to fail if desired caps are sent in that Appium ' +242          'does not recognize as valid for the selected device',243  }],244  [['--isolate-sim-device'], {245    default: false,246    dest: 'isolateSimDevice',247    action: 'store_true',248    required: false,249    help: 'Xcode 6 has a bug on some platforms where a certain simulator ' +250          'can only be launched without error if all other simulator devices ' +251          'are first deleted. This option causes Appium to delete all ' +252          'devices other than the one being used by Appium. Note that this ' +253          'is a permanent deletion, and you are responsible for using simctl ' +254          'or xcode to manage the categories of devices used with Appium.',255  }],256  [['--tmp'], {257    default: null,258    dest: 'tmpDir',259    required: false,260    help: 'Absolute path to directory Appium can use to manage temporary ' +261          'files, like built-in iOS apps it needs to move around. On *nix/Mac ' +262          'defaults to /tmp, on Windows defaults to C:\\Windows\\Temp',263  }],264  [['--trace-dir'], {265    default: null,266    dest: 'traceDir',267    required: false,268    help: 'Absolute path to directory Appium use to save ios instruments ' +269          'traces, defaults to <tmp dir>/appium-instruments',270  }],271  [['--debug-log-spacing'], {272    dest: 'debugLogSpacing',273    default: false,274    action: 'store_true',275    required: false,276    help: 'Add exaggerated spacing in logs to help with visual inspection',277  }],278  [['--suppress-adb-kill-server'], {279    dest: 'suppressKillServer',280    default: false,281    action: 'store_true',282    required: false,283    help: '(Android-only) If set, prevents Appium from killing the adb server instance',284  }],285  [['--long-stacktrace'], {286    dest: 'longStacktrace',287    default: false,288    required: false,289    action: 'store_true',290    help: 'Add long stack traces to log entries. Recommended for debugging only.',291  }],292  [['--webkit-debug-proxy-port'], {293    default: 27753,294    dest: 'webkitDebugProxyPort',295    required: false,296    type: 'int',297    help: '(IOS-only) Local port used for communication with ios-webkit-debug-proxy'298  }],299  [['--webdriveragent-port'], {300    default: 8100,301    dest: 'wdaLocalPort',302    required: false,303    type: 'int',304    help: '(IOS-only, XCUITest-only) Local port used for communication with WebDriverAgent'305  }],306  [['-dc', DEFAULT_CAPS_ARG], {307    dest: 'defaultCapabilities',308    default: {},309    type: parseDefaultCaps,310    required: false,311    help: 'Set the default desired capabilities, which will be set on each ' +312          'session unless overridden by received capabilities. For example: ' +313          '[ \'{"app": "myapp.app", "deviceName": "iPhone Simulator"}\' ' +314          '| /path/to/caps.json ]'315  }],316  [['--relaxed-security'], {317    default: false,318    dest: 'relaxedSecurityEnabled',319    action: 'store_true',320    required: false,321    help: 'Disable additional security checks, so it is possible to use some advanced features, provided ' +322          'by drivers supporting this option. Only enable it if all the ' +323          'clients are in the trusted network and it\'s not the case if a client could potentially ' +324          'break out of the session sandbox. Specific features can be overridden by ' +325          'using the --deny-insecure flag',326  }],327  [['--allow-insecure'], {328    dest: 'allowInsecure',329    default: [],330    type: parseSecurityFeatures,331    required: false,332    help: 'Set which insecure features are allowed to run in this server\'s sessions. ' +333          'Features are defined on a driver level; see documentation for more details. ' +334          'This should be either a comma-separated list of feature names, or a path to ' +335          'a file where each feature name is on a line. Note that features defined via ' +336          '--deny-insecure will be disabled, even if also listed here. For example: ' +337          'execute_driver_script,adb_shell',338  }],339  [['--deny-insecure'], {340    dest: 'denyInsecure',341    default: [],342    type: parseSecurityFeatures,343    required: false,344    help: 'Set which insecure features are not allowed to run in this server\'s sessions. ' +345          'Features are defined on a driver level; see documentation for more details. ' +346          'This should be either a comma-separated list of feature names, or a path to ' +347          'a file where each feature name is on a line. Features listed here will not be ' +348          'enabled even if also listed in --allow-insecure, and even if --relaxed-security ' +349          'is turned on. For example: execute_driver_script,adb_shell',350  }],351  [['--command-timeout'], {352    default: 60,353    dest: 'defaultCommandTimeout',354    type: 'int',355    required: false,356    deprecated_for: 'newCommandTimeout capability',357    action: StoreDeprecatedAction,358    help: 'No effect. This used to be the default command ' +359          'timeout for the server to use for all sessions (in seconds and ' +360          'should be less than 2147483). Use newCommandTimeout cap instead'361  }],362  [['-k', '--keep-artifacts'], {363    default: false,364    dest: 'keepArtifacts',365    action: StoreDeprecatedTrueAction,366    required: false,367    help: 'No effect, trace is now in tmp dir by default and is ' +368          'cleared before each run. Please also refer to the --trace-dir flag.',369  }],370  [['--platform-name'], {371    dest: 'platformName',372    default: null,373    required: false,374    action: StoreDeprecatedDefaultCapabilityAction,375    help: 'Name of the mobile platform: iOS, Android, or FirefoxOS',376  }],377  [['--platform-version'], {378    dest: 'platformVersion',379    default: null,380    required: false,381    action: StoreDeprecatedDefaultCapabilityAction,382    help: 'Version of the mobile platform',383  }],384  [['--automation-name'], {385    dest: 'automationName',386    default: null,387    required: false,388    action: StoreDeprecatedDefaultCapabilityAction,389    help: 'Name of the automation tool: Appium, XCUITest, etc.',390  }],391  [['--device-name'], {392    dest: 'deviceName',393    default: null,394    required: false,395    action: StoreDeprecatedDefaultCapabilityAction,396    help: 'Name of the mobile device to use, for example: ' +397          'iPhone Retina (4-inch), Android Emulator',398  }],399  [['--browser-name'], {400    dest: 'browserName',401    default: null,402    required: false,403    action: StoreDeprecatedDefaultCapabilityAction,404    help: 'Name of the mobile browser: Safari or Chrome',405  }],406  [['--app'], {407    dest: 'app',408    required: false,409    default: null,410    action: StoreDeprecatedDefaultCapabilityAction,411    help: 'IOS: abs path to simulator-compiled .app file or the ' +412          'bundle_id of the desired target on device; Android: abs path to .apk file',413  }],414  [['-lt', '--launch-timeout'], {415    default: 90000,416    dest: 'launchTimeout',417    type: 'int',418    required: false,419    action: StoreDeprecatedDefaultCapabilityAction,420    help: '(iOS-only) how long in ms to wait for Instruments to launch',421  }],422  [['--language'], {423    default: null,424    dest: 'language',425    required: false,426    action: StoreDeprecatedDefaultCapabilityAction,427    help: 'Language for the iOS simulator / Android Emulator, like: en, es',428  }],429  [['--locale'], {430    default: null,431    dest: 'locale',432    required: false,433    action: StoreDeprecatedDefaultCapabilityAction,434    help: 'Locale for the iOS simulator / Android Emulator, like en_US, de_DE',435  }],436  [['-U', '--udid'], {437    dest: 'udid',438    required: false,439    default: null,440    action: StoreDeprecatedDefaultCapabilityAction,441    help: 'Unique device identifier of the connected physical device',442  }],443  [['--orientation'], {444    dest: 'orientation',445    default: null,446    required: false,447    action: StoreDeprecatedDefaultCapabilityAction,448    help: '(IOS-only) use LANDSCAPE or PORTRAIT to initialize all requests ' +449          'to this orientation',450  }],451  [['--no-reset'], {452    default: false,453    dest: 'noReset',454    action: StoreDeprecatedDefaultCapabilityTrueAction,455    required: false,456    help: 'Do not reset app state between sessions (IOS: do not delete app ' +457          'plist files; Android: do not uninstall app before new session)',458  }],459  [['--full-reset'], {460    default: false,461    dest: 'fullReset',462    action: StoreDeprecatedDefaultCapabilityTrueAction,463    required: false,464    help: '(iOS) Delete the entire simulator folder. (Android) Reset app ' +465          'state by uninstalling app instead of clearing app data. On ' +466          'Android, this will also remove the app after the session is complete.',467  }],468  [['--app-pkg'], {469    dest: 'appPackage',470    default: null,471    required: false,472    action: StoreDeprecatedDefaultCapabilityAction,473    help: '(Android-only) Java package of the Android app you want to run ' +474          '(e.g., com.example.android.myApp)',475  }],476  [['--app-activity'], {477    dest: 'appActivity',478    default: null,479    required: false,480    action: StoreDeprecatedDefaultCapabilityAction,481    help: '(Android-only) Activity name for the Android activity you want ' +482          'to launch from your package (e.g., MainActivity)',483  }],484  [['--app-wait-package'], {485    dest: 'appWaitPackage',486    default: false,487    required: false,488    action: StoreDeprecatedDefaultCapabilityAction,489    help: '(Android-only) Package name for the Android activity you want ' +490          'to wait for (e.g., com.example.android.myApp)',491  }],492  [['--app-wait-activity'], {493    dest: 'appWaitActivity',494    default: false,495    required: false,496    action: StoreDeprecatedDefaultCapabilityAction,497    help: '(Android-only) Activity name for the Android activity you want ' +498          'to wait for (e.g., SplashActivity)',499  }],500  [['--device-ready-timeout'], {501    dest: 'deviceReadyTimeout',502    default: 5,503    required: false,504    type: 'int',505    action: StoreDeprecatedDefaultCapabilityAction,506    help: '(Android-only) Timeout in seconds while waiting for device to become ready',507  }],508  [['--android-coverage'], {509    dest: 'androidCoverage',510    default: false,511    required: false,512    action: StoreDeprecatedDefaultCapabilityAction,513    help: '(Android-only) Fully qualified instrumentation class. Passed to -w in ' +514          'adb shell am instrument -e coverage true -w ' +515          '(e.g. com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation)',516  }],517  [['--avd'], {518    dest: 'avd',519    default: null,520    required: false,521    action: StoreDeprecatedDefaultCapabilityAction,522    help: '(Android-only) Name of the avd to launch (e.g. @Nexus_5)',523  }],524  [['--avd-args'], {525    dest: 'avdArgs',526    default: null,527    required: false,528    action: StoreDeprecatedDefaultCapabilityAction,529    help: '(Android-only) Additional emulator arguments to launch the avd (e.g. -no-snapshot-load)',530  }],531  [['--use-keystore'], {532    default: false,533    dest: 'useKeystore',534    action: StoreDeprecatedDefaultCapabilityTrueAction,535    required: false,536    help: '(Android-only) When set the keystore will be used to sign apks.',537  }],538  [['--keystore-path'], {539    default: path.resolve(process.env.HOME || process.env.USERPROFILE || '', '.android', 'debug.keystore'),540    dest: 'keystorePath',541    required: false,542    action: StoreDeprecatedDefaultCapabilityAction,543    help: '(Android-only) Path to keystore',544  }],545  [['--keystore-password'], {546    default: 'android',547    dest: 'keystorePassword',548    required: false,549    action: StoreDeprecatedDefaultCapabilityAction,550    help: '(Android-only) Password to keystore',551  }],552  [['--key-alias'], {553    default: 'androiddebugkey',554    dest: 'keyAlias',555    required: false,556    action: StoreDeprecatedDefaultCapabilityAction,557    help: '(Android-only) Key alias',558  }],559  [['--key-password'], {560    default: 'android',561    dest: 'keyPassword',562    required: false,563    action: StoreDeprecatedDefaultCapabilityAction,564    help: '(Android-only) Key password',565  }],566  [['--intent-action'], {567    dest: 'intentAction',568    default: 'android.intent.action.MAIN',569    required: false,570    action: StoreDeprecatedDefaultCapabilityAction,571    help: '(Android-only) Intent action which will be used to start activity (e.g. android.intent.action.MAIN)',572  }],573  [['--intent-category'], {574    dest: 'intentCategory',575    default: 'android.intent.category.LAUNCHER',576    required: false,577    action: StoreDeprecatedDefaultCapabilityAction,578    help: '(Android-only) Intent category which will be used to start activity ' +579          '(e.g. android.intent.category.APP_CONTACTS)',580  }],581  [['--intent-flags'], {582    dest: 'intentFlags',583    default: '0x10200000',584    required: false,585    action: StoreDeprecatedDefaultCapabilityAction,586    help: '(Android-only) Flags that will be used to start activity (e.g. 0x10200000)',587  }],588  [['--intent-args'], {589    dest: 'optionalIntentArguments',590    default: null,591    required: false,592    action: StoreDeprecatedDefaultCapabilityAction,593    help: '(Android-only) Additional intent arguments that will be used to start activity  (e.g. 0x10200000)',594  }],595  [['--dont-stop-app-on-reset'], {596    dest: 'dontStopAppOnReset',597    default: false,598    required: false,599    action: StoreDeprecatedDefaultCapabilityTrueAction,600    help: '(Android-only) When included, refrains from stopping the app before restart',601  }],602  [['--calendar-format'], {603    default: null,604    dest: 'calendarFormat',605    required: false,606    action: StoreDeprecatedDefaultCapabilityAction,607    help: '(IOS-only) calendar format for the iOS simulator (e.g. gregorian)',608  }],609  [['--native-instruments-lib'], {610    default: false,611    dest: 'nativeInstrumentsLib',612    action: StoreDeprecatedDefaultCapabilityTrueAction,613    required: false,614    help: '(IOS-only) IOS has a weird built-in unavoidable ' +615          'delay. We patch this in appium. If you do not want it patched, pass in this flag.',616  }],617  [['--keep-keychains'], {618    default: false,619    dest: 'keepKeyChains',620    action: StoreDeprecatedDefaultCapabilityTrueAction,621    required: false,622    help: '(iOS-only) Whether to keep keychains ' +623          '(Library/Keychains) when reset app between sessions',624  }],625  [['--localizable-strings-dir'], {626    required: false,627    dest: 'localizableStringsDir',628    default: 'en.lproj',629    action: StoreDeprecatedDefaultCapabilityAction,630    help: '(IOS-only) the relative path of the dir where Localizable.strings file resides (e.g. en.lproj)',631  }],632  [['--show-ios-log'], {633    default: false,634    dest: 'showIOSLog',635    action: StoreDeprecatedDefaultCapabilityTrueAction,636    required: false,637    help: '(IOS-only) if set, the iOS system log will be written to the console',638  }],639  [['--async-trace'], {640    dest: 'longStacktrace',641    default: false,642    required: false,643    action: StoreDeprecatedDefaultCapabilityTrueAction,644    help: 'Add long stack traces to log entries. Recommended for debugging only.',645  }],646  [['--chromedriver-port'], {647    default: null,648    dest: 'chromedriverPort',649    required: false,650    type: 'int',651    action: StoreDeprecatedDefaultCapabilityAction,652    help: 'Port upon which ChromeDriver will run. If not given, ' +653          'Android driver will pick a random available port.',654  }],655  [['--log-filters'], {656    dest: 'logFilters',657    default: null,658    required: false,659    help: 'Set the full path to a JSON file containing one or more log filtering rules',660  }],661];662function parseSecurityFeatures (features) {663  const splitter = (splitOn, str) => `${str}`.split(splitOn)664    .map((s) => s.trim())665    .filter(Boolean);666  let parsedFeatures;667  try {668    parsedFeatures = splitter(',', features);669  } catch (err) {670    throw new TypeError('Could not parse value of --allow/deny-insecure. Should be ' +671      'a list of strings separated by commas, or a path to a file ' +672      'listing one feature name per line.');673  }674  if (parsedFeatures.length === 1 && fs.existsSync(parsedFeatures[0])) {675    // we might have a file which is a list of features676    try {677      const fileFeatures = fs.readFileSync(parsedFeatures[0], 'utf8');678      parsedFeatures = splitter('\n', fileFeatures);679    } catch (err) {680      throw new TypeError(`Attempted to read --allow/deny-insecure feature names ` +681        `from file ${parsedFeatures[0]} but got error: ${err.message}`);682    }683  }684  return parsedFeatures;685}686function parseDefaultCaps (capsOrPath) {687  let caps = capsOrPath;688  let loadedFromFile = false;689  try {690    // use synchronous file access, as `argparse` provides no way of either691    // awaiting or using callbacks. This step happens in startup, in what is692    // effectively command-line code, so nothing is blocked in terms of693    // sessions, so holding up the event loop does not incur the usual694    // drawbacks.695    if (_.isString(capsOrPath) && fs.statSync(capsOrPath).isFile()) {696      caps = fs.readFileSync(capsOrPath, 'utf8');697      loadedFromFile = true;698    }699  } catch (err) {700    // not a file, or not readable701  }702  try {703    const result = JSON.parse(caps);704    if (!_.isPlainObject(result)) {705      throw new Error(`'${_.truncate(result, {length: 100})}' is not an object`);706    }707    return result;708  } catch (e) {709    const msg = loadedFromFile710      ? `Default capabilities in '${capsOrPath}' must be a valid JSON`711      : `Default capabilities must be a valid JSON`;712    throw new TypeError(`${msg}. Original error: ${e.message}`);713  }714}715function getParser () {716  const parser = new ArgumentParser({717    add_help: true,718    description: 'A webdriver-compatible server for use with native and hybrid iOS and Android applications.',719    prog: process.argv[1] || 'Appium'720  });721  parser.rawArgs = args;722  for (const [flagsOrNames, options] of args) {723    parser.add_argument(...flagsOrNames, options);724  }725  parser.add_argument('-v', '--version', {726    action: 'version',727    version: require(path.resolve(rootDir, 'package.json')).version,728  });729  return parser;730}731function getDefaultArgs () {732  return args.reduce((acc, [, {dest, default: defaultValue}]) => {733    acc[dest] = defaultValue;734    return acc;735  }, {});736}737export default getParser;...