mirror of
https://github.com/appium/appium.git
synced 2026-01-21 09:39:52 -06:00
381 lines
9.3 KiB
JavaScript
381 lines
9.3 KiB
JavaScript
"use strict";
|
|
var ap = require('argparse').ArgumentParser
|
|
, pkgObj = require('../../package.json')
|
|
, path = require('path')
|
|
, _ = require('underscore');
|
|
|
|
var args = [
|
|
[['--app'] , {
|
|
required: false
|
|
, defaultValue: null
|
|
, help: 'IOS: abs path to simulator-compiled .app file or the bundle_id of the desired target on device; Android: abs path to .apk file'
|
|
, example: "/abs/path/to/my.app"
|
|
}],
|
|
|
|
[['--ipa'] , {
|
|
required: false
|
|
, defaultValue: null
|
|
, help: '(IOS-only) abs path to compiled .ipa file'
|
|
, example: "/abs/path/to/my.ipa"
|
|
}],
|
|
|
|
[['-q', '--quiet'], {
|
|
required: false
|
|
, defaultValue: false
|
|
, action: 'storeTrue'
|
|
, help: "Don't use verbose logging output"
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['-U', '--udid'] , {
|
|
required: false
|
|
, defaultValue: null
|
|
, example: "1adsf-sdfas-asdf-123sdf"
|
|
, help: 'Unique device identifier of the connected physical device'
|
|
}],
|
|
|
|
[['-a', '--address'] , {
|
|
defaultValue: '0.0.0.0'
|
|
, required: false
|
|
, example: "0.0.0.0"
|
|
, help: 'IP Address to listen on'
|
|
}],
|
|
|
|
[['-p', '--port'] , {
|
|
defaultValue: 4723
|
|
, required: false
|
|
, type: 'int'
|
|
, example: "4723"
|
|
, help: 'port to listen on'
|
|
}],
|
|
|
|
[['-dp', '--device-port'] , {
|
|
defaultValue: 4724
|
|
, dest: 'devicePort'
|
|
, required: false
|
|
, type: 'int'
|
|
, example: "4724"
|
|
, help: '(Android-only) port to connect to device on'
|
|
}],
|
|
|
|
[['-k', '--keep-artifacts'] , {
|
|
defaultValue: false
|
|
, dest: 'keepArtifacts'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: '(IOS-only) Keep Instruments trace directories'
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--session-override'] , {
|
|
defaultValue: false
|
|
, dest: 'sessionOverride'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: 'Enables session override (clobbering)'
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--full-reset'] , {
|
|
defaultValue: false
|
|
, dest: 'fullReset'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: '(Android-only) Reset app state by uninstalling app instead of ' +
|
|
'clearing app data'
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--no-reset'] , {
|
|
defaultValue: false
|
|
, dest: 'noReset'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: "Don't reset app state between sessions (IOS: don't delete app " +
|
|
"plist files; Android: don't uninstall app before new session)"
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['-l', '--pre-launch'] , {
|
|
defaultValue: false
|
|
, dest: 'launch'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: 'Pre-launch the application before allowing the first session ' +
|
|
'(Requires --app and, for Android, --app-pkg and --app-activity)'
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['-g', '--log'] , {
|
|
defaultValue: null
|
|
, required: false
|
|
, example: "/path/to/appium.log"
|
|
, help: 'Log output to this file instead of stdout'
|
|
}],
|
|
|
|
[['--log-timestamp'] , {
|
|
defaultValue: false
|
|
, required: false
|
|
, help: 'Show timestamps in console output'
|
|
, nargs: 0
|
|
, action: 'storeTrue'
|
|
, dest: 'logTimestamp'
|
|
}],
|
|
|
|
[['--log-no-colors'] , {
|
|
defaultValue: false
|
|
, required: false
|
|
, help: "Don't use colors in console output"
|
|
, nargs: 0
|
|
, action: 'storeTrue'
|
|
, dest: 'logNoColors'
|
|
}],
|
|
|
|
[['-G', '--webhook'] , {
|
|
defaultValue: null
|
|
, required: false
|
|
, example: "localhost:9876"
|
|
, help: 'Also send log output to this HTTP listener'
|
|
}],
|
|
|
|
[['--native-instruments-lib'], {
|
|
defaultValue: false
|
|
, dest: 'nativeInstrumentsLib'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: '(IOS-only) IOS has a weird built-in unavoidable ' +
|
|
'delay. We patch this in appium. If you do not want it patched, ' +
|
|
'pass in this flag.'
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--merciful', '-m'], {
|
|
defaultValue: false
|
|
, dest: 'merciful'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: "Don't run the watcher process that will force-kill an " +
|
|
"unresponsive instruments"
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--app-pkg'], {
|
|
dest: 'androidPackage'
|
|
, defaultValue: null
|
|
, required: false
|
|
, example: "com.example.android.myApp"
|
|
, help: "(Android-only) Java package of the Android app you want to run " +
|
|
"(e.g., com.example.android.myApp)"
|
|
}],
|
|
|
|
[['--app-activity'], {
|
|
dest: 'androidActivity'
|
|
, defaultValue: null
|
|
, required: false
|
|
, example: "MainActivity"
|
|
, help: "(Android-only) Activity name for the Android activity you want " +
|
|
"to launch from your package (e.g., MainActivity)"
|
|
}],
|
|
|
|
[['--app-wait-activity'], {
|
|
dest: 'androidWaitActivity'
|
|
, defaultValue: false
|
|
, required: false
|
|
, example: "SplashActivity"
|
|
, help: "(Android-only) Activity name for the Android activity you want " +
|
|
"to wait for (e.g., SplashActivity)"
|
|
}],
|
|
|
|
[['--avd'] , {
|
|
defaultValue: null
|
|
, required: false
|
|
, example: "@default"
|
|
, help: 'name of the avd to launch'
|
|
}],
|
|
|
|
[['--device-ready-timeout'], {
|
|
dest: 'androidDeviceReadyTimeout'
|
|
, defaultValue: '5'
|
|
, required: false
|
|
, example: "5"
|
|
, help: "(Android-only) Timeout in seconds while waiting for device to become ready"
|
|
}],
|
|
|
|
[['--safari'], {
|
|
defaultValue: false
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: "(IOS-Only) Use the safari app"
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--device-name'], {
|
|
dest: 'deviceName'
|
|
, defaultValue: null
|
|
, required: false
|
|
, example: "iPhone Retina (4-inch)"
|
|
, help: "(IOS-Simulator-only) name of the iOS device to use"
|
|
}],
|
|
|
|
[['--default-device'], {
|
|
dest: 'defaultDevice'
|
|
, defaultValue: false
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: "(IOS-Simulator-only) use the default simulator that instruments " +
|
|
"launches on its own"
|
|
}],
|
|
|
|
[['--force-iphone'], {
|
|
defaultValue: false
|
|
, dest: 'forceIphone'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: "(IOS-only) Use the iPhone Simulator no matter what the app wants"
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--force-ipad'], {
|
|
defaultValue: false
|
|
, dest: 'forceIpad'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: "(IOS-only) Use the iPad Simulator no matter what the app wants"
|
|
, nargs: 0
|
|
}],
|
|
|
|
[['--language'] , {
|
|
defaultValue: null
|
|
, dest: 'language'
|
|
, required: false
|
|
, example: "en"
|
|
, help: '(IOS-only) language for the iOS simulator'
|
|
}],
|
|
|
|
[['--locale'] , {
|
|
defaultValue: null
|
|
, dest: 'locale'
|
|
, required: false
|
|
, example: "en_US"
|
|
, help: '(IOS-only) locale for the iOS simulator'
|
|
}],
|
|
|
|
[['--calendar-format'] , {
|
|
defaultValue: null
|
|
, dest: 'calendarFormat'
|
|
, required: false
|
|
, example: "gregorian"
|
|
, help: '(IOS-only) calendar format for the iOS simulator'
|
|
}],
|
|
|
|
[['--orientation'], {
|
|
defaultValue: null
|
|
, required: false
|
|
, example: "LANDSCAPE"
|
|
, help: "(IOS-only) use LANDSCAPE or PORTRAIT to initialize all requests " +
|
|
"to this orientation"
|
|
}],
|
|
|
|
[['--tracetemplate'], {
|
|
defaultValue: null
|
|
, dest: 'automationTraceTemplatePath'
|
|
, required: false
|
|
, example: "/Users/me/Automation.tracetemplate"
|
|
, help: "(IOS-only) .tracetemplate file to use with Instruments"
|
|
}],
|
|
|
|
[['--nodeconfig'] , {
|
|
required: false
|
|
, defaultValue: null
|
|
, help: 'Configuration JSON file to register appium with selenium grid'
|
|
, example: "/abs/path/to/nodeconfig.json"
|
|
}],
|
|
|
|
[['-ra', '--robot-address'] , {
|
|
defaultValue: '0.0.0.0'
|
|
, dest: 'robotAddress'
|
|
, required: false
|
|
, example: "0.0.0.0"
|
|
, help: 'IP Address of robot'
|
|
}],
|
|
|
|
[['-rp', '--robot-port'] , {
|
|
defaultValue: -1
|
|
, dest: 'robotPort'
|
|
, required: false
|
|
, type: 'int'
|
|
, example: "4242"
|
|
, help: 'port for robot'
|
|
}],
|
|
|
|
[['--selendroid-port'], {
|
|
defaultValue: 8080
|
|
, dest: 'selendroidPort'
|
|
, required: false
|
|
, type: 'int'
|
|
, example: "8080"
|
|
, help: 'Local port used for communication with Selendroid'
|
|
}],
|
|
|
|
[['--use-keystore'], {
|
|
defaultValue: false
|
|
, dest: 'useKeystore'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: '(Android-only) When set the keystore will be used to sign apks.'
|
|
}],
|
|
|
|
[['--keystore-path'], {
|
|
defaultValue: path.resolve(process.env.HOME || process.env.USERPROFILE || '', '.android', 'debug.keystore')
|
|
, dest: 'keystorePath'
|
|
, required: false
|
|
, help: '(Android-only) Path to keystore'
|
|
}],
|
|
|
|
[['--keystore-password'], {
|
|
defaultValue: 'android'
|
|
, dest: 'keystorePassword'
|
|
, required: false
|
|
, help: '(Android-only) Password to keystore'
|
|
}],
|
|
|
|
[['--key-alias'], {
|
|
defaultValue: 'androiddebugkey'
|
|
, dest: 'keyAlias'
|
|
, required: false
|
|
, help: '(Android-only) Key alias'
|
|
}],
|
|
|
|
[['--key-password'], {
|
|
defaultValue: 'android'
|
|
, dest: 'keyPassword'
|
|
, required: false
|
|
, help: '(Android-only) Key password'
|
|
}],
|
|
|
|
[['--show-config'], {
|
|
defaultValue: false
|
|
, dest: 'showConfig'
|
|
, action: 'storeTrue'
|
|
, required: false
|
|
, help: 'Show info about the appium server configuration and exit'
|
|
}]
|
|
];
|
|
|
|
// Setup all the command line argument parsing
|
|
module.exports = function() {
|
|
var parser = new ap({
|
|
version: pkgObj.version,
|
|
addHelp: true,
|
|
description: 'A webdriver-compatible server for use with native and hybrid iOS and Android applications.'
|
|
});
|
|
|
|
_.each(args, function(arg) {
|
|
parser.addArgument(arg[0], arg[1]);
|
|
});
|
|
|
|
parser.rawArgs = args;
|
|
|
|
return parser;
|
|
};
|