1.11.2-rc.1

* Add deprecation notice when automationName not set

* PR changes

docs/en/contributing-to-appium/developers-overview.md

@@ -195,7 +195,7 @@ converted into the `npm-shrinkwrap.json` file.
 1. Determine whether we have a `patch` (bugfix), `minor` (feature), or `major` (breaking) release according to the principles of SemVer.
 1. Update `package.json` with the appropriate new version.
 1. Update the CHANGELOG/README with appropriate changes and submit for review as a PR, along with shrinkwrap and `package.json` changes. Wait for it to be merged, then pull it into the release branch.
-1. Run `npm run shrinkwrap-prod`. This script prunes dev dependencies (leaving only production dependencies), creates a production-only `npm-shrinkwrap.json` and then re-installs the dev dependencies by doing `npm install --no-shrinkwrap`.
+1. Run `npm shrinkwrap` to generate the `npm-shrinkwrap.json`
 1. Create a tag of the form `v<version>` on the release branch (usually a minor branch like `1.5` or `1.4`), with: `git tag -a v<version>`, e.g., `git tag -a v1.5.0`. This is not necessary for beta versions.
 1. Push the tag to upstream: `git push --tags <remote> <branch>`
 1. Run `npm publish` (with `--tag beta` if this isn't an official release).

gulpfile.js

@@ -12,12 +12,9 @@ const path = require('path');
 const fs = require('fs');
 const log = require('fancy-log');
 
-
-require('./ci/gulp');
-
-
 // remove 'fsevents' from shrinkwrap, since it causes errors on non-Mac hosts
 // see https://github.com/npm/npm/issues/2679
+
 gulp.task('fixShrinkwrap', function (done) {
   let shrinkwrap;
   try {
@@ -27,6 +24,7 @@ gulp.task('fixShrinkwrap', function (done) {
               `(Original error: ${err.message})`);
     return done();
   }
+
   delete shrinkwrap.dependencies.fsevents;
   const shrinkwrapString = JSON.stringify(shrinkwrap, null, '  ') + '\n';
   fs.writeFile('./npm-shrinkwrap.json', shrinkwrapString, done);
@@ -44,7 +42,6 @@ boilerplate({
   test: {
     files: ['${testDir}/**/*-specs.js']
   },
-  extraPrepublishTasks: ['fixShrinkwrap'],
   preCommitTasks: ['eslint', 'once'],
 });
 

lib/appium.js

@@ -18,16 +18,26 @@ import AsyncLock from 'async-lock';
 import { inspectObject, parseCapsForInnerDriver, getPackageVersion } from './utils';
 import semver from 'semver';
 
+const PLATFORMS = {
+  FAKE: 'fake',
+  ANDROID: 'android',
+  IOS: 'ios',
+  WINDOWS: 'windows',
+  MAC: 'mac',
+  TIZEN: 'tizen',
+};
 
 const AUTOMATION_NAMES = {
   APPIUM: 'Appium',
   SELENDROID: 'Selendroid',
   UIAUTOMATOR2: 'UiAutomator2',
+  UIAUTOMATOR1: 'UiAutomator1',
   XCUITEST: 'XCUITest',
   YOUIENGINE: 'YouiEngine',
   ESPRESSO: 'Espresso',
   TIZEN: 'Tizen',
   FAKE: 'Fake',
+  INSTRUMENTS: 'Instruments',
 };
 const DRIVER_MAP = {
   SelendroidDriver: {
@@ -56,10 +66,12 @@ const DRIVER_MAP = {
   },
   AndroidDriver: {
     driverClass: AndroidDriver,
+    automationName: AUTOMATION_NAMES.UIAUTOMATOR1,
     version: getPackageVersion('appium-android-driver'),
   },
   IosDriver: {
     driverClass: IosDriver,
+    automationName: AUTOMATION_NAMES.INSTRUMENTS,
     version: getPackageVersion('appium-ios-driver'),
   },
   WindowsDriver: {
@@ -83,20 +95,24 @@ const DRIVER_MAP = {
 };
 
 const PLATFORMS_MAP = {
-  fake: () => FakeDriver,
-  android: (caps) => {
+  [PLATFORMS.FAKE]: () => FakeDriver,
+  [PLATFORMS.ANDROID]: (caps) => {
     const platformVersion = semver.valid(semver.coerce(caps.platformVersion));
+    log.warn(`DeprecationWarning: 'automationName' capability was not provided. ` +
+      `Future versions of Appium will require 'automationName' capability to be set for Android sessions.`);
+    log.info(`Setting automation to '${AUTOMATION_NAMES.UIAUTOMATOR1}'. `);
     if (platformVersion && semver.satisfies(platformVersion, '>=6.0.0')) {
-      log.warn("Consider setting 'automationName' capability to " +
-        `'${AUTOMATION_NAMES.UIAUTOMATOR2}' ` +
-        "on Android >= 6, since UIAutomator framework " +
-        "is not maintained anymore by the OS vendor.");
+      log.warn(`Consider setting 'automationName' capability to '${AUTOMATION_NAMES.UIAUTOMATOR2}' ` +
+        'on Android >= 6, since UIAutomator1 framework ' +
+        'is not maintained anymore by the OS vendor.');
     }
 
     return AndroidDriver;
   },
-  ios: (caps) => {
+  [PLATFORMS.IOS]: (caps) => {
     const platformVersion = semver.valid(semver.coerce(caps.platformVersion));
+    log.warn(`DeprecationWarning: 'automationName' capability was not provided. ` +
+      `Future versions of Appium will require 'automationName' capability to be set for iOS sessions.`);
     if (platformVersion && semver.satisfies(platformVersion, '>=10.0.0')) {
       log.info("Requested iOS support with version >= 10, " +
         `using '${AUTOMATION_NAMES.XCUITEST}' ` +
@@ -107,9 +123,9 @@ const PLATFORMS_MAP = {
 
     return IosDriver;
   },
-  windows: () => WindowsDriver,
-  mac: () => MacDriver,
-  tizen: () => TizenDriver,
+  [PLATFORMS.WINDOWS]: () => WindowsDriver,
+  [PLATFORMS.MAC]: () => MacDriver,
+  [PLATFORMS.TIZEN]: () => TizenDriver,
 };
 
 const desiredCapabilityConstraints = {
@@ -174,6 +190,8 @@ class AppiumDriver extends BaseDriver {
       throw new Error("You must include a platformName capability");
     }
 
+    const platformName = caps.platformName.toLowerCase();
+
     // we don't necessarily have an `automationName` capability,
     if (_.isString(caps.automationName)) {
       for (const {automationName, driverClass} of _.values(DRIVER_MAP)) {
@@ -183,7 +201,7 @@ class AppiumDriver extends BaseDriver {
       }
     }
 
-    const driverSelector = PLATFORMS_MAP[caps.platformName.toLowerCase()];
+    const driverSelector = PLATFORMS_MAP[platformName];
     if (driverSelector) {
       return driverSelector(caps);
     }

package.json

@@ -11,7 +11,7 @@
     "firefoxos",
     "testing"
   ],
-  "version": "1.11.0-beta.3",
+  "version": "1.11.2-rc.1",
   "author": "https://github.com/appium",
   "license": "Apache-2.0",
   "repository": {
@@ -36,27 +36,28 @@
   "files": [
     "bin",
     "lib",
-    "build/lib"
+    "build/lib",
+    "npm-shrinkwrap.json"
   ],
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "appium-android-driver": "^4.0.0",
-    "appium-base-driver": "3.x",
-    "appium-espresso-driver": "^1.0.0",
-    "appium-fake-driver": "^0.x",
-    "appium-ios-driver": "2.x",
-    "appium-mac-driver": "1.x",
-    "appium-selendroid-driver": "1.x",
-    "appium-support": "2.x",
+    "appium-android-driver": "^4.8.0",
+    "appium-base-driver": "^3.15.2",
+    "appium-espresso-driver": "^1.7.1",
+    "appium-fake-driver": "^0.6.2",
+    "appium-ios-driver": "^4.1.0",
+    "appium-mac-driver": "^1.4.1",
+    "appium-selendroid-driver": "^1.13.3",
+    "appium-support": "^2.25.0",
     "appium-tizen-driver": "^1.1.1-beta.3",
-    "appium-uiautomator2-driver": "1.x",
-    "appium-windows-driver": "1.x",
-    "appium-xcuitest-driver": "2.x",
-    "appium-youiengine-driver": "^1.1.1",
+    "appium-uiautomator2-driver": "^1.29.1",
+    "appium-windows-driver": "^1.5.1",
+    "appium-xcuitest-driver": "^2.105.1",
+    "appium-youiengine-driver": "^1.1.2",
     "argparse": "^1.0.10",
     "async-lock": "^1.0.0",
-    "asyncbox": "2.x",
-    "bluebird": "3.x",
+    "asyncbox": "^2.5.2",
+    "bluebird": "^3.5.3",
     "continuation-local-storage": "3.x",
     "dateformat": "^3.0.3",
     "find-root": "^1.1.0",
@@ -65,15 +66,18 @@
     "npmlog": "4.x",
     "request": "^2.81.0",
     "request-promise": "4.x",
-    "semver": "^5.5.0",
+    "semver": "^5.6.0",
     "source-map-support": "0.x",
-    "teen_process": "1.x",
+    "teen_process": "^1.14.1",
     "winston": "3.x"
   },
   "scripts": {
     "clean": "rm -rf node_modules && rm -f package-lock.json && npm install",
-    "prepare": "gulp prepublish",
-    "publish": "gulp prepublish",
+    "prepublish": "gulp prepublish",
+    "prepublishOnly": "npm run prune-shrinkwrap && gulp fixShrinkwrap",
+    "postpublish": "npm run restore-shrinkwrap",
+    "prune-shrinkwrap": "npm ci --production --ignore-scripts && npm shrinkwrap && npm install --only=dev --no-shrinkwrap",
+    "restore-shrinkwrap": "git checkout HEAD -- npm-shrinkwrap.json",
     "test": "gulp once",
     "e2e-test": "gulp e2e-test",
     "watch": "gulp watch",
@@ -84,7 +88,6 @@
     "lint": "gulp eslint",
     "coverage": "gulp coveralls",
     "generate-docs": "node ./build/commands-yml/parse.js",
-    "shrinkwrap-prod": "rimraf package-lock.json && npm prune --production && npm shrinkwrap && npm install --no-shrinkwrap",
     "zip": "zip -qr appium.zip .",
     "upload": "gulp github-upload",
     "zip-and-upload": "npm run zip && npm run upload"
@@ -105,13 +108,13 @@
     "eslint-plugin-import": "^2.2.0",
     "eslint-plugin-mocha": "^5.0.0",
     "eslint-plugin-promise": "^4.0.0",
-    "fancy-log": "^1.3.2",
+    "fancy-log": "^1.3.3",
     "gulp": "^4.0.0",
     "handlebars": "^4.0.10",
     "mocha": "5.x",
     "pre-commit": "1.x",
     "replace-ext": "^1.0.0",
-    "rimraf": "^2.6.2",
+    "rimraf": "^2.6.3",
     "sinon": "^6.0.0",
     "validate.js": "^0.12.0",
     "wd": "^1.10.0",