Merge pull request #225 from karma-runner/fix/issue-210-w3c

fix: fixes issues with older browsers / caps

Author: wswebcreation

README.md

@@ -37,6 +37,7 @@ module.exports = function(config) {
   // Example set of browsers to run on Sauce Labs
   // Check out https://saucelabs.com/platforms for all browser/platform combos
   var customLaunchers = {
+    // Old JSONWP way of setting the capabilities
     sl_chrome: {
       base: 'SauceLabs',
       browserName: 'chrome',
@@ -67,7 +68,18 @@ module.exports = function(config) {
       version: '4.4',
       deviceName: 'Samsung Galaxy S3 Emulator',
       deviceOrientation: 'portrait'
-    }
+    },
+    // For W3C way of setting the capabilies check
+    // https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/
+    // And select WebDriver (W3C) Selenium 3/4, Webdriver.io
+    sl_chromeW3C: {
+      base: 'SauceLabs',
+      browserName: 'chrome',
+      browserVersion: 'latest',
+      'sauce:options':{
+        tags: ['w3c-chrome']
+      }
+    },
   }
 
   config.set({

examples/karma.conf-ci.js

@@ -10,17 +10,28 @@ module.exports = function (config) {
     sl_chrome: {
       base: 'SauceLabs',
       browserName: 'chrome',
-      version: 'latest'
+      version: 'latest',
+      tags: ['jsonwp-chrome']
+    },
+    sl_chromeW3C: {
+      base: 'SauceLabs',
+      browserName: 'chrome',
+      browserVersion: 'latest',
+      'sauce:options':{
+        tags: ['w3c-chrome']
+      }
     },
     sl_firefox: {
       base: 'SauceLabs',
       browserName: 'firefox',
-      version: 'latest'
+      version: 'latest',
+      tags: ['jsonwp-firefox']
     },
     sl_ie_11: {
       base: 'SauceLabs',
       browserName: 'internet explorer',
-      version: 'latest'
+      version: 'latest',
+      tags: ['jsonwp-ie11']
     }
   };
 

src/process-config.ts

@@ -1,13 +1,14 @@
 import {bootstrap} from 'global-agent'
+import {isW3C} from "./utils";
 
-export function processConfig (config: any = {}, args: any = {}) {
+export function processConfig(config: any = {}, args: any = {}) {
   const username = config.username || process.env.SAUCE_USERNAME;
   const accessKey = config.accessKey || process.env.SAUCE_ACCESS_KEY;
   const startConnect = config.startConnect !== false;
 
   let tunnelIdentifier = args.tunnelIdentifier || config.tunnelIdentifier;
 
-  // TODO: This option is very ambiguous because it technically only affects the reporter. Consider	
+  // TODO: This option is very ambiguous because it technically only affects the reporter. Consider
   // renaming in the future.
   const sauceApiProxy = args.proxy || config.proxy;
   if (sauceApiProxy) {
@@ -20,9 +21,7 @@ export function processConfig (config: any = {}, args: any = {}) {
   }
 
   // Browser name that will be printed out by Karma.
-  const browserName = args.browserName +
-    (args.version ? ' ' + args.version : '') +
-    (args.platform ? ' (' + args.platform + ')' : '');
+  const browserName = `${args.browserName} ${args.browserVersion || args.version || ''} ${args.platformName || args.platform || ''}`;
 
   // In case "startConnect" is enabled, and no tunnel identifier has been specified, we just
   // generate one randomly. This makes it possible for developers to use "startConnect" with
@@ -53,20 +52,27 @@ export function processConfig (config: any = {}, args: any = {}) {
   };
 
   // transform JWP capabilities into W3C capabilities for backward compatibility
-  args.browserVersion = args.browserVersion || args.version || 'latest'
-  args.platformName = args.platformName || args.platform || 'Windows 10'
-  // delete JWP capabilities
+  if (isW3C(args)) {
+    args.browserVersion = args.browserVersion || args.version || 'latest'
+    args.platformName = args.platformName || args.platform || 'Windows 10'
+    args['sauce:options'] = { ...(args['sauce:options'] || {}), ...capabilitiesFromConfig }
+
+    // delete JWP capabilities
+    delete args.version
+    delete args.platform
+  } else {
+    args = {...args, ...capabilitiesFromConfig}
+  }
+  // Not needed
   delete args.base
-  delete args.version
-  delete args.platform
+
   const seleniumCapabilities = {
     user: username,
     key: accessKey,
     region: config.region,
     headless: config.headless,
     logLevel: 'error',
     capabilities: {
-      'sauce:options': capabilitiesFromConfig,
       ...args
     },
     ...config.options

src/utils.ts

@@ -11,3 +11,8 @@ export async function waitUntil({condition, retries = 0, maxRetries = 50, interv
 
   return waitUntil({condition, retries: retries++, maxRetries, interval})
 }
+
+export function isW3C(capabilities){
+  // Only browserVersion is mandatory, platformName is optional
+  return Boolean(capabilities.browserVersion)
+}