[DEVX-1973] Support chrome (#181)

* [DEVX-1973] Support chrome

* remove useChrome config

* report chrome

* run post release test on mac12

* update playwright version in post release test

* refine playwright config

* add comments for browser settings

* Update src/sauce.config.js

Co-authored-by: Alex Plischke <[email protected]>

Co-authored-by: Alex Plischke <[email protected]>

Author: tianfeng92

src/constants.js

@@ -19,3 +19,5 @@ exports.LOG_FILES = [
 ];
 
 exports.DESIRED_BROWSER = process.env.BROWSER_NAME || 'chromium';
+
+exports.DOCKER_CHROME_PATH = '/opt/google/chrome/google-chrome';

src/playwright-runner.js

@@ -7,7 +7,7 @@ const utils = require('./utils');
 const {createJobReport} = require('./reporter');
 const {prepareNpmEnv, loadRunConfig, escapeXML, preExec} = require('sauce-testrunner-utils');
 const {updateExportedValue} = require('sauce-testrunner-utils').saucectl;
-const {LOG_FILES} = require('./constants');
+const {LOG_FILES, DOCKER_CHROME_PATH} = require('./constants');
 const glob = require('glob');
 const convert = require('xml-js');
 const {runCucumber} = require('./cucumber-runner');
@@ -341,10 +341,18 @@ async function run(nodeBin, runCfgPath, suiteName) {
 }
 
 async function runPlaywright(nodeBin, runCfg) {
+  let excludeParams = ['screenshot-on-failure', 'video', 'slow-mo', 'headless', 'headed'];
+
   process.env.BROWSER_NAME = runCfg.suite.param.browserName;
   process.env.HEADLESS = runCfg.suite.param.headless;
   process.env.SAUCE_SUITE_NAME = runCfg.suite.name;
   process.env.SAUCE_ARTIFACTS_DIRECTORY = runCfg.assetsDir;
+  if (runCfg.suite.param.browserName === 'chrome') {
+    excludeParams.push('browser');
+  }
+  if (!process.env.SAUCE_VM) {
+    process.env.BROWSER_PATH = DOCKER_CHROME_PATH;
+  }
 
   if (runCfg.playwright.configFile) {
     const playwrightCfgFile = path.join(runCfg.projectPath, runCfg.playwright.configFile);
@@ -381,7 +389,6 @@ async function runPlaywright(nodeBin, runCfg) {
   }
   let args = _.defaultsDeep(defaultArgs, utils.replaceLegacyKeys(suite.param));
 
-  let excludeParams = ['screenshot-on-failure', 'video', 'slow-mo', 'headless', 'headed'];
 
   // There is a conflict if the playwright project has a `browser` defined,
   // since the job is launched with the browser set by saucectl, which is now set as the job's metadata.

src/sauce.config.js

@@ -27,9 +27,9 @@ for (const file of configFiles) {
 
 const overrides = {
   use: {
-    browserName: process.env.BROWSER_NAME, // override browserName with suite browserName
     headless: process.env.SAUCE_VM ? process.env.HEADLESS === 'true' : true,
     video: process.env.SAUCE_VM ? 'off' : 'on',
+    launchOptions: {},
   },
   reporter: [
     ['list'],
@@ -47,6 +47,17 @@ const overrides = {
   testIgnore: process.env.TEST_IGNORE,
 };
 
+if (process.env.BROWSER_NAME !== 'chrome') {
+  // chromium, firefox and webkit come pre-packaged with playwright.
+  // So we can just pass those browser values to playwright and
+  // it knows what to do and where to pick them up.
+  overrides.use.browserName = process.env.BROWSER_NAME; // override browserName with suite browserName
+} else {
+  // Google chrome is provided by the sauce VM (or docker image). So we have to let playwright know where to look.
+  overrides.use.channel = 'chrome';
+  overrides.use.launchOptions.executablePath = process.env.BROWSER_PATH;
+}
+
 if ('HTTP_PROXY' in process.env && process.env.HTTP_PROXY !== '') {
   const proxy = {
     server: process.env.HTTP_PROXY,

tests/fixtures/post-release/.sauce/config_mac.yml

@@ -10,22 +10,22 @@ rootDir: .
 playwright:
   # CAUTION: This has to be an already deployed framework version in the cloud. Not necessarily the one you want to test.
   # Then use --runner-version to specify the release you actually want to use.
-  version: 1.18.1
+  version: 1.27.1
 suites:
   - name: "Post Release Test (macOS) - chromium"
-    platformName: "macOS 11.00"
+    platformName: "macOS 12"
     testMatch: ['.*.js']
     params:
       browserName: "chromium"
 
   - name: "Post Release Test (macOS) - webkit"
-    platformName: "macOS 11.00"
+    platformName: "macOS 12"
     testMatch: ['.*.js']
     params:
       browserName: "webkit"
 
   - name: "Post Release Test (macOS) - firefox"
-    platformName: "macOS 11.00"
+    platformName: "macOS 12"
     testMatch: ['.*.js']
     params:
       browserName: "firefox"

tests/fixtures/post-release/.sauce/config_win.yml

@@ -10,7 +10,7 @@ rootDir: .
 playwright:
   # CAUTION: This has to be an already deployed framework version in the cloud. Not necessarily the one you want to test.
   # Then use --runner-version to specify the release you actually want to use.
-  version: 1.18.1
+  version: 1.27.1
 suites:
   - name: "Post Release Test (Windows) - chromium"
     platformName: "Windows 10"