@allurereport/plugin-testops 3.6.1 → 3.6.2

package/dist/client.d.ts

@@ -27,7 +27,7 @@ export declare class TestOpsClient {
     startUpload(ci: CiDescriptor): Promise<void>;
     stopUpload(ci: CiDescriptor, status: TestStatus): Promise<void>;
     createLaunch(launchName: string, launchTags: string[]): Promise<void>;
-    createSession(environment?: Record<string, any>): Promise<void>;
+    createSession(environment?: Record<string, unknown>): Promise<void>;
     get namedEnvs(): MapIterator<TestOpsNamedEnv>;
     getNamedEnvFor(id: string): TestOpsNamedEnv | undefined;
     createNamedEnvs(environments: EnvironmentIdentity[], onProgress?: (percent: number, total: number) => void): Promise<void>;

package/dist/client.js

@@ -16,6 +16,7 @@ import { chunk } from "lodash-es";
 import pLimit from "p-limit";
 import { bold } from "yoctocolors";
 import { Logger } from "./logger.js";
+import { toUploadFixturesResultsDto, toUploadResultsDto } from "./uploaderDto.js";
 class TestOpsClientError extends AxiosError {
 }
 const CHUNK_SIZE = 100;
@@ -356,40 +357,33 @@ export class TestOpsClient {
     }
 }
 _TestOpsClient_logger = new WeakMap(), _TestOpsClient_accessToken = new WeakMap(), _TestOpsClient_projectId = new WeakMap(), _TestOpsClient_oauthToken = new WeakMap(), _TestOpsClient_client = new WeakMap(), _TestOpsClient_launch = new WeakMap(), _TestOpsClient_session = new WeakMap(), _TestOpsClient_uploadInProgress = new WeakMap(), _TestOpsClient_uploadLimit = new WeakMap(), _TestOpsClient_namedEnvsIdsByEnv = new WeakMap(), _TestOpsClient_instances = new WeakSet(), _TestOpsClient_postTestResultsChunk = async function _TestOpsClient_postTestResultsChunk(trsChunk) {
-    const { data } = await __classPrivateFieldGet(this, _TestOpsClient_client, "f").post("/api/upload/test-result", {
-        testSessionId: __classPrivateFieldGet(this, _TestOpsClient_session, "f").id,
-        results: trsChunk.map((testResult) => {
-            const extendedTestResult = {
-                ...testResult,
-                uuid: testResult.id,
-            };
-            const namedEnvironment = !!testResult.environment && this.getNamedEnvFor(testResult.environment);
-            if (namedEnvironment) {
-                extendedTestResult.namedEnv = { id: namedEnvironment.id };
-            }
-            if (typeof extendedTestResult.category?.externalId === "string" ||
-                typeof extendedTestResult.category?.externalId === "number") {
-                const category = extendedTestResult.category;
-                extendedTestResult.category = {
-                    externalId: category.externalId,
-                };
-                if (category.grouping && category.grouping.length > 0) {
-                    extendedTestResult.category.grouping = category.grouping;
-                }
-            }
-            const error = extendedTestResult.error;
-            if (typeof error?.message === "string") {
-                extendedTestResult.message = error.message;
-            }
-            if (typeof error?.trace === "string") {
-                extendedTestResult.trace = error.trace;
-            }
-            return extendedTestResult;
-        }),
-    }, { headers: { "Content-Type": "application/json" } });
+    const extendedChunk = trsChunk.map((testResult) => {
+        const extendedTestResult = {
+            ...testResult,
+            uuid: testResult.id,
+        };
+        const namedEnvironment = !!testResult.environment && this.getNamedEnvFor(testResult.environment);
+        if (namedEnvironment) {
+            extendedTestResult.namedEnv = { id: namedEnvironment.id };
+        }
+        const error = extendedTestResult.error;
+        if (typeof error?.message === "string") {
+            extendedTestResult.message = error.message;
+        }
+        if (typeof error?.trace === "string") {
+            extendedTestResult.trace = error.trace;
+        }
+        return extendedTestResult;
+    });
+    const body = toUploadResultsDto(__classPrivateFieldGet(this, _TestOpsClient_session, "f").id, extendedChunk);
+    const { data } = await __classPrivateFieldGet(this, _TestOpsClient_client, "f").post("/api/upload/test-result", body, {
+        headers: { "Content-Type": "application/json" },
+    });
     const reportIdsToTestOpsIds = {};
     for (const { id, uuid } of data.results ?? []) {
-        reportIdsToTestOpsIds[uuid] = id;
+        if (typeof uuid === "string" && typeof id === "number") {
+            reportIdsToTestOpsIds[uuid] = id;
+        }
     }
     return reportIdsToTestOpsIds;
 }, _TestOpsClient_uploadChunkAttachmentsAndFixtures = async function _TestOpsClient_uploadChunkAttachmentsAndFixtures(trsChunk, reportIdsToTestOpsIds, attachmentsResolver, fixturesResolver, uploadLimitFn, onProgress) {
@@ -435,7 +429,6 @@ _TestOpsClient_logger = new WeakMap(), _TestOpsClient_accessToken = new WeakMap(
 }, _TestOpsClient_uploadFixturesForResult = async function _TestOpsClient_uploadFixturesForResult(testOpsResultId, fixtures) {
     if (fixtures.length === 0)
         return;
-    await __classPrivateFieldGet(this, _TestOpsClient_client, "f").post(`/api/upload/test-result/${testOpsResultId}/test-fixture-result`, {
-        fixtures,
-    });
+    const body = toUploadFixturesResultsDto(fixtures);
+    await __classPrivateFieldGet(this, _TestOpsClient_client, "f").post(`/api/upload/test-result/${testOpsResultId}/test-fixture-result`, body);
 };

package/dist/model.d.ts

@@ -13,6 +13,136 @@ export type UploadCategory = {
     expand?: boolean;
     hide?: boolean;
 };
+export type UploadTestStatus = "failed" | "broken" | "passed" | "skipped" | "unknown";
+export type UploadTestResultCategoryGroupingDto = {
+    key?: string;
+    value?: string;
+    name?: string;
+};
+export type UploadTestResultCategoryDto = {
+    id?: number;
+    externalId?: string;
+    grouping?: UploadTestResultCategoryGroupingDto[];
+};
+export type UploadTestResultNamedEnvDto = {
+    id?: number;
+    externalId?: string;
+};
+export type UploadAttachmentDto = {
+    name?: string;
+    originalFileName?: string;
+    contentType?: string;
+    contentLength?: number;
+    optional?: boolean;
+};
+export type UploadParameterDto = {
+    name?: string;
+    value?: string;
+    hidden?: boolean;
+    excluded?: boolean;
+    masked?: boolean;
+};
+export type UploadLinkDto = {
+    name?: string;
+    url?: string;
+    type?: string;
+};
+export type UploadLabelDto = {
+    name?: string;
+    value?: string;
+};
+export type UploadTestResultBodyStepDto = {
+    type: "body";
+    body?: string;
+    bodyJson?: unknown;
+    status?: UploadTestStatus;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    message?: string;
+    trace?: string;
+    parameters?: UploadParameterDto[];
+    steps?: UploadTestResultStepDto[];
+    expectedResultSteps?: UploadTestResultStepDto[];
+};
+export type UploadTestResultExpectedBodyStepDto = {
+    type: "expected_body";
+    body?: string;
+    bodyJson?: unknown;
+    status?: UploadTestStatus;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    message?: string;
+};
+export type UploadTestResultAttachmentStepDto = {
+    type: "attachment";
+    attachment?: UploadAttachmentDto;
+    status?: UploadTestStatus;
+    start?: number;
+    stop?: number;
+    duration?: number;
+};
+export type UploadTestResultUnknownStepDto = {
+    type?: string;
+};
+export type UploadTestResultStepDto = UploadTestResultBodyStepDto | UploadTestResultExpectedBodyStepDto | UploadTestResultAttachmentStepDto | UploadTestResultUnknownStepDto;
+export type UploadTestResultDto = {
+    uuid?: string;
+    historyId?: string;
+    testCaseId?: string;
+    name?: string;
+    fullName?: string;
+    description?: string;
+    descriptionHtml?: string;
+    precondition?: string;
+    preconditionHtml?: string;
+    expectedResult?: string;
+    expectedResultHtml?: string;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    status?: UploadTestStatus;
+    message?: string;
+    trace?: string;
+    hostId?: string;
+    threadId?: string;
+    environment?: string;
+    category?: UploadTestResultCategoryDto;
+    namedEnv?: UploadTestResultNamedEnvDto;
+    steps?: UploadTestResultStepDto[];
+    attachments?: UploadAttachmentDto[];
+    parameters?: UploadParameterDto[];
+    links?: UploadLinkDto[];
+    labels?: UploadLabelDto[];
+};
+export type UploadResultsDto = {
+    testSessionId: number;
+    results?: UploadTestResultDto[];
+};
+export type UploadTestResultResponseDto = {
+    id?: number;
+    uuid?: string;
+};
+export type UploadResultsResponseDto = {
+    results?: UploadTestResultResponseDto[];
+};
+export type UploadTestFixtureType = "BEFORE" | "AFTER";
+export type UploadTestFixtureResultDto = {
+    type?: UploadTestFixtureType;
+    uuid?: string;
+    name?: string;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    status?: UploadTestStatus;
+    message?: string;
+    trace?: string;
+    steps?: UploadTestResultStepDto[];
+};
+export type UploadFixturesResultsDto = {
+    fixtures?: UploadTestFixtureResultDto[];
+};
 export type TestResultWithCategories = Pick<TestResult, "status" | "labels" | "error" | "flaky" | "duration" | "transition" | "environment"> & {
     categories?: {
         id?: string;

package/dist/plugin.js

@@ -19,6 +19,7 @@ import { bold } from "yoctocolors";
 import { TestOpsClient } from "./client.js";
 import { Logger } from "./logger.js";
 import { toUploadCategory } from "./uploadCategory.js";
+import { uploadFilenameForLink } from "./uploaderDto.js";
 import { attachmentsResolverFactory, fixturesResolverFactory, resolvePluginOptions, unwrapStepsAttachments, } from "./utils.js";
 const categoryDisplayName = (cat) => cat.name ?? cat.grouping?.[0]?.name ?? cat.grouping?.[0]?.value ?? cat.grouping?.[0]?.key ?? cat.externalId;
 export class TestOpsPlugin {
@@ -201,12 +202,12 @@ _TestOpsPlugin_logger = new WeakMap(), _TestOpsPlugin_ci = new WeakMap(), _TestO
             attachmentsResolver: async (attachmentLink) => {
                 const content = await store.attachmentContentById(attachmentLink.id);
                 const body = await content?.readContent(async (stream) => stream);
-                const attachmentName = attachmentLink.name || attachmentLink.originalFileName;
-                if (attachmentName === undefined || body === undefined) {
+                const filename = uploadFilenameForLink(attachmentLink);
+                if (filename === undefined || body === undefined) {
                     return undefined;
                 }
                 return {
-                    originalFileName: attachmentName,
+                    originalFileName: filename,
                     contentType: attachmentLink.contentType ?? "application/octet-stream",
                     content: body,
                 };

package/dist/uploaderDto.d.ts

@@ -0,0 +1,9 @@
+import type { AttachmentLink } from "@allurereport/core-api";
+import type { UploadAttachmentDto, UploadFixturesResultsDto, UploadResultsDto, UploadTestFixtureResultDto, UploadTestResultDto } from "./model.js";
+import type { TestOpsFixtureResult, TestOpsPluginTestResult } from "./model.js";
+export declare const uploadFilenameForLink: (link: AttachmentLink) => string | undefined;
+export declare const toUploadAttachmentDto: (link: AttachmentLink) => UploadAttachmentDto;
+export declare const toUploadTestResultDto: (tr: TestOpsPluginTestResult) => UploadTestResultDto;
+export declare const toUploadResultsDto: (testSessionId: number, trs: TestOpsPluginTestResult[]) => UploadResultsDto;
+export declare const toUploadFixtureResultDto: (fxt: TestOpsFixtureResult) => UploadTestFixtureResultDto;
+export declare const toUploadFixturesResultsDto: (fixtures: TestOpsFixtureResult[]) => UploadFixturesResultsDto;

package/dist/uploaderDto.js

@@ -0,0 +1,132 @@
+const isObject = (v) => typeof v === "object" && v !== null;
+const hasString = (obj, key) => typeof obj[key] === "string";
+export const uploadFilenameForLink = (link) => {
+    if ("originalFileName" in link && typeof link.originalFileName === "string")
+        return link.originalFileName;
+    return undefined;
+};
+export const toUploadAttachmentDto = (link) => {
+    return {
+        name: "name" in link && typeof link.name === "string" ? link.name : undefined,
+        originalFileName: uploadFilenameForLink(link),
+        contentType: "contentType" in link && typeof link.contentType === "string" ? link.contentType : undefined,
+        contentLength: "contentLength" in link && typeof link.contentLength === "number" ? link.contentLength : undefined,
+        optional: "optional" in link && typeof link.optional === "boolean"
+            ? link.optional
+            : undefined,
+    };
+};
+const toUploadStepDto = (step) => {
+    if (step.type === "attachment") {
+        return {
+            type: "attachment",
+            attachment: toUploadAttachmentDto(step.link),
+        };
+    }
+    return {
+        type: "body",
+        body: step.name,
+        status: step.status,
+        start: step.start,
+        stop: step.stop,
+        duration: step.duration,
+        message: typeof step.message === "string" ? step.message : undefined,
+        trace: typeof step.trace === "string" ? step.trace : undefined,
+        parameters: step.parameters,
+        steps: step.steps?.map(toUploadStepDto),
+    };
+};
+const normalizeCategory = (category) => {
+    if (!category)
+        return undefined;
+    const externalIdUnknown = category.externalId;
+    const groupingUnknown = category.grouping;
+    const externalId = typeof externalIdUnknown === "string"
+        ? externalIdUnknown
+        : typeof externalIdUnknown === "number"
+            ? String(externalIdUnknown)
+            : undefined;
+    if (!externalId)
+        return undefined;
+    const grouping = Array.isArray(groupingUnknown)
+        ? groupingUnknown
+            .filter(isObject)
+            .map((g) => ({
+            key: hasString(g, "key") ? g.key : undefined,
+            value: hasString(g, "value") ? g.value : undefined,
+            name: hasString(g, "name") ? g.name : undefined,
+        }))
+            .filter((g) => g.key || g.value || g.name)
+        : undefined;
+    return {
+        externalId,
+        ...(grouping && grouping.length > 0 ? { grouping } : {}),
+    };
+};
+const optionalArray = (v, isItem) => {
+    if (!Array.isArray(v))
+        return undefined;
+    const out = [];
+    for (const item of v) {
+        if (isItem(item))
+            out.push(item);
+    }
+    return out;
+};
+const isAttachmentLink = (v) => isObject(v) && hasString(v, "id");
+export const toUploadTestResultDto = (tr) => {
+    const attachmentsUnknown = tr.attachments;
+    const attachments = optionalArray(attachmentsUnknown, isAttachmentLink)?.map(toUploadAttachmentDto);
+    return {
+        uuid: tr.id,
+        historyId: tr.historyId,
+        testCaseId: tr.testCase?.id,
+        name: tr.name,
+        fullName: tr.fullName,
+        description: tr.description,
+        descriptionHtml: tr.descriptionHtml,
+        precondition: tr.precondition,
+        preconditionHtml: tr.preconditionHtml,
+        expectedResult: tr.expectedResult,
+        expectedResultHtml: tr.expectedResultHtml,
+        start: tr.start,
+        stop: tr.stop,
+        duration: tr.duration,
+        status: tr.status,
+        message: tr.message,
+        trace: tr.trace,
+        hostId: tr.hostId,
+        threadId: tr.threadId,
+        environment: tr.environment,
+        ...(normalizeCategory(tr.category) ? { category: normalizeCategory(tr.category) } : {}),
+        ...(typeof tr.namedEnv?.id === "number" ? { namedEnv: { id: tr.namedEnv.id } } : {}),
+        steps: tr.steps?.map(toUploadStepDto),
+        ...(attachments ? { attachments } : {}),
+        parameters: tr.parameters,
+        links: tr.links,
+        labels: tr.labels,
+    };
+};
+export const toUploadResultsDto = (testSessionId, trs) => {
+    return {
+        testSessionId,
+        results: trs.map(toUploadTestResultDto),
+    };
+};
+export const toUploadFixtureResultDto = (fxt) => {
+    return {
+        type: fxt.type,
+        uuid: fxt.id,
+        name: fxt.name,
+        start: fxt.start,
+        stop: fxt.stop,
+        duration: fxt.duration,
+        status: fxt.status,
+        message: fxt.error?.message,
+        trace: fxt.error?.trace,
+        steps: fxt.steps?.map(toUploadStepDto),
+    };
+};
+export const toUploadFixturesResultsDto = (fixtures) => {
+    return { fixtures: fixtures.map(toUploadFixtureResultDto) };
+};

package/dist/utils.js

@@ -1,4 +1,5 @@
 import { env } from "node:process";
+import { uploadFilenameForLink } from "./uploaderDto.js";
 export const unwrapStepsAttachments = (steps) => {
     return steps.map((step) => {
         if (step.type === "attachment") {
@@ -40,12 +41,12 @@ export function attachmentsResolverFactory(store) {
         await Promise.all(attachments.map(async (attachment) => {
             const content = await store.attachmentContentById(attachment.id);
             const body = await content?.readContent(async (s) => s);
-            const name = attachment.name || attachment.originalFileName;
-            if (name === undefined || body === undefined) {
+            const filename = uploadFilenameForLink(attachment);
+            if (filename === undefined || body === undefined) {
                 return undefined;
             }
             result.push({
-                originalFileName: name,
+                originalFileName: filename,
                 contentType: attachment.contentType ?? "application/octet-stream",
                 content: body,
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-testops",
-  "version": "3.6.1",
+  "version": "3.6.2",
   "description": "Allure Plugin TestOps",
   "keywords": [
     "allure",
@@ -32,10 +32,10 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/ci": "3.6.1",
-    "@allurereport/core-api": "3.6.1",
-    "@allurereport/plugin-api": "3.6.1",
-    "@allurereport/reader-api": "3.6.1",
+    "@allurereport/ci": "3.6.2",
+    "@allurereport/core-api": "3.6.2",
+    "@allurereport/plugin-api": "3.6.2",
+    "@allurereport/reader-api": "3.6.2",
     "axios": "^1.15.0",
     "form-data": "^4.0.5",
     "lodash-es": "^4.18.1",