@spscommerce/e2e-core 1.1.0 → 1.1.4

package/helpers/apiCalls.ts

@@ -1,5 +1,10 @@
 import fetch from 'node-fetch';
-import { authEndpoint } from './envSetup';
+
+let authEndpoint = 'https://test.id.spsc.io/';
+
+if (process.env.URL && process.env.URL.toLowerCase().includes('prod')) {
+    authEndpoint = 'https://id.spsc.io/';
+}
 
 export async function getAuthToken(): Promise<string> {
     if (process.env.USER_EMAIL && process.env.USER_PASSWORD) {
@@ -56,7 +61,10 @@ export async function changePreferredOrg(orgID: string): Promise<void> {
             email: userData.email,
             first_name: userData.first_name,
             last_name: userData.last_name,
-            preferred_org_id: orgID
+            preferred_org_id: orgID,	
+            organization: {	
+                id: orgID	
+            }
         }),
         headers: {
             'Authorization': `Bearer ${process.env.TOKEN}`,

package/helpers/authSetup.ts

@@ -1,14 +1,21 @@
-import { getAuthToken, changePreferredOrg } from './apiCalls';
-import { primaryOrgID } from './envSetup';
+import { changePreferredOrg, getAuthToken, getUserInfo } from '../helpers/apiCalls';
 
-export async function authenticate(orgID?: string): Promise<void> {
-  if (orgID) {
+export async function authenticate(orgID: string): Promise<void> {
+  const testSuiteName = expect.getState().testPath.split('/').pop().split('.').reverse()[2];
+  process.env.TOKEN = await getAuthToken();
+  let userData = await getUserInfo();
+  console.log(`${testSuiteName} suite authentication flow: 
+  Current preferred org: ${userData.preferred_org_id}.
+  Current org: ${userData.organization.organization_name}.`);
+  while (userData.preferred_org_id !== orgID || userData.organization.id !== orgID) {
     await changePreferredOrg(orgID);
     process.env.TOKEN = await getAuthToken();
-  } else {
-    await changePreferredOrg(primaryOrgID);
-    process.env.TOKEN = await getAuthToken();
+    userData = await getUserInfo();
+    console.log(`${testSuiteName} suite authentication flow: 
+    Preferred org was changed to: ${userData.preferred_org_id}.
+    Current org was changed to: ${userData.organization.organization_name}.`);
   }
+  console.log(process.env.TOKEN);
   await page.addInitScript(params => {
     window.localStorage.setItem(params.name, params.value);
   }, { name: "access_token", value: process.env.TOKEN });
@@ -19,5 +26,7 @@ export async function unauthenticate(): Promise<void> {
   await context.clearCookies();
   await context.addInitScript(() => window.localStorage.clear());
   await context.addInitScript(() => window.sessionStorage.clear());
+  await page.goto(process.env.BASEURL);
+  await page.waitForURL(/https:\/\/auth.*/);
   return;
 }

package/jest-environment.config.js

@@ -32,6 +32,7 @@ class JestEnvironmentFailFast extends ParentEnvironment {
     // https://github.com/facebook/jest/issues/10059
     // https://github.com/facebook/jest/blob/main/packages/jest-circus/src/eventHandler.ts
     async handleTestEvent(event, state) {
+        await super.handleTestEvent(event);
 
         // TEST STARTED
         // Delete already existing screenshot/trace file before test starts if it ran twice due to jest.retryTimes()
@@ -46,8 +47,17 @@ class JestEnvironmentFailFast extends ParentEnvironment {
             }
         }
 
-        // TEST FAILED
-        // Take a screenshot for each failed test while running in CI
+        // HOOK FAILS
+        // Take a screenshot for each failed test
+        if (event.name === 'hook_failure') {
+            await this.global.page.screenshot({
+                fullPage: true,
+                path: process.cwd() + `/results-e2e/screenshots/${event.hook.parent.name.replace(/_$/, '')}.png`,
+            });
+        }
+
+        // TEST FAILS
+        // Take a screenshot for each failed test
         if (event.name === 'test_fn_failure' && !event.test.parent.name.includes('visual')) {
             this.failedTest = true;
             this.failedTestName = event.test.name;
@@ -70,14 +80,13 @@ class JestEnvironmentFailFast extends ParentEnvironment {
 
         // TEST FINISHED AND VIDEO OPTION IS SET TO TRUE
         // Save test status, test suite name and random PW video name
-        if (event.name === "test_done" && process.env.VIDEO) {
+        if (event.name === "test_done" && process.env.VIDEO && (process.env.VIDEO.toLowerCase() === 'true')) {
             const success = event.test.errors.length === 0 ? true : false;
             const testSuiteName = event.test.parent.name;
             const videoName = await this.global.page.video().path();
             this.videos.push({ testSuiteName, videoName, success });
         }
 
-
         // 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 'FailFast'

package/jest.setup.js

@@ -1,18 +1,11 @@
-const { authenticate } = require('./helpers/authSetup');
 const { enableTracer, disableTracer, enableLogger, disableLogger } = require('./helpers/loggerSetup');
 
-// Global hooks
-// You can add additional hooks for a specific suite directly in the test file
-beforeAll(async () => {
-  await authenticate();
-});
-
 if (process.env.LOGGER || process.env.TRACER) {
   beforeEach(async () => {
     process.env.LOGGER && (process.env.LOGGER.toLowerCase() === 'true') && await enableLogger();
     process.env.TRACER && (process.env.TRACER.toLowerCase() === 'true') && await enableTracer();
   });
-
+  
   afterEach(async () => {
     process.env.LOGGER && (process.env.LOGGER.toLowerCase() === 'true') && await disableLogger();
     process.env.TRACER && (process.env.TRACER.toLowerCase() === 'true') && await disableTracer();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spscommerce/e2e-core",
-  "version": "1.1.0",
+  "version": "1.1.4",
   "description": "An automation test framework which is based on playwright, jest and ts",
   "scripts": {
     "test": "jest",

package/helpers/envSetup.ts

@@ -1,9 +0,0 @@
-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 };