playwright-ctrf-json-reporter 0.0.15 → 0.0.17

package/README.md

@@ -12,27 +12,18 @@ A Playwright JSON test reporter to create test reports that follow the CTRF stan
 
 [Common Test Report Format](https://ctrf.io) ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.
 
-⭐ **If you find this project useful, consider giving it a GitHub star** ⭐
+## **⭐⭐ If you find this project useful, consider giving it a GitHub star ⭐⭐**
 
-It means a lot to us and helps us grow this open source library.
+## Help us get featured on the Playwright Reporter showcase
 
-## We need your help
+We'd love to be featured but we need more followers and stars to be [considered](https://github.com/microsoft/playwright/pull/31470)
 
-We believe CTRF can save **a lot** of time for engineers, a single data serialisation report, well structured, community driven and works with any framework. For over 30s years software engineers have used a de facto data serialisation report, you know the one! But we feel it’s time to modernise.
+Support our mission to enhance JSON test reporting by:
 
-The only way we can grow CTRF is with your help and the support of the software engineering community.
+- **⭐ Starring this repository to show your support. ⭐**
+- **🙌 Following our [GitHub page here](https://github.com/ctrf-io). 🙌**
 
-## How can you help?
-
-- Join and build with us! We are looking for [contributors](https://github.com/ctrf-io), get involved in this early stage project. All contributions are welcome.
-- Give this repository a star ⭐⭐⭐⭐⭐⭐
-- Follow the CTRF [GitHub organisation](https://github.com/ctrf-io)
-- Clap for our medium articles (30 times each) 👏
-- Share our [libraries](https://github.com/orgs/ctrf-io/repositories), our [homepage](https://www.ctrf.io/), or [Medium articles](https://medium.com/@ma11hewthomas)
-- Maybe even write a blog about us!
-- Try our [tools](https://github.com/orgs/ctrf-io/repositories)
-
-**Thank you so much!!**
+Thank you! Your support is invaluable to us! 💙
 
 ## Features
 
@@ -162,6 +153,7 @@ The test object in the report includes the following [CTRF properties](https://c
 | `flaky`      | Boolean          | Optional | Indicates whether the test result is flaky.                                         |
 | `browser`    | String           | Optional | The browser used for the test.                                                      |
 | `screenshot` | String           | Optional | A base64 encoded screenshot taken during the test.                                  |
+| `steps`      | Array of Objects | Optional | Individual steps in the test, especially for BDD-style testing.                     |
 
 ## Advanced usage
 

package/dist/generate-report.d.ts

@@ -1,4 +1,4 @@
-import { type Suite, type Reporter, type TestCase, type TestResult, type FullConfig } from '@playwright/test/reporter';
+import { type Suite, type Reporter, type TestCase, type TestResult, type FullConfig, type TestStep } from '@playwright/test/reporter';
 import { type CtrfTestState, type CtrfReport, type CtrfTest, type CtrfEnvironment } from '../types/ctrf';
 interface ReporterConfigOptions {
     outputFile?: string;
@@ -48,5 +48,6 @@ declare class GenerateCtrfReport implements Reporter {
     extractFailureDetails(testResult: TestResult): Partial<CtrfTest>;
     countSuites(suite: Suite): number;
     writeReportToFile(data: CtrfReport): void;
+    processStep(test: CtrfTest, step: TestStep): void;
 }
 export default GenerateCtrfReport;

package/dist/generate-report.js

@@ -118,6 +118,12 @@ class GenerateCtrfReport {
             test.filePath = testCase.location.file;
             test.retries = testResult.retry;
             test.flaky = testResult.status === 'passed' && testResult.retry > 0;
+            test.steps = [];
+            if (testResult.steps.length > 0) {
+                testResult.steps.forEach((step) => {
+                    this.processStep(test, step);
+                });
+            }
             if (this.reporterConfigOptions.screenshot === true) {
                 test.screenshot = this.extractScreenshotBase64(testResult);
             }
@@ -249,7 +255,10 @@ class GenerateCtrfReport {
         return (_a = screenshotAttachment === null || screenshotAttachment === void 0 ? void 0 : screenshotAttachment.body) === null || _a === void 0 ? void 0 : _a.toString('base64');
     }
     extractFailureDetails(testResult) {
-        if (testResult.status === 'failed' && testResult.error !== undefined) {
+        if ((testResult.status === 'failed' ||
+            testResult.status === 'timedOut' ||
+            testResult.status === 'interrupted') &&
+            testResult.error !== undefined) {
             const failureDetails = {};
             if (testResult.error.message !== undefined) {
                 failureDetails.message = testResult.error.message;
@@ -280,5 +289,24 @@ class GenerateCtrfReport {
             console.error(`Error writing ctrf json report:, ${String(error)}`);
         }
     }
+    processStep(test, step) {
+        var _a;
+        if (step.category === 'test.step') {
+            const stepStatus = step.error === undefined
+                ? this.mapPlaywrightStatusToCtrf('passed')
+                : this.mapPlaywrightStatusToCtrf('failed');
+            const currentStep = {
+                name: step.title,
+                status: stepStatus,
+            };
+            (_a = test.steps) === null || _a === void 0 ? void 0 : _a.push(currentStep);
+        }
+        const childSteps = step.steps;
+        if (childSteps.length > 0) {
+            childSteps.forEach((cStep) => {
+                this.processStep(test, cStep);
+            });
+        }
+    }
 }
 exports.default = GenerateCtrfReport;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-ctrf-json-reporter",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "A Playwright JSON test reporter to create test results reports",
   "main": "dist/index.js",
   "scripts": {