qase-javascript-commons 2.0.0-beta.4 → 2.0.0-beta.6

package/changelog.md

@@ -1,3 +1,49 @@
+# qase-javascript-commons@2.0.0-beta.6
+
+## What's new
+
+### Select the API version to use for reporting
+
+Qase TestOps API has two endpoints for reporting test results:
+
+- Version 1, stable and used my most test reporters.
+  https://developers.qase.io/reference/create-result-bulk
+- Version 2, currently in beta access, and currently supported only
+  in the `playwright-qase-reporter`.
+  https://developers.qase.io/v2.0/reference/create-results-v2
+
+This commit introduces a way to select the API version to use.
+It enables using all new features of v2 JS reporters with the stable v1 API,
+and elso experimenting with the new v2 API.
+
+**Warning**: v2 API is still in beta. 
+If you want to try the v2 JS reporters, you don't have to enable the new API.
+
+To enable using API v2, set an environment variable before running the tests:
+
+```bash
+QASE_TESTOPS_API_V2=true
+```
+
+### Support adding test suite description to a test report.
+
+Test reporters can now test suite description to test results.
+Such description can be collected from test's location and attributes
+or explicitly declared in the test.
+
+Add new data models:
+- Relation
+- Suite
+- SuiteData
+
+
+# qase-javascript-commons@2.0.0-beta.5
+
+## What's new
+
+* 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.
+
 # qase-javascript-commons@2.0.0-beta.4
 
 ## What's new

package/dist/config/config-validation-schema.js

@@ -27,6 +27,10 @@ exports.configValidationSchema = {
             type: ['string', 'number'],
             nullable: true,
         },
+        captureLogs: {
+            type: 'boolean',
+            nullable: true,
+        },
         testops: {
             type: 'object',
             nullable: true,
@@ -111,6 +115,10 @@ exports.configValidationSchema = {
                     type: 'boolean',
                     nullable: true,
                 },
+                useV2: {
+                    type: 'boolean',
+                    nullable: true,
+                },
             },
         },
         report: {

package/dist/env/env-enum.d.ts

@@ -5,7 +5,8 @@ export declare enum EnvEnum {
     mode = "QASE_MODE",
     fallback = "QASE_FALLBACK",
     debug = "QASE_DEBUG",
-    environment = "QASE_ENVIRONMENT"
+    environment = "QASE_ENVIRONMENT",
+    captureLogs = "QASE_CAPTURE_LOGS"
 }
 /**
  * @enum {string}
@@ -14,7 +15,8 @@ export declare enum EnvTestOpsEnum {
     project = "QASE_TESTOPS_PROJECT",
     uploadAttachments = "QASE_TESTOPS_UPLOAD_ATTACHMENTS",
     chunk = "QASE_TESTOPS_CHUNK",
-    defect = "QASE_TESTOPS_DEFECT"
+    defect = "QASE_TESTOPS_DEFECT",
+    useV2 = "QASE_TESTOPS_API_V2"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -10,6 +10,7 @@ var EnvEnum;
     EnvEnum["fallback"] = "QASE_FALLBACK";
     EnvEnum["debug"] = "QASE_DEBUG";
     EnvEnum["environment"] = "QASE_ENVIRONMENT";
+    EnvEnum["captureLogs"] = "QASE_CAPTURE_LOGS";
 })(EnvEnum || (exports.EnvEnum = EnvEnum = {}));
 /**
  * @enum {string}
@@ -20,6 +21,7 @@ var EnvTestOpsEnum;
     EnvTestOpsEnum["uploadAttachments"] = "QASE_TESTOPS_UPLOAD_ATTACHMENTS";
     EnvTestOpsEnum["chunk"] = "QASE_TESTOPS_CHUNK";
     EnvTestOpsEnum["defect"] = "QASE_TESTOPS_DEFECT";
+    EnvTestOpsEnum["useV2"] = "QASE_TESTOPS_API_V2";
 })(EnvTestOpsEnum || (exports.EnvTestOpsEnum = EnvTestOpsEnum = {}));
 /**
  * @enum {string}

package/dist/env/env-to-config.js

@@ -11,6 +11,7 @@ const envToConfig = (env) => ({
     mode: env[env_enum_1.EnvEnum.mode],
     debug: env[env_enum_1.EnvEnum.debug],
     environment: env[env_enum_1.EnvEnum.environment],
+    captureLogs: env[env_enum_1.EnvEnum.captureLogs],
     testops: {
         project: env[env_enum_1.EnvTestOpsEnum.project],
         uploadAttachments: env[env_enum_1.EnvTestOpsEnum.uploadAttachments],
@@ -29,6 +30,7 @@ const envToConfig = (env) => ({
         },
         chunk: env[env_enum_1.EnvTestOpsEnum.chunk],
         defect: env[env_enum_1.EnvTestOpsEnum.defect],
+        useV2: env[env_enum_1.EnvTestOpsEnum.useV2],
     },
     report: {
         connections: {

package/dist/env/env-type.d.ts

@@ -6,10 +6,12 @@ export type EnvType = {
     [EnvEnum.fallback]?: `${ModeEnum}`;
     [EnvEnum.debug]?: boolean;
     [EnvEnum.environment]?: string | number;
+    [EnvEnum.captureLogs]?: boolean;
     [EnvTestOpsEnum.project]?: string;
     [EnvTestOpsEnum.uploadAttachments]?: boolean;
     [EnvTestOpsEnum.chunk]?: number;
     [EnvTestOpsEnum.defect]?: boolean;
+    [EnvTestOpsEnum.useV2]?: boolean;
     [EnvApiEnum.token]?: string;
     [EnvApiEnum.baseUrl]?: string;
     [EnvRunEnum.id]?: number;

package/dist/env/env-validation-schema.js

@@ -28,6 +28,10 @@ exports.envValidationSchema = {
             type: ['string', 'number'],
             nullable: true,
         },
+        [env_enum_1.EnvEnum.captureLogs]: {
+            type: 'boolean',
+            nullable: true,
+        },
         [env_enum_1.EnvTestOpsEnum.project]: {
             type: 'string',
             nullable: true,
@@ -44,6 +48,10 @@ exports.envValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
+        [env_enum_1.EnvTestOpsEnum.useV2]: {
+            type: 'boolean',
+            nullable: true,
+        },
         [env_enum_1.EnvApiEnum.token]: {
             type: 'string',
             nullable: true,

package/dist/index.d.ts

@@ -7,3 +7,4 @@ export * from './options';
 export * from './reporters';
 export * from './writer';
 export * from './utils/get-package-version';
+export * from './utils/mimeTypes';

package/dist/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./options"), exports);
 __exportStar(require("./reporters"), exports);
 __exportStar(require("./writer"), exports);
 __exportStar(require("./utils/get-package-version"), exports);
+__exportStar(require("./utils/mimeTypes"), exports);

package/dist/models/index.d.ts

@@ -1,4 +1,4 @@
-export { type TestResultType } from './test-result';
+export { type TestResultType, Relation, Suite, SuiteData } from './test-result';
 export { TestExecution, TestStatusEnum } from './test-execution';
 export { type TestStepType } from './test-step';
 export { StepStatusEnum } from './step-execution';

package/dist/models/test-result.d.ts

@@ -13,7 +13,17 @@ export type TestResultType = {
     steps: TestStepType[];
     params: Record<string, string>;
     author: string | null;
-    relations: any[];
+    relations: Relation | null;
     muted: boolean;
     message: string | null;
 };
+export type Relation = {
+    suite?: Suite;
+};
+export type Suite = {
+    data: SuiteData[];
+};
+export type SuiteData = {
+    title: string;
+    public_id: number | null;
+};

package/dist/options/options-type.d.ts

@@ -21,6 +21,7 @@ export type OptionsType = {
     reporterName: string;
     mode?: `${ModeEnum}` | undefined;
     fallback?: `${ModeEnum}` | undefined;
+    captureLogs?: boolean | undefined;
     debug?: boolean | undefined;
     environment?: string | number | undefined;
     testops?: (RecursivePartial<TestOpsOptionsType> & AdditionalTestOpsOptionsType) | undefined;

package/dist/qase.js

@@ -71,7 +71,7 @@ class QaseReporter extends reporters_1.AbstractReporter {
     constructor(options, logger) {
         const env = (0, env_1.envToConfig)((0, env_schema_1.default)({ schema: env_1.envValidationSchema }));
         const composedOptions = (0, options_1.composeOptions)(options, env);
-        super({ debug: composedOptions.debug }, logger);
+        super({ debug: composedOptions.debug, captureLogs: composedOptions.captureLogs }, logger);
         /**
          * @type {boolean}
          * @private
@@ -233,13 +233,17 @@ class QaseReporter extends reporters_1.AbstractReporter {
                     },
                     plan,
                     chunk,
-                    ...commonOptions,
+                    debug: commonOptions.debug,
+                    captureLogs: commonOptions.captureLogs,
                 }, apiClient, logger, typeof environment === 'number' ? environment : undefined);
             }
             case options_1.ModeEnum.report: {
                 const localOptions = report.connections?.[writer_1.DriverEnum.local];
                 const writer = new writer_1.FsWriter(localOptions);
-                return new reporters_1.ReportReporter(commonOptions, writer, logger, typeof environment === 'number' ? environment.toString() : environment, testops.run?.id);
+                return new reporters_1.ReportReporter({
+                    debug: commonOptions.debug,
+                    captureLogs: commonOptions.captureLogs,
+                }, writer, logger, typeof environment === 'number' ? environment.toString() : environment, testops.run?.id);
             }
             case options_1.ModeEnum.off:
                 throw new disabled_exception_1.DisabledException();

package/dist/reporters/abstract-reporter.d.ts

@@ -6,12 +6,14 @@ export interface LoggerInterface {
 }
 export interface ReporterOptionsType {
     debug?: boolean | undefined;
+    captureLogs?: boolean | undefined;
 }
 export interface ReporterInterface {
     addTestResult(result: TestResultType): void;
     publish(): Promise<void>;
     getTestResults(): TestResultType[];
     setTestResults(results: TestResultType[]): void;
+    isCaptureLogs(): boolean;
 }
 /**
  * @abstract
@@ -25,6 +27,15 @@ export declare abstract class AbstractReporter implements ReporterInterface {
      * @private
      */
     private readonly debug;
+    /**
+     * @type {boolean | undefined}
+     * @private
+     */
+    private readonly captureLogs;
+    /**
+     * @type {TestResultType[]}
+     * @protected
+     */
     protected results: TestResultType[];
     /**
      * @returns {Promise<void>}
@@ -40,6 +51,10 @@ export declare abstract class AbstractReporter implements ReporterInterface {
      * @returns {TestResultType[]}
      */
     getTestResults(): TestResultType[];
+    /**
+     * @returns {boolean}
+     */
+    isCaptureLogs(): boolean;
     /**
      * @param {TestResultType} result
      */

package/dist/reporters/abstract-reporter.js

@@ -21,9 +21,14 @@ class AbstractReporter {
      */
     constructor(options, logger = console) {
         this.logger = logger;
+        /**
+         * @type {TestResultType[]}
+         * @protected
+         */
         this.results = [];
-        const { debug } = options ?? {};
+        const { debug, captureLogs } = options ?? {};
         this.debug = debug;
+        this.captureLogs = captureLogs;
     }
     /**
      * @returns {TestResultType[]}
@@ -31,6 +36,12 @@ class AbstractReporter {
     getTestResults() {
         return this.results;
     }
+    /**
+     * @returns {boolean}
+     */
+    isCaptureLogs() {
+        return this.captureLogs ?? false;
+    }
     /**
      * @param {TestResultType} result
      */

package/dist/reporters/testops-reporter.d.ts

@@ -1,4 +1,4 @@
-import { QaseApiInterface, ResultStepStatus } from 'qaseio';
+import { QaseApiInterface, ResultStepStatus, TestStepResultCreateStatusEnum } from 'qaseio';
 import { AbstractReporter, LoggerInterface, ReporterOptionsType } from './abstract-reporter';
 import { StepStatusEnum, TestStatusEnum } from '../models';
 export type TestOpsRunType = {
@@ -17,6 +17,7 @@ export type TestOpsOptionsType = {
     plan: TestOpsPlanType;
     chunk?: number | undefined;
     defect?: boolean | undefined;
+    useV2?: boolean | undefined;
 };
 /**
  * @class TestOpsReporter
@@ -32,6 +33,10 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @type {Record<StepStatusEnum, ResultStepStatus>}
      */
     static stepStatusMap: Record<StepStatusEnum, ResultStepStatus>;
+    /**
+     * @type {Record<StepStatusEnum, ResultStepStatus>}
+     */
+    static stepStatusMapV1: Record<StepStatusEnum, TestStepResultCreateStatusEnum>;
     /**
      * @type {string}
      * @private
@@ -62,6 +67,16 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @private
      */
     private readonly chunk;
+    /**
+     * @type {boolean | undefined}
+     * @private
+     */
+    private readonly useV2;
+    /**
+     * @type {boolean | undefined}
+     * @private
+     */
+    private readonly defect;
     /**
      * @param {ReporterOptionsType & TestOpsOptionsType} options
      * @param {QaseApiInterface} api
@@ -79,18 +94,36 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @private
      */
     private transformTestResult;
+    /**
+     * @param {TestResultType} result
+     * @returns Promise<ResultCreate>
+     * @private
+     */
+    private transformTestResultV1;
     /**
      * @returns {ResultExecution}
      * @private
      * @param {TestExecution} exec
      */
     private getExecution;
+    /**
+     * @param {Relation | null} relation
+     * @returns {ResultRelations}
+     * @private
+     */
+    private getRelation;
     /**
      * @param {TestStepType[]} steps
      * @returns Promise<ResultStep[]>
      * @private
      */
     private transformSteps;
+    /**
+     * @param {TestStepType[]} steps
+     * @returns Promise<TestStepResultCreate[]>
+     * @private
+     */
+    private transformStepsV1;
     /**
      * @param {number} runId
      * @returns {Promise<void>}

package/dist/reporters/testops-reporter.js

@@ -33,6 +33,8 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
         this.run = { complete: true, ...run };
         this.environment = environment;
         this.chunk = options.chunk ?? defaultChunkSize;
+        this.useV2 = options.useV2 ?? false;
+        this.defect = options.defect ?? false;
     }
     /**
      * @returns {Promise<void>}
@@ -54,15 +56,29 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             this.log('No test cases were matched. Ensure that your tests are declared correctly.');
             return;
         }
-        const results = [];
-        for (const result of this.results) {
-            const resultCreateV2 = await this.transformTestResult(result);
-            results.push(resultCreateV2);
+        if (this.useV2) {
+            const results = [];
+            for (const result of this.results) {
+                const resultCreateV2 = await this.transformTestResult(result);
+                results.push(resultCreateV2);
+            }
+            for (let i = 0; i < results.length; i += this.chunk) {
+                await this.api.result.createResultsV2(this.projectCode, runId, {
+                    results: results.slice(i, i + this.chunk),
+                });
+            }
         }
-        for (let i = 0; i < results.length; i += this.chunk) {
-            await this.api.result.createResultsV2(this.projectCode, runId, {
-                results: results.slice(i, i + this.chunk),
-            });
+        else {
+            const results = [];
+            for (const result of this.results) {
+                const resultCreate = await this.transformTestResultV1(result);
+                results.push(resultCreate);
+            }
+            for (let i = 0; i < results.length; i += this.chunk) {
+                await this.api.results.createResultBulk(this.projectCode, runId, {
+                    results: results.slice(i, i + this.chunk),
+                });
+            }
         }
         this.log((0, chalk_1.default) `{green ${this.results.length} result(s) sent to Qase}`);
         if (!this.run.complete) {
@@ -93,14 +109,41 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             attachments: attachments,
             steps: steps,
             params: result.params,
-            relations: {
-            // suite: {
-            //   data: result.suiteTitle ? this.getSuites(result.suiteTitle) : [],
-            // },
-            },
+            relations: this.getRelation(result.relations),
             message: result.message,
         };
     }
+    /**
+     * @param {TestResultType} result
+     * @returns Promise<ResultCreate>
+     * @private
+     */
+    async transformTestResultV1(result) {
+        const attachments = await this.uploadAttachments(result.attachments);
+        const steps = await this.transformStepsV1(result.steps);
+        const resultCreate = {
+            attachments: attachments,
+            comment: result.message,
+            defect: this.defect,
+            param: result.params,
+            stacktrace: result.execution.stacktrace,
+            start_time: result.execution.start_time ? result.execution.start_time | 0 : null,
+            status: result.execution.status,
+            steps: steps,
+            time: result.execution.end_time,
+            time_ms: result.execution.duration,
+        };
+        const id = Array.isArray(result.testops_id) ? null : result.testops_id;
+        if (id) {
+            resultCreate.case_id = id;
+            return resultCreate;
+        }
+        resultCreate.case = {
+            title: result.title,
+            suite_title: result.relations?.suite ? result.relations?.suite?.data.map((suite) => suite.title).join('\t') : null,
+        };
+        return resultCreate;
+    }
     /**
      * @returns {ResultExecution}
      * @private
@@ -116,6 +159,28 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             thread: exec.thread,
         };
     }
+    /**
+     * @param {Relation | null} relation
+     * @returns {ResultRelations}
+     * @private
+     */
+    getRelation(relation) {
+        if (!relation || !relation.suite) {
+            return {};
+        }
+        const suiteData = [];
+        for (const data of relation.suite.data) {
+            suiteData.push({
+                public_id: null,
+                title: data.title,
+            });
+        }
+        return {
+            suite: {
+                data: suiteData,
+            },
+        };
+    }
     /**
      * @param {TestStepType[]} steps
      * @returns Promise<ResultStep[]>
@@ -141,6 +206,27 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
         }
         return resultsSteps;
     }
+    /**
+     * @param {TestStepType[]} steps
+     * @returns Promise<TestStepResultCreate[]>
+     * @private
+     */
+    async transformStepsV1(steps) {
+        const resultsSteps = [];
+        for (const step of steps) {
+            const attachmentHashes = await this.uploadAttachments(step.attachments);
+            const resultStep = {
+                status: TestOpsReporter.stepStatusMapV1[step.execution.status],
+                action: step.data.action,
+                attachments: attachmentHashes,
+            };
+            if (step.steps.length > 0) {
+                resultStep.steps = await this.transformStepsV1(step.steps);
+            }
+            resultsSteps.push(resultStep);
+        }
+        return resultsSteps;
+    }
     /**
      * @param {number} runId
      * @returns {Promise<void>}
@@ -235,3 +321,11 @@ TestOpsReporter.stepStatusMap = {
     [models_1.StepStatusEnum.failed]: qaseio_1.ResultStepStatus.FAILED,
     [models_1.StepStatusEnum.blocked]: qaseio_1.ResultStepStatus.BLOCKED,
 };
+/**
+ * @type {Record<StepStatusEnum, ResultStepStatus>}
+ */
+TestOpsReporter.stepStatusMapV1 = {
+    [models_1.StepStatusEnum.passed]: qaseio_1.TestStepResultCreateStatusEnum.PASSED,
+    [models_1.StepStatusEnum.failed]: qaseio_1.TestStepResultCreateStatusEnum.FAILED,
+    [models_1.StepStatusEnum.blocked]: qaseio_1.TestStepResultCreateStatusEnum.BLOCKED,
+};

package/dist/utils/mimeTypes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get mime type of the file
+ * @param {string} filePath
+ */
+export declare function getMimeTypes(filePath: string): string;

package/dist/utils/mimeTypes.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMimeTypes = void 0;
+const path = __importStar(require("path"));
+const mime = __importStar(require("mime-types"));
+/**
+ * Get mime type of the file
+ * @param {string} filePath
+ */
+function getMimeTypes(filePath) {
+    const fileName = path.basename(filePath);
+    const mimeType = mime.contentType(fileName);
+    if (!mimeType && typeof mimeType !== 'string') {
+        return 'application/octet-stream';
+    }
+    return mimeType;
+}
+exports.getMimeTypes = getMimeTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.6",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -26,15 +26,16 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "chalk": "^4.1.2",
+    "child-process-ext": "^3.0.2",
     "env-schema": "^5.2.0",
     "form-data": "^4.0.0",
     "lodash.get": "^4.4.2",
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
+    "mime-types": "^2.1.33",
     "qaseio": "^2.1.0-beta.1",
     "strip-ansi": "^6.0.1",
-    "uuid": "^9.0.0",
-    "child-process-ext": "^3.0.2"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",
@@ -42,6 +43,8 @@
     "@types/lodash.get": "^4.4.7",
     "@types/lodash.merge": "^4.6.7",
     "@types/lodash.mergewith": "^4.6.7",
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^20.12.5",
     "@types/uuid": "^9.0.1",
     "axios": "^0.21.4",
     "jest": "^29.5.0",