@allurereport/ci 3.21.0 → 3.22.1

package/README.md

@@ -9,3 +9,20 @@
 - 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
 
 ---
+
+## Publication outcomes in report summaries
+
+Plugin summaries have an optional `published` boolean. `true` means the requested publication
+completed; `false` means publication was requested but did not complete. The field is omitted
+when publication was not requested, including realtime runs. Dump-only runs generate no summaries.
+Plugins without a summary are outside this publication status contract.
+
+The remote batch is confirmed only after completion. If uploading or completing the batch fails,
+all reports in that batch are marked unpublished even if some files were already uploaded.
+A successful publication does not require a returned report link.
+
+`createReportContext` reads the flag from `summary.json`; `createReportContextFromData` accepts it
+in `summaries`. `renderReportSummaryMarkdown` includes an **Expected reports were not published**
+warning after the statistics table for reports with `published: false`. Older summaries without
+the field retain the existing output. Details remain in the CLI logs; publication warnings do not
+change test statistics, quality gates, or the run's exit code.

package/dist/detectors/amazon.js

@@ -143,6 +143,12 @@ export const amazon = {
             return getProjectName(buildArn);
         }
     },
+    get pipelineRunName() {
+        return getPipelineName();
+    },
+    get pipelineRunUrl() {
+        return getPipelineName() ? this.jobUrl : undefined;
+    },
     get jobRunUid() {
         const pipelineName = getPipelineName();
         if (pipelineName) {
@@ -153,6 +159,10 @@ export const amazon = {
         }
     },
     get jobRunUrl() {
+        const buildUrl = getEnv("CODEBUILD_BUILD_URL");
+        if (buildUrl) {
+            return buildUrl;
+        }
         const pipelineName = getPipelineName();
         if (pipelineName) {
             const buildArn = getEnv("CODEBUILD_BUILD_ARN");
@@ -197,6 +207,10 @@ export const amazon = {
     get pullRequestName() {
         return "";
     },
+    get commitSha() {
+        const version = getEnv("CODEBUILD_RESOLVED_SOURCE_VERSION") || getEnv("CODEBUILD_SOURCE_VERSION");
+        return GIT_SHA_REGEXP.test(version) ? version : undefined;
+    },
     get provider() {
         return getRepository()?.provider;
     },

package/dist/detectors/azure.js

@@ -80,6 +80,12 @@ export const azure = {
         }
         return getEnv("BUILD_DEFINITIONNAME");
     },
+    get pipelineRunName() {
+        return this.jobName || this.jobRunName || this.jobRunUid;
+    },
+    get pipelineRunUrl() {
+        return this.jobRunUid ? this.jobRunUrl : undefined;
+    },
     get jobRunUid() {
         if (isClassicRelease()) {
             return getEnv("RELEASE_RELEASEID");
@@ -119,6 +125,15 @@ export const azure = {
     get pullRequestName() {
         return "";
     },
+    get commitSha() {
+        return getEnv("SYSTEM_PULLREQUEST_SOURCECOMMITID") || getEnv("BUILD_SOURCEVERSION") || undefined;
+    },
+    get commitUrl() {
+        const repositoryUrl = getRepositoryUrl();
+        if (getEnv("BUILD_REPOSITORY_PROVIDER") !== "TfsGit" || !repositoryUrl || !this.commitSha)
+            return undefined;
+        return `${getBrowserRepositoryUrl(repositoryUrl)}/commit/${encodeURIComponent(this.commitSha)}`;
+    },
     get provider() {
         return getRepositoryFromUrl()?.provider ?? mapAzureRepositoryProvider(getEnv("BUILD_REPOSITORY_PROVIDER"));
     },

package/dist/detectors/bitbucket.js

@@ -40,6 +40,12 @@ export const bitbucket = {
     get jobName() {
         return getEnv("BITBUCKET_REPO_FULL_NAME");
     },
+    get pipelineRunName() {
+        return getEnv("BITBUCKET_BUILD_NUMBER") || this.jobRunUid;
+    },
+    get pipelineRunUrl() {
+        return this.jobRunUid ? this.jobRunUrl : undefined;
+    },
     get jobRunUid() {
         return getEnv("BITBUCKET_PIPELINE_UUID");
     },
@@ -66,6 +72,9 @@ export const bitbucket = {
     get pullRequestName() {
         return "";
     },
+    get commitSha() {
+        return getEnv("BITBUCKET_COMMIT") || undefined;
+    },
     get provider() {
         return GitProvider.Bitbucket;
     },

package/dist/detectors/circle.js

@@ -50,6 +50,13 @@ export const circle = {
         const reponame = getEnv("CIRCLE_PROJECT_REPONAME");
         return `${username}/${reponame}`;
     },
+    get pipelineRunName() {
+        return getEnv("CIRCLE_WORKFLOW_ID");
+    },
+    get pipelineRunUrl() {
+        const id = getEnv("CIRCLE_WORKFLOW_ID");
+        return id ? `https://app.circleci.com/pipelines/workflows/${encodeURIComponent(id)}` : undefined;
+    },
     get jobRunUid() {
         return getEnv("CIRCLE_WORKFLOW_JOB_ID");
     },
@@ -68,6 +75,9 @@ export const circle = {
     get pullRequestName() {
         return "";
     },
+    get commitSha() {
+        return getEnv("CIRCLE_SHA1") || undefined;
+    },
     get provider() {
         return getRepository()?.provider;
     },

package/dist/detectors/drone.js

@@ -66,6 +66,12 @@ export const drone = {
     get jobName() {
         return getEnv("DRONE_REPO");
     },
+    get pipelineRunName() {
+        return getEnv("DRONE_REPO") || getJobRunUID();
+    },
+    get pipelineRunUrl() {
+        return getJobRunURL() || undefined;
+    },
     get jobRunUid() {
         return getJobRunUID();
     },
@@ -101,6 +107,9 @@ export const drone = {
     get pullRequestName() {
         return getEnv("DRONE_PULL_REQUEST_TITLE");
     },
+    get commitSha() {
+        return getEnv("DRONE_COMMIT_SHA") || undefined;
+    },
     get provider() {
         return getRepository()?.provider;
     },

package/dist/detectors/github.js

@@ -1,6 +1,6 @@
 import { join } from "node:path/posix";
 import { CiType, GitProvider } from "@allurereport/core-api";
-import { resolveGithubPullRequestContext, resolveGithubPullRequestNumber } from "../helpers/github.js";
+import { resolveGithubCommitSha, resolveGithubPullRequestContext, resolveGithubPullRequestNumber, } from "../helpers/github.js";
 import { stripRefsHeads } from "../helpers/gitProvider.js";
 import { getEnv } from "../utils.js";
 const getBaseURL = () => getEnv("GITHUB_SERVER_URL");
@@ -55,6 +55,12 @@ export const github = {
     get jobName() {
         return `${getRepo()} - ${getWorkflow()}`;
     },
+    get pipelineRunName() {
+        return getWorkflow() || getRunID();
+    },
+    get pipelineRunUrl() {
+        return getRunID() ? this.jobRunUrl : undefined;
+    },
     get jobRunUid() {
         return getRunID();
     },
@@ -86,6 +92,9 @@ export const github = {
         }
         return `Pull request #${pullRequestNumber}`;
     },
+    get commitSha() {
+        return resolveGithubCommitSha();
+    },
     get provider() {
         return GitProvider.Github;
     },

package/dist/detectors/gitlab.js

@@ -34,6 +34,12 @@ export const gitlab = {
     get ciJobName() {
         return getEnv("CI_JOB_NAME");
     },
+    get pipelineRunName() {
+        return getEnv("CI_PIPELINE_NAME") || getEnv("CI_PIPELINE_ID");
+    },
+    get pipelineRunUrl() {
+        return getEnv("CI_PIPELINE_URL") || undefined;
+    },
     get jobRunUid() {
         return getEnv("CI_PIPELINE_ID");
     },
@@ -57,6 +63,9 @@ export const gitlab = {
     get pullRequestName() {
         return getEnv("CI_MERGE_REQUEST_TITLE");
     },
+    get commitSha() {
+        return getEnv("CI_MERGE_REQUEST_SOURCE_BRANCH_SHA") || getEnv("CI_COMMIT_SHA") || undefined;
+    },
     get provider() {
         return GitProvider.Gitlab;
     },

package/dist/detectors/jenkins.js

@@ -64,6 +64,9 @@ export const jenkins = {
     get pullRequestName() {
         return getEnv("CHANGE_TITLE");
     },
+    get commitSha() {
+        return getEnv("GIT_COMMIT") || undefined;
+    },
     get provider() {
         return getRepository()?.provider;
     },

package/dist/detectors/local.js

@@ -59,6 +59,10 @@ export const local = {
     get pullRequestName() {
         return "";
     },
+    get commitSha() {
+        const output = spawnSync("git", ["rev-parse", "HEAD"]);
+        return !output.error && output.status === 0 ? output.stdout.toString().trim() || undefined : undefined;
+    },
     get provider() {
         return getRepository()?.provider;
     },

package/dist/helpers/github.d.ts

@@ -2,8 +2,10 @@ export type GithubPullRequestContext = {
     number: string;
     headRef?: string;
     baseRef?: string;
+    headSha?: string;
 };
 export declare const parsePullRequestContextFromEventJson: (content: string) => GithubPullRequestContext | undefined;
 export declare const parsePullRequestNumberFromEventJson: (content: string) => string;
 export declare const resolveGithubPullRequestContext: () => GithubPullRequestContext | undefined;
+export declare const resolveGithubCommitSha: () => string | undefined;
 export declare const resolveGithubPullRequestNumber: () => string;

package/dist/helpers/github.js

@@ -21,11 +21,11 @@ const contextFromPullRequestFields = (pullRequest, fallbackNumber) => {
         number,
         headRef: nonBlank(pullRequest?.head?.ref),
         baseRef: nonBlank(pullRequest?.base?.ref),
+        headSha: nonBlank(pullRequest?.head?.sha),
     };
 };
-export const parsePullRequestContextFromEventJson = (content) => {
+const pullRequestContextFromEvent = (event) => {
     try {
-        const event = JSON.parse(content);
         const fromPullRequest = contextFromPullRequestFields(event.pull_request, event.number);
         if (fromPullRequest) {
             return fromPullRequest;
@@ -40,17 +40,25 @@ export const parsePullRequestContextFromEventJson = (content) => {
         return undefined;
     }
 };
+export const parsePullRequestContextFromEventJson = (content) => {
+    try {
+        return pullRequestContextFromEvent(JSON.parse(content));
+    }
+    catch {
+        return undefined;
+    }
+};
 export const parsePullRequestNumberFromEventJson = (content) => {
     return parsePullRequestContextFromEventJson(content)?.number ?? "";
 };
-const readPullRequestContextFromEventPath = () => {
+const readGithubEventFromPath = () => {
     const eventPath = getEnv("GITHUB_EVENT_PATH");
     if (!eventPath) {
         return undefined;
     }
     try {
         const content = readFileSync(eventPath, "utf-8");
-        return parsePullRequestContextFromEventJson(content);
+        return JSON.parse(content);
     }
     catch {
         return undefined;
@@ -75,7 +83,15 @@ export const resolveGithubPullRequestContext = () => {
             baseRef: nonBlank(getEnv("GITHUB_BASE_REF")),
         };
     }
-    return readPullRequestContextFromEventPath();
+    const event = readGithubEventFromPath();
+    return event ? pullRequestContextFromEvent(event) : undefined;
+};
+export const resolveGithubCommitSha = () => {
+    const event = readGithubEventFromPath();
+    return (nonBlank(event?.workflow_run?.head_sha) ||
+        (event ? pullRequestContextFromEvent(event)?.headSha : undefined) ||
+        getEnv("GITHUB_SHA") ||
+        undefined);
 };
 export const resolveGithubPullRequestNumber = () => {
     return resolveGithubPullRequestContext()?.number ?? "";

package/dist/helpers/reportCiContext.d.ts

@@ -0,0 +1,10 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+import type { PluginSummary } from "@allurereport/plugin-api";
+export type ContextLink = {
+    label: string;
+    href: string;
+};
+type ReportCiContext = Pick<PluginSummary, "commitSha" | "commitHref" | "ciRunName" | "ciRunHref">;
+export declare const createReportCiContext: (ci: CiDescriptor | undefined) => ReportCiContext;
+export declare const reportCiContextLinks: (report: ReportCiContext) => ContextLink[];
+export {};

package/dist/helpers/reportCiContext.js

@@ -0,0 +1,94 @@
+import { GitProvider } from "@allurereport/core-api";
+const browserUrl = (value) => {
+    if (!value) {
+        return undefined;
+    }
+    try {
+        const url = new URL(value);
+        if (url.protocol !== "https:" && url.protocol !== "http:") {
+            return undefined;
+        }
+        if (url.username || url.password) {
+            url.username = "";
+            url.password = "";
+            return url.toString();
+        }
+        return value;
+    }
+    catch {
+        return undefined;
+    }
+};
+const trimTrailingSlashes = (value) => {
+    if (!value) {
+        return undefined;
+    }
+    let end = value.length;
+    while (end > 0 && value[end - 1] === "/") {
+        end--;
+    }
+    return value.slice(0, end);
+};
+const commitUrl = (ci, sha) => {
+    const explicit = browserUrl(ci.commitUrl);
+    if (explicit) {
+        return explicit;
+    }
+    const repositoryUrl = trimTrailingSlashes(browserUrl(ci.repository?.url))?.replace(/\.git$/i, "");
+    const pullRequestUrl = trimTrailingSlashes(browserUrl(ci.pullRequest?.url));
+    switch (ci.provider) {
+        case GitProvider.Github:
+            if (!pullRequestUrl && !repositoryUrl)
+                return undefined;
+            if (pullRequestUrl) {
+                return `${pullRequestUrl}/commits/${encodeURIComponent(sha)}`;
+            }
+            else {
+                return `${repositoryUrl}/commit/${encodeURIComponent(sha)}`;
+            }
+        case GitProvider.Gitlab:
+            if (!pullRequestUrl && !repositoryUrl)
+                return undefined;
+            if (pullRequestUrl) {
+                return `${pullRequestUrl}/diffs?commit_id=${encodeURIComponent(sha)}`;
+            }
+            else {
+                return `${repositoryUrl}/-/commit/${encodeURIComponent(sha)}`;
+            }
+        case GitProvider.Bitbucket:
+            return repositoryUrl ? `${repositoryUrl}/commits/${encodeURIComponent(sha)}` : undefined;
+        default:
+            return undefined;
+    }
+};
+export const createReportCiContext = (ci) => {
+    if (!ci) {
+        return { commitSha: undefined, commitHref: undefined, ciRunName: undefined, ciRunHref: undefined };
+    }
+    const sha = ci.commitSha;
+    const pipelineHref = browserUrl(ci.pipelineRunUrl);
+    const runHref = pipelineHref || browserUrl(ci.jobRunUrl);
+    return {
+        commitSha: sha,
+        commitHref: sha ? commitUrl(ci, sha) : undefined,
+        ciRunHref: runHref,
+        ciRunName: runHref
+            ? pipelineHref
+                ? ci.pipelineRunName || "Pipeline"
+                : ci.jobRunName || ci.jobRunUid || ci.type
+            : undefined,
+    };
+};
+export const reportCiContextLinks = (report) => {
+    const links = [];
+    const sha = report.commitSha;
+    const shaUrl = browserUrl(report.commitHref);
+    const runUrl = browserUrl(report.ciRunHref);
+    if (sha && shaUrl) {
+        links.push({ label: sha.slice(0, 8), href: shaUrl });
+    }
+    if (runUrl) {
+        links.push({ label: report.ciRunName || "CI run", href: runUrl });
+    }
+    return links;
+};

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from "./reportContext.js";
 export * from "./reportMarkdown.js";
 export { applyAllureCiEnv } from "./ciEnv.js";
 export { detect } from "./detect.js";
+export { createReportCiContext } from "./helpers/reportCiContext.js";
 export { isLocalCiDescriptor } from "./detectors/local.js";
 export { restoreGitlabHistory, upsertGitlabJobNote } from "./helpers/gitlab/index.js";
 export type { GitlabCiDescriptor } from "./detectors/gitlab.js";

package/dist/index.js

@@ -2,5 +2,6 @@ export * from "./reportContext.js";
 export * from "./reportMarkdown.js";
 export { applyAllureCiEnv } from "./ciEnv.js";
 export { detect } from "./detect.js";
+export { createReportCiContext } from "./helpers/reportCiContext.js";
 export { isLocalCiDescriptor } from "./detectors/local.js";
 export { restoreGitlabHistory, upsertGitlabJobNote } from "./helpers/gitlab/index.js";

package/dist/reportMarkdown.js

@@ -1,3 +1,4 @@
+import { reportCiContextLinks } from "./helpers/reportCiContext.js";
 const STATUS_ORDER = ["passed", "failed", "broken", "skipped", "unknown"];
 const STATUS_LABELS = {
     passed: "Passed tests",
@@ -144,6 +145,7 @@ const toReportLink = (report) => {
             label: reportLabel(report),
             href,
             kind: reportLinkKind(report),
+            context: reportCiContextLinks(report),
         }
         : undefined;
 };
@@ -158,7 +160,21 @@ const renderReportLinks = (reports) => {
     const links = sortLinks(reports.map(toReportLink).filter((item) => item !== undefined));
     const reportLinks = links.filter(({ kind }) => kind === "report");
     const testOpsLinks = links.filter(({ kind }) => kind === "testops");
-    return [renderLinks("Reports", reportLinks), renderLinks("Allure TestOps", testOpsLinks)].filter((line) => line !== undefined);
+    const context = reportLinks[0]?.context ?? [];
+    const hasSharedContext = reportLinks.every(({ context: current }) => current.length === context.length &&
+        current.every((item, index) => item.label === context[index].label && item.href === context[index].href));
+    if (hasSharedContext) {
+        return [
+            renderLinks("Reports", reportLinks),
+            renderLinks("Context", context),
+            renderLinks("Allure TestOps", testOpsLinks),
+        ].filter((line) => line !== undefined);
+    }
+    const reportItems = reportLinks.map(({ label, href, context }) => {
+        const links = [{ label: "Report", href }, ...context];
+        return `* ${escapeHtml(label)} - ${links.map((item) => link(item.label, item.href)).join(", ")}`;
+    });
+    return [["**Reports:**", ...reportItems].join("\n"), renderLinks("Allure TestOps", testOpsLinks)].filter((line) => line !== undefined);
 };
 const pluginSummaryToStatusStats = (report) => ({
     failed: report.stats.failed ?? 0,
@@ -207,6 +223,12 @@ const renderArtifacts = (artifacts) => {
     });
     return [`<details>`, `<summary>Artifacts used (${artifacts.length})</summary>`, "", ...rows, "", "</details>"].join("\n");
 };
+const renderPublicationWarnings = (reports) => {
+    const missing = reports.filter((report) => report.published === false);
+    return missing.length
+        ? ["**⚠ Expected reports were not published**", ...missing.map(({ name }) => `- ${inlineCode(name)}`)].join("\n\n")
+        : undefined;
+};
 export const renderReportSummaryMarkdown = (context, options = {}) => {
     const { title = "Allure Report Summary", includeArtifacts = true } = options;
     const regularReports = context.reports.filter((report) => report.filtered !== true);
@@ -236,6 +258,7 @@ export const renderReportSummaryMarkdown = (context, options = {}) => {
     const sections = [
         `# ${escapeHtml(title)}`,
         renderTable(aggregateRows, includeResolutions, renderOptions),
+        renderPublicationWarnings(context.reports),
         ...renderReportLinks(regularReports),
         renderFilteredReports(filteredReports, renderOptions),
         includeArtifacts ? renderArtifacts(context.artifacts) : undefined,

package/dist/utils.js

@@ -5,7 +5,7 @@ export const parseURLPath = (urlString) => {
         const { pathname } = new URL(urlString);
         return pathname.replace(/^\/+/, "");
     }
-    catch (error) {
+    catch {
         return "";
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/ci",
-  "version": "3.21.0",
+  "version": "3.22.1",
   "description": "Utilities set to get useful report data from different CI",
   "keywords": [
     "allure",
@@ -27,27 +27,29 @@
   "scripts": {
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
-    "test": "rimraf ./out && vitest run",
+    "test": "rimraf out && vp test run",
     "test:unit": "yarn test",
-    "lint": "oxlint --import-plugin src test features stories",
-    "lint:fix": "oxlint --import-plugin --fix src test features stories"
+    "lint": "vp lint --import-plugin src test features stories",
+    "lint:fix": "vp lint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.21.0",
-    "@allurereport/plugin-api": "3.21.0",
+    "@allurereport/core-api": "3.22.1",
+    "@allurereport/plugin-api": "3.22.1",
     "axios": "^1.20.0",
     "glob": "^13.0.6"
   },
   "devDependencies": {
-    "@allurereport/test-config": "3.21.0",
+    "@allurereport/common-config": "3.22.1",
     "@types/node": "^20",
-    "@vitest/coverage-istanbul": "^4.1.0",
-    "@vitest/runner": "^2.1.8",
-    "@vitest/snapshot": "^5.0.1",
+    "@vitest/coverage-istanbul": "5.0.4",
+    "@vitest/runner": "^2",
+    "@vitest/snapshot": "5.0.4",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",
     "rimraf": "^6",
     "typescript": "^5",
-    "vitest": "^4.1.0"
+    "vite": "@voidzero-dev/vite-plus-core@1.2.0",
+    "vite-plus": "1.2.0",
+    "vitest": "5.0.4"
   }
 }

package/dist/detectors/index.d.ts

@@ -1,9 +0,0 @@
-export { amazon } from "./amazon.js";
-export { azure } from "./azure.js";
-export { bitbucket } from "./bitbucket.js";
-export { circle } from "./circle.js";
-export { drone } from "./drone.js";
-export { github } from "./github.js";
-export { gitlab } from "./gitlab.js";
-export { jenkins } from "./jenkins.js";
-export { local } from "./local.js";

package/dist/detectors/index.js

@@ -1,9 +0,0 @@
-export { amazon } from "./amazon.js";
-export { azure } from "./azure.js";
-export { bitbucket } from "./bitbucket.js";
-export { circle } from "./circle.js";
-export { drone } from "./drone.js";
-export { github } from "./github.js";
-export { gitlab } from "./gitlab.js";
-export { jenkins } from "./jenkins.js";
-export { local } from "./local.js";