appium-android-driver 5.0.5 → 5.0.8

package/lib/driver.js

@@ -5,7 +5,6 @@ import {
   helpers, ensureNetworkSpeed,
   SETTINGS_HELPER_PKG_ID,
 } from './android-helpers';
-import log from './logger';
 import _ from 'lodash';
 import { DEFAULT_ADB_PORT } from 'appium-adb';
 import { fs, tempDir, util } from '@appium/support';
@@ -139,7 +138,7 @@ class AndroidDriver extends BaseDriver {
       });
 
       if (await this.adb.getApiLevel() >= 23) {
-        log.warn("Consider setting 'automationName' capability to " +
+        this.log.warn("Consider setting 'automationName' capability to " +
           "'uiautomator2' on Android >= 6, since UIAutomator framework " +
           'is not maintained anymore by the OS vendor.');
       }
@@ -157,7 +156,7 @@ class AndroidDriver extends BaseDriver {
       } else if (this.appOnDevice) {
         // the app isn't an actual app file but rather something we want to
         // assume is on the device and just launch via the appPackage
-        log.info(`App file was not listed, instead we're going to run ` +
+        this.log.info(`App file was not listed, instead we're going to run ` +
           `${this.opts.appPackage} directly on the device`);
         await this.checkPackagePresent();
       }
@@ -166,7 +165,7 @@ class AndroidDriver extends BaseDriver {
       // is set for emulators by calling adb.networkSpeed before running the app
       if (util.hasValue(this.opts.networkSpeed)) {
         if (!this.isEmulator()) {
-          log.warn('Sorry, networkSpeed capability is only available for emulators');
+          this.log.warn('Sorry, networkSpeed capability is only available for emulators');
         } else {
           const networkSpeed = ensureNetworkSpeed(this.adb, this.opts.networkSpeed);
           await this.adb.networkSpeed(networkSpeed);
@@ -175,10 +174,10 @@ class AndroidDriver extends BaseDriver {
       // check if we have to enable/disable gps before running the application
       if (util.hasValue(this.opts.gpsEnabled)) {
         if (this.isEmulator()) {
-          log.info(`Trying to ${this.opts.gpsEnabled ? 'enable' : 'disable'} gps location provider`);
+          this.log.info(`Trying to ${this.opts.gpsEnabled ? 'enable' : 'disable'} gps location provider`);
           await this.adb.toggleGPSLocationProvider(this.opts.gpsEnabled);
         } else {
-          log.warn('Sorry! gpsEnabled capability is only available for emulators');
+          this.log.warn('Sorry! gpsEnabled capability is only available for emulators');
         }
       }
 
@@ -200,13 +199,13 @@ class AndroidDriver extends BaseDriver {
 
   setAvdFromCapabilities (caps) {
     if (this.opts.avd) {
-      log.info('avd name defined, ignoring device name and platform version');
+      this.log.info('avd name defined, ignoring device name and platform version');
     } else {
       if (!caps.deviceName) {
-        log.errorAndThrow('avd or deviceName should be specified when reboot option is enables');
+        this.log.errorAndThrow('avd or deviceName should be specified when reboot option is enables');
       }
       if (!caps.platformVersion) {
-        log.errorAndThrow('avd or platformVersion should be specified when reboot option is enabled');
+        this.log.errorAndThrow('avd or platformVersion should be specified when reboot option is enabled');
       }
       let avdDevice = caps.deviceName.replace(/[^a-zA-Z0-9_.]/g, '-');
       this.opts.avd = `${avdDevice}__${caps.platformVersion}`;
@@ -229,7 +228,7 @@ class AndroidDriver extends BaseDriver {
   }
 
   async startAndroidSession () {
-    log.info(`Starting Android session`);
+    this.log.info(`Starting Android session`);
     // set up the device to run on (real or emulator, etc)
     this.defaultIME = await helpers.initDevice(this.adb, this.opts);
 
@@ -245,15 +244,15 @@ class AndroidDriver extends BaseDriver {
       if (await this.adb.isAnimationOn()) {
         if (await this.adb.getApiLevel() >= 28) { // API level 28 is Android P
           // Don't forget to reset the relaxing in delete session
-          log.warn('Relaxing hidden api policy to manage animation scale');
+          this.log.warn('Relaxing hidden api policy to manage animation scale');
           await this.adb.setHiddenApiPolicy('1', !!this.opts.ignoreHiddenApiPolicyError);
         }
 
-        log.info('Disabling window animation as it is requested by "disableWindowAnimation" capability');
+        this.log.info('Disabling window animation as it is requested by "disableWindowAnimation" capability');
         await this.adb.setAnimationState(false);
         this._wasWindowAnimationDisabled = true;
       } else {
-        log.info('Window animation is already disabled');
+        this.log.info('Window animation is already disabled');
       }
     }
 
@@ -292,7 +291,7 @@ class AndroidDriver extends BaseDriver {
     }
 
     if (util.hasValue(this.opts.orientation)) {
-      log.debug(`Setting initial orientation to '${this.opts.orientation}'`);
+      this.addManagedDriverlog.debug(`Setting initial orientation to '${this.opts.orientation}'`);
       await this.setOrientation(this.opts.orientation);
     }
 
@@ -304,7 +303,7 @@ class AndroidDriver extends BaseDriver {
       let viewName = this.defaultWebviewName();
       let timeout = (this.opts.autoWebviewTimeout) || 2000;
 
-      log.info(`Setting auto webview to context '${viewName}' with timeout ${timeout}ms`);
+      this.log.info(`Setting auto webview to context '${viewName}' with timeout ${timeout}ms`);
 
       // try every 500ms until timeout is over
       await retryInterval(timeout / 500, 500, async () => {
@@ -338,7 +337,7 @@ class AndroidDriver extends BaseDriver {
       try {
         otherApps = helpers.parseArray(this.opts.otherApps);
       } catch (e) {
-        log.errorAndThrow(`Could not parse "otherApps" capability: ${e.message}`);
+        this.log.errorAndThrow(`Could not parse "otherApps" capability: ${e.message}`);
       }
       otherApps = await B.all(otherApps.map((app) => this.helpers.configureApp(app, APP_EXTENSION)));
       await helpers.installOtherApks(otherApps, this.adb, this.opts);
@@ -347,9 +346,9 @@ class AndroidDriver extends BaseDriver {
     // install app
     if (!this.opts.app) {
       if (this.opts.fullReset) {
-        log.errorAndThrow('Full reset requires an app capability, use fastReset if app is not provided');
+        this.log.errorAndThrow('Full reset requires an app capability, use fastReset if app is not provided');
       }
-      log.debug('No app capability. Assuming it is already on the device');
+      this.log.debug('No app capability. Assuming it is already on the device');
       if (this.opts.fastReset) {
         await helpers.resetApp(this.adb, this.opts);
       }
@@ -372,16 +371,16 @@ class AndroidDriver extends BaseDriver {
   }
 
   async checkAppPresent () {
-    log.debug('Checking whether app is actually present');
+    this.log.debug('Checking whether app is actually present');
     if (!(await fs.exists(this.opts.app))) {
-      log.errorAndThrow(`Could not find app apk at ${this.opts.app}`);
+      this.log.errorAndThrow(`Could not find app apk at ${this.opts.app}`);
     }
   }
 
   async checkPackagePresent () {
-    log.debug('Checking whether package is present on the device');
+    this.log.debug('Checking whether package is present on the device');
     if (!(await this.adb.shell(['pm', 'list', 'packages', this.opts.appPackage]))) {
-      log.errorAndThrow(`Could not find package ${this.opts.appPackage} on the device`);
+      this.log.errorAndThrow(`Could not find package ${this.opts.appPackage} on the device`);
     }
   }
 
@@ -391,7 +390,7 @@ class AndroidDriver extends BaseDriver {
   }
 
   async deleteSession () {
-    log.debug('Shutting down Android driver');
+    this.log.debug('Shutting down Android driver');
 
     try {
       if (!_.isEmpty(this._screenRecordingProperties)) {
@@ -409,7 +408,7 @@ class AndroidDriver extends BaseDriver {
       // certain cleanup we only care to do if the bootstrap was ever run
       await this.stopChromedriverProxies();
       if (this.opts.unicodeKeyboard && this.opts.resetKeyboard && this.defaultIME) {
-        log.debug(`Resetting IME to ${this.defaultIME}`);
+        this.log.debug(`Resetting IME to ${this.defaultIME}`);
         await this.adb.setIME(this.defaultIME);
       }
       if (!this.isChromeSession && !this.opts.dontStopAppOnReset) {
@@ -422,7 +421,7 @@ class AndroidDriver extends BaseDriver {
       await this.bootstrap.shutdown();
       this.bootstrap = null;
     } else {
-      log.debug("Called deleteSession but bootstrap wasn't active");
+      this.log.debug("Called deleteSession but bootstrap wasn't active");
     }
     // some cleanup we want to do regardless, in case we are shutting down
     // mid-startup
@@ -431,29 +430,29 @@ class AndroidDriver extends BaseDriver {
       await this.adb.forceStop('io.appium.unlock');
     }
     if (this._wasWindowAnimationDisabled) {
-      log.info('Restoring window animation state');
+      this.log.info('Restoring window animation state');
       await this.adb.setAnimationState(true);
 
       // This was necessary to change animation scale over Android P. We must reset the policy for the security.
       if (await this.adb.getApiLevel() >= 28) {
-        log.info('Restoring hidden api policy to the device default configuration');
+        this.log.info('Restoring hidden api policy to the device default configuration');
         await this.adb.setDefaultHiddenApiPolicy(!!this.opts.ignoreHiddenApiPolicyError);
       }
     }
 
     if (this.opts.reboot) {
       let avdName = this.opts.avd.replace('@', '');
-      log.debug(`closing emulator '${avdName}'`);
+      this.log.debug(`closing emulator '${avdName}'`);
       await this.adb.killEmulator(avdName);
     }
   }
 
   async setSharedPreferences () {
     let sharedPrefs = this.opts.sharedPreferences;
-    log.info('Trying to set shared preferences');
+    this.log.info('Trying to set shared preferences');
     let name = sharedPrefs.name;
     if (_.isUndefined(name)) {
-      log.warn(`Skipping setting Shared preferences, name is undefined: ${JSON.stringify(sharedPrefs)}`);
+      this.log.warn(`Skipping setting Shared preferences, name is undefined: ${JSON.stringify(sharedPrefs)}`);
       return false;
     }
     let remotePath = `/data/data/${this.opts.appPackage}/shared_prefs`;
@@ -461,19 +460,19 @@ class AndroidDriver extends BaseDriver {
     let localPath = `/tmp/${name}.xml`;
     let builder = this.getPrefsBuilder();
     builder.build(sharedPrefs.prefs);
-    log.info(`Creating temporary shared preferences: ${localPath}`);
+    this.log.info(`Creating temporary shared preferences: ${localPath}`);
     builder.toFile(localPath);
-    log.info(`Creating shared_prefs remote folder: ${remotePath}`);
+    this.log.info(`Creating shared_prefs remote folder: ${remotePath}`);
     await this.adb.shell(['mkdir', '-p', remotePath]);
-    log.info(`Pushing shared_prefs to ${remoteFile}`);
+    this.log.info(`Pushing shared_prefs to ${remoteFile}`);
     await this.adb.push(localPath, remoteFile);
     try {
-      log.info(`Trying to remove shared preferences temporary file`);
+      this.log.info(`Trying to remove shared preferences temporary file`);
       if (await fs.exists(localPath)) {
         await fs.unlink(localPath);
       }
     } catch (e) {
-      log.warn(`Error trying to remove temporary file ${localPath}`);
+      this.log.warn(`Error trying to remove temporary file ${localPath}`);
     }
     return true;
   }
@@ -490,7 +489,7 @@ class AndroidDriver extends BaseDriver {
       return false;
     }
     if ((!caps.browserName || !helpers.isChromeBrowser(caps.browserName)) && !caps.app && !caps.appPackage) {
-      log.errorAndThrow('The desired capabilities must include either an app, appPackage or browserName');
+      this.log.errorAndThrow('The desired capabilities must include either an app, appPackage or browserName');
     }
     return helpers.validateDesiredCaps(caps);
   }

package/lib/webview-helpers.js

@@ -478,7 +478,9 @@ helpers.getWebviewDetails = function getWebviewDetails (adb, webview) {
 helpers.createChromedriverCaps = function createChromedriverCaps (opts, deviceId, webViewDetails) {
   const caps = { chromeOptions: {} };
 
-  const androidPackage = opts.chromeOptions?.androidPackage || opts.appPackage;
+  const androidPackage = opts.chromeOptions?.androidPackage
+    || opts.appPackage
+    || webViewDetails?.info?.['Android-Package'];
   if (androidPackage) {
     // chromedriver raises an invalid argument error when androidPackage is 'null'
     caps.chromeOptions.androidPackage = androidPackage;

package/package.json

@@ -9,7 +9,7 @@
     "mobile",
     "mobile testing"
   ],
-  "version": "5.0.5",
+  "version": "5.0.8",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -35,7 +35,7 @@
     "bootstrap/bin/AppiumBootstrap.jar"
   ],
   "dependencies": {
-    "@appium/base-driver": "^8.0.0",
+    "@appium/base-driver": "^8.3.0",
     "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.0.0",
     "appium-adb": "^9.0.0",