@spscommerce/e2e-core 2.4.10 → 2.4.12

package/.dockerignore

@@ -1,8 +1,8 @@
 # Ignore all files by default
 *
 # White list the required files
-!helpers/
-!package-lock.json
+!.yarnrc.yml
 !package.json
+!playwright.config.js
 !tsconfig.json
-!playwright.config.ts
+!yarn.lock

package/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/Dockerfile

@@ -5,6 +5,7 @@ ARG BROWSER
 RUN mkdir e2e
 WORKDIR /e2e
 COPY . .
+RUN corepack enable && corepack prepare yarn@4.4.0 --activate
 RUN yarn
 RUN if [ "$BROWSER" = "edge" ]; then npx playwright install msedge; fi
 RUN if [ "$BROWSER" = "chrome" ]; then npx playwright install chrome; fi

package/Example.test.ts

@@ -4,7 +4,7 @@ import { enableLogger, disableLogger } from './src/loggerSetup';
 
 test.describe('SPS_Example', () => {
 
-  // test.describe.configure({ retries: 1 });
+  test.describe.configure({ retries: 1 });
 
   test.beforeEach(async ({ page }, testInfo) => {
     process.env.CI && await enableLogger(testInfo.titlePath, page);

package/README.md

@@ -129,7 +129,14 @@ RUN if [ "$BROWSER" = "chrome" ]; then npx playwright install chrome; fi
 
 ## Publish package
 If you want to publish your package to the npm registry and have changed any files from `src` folder, you must build the package first. Run the following command: `yarn build`.
-After that, push changed files from the `lib` and `src` folders to your PR.
+After that, push changed files from the `lib` and `src` folders to your PR. You need to follow the [pattern](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) of the semantic commit messages (should begin from __fix:__ or __feat:__), like:
+```
+fix: Update Dockerfile to restore build process
+```
+or
+```
+feat: Bump @playwright/test package to the last version
+```
 
 ## Run tests in CI (Azure Pipelines)
 In order to add an Azure Pipeline for your framework, head over to https://dev.azure.com/spscommerce/ and find your team. You can create a new pipeline by selecting your Git repository. For more information on getting started with Azure, visit https://github.com/SPSCommerce/azure-pipelines-config.

package/lib/index.d.ts

@@ -1,4 +1,3 @@
 export * from './globalSetup';
-export * from './globalTeardown';
 export * from './loggerSetup';
 export { default as expect } from './matchersSetup';

package/lib/index.js

@@ -19,7 +19,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expect = void 0;
 __exportStar(require("./globalSetup"), exports);
-__exportStar(require("./globalTeardown"), exports);
 __exportStar(require("./loggerSetup"), exports);
 var matchersSetup_1 = require("./matchersSetup");
 Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return __importDefault(matchersSetup_1).default; } });

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,mDAAiC;AACjC,gDAA8B;AAC9B,iDAAoD;AAA3C,wHAAA,OAAO,OAAU"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,gDAA8B;AAC9B,iDAAoD;AAA3C,wHAAA,OAAO,OAAU"}

package/lib/reporters/junitFix.d.ts

@@ -0,0 +1,10 @@
+import type { Reporter } from '@playwright/test/reporter';
+interface JUnitFixOptions {
+    reportJunitFile?: string;
+}
+declare class JunitFixReporter implements Reporter {
+    private readonly reportJunitFile;
+    constructor(options: JUnitFixOptions);
+    onEnd(): void;
+}
+export default JunitFixReporter;

package/lib/reporters/junitFix.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+class JunitFixReporter {
+    reportJunitFile;
+    constructor(options) {
+        this.reportJunitFile = options.reportJunitFile;
+    }
+    onEnd() {
+        const report = fs_1.default.readFileSync(this.reportJunitFile);
+        const reportFixed = String(report).replaceAll(/<testcase(\s+)name="([^"]+?)"/gi, (_all, spaces, name) => {
+            // Replace 'test case > test name' to the 'test name test case'
+            if (name)
+                name = name.replaceAll(/ › /g, ' ');
+            return `<testcase${spaces}name="${name}"`;
+        });
+        fs_1.default.writeFileSync(this.reportJunitFile, reportFixed);
+    }
+}
+exports.default = JunitFixReporter;
+//# sourceMappingURL=junitFix.js.map

package/lib/reporters/junitFix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"junitFix.js","sourceRoot":"","sources":["../../src/reporters/junitFix.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AAOpB,MAAM,gBAAgB;IACH,eAAe,CAAU;IAE1C,YAAY,OAAwB;QAClC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IACjD,CAAC;IAED,KAAK;QACH,MAAM,MAAM,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,CAC3C,iCAAiC,EACjC,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YACrB,+DAA+D;YAC/D,IAAI,IAAI;gBAAE,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC9C,OAAO,YAAY,MAAM,SAAS,IAAI,GAAG,CAAC;QAC5C,CAAC,CACF,CAAC;QACF,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;CACF;AAED,kBAAe,gBAAgB,CAAC"}

package/lib/reporters/screenshots.d.ts

@@ -0,0 +1,5 @@
+import type { Reporter, TestCase, TestResult } from '@playwright/test/reporter';
+declare class ScreenshotsReporter implements Reporter {
+    onTestEnd(test: TestCase, result: TestResult): void;
+}
+export default ScreenshotsReporter;

package/lib/reporters/screenshots.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+// Simple reporter for copy attachments to the screenshots folder
+class ScreenshotsReporter {
+    onTestEnd(test, result) {
+        const screenshotsDirName = path_1.default.join(process.cwd(), 'results-e2e/screenshots/');
+        result.attachments.forEach(attachment => {
+            // Create folder if un-exists
+            if (!fs_1.default.existsSync(screenshotsDirName))
+                fs_1.default.mkdirSync(screenshotsDirName, { recursive: true });
+            // Copy file as '<description> <test name>.<file ext>'
+            fs_1.default.copyFileSync(attachment.path, path_1.default.join(screenshotsDirName, `${test.titlePath().at(-2)} ${test.title}${path_1.default.extname(attachment.path)}`));
+        });
+    }
+}
+exports.default = ScreenshotsReporter;
+//# sourceMappingURL=screenshots.js.map

package/lib/reporters/screenshots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../../src/reporters/screenshots.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAGxB,iEAAiE;AACjE,MAAM,mBAAmB;IACvB,SAAS,CAAC,IAAc,EAAE,MAAkB;QAC1C,MAAM,kBAAkB,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,0BAA0B,CAAC,CAAC;QAChF,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACtC,6BAA6B;YAC7B,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBAAE,YAAE,CAAC,SAAS,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9F,sDAAsD;YACtD,YAAE,CAAC,YAAY,CACb,UAAU,CAAC,IAAI,EACf,cAAI,CAAC,IAAI,CACP,kBAAkB,EAClB,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAC3E,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,kBAAe,mBAAmB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spscommerce/e2e-core",
-  "version": "2.4.10",
+  "version": "2.4.12",
   "description": "An automation test framework which is based on Playwright.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -26,12 +26,13 @@
   "license": "UNLICENSED",
   "dependencies": {
     "@playwright/test": "1.46.1",
-    "@typescript-eslint/eslint-plugin": "5.30.0",
-    "@typescript-eslint/parser": "5.30.0",
-    "dotenv": "16.0.3",
-    "eslint": "7.32.0",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "6.21.0",
+    "dotenv": "16.4.5",
+    "eslint": "8.20.0",
     "jest-expect-message": "1.0.4",
     "jest-extended": "1.2.0",
     "typescript": "4.7.4"
-  }
+  },
+  "packageManager": "yarn@4.4.0+sha512.91d93b445d9284e7ed52931369bc89a663414e5582d00eea45c67ddc459a2582919eece27c412d6ffd1bd0793ff35399381cb229326b961798ce4f4cc60ddfdb"
 }

package/playwright.config.js

@@ -121,12 +121,13 @@ const config = {
     /* Reporter to use. See https://playwright.dev/docs/test-reporters */
     reporter: [
         ['junit', { outputFile: path.join(process.cwd(), `results-e2e/reports/${reportName}`) }],
-        ['list']
+        ['list'],
+        // Special reporters to transform video-s/screen-s to the form what can be displayed in the TestingInspector attachments
+        [path.resolve(__dirname, './src/reporters/screenshots.ts')],
+        [path.resolve(__dirname, './src/reporters/junitFix.ts'), { reportJunitFile: `results-e2e/reports/${reportName}` }],
     ],
     /* Global setup file must export a single function. This function will be run once before all the tests */
     globalSetup: require.resolve('./lib/globalSetup'),
-    /* Similarly, run something once after all the tests. */
-    globalTeardown: require.resolve('./lib/globalTeardown'),
     /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions */
     use: {
         storageState: !process.env.SKIP_AUTH ? storageStatePath : undefined,

package/src/index.ts

@@ -1,4 +1,3 @@
 export * from './globalSetup';
-export * from './globalTeardown';
 export * from './loggerSetup';
 export { default as expect } from './matchersSetup';

package/src/reporters/junitFix.ts

@@ -0,0 +1,29 @@
+import fs from 'fs';
+import type { Reporter } from '@playwright/test/reporter';
+
+interface JUnitFixOptions {
+  reportJunitFile?: string;
+}
+
+class JunitFixReporter implements Reporter {
+  private readonly reportJunitFile!: string;
+
+  constructor(options: JUnitFixOptions) {
+    this.reportJunitFile = options.reportJunitFile;
+  }
+
+  onEnd() {
+    const report = fs.readFileSync(this.reportJunitFile);
+    const reportFixed = String(report).replaceAll(
+      /<testcase(\s+)name="([^"]+?)"/gi,
+      (_all, spaces, name) => {
+        // Replace 'test case > test name' to the 'test name test case'
+        if (name) name = name.replaceAll(/ › /g, ' ');
+        return `<testcase${spaces}name="${name}"`;
+      }
+    );
+    fs.writeFileSync(this.reportJunitFile, reportFixed);
+  }
+}
+
+export default JunitFixReporter;

package/src/reporters/screenshots.ts

@@ -0,0 +1,24 @@
+import fs from 'fs';
+import path from 'path';
+import type { Reporter, TestCase, TestResult } from '@playwright/test/reporter';
+
+// Simple reporter for copy attachments to the screenshots folder
+class ScreenshotsReporter implements Reporter {
+  onTestEnd(test: TestCase, result: TestResult) {
+    const screenshotsDirName = path.join(process.cwd(), 'results-e2e/screenshots/');
+    result.attachments.forEach(attachment => {
+      // Create folder if un-exists
+      if (!fs.existsSync(screenshotsDirName)) fs.mkdirSync(screenshotsDirName, { recursive: true });
+      // Copy file as '<description> <test name>.<file ext>'
+      fs.copyFileSync(
+        attachment.path,
+        path.join(
+          screenshotsDirName,
+          `${test.titlePath().at(-2)} ${test.title}${path.extname(attachment.path)}`
+        )
+      );
+    });
+  }
+}
+
+export default ScreenshotsReporter;

package/lib/globalTeardown.d.ts

@@ -1 +0,0 @@
-export default function globalTeardown(): Promise<void>;

package/lib/globalTeardown.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const playwright_config_js_1 = __importDefault(require("../playwright.config.js"));
-async function globalTeardown() {
-    const currentProjectNames = playwright_config_js_1.default.projects.map((project) => project.name);
-    const oldFolder = path_1.default.join(process.cwd(), 'results-e2e-raw/');
-    const newFolder = path_1.default.join(process.cwd(), 'results-e2e/screenshots/');
-    fs_1.default.mkdirSync(newFolder, { recursive: true });
-    if (fs_1.default.existsSync(oldFolder)) {
-        for (const oldSubFolder of fs_1.default.readdirSync(oldFolder)) {
-            for (const oldFile of fs_1.default.readdirSync(path_1.default.join(oldFolder, oldSubFolder))) {
-                const oldFilePath = `${oldFolder}/${oldSubFolder}/${oldFile}`;
-                const newFile = "SPS_" + oldSubFolder
-                    .substring(oldSubFolder.indexOf("SPS") + 4)
-                    .split('-')
-                    .filter(e => !currentProjectNames.includes(e) && !e.includes('retry'))
-                    .join('_')
-                    .replace('_', ' ');
-                const newFilePath = `${newFolder}/${newFile}.${oldFile.split('.').pop()}`;
-                fs_1.default.copyFileSync(oldFilePath, newFilePath);
-            }
-        }
-    }
-    return;
-}
-exports.default = globalTeardown;
-//# sourceMappingURL=globalTeardown.js.map

package/lib/globalTeardown.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"globalTeardown.js","sourceRoot":"","sources":["../src/globalTeardown.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,mFAA6C;AAE9B,KAAK,UAAU,cAAc;IACxC,MAAM,mBAAmB,GAAG,8BAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9F,MAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,0BAA0B,CAAC,CAAC;IACvE,YAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,IAAI,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC1B,KAAK,MAAM,YAAY,IAAI,YAAE,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE;YAClD,KAAK,MAAM,OAAO,IAAI,YAAE,CAAC,WAAW,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,EAAE;gBACtE,MAAM,WAAW,GAAG,GAAG,SAAS,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC;gBAC9D,MAAM,OAAO,GAAG,MAAM,GAAG,YAAY;qBAChC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;qBAC1C,KAAK,CAAC,GAAG,CAAC;qBACV,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;qBACrE,IAAI,CAAC,GAAG,CAAC;qBACT,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBACvB,MAAM,WAAW,GAAG,GAAG,SAAS,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;gBAC1E,YAAE,CAAC,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;aAC7C;SACJ;KACJ;IACD,OAAO;AACX,CAAC;AArBD,iCAqBC"}

package/src/globalTeardown.ts

@@ -1,26 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import config from '../playwright.config.js';
-
-export default async function globalTeardown(): Promise<void> {
-    const currentProjectNames = config.projects.map((project: { name: string; }) => project.name);
-    const oldFolder = path.join(process.cwd(), 'results-e2e-raw/');
-    const newFolder = path.join(process.cwd(), 'results-e2e/screenshots/');
-    fs.mkdirSync(newFolder, { recursive: true });
-    if (fs.existsSync(oldFolder)) {
-        for (const oldSubFolder of fs.readdirSync(oldFolder)) {
-            for (const oldFile of fs.readdirSync(path.join(oldFolder, oldSubFolder))) {
-                const oldFilePath = `${oldFolder}/${oldSubFolder}/${oldFile}`;
-                const newFile = "SPS_" + oldSubFolder
-                    .substring(oldSubFolder.indexOf("SPS") + 4)
-                    .split('-')
-                    .filter(e => !currentProjectNames.includes(e) && !e.includes('retry'))
-                    .join('_')
-                    .replace('_', ' ');
-                const newFilePath = `${newFolder}/${newFile}.${oldFile.split('.').pop()}`;
-                fs.copyFileSync(oldFilePath, newFilePath);
-            }
-        }
-    }
-    return;
-}