saving status quo

Author: kbrueckner

__tests__/web.spec.ts

@@ -41,7 +41,7 @@ const test = base.extend<MyActors>({
 // TODO: implement test for DoubleClick
 // TODO: test different details between Fill and Type
 test.describe('Testing screenplay-playwright-js web module', () => {
-    test.skip('Navigate', async ({ actor }) => {
+    test('Navigate', async ({ actor }) => {
         await test.step('Navigate to playwright page', async () => {
             await actor.attemptsTo(
                 Navigate.to('https://google.de'),

package-lock.json

@@ -53,7 +53,7 @@
     "@playwright/test": "^1.38.0"
   },
   "dependencies": {
-    "@testla/screenplay": "^1.0.0"
+    "@testla/screenplay": "^1.1.0-beta.1"
   },
   "engines": {
     "node": ">=18.x.x"

package.json

@@ -4,3 +4,5 @@ export const ICON = {
     FAIL: '✗',
     SKIP: '⤿',
 };
+
+export const BLANKS_PER_INDENTATION_LEVEL = 4;

src/constants.ts

@@ -1,3 +1,4 @@
+import { STRUCTURED_LOGS_ENVVAR_NAME } from '@testla/screenplay';
 import type {
     FullResult,
     Reporter, TestCase, TestResult, TestStatus,
@@ -37,7 +38,9 @@ class TextReporter implements Reporter {
                 break;
             case 'failed':
             case 'timedOut':
-                this.failed.push(testId);
+                if (!this.failed.some((entry) => entry === testId)) {
+                    this.failed.push(testId);
+                }
                 break;
             case 'passed':
             default:
@@ -76,16 +79,6 @@ class TextReporter implements Reporter {
         }
     }
 
-    // async onStdOut(chunk: string | Buffer, test: TestCase): Promise<void> {
-    //     const result = await streamToString(
-    //         Readable.from(chunk)
-    //             .pipe(new FilterEventStream())
-    //             .pipe(new ParseEventStream())
-    //             .pipe(new TransformEventToTextStream()),
-    //     );
-    //     this.addToResultBuffer(result, test.id);
-    // }
-
     onBegin() {
         if (this.outputFile && existsSync(this.outputFile)) {
             rm(this.outputFile, (err) => {
@@ -95,25 +88,18 @@ class TextReporter implements Reporter {
             });
         }
 
-        process.env.TEASLA_SCREENPLAY_STRUCTURED_LOGS = 'true';
+        process.env[STRUCTURED_LOGS_ENVVAR_NAME] = 'true';
     }
 
     async onTestEnd(test: TestCase, result: TestResult) {
-        // test.results[0].stdout
-        // this.addToResultBuffer(`${new Date().toISOString()}  [CASE]  ${TextReporter.getResultStatusIcon(result.status)} ${test.parent.title} > ${test.title} [${test._projectId.toUpperCase()}]  [${result.status.toUpperCase()}] (${TextReporter.printRuntime(result.duration)})`, test.id);
-        // this.write(`${new Date().toISOString()}  [CASE${result.retry > 0 ? ` RETRY#${result.retry}` : ''}]  ${TextReporter.getResultStatusIcon(result.status)} ${test.parent.title} > ${test.title} [${test._projectId.toUpperCase()}] [${result.status.toUpperCase()}] (${TextReporter.printRuntime(result.duration)})`);
-        // this.write(`${TextReporter.getResultStatusIcon(result.status)} ${test.parent.title} › ${test.title} ${result.retry > 0 ? `[RETRY#${result.retry}] ` : ''}[${result.status.toUpperCase()} after ${TextReporter.printRuntime(result.duration)}] (${test._projectId.toUpperCase()})`);
+        // eslint-disable-next-line
+        // @ts-ignore
+        // eslint-disable-next-line
         this.write(`[${test._projectId.toUpperCase()}] ${TextReporter.getResultStatusIcon(result.status)} ${test.parent.title} › ${test.title} ${result.retry > 0 ? `[RETRY#${result.retry}] ` : ''}[${result.status.toUpperCase()} after ${TextReporter.printRuntime(result.duration)}]`);
-        this.write('────────────────────────────────');
-        // test.results[0].stdout.forEach((line: string): void => {
-
-        // });
-        // test.results.forEach((result, index) => {
-        // eslint-disable-next-line no-restricted-syntax
-        // for (const resultX of test.results) {
-        //     if (resultX.retry > 0) {
-        //         this.write(`--- retry #${resultX.retry} ---`);
-        //     }
+        if (result.status !== 'skipped') {
+            this.write('────────────────────────────────');
+        }
+
         // eslint-disable-next-line no-await-in-loop
         const reportString = await streamToString(
             Readable.from(result.stdout)
@@ -124,14 +110,14 @@ class TextReporter implements Reporter {
         this.write(reportString);
 
         this.putIntoBucket(TextReporter.getTestId(test), result.status);
-        // };
     }
 
     onEnd(result: FullResult) {
         this.write('────────────────────────────────\n');
         this.write(`Finished the run: ${result.status.toUpperCase()} after ${TextReporter.printRuntime(result.duration)}\n`);
         if (this.failed.length) {
             this.write(`Failed: ${this.failed.length}`);
+            this.failed.sort().forEach((failed: string) => this.write(`    - ${TextReporter.reformatFailedString(failed)}`))
         }
         if (this.skipped.length) {
             this.write(`Skipped: ${this.skipped.length}`);
@@ -149,6 +135,12 @@ class TextReporter implements Reporter {
 
     private static printRuntime = (time: number) => `${(Math.round(time * 1000) / 1000000).toFixed(3)}s`;
 
+    private static reformatFailedString = (str: string) => {
+        const firstArrowReplaced = str.replace('>', '›');
+        const parts = firstArrowReplaced.split('›');
+        return `[${parts[0].trim().toUpperCase()}] ✗ ${parts[1].trim().replaceAll('>', '›')}`;
+    };
+
     // eslint-disable-next-line class-methods-use-this
     printsToStdio(): boolean {
         return false;

src/reporter/text-reporter.ts

@@ -1,7 +1,7 @@
 import { ACTIVITY_TYPE, EXEC_STATUS } from '@testla/screenplay';
 import { ExecStatus, LogEvent } from '@testla/screenplay/lib/interfaces';
 import { Transform, TransformCallback } from 'stream';
-import { ICON } from '../constants';
+import { BLANKS_PER_INDENTATION_LEVEL, ICON } from '../constants';
 
 export class TransformEventToTextStream extends Transform {
     constructor() {
@@ -28,20 +28,32 @@ export class TransformEventToTextStream extends Transform {
         return badge;
     }
 
+    private static indent(level: number) {
+        let indentation = ' ';
+
+        for (let i = 0; i <= level * BLANKS_PER_INDENTATION_LEVEL; i += 1) {
+            indentation = ` ${indentation}`;
+        }
+
+        return indentation;
+    }
+
     // eslint-disable-next-line no-underscore-dangle
     _transform(record: LogEvent, encoding: BufferEncoding, callback: TransformCallback) {
         const msg = `${
             record.time
         }  [${
             TransformEventToTextStream.getStatusText(record.status)
-        }]  ${
+        }]${
+            TransformEventToTextStream.indent(record.wrapLevel)
+        }${
             record.status !== EXEC_STATUS.FAILED ? (record.activityType === ACTIVITY_TYPE.QUESTION ? ICON.PASS : ICON.EXEC) : ICON.FAIL
         } ${
             record.actor
         } ${
-            record.activity
+            record.activityAction
         } ${
-            record.activityText
+            record.activityDetails
         }  (${record.filePath})`;
 
         this.push(msg);