@o3r/testing 12.1.0-prerelease.69 → 12.1.0-prerelease.70

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/testing",
-  "version": "12.1.0-prerelease.69",
+  "version": "12.1.0-prerelease.70",
   "publishConfig": {
     "access": "public"
   },
@@ -94,6 +94,10 @@
       "types": "./visual-test/utils.d.ts",
       "default": "./visual-test/utils.js",
       "import": "./esm/visual-test/utils.js"
+    },
+    "./visual-testing-reporter": {
+      "types": "./visual-testing-reporter/index.d.ts",
+      "default": "./visual-testing-reporter/index.js"
     }
   },
   "peerDependencies": {
@@ -109,9 +113,9 @@
     "@material/slider": "^14.0.0",
     "@ngrx/store": "^19.0.0",
     "@ngx-translate/core": "~16.0.4",
-    "@o3r/core": "^12.1.0-prerelease.69",
-    "@o3r/localization": "^12.1.0-prerelease.69",
-    "@o3r/schematics": "^12.1.0-prerelease.69",
+    "@o3r/core": "^12.1.0-prerelease.70",
+    "@o3r/localization": "^12.1.0-prerelease.70",
+    "@o3r/schematics": "^12.1.0-prerelease.70",
     "@playwright/test": "^1.49.0",
     "@schematics/angular": "^19.0.0",
     "pixelmatch": "^6.0.0",
@@ -200,12 +204,12 @@
     "@ngx-translate/core": "~16.0.4",
     "@nx/eslint-plugin": "~20.4.0",
     "@nx/jest": "~20.4.0",
-    "@o3r/build-helpers": "^12.1.0-prerelease.69",
-    "@o3r/core": "^12.1.0-prerelease.69",
-    "@o3r/eslint-plugin": "^12.1.0-prerelease.69",
-    "@o3r/localization": "^12.1.0-prerelease.69",
-    "@o3r/schematics": "^12.1.0-prerelease.69",
-    "@o3r/test-helpers": "^12.1.0-prerelease.69",
+    "@o3r/build-helpers": "^12.1.0-prerelease.70",
+    "@o3r/core": "^12.1.0-prerelease.70",
+    "@o3r/eslint-plugin": "^12.1.0-prerelease.70",
+    "@o3r/localization": "^12.1.0-prerelease.70",
+    "@o3r/schematics": "^12.1.0-prerelease.70",
+    "@o3r/test-helpers": "^12.1.0-prerelease.70",
     "@playwright/test": "~1.50.0",
     "@schematics/angular": "~19.1.0",
     "@stylistic/eslint-plugin": "~3.1.0",

package/visual-testing-reporter/index.d.ts

@@ -0,0 +1,47 @@
+import { type FullConfig, type Reporter, type Suite } from '@playwright/test/reporter';
+/**
+ * The screenshot information
+ */
+export interface ScreenshotInformation {
+    /**
+     * The path of the actual screenshot
+     */
+    actual: string;
+    /**
+     * The path of the expected screenshot
+     */
+    expected: string;
+}
+/**
+ * The report of the visual testing campaign
+ */
+export type VisualTestingReporterReport = ScreenshotInformation[];
+/**
+ * Configuration for the visual testing reporter
+ */
+export interface VisualTestingReporterOptions {
+    /** The output file for the report */
+    outputFile?: string;
+}
+/**
+ * Playwright reporter for visual testing
+ */
+export declare class VisualTestingPlaywrightReporter implements Reporter {
+    private suite;
+    private readonly outputFile;
+    constructor(options: VisualTestingReporterOptions);
+    /**
+     * @inheritdoc
+     */
+    printsToStdio(): boolean;
+    /**
+     * @inheritdoc
+     */
+    onBegin(_: FullConfig, suite: Suite): void;
+    /**
+     * @inheritdoc
+     */
+    onEnd(): Promise<void>;
+}
+export default VisualTestingPlaywrightReporter;
+//# sourceMappingURL=index.d.ts.map

package/visual-testing-reporter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/visual-testing-reporter/index.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,KAAK,EACX,MAAM,2BAA2B,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,qBAAqB,EAAE,CAAC;AAMlE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,+BAAgC,YAAW,QAAQ;IAC9D,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAExB,OAAO,EAAE,4BAA4B;IAIjD;;OAEG;IACI,aAAa;IAIpB;;OAEG;IACI,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IAI1C;;OAEG;IACU,KAAK;CAiBnB;AAED,eAAe,+BAA+B,CAAC"}

package/visual-testing-reporter/index.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualTestingPlaywrightReporter = void 0;
+var tslib_1 = require("tslib");
+var promises_1 = require("node:fs/promises");
+var node_path_1 = require("node:path");
+/**
+ * Playwright reporter for visual testing
+ */
+var VisualTestingPlaywrightReporter = /** @class */ (function () {
+    function VisualTestingPlaywrightReporter(options) {
+        this.outputFile = options.outputFile || (0, node_path_1.join)(process.cwd(), 'playwright-reports/visual-testing/report.json');
+    }
+    /**
+     * @inheritdoc
+     */
+    VisualTestingPlaywrightReporter.prototype.printsToStdio = function () {
+        return false;
+    };
+    /**
+     * @inheritdoc
+     */
+    VisualTestingPlaywrightReporter.prototype.onBegin = function (_, suite) {
+        this.suite = suite;
+    };
+    /**
+     * @inheritdoc
+     */
+    VisualTestingPlaywrightReporter.prototype.onEnd = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var screenshotsToUpdate;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        screenshotsToUpdate = this.suite.allTests().flatMap(function (test) {
+                            return test.results.flatMap(function (result) {
+                                return result.errors
+                                    .map(function (error) { return error.matcherResult; })
+                                    .filter(function (matcherResult) {
+                                    return (matcherResult === null || matcherResult === void 0 ? void 0 : matcherResult.name) === 'toHaveScreenshot'
+                                        && typeof matcherResult.actual === 'string'
+                                        && typeof matcherResult.expected === 'string'
+                                        && !matcherResult.pass;
+                                })
+                                    .map(function (_a) {
+                                    var actual = _a.actual, expected = _a.expected;
+                                    return ({ actual: actual, expected: expected });
+                                });
+                            });
+                        });
+                        return [4 /*yield*/, (0, promises_1.mkdir)((0, node_path_1.dirname)(this.outputFile), { recursive: true })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, (0, promises_1.writeFile)(this.outputFile, JSON.stringify(screenshotsToUpdate, null, 2))];
+                }
+            });
+        });
+    };
+    return VisualTestingPlaywrightReporter;
+}());
+exports.VisualTestingPlaywrightReporter = VisualTestingPlaywrightReporter;
+exports.default = VisualTestingPlaywrightReporter;
+//# sourceMappingURL=index.js.map

package/visual-testing-reporter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/visual-testing-reporter/index.ts"],"names":[],"mappings":";;;;AAAA,6CAG0B;AAC1B,uCAGmB;AAyCnB;;GAEG;AACH;IAIE,yCAAY,OAAqC;QAC/C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAA,gBAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,+CAA+C,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACI,uDAAa,GAApB;QACE,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,iDAAO,GAAd,UAAe,CAAa,EAAE,KAAY;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;OAEG;IACU,+CAAK,GAAlB;;;;;;wBACQ,mBAAmB,GAAgC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,UAAC,IAAI;4BAC1F,OAAA,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAC,MAAM;gCAC1B,OAAA,MAAM,CAAC,MAAM;qCACV,GAAG,CAAC,UAAC,KAAK,IAAK,OAAC,KAAa,CAAC,aAAa,EAA5B,CAA4B,CAAC;qCAC5C,MAAM,CAAC,UAAC,aAA4C;oCACnD,OAAA,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,IAAI,MAAK,kBAAkB;2CACvC,OAAO,aAAa,CAAC,MAAM,KAAK,QAAQ;2CACxC,OAAO,aAAa,CAAC,QAAQ,KAAK,QAAQ;2CAC1C,CAAC,aAAa,CAAC,IAAI;gCAHtB,CAGsB,CACvB;qCACA,GAAG,CAAC,UAAC,EAAoB;wCAAlB,MAAM,YAAA,EAAE,QAAQ,cAAA;oCAAO,OAAA,CAAC,EAAE,MAAM,QAAA,EAAE,QAAQ,UAAA,EAAE,CAA0B;gCAA/C,CAA+C,CAAC;4BARjF,CAQiF,CAClF;wBAVD,CAUC,CACF,CAAC;wBACF,qBAAM,IAAA,gBAAK,EAAC,IAAA,mBAAO,EAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAA;;wBAA1D,SAA0D,CAAC;wBAC3D,sBAAO,IAAA,oBAAS,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAC;;;;KACjF;IACH,sCAAC;AAAD,CAAC,AA1CD,IA0CC;AA1CY,0EAA+B;AA4C5C,kBAAe,+BAA+B,CAAC","sourcesContent":["import {\n  mkdir,\n  writeFile,\n} from 'node:fs/promises';\nimport {\n  dirname,\n  join,\n} from 'node:path';\nimport type {\n  MatcherReturnType,\n} from '@playwright/test';\nimport {\n  type FullConfig,\n  type Reporter,\n  type Suite,\n} from '@playwright/test/reporter';\n\n/**\n * The screenshot information\n */\nexport interface ScreenshotInformation {\n  /**\n   * The path of the actual screenshot\n   */\n  actual: string;\n  /**\n   * The path of the expected screenshot\n   */\n  expected: string;\n}\n\n/**\n * The report of the visual testing campaign\n */\nexport type VisualTestingReporterReport = ScreenshotInformation[];\n\ntype ScreenshotMatcherReturnType = MatcherReturnType & ScreenshotInformation & {\n  name: 'toHaveScreenshot';\n};\n\n/**\n * Configuration for the visual testing reporter\n */\nexport interface VisualTestingReporterOptions {\n  /** The output file for the report */\n  outputFile?: string;\n}\n\n/**\n * Playwright reporter for visual testing\n */\nexport class VisualTestingPlaywrightReporter implements Reporter {\n  private suite!: Suite;\n  private readonly outputFile: string;\n\n  constructor(options: VisualTestingReporterOptions) {\n    this.outputFile = options.outputFile || join(process.cwd(), 'playwright-reports/visual-testing/report.json');\n  }\n\n  /**\n   * @inheritdoc\n   */\n  public printsToStdio() {\n    return false;\n  }\n\n  /**\n   * @inheritdoc\n   */\n  public onBegin(_: FullConfig, suite: Suite) {\n    this.suite = suite;\n  }\n\n  /**\n   * @inheritdoc\n   */\n  public async onEnd() {\n    const screenshotsToUpdate: VisualTestingReporterReport = this.suite.allTests().flatMap((test) =>\n      test.results.flatMap((result) =>\n        result.errors\n          .map((error) => (error as any).matcherResult)\n          .filter((matcherResult: MatcherReturnType | undefined): matcherResult is ScreenshotMatcherReturnType =>\n            matcherResult?.name === 'toHaveScreenshot'\n            && typeof matcherResult.actual === 'string'\n            && typeof matcherResult.expected === 'string'\n            && !matcherResult.pass\n          )\n          .map(({ actual, expected }) => ({ actual, expected }) as ScreenshotInformation)\n      )\n    );\n    await mkdir(dirname(this.outputFile), { recursive: true });\n    return writeFile(this.outputFile, JSON.stringify(screenshotsToUpdate, null, 2));\n  }\n}\n\nexport default VisualTestingPlaywrightReporter;\n"]}