@spscommerce/e2e-core 1.0.2 → 1.1.0

package/.dockerignore

@@ -1,8 +1,7 @@
 # Ignore all files by default
 *
 # White list the required files
-!auth.json
-!env.config.ts
+!helpers/
 !credentials.sh
 !jest-environment.config.js
 !jest-playwright.config.js

package/Dockerfile

@@ -3,7 +3,8 @@ FROM mcr.microsoft.com/playwright:bionic
 # We need to install Edge manually since it does not exist in the official PW image
 # https://github.com/microsoft/playwright/blob/07fb81a4efdcc4c2169a61a16b513b9d91be6c49/src/server/chromium/findChromiumChannel.ts#L38
 
-RUN apt-get install wget \
+RUN apt-get update \
+    && apt-get install --reinstall wget \
     && wget -q -O - https://packages.microsoft.com/keys/microsoft.asc | apt-key add - \
     && echo "deb https://packages.microsoft.com/repos/edge stable main" >> /etc/apt/sources.list.d/microsoft-edge.list \
     && apt-get update -qqy \

package/README.md

@@ -39,7 +39,7 @@ HEADLESS=false BROWSER=chromium npm run test
 | ------------------: | -------------------------------------------------- | ------------------------------ | ------------------------------------ |
 | HEADLESS            | launch browser in headless/headful mode            | true                           | true, false                          |
 | BROWSER             | use + as a separator, e.g edge+firefox             | chromium                       | chromium, firefox, webkit, edge      |
-| ENV                 | auth state is invoked for the defined env          | test                           | test, prod                           |
+| URL                 | auth state is invoked for the defined env          | test                           | test, prod etc.                           |
 | SLOWMO              | slow down an execution for debugging               | 0                              | [number_in_ms]                       |
 | TIMEOUT             | global timeout for each test                       | 30000                          | [number_in_ms]                       |
 | WORKERS             | number of workers (test threads)                   | number of CPUs minus 1         | [number]                             |

package/helpers/apiCalls.ts

@@ -0,0 +1,75 @@
+import fetch from 'node-fetch';
+import { authEndpoint } from './envSetup';
+
+export async function getAuthToken(): Promise<string> {
+    if (process.env.USER_EMAIL && process.env.USER_PASSWORD) {
+        const requestOptions = {
+            method: 'POST',
+            body: JSON.stringify({
+                username: process.env.USER_EMAIL,
+                password: process.env.USER_PASSWORD,
+                client_id: "595",
+                grant_type: "password"
+            }),
+            headers: {
+                'Accept': 'application/json',
+                'Content-Type': 'application/json'
+            }
+        }
+        try {
+            const fetchResponse = await fetch(authEndpoint + 'identity/token/', requestOptions);
+            const data = await fetchResponse.json();
+            return data.access_token;
+        } catch (e) {
+            console.log(e);
+            return process.exit(1);
+        }
+    } else {
+        throw new Error(`Set up process environment variables: USER_EMAIL and USER_PASSWORD.`);
+    }
+}
+
+export async function getUserInfo(): Promise<any> {
+    const requestOptions = {
+        method: 'GET',
+        headers: {
+            'Authorization': `Bearer ${process.env.TOKEN}`,
+            'Accept': 'application/json',
+            'Content-Type': 'application/json'
+        }
+    }
+    try {
+        const fetchResponse = await fetch(authEndpoint + `identity/users/me/`, requestOptions);
+        const data = await fetchResponse.json();
+        return data;
+    } catch (e) {
+        console.log(e);
+        return process.exit(1);
+    }
+}
+
+export async function changePreferredOrg(orgID: string): Promise<void> {
+    const userData = await getUserInfo();
+    const requestOptions = {
+        method: 'PUT',
+        body: JSON.stringify({
+            email: userData.email,
+            first_name: userData.first_name,
+            last_name: userData.last_name,
+            preferred_org_id: orgID
+        }),
+        headers: {
+            'Authorization': `Bearer ${process.env.TOKEN}`,
+            'Accept': 'application/json',
+            'Content-Type': 'application/json'
+        }
+    }
+    try {
+        const fetchResponse = await fetch(authEndpoint + `identity/users/${userData.id}/`, requestOptions);
+        const data = await fetchResponse.json();
+        return data;
+    } catch (e) {
+        console.log(e);
+        return process.exit(1);
+    }
+}

package/helpers/authSetup.ts

@@ -1,14 +1,17 @@
-import { authFile } from "../env.config";
-import fs from 'fs';
+import { getAuthToken, changePreferredOrg } from './apiCalls';
+import { primaryOrgID } from './envSetup';
 
-export async function authenticate(): Promise<void> {
-  const authStorage = fs.readFileSync(authFile, 'utf8');
-  await context.addInitScript(([storageDump]) => {
-    const entries = JSON.parse(storageDump);
-    Object.keys(entries).forEach(k => {
-      window.localStorage.setItem(k, entries[k]);
-    });
-  }, [authStorage]);
+export async function authenticate(orgID?: string): Promise<void> {
+  if (orgID) {
+    await changePreferredOrg(orgID);
+    process.env.TOKEN = await getAuthToken();
+  } else {
+    await changePreferredOrg(primaryOrgID);
+    process.env.TOKEN = await getAuthToken();
+  }
+  await page.addInitScript(params => {
+    window.localStorage.setItem(params.name, params.value);
+  }, { name: "access_token", value: process.env.TOKEN });
   return;
 }
 

package/helpers/envSetup.ts

@@ -0,0 +1,9 @@
+let authEndpoint = 'https://test.id.spsc.io/';
+let primaryOrgID = '209098808305562446811265341033453015703'; // SPS Commerce org id on test env
+
+if (process.env.URL && process.env.URL.toLowerCase().includes('prod')) {
+    authEndpoint = 'https://id.spsc.io/';
+    primaryOrgID = '157627141979612915626333577105111854232'; // SPS Commerce org id on prod env
+}
+
+export { authEndpoint, primaryOrgID };

package/helpers/loggerSetup.ts

@@ -1,5 +1,5 @@
-const path = require('path');
-const fs = require('fs');
+import fs from "fs";
+import path from "path";
 
 let access: any;
 
@@ -13,7 +13,7 @@ export async function enableTracer(): Promise<void> {
 
 export async function disableTracer(): Promise<void> {
     const testName = expect.getState().currentTestName.replace(/ /g, "");
-    const tracePathPerSuite = path.join(process.cwd(), 'results/traces');
+    const tracePathPerSuite = path.join(process.cwd(), 'results-e2e/traces');
     
     // Stop tracing and write it to file per test
     try {
@@ -28,7 +28,7 @@ export async function disableTracer(): Promise<void> {
 
 export async function enableLogger(): Promise<void> {
     const testName = expect.getState().currentTestName.replace(/ /g, "");
-    const logPathPerSuite = path.join(process.cwd(), 'results/logs');
+    const logPathPerSuite = path.join(process.cwd(), 'results-e2e/logs');
 
     // Create folder per suite for error files
     await fs.mkdirSync(logPathPerSuite, { recursive: true });
@@ -37,11 +37,6 @@ export async function enableLogger(): Promise<void> {
     access = fs.createWriteStream(`${logPathPerSuite}/${testName}.log`)
     process.stdout.write = process.stderr.write = access.write.bind(access);
 
-    // Write the GitHub link of the currently running test to the beginning of each log file
-    const testNameGH = testName.split('_').slice(2).join('_');
-    // Set up your repository url here
-    console.log(`https://github.com/SPSCommerce/[your_GH_repo_name]/search?q=${testNameGH}`);
-
     // Listen for errors
     page
         .on('console', async message => {

package/jest-environment.config.js

@@ -18,7 +18,6 @@ class JestEnvironmentFailFast extends ParentEnvironment {
         await super.teardown();
         if (this.videos.length !== 0) {
             const { recordVideo } = pwConfig.contextOptions;
-            console.log(this.videos)
             const anyTestFailed = this.videos.find(element => element.success !== true);
             if (anyTestFailed) {
                 const newVideoName = `${recordVideo.dir}/${anyTestFailed.testSuiteName}.webm`;
@@ -37,8 +36,8 @@ class JestEnvironmentFailFast extends ParentEnvironment {
         // TEST STARTED
         // Delete already existing screenshot/trace file before test starts if it ran twice due to jest.retryTimes()
         if (event.name === 'test_start') {
-            const traceFilePerTest = path.join(process.cwd(), `results/traces/${event.test.parent.name}${event.test.name}.zip`);
-            const screenFilePerTest = path.join(process.cwd(), `results/screenshots/${event.test.parent.name}${event.test.name}.png`);
+            const traceFilePerTest = path.join(process.cwd(), `results-e2e/traces/${event.test.parent.name}${event.test.name}.zip`);
+            const screenFilePerTest = path.join(process.cwd(), `results-e2e/screenshots/${event.test.parent.name}${event.test.name}.png`);
             if (fs.existsSync(traceFilePerTest)) {
                 fs.unlinkSync(traceFilePerTest);
             }
@@ -55,7 +54,7 @@ class JestEnvironmentFailFast extends ParentEnvironment {
             if (state.currentlyRunningTest) {
                 await this.global.page.screenshot({
                     fullPage: true,
-                    path: process.cwd() + `/results/screenshots/${event.test.parent.name}${event.test.name}.png`,
+                    path: process.cwd() + `/results-e2e/screenshots/${event.test.parent.name}${event.test.name}.png`,
                 });
             }
         }
@@ -63,7 +62,7 @@ class JestEnvironmentFailFast extends ParentEnvironment {
         // TEST FINISHED SUCCESSFULLY
         // Delete trace file for each succeeded test
         if (event.name === 'test_done' && event.test.errors.length === 0) {
-            const traceFilePerTest = path.join(process.cwd(), `results/traces/${event.test.parent.name}${event.test.name}.zip`);
+            const traceFilePerTest = path.join(process.cwd(), `results-e2e/traces/${event.test.parent.name}${event.test.name}.zip`);
             if (fs.existsSync(traceFilePerTest)) {
                 fs.unlinkSync(traceFilePerTest);
             }
@@ -81,8 +80,8 @@ class JestEnvironmentFailFast extends ParentEnvironment {
 
         // TEST FINISHES AND FAILS
         // Skip all further tests in the suite (all tests are related to each other) if 
-        // - any test is failed AND suite name includes 'long_scenario'
-        if (this.failedTest && event.name === 'test_start' && event.test.parent.name.includes('long_scenario')) {
+        // - any test is failed AND suite name includes 'FailFast'
+        if (this.failedTest && event.name === 'test_start' && event.test.parent.name.includes('FailFast')) {
             event.test.mode = 'skip';
         }
     }

package/jest-playwright.config.js

@@ -1,3 +1,8 @@
+const customViewport = {
+    width: 1920,
+    height: 1080,
+}
+
 let runModeBrowser = [];
 
 // Run in chromium browser by default (if process.env.BROWSER is not specified)
@@ -19,13 +24,10 @@ if (!process.env.BROWSER) {
             case 'webkit':
                 runModeBrowser.push('webkit');
                 break;
-            // Pay attention: browserName is 'chromium' for Edge browser (mentioned in describe)
-            // https://support.microsoft.com/en-us/microsoft-edge/download-the-new-microsoft-edge-based-on-chromium-0f4a3dd7-55df-60f5-739f-00010dba52cf
             case 'edge':
             case 'msedge':
-                // Channel is 'msedge-dev' since only it is available in linux
-                // https://github.com/microsoft/playwright/blob/07fb81a4efdcc4c2169a61a16b513b9d91be6c49/src/server/chromium/findChromiumChannel.ts#L38
                 runModeBrowser.push({ displayName: 'edge', name: 'chromium', launchOptions: { channel: 'msedge-dev' } });
+                // https://github.com/microsoft/playwright/blob/07fb81a4efdcc4c2169a61a16b513b9d91be6c49/src/server/chromium/findChromiumChannel.ts#L38
                 break;
             default:
                 runModeBrowser.push('chromium');
@@ -38,22 +40,27 @@ if (!process.env.BROWSER) {
 // Run in headless mode by default (if process.env.HEADLESS is not specified)
 const runModeHead = !process.env.HEADLESS || process.env.HEADLESS === 'true' ? true : false;
 
+// Apply customViewport while running in headless mode
+const runModeViewport = runModeHead ? customViewport : null;
+
+let runModeArgs = [];
+
+if (runModeBrowser === ['chromium'] && runModeHead === false) {  
+    runModeArgs = ['--window-size=1920,1080'];
+}
+
 module.exports = {
     exitOnPageError: false,
     launchOptions: {
+        args: runModeArgs,
         headless: runModeHead,
         slowMo: process.env.SLOWMO ? +process.env.SLOWMO : 0,
     },
     launchType: "LAUNCH",
     contextOptions: {
         acceptDownloads: true,
-        viewport: {
-            width: 1920,
-            height: 1080
-          },
-        recordVideo: process.env.VIDEO && {
-            dir: process.cwd() + '/results/video',
-        }
+        viewport: runModeViewport,
+        ...(process.env.VIDEO && {recordVideo: { dir: process.cwd() + '/results/video' } }),
     },
     browsers: runModeBrowser
 }

package/jest.auth.js

@@ -1,37 +1,5 @@
-const { authFile, authRequest } = require('./env.config');
-const fetch = require('node-fetch');
-const fs = require('fs');
+const { getAuthToken } = require('./helpers/apiCalls');
 
 module.exports = async () => {
-  // Run the script, if auth[Env].json file does not exist yet
-  if (!fs.existsSync(authFile)) {
-    // Send auth request, if process.env.USER_EMAIL and process.env.USER_PASSWORD are set up
-    if (process.env.USER_EMAIL) {
-      const rawResponse = await fetch(authRequest, {
-        method: 'POST',
-        body: JSON.stringify({
-          username: process.env.USER_EMAIL,
-          password: process.env.USER_PASSWORD,
-          client_id: "595",
-          grant_type: "password"
-        }),
-        headers: {
-          'Content-Type': 'application/json'
-        }
-      });
-      const requestContent = await rawResponse.json();
-      // Save token into the newly created auth[Env].json file, if token value exists in the response
-      if (requestContent.access_token) {
-        fs.copyFileSync('./auth.json', authFile)
-        let fileContent = JSON.parse(fs.readFileSync(authFile, 'utf8'));
-        fileContent.access_token = requestContent.access_token;
-        fs.writeFileSync(authFile, JSON.stringify(fileContent));
-      } else {
-        console.log(`Auth request response: ${JSON.stringify(requestContent)}`)
-        throw new Error(`Something went wrong while invoking auth state.`);
-      }
-    } else {
-      throw new Error(`Set up process.env.USER_EMAIL and process.env.USER_PASSWORD (run "source .credentials.sh" locally).`);
-    }
-  }
+  process.env.TOKEN = await getAuthToken();
 }

package/jest.config.js

@@ -10,13 +10,14 @@ module.exports = {
         includeShortConsoleOutput: true,
         classNameTemplate: "{classname}",
         titleTemplate: "{classname}{title}",
-        outputDirectory: "results/jest-junit-report",
+        outputDirectory: "results-e2e/jest-junit-report",
         outputName: process.env.SUITE ? `TEST-${process.env.SUITE}.xml` : `TEST-result.xml`
       },
     ],
   ],
   setupFilesAfterEnv: [
     "./jest.setup.js",
+    "jest-extended/all",
     // https://github.com/mattphillips/jest-expect-message/issues/39
     // "jest-expect-message",
     "@alex_neo/jest-expect-message"
@@ -27,5 +28,8 @@ module.exports = {
   transform: {
     "^.+\\.(ts)$": "ts-jest",
   },
+  transformIgnorePatterns: [
+    "/node_modules/?!(@spscommerce/e2e-core)"
+  ],
   verbose: true,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spscommerce/e2e-core",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "An automation test framework which is based on playwright, jest and ts",
   "scripts": {
     "test": "jest",
@@ -25,6 +25,7 @@
     "@alex_neo/jest-expect-message": "^1.0.5",
     "@types/jest": "^26.0.24",
     "@types/jest-expect-message": "^1.0.3",
+    "@types/node-fetch": "^3.0.3",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
     "eslint": "^7.32.0",
@@ -33,10 +34,12 @@
     "jest": "^27.3.1",
     "jest-circus": "^27.3.1",
     "jest-expect-message": "^1.0.2",
+    "jest-extended": "^1.2.0",
     "jest-junit": "^13.0.0",
     "jest-playwright-preset": "^1.7.0",
-    "node-fetch": "^2.6.5",
+    "node-fetch": "^2.6.6",
     "playwright": "^1.16.1",
+    "playwright-core": "^1.17.1",
     "ts-jest": "^27.0.7",
     "typescript": "^4.4.4"
   }

package/auth.json

@@ -1 +0,0 @@
-{"access_token":"","orgHint":"[\"209098808305562446811265341033453015703\"]"}

package/env.config.ts

@@ -1,9 +0,0 @@
-let authFile = './authTest.json';
-let authRequest = 'https://test.id.spsc.io/identity/token/';
-
-if (process.env.ENV && process.env.ENV.toLowerCase() === 'prod') {
-  authFile = './authProd.json';
-  authRequest = 'https://id.spsc.io/identity/token/';
-}
-
-export { authFile, authRequest }