@wdio/browserstack-service 7.24.0 → 7.25.0

package/README.md

@@ -56,6 +56,91 @@ Set this to true to kill the browserstack process on complete, without waiting f
 Type: `Boolean`<br />
 Default: `false`
 
+### app
+[Appium](https://appium.io/) set this with app file path available locally on your machine to use the app as [application under test](https://www.browserstack.com/docs/app-automate/appium/set-up-tests/specify-app) for Appium sessions.
+
+Type: `String` or `JsonObject`<br />
+Default: `undefined`
+
+List of available app values:
+
+#### path
+
+Use local available app file path as application under test for appium.
+
+```js
+services: [
+  ['browserstack', {
+    app: '/path/to/local/app.apk'
+    // OR
+    app: {
+      path: '/path/to/local/app.apk'
+    }
+  }]
+]
+```
+
+Pass custom_id while app upload.
+
+```js
+services: [
+  ['browserstack', {
+    app: {
+      path: '/path/to/local/app.apk',
+      custom_id: 'custom_id'
+    }
+  }]
+]
+```
+
+#### id
+
+Use app url returned after uploading app to BrowserStack.
+
+```js
+services: [
+  ['browserstack', {
+    app: 'bs://<app-id>'
+    // OR
+    app: {
+      id: 'bs://<app-id>'
+    }
+  }]
+]
+```
+
+#### custom_id
+
+use custom_id of already uploaded apps
+
+```js
+services: [
+  ['browserstack', {
+    app: 'custom_id'
+    // OR
+    app: {
+      custom_id: 'custom_id'
+    }
+  }]
+]
+```
+
+#### shareable_id
+
+use shareable_id of already uploaded apps
+
+```js
+services: [
+  ['browserstack', {
+    app: 'username/custom_id'
+    // OR
+    app: {
+      shareable_id: 'username/custom_id'
+    }
+  }]
+]
+```
+
 ### opts
 Specified optional will be passed down to BrowserstackLocal.
 

package/build/constants.d.ts

@@ -1,2 +1,3 @@
 export declare const BROWSER_DESCRIPTION: readonly ["device", "os", "osVersion", "os_version", "browserName", "browser", "browserVersion", "browser_version"];
+export declare const VALID_APP_EXTENSION: string[];
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,qHAStB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA"}

package/build/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_DESCRIPTION = void 0;
+exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
 exports.BROWSER_DESCRIPTION = [
     'device',
     'os',
@@ -11,3 +11,8 @@ exports.BROWSER_DESCRIPTION = [
     'browserVersion',
     'browser_version'
 ];
+exports.VALID_APP_EXTENSION = [
+    '.apk',
+    '.aab',
+    '.ipa'
+];

package/build/launcher.d.ts

@@ -1,5 +1,6 @@
 import * as BrowserstackLocalLauncher from 'browserstack-local';
 import type { Capabilities, Services, Options } from '@wdio/types';
+import { App, AppConfig, AppUploadResponse } from './types';
 import { BrowserstackConfig } from './types';
 declare type BrowserstackLocal = BrowserstackLocalLauncher.Local & {
     pid?: number;
@@ -10,8 +11,15 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _config;
     browserstackLocal?: BrowserstackLocal;
     constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
-    onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): void | Promise<unknown>;
+    onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): Promise<unknown>;
     onComplete(): true | Promise<unknown> | undefined;
+    _uploadApp(app: App): Promise<AppUploadResponse>;
+    /**
+     * @param  {String | AppConfig}  appConfig    <string>: should be "app file path" or "app_url" or "custom_id" or "shareable_id".
+     *                                            <object>: only "path" and "custom_id" should coexist as multiple properties.
+     */
+    _validateApp(appConfig: AppConfig | string): Promise<App>;
+    _updateCaps(capabilities?: Capabilities.RemoteCapabilities, capType?: string, value?: string): void;
 }
 export {};
 //# sourceMappingURL=launcher.d.ts.map

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAIlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAI5C,aAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAI5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IALnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAiCvC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyEtF,UAAU;CAkCb"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAClE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAI3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAK5C,aAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAI5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IALnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAiCjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA6E5F,UAAU;IAmCJ,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAC,MAAM;CA+C9F"}

package/build/launcher.js

@@ -26,12 +26,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const got_1 = __importDefault(require("got"));
+const form_data_1 = __importDefault(require("form-data"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const util_1 = require("util");
 const perf_hooks_1 = require("perf_hooks");
+const webdriverio_1 = require("webdriverio");
 const BrowserstackLocalLauncher = __importStar(require("browserstack-local"));
 const logger_1 = __importDefault(require("@wdio/logger"));
 // @ts-ignore
 const package_json_1 = require("../package.json");
+const constants_1 = require("./constants");
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class BrowserstackLauncherService {
     constructor(_options, capabilities, _config) {
@@ -72,7 +78,40 @@ class BrowserstackLauncherService {
             });
         }
     }
-    onPrepare(config, capabilities) {
+    async onPrepare(config, capabilities) {
+        /**
+         * Upload app to BrowserStack if valid file path to app is given.
+         * Update app value of capability directly if app_url, custom_id, shareable_id is given
+         */
+        if (!this._options.app) {
+            log.info('app is not defined in browserstack-service config, skipping ...');
+        }
+        else {
+            let app = {};
+            let appConfig = this._options.app;
+            try {
+                app = await this._validateApp(appConfig);
+            }
+            catch (error) {
+                throw new webdriverio_1.SevereServiceError(error);
+            }
+            if (constants_1.VALID_APP_EXTENSION.includes(path_1.default.extname(app.app))) {
+                if (fs_1.default.existsSync(app.app)) {
+                    let data;
+                    data = await this._uploadApp(app);
+                    log.info(`app upload completed: ${JSON.stringify(data)}`);
+                    app.app = data.app_url;
+                }
+                else if (app.customId) {
+                    app.app = app.customId;
+                }
+                else {
+                    throw new webdriverio_1.SevereServiceError('[Invalid app path] app path ${app.app} is not correct, Provide correct path to app under test');
+                }
+            }
+            log.info(`Using app: ${app.app}`);
+            this._updateCaps(capabilities, 'app', app.app);
+        }
         if (!this._options.browserstackLocal) {
             return log.info('browserstackLocal is not enabled - skipping...');
         }
@@ -81,43 +120,9 @@ class BrowserstackLauncherService {
             ...this._options.opts
         };
         this.browserstackLocal = new BrowserstackLocalLauncher.Local();
-        if (Array.isArray(capabilities)) {
-            capabilities.forEach((capability) => {
-                if (!capability['bstack:options']) {
-                    const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
-                    if (extensionCaps.length) {
-                        capability['bstack:options'] = { local: true };
-                    }
-                    else {
-                        capability['browserstack.local'] = true;
-                    }
-                }
-                else {
-                    capability['bstack:options'].local = true;
-                }
-            });
-        }
-        else if (typeof capabilities === 'object') {
-            Object.entries(capabilities).forEach(([, caps]) => {
-                if (!caps.capabilities['bstack:options']) {
-                    const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
-                    if (extensionCaps.length) {
-                        caps.capabilities['bstack:options'] = { local: true };
-                    }
-                    else {
-                        caps.capabilities['browserstack.local'] = true;
-                    }
-                }
-                else {
-                    caps.capabilities['bstack:options'].local = true;
-                }
-            });
-        }
-        else {
-            throw TypeError('Capabilities should be an object or Array!');
-        }
+        this._updateCaps(capabilities, 'local');
         /**
-         * measure TestingBot tunnel boot time
+         * measure BrowserStack tunnel boot time
          */
         const obs = new perf_hooks_1.PerformanceObserver((list) => {
             const entry = list.getEntries()[0];
@@ -174,5 +179,106 @@ class BrowserstackLauncherService {
             return Promise.reject(err);
         });
     }
+    async _uploadApp(app) {
+        log.info(`uploading app ${app.app} ${app.customId ? `and custom_id: ${app.customId}` : ''} to browserstack`);
+        const form = new form_data_1.default();
+        if (app.app)
+            form.append('file', fs_1.default.createReadStream(app.app));
+        if (app.customId)
+            form.append('custom_id', app.customId);
+        const res = await got_1.default.post('https://api-cloud.browserstack.com/app-automate/upload', {
+            body: form,
+            username: this._config.user,
+            password: this._config.key
+        }).json().catch((err) => {
+            throw new webdriverio_1.SevereServiceError(`app upload failed ${err.message}`);
+        });
+        return res;
+    }
+    /**
+     * @param  {String | AppConfig}  appConfig    <string>: should be "app file path" or "app_url" or "custom_id" or "shareable_id".
+     *                                            <object>: only "path" and "custom_id" should coexist as multiple properties.
+     */
+    async _validateApp(appConfig) {
+        let app = {};
+        if (typeof appConfig === 'string') {
+            app.app = appConfig;
+        }
+        else if (typeof appConfig === 'object' && Object.keys(appConfig).length) {
+            if (Object.keys(appConfig).length > 2 || (Object.keys(appConfig).length === 2 && (!appConfig.path || !appConfig.custom_id))) {
+                throw new webdriverio_1.SevereServiceError(`keys ${Object.keys(appConfig)} can't co-exist as app values, use any one property from
+                            {id<string>, path<string>, custom_id<string>, shareable_id<string>}, only "path" and "custom_id" can co-exist.`);
+            }
+            app.app = appConfig.id || appConfig.path || appConfig.custom_id || appConfig.shareable_id;
+            app.customId = appConfig.custom_id;
+        }
+        else {
+            throw new webdriverio_1.SevereServiceError('[Invalid format] app should be string or an object');
+        }
+        if (!app.app) {
+            throw new webdriverio_1.SevereServiceError(`[Invalid app property] supported properties are {id<string>, path<string>, custom_id<string>, shareable_id<string>}.
+                    For more details please visit https://www.browserstack.com/docs/app-automate/appium/set-up-tests/specify-app ')`);
+        }
+        return app;
+    }
+    _updateCaps(capabilities, capType, value) {
+        if (Array.isArray(capabilities)) {
+            capabilities.forEach((capability) => {
+                if (!capability['bstack:options']) {
+                    const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
+                    if (extensionCaps.length) {
+                        if (capType === 'local') {
+                            capability['bstack:options'] = { local: true };
+                        }
+                        else if (capType === 'app') {
+                            capability['appium:app'] = value;
+                        }
+                    }
+                    else if (capType === 'local') {
+                        capability['browserstack.local'] = true;
+                    }
+                    else if (capType === 'app') {
+                        capability['app'] = value;
+                    }
+                }
+                else if (capType === 'local') {
+                    capability['bstack:options'].local = true;
+                }
+                else if (capType === 'app') {
+                    capability['appium:app'] = value;
+                }
+            });
+        }
+        else if (typeof capabilities === 'object') {
+            Object.entries(capabilities).forEach(([, caps]) => {
+                if (!caps.capabilities['bstack:options']) {
+                    const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
+                    if (extensionCaps.length) {
+                        if (capType === 'local') {
+                            caps.capabilities['bstack:options'] = { local: true };
+                        }
+                        else if (capType === 'app') {
+                            caps.capabilities['appium:app'] = value;
+                        }
+                    }
+                    else if (capType === 'local') {
+                        caps.capabilities['browserstack.local'] = true;
+                    }
+                    else if (capType === 'app') {
+                        caps.capabilities['app'] = value;
+                    }
+                }
+                else if (capType === 'local') {
+                    caps.capabilities['bstack:options'].local = true;
+                }
+                else if (capType === 'app') {
+                    caps.capabilities['appium:app'] = value;
+                }
+            });
+        }
+        else {
+            throw new webdriverio_1.SevereServiceError('Capabilities should be an object or Array!');
+        }
+    }
 }
 exports.default = BrowserstackLauncherService;

package/build/types.d.ts

@@ -4,12 +4,33 @@ export interface SessionResponse {
     };
 }
 export declare type MultiRemoteAction = (sessionId: string, browserName?: string) => Promise<any>;
+export declare type AppConfig = {
+    id?: string;
+    path?: string;
+    custom_id?: string;
+    shareable_id?: string;
+};
+export interface AppUploadResponse {
+    app_url?: string;
+    custom_id?: string;
+    shareable_id?: string;
+}
+export interface App {
+    app?: string;
+    customId?: string;
+}
 export interface BrowserstackConfig {
     /**
      * Set this to true to enable routing connections from Browserstack cloud through your computer.
      * You will also need to set `browserstack.local` to true in browser capabilities.
      */
     browserstackLocal?: boolean;
+    /**
+     * Set this with app file path present locally on your device or
+     * app hashed id returned after uploading app to Browserstack or
+     * custom_id, sharable_id of the uploaded app
+     */
+    app?: string | AppConfig;
     /**
      * Cucumber only. Set this to true to enable updating the session name to the Scenario name if only
      * a single Scenario was ran. Useful when running in parallel

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,oBAAY,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAAA;CACvD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,oBAAY,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,oBAAY,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAAA;CACvD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "7.24.0",
+  "version": "7.25.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "Adam Bjerstedt <abjerstedt@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service",
@@ -25,10 +25,11 @@
   "dependencies": {
     "@types/node": "^18.0.0",
     "@wdio/logger": "7.19.0",
-    "@wdio/types": "7.24.0",
+    "@wdio/types": "7.25.0",
     "browserstack-local": "^1.4.5",
+    "form-data": "^4.0.0",
     "got": "^11.0.2",
-    "webdriverio": "7.24.0"
+    "webdriverio": "7.25.0"
   },
   "peerDependencies": {
     "@wdio/cli": "^5.0.0 || ^6.0.0 || ^7.0.0"
@@ -37,5 +38,5 @@
     "access": "public"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "cf88ab19bcd0d097ebf00fb812fcbfd1caef9705"
+  "gitHead": "6e619e8d6a97561922c75a6e0ef2e6172e63b720"
 }