feat: Add support of .aab packages (#750)

Author: mykola-mokhnach

README.md

@@ -65,7 +65,7 @@ appium:showGradleLog | Whether to include Gradle log to the regular server logs
 
 Capability Name | Description
 --- | ---
-appium:app | Full path to the application to be tested (the app must be located on the same machine where the server is running). Only `.apk` application extension is supported. `.aab` files need to be [converted](https://stackoverflow.com/questions/53040047/generate-apk-file-from-aab-file-android-app-bundle) to `.apk` format using [bundletool](https://developer.android.com/studio/command-line/bundletool) first in order to be used with this driver. Could also be an URL to a remote location. If neither of the `app` or `appPackage` capabilities are provided then the driver will fail to start a session. Also, if `app` capability is not provided it is expected that the app under test is already installed on the device under test and `noReset` is equal to `true`.
+appium:app | Full path to the application to be tested (the app must be located on the same machine where the server is running). The `.apk` application extension is supported. Since driver version 2.1.0 `.aab` files are supported as well (they get converted to `.apk` format automatically if [bundletool.jar](https://github.com/google/bundletool/releases) could be found in your PATH). For older driver versions `.aab` files need to be [converted](https://stackoverflow.com/questions/53040047/generate-apk-file-from-aab-file-android-app-bundle) manually to `.apk` format using [bundletool](https://developer.android.com/studio/command-line/bundletool) first. Could also be an URL to a remote location. If neither of the `app` or `appPackage` capabilities are provided then the driver will fail to start a session. Also, if `app` capability is not provided it is expected that the app under test is already installed on the device under test and `noReset` is equal to `true`.
 appium:appPackage | Application package identifier to be started. If not provided then Espresso will try to detect it automatically from the package provided by the `app` capability. Read [How To Troubleshoot Activities Startup](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/activity-startup.md) for more details
 appium:appActivity | Main application activity identifier. If not provided then Espresso will try to detect it automatically from the package provided by the `app` capability. Read [How To Troubleshoot Activities Startup](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/activity-startup.md) for more details
 appium:appWaitActivity | Identifier of the first activity that the application invokes. If not provided then equals to `appium:appActivity`. Read [How To Troubleshoot Activities Startup](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/activity-startup.md) for more details

lib/driver.js

@@ -119,8 +119,6 @@ const CHROME_NO_PROXY = [
   ['POST', new RegExp('^/session/[^/]+/se/log')],
 ];
 
-const APP_EXTENSION = '.apk';
-
 
 class EspressoDriver extends BaseDriver {
   constructor (opts = {}, shouldValidateCaps = true) {
@@ -177,12 +175,12 @@ class EspressoDriver extends BaseDriver {
 
       if (this.isChromeSession) {
         if (this.opts.app) {
-          logger.warn(`
-            'browserName' capability will be ignored.
-            Chrome browser cannot be run in Espresso sessions because Espresso automation doesn't have permission to access Chrome.
-          `);
+          logger.warn(`'browserName' capability will be ignored`);
+          logger.warn(`Chrome browser cannot be run in Espresso sessions because Espresso automation doesn't ` +
+              `have permission to access Chrome`);
         } else {
-          logger.errorAndThrow(`Chrome browser sessions cannot be run in Espresso because Espresso automation doesn't have permission to access Chrome`);
+          logger.errorAndThrow(`Chrome browser sessions cannot be run in Espresso because Espresso ` +
+            `automation doesn't have permission to access Chrome`);
         }
       }
 
@@ -191,25 +189,41 @@ class EspressoDriver extends BaseDriver {
         this.addWipeDataToAvdArgs();
       }
 
+      this.opts.systemPort = this.opts.systemPort
+        || await findAPortNotInUse(SYSTEM_PORT_RANGE[0], SYSTEM_PORT_RANGE[1]);
+      this.opts.adbPort = this.opts.adbPort || DEFAULT_ADB_PORT;
+      // get device udid for this session
+      const {udid, emPort} = await helpers.getDeviceInfoFromCaps(this.opts);
+      this.opts.udid = udid;
+      this.opts.emPort = emPort;
+      // now that we know our java version and device info, we can create our
+      // ADB instance
+      this.adb = await androidHelpers.createADB(this.opts);
+
       if (this.opts.app) {
         // find and copy, or download and unzip an app url or path
-        this.opts.app = await this.helpers.configureApp(this.opts.app, APP_EXTENSION);
-        await this.checkAppPresent();
+        this.opts.app = await this.helpers.configureApp(this.opts.app, {
+          onPostProcess: this.onPostConfigureApp.bind(this),
+          supportedExtensions: ['.apk', '.aab']
+        });
       } 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
         logger.info(`App file was not listed, instead we're going to run ` +
             `${this.opts.appPackage} directly on the device`);
-        await this.checkPackagePresent();
+        if (!await this.adb.isAppInstalled(this.opts.appPackage)) {
+          logger.errorAndThrow(`Could not find the package '${this.opts.appPackage}' ` +
+            `installed on the device`);
+        }
       }
 
-      this.opts.systemPort = this.opts.systemPort || await findAPortNotInUse(SYSTEM_PORT_RANGE[0], SYSTEM_PORT_RANGE[1]);
-      this.opts.adbPort = this.opts.adbPort || DEFAULT_ADB_PORT;
       await this.startEspressoSession();
       return [sessionId, caps];
     } catch (e) {
       await this.deleteSession();
-      e.message += '. Check https://github.com/appium/appium-espresso-driver#troubleshooting regarding advanced session startup troubleshooting.';
+      e.message += `${_.endsWith(e.message, '.') ? '' : '.'} Check ` +
+        'https://github.com/appium/appium-espresso-driver#troubleshooting ' +
+        'regarding advanced session startup troubleshooting.';
       if (isErrorType(e, errors.SessionNotCreatedError)) {
         throw e;
       }
@@ -219,6 +233,46 @@ class EspressoDriver extends BaseDriver {
     }
   }
 
+  async onPostConfigureApp ({cachedAppInfo, isUrl, appPath}) {
+    const presignApp = async (appLocation) => {
+      if (this.opts.noSign) {
+        logger.info('Skipping application signing because noSign capability is set to true. ' +
+          'Having the application under test with improper signature/non-signed will cause ' +
+          'Espresso automation startup failure.');
+      } else if (!await this.adb.checkApkCert(appLocation, this.opts.appPackage)) {
+        await this.adb.sign(appLocation, this.opts.appPackage);
+      }
+    };
+
+    const isApk = _.endsWith(_.toLower(appPath), '.apk');
+    // Do not cache .apk if was already present on the local file system
+    const shouldResultAppPathBeCached = !isApk || (isApk && isUrl);
+    let pathInCache = null;
+    let isResultAppPathAlreadyCached = false;
+    if (_.isPlainObject(cachedAppInfo)) {
+      const packageHash = await fs.hash(appPath);
+      if (packageHash === cachedAppInfo.packageHash && await fs.exists(cachedAppInfo.fullPath)) {
+        isResultAppPathAlreadyCached = true;
+        pathInCache = cachedAppInfo.fullPath;
+      }
+    }
+    if (!isResultAppPathAlreadyCached) {
+      if (shouldResultAppPathBeCached) {
+        pathInCache = isApk ? appPath : await this.adb.extractUniversalApk(appPath);
+        if (!isApk && isUrl) {
+          // Clean up the temporarily downloaded .aab package
+          await fs.rimraf(appPath);
+        }
+        await presignApp(pathInCache);
+      } else if (isApk) {
+        // It is probably not the best idea to modify the provided app in-place,
+        // but this is how it was always working
+        await presignApp(appPath);
+      }
+    }
+    return shouldResultAppPathBeCached ? {appPath: pathInCache} : false;
+  }
+
   get driverData () {
     // TODO fille out resource info here
     return {};
@@ -257,15 +311,6 @@ class EspressoDriver extends BaseDriver {
   async startEspressoSession () {
     logger.info(`EspressoDriver version: ${version}`);
 
-    // get device udid for this session
-    let {udid, emPort} = await helpers.getDeviceInfoFromCaps(this.opts);
-    this.opts.udid = udid;
-    this.opts.emPort = emPort;
-
-    // now that we know our java version and device info, we can create our
-    // ADB instance
-    this.adb = await androidHelpers.createADB(this.opts);
-
     // Read https://github.com/appium/appium-android-driver/pull/461 what happens if ther is no setHiddenApiPolicy for Android P+
     if (await this.adb.getApiLevel() >= 28) { // Android P
       logger.warn('Relaxing hidden api policy');
@@ -438,13 +483,6 @@ class EspressoDriver extends BaseDriver {
       await this.adb.uninstallApk(this.opts.appPackage);
     }
     if (this.opts.app) {
-      if (this.opts.noSign) {
-        logger.info('Skipping application signing because noSign capability is set to true. ' +
-          'Having the application under test with improper signature/non-signed will cause ' +
-          'Espresso automation startup failure.');
-      } else if (!await this.adb.checkApkCert(this.opts.app, this.opts.appPackage)) {
-        await this.adb.sign(this.opts.app, this.opts.appPackage);
-      }
       await helpers.installApk(this.adb, this.opts);
     }
     if (this.opts.skipServerInstallation) {
@@ -525,14 +563,6 @@ class EspressoDriver extends BaseDriver {
     }
   }
 
-  // TODO method is duplicated from uiautomator2
-  async checkAppPresent () {
-    logger.debug('Checking whether app is actually present');
-    if (!(await fs.exists(this.opts.app))) {
-      logger.errorAndThrow(`Could not find app apk at '${this.opts.app}'`);
-    }
-  }
-
   async onSettingsUpdate () {
     // intentionally do nothing here, since commands.updateSettings proxies
     // settings to the espresso server already
@@ -567,6 +597,10 @@ class EspressoDriver extends BaseDriver {
   get isChromeSession () {
     return helpers.isChromeBrowser(this.opts.browserName);
   }
+
+  get appOnDevice () {
+    return !this.opts.app && helpers.isPackageOrBundle(this.opts.appPackage);
+  }
 }
 
 // first add the android-driver commands which we will fall back to

package.json

@@ -49,10 +49,10 @@
     "!.DS_Store"
   ],
   "dependencies": {
-    "@appium/base-driver": "^8.0.0",
+    "@appium/base-driver": "^8.2.4",
     "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.4.3",
-    "appium-adb": "^8.18.0",
+    "appium-adb": "^9.1.0",
     "appium-android-driver": "^5.0.0",
     "asyncbox": "^2.3.1",
     "bluebird": "^3.5.0",