Improvements (#1)

* fix security issue + improve override of capabilities

* fix specs for mobile

* fix integration tests

Author: taktakpeops

examples/with-bt-local/package.json

@@ -66,9 +66,9 @@
   "scripts": {
     "start": "PORT=8080 node scripts/start.js",
     "build": "node scripts/build.js",
-    "test:jest": "jest --ci",
+    "test:jest": "jest --ci --runInBand",
     "test:visual": "jest --testNamePattern=VisualTest --update-snapshot",
-    "test:e2e": "jest --testNamePattern=UiTest",
+    "test:e2e": "jest --testNamePattern=UiTest --runInBand --ci",
     "test:unit": "jest --testNamePattern=UnitTest",
     "test": "npm-run-all -p -r start test:jest"
   },

examples/with-bt-local/src/App.e2e.test.js

@@ -8,11 +8,7 @@ describe('ui testing UiTest', () => {
   let driver;
 
   beforeAll(async () => {
-    driver = await global.__driver__({
-      'bstack:options': {
-        sessionName: 'ui testing',
-      },
-    });
+    driver = await global.__driver__();
 
     await driver.get('http://localhost:8080');
   }, 20000);

examples/with-bt-local/src/__visual_testing__/App.test.js

@@ -9,11 +9,7 @@ describe('visual testing VisualTest', () => {
   let driver;
 
   beforeAll(async () => {
-    driver = await global.__driver__({
-      'bstack:options': {
-        sessionName: 'visual testing',
-      },
-    });
+    driver = await global.__driver__();
 
     await driver.get('http://localhost:8080');
   }, 20000);

package-lock.json

@@ -17,7 +17,7 @@
     "lint": "eslint --ext .ts src/*",
     "lint:fix": "eslint --ext .ts src/* --fix",
     "prettier": "prettier --write \"**/*.{md,ts}\"",
-    "test": "npm run build && jest"
+    "test": "npm run build && jest --runInBand --ci"
   },
   "keywords": [
     "jest",
@@ -31,11 +31,9 @@
   "license": "MIT",
   "dependencies": {
     "@jest/types": "~24.9.0",
-    "@types/lodash.merge": "~4.6.6",
     "@types/selenium-webdriver": "~4.0.3",
     "browserstack-local": "~1.4.2",
     "jest-environment-node": "~24.9.0",
-    "lodash.merge": "~4.6.2",
     "selenium-webdriver": "~4.0.0-alpha.5"
   },
   "devDependencies": {

package.json

@@ -6,11 +6,7 @@ describe('Github', () => {
   beforeAll(async () => {
     // eslint-disable-next-line
     // @ts-ignore
-    driver = await global.__driver__({
-      'bstack:options': {
-        sessionName: 'github',
-      },
-    });
+    driver = await global.__driver__();
     await driver.get('https://github.com/taktakpeops/jest-environment-browserstack');
   }, 20000);
 

src/__tests__/github.spec.ts

@@ -6,11 +6,7 @@ describe('NPM', () => {
   beforeAll(async () => {
     // eslint-disable-next-line
     // @ts-ignore
-    driver = await global.__driver__({
-      'bstack:options': {
-        sessionName: 'npm',
-      },
-    });
+    driver = await global.__driver__();
     await driver.get('https://www.npmjs.com/package/jest-environment-browserstack');
   }, 20000);
 

src/__tests__/npm.spec.ts

@@ -0,0 +1,37 @@
+import { WebDriver, By } from 'selenium-webdriver';
+
+describe('Switch specs', () => {
+  let driver: WebDriver;
+
+  beforeAll(async () => {
+    // eslint-disable-next-line
+    // @ts-ignore
+    driver = await global.__driver__({
+      'bstack:options': {
+        osVersion: '11',
+        deviceName: 'iPhone 8 Plus',
+        realMobile: 'true',
+        buildName: 'jest-environment-browserstack',
+        sessionName: 'override capabilities',
+      },
+      browserName: 'iPhone',
+    });
+    await driver.get('https://github.com/taktakpeops/jest-environment-browserstack');
+  }, 20000);
+
+  afterAll(async () => {
+    await driver.quit();
+  });
+
+  it('has an author', async () => {
+    const authorSpan = await driver.findElement(By.css('.Details .Header-link:first-of-type'));
+    const author = await authorSpan.getText();
+    expect(author).toBe('taktakpeops');
+  });
+
+  it('has a repository name', async () => {
+    const repoSpan = await driver.findElement(By.css('.Details .Header-link:last-of-type'));
+    const repo = await repoSpan.getText();
+    expect(repo).toBe('jest-environment-browserstack');
+  });
+});

src/__tests__/switch.spec.ts

@@ -4,7 +4,6 @@ import { Options, Local } from 'browserstack-local';
 import { Builder, WebDriver } from 'selenium-webdriver';
 import { randomBytes } from 'crypto';
 import { Script } from 'vm';
-import merge from 'lodash.merge';
 
 import { BrowserstackCapabilities } from './types';
 
@@ -53,6 +52,8 @@ export default class BrowserstackEnvironment extends NodeEnvironment {
         this.localIdentifier = opts.localIdentifier;
       }
 
+      this.btCapabilities['bstack:options'].localIdentifier = this.localIdentifier;
+
       this.btTunnelOpts = localTesting;
     }
 
@@ -90,7 +91,19 @@ export default class BrowserstackEnvironment extends NodeEnvironment {
   }
 
   private async createWDDriver(capabilities?: BrowserstackCapabilities): Promise<WebDriver> {
-    const driverFactory = new Builder().usingServer(this.selHubUrl).withCapabilities(merge(this.btCapabilities, capabilities));
+    // checks if we have new capabilities
+    if (capabilities) {
+      // define username + accessKey + tunnelIdentifier if any
+      capabilities['bstack:options'].userName = this.btCapabilities['bstack:options'].userName;
+      capabilities['bstack:options'].accessKey = this.btCapabilities['bstack:options'].accessKey;
+
+      if (this.localIdentifier) {
+        capabilities['bstack:options'].localIdentifier = this.btCapabilities['bstack:options'].localIdentifier;
+      }
+    }
+
+    const driverFactory = new Builder().usingServer(this.selHubUrl).withCapabilities(capabilities || this.btCapabilities);
+
     const driver = await driverFactory.build();
 
     this.drivers.push(driver);