@orangebeard-io/playwright-orangebeard-reporter 1.0.1 → 1.0.3

package/.github/workflows/release.yml

@@ -1,144 +0,0 @@
-name: release
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  get-version:
-    runs-on: ubuntu-latest
-    outputs:
-      releaseVersion: ${{ steps.exposeVersion.outputs.releaseVersion }}
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      - name: Cache node modules
-        uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            node_modules-
-      - name: Install Node dependencies
-        run: npm install
-      - name: Get version from package.json
-        id: exposeVersion
-        run: echo "releaseVersion=$(npm run get-version --silent)" >> $GITHUB_OUTPUT
-  prepare-release:
-    needs: get-version
-    runs-on: ubuntu-latest
-    outputs:
-      versionInfo: ${{ steps.readChangelogEntry.outputs.log_entry }}
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Configure git
-        run: |
-          git config --global user.email "info@orangebeard.io"
-          git config --global user.name "Orangebeard.io"
-      - name: Create tag
-        run: |
-          git tag -a v${{ needs.get-version.outputs.releaseVersion }} -m ${{ needs.get-version.outputs.releaseVersion }}
-          git push origin main --follow-tags
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      - name: Cache node modules
-        uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            node_modules-
-      - name: Install Node dependencies
-        run: npm install
-      - name: Create CHANGELOG.md
-        run: npm run create-changelog
-      - name: Upload changelog as artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: changelog
-          path: CHANGELOG.md
-  create-release:
-    needs: [get-version, prepare-release]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Download changelog for artifact
-        uses: actions/download-artifact@v4
-        with:
-          name: changelog
-      - name: Create Release
-        id: createRelease
-        uses: ncipollo/release-action@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag: v${{ needs.get-version.outputs.releaseVersion }}
-          name: ${{ needs.get-version.outputs.releaseVersion }}
-          bodyFile: CHANGELOG.md
-  publish-release:
-    needs: [get-version, prepare-release, create-release]
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Cache node modules
-        uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            node_modules-
-      - name: Transpile to JS
-        run: npm run build
-      - name: Install Node dependencies
-        run: npm install
-      - name: Publish to NPM
-        run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-  update-version:
-    needs: [get-version, prepare-release, create-release, publish-release]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Configure git
-        run: |
-          git config --global user.email "info@orangebeard.io"
-          git config --global user.name "Orangebeard.io"
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      - name: Cache node modules
-        uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            node_modules-
-      - name: Install Node dependencies
-        run: npm install
-      - name: Update version
-        run: |
-          npm run update-version
-          git add package.json package-lock.json
-          git commit -m "Update version"
-          git push origin main

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "arrowParens": "always",
-  "singleQuote": true,
-  "trailingComma": "all",
-  "printWidth": 100,
-  "endOfLine": "auto"
-}

package/changelog-template.hbs

@@ -1,29 +0,0 @@
-{{#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/src/index.ts

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

package/src/reporter/OrangebeardReporter.ts

@@ -1,265 +0,0 @@
-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

@@ -1,160 +0,0 @@
-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

@@ -1,20 +0,0 @@
-{
-  "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"],
-}