[ENG-2280] test: add giftaid playwright tests (#380)

* test: add giftaid playwright tests

* test: add postcode lookup tests

* add test for international postcode and address

* remove ERP test

* add giftaid update valid submission test

* add giftaid update tests

* add nightly-sanity tag to all tests to run nightly

* use the same sanity tests to run nightly

* remove email env vars from .env.example file

Author: KrupaPammi

package.json

@@ -39,6 +39,7 @@
     "start": "node scripts/start.js",
     "build": "node scripts/build.js",
     "lint": "eslint --color src tests",
+    "test:sanity": "playwright test --grep '@sanity'",
     "sanity-test": "export NODE_ENV=development; node_modules/.bin/nightwatch --tag sanity -e chrome --retries 2",
     "cy:run": "export NODE_ENV=development; cypress run",
     "cy:open": "export NODE_ENV=development; cypress open",

playwright/.env.example

@@ -0,0 +1,13 @@
+# Browserstack
+BASE_URL=https://giftaid-staging.comicrelief.com/
+BROWSERSTACK_USERNAME=krupapammi1
+BROWSERSTACK_ACCESS_KEY=
+
+# Contact service reporting staging
+CONTACT_SERVICE_REPORTING_BASE_URL=https://contact-staging.data.comicrelief.com/reporting
+CONTACT_SERVICE_REPORTING_API_KEY=
+
+#ERP Next
+ERP_HOST=https://erp-staging.comicrelief.com
+ERP_CLIENT=
+ERP_SECRET=

playwright/.gitignore

@@ -0,0 +1,2 @@
+test-results
+/node_modules

playwright/browserstack.js

@@ -0,0 +1,84 @@
+require('dotenv').config();
+
+const base = require('@playwright/test');
+const cp = require('child_process');
+const clientPlaywrightVersion = cp
+  .execSync('npx playwright --version')
+  .toString()
+  .trim()
+  .split(' ')[1];
+
+// BrowserStack Specific Capabilities.
+const caps = {
+  project: 'Giftaid',
+  // build: 'Your specified build name goes here',
+  name: 'e2e tests',
+  browser: 'chrome',
+  resolution: '1024x768',
+  os: 'osx',
+  os_version: 'catalina',
+  'browserstack.username': process.env.BROWSERSTACK_USERNAME,
+  'browserstack.accessKey': process.env.BROWSERSTACK_ACCESS_KEY,
+  'client.playwrightVersion': clientPlaywrightVersion,
+};
+
+// Patching the capabilities dynamically according to the project name.
+const patchCaps = (name, title) => {
+  let combination = name.split(/@browserstack/)[0];
+  let [browerCaps, osCaps] = combination.split(/:/);
+  let [browser, browser_version] = browerCaps.split(/@/);
+  let osCapsSplit = osCaps.split(/ /);
+  let os = osCapsSplit.shift();
+  let os_version = osCapsSplit.join(' ');
+  caps.browser = browser ? browser : 'chrome';
+  caps.browser_version = browser_version ? browser_version : 'latest';
+  caps.os = os ? os : 'osx';
+  caps.os_version = os_version ? os_version : 'catalina';
+  caps.name = title;
+};
+
+const isHash = (entity) => Boolean(entity && typeof(entity) === "object" && !Array.isArray(entity));
+const nestedKeyValue = (hash, keys) => keys.reduce((hash, key) => (isHash(hash) ? hash[key] : undefined), hash);
+const isUndefined = val => (val === undefined || val === null || val === '');
+const evaluateSessionStatus = (status) => {
+  if (!isUndefined(status)) {
+    status = status.toLowerCase();
+  }
+  if (status === "passed") {
+    return "passed";
+  } else if (status === "failed" || status === "timedout") {
+    return "failed";
+  } else {
+    return "";
+  }
+}
+
+exports.test = base.test.extend({
+  page: async ({ page, playwright }, use, testInfo) => {
+    // Use BrowserStack Launched Browser according to capabilities for cross-browser testing.
+    if (testInfo.project.name.match(/browserstack/)) {
+      patchCaps(testInfo.project.name,`${testInfo.title}`);
+      const vBrowser = await playwright.chromium.connect({
+        wsEndpoint:
+          `wss://cdp.browserstack.com/playwright?caps=` +
+          `${encodeURIComponent(JSON.stringify(caps))}`,
+      });
+      const vContext = await vBrowser.newContext(testInfo.project.use);
+      const vPage = await vContext.newPage();
+      await use(vPage);
+      const testResult = {
+        action: 'setSessionStatus',
+        arguments: {
+          status: evaluateSessionStatus(testInfo.status),
+          reason: nestedKeyValue(testInfo, ['error', 'message'])
+        },
+      };
+      await vPage.evaluate(() => {},
+        `browserstack_executor: ${JSON.stringify(testResult)}`);
+      await vPage.close();
+      await vBrowser.close();
+    } else {
+      use(page);
+    }
+  },
+});