test: add mobile browsers for testing

Author: jaissica12

.github/workflows/cross-browser-testing-mobile.yml

@@ -0,0 +1,39 @@
+name: 'BrowserStack Mobile Test'
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  browserstack-mobile-test:
+    name: 'BrowserStack Mobile Test'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'BrowserStack Env Setup'
+        uses: browserstack/github-actions/setup-env@master
+        with:
+          username:  ${{ secrets.BROWSERSTACK_USERNAME }}
+          access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+
+      - name: 'BrowserStack Local Tunnel Setup'
+        uses: browserstack/github-actions/setup-local@master
+        with:
+          local-testing: start
+          local-identifier: random
+
+      - name: 'Checkout the repository'
+        uses: actions/checkout@v3
+
+      - name: 'Run NPM CI'
+        run: npm ci
+
+      - name: Run Build IIFE
+        run: npm run build:iife
+
+      - name: 'Run NPM build test bundle'
+        run: npm run build:test-bundle
+
+      - name: 'Run Browserstack Mobile Tests'
+        run: npm run test:browserstack-mobile
+
+      - name: 'BrowserStackLocal Stop'
+        uses: browserstack/github-actions/setup-local@master
+        with:
+          local-testing: stop

package.json

@@ -43,6 +43,8 @@
         "test": "npm run build && npm run build:test-bundle && cross-env DEBUG=false karma start test/karma.config.js",
         "test:browserstack": "karma start test/cross-browser-testing/browserstack.karma.config.js",
         "test:browserstack:debug": "cross-env DEBUG=true karma start test/cross-browser-testing/browserstack.karma.config.js",
+        "test:browserstack-mobile": "karma start test/cross-browser-testing/browserstack.karma.mobile.config.js",
+        "test:browserstack-mobile:debug": "cross-env DEBUG=true karma start test/cross-browser-testing/browserstack.karma.mobile.config.js",
         "test:debug": "cross-env DEBUG=true karma start test/karma.config.js",
         "test:stub": "cross-env TESTTYPE=stub ENVIRONMENT=prod rollup --config rollup.test.config.js && karma start test/stub/karma.stub.config.js",
         "test:integrations": "npm run test:requirejs && npm run test:integrations:cjs && npm run test:integrations:module",

test/cross-browser-testing/browserstack.karma.mobile.config.js

@@ -0,0 +1,113 @@
+const { DEBUG } = process.env;
+
+const files = [
+  '../lib/geomock.js',
+  '../../dist/mparticle.js',
+  '../test-bundle.js',
+];
+
+let captureConsole = false;
+let browserConsoleLogOptions = {};
+
+if (DEBUG === 'true') {
+    browserConsoleLogOptions = {
+        level: 'log',
+        format: '%b %T: %m',
+        terminal: true,
+    };
+    captureConsole = true;
+} else {
+    browserConsoleLogOptions = {
+        terminal: false,
+    };
+}
+
+const customLaunchers = {
+  // Android Mobile Browsers
+  bs_android_chrome: {
+    base: 'BrowserStack',
+    device: 'Google Pixel 8',
+    os: 'android',
+    os_version: '14.0',
+    real_mobile: true,
+    browser: 'chrome'
+  },
+  bs_android_firefox: {
+    base: 'BrowserStack',
+    device: 'Google Pixel 8',
+    os: 'android',
+    os_version: '14.0',
+    real_mobile: true,
+    browser: 'firefox'
+  },
+  bs_android_samsung: {
+    base: 'BrowserStack',
+    device: 'Samsung Galaxy S23',
+    os: 'android',
+    os_version: '13.0',
+    real_mobile: true,
+    browser: 'samsung'
+  },
+  
+  // iOS Mobile Browsers
+  bs_ios_safari: {
+    base: 'BrowserStack',
+    device: 'iPhone 15 Pro',
+    os: 'ios',
+    os_version: '17',
+    real_mobile: true,
+    browser: 'safari'
+  },
+  bs_ios_chrome: {
+    base: 'BrowserStack',
+    device: 'iPhone 15 Pro',
+    os: 'ios',
+    os_version: '17',
+    real_mobile: true,
+    browser: 'chrome'
+  },
+  bs_ios_firefox: {
+    base: 'BrowserStack',
+    device: 'iPhone 15 Pro',
+    os: 'ios',
+    os_version: '17',
+    real_mobile: true,
+    browser: 'firefox'
+  },
+};
+
+module.exports = function(config) {
+  config.set({
+    browserStack: {
+      username: process.env.BS_USERNAME,
+      accessKey: process.env.BS_ACCESS_KEY,
+      local: true,
+    },
+    autoWatch: false,
+    customLaunchers,
+    browsers: Object.keys(customLaunchers),
+    frameworks: ['mocha', 'should'],
+    files,
+    reporters: ['progress', 'junit'],
+    colors: true,
+    singleRun: true,
+    debug: true,
+    logLevel: config.LOG_INFO,
+    browserConsoleLogOptions,
+    client: {
+      captureConsole,
+      mocha: {
+        timeout: 10000
+      }
+    },
+    junitReporter: {
+      outputDir: 'reports/',
+      outputFile: 'test-karma-mobile.xml',
+    },
+    browserDisconnectTimeout: 180000,
+    browserDisconnectTolerance: 5,
+    concurrency: 1,
+    captureTimeout: 180000,
+    browserNoActivityTimeout: 180000,
+  });
+};