qase-playwright: add capturing logs

Update the reporter for attaching stdout and stderr as attachments .

Author: Dmitrii Gridnev

qase-javascript-commons/changelog.md

@@ -2,7 +2,7 @@
 
 ## What's new
 
-* Update the config of reporters. Added `framework.captureLogs` field. If it is set to `true`, the reporter will capture logs from the test framework.
+* Update the config of reporters. Added `captureLogs` field. If it is set to `true`, the reporter will capture logs from the test framework.
 * Added `getMimeType` function to the commons package. It returns the MIME type of the file by its extension.
 
 # [email protected]

qase-playwright/changelog.md

@@ -1,8 +1,38 @@
+# [email protected]
+
+## What's new
+
+Capture `stdout` and `stderr` logs as attachments.
+To enable this feature, set environment variable `QASE_CAPTURE_LOGS=true` or
+add `captureLogs: true` to the reporter configuration:
+
+```diff
+[
+  'playwright-qase-reporter',
+  {
+    mode: 'testops', 
++   captureLogs: true,
+    ...
+  },
+];
+```
+
 # [email protected]
 
 ## What's new
 
-Added support for the version of [email protected].
+Upload test attachments to Qase:
+```js
+test('test', async ({ page }) => {
+  // upload files by path
+  qase.attach({ paths: '/path/to/file'});
+  // list multiple files at once
+  qase.attach({ paths: ['/path/to/file', '/path/to/another/file']});
+  // upload contents directly from your code
+  qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+  await page.goto('https://example.com');
+});
+```
 
 # [email protected]
 

qase-playwright/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-qase-reporter",
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0-beta.6",
   "description": "Qase TMS Playwright Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -43,7 +43,7 @@
   "author": "Aleksei Galagan <[email protected]> (https://github.com/alexneo2003/)",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0-beta.4",
+    "qase-javascript-commons": "^2.0.0-beta.5",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {

qase-playwright/src/playwright.ts

@@ -2,6 +2,7 @@ import test from '@playwright/test';
 import { v4 as uuidv4 } from 'uuid';
 import { PlaywrightQaseReporter } from './reporter';
 import * as path from 'path';
+import { getMimeTypes } from 'qase-javascript-commons';
 
 export const ReporterContentType = 'application/qase.metadata+json';
 const defaultContentType = 'application/octet-stream';
@@ -141,7 +142,7 @@ qase.attach = function(attach: {
 
     for (const file of files) {
       const attachmentName = path.basename(file);
-      const contentType = getContentType(path.extname(file));
+      const contentType: string = getMimeTypes(file);
       addAttachment(attachmentName, contentType, file);
     }
 
@@ -161,28 +162,6 @@ const addMetadata = (metadata: MetadataMessage): void => {
   });
 };
 
-const getContentType = (extension: string): string => {
-  const types: Record<string, string> = {
-    '.html': 'text/html',
-    '.css': 'text/css',
-    '.js': 'application/javascript',
-    '.json': 'application/json',
-    '.png': 'image/png',
-    '.jpg': 'image/jpeg',
-    '.gif': 'image/gif',
-    '.svg': 'image/svg+xml',
-    '.wav': 'audio/wav',
-    '.mp4': 'video/mp4',
-    '.woff': 'application/font-woff',
-    '.ttf': 'application/font-ttf',
-    '.eot': 'application/vnd.ms-fontobject',
-    '.otf': 'application/font-otf',
-    '.wasm': 'application/wasm',
-  };
-
-  return types[extension] ?? defaultContentType;
-};
-
 const addAttachment = (name: string, contentType: string, filePath?: string, body?: string | Buffer): void => {
   const stepName = `step_attach_${uuidv4()}_${name}`;
 

qase-playwright/src/reporter.ts

@@ -17,6 +17,7 @@ import { MetadataMessage, ReporterContentType } from './playwright';
 type ArrayItemType<T> = T extends (infer R)[] ? R : never;
 
 const stepAttachRegexp = /^step_attach_(\w{8}-\w{4}-\w{4}-\w{4}-\w{12})_/i;
+const logMimeType = 'text/plain';
 
 interface TestCaseMetadata {
   ids: number[];
@@ -50,9 +51,14 @@ export class PlaywrightQaseReporter implements Reporter {
    */
   private static qaseIds: Map<string, number[]> = new Map<string, number[]>();
 
-  // private static transformSuiteTitle(test: TestCase) {
-  //   return test.titlePath().filter(Boolean);
-  // }
+  /**
+   * @param {TestCase} test
+   * @returns {string[]}
+   * @private
+   */
+  private static transformSuiteTitle(test: TestCase): string[] {
+    return test.titlePath().filter(Boolean);
+  }
 
   /**
    * @type {Map<TestStep, TestCase>}
@@ -252,7 +258,7 @@ export class PlaywrightQaseReporter implements Reporter {
   public onTestEnd(test: TestCase, result: TestResult) {
     const testCaseMetadata = this.transformAttachments(result.attachments);
     const error = result.error ? PlaywrightQaseReporter.transformError(result.error) : null;
-
+    const suites = PlaywrightQaseReporter.transformSuiteTitle(test);
     const testResult: TestResultType = {
       attachments: testCaseMetadata.attachments,
       author: null,
@@ -275,13 +281,23 @@ export class PlaywrightQaseReporter implements Reporter {
       params: testCaseMetadata.parameters,
       relations: [],
       run_id: null,
-      signature: '',
+      signature: suites.join(':'),
       steps: this.transformSteps(result.steps, null),
       // suiteTitle: PlaywrightQaseReporter.transformSuiteTitle(test),
       testops_id: null,
       title: testCaseMetadata.title === '' ? test.title : testCaseMetadata.title,
     };
 
+    if (this.reporter.isCaptureLogs()) {
+      if (result.stdout.length > 0) {
+        testResult.attachments.push(this.convertLogsToAttachments(result.stdout, 'stdout.log'));
+      }
+
+      if (result.stderr.length > 0) {
+        testResult.attachments.push(this.convertLogsToAttachments(result.stderr, 'stderr.log'));
+      }
+    }
+
     if (testCaseMetadata.ids.length > 0) {
       testResult.testops_id = testCaseMetadata.ids;
     } else {
@@ -302,4 +318,23 @@ export class PlaywrightQaseReporter implements Reporter {
   public static addIds(ids: number[], title: string): void {
     this.qaseIds.set(title, ids);
   }
+
+  /**
+   * @param {(string | Buffer)[]} logs
+   * @param {string} name
+   * @returns {Attachment}
+   * @private
+   */
+  private convertLogsToAttachments(logs: (string | Buffer)[], name: string): Attachment {
+    let content = '';
+    for (const line of logs) {
+      content = content + line.toString();
+    }
+
+    return {
+      file_name: name,
+      mime_type: logMimeType,
+      content: content,
+    } as Attachment;
+  }
 }