qase-javascript-commons 2.2.3 → 2.2.5

package/changelog.md

@@ -1,3 +1,10 @@
+# qase-javascript-commons@2.2.5
+
+## What's new
+
+Use the API v2 client by default. If you want to use the API v1 client, specify the `useV2` option in the config file or
+the environment variable `QASE_TESTOPS_USEV2` as `False`.
+
 # qase-javascript-commons@2.2.3
 
 ## What's new

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/reporters/testops-reporter.js

@@ -47,7 +47,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
         this.environment = environment;
         this.planId = plan.id;
         this.batchSize = options.batch?.size ?? defaultChunkSize;
-        this.useV2 = options.useV2 ?? false;
+        this.useV2 = options.useV2 ?? true;
         this.defect = options.defect ?? false;
         this.rootSuite = rootSuite;
     }

package/dist/steps/step.d.ts

@@ -0,0 +1,16 @@
+import { Attachment, TestStepType } from '../models';
+export type StepFunction<T = any> = (this: QaseStep, step: QaseStep) => T | Promise<T>;
+export declare class QaseStep {
+    name: string;
+    attachments: Attachment[];
+    steps: TestStepType[];
+    constructor(name: string);
+    attach(attach: {
+        name?: string;
+        type?: string;
+        content?: string;
+        paths?: string[] | string;
+    }): void;
+    step(name: string, body: StepFunction): Promise<void>;
+    run(body: StepFunction, messageEmitter: (step: TestStepType) => Promise<void>): Promise<void>;
+}

package/dist/steps/step.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QaseStep = void 0;
+const uuid_1 = require("uuid");
+const path_1 = __importDefault(require("path"));
+const models_1 = require("../models");
+class QaseStep {
+    constructor(name) {
+        this.name = '';
+        this.attachments = [];
+        this.steps = [];
+        this.name = name;
+    }
+    attach(attach) {
+        if (attach.paths) {
+            const files = Array.isArray(attach.paths) ? attach.paths : [attach.paths];
+            for (const file of files) {
+                const attachmentName = path_1.default.basename(file);
+                const contentType = 'application/octet-stream';
+                this.attachments.push({
+                    id: (0, uuid_1.v4)(),
+                    file_name: attachmentName,
+                    mime_type: contentType,
+                    content: '',
+                    file_path: file,
+                    size: 0,
+                });
+            }
+            return;
+        }
+        if (attach.content) {
+            const attachmentName = attach.name ?? 'attachment';
+            const contentType = attach.type ?? 'application/octet-stream';
+            this.attachments.push({
+                id: (0, uuid_1.v4)(),
+                file_name: attachmentName,
+                mime_type: contentType,
+                content: attach.content,
+                file_path: null,
+                size: attach.content.length,
+            });
+        }
+    }
+    async step(name, body) {
+        const childStep = new QaseStep(name);
+        // eslint-disable-next-line @typescript-eslint/require-await
+        await childStep.run(body, async (step) => {
+            this.steps.push(step);
+        });
+    }
+    async run(body, messageEmitter) {
+        const startDate = new Date().getTime();
+        const step = new models_1.TestStepType();
+        step.data = {
+            action: this.name,
+            expected_result: null,
+        };
+        try {
+            await body.call(this, this);
+            step.execution = {
+                start_time: startDate,
+                end_time: new Date().getTime(),
+                status: models_1.StepStatusEnum.passed,
+                duration: null,
+            };
+            step.attachments = this.attachments;
+            step.steps = this.steps;
+            await messageEmitter(step);
+        }
+        catch (e) {
+            step.execution = {
+                start_time: startDate,
+                end_time: new Date().getTime(),
+                status: models_1.StepStatusEnum.failed,
+                duration: null,
+            };
+            step.attachments = this.attachments;
+            step.steps = this.steps;
+            await messageEmitter(step);
+            throw e;
+        }
+    }
+}
+exports.QaseStep = QaseStep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",