qase-javascript-commons 2.2.19 → 2.3.0

package/dist/reporters/testops-reporter.js

@@ -4,13 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestOpsReporter = void 0;
-const fs_1 = require("fs");
 const chalk_1 = __importDefault(require("chalk"));
-const qaseio_1 = require("qaseio");
 const abstract_reporter_1 = require("./abstract-reporter");
 const models_1 = require("../models");
-const qase_error_1 = require("../utils/qase-error");
-const axios_1 = require("axios");
 const state_1 = require("../state/state");
 const async_mutex_1 = require("async-mutex");
 const defaultChunkSize = 200;
@@ -21,120 +17,29 @@ const defaultChunkSize = 200;
 class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
     api;
     withState;
-    /**
-     * @type {Record<TestStatusEnum, string>}
-     */
-    static statusMap = {
-        [models_1.TestStatusEnum.passed]: 'passed',
-        [models_1.TestStatusEnum.failed]: 'failed',
-        [models_1.TestStatusEnum.skipped]: 'skipped',
-        [models_1.TestStatusEnum.disabled]: 'disabled',
-        [models_1.TestStatusEnum.blocked]: 'blocked',
-        [models_1.TestStatusEnum.invalid]: 'invalid',
-    };
-    /**
-     * @type {Record<StepStatusEnum, ResultStepStatus>}
-     */
-    static stepStatusMap = {
-        [models_1.StepStatusEnum.passed]: qaseio_1.ResultStepStatus.PASSED,
-        [models_1.StepStatusEnum.failed]: qaseio_1.ResultStepStatus.FAILED,
-        [models_1.StepStatusEnum.blocked]: qaseio_1.ResultStepStatus.BLOCKED,
-        [models_1.StepStatusEnum.skipped]: qaseio_1.ResultStepStatus.SKIPPED,
-    };
-    /**
-     * @type {Record<StepStatusEnum, ResultStepStatus>}
-     */
-    static 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,
-        [models_1.StepStatusEnum.skipped]: qaseio_1.TestStepResultCreateStatusEnum.BLOCKED,
-    };
-    /**
-     * @type {string}
-     * @private
-     */
-    baseUrl;
-    /**
-     * @type {string}
-     * @private
-     */
     projectCode;
-    /**
-     * @type {boolean | undefined}
-     * @private
-     */
-    isUploadAttachments;
-    /**
-     * @type {TestOpsRunType}
-     * @private
-     */
-    run;
-    /**
-     * @type { string | undefined}
-     * @private
-     */
-    environment;
-    /**
-     * @type { number | undefined}
-     * @private
-     */
-    planId;
-    /**
-     * @type {TestResultType[]}
-     * @private
-     */
+    baseUrl;
     batchSize;
-    /**
-     * @type {boolean | undefined}
-     * @private
-     */
-    useV2;
-    /**
-     * @type {boolean | undefined}
-     * @private
-     */
-    defect;
-    /**
-     * @type {string | undefined}
-     * @private
-     */
-    rootSuite;
-    /**
-     * @type {number}
-     * @private
-     */
+    runId;
     firstIndex = 0;
-    /**
-     * @type {boolean}
-     * @private
-     */
     isTestRunReady = false;
     mutex = new async_mutex_1.Mutex();
     /**
      * @param {LoggerInterface} logger
-     * @param {ReporterOptionsType & TestOpsOptionsType} options
-     * @param {QaseApiInterface} api
+     * @param {IClient} api
      * @param {boolean} withState
-     * @param {string | undefined} environment
-     * @param {string | undefined} rootSuite
+     * @param {string} projectCode
      * @param {string | undefined} baseUrl
+     * @param {number | undefined} batchSize
      */
-    constructor(logger, options, api, withState, environment, rootSuite, baseUrl) {
-        const { project, uploadAttachments, run, plan, } = options;
+    constructor(logger, api, withState, projectCode, baseUrl, batchSize, runId) {
         super(logger);
         this.api = api;
         this.withState = withState;
+        this.projectCode = projectCode;
         this.baseUrl = this.getBaseUrl(baseUrl);
-        this.projectCode = project;
-        this.isUploadAttachments = uploadAttachments;
-        this.run = { complete: true, ...run };
-        this.environment = environment;
-        this.planId = plan.id;
-        this.batchSize = options.batch?.size ?? defaultChunkSize;
-        this.useV2 = options.useV2 ?? true;
-        this.defect = options.defect ?? false;
-        this.rootSuite = rootSuite;
+        this.batchSize = batchSize ?? defaultChunkSize;
+        this.runId = runId;
     }
     /**
      * @returns {Promise<void>}
@@ -174,33 +79,11 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @returns {Promise<void>}
      */
     async checkOrCreateTestRun() {
-        if (this.run.id !== undefined) {
-            this.isTestRunReady = true;
-            return;
-        }
-        this.logger.logDebug('Creating test run');
-        let environmentId;
-        if (this.environment != undefined) {
-            try {
-                const { data } = await this.api.environment.getEnvironments(this.projectCode, undefined, this.environment, 100);
-                const env = data.result?.entities?.find((env) => env.slug === this.environment);
-                if (env) {
-                    environmentId = env.id;
-                }
-            }
-            catch (error) {
-                throw this.processError(error, 'Error on getting environments');
-            }
-        }
-        const { result } = await this.createRun(this.run.title, this.run.description, environmentId);
-        if (!result?.id) {
-            throw new Error('Cannot create run.');
-        }
-        this.logger.logDebug(`Test run created: ${result.id}`);
-        this.run.id = result.id;
-        process.env['QASE_TESTOPS_RUN_ID'] = String(result.id);
+        const runId = await this.api.createRun();
+        this.runId = runId;
+        process.env['QASE_TESTOPS_RUN_ID'] = String(runId);
         if (this.withState) {
-            state_1.StateManager.setRunId(result.id);
+            state_1.StateManager.setRunId(runId);
         }
         this.isTestRunReady = true;
     }
@@ -210,36 +93,10 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @private
      */
     async publishResults(testResults) {
-        if (this.useV2) {
-            const results = [];
-            for (const result of testResults) {
-                const resultCreateV2 = await this.transformTestResult(result);
-                results.push(resultCreateV2);
-            }
-            try {
-                await this.api.result.createResultsV2(this.projectCode, this.run.id, {
-                    results: results,
-                });
-            }
-            catch (error) {
-                throw this.processError(error, 'Error on uploading results', results);
-            }
-        }
-        else {
-            const results = [];
-            for (const result of testResults) {
-                const resultCreate = await this.transformTestResultV1(result);
-                results.push(resultCreate);
-            }
-            try {
-                await this.api.results.createResultBulk(this.projectCode, this.run.id, {
-                    results: results,
-                });
-            }
-            catch (error) {
-                throw this.processError(error, 'Error on uploading results', results);
-            }
+        if (!this.runId) {
+            throw new Error('Run ID is not set');
         }
+        await this.api.uploadResults(this.runId, testResults);
         this.logger.logDebug(`Results sent to Qase: ${testResults.length}`);
     }
     /**
@@ -280,384 +137,11 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @returns {Promise<void>}
      */
     async complete() {
-        if (!this.run.complete) {
-            return;
-        }
-        try {
-            await this.api.runs.completeRun(this.projectCode, this.run.id);
-            this.logger.log((0, chalk_1.default) `{green Run ${this.run.id} completed}`);
-        }
-        catch (error) {
-            throw this.processError(error, 'Error on completing run');
-        }
-        const runUrl = `${this.baseUrl}/run/${this.projectCode}/dashboard/${this.run.id}`;
-        this.logger.log((0, chalk_1.default) `{blue Test run link: ${runUrl}}`);
-    }
-    /**
-     * @param {TestResultType} result
-     * @returns Promise<ResultCreateV2>
-     * @private
-     */
-    async transformTestResult(result) {
-        const attachments = await this.uploadAttachments(result.attachments);
-        const steps = await this.transformSteps(result.steps, result.title);
-        const param = {};
-        for (const key in result.params) {
-            const value = result.params[key];
-            if (!value) {
-                continue;
-            }
-            param[key] = value;
-        }
-        const group_params = [];
-        const keys = Object.keys(result.group_params);
-        if (keys.length > 0) {
-            group_params.push(keys);
-        }
-        for (const key in result.group_params) {
-            const value = result.group_params[key];
-            if (!value) {
-                continue;
-            }
-            param[key] = value;
-        }
-        const model = {
-            title: result.title,
-            execution: this.getExecution(result.execution),
-            testops_id: Array.isArray(result.testops_id) ? null : result.testops_id,
-            attachments: attachments,
-            steps: steps,
-            params: param,
-            param_groups: group_params,
-            relations: this.getRelation(result.relations),
-            message: result.message,
-            fields: result.fields,
-            defect: this.defect,
-        };
-        this.logger.logDebug(`Transformed result: ${JSON.stringify(model)}`);
-        return model;
-    }
-    /**
-     * @param {TestResultType} result
-     * @returns Promise<ResultCreate>
-     * @private
-     */
-    async transformTestResultV1(result) {
-        const attachments = await this.uploadAttachments(result.attachments);
-        const steps = await this.transformStepsV1(result.steps, result.title);
-        const param = {};
-        for (const key in result.params) {
-            const value = result.params[key];
-            if (!value) {
-                continue;
-            }
-            param[key] = value;
-        }
-        const group_params = [];
-        const keys = Object.keys(result.group_params);
-        if (keys.length > 0) {
-            group_params.push(keys);
-        }
-        for (const key in result.group_params) {
-            const value = result.group_params[key];
-            if (!value) {
-                continue;
-            }
-            param[key] = value;
-        }
-        const resultCreate = {
-            attachments: attachments,
-            comment: result.message,
-            defect: this.defect,
-            param: param,
-            param_groups: group_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;
-        }
-        const rootSuite = this.rootSuite ? `${this.rootSuite}\t` : '';
-        resultCreate.case = {
-            title: result.title,
-            suite_title: result.relations?.suite ? `${rootSuite}${result.relations.suite.data.map((suite) => suite.title).join('\t')}` : rootSuite,
-            description: result.fields['description'] ?? null,
-            postconditions: result.fields['postconditions'] ?? null,
-            preconditions: result.fields['preconditions'] ?? null,
-        };
-        if (result.fields['severity']) {
-            resultCreate.case.severity = result.fields['severity'];
-        }
-        if (result.fields['priority']) {
-            resultCreate.case.priority = result.fields['priority'];
-        }
-        if (result.fields['layer']) {
-            resultCreate.case.layer = result.fields['layer'];
-        }
-        if (result.fields['author']) {
-            const resp = await this.api.authors.getAuthors(result.fields['author']);
-            if (resp.data.result?.entities && resp.data.result.entities.length > 0) {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                resultCreate.author_id = resp.data.result.entities[0]?.author_id ?? null;
-            }
-        }
-        this.logger.logDebug(`Transformed result: ${JSON.stringify(resultCreate)}`);
-        return resultCreate;
-    }
-    /**
-     * @returns {ResultExecution}
-     * @private
-     * @param {TestExecution} exec
-     */
-    getExecution(exec) {
-        return {
-            status: TestOpsReporter.statusMap[exec.status],
-            start_time: exec.start_time,
-            end_time: exec.end_time,
-            duration: exec.duration,
-            stacktrace: exec.stacktrace,
-            thread: exec.thread,
-        };
-    }
-    /**
-     * @param {Relation | null} relation
-     * @returns {ResultRelations}
-     * @private
-     */
-    getRelation(relation) {
-        if (!relation?.suite) {
-            if (this.rootSuite == undefined) {
-                return {};
-            }
-            return {
-                suite: {
-                    data: [
-                        {
-                            public_id: null,
-                            title: this.rootSuite,
-                        },
-                    ],
-                },
-            };
-        }
-        const suiteData = [];
-        if (this.rootSuite != undefined) {
-            suiteData.push({
-                public_id: null,
-                title: this.rootSuite,
-            });
+        if (!this.runId) {
+            throw new Error('Run ID is not set');
         }
-        for (const data of relation.suite.data) {
-            suiteData.push({
-                public_id: null,
-                title: data.title,
-            });
-        }
-        return {
-            suite: {
-                data: suiteData,
-            },
-        };
-    }
-    /**
-     * @param {TestStepType[]} steps
-     * @param testTitle
-     * @returns Promise<ResultStep[]>
-     * @private
-     */
-    async transformSteps(steps, testTitle) {
-        const resultsSteps = [];
-        for (const step of steps) {
-            const attachmentHashes = await this.uploadAttachments(step.attachments);
-            const resultStep = {
-                data: {
-                    action: '',
-                },
-                execution: {
-                    status: TestOpsReporter.stepStatusMap[step.execution.status],
-                    attachments: attachmentHashes,
-                },
-            };
-            if (step.step_type === models_1.StepType.TEXT) {
-                if ('action' in step.data && resultStep.data != undefined) {
-                    if (step.data.action === '') {
-                        this.logEmptyStep(testTitle);
-                        resultStep.data.action = 'Unnamed step';
-                    }
-                    else {
-                        resultStep.data.action = step.data.action;
-                    }
-                }
-                if ('expected_result' in step.data && resultStep.data != undefined && step.data.expected_result != null) {
-                    resultStep.data.expected_result = step.data.expected_result;
-                }
-                if ('data' in step.data && resultStep.data != undefined && step.data.data != null) {
-                    resultStep.data.input_data = step.data.data;
-                }
-            }
-            if (step.step_type === models_1.StepType.GHERKIN) {
-                if ('keyword' in step.data && resultStep.data != undefined) {
-                    resultStep.data.action = step.data.keyword;
-                }
-            }
-            if (step.steps.length > 0) {
-                resultStep.steps = await this.transformSteps(step.steps, testTitle);
-            }
-            resultsSteps.push(resultStep);
-        }
-        return resultsSteps;
-    }
-    /**
-     * @param {TestStepType[]} steps
-     * @param testTitle
-     * @returns Promise<TestStepResultCreate[]>
-     * @private
-     */
-    async transformStepsV1(steps, testTitle) {
-        const resultsSteps = [];
-        for (const step of steps) {
-            const attachmentHashes = await this.uploadAttachments(step.attachments);
-            const resultStep = {
-                status: TestOpsReporter.stepStatusMapV1[step.execution.status],
-                attachments: attachmentHashes,
-            };
-            if (step.step_type === models_1.StepType.TEXT) {
-                if ('action' in step.data) {
-                    if (step.data.action === '') {
-                        this.logEmptyStep(testTitle);
-                        resultStep.action = 'Unnamed step';
-                    }
-                    else {
-                        resultStep.action = step.data.action;
-                    }
-                }
-            }
-            if (step.step_type === models_1.StepType.GHERKIN) {
-                if ('keyword' in step.data) {
-                    resultStep.action = step.data.keyword;
-                }
-            }
-            if (step.steps.length > 0) {
-                resultStep.steps = await this.transformStepsV1(step.steps, testTitle);
-            }
-            resultsSteps.push(resultStep);
-        }
-        return resultsSteps;
-    }
-    logEmptyStep(testTitle) {
-        this.logger.log((0, chalk_1.default) `{magenta Test '${testTitle}' has empty action in step. The reporter will mark this step as unnamed step.}`);
-    }
-    /**
-     * @param {string} title
-     * @param {string} description
-     * @param {number | undefined} environment
-     * @returns {Promise<IdResponse>}
-     * @private
-     */
-    async createRun(title, description, environment) {
-        try {
-            const runObject = {
-                title,
-                description,
-                is_autotest: true,
-                cases: [],
-                start_time: this.getDate(),
-            };
-            if (environment !== undefined) {
-                runObject.environment_id = environment;
-            }
-            if (this.planId) {
-                runObject.plan_id = this.planId;
-            }
-            const { data } = await this.api.runs.createRun(this.projectCode, runObject);
-            return data;
-        }
-        catch (error) {
-            throw this.processError(error, 'Error on creating run');
-        }
-    }
-    /**
-     * @returns {string}
-     * @private
-     */
-    getDate() {
-        const date = new Date();
-        date.setSeconds(-10);
-        const year = date.getUTCFullYear();
-        const month = ('0' + (date.getUTCMonth() + 1).toString()).slice(-2); // Months are zero indexed, so we add 1
-        const day = ('0' + date.getUTCDate().toString()).slice(-2);
-        const hours = ('0' + date.getUTCHours().toString()).slice(-2);
-        const minutes = ('0' + date.getUTCMinutes().toString()).slice(-2);
-        const seconds = ('0' + date.getUTCSeconds().toString()).slice(-2);
-        return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
-    }
-    /**
-     * @returns {Promise<void>}
-     * @private
-     */
-    async uploadAttachments(attachments) {
-        if (!this.isUploadAttachments) {
-            return [];
-        }
-        const acc = [];
-        for (const attachment of attachments) {
-            this.logger.logDebug(`Uploading attachment: ${attachment.file_path ?? attachment.file_name}`);
-            try {
-                let data;
-                if (attachment.file_path) {
-                    data = { name: attachment.file_name, value: (0, fs_1.createReadStream)(attachment.file_path) };
-                }
-                else {
-                    if (typeof attachment.content === 'string') {
-                        data = { name: attachment.file_name, value: Buffer.from(attachment.content) };
-                    }
-                    else {
-                        data = { name: attachment.file_name, value: attachment.content };
-                    }
-                }
-                const response = await this.api.attachments.uploadAttachment(this.projectCode, [data]);
-                if (response.data.result?.[0]?.hash != undefined) {
-                    acc.push(response.data.result[0].hash);
-                }
-            }
-            catch (error) {
-                this.logger.logError('Cannot upload attachment:', error);
-            }
-        }
-        return acc;
-    }
-    /**
-     * Process error and throw QaseError
-     * @param {Error | AxiosError} error
-     * @param {string} message
-     * @param {object} model
-     * @private
-     */
-    processError(error, message, model) {
-        if (!(0, axios_1.isAxiosError)(error)) {
-            return new qase_error_1.QaseError(message, { cause: error });
-        }
-        const err = error;
-        if (err.response?.status === 401) {
-            return new qase_error_1.QaseError(message + ': \n Unauthorized. Please check your API token. Maybe it is expired or invalid.');
-        }
-        if (err.response?.status === 404) {
-            return new qase_error_1.QaseError(message + ': Not found.');
-        }
-        if (err.response?.status === 403) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/restrict-template-expressions
-            return new qase_error_1.QaseError(`${message}: ${error.response?.data?.errorMessage}`);
-        }
-        if (err.response?.status === 400 || err.response?.status === 422) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/restrict-template-expressions
-            return new qase_error_1.QaseError(message + ': \n Bad request: \n' + `${JSON.stringify(err.response?.data)}` + '. \n Body: \n ' + JSON.stringify(model));
-        }
-        return new qase_error_1.QaseError(message, { cause: err });
+        await this.api.completeRun(this.runId);
+        this.logger.log((0, chalk_1.default) `{green Run ${this.runId} completed}`);
     }
     /**
      * @param {string | undefined} url
@@ -677,7 +161,10 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @private
      */
     prepareFailedTestLink(id, title) {
-        const baseLink = `${this.baseUrl}/run/${this.projectCode}/dashboard/${this.run.id}?source=logs&status=%5B2%5D&search=`;
+        if (!this.runId) {
+            throw new Error('Run ID is not set');
+        }
+        const baseLink = `${this.baseUrl}/run/${this.projectCode}/dashboard/${this.runId}?source=logs&status=%5B2%5D&search=`;
         if (id) {
             return `${baseLink}${id}`;
         }

package/dist/state/state.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StateManager = void 0;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
 class StateManager {
     static statePath = path_1.default.resolve(__dirname, 'reporterState.json');
     static getState() {

package/dist/steps/step.d.ts

@@ -1,5 +1,5 @@
 import { Attachment, TestStepType } from '../models';
-export type StepFunction<T = any> = (this: QaseStep, step: QaseStep) => T | Promise<T>;
+export type StepFunction<T = unknown> = (this: QaseStep, step: QaseStep) => T | Promise<T>;
 export declare class QaseStep {
     name: string;
     attachments: Attachment[];

package/dist/steps/step.js

@@ -71,7 +71,7 @@ class QaseStep {
             step.steps = this.steps;
             await messageEmitter(step);
         }
-        catch (e) {
+        catch (error) {
             step.execution = {
                 start_time: startDate,
                 end_time: new Date().getTime(),
@@ -81,7 +81,7 @@ class QaseStep {
             step.attachments = this.attachments;
             step.steps = this.steps;
             await messageEmitter(step);
-            throw e;
+            throw error;
         }
     }
 }

package/dist/utils/hostData.js

@@ -167,7 +167,8 @@ function getHostInfo(framework, reporterName) {
             framework: getPackageVersion(framework) ?? '',
             reporter: getPackageVersion(reporterName) ?? '',
             commons: getPackageVersion('qase-javascript-commons') ?? '',
-            apiClient: getPackageVersion('qaseio') ?? '',
+            apiClientV1: getPackageVersion('qase-api-client') ?? '',
+            apiClientV2: getPackageVersion('qase-api-v2-client') ?? '',
         };
     }
     catch (error) {
@@ -182,7 +183,8 @@ function getHostInfo(framework, reporterName) {
             framework: '',
             reporter: '',
             commons: '',
-            apiClient: '',
+            apiClientV1: '',
+            apiClientV2: '',
         };
     }
 }