@spscommerce/e2e-core 2.5.1 → 2.6.0

package/.dockerignore

@@ -3,6 +3,6 @@
 # White list the required files
 !.yarnrc.yml
 !package.json
-!playwright.config.js
+!playwright.config.ts
 !tsconfig.json
 !yarn.lock

package/README.md

@@ -27,25 +27,26 @@ REPO_NAME=fulfillment-ui-v2
 BASEURL=https://test.commerce.spscommerce.com/fulfillment
 VIEWPORT={"width": 1920, "height": 1080}
 ```
-| Variable            | description                                        | default                        | possible values                      |
-| ------------------: | -------------------------------------------------- | ------------------------------ | ------------------------------------ |
-| HEADLESS            | launch browser in headless/headful mode            | true                           | true, false                          |
-| BROWSER             | use + as a separator, e.g edge+firefox             | chromium                       | chromium, firefox, webkit, edge      |
-| TEST_TIMEOUT        | global timeout for each test                       | 30000                          | [number_in_ms]                       |
-| EXPECT_TIMEOUT      | global timeout for each expect                     | 5000                           | [number_in_ms]                       |
-| ACTION_TIMEOUT      | global timeout for each PW action, like click()    | 30000                          | [number_in_ms]                       |
-| SLOWMO              | slows down the actions by the specified ms         | 0                              | [number_in_ms]                       |
-| WORKERS             | number of workers (test threads)                   | 1                              | [number]                             |
-| TRACER              | create PW actions trace file per each failed test  | false                          | true, false                          |
-| VIEWPORT            | emulates consistent viewport for each page         | {"width": 1536, "height": 960} | [string]                             |
-| CI                  | used in CI: forbidOnly and maxFailures are applied | false                          | true, false                          |
-| SUITE               | used in CI: report file name is created per suite  | TEST-results.xml               | [string]                             |
-| ENV                 | invoked auth state environment flag*               | test                           | test, prod                           |
-| BASEURL             | auth state is invoked for the provided url*        | -      (required)              | [string]                             |
-| TEST_DIR            | used in package.json: tests directory path         | -      (required)              | [string]                             |
-| CONFIG_PATH         | used in package.json: .env file path               | -                              | [string]                             |
-| SETUP_PATH          | used in package.json: set sm-th before test start  | -                              | [string]                             |
-| REPO_NAME           | creates GH repo link on test in log files          | -                              | [string]                             |
+| Variable        | description                                        | default                        | possible values                 |
+|:----------------|----------------------------------------------------|--------------------------------|---------------------------------|
+| HEADLESS        | launch browser in headless/headful mode            | true                           | true, false                     |
+| BROWSER         | use + as a separator, e.g edge+firefox             | chromium                       | chromium, firefox, webkit, edge |
+| TEST_TIMEOUT    | global timeout for each test                       | 30000                          | [number_in_ms]                  |
+| EXPECT_TIMEOUT  | global timeout for each expect                     | 5000                           | [number_in_ms]                  |
+| ACTION_TIMEOUT  | global timeout for each PW action, like click()    | 30000                          | [number_in_ms]                  |
+| SLOWMO          | slows down the actions by the specified ms         | 0                              | [number_in_ms]                  |
+| WORKERS         | number of workers (test threads)                   | 1                              | [number]                        |
+| TRACER          | create PW actions trace file per each failed test  | false                          | true, false                     |
+| VIEWPORT        | emulates consistent viewport for each page         | {"width": 1536, "height": 960} | [string]                        |
+| CI              | used in CI: forbidOnly and maxFailures are applied | false                          | true, false                     |
+| SUITE           | used in CI: report file name is created per suite  | TEST-results.xml               | [string]                        |
+| ENV             | invoked auth state environment flag*               | test                           | test, prod                      |
+| BASEURL         | auth state is invoked for the provided url*        | -      (required)              | [string]                        |
+| TEST_DIR        | used in package.json: tests directory path         | -      (required)              | [string]                        |
+| CONFIG_PATH     | used in package.json: .env file path               | -                              | [string]                        |
+| SETUP_PATH      | used in package.json: set sm-th before test start  | -                              | [string]                        |
+| REPO_NAME       | creates GH repo link on test in log files          | -                              | [string]                        |
+| TESTRAIL_REPORT | enables custom TestRail reporter                   | -                              | true, false                     |
 
 \* If you have several urls to run your tests for, consider the following possible set up in the SETUP_PATH file instead of providing BASEURL in the .env file:
 ```
@@ -77,8 +78,8 @@ It allows to set url for testing via CLI instead of setting it up in .env file.
 
 6. Setup the following "scripts" commands in the `package.json` according to your paths:
 ```
-"test": ". .credentials.sh && CONFIG_PATH=$(pwd)/.env SETUP_PATH=$(pwd)/src/helpers/urlSetup.js TEST_DIR=$(pwd) HEADLESS=false playwright test --config=node_modules/@spscommerce/e2e-core/playwright.config.js",
-"test:ci": "CONFIG_PATH=$(pwd)/.env SETUP_PATH=$(pwd)/src/helpers/urlSetup.js TEST_DIR=$(pwd) CI=true playwright test --config=node_modules/@spscommerce/e2e-core/playwright.config.js"
+"test": ". .credentials.sh && CONFIG_PATH=$(pwd)/.env SETUP_PATH=$(pwd)/src/helpers/urlSetup.js TEST_DIR=$(pwd) HEADLESS=false playwright test --config=node_modules/@spscommerce/e2e-core/playwright.config.ts",
+"test:ci": "CONFIG_PATH=$(pwd)/.env SETUP_PATH=$(pwd)/src/helpers/urlSetup.js TEST_DIR=$(pwd) CI=true playwright test --config=node_modules/@spscommerce/e2e-core/playwright.config.ts"
 ```
 7. Add your first test file (see Example.test.ts file).
 
@@ -203,6 +204,9 @@ jobs:
 
 [TestingInspector@1](https://github.com/SPSCommerce/azure-pipelines-extensions/tree/main/extensions/workflow#testinginspector) - Azure DevOps extension used in CI pipeline to upload screenshot and log files into the test results report.
 
+## Report to TestRail
+We can use the custom [playwright-testrail-reporter](https://github.com/niche-tester/playwright-testrail-reporter) to publish tests result to the TestRail. It enables by the **TESTRAIL_REPORT** environment variable (you can check official docs for the usage capabilities and setup).
+
 ## Q&A
 If you have any questions or difficulties with this package, reach out to us in [#ffqa](https://spscommerce.slack.com/archives/G01GH392AUX) on Slack. 
 Additional info over this framework could be found on [Confluence](https://atlassian.spscommerce.com/wiki/x/jQwlF).
@@ -217,3 +221,4 @@ Put in a PR against this repo if you fix a bug or come up with an improvement!
 - [jest-expect-message](https://github.com/mattphillips/jest-expect-message) - gives ability to add a custom error message to the assertions
 - [jest-extended](https://github.com/jest-community/jest-extended) -  adds additional matchers to default ones making it easy to test everything 🙌
 - [typescript](https://github.com/Microsoft/TypeScript) - language for application-scale JavaScript that adds optional types
+- [playwright-testrail-reporter](https://github.com/niche-tester/playwright-testrail-reporter/tree/main) - custom reporter for Playwright Test to seamlessly integrate with TestRail

package/eslint.config.mjs

@@ -1,12 +1,12 @@
 import globals from 'globals';
 import path from 'node:path';
-import {fileURLToPath} from 'node:url';
-import {defineConfig, globalIgnores} from 'eslint/config';
+import { fileURLToPath } from 'node:url';
+import { defineConfig, globalIgnores } from 'eslint/config';
 
 import tsParser from '@typescript-eslint/parser';
 import typescriptEslint from '@typescript-eslint/eslint-plugin';
 import js from '@eslint/js';
-import {FlatCompat} from '@eslint/eslintrc';
+import { FlatCompat } from '@eslint/eslintrc';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -17,10 +17,14 @@ const compat = new FlatCompat({
 export default defineConfig([globalIgnores(["node_modules/*", "lib/*"]), {
     languageOptions: {
         globals: {
-            ...globals.browser, ...globals.amd, ...globals.node,
+            ...globals.browser,
+            ...globals.amd,
+            ...globals.node,
         },
-
-        parser: tsParser, "ecmaVersion": 12, "sourceType": "module", parserOptions: {},
+        parser: tsParser,
+        ecmaVersion: 12,
+        sourceType: "module",
+        parserOptions: {},
     },
 
     extends: compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended"),
@@ -28,11 +32,5 @@ export default defineConfig([globalIgnores(["node_modules/*", "lib/*"]), {
     plugins: {
         "@typescript-eslint": typescriptEslint,
     },
-
-    "rules": {
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-var-requires": "off",
-        "@typescript-eslint/no-require-imports": "off",
-        "no-empty-pattern": "off"
-    },
+    rules: {},
 }]);

package/lib/matchersSetup.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const test_1 = require("@playwright/test");
 const withMessage_js_1 = __importDefault(require("jest-expect-message/dist/withMessage.js"));
 const expect = (0, withMessage_js_1.default)(test_1.test.expect);
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const matchers = require('jest-extended');
 expect.extend(matchers);
 exports.default = expect;

package/lib/matchersSetup.js.map

@@ -1 +1 @@
-{"version":3,"file":"matchersSetup.js","sourceRoot":"","sources":["../src/matchersSetup.ts"],"names":[],"mappings":";;;;;AAAA,2CAAwC;AACxC,6FAAkE;AAElE,MAAM,MAAM,GAAG,IAAA,wBAAW,EAAC,WAAI,CAAC,MAAM,CAAC,CAAC;AAExC,MAAM,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAExB,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"matchersSetup.js","sourceRoot":"","sources":["../src/matchersSetup.ts"],"names":[],"mappings":";;;;;AAAA,2CAAwC;AACxC,6FAAkE;AAElE,MAAM,MAAM,GAAG,IAAA,wBAAW,EAAC,WAAI,CAAC,MAAM,CAAC,CAAC;AAExC,iEAAiE;AACjE,MAAM,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAExB,kBAAe,MAAM,CAAC"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@spscommerce/e2e-core",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "An automation test framework which is based on Playwright.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
     "lint": "eslint .",
     "build": "tsc --incremental -p tsconfig.json",
-    "test": "CONFIG_PATH=$(pwd)/.env HEADLESS=false npx playwright test"
+    "test": "CONFIG_PATH=$(pwd)/.env HEADLESS=false playwright test"
   },
   "repository": {
     "type": "git",
@@ -33,6 +33,7 @@
     "eslint": "9.39.1",
     "jest-expect-message": "1.1.3",
     "jest-extended": "1.2.1",
+    "playwright-testrail-reporter": "1.3.3",
     "typescript": "4.9.5"
   },
   "packageManager": "yarn@4.4.0+sha512.91d93b445d9284e7ed52931369bc89a663414e5582d00eea45c67ddc459a2582919eece27c412d6ffd1bd0793ff35399381cb229326b961798ce4f4cc60ddfdb"

package/{playwright.config.js → playwright.config.ts}

@@ -1,8 +1,9 @@
-const path = require('path');
-const { devices } = require('@playwright/test');
+import path from 'path';
+import { devices } from '@playwright/test';
+import dotenv from 'dotenv';
 
 if (process.env.CONFIG_PATH) {
-    require('dotenv').config({ path: process.env.CONFIG_PATH });
+    dotenv.config({ path: process.env.CONFIG_PATH });
 }
 
 const reportName = process.env.SUITE ? `${process.env.SUITE}.xml` : `TEST-result.xml`;
@@ -100,8 +101,6 @@ const storageStatePath = process.env.ENV && process.env.ENV.includes('prod')
  * See https://playwright.dev/docs/test-configuration
  */
 
-// @ts-check
-/** @type {import('@playwright/test').PlaywrightTestConfig} */
 const config = {
     /*  Directory that will be recursively scanned for test files */
     testDir: process.env.TEST_DIR,
@@ -123,6 +122,8 @@ const config = {
     reporter: [
         ['junit', { outputFile: path.join(process.cwd(), `results-e2e/reports/${reportName}`) }],
         ['list'],
+        // Testrail custom reporter
+        ...(process.env.TESTRAIL_REPORT && process.env.TESTRAIL_REPORT === 'true' ? [['playwright-testrail-reporter']] : []),
         // Special reporters to transform video-s/screen-s to the form what can be displayed in the TestingInspector attachments
         [path.resolve(__dirname, './lib/reporters/screenshots')],
         [path.resolve(__dirname, './lib/reporters/junitFix'), { reportJunitFile: `results-e2e/reports/${reportName}` }],
@@ -157,4 +158,4 @@ const config = {
     outputDir: path.join(process.cwd(), 'results-e2e-raw/')
 };
 
-module.exports = config;
+export default config;

package/src/matchersSetup.ts

@@ -3,6 +3,7 @@ import withMessage from 'jest-expect-message/dist/withMessage.js';
 
 const expect = withMessage(test.expect);
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const matchers = require('jest-extended');
 expect.extend(matchers);