[DEVX-1190] merge configs (#116)

* Merge config needed to run in sauce with customer's config

* fix unit test

* use correct key for headless

Author: mhan83

src/playwright-runner.js

@@ -238,8 +238,8 @@ async function run (nodeBin, runCfgPath, suiteName) {
 
   // Copy our runner's playwright config to a custom location in order to
   // preserve the customer's config which we may want to load in the future
-  const configFile = path.join(projectPath, 'custom.config.js');
-  fs.copyFileSync(path.join(__dirname, 'playwright.config.js'), configFile);
+  const configFile = path.join(projectPath, 'sauce.config.js');
+  fs.copyFileSync(path.join(__dirname, 'sauce.config.js'), configFile);
 
   const defaultArgs = {
     output: assetsDir,

src/playwright.config.js renamed to src/sauce.config.js

@@ -1,8 +1,14 @@
 const process = require('process');
+const _ = require('lodash');
 
-const defaults = {
+let userConfig = {};
+try {
+  userConfig = require('./playwright.config.js');
+} catch {}
+
+const overrides = {
   use: {
-    headed: process.env.SAUCE_VM ? true : false,
+    headless: process.env.SAUCE_VM ? false : true,
     video: process.env.SAUCE_VM ? 'off' : 'on',
   },
   reporter: [
@@ -18,9 +24,9 @@ if ('HTTP_PROXY' in process.env && process.env.HTTP_PROXY !== '') {
     server: process.env.HTTP_PROXY,
   };
 
-  defaults.use.contextOptions = { proxy, ignoreHTTPSErrors: true };
+  overrides.use.contextOptions = { proxy, ignoreHTTPSErrors: true };
   // Need to set the browser launch option as well, it is a hard requirement when testing chromium + windows.
-  defaults.use.launchOptions = { proxy, ignoreHTTPSErrors: true };
+  overrides.use.launchOptions = { proxy, ignoreHTTPSErrors: true };
 }
 
-module.exports = defaults;
+module.exports = _.merge(userConfig, overrides);

tests/fixtures/config-merging/.gitignore

@@ -0,0 +1 @@
+sauce.config.js

tests/fixtures/config-merging/README.md

@@ -0,0 +1,3 @@
+# Config Merging Playwright Test
+
+Small test to ensure local playwright config is being preserved.

tests/fixtures/config-merging/playwright.config.js

@@ -0,0 +1,9 @@
+/** @type {import('@playwright/test').PlaywrightTestConfig} */
+module.exports = {
+  use: {
+    'headed': false,
+    'video': false,
+    'timezoneId': 'Asia/Seoul',
+    reporter: [['dot']],
+  },
+};

tests/fixtures/config-merging/sauce-runner.json

@@ -0,0 +1,29 @@
+{
+    "sauce": {
+        "region": "us-west-1",
+        "metadata": {
+            "tags": ["tag1", "tag2"],
+            "build": "Local Test Build"
+        }
+    },
+    "playwright": {
+        "version": "1.12.3",
+        "projectPath": "./tests/fixtures/basic-js/"
+    },
+    "suites": [
+        {
+            "name": "config-merging",
+            "param": {
+              "browserName": "chromium",
+              "globalTimeout": 900000,
+              "grep": ".*",
+              "repeatEach": 1,
+              "retries": 0,
+              "shard": "1/2",
+              "timeout": 30000,
+              "maxFailures": 2
+            },
+            "testMatch": ".*.js"
+        }
+    ]
+}

tests/fixtures/config-merging/tests/timezone.spec.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright Microsoft Corporation. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { test, expect } = require('@playwright/test');
+
+test('timezone is being set from config', async ({ page }) => {
+  await page.goto('https://whatismytimezone.com/');
+  await expect(page.locator('article').first()).toContainText('Korean Standard Time');
+});

tests/unit/src/playwright-runner.spec.js

@@ -80,7 +80,7 @@ describe('playwright-runner', function () {
         '--output',
         path.join(MOCK_CWD, '__assets__'),
         '--config',
-        path.join(MOCK_CWD, 'custom.config.js'),
+        path.join(MOCK_CWD, 'sauce.config.js'),
         '--browser',
         'chromium',
         '--headed',