@orangebeard-io/playwright-orangebeard-reporter 1.0.0

package/README.md

@@ -0,0 +1,90 @@
+<h1 align="center">
+  <a href="https://github.com/orangebeard-io/playwright-listener">
+    <img src="https://raw.githubusercontent.com/orangebeard-io/playwright-listener/main/.github/logo.svg" alt="Orangebeard.io Playwright Listener" height="200">
+  </a>
+  <br>Orangebeard.io Playwright Listener<br>
+</h1>
+
+<h4 align="center">Orangebeard listener for <a href="https://playwright.dev" target="_blank" rel="noopener">Playwright</a></h4>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@orangebeard-io/playwright-orangebeard-reporter">
+    <img src="https://img.shields.io/npm/v/@orangebeard-io/playwright-orangebeard-reporter.svg?style=flat-square"
+      alt="NPM Version" />
+  </a>
+  <a href="https://github.com/orangebeard-io/playwright-listener/actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/orangebeard-io/playwright-listener/release.yml?branch=main&style=flat-square"
+      alt="Build Status" />
+  </a>
+  <a href="https://github.com/orangebeard-io/playwright-listener/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/orangebeard-io/playwright-listener?style=flat-square"
+      alt="License" />
+  </a>
+</p>
+
+<div align="center">
+  <h4>
+    <a href="https://orangebeard.io">Orangebeard</a> |
+    <a href="#installation">Installation</a> |
+    <a href="#configuration">Configuration</a>
+  </h4>
+</div>
+
+## Installation
+
+### Install the npm package
+
+```shell
+npm install @orangebeard-io/playwright-orangebeard-reporter
+```
+
+## Configuration
+
+Create orangebeard.json (in your test projects's folder (or above))
+
+```JSON
+{
+  "endpoint": "https://XXX.orangebeard.app",
+  "accessToken": "00000000-0000-0000-0000-00000000",
+  "project": "my_project_name",
+  "testset": "My Test Set Name",
+  "description": "A run from playwright",
+  "attributes": [
+    {
+      "key": "SomeKey",
+      "value": "SomeValue"
+    },
+    {
+      "value": "Tag value"
+    }
+  ]
+}
+```
+
+Configure the reporter in playwright-config.ts:
+```ts
+export default defineConfig({
+    testDir: './my-tests',
+    reporter: [['@orangebeard-io/playwright-orangebeard-reporter']],
+    projects: [
+        {
+            name: 'chromium',
+            use: { ...devices['Desktop Chrome'] },
+        }]
+});
+```
+
+### Running
+
+Run your tests as usual!
+
+Alternatively, configure Orangebeard variables as ENV (without or on top of orangebeard.json):
+
+```shell
+ ORANGEBEARD_ENDPOINT=https://company.orangebeard.app
+ ORANGEBEARD_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+ ORANGEBEARD_PROJECT="my project"
+ ORANGEBEARD_TESTSET="my test set"
+ ORANGEBEARD_DESCRIPTION="My awesome testrun"
+ ORANGEBEARD_ATTRIBUTES="key:value; value;"
+ ```

package/changelog-template.hbs

@@ -0,0 +1,29 @@
+{{#each releases}}
+  {{#if summary}}
+    {{summary}}
+  {{/if}}
+
+  {{#if merges}}
+    ### :twisted_rightwards_arrows: Merged
+
+    {{#each merges}}
+      - {{#if commit.breaking}}**Breaking change:** {{/if}}{{message}} {{#if href}}[`#{{id}}`]({{href}}){{/if}}
+    {{/each}}
+  {{/if}}
+
+  {{#if fixes}}
+    ### :bug: Fixed
+
+    {{#each fixes}}
+      - {{#if commit.breaking}}**Breaking change:** {{/if}}{{commit.subject}}{{#each fixes}} {{#if href}}[`#{{id}}`]({{href}}){{/if}}{{/each}}
+    {{/each}}
+  {{/if}}
+
+  {{#commit-list commits heading='### :mag: Commits'}}
+    - {{#if breaking}}**Breaking change:** {{/if}}{{subject}} {{#if href}}[`{{shorthash}}`]({{href}}){{/if}}
+  {{/commit-list}}
+
+  {{#if href}}
+    See full comparison at [{{title}}]({{href}})
+  {{/if}}
+{{/each}}

package/dist/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const OrangebeardReporter_1 = require("./reporter/OrangebeardReporter");
+exports.default = OrangebeardReporter_1.OrangebeardReporter;

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@orangebeard-io/playwright-orangebeard-reporter",
+  "version": "1.0.0",
+  "description": "A Playwright reporter to report to Orangebeard.io",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "rimraf ./dist && tsc",
+    "lint": "eslint . --ext .ts",
+    "format:js": "npm run lint -- --fix",
+    "format:md": "prettier --write README.md",
+    "format": "npm run format:js && npm run format:md",
+    "test": "jest --unhandled-rejections=none --config ./jest.config.js",
+    "test:coverage": "jest --unhandled-rejections=none --coverage",
+    "get-version": "echo $npm_package_version",
+    "update-version": "release-it --ci --no-git --no-npm.publish",
+    "create-changelog": "auto-changelog --template changelog-template.hbs --starting-version v$npm_package_version"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/orangebeard-io/playwright-listener.git"
+  },
+  "keywords": [
+    "playwright",
+    "orangebeard",
+    "reporter",
+    "testing"
+  ],
+  "author": "Orangebeard.io",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/orangebeard-io/playwright-listener/issues"
+  },
+  "homepage": "https://github.com/orangebeard-io/playwright-listener#readme",
+  "devDependencies": {
+    "auto-changelog": "^2.5.0",
+    "@js-joda/core": "^5.6.3",
+    "@orangebeard-io/javascript-client": "^2.0.6",
+    "@playwright/test": "^1.49.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "eslint": "^9.15.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+import {OrangebeardReporter} from "./reporter/OrangebeardReporter";
+
+export default OrangebeardReporter;

package/src/reporter/OrangebeardReporter.ts

@@ -0,0 +1,265 @@
+import {UUID} from 'crypto';
+import {Reporter, TestCase, TestResult, TestStep} from '@playwright/test/reporter'
+import {ansiToMarkdown, getBytes, getCodeSnippet, getTime, removeAnsi, testStatusMap} from './utils'
+import {OrangebeardParameters} from "@orangebeard-io/javascript-client/dist/client/models/OrangebeardParameters";
+import OrangebeardAsyncV3Client from "@orangebeard-io/javascript-client/dist/client/OrangebeardAsyncV3Client";
+import {StartTest} from "@orangebeard-io/javascript-client/dist/client/models/StartTest";
+import {Attachment} from "@orangebeard-io/javascript-client/dist/client/models/Attachment";
+import {Log} from "@orangebeard-io/javascript-client/dist/client/models/Log";
+import {Attribute} from "@orangebeard-io/javascript-client/dist/client/models/Attribute";
+import {FinishStep} from "@orangebeard-io/javascript-client/dist/client/models/FinishStep";
+import TestType = StartTest.TestType;
+import LogFormat = Log.LogFormat;
+import LogLevel = Log.LogLevel;
+import Status = FinishStep.Status;
+import * as path from "node:path";
+
+export class OrangebeardReporter implements Reporter {
+
+    config: OrangebeardParameters;
+    client: OrangebeardAsyncV3Client;
+
+    //CONTEXT TRACKING
+    testRunId: UUID;
+    suites: Map<string, UUID> = new Map<string, UUID>(); //suiteNames , uuid
+    tests: Map<string, UUID> = new Map<string, UUID>(); //testId, uuid
+    steps: Map<string, UUID> = new Map<string, UUID>(); //testId_stepPath, uuid
+    promises: Promise<void>[] = [];
+
+    constructor() {
+        this.client = new OrangebeardAsyncV3Client();
+        this.config = this.client.config;
+    }
+
+    onBegin(): void {
+        this.testRunId = this.client.startTestRun({
+            testSetName: this.config.testset,
+            description: this.config.description,
+            startTime: getTime(),
+            attributes: this.config.attributes
+        })
+    }
+
+    async onEnd(): Promise<void> {
+        await Promise.all(this.promises)
+        return this.client.finishTestRun(this.testRunId, {endTime: getTime()})
+    }
+
+    onStdErr(chunk: string | Buffer, test: void | TestCase, _result: void | TestResult): void {
+        //log error level
+
+        if (typeof test === 'object' && test !== null) {
+            const testUUID = this.tests.get(test.id);
+            const message = chunk.toString();
+            this.client.log({
+                logFormat: LogFormat.PLAIN_TEXT,
+                logLevel: LogLevel.ERROR,
+                logTime: getTime(),
+                message: message,
+                testRunUUID: this.testRunId,
+                testUUID: testUUID
+            });
+        }
+    }
+
+    onStdOut(chunk: string | Buffer, test: void | TestCase, _result: void | TestResult): void {
+        if (typeof test === 'object' && test !== null) {
+            const testUUID = this.tests.get(test.id);
+            const message = chunk.toString();
+            this.client.log({
+                logFormat: LogFormat.PLAIN_TEXT,
+                logLevel: LogLevel.INFO,
+                logTime: getTime(),
+                message: message,
+                testRunUUID: this.testRunId,
+                testUUID: testUUID
+            });
+        }
+    }
+
+    onStepBegin(test: TestCase, _result: TestResult, step: TestStep): void {
+        //start step
+        const testUUID = this.tests.get(test.id);
+
+        const stepUUID = this.client.startStep({
+            startTime: getTime(),
+            stepName: step.title,
+            description: step.location ? `${path.basename(step.location.file)}:${step.location.line}`: undefined,
+            testRunUUID: this.testRunId,
+            testUUID: testUUID,
+            parentStepUUID: step.parent ? this.steps.get(test.id + "|" + step.parent.titlePath()) : undefined,
+        })
+        this.steps.set(test.id + "|" + step.titlePath(), stepUUID)
+
+        if(step.location) {
+            this.client.log({
+                logFormat: LogFormat.MARKDOWN,
+                logLevel: LogLevel.INFO,
+                logTime: getTime(),
+                message: getCodeSnippet(step.location.file, step.location.line),
+                testRunUUID: this.testRunId,
+                testUUID: testUUID,
+                stepUUID: stepUUID
+            });
+        }
+    }
+
+    onStepEnd(test: TestCase, _result: TestResult, step: TestStep): void {
+        const testUUID = this.tests.get(test.id);
+        const stepUUID = this.steps.get(test.id + "|" + step.titlePath())
+        if(step.error) {
+            const message = step.error.message;
+            this.client.log({
+                logFormat: LogFormat.MARKDOWN,
+                logLevel: LogLevel.ERROR,
+                logTime: getTime(),
+                message: ansiToMarkdown(message),
+                testRunUUID: this.testRunId,
+                testUUID: testUUID,
+                stepUUID: stepUUID
+            });
+
+            if (step.error.snippet) {
+                this.client.log({
+                    logFormat: LogFormat.MARKDOWN,
+                    logLevel: LogLevel.ERROR,
+                    logTime: getTime(),
+                    message: `\`\`\`js\n${removeAnsi(step.error.snippet)}\n\`\`\``,
+                    testRunUUID: this.testRunId,
+                    testUUID: testUUID,
+                    stepUUID: stepUUID
+                });
+            }
+        }
+
+        this.client.finishStep(this.steps.get(test.id + "|" + step.titlePath()), {
+            endTime: getTime(),
+            status: step.error ? Status.FAILED : Status.PASSED,
+            testRunUUID: this.testRunId
+        })
+        this.steps.delete(test.id + "|" + step.titlePath())
+    }
+
+    onTestBegin(test: TestCase): void {
+        //check suite
+        const suiteUUID = this.getOrStartSuite(test.parent.titlePath())
+        const attributes: Array<Attribute> = [];
+        for (const tag of test.tags) {
+            attributes.push({value: tag})
+        }
+        const testUUID = this.client.startTest({
+            testType: TestType.TEST,
+            testRunUUID: this.testRunId,
+            suiteUUID: suiteUUID,
+            testName: test.title,
+            startTime: getTime(),
+            description: this.getTestDescription(test),
+            attributes: attributes
+        });
+        this.tests.set(test.id, testUUID);
+    }
+
+    async onTestEnd(test: TestCase, result: TestResult): Promise<void> {
+        const testUUID = this.tests.get(test.id);
+        if (result.attachments.length > 0) {
+            let message = "";
+            for (const attachment of result.attachments) {
+                message += `- ${attachment.name} (${attachment.contentType})\n`
+            }
+            const attachmentsLogUUID = this.client.log({
+                logFormat: LogFormat.MARKDOWN,
+                logLevel: LogLevel.INFO,
+                logTime: getTime(),
+                message: message,
+                testRunUUID: this.testRunId,
+                testUUID: testUUID
+            })
+            for (const attachment of result.attachments) {
+                this.promises.push(this.logAttachment(attachment, testUUID, attachmentsLogUUID));
+            }
+        }
+
+        //determine status
+        const status = testStatusMap[result.status]
+
+        //finish test
+        this.client.finishTest(testUUID, {
+            testRunUUID: this.testRunId,
+            status: status,
+            endTime: getTime()
+        });
+        this.tests.delete(test.id);
+    }
+
+    printsToStdio(): boolean {
+        return false;
+    }
+
+    private getOrStartSuite(suitePath: Array<string>): UUID {
+        const filteredSuitePath = suitePath.filter(name => name !== "");
+        let currentPath: Array<string> = [];
+        let parentSuiteUUID: UUID | undefined = undefined;
+
+        for (const suiteName of filteredSuitePath) {
+            currentPath.push(suiteName);
+            const existingSuiteUUID = this.suites.get(currentPath.join('|'));
+
+            if (existingSuiteUUID) {
+                parentSuiteUUID = existingSuiteUUID;
+            } else {
+                const newSuitesUUIDs = this.client.startSuite({
+                    testRunUUID: this.testRunId,
+                    parentSuiteUUID: parentSuiteUUID,
+                    suiteNames: [suiteName],
+                });
+
+                if (newSuitesUUIDs && newSuitesUUIDs.length > 0) {
+                    parentSuiteUUID = newSuitesUUIDs[0];
+                    this.suites.set(currentPath.join('|'), parentSuiteUUID);
+                } else {
+                    console.error(`Failed to create suite for path: ${currentPath.join(' > ')}`);
+                }
+            }
+        }
+        return parentSuiteUUID as UUID;
+    }
+
+    private getTestDescription(test: TestCase): string {
+        let description = `${path.basename(test.location.file)}:${test.location.line}\n`;
+        for (const annotation of test.annotations) {
+            description = `${description + annotation.type}: ${annotation.description}\n`
+        }
+        return description;
+    }
+
+    private async logAttachment(attachment: {
+        name: string,
+        path?: string,
+        body?: Buffer,
+        contentType: string
+    }, testUUID: UUID, logUUID: UUID) {
+        let content: Buffer;
+        if (attachment.body) {
+            content = attachment.body;
+        } else if (attachment.path) {
+            content = await getBytes(attachment.path);
+        } else {
+            throw new Error("Attachment must have either body or path defined.");
+        }
+
+        const orangebeardAttachment: Attachment = {
+            file: {
+                name: path.basename(attachment.path),
+                content: content,
+                contentType: attachment.contentType,
+            },
+            metaData: {
+                testRunUUID: this.testRunId,
+                testUUID: testUUID,
+                logUUID: logUUID,
+                attachmentTime: getTime()
+            },
+        };
+        this.client.sendAttachment(orangebeardAttachment);
+    }
+}

package/src/reporter/utils.ts

@@ -0,0 +1,160 @@
+import {ZonedDateTime} from "@js-joda/core";
+import {FinishTest} from "@orangebeard-io/javascript-client/dist/client/models/FinishTest";
+import * as fs from "node:fs";
+import {promisify} from "util";
+import Status = FinishTest.Status;
+
+const stat = promisify(fs.stat);
+const access = promisify(fs.access);
+
+export function getTime() {
+    return ZonedDateTime.now().withFixedOffsetZone().toString();
+}
+
+export const testStatusMap = {
+    "passed": Status.PASSED,
+    "failed": Status.FAILED,
+    "timedOut": Status.TIMED_OUT,
+    "skipped": Status.SKIPPED,
+    "interrupted": Status.STOPPED
+};
+
+export function removeAnsi(ansiString: string): string {
+    const parts = ansiString.split(/(\u001b\[[0-9;]*[mG])/);
+    let result = "";
+    for (const part of parts) {
+        if (!part.startsWith("\u001b[")) {
+            result += part;
+        }
+    }
+    return result;
+}
+
+export function ansiToMarkdown(ansiString: string): string {
+    let markdown = "";
+    let currentStyle: { italic?: boolean, code?: boolean } = {};
+
+    const ansiCodes = {
+        "31": {italic: true},
+        "32": {italic: true},
+        "39": {italic: false}, // Reset styles
+        "2": {code: true},
+        "22": {code: false},
+    };
+
+    const parts = ansiString.split(/(\u001b\[[0-9;]*[mG])/);
+
+    for (const part of parts) {
+        if (part.startsWith("\u001b[")) {
+            const code = part.slice(2, -1);
+            const codes = code.split(';');
+            for (const c of codes) {
+                const style = ansiCodes[c as keyof typeof ansiCodes]; // Type guard
+                if (style) {
+                    currentStyle = {...currentStyle, ...style};
+                }
+            }
+        } else {
+            let formattedPart = part.replace(/\n/g, "  \n");
+
+            if (currentStyle.italic) {
+                formattedPart = formattedPart.endsWith(" ") ? `*${formattedPart.trim()}* ` : `*${formattedPart}*`;
+
+            }
+            if (currentStyle.code) {
+                formattedPart = `${formattedPart}`;
+            }
+
+            markdown += formattedPart
+
+        }
+    }
+
+    return markdown;
+}
+
+/**
+ * Reads a 3-line snippet from a file, centered around the specified line number.
+ *
+ * @param filePath - The path to the file.
+ * @param lineNumber - The line number to center the snippet around (1-based index).
+ * @returns A promise that resolves with the 3-line snippet or an error message if the line is out of range.
+ */
+export /**
+ * Reads a 3-line snippet from a file, centered around the specified line number.
+ *
+ * @param filePath - The path to the file.
+ * @param lineNumber - The line number to center the snippet around (1-based index).
+ * @returns The 3-line snippet or an error message if the line is out of range.
+ */
+function getCodeSnippet(filePath: string, lineNumber: number): string {
+    if (lineNumber < 1) {
+        throw new Error('Line number must be 1 or greater.');
+    }
+
+    const fileContent = fs.readFileSync(filePath, 'utf8');
+    const lines = fileContent.split(/\r?\n/); // Support both Unix and Windows line endings
+
+    const startLine = Math.max(0, lineNumber - 2); // Zero-based index for one line before
+    const endLine = Math.min(lines.length, lineNumber + 1); // One line after
+
+    if (startLine >= lines.length) {
+        throw new Error('Line number is out of range.');
+    }
+
+    let snippet = lines.slice(startLine, endLine);
+    if (snippet.length > 0 && snippet[0].trim() === "") {
+        snippet = snippet.slice(1);
+    }
+
+    return `\`\`\`js\n${snippet.join('\n')}\n\`\`\``;
+}
+
+const fileExists = async (filepath: string) => {
+    try {
+        await access(filepath, fs.constants.F_OK);
+        return true;
+    } catch {
+        return false;
+    }
+};
+
+const waitForFile = async (filepath: string, interval = 1000, timeout = 60000) => {
+    const start = Date.now();
+
+    while (true) {
+        const now = Date.now();
+        if (now - start > timeout) {
+            throw new Error(`Timeout: ${filepath} did not become available within ${timeout}ms`);
+        }
+
+        if (await fileExists(filepath)) {
+            const stats = [];
+            for (let i = 0; i < 2; i++) {
+                stats.push(await stat(filepath));
+                await new Promise((resolve) => setTimeout(resolve, interval));
+            }
+
+            const [first, second] = stats;
+            if (
+                first.mtimeMs === second.mtimeMs &&
+                first.size === second.size
+            ) {
+                return;
+            }
+        }
+
+        await new Promise((resolve) => setTimeout(resolve, interval));
+    }
+};
+
+export const getBytes = async (filePath: string) => {
+    try {
+        await waitForFile(filePath, 100, 5000)
+        return fs.readFileSync(filePath);
+    } catch (err) {
+        console.error('Error reading file:', err);
+        throw err;
+    }
+};
+

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "allowJs": false,
+    "outDir": "dist",
+    "rootDir": "src",
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/*"]
+    },
+    "typeRoots": ["./node_modules/@types"]
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["node_modules"],
+}