@allurereport/ci 3.0.0-beta.17

package/README.md

@@ -0,0 +1,13 @@
+# Allure CI Detector
+
+[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
+
+- Learn more about Allure Report at https://allurereport.org
+- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
+- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
+- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – be in touch with the latest updates
+- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
+
+---
+
+TODO:

package/dist/detect.d.ts

@@ -0,0 +1,2 @@
+import type { CiDescriptor } from "@allurereport/core-api";
+export declare const detect: () => CiDescriptor | undefined;

package/dist/detect.js

@@ -0,0 +1,11 @@
+import { amazon } from "./detectors/amazon.js";
+import { azure } from "./detectors/azure.js";
+import { bitbucket } from "./detectors/bitbucket.js";
+import { circle } from "./detectors/circle.js";
+import { drone } from "./detectors/drone.js";
+import { github } from "./detectors/github.js";
+import { gitlab } from "./detectors/gitlab.js";
+import { jenkins } from "./detectors/jenkins.js";
+export const detect = () => {
+    return [amazon, azure, bitbucket, circle, drone, github, gitlab, jenkins].find((descriptor) => descriptor.detected);
+};

package/dist/detectors/amazon.d.ts

@@ -0,0 +1,10 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const parseArnValues: (source: string) => string[];
+export declare const isBatchBuild: () => boolean;
+export declare const getRegionID: (source: string) => string;
+export declare const getAccountID: (source: string) => string;
+export declare const getProjectName: (source: string) => string;
+export declare const getBuildGUID: (source: string) => string;
+export declare const getInitiator: () => string;
+export declare const getPipelineName: () => string;
+export declare const amazon: CiDescriptor;

package/dist/detectors/amazon.js

@@ -0,0 +1,123 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv } from "../utils.js";
+const AMAZON_REGEXP = /^arn:aws:codebuild:([^:]+):([\d]+):(?:build|build-batch)\/([^:]+):([\da-f-]+)$/;
+const PIPELINE_REGEXP = /^(?:codepipeline\/)(.+)$/;
+export const parseArnValues = (source) => {
+    if (!source) {
+        return [];
+    }
+    return source.match(AMAZON_REGEXP)?.slice(1) ?? [];
+};
+export const isBatchBuild = () => getEnv("CODEBUILD_BUILD_BATCH_TRIGGERED") === "true";
+export const getRegionID = (source) => parseArnValues(source)?.[0] ?? "";
+export const getAccountID = (source) => parseArnValues(source)?.[1] ?? "";
+export const getProjectName = (source) => parseArnValues(source)?.[2] ?? "";
+export const getBuildGUID = (source) => parseArnValues(source)?.[3] ?? "";
+export const getInitiator = () => getEnv("CODEBUILD_INITIATOR");
+export const getPipelineName = () => {
+    const initiator = getInitiator();
+    if (!initiator) {
+        return "";
+    }
+    return initiator.match(PIPELINE_REGEXP)?.[1] ?? "";
+};
+export const amazon = {
+    type: CiType.Amazon,
+    get detected() {
+        const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+        return buildArn !== "" && parseArnValues(buildArn).length > 0;
+    },
+    get jobUid() {
+        const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+        const pipelineName = getPipelineName();
+        if (pipelineName) {
+            return `pipeline/${pipelineName}`;
+        }
+        else if (isBatchBuild()) {
+            const projectName = getProjectName(buildArn);
+            return `buildbatch/${projectName}`;
+        }
+        else {
+            const projectName = getProjectName(buildArn);
+            return `build/${projectName}`;
+        }
+    },
+    get jobUrl() {
+        const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+        const pipelineName = getPipelineName();
+        if (pipelineName) {
+            const regionId = getRegionID(buildArn);
+            return `https://console.aws.amazon.com/codesuite/codepipeline/pipelines/${pipelineName}/view?region=${regionId}`;
+        }
+        else {
+            const regionId = getRegionID(buildArn);
+            const projectName = getProjectName(buildArn);
+            return `https://console.aws.amazon.com/codebuild/home?region=${regionId}#/projects/${projectName}/view/new`;
+        }
+    },
+    get jobName() {
+        const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+        const pipelineName = getPipelineName();
+        if (pipelineName) {
+            return pipelineName;
+        }
+        else {
+            return getProjectName(buildArn);
+        }
+    },
+    get jobRunUid() {
+        const pipelineName = getPipelineName();
+        if (pipelineName) {
+            return getEnv("CODEBUILD_BUILD_ID");
+        }
+        else {
+            return getBuildGUID(getEnv("CODEBUILD_BUILD_ARN"));
+        }
+    },
+    get jobRunUrl() {
+        const pipelineName = getPipelineName();
+        if (pipelineName) {
+            const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+            const executionGuid = getEnv("CODEBUILD_BUILD_ID") || "";
+            const regionId = getRegionID(buildArn);
+            return `https://console.aws.amazon.com/codesuite/codepipeline/pipelines/${pipelineName}/executions/${executionGuid}/timeline?region=${regionId}`;
+        }
+        else if (isBatchBuild()) {
+            const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+            const accountId = getAccountID(buildArn);
+            const projectName = getProjectName(buildArn);
+            const buildGuid = getBuildGUID(buildArn);
+            return `https://console.aws.amazon.com/codesuite/codebuild/${accountId}/projects/${projectName}/batch/${projectName}:${buildGuid}`;
+        }
+        else {
+            const buildArn = getEnv("CODEBUILD_BUILD_ARN");
+            const regionId = getRegionID(buildArn);
+            const projectName = getProjectName(buildArn);
+            const buildGuid = getBuildGUID(buildArn);
+            return `https://console.aws.amazon.com/codebuild/home?region=${regionId}#/builds/${projectName}:${buildGuid}/view/new`;
+        }
+    },
+    get jobRunName() {
+        const pipelineName = getPipelineName();
+        if (pipelineName) {
+            const executionGuid = getEnv("CODEBUILD_BUILD_ID");
+            return `${pipelineName}-${executionGuid}`;
+        }
+        else {
+            const projectName = getProjectName(getEnv("CODEBUILD_BUILD_ARN"));
+            const buildNumber = getEnv("CODEBUILD_BUILD_NUMBER");
+            return `${projectName}-${buildNumber}`;
+        }
+    },
+    get jobRunBranch() {
+        const sourceVersion = getEnv("CODEBUILD_SOURCE_VERSION");
+        const { branch } = sourceVersion?.match?.(/refs\/heads\/(?<branch>\S+)\^\{(?<commithash>\S+)\}/)?.groups ?? {};
+        return branch ?? "";
+    },
+    get pullRequestUrl() {
+        return "";
+    },
+    get pullRequestName() {
+        return "";
+    },
+};

package/dist/detectors/azure.d.ts

@@ -0,0 +1,6 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const getRootURL: () => string;
+export declare const getBuildID: () => string;
+export declare const getDefinitionID: () => string;
+export declare const getProjectID: () => string;
+export declare const azure: CiDescriptor;

package/dist/detectors/azure.js

@@ -0,0 +1,48 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv } from "../utils.js";
+export const getRootURL = () => getEnv("SYSTEM_COLLECTIONURI");
+export const getBuildID = () => getEnv("BUILD_BUILDID");
+export const getDefinitionID = () => getEnv("SYSTEM_DEFINITIONID");
+export const getProjectID = () => getEnv("SYSTEM_TEAMPROJECTID");
+export const azure = {
+    type: CiType.Azure,
+    get detected() {
+        return getEnv("SYSTEM_DEFINITIONID") !== "";
+    },
+    get jobUid() {
+        return `${getProjectID()}_${getDefinitionID()}`;
+    },
+    get jobUrl() {
+        return `${getRootURL()}/${getProjectID()}/_build?definitionId=${getDefinitionID()}`;
+    },
+    get jobName() {
+        return getEnv("BUILD_DEFINITIONNAME");
+    },
+    get jobRunUid() {
+        return getBuildID();
+    },
+    get jobRunUrl() {
+        return `${getRootURL()}/${getProjectID()}/_build/results?buildId=${getBuildID()}`;
+    },
+    get jobRunName() {
+        return getEnv("BUILD_BUILDNUMBER");
+    },
+    get jobRunBranch() {
+        return getEnv("BUILD_SOURCEBRANCHNAME");
+    },
+    get pullRequestUrl() {
+        const repositoryProvider = getEnv("BUILD_REPOSITORY_PROVIDER");
+        const repositoryUrl = getEnv("SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI");
+        const pullRequestNumber = getEnv("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER");
+        if (repositoryProvider === "GitHub") {
+            return `${repositoryUrl}/pull/${pullRequestNumber}`;
+        }
+        if (repositoryProvider === "TfsGit" || repositoryProvider === "TfsVersionControl") {
+            return `${repositoryUrl}/pullrequest/${pullRequestNumber}`;
+        }
+        return "";
+    },
+    get pullRequestName() {
+        return "";
+    },
+};

package/dist/detectors/bitbucket.d.ts

@@ -0,0 +1,3 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const getJobURL: () => string;
+export declare const bitbucket: CiDescriptor;

package/dist/detectors/bitbucket.js

@@ -0,0 +1,44 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv } from "../utils.js";
+export const getJobURL = () => {
+    const origin = getEnv("BITBUCKET_GIT_HTTP_ORIGIN");
+    return `${origin}/pipelines`;
+};
+export const bitbucket = {
+    type: CiType.Bitbucket,
+    get detected() {
+        return getEnv("BITBUCKET_PIPELINE_UUID") !== "";
+    },
+    get jobUid() {
+        return getEnv("BITBUCKET_REPO_FULL_NAME");
+    },
+    get jobUrl() {
+        return getJobURL();
+    },
+    get jobName() {
+        return getEnv("BITBUCKET_REPO_FULL_NAME");
+    },
+    get jobRunUid() {
+        return getEnv("BITBUCKET_PIPELINE_UUID");
+    },
+    get jobRunUrl() {
+        return `${getJobURL()}/results/${this.jobRunUid}`;
+    },
+    get jobRunName() {
+        return getEnv("BITBUCKET_PIPELINE_UUID");
+    },
+    get jobRunBranch() {
+        return getEnv("BITBUCKET_BRANCH");
+    },
+    get pullRequestUrl() {
+        const prId = getEnv("BITBUCKET_PR_ID");
+        if (!prId) {
+            return "";
+        }
+        const origin = getEnv("BITBUCKET_GIT_HTTP_ORIGIN");
+        return `${origin}/pull-requests/${prId}`;
+    },
+    get pullRequestName() {
+        return "";
+    },
+};

package/dist/detectors/circle.d.ts

@@ -0,0 +1,4 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const getBuildNumber: () => string;
+export declare const getJobRunURL: () => string;
+export declare const circle: CiDescriptor;

package/dist/detectors/circle.js

@@ -0,0 +1,48 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv, parseURLPath } from "../utils.js";
+export const getBuildNumber = () => getEnv("CIRCLE_BUILD_NUM");
+export const getJobRunURL = () => getEnv("CIRCLE_BUILD_URL");
+const getJobURL = () => {
+    const jobRunURL = getJobRunURL();
+    const buildNumber = getBuildNumber();
+    return jobRunURL.replace(`/${buildNumber}`, "");
+};
+export const circle = {
+    type: CiType.Circle,
+    get detected() {
+        const hasEnv = getEnv("CIRCLECI") !== "";
+        const jobURL = getJobURL();
+        const path = parseURLPath(jobURL);
+        return hasEnv && path !== "";
+    },
+    get jobUid() {
+        const jobURL = getJobURL();
+        return parseURLPath(jobURL);
+    },
+    get jobUrl() {
+        return getJobURL();
+    },
+    get jobName() {
+        const username = getEnv("CIRCLE_USERNAME");
+        const reponame = getEnv("CIRCLE_PROJECT_REPONAME");
+        return `${username}/${reponame}`;
+    },
+    get jobRunUid() {
+        return getEnv("CIRCLE_WORKFLOW_JOB_ID");
+    },
+    get jobRunUrl() {
+        return getJobRunURL();
+    },
+    get jobRunName() {
+        return getEnv("CIRCLE_BUILD_NUM");
+    },
+    get jobRunBranch() {
+        return getEnv("CIRCLE_BRANCH");
+    },
+    get pullRequestUrl() {
+        return "";
+    },
+    get pullRequestName() {
+        return "";
+    },
+};

package/dist/detectors/drone.d.ts

@@ -0,0 +1,5 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const getJobRunUID: () => string;
+export declare const getJobRunURL: () => string;
+export declare const getJobURL: () => string;
+export declare const drone: CiDescriptor;

package/dist/detectors/drone.js

@@ -0,0 +1,52 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv } from "../utils.js";
+export const getJobRunUID = () => getEnv("CI_BUILD_NUMBER");
+export const getJobRunURL = () => getEnv("DRONE_BUILD_LINK");
+export const getJobURL = () => {
+    const jobRunURL = getJobRunURL();
+    const jobRunUID = getJobRunUID();
+    return jobRunURL.replace(jobRunUID, "");
+};
+export const drone = {
+    type: CiType.Drone,
+    get detected() {
+        return getEnv("DRONE_SYSTEM_HOST") !== "";
+    },
+    get jobUid() {
+        return getEnv("DRONE_REPO");
+    },
+    get jobUrl() {
+        return getJobURL();
+    },
+    get jobName() {
+        return getEnv("DRONE_REPO");
+    },
+    get jobRunUid() {
+        return getJobRunUID();
+    },
+    get jobRunUrl() {
+        return getJobRunURL();
+    },
+    get jobRunName() {
+        return getEnv("DRONE_BUILD_NUMBER");
+    },
+    get jobRunBranch() {
+        return getEnv("DRONE_BRANCH");
+    },
+    get pullRequestUrl() {
+        const githubServer = getEnv("DRONE_GITHUB_SERVER");
+        const gitlabServer = getEnv("DRONE_GITLAB_SERVER");
+        const repoLink = getEnv("DRONE_REPO_LINK");
+        const pullRequestNumber = getEnv("DRONE_PULL_REQUEST");
+        if (repoLink.startsWith(githubServer)) {
+            return `${repoLink}/pull/${pullRequestNumber}`;
+        }
+        if (repoLink.startsWith(gitlabServer)) {
+            return `${repoLink}/-/merge_requests/${pullRequestNumber}`;
+        }
+        return "";
+    },
+    get pullRequestName() {
+        return getEnv("DRONE_PULL_REQUEST_TITLE");
+    },
+};

package/dist/detectors/github.d.ts

@@ -0,0 +1,2 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const github: CiDescriptor;

package/dist/detectors/github.js

@@ -0,0 +1,57 @@
+import { CiType } from "@allurereport/core-api";
+import { join } from "node:path/posix";
+import { getEnv } from "../utils.js";
+const pullRequestSuffixRe = /\/merge$/;
+const getBaseURL = () => getEnv("GITHUB_SERVER_URL");
+const getRunID = () => getEnv("GITHUB_RUN_ID");
+const getWorkflow = () => getEnv("GITHUB_WORKFLOW");
+const getRepo = () => getEnv("GITHUB_REPOSITORY");
+export const github = {
+    type: CiType.Github,
+    get detected() {
+        return getEnv("GITHUB_ACTIONS") !== "";
+    },
+    get jobUid() {
+        return `${getRepo()}_${getWorkflow()}`;
+    },
+    get jobUrl() {
+        const workflow = encodeURIComponent(`workflow:"${getWorkflow()}"`);
+        return `${getBaseURL()}/${getRepo()}/actions?query=${workflow}`;
+    },
+    get jobName() {
+        return `${getRepo()} - ${getWorkflow()}`;
+    },
+    get jobRunUid() {
+        return getRunID();
+    },
+    get jobRunUrl() {
+        return `${getBaseURL()}/${getRepo()}/actions/runs/${getRunID()}`;
+    },
+    get jobRunName() {
+        const runNumber = getEnv("GITHUB_RUN_NUMBER");
+        const job = getEnv("GITHUB_JOB");
+        return `${job} #${runNumber}`;
+    },
+    get jobRunBranch() {
+        return getEnv("GITHUB_REF");
+    },
+    get pullRequestUrl() {
+        const refName = getEnv("GITHUB_REF_NAME");
+        if (!pullRequestSuffixRe.test(refName)) {
+            return "";
+        }
+        const pullRequestNumber = refName.replace(pullRequestSuffixRe, "");
+        const serverUrl = getEnv("GITHUB_SERVER_URL");
+        const repo = getRepo();
+        const pathname = join(repo, "pull", pullRequestNumber);
+        return new URL(pathname, serverUrl).toString();
+    },
+    get pullRequestName() {
+        const refName = getEnv("GITHUB_REF_NAME");
+        if (!pullRequestSuffixRe.test(refName)) {
+            return "";
+        }
+        const pullRequestNumber = refName.replace(pullRequestSuffixRe, "");
+        return `Pull request #${pullRequestNumber}`;
+    },
+};

package/dist/detectors/gitlab.d.ts

@@ -0,0 +1,2 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const gitlab: CiDescriptor;

package/dist/detectors/gitlab.js

@@ -0,0 +1,40 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv } from "../utils.js";
+export const gitlab = {
+    type: CiType.Gitlab,
+    get detected() {
+        return getEnv("GITLAB_CI") !== "";
+    },
+    get jobUid() {
+        return getEnv("CI_PROJECT_ID");
+    },
+    get jobUrl() {
+        return `${getEnv("CI_PROJECT_URL")}/pipelines`;
+    },
+    get jobName() {
+        return getEnv("CI_PROJECT_NAME");
+    },
+    get jobRunUid() {
+        return getEnv("CI_PIPELINE_ID");
+    },
+    get jobRunUrl() {
+        return getEnv("CI_PIPELINE_URL");
+    },
+    get jobRunName() {
+        return getEnv("CI_PIPELINE_ID");
+    },
+    get jobRunBranch() {
+        return getEnv("CI_COMMIT_REF_NAME");
+    },
+    get pullRequestUrl() {
+        const mergeRequestIID = getEnv("CI_MERGE_REQUEST_IID");
+        if (!mergeRequestIID) {
+            return "";
+        }
+        const projectUrl = getEnv("CI_PROJECT_URL");
+        return `${projectUrl}/-/merge_requests/${mergeRequestIID}`;
+    },
+    get pullRequestName() {
+        return getEnv("CI_MERGE_REQUEST_TITLE");
+    },
+};

package/dist/detectors/jenkins.d.ts

@@ -0,0 +1,2 @@
+import { type CiDescriptor } from "@allurereport/core-api";
+export declare const jenkins: CiDescriptor;

package/dist/detectors/jenkins.js

@@ -0,0 +1,35 @@
+import { CiType } from "@allurereport/core-api";
+import { getEnv } from "../utils.js";
+export const jenkins = {
+    type: CiType.Jenkins,
+    get detected() {
+        return getEnv("JENKINS_URL") !== "";
+    },
+    get jobUid() {
+        return getEnv("JOB_NAME");
+    },
+    get jobUrl() {
+        return getEnv("JOB_URL");
+    },
+    get jobName() {
+        return getEnv("JOB_BASE_NAME");
+    },
+    get jobRunUid() {
+        return getEnv("BUILD_NUMBER");
+    },
+    get jobRunUrl() {
+        return getEnv("BUILD_URL");
+    },
+    get jobRunName() {
+        return getEnv("BUILD_DISPLAY_NAME");
+    },
+    get jobRunBranch() {
+        return getEnv("BRANCH_NAME");
+    },
+    get pullRequestUrl() {
+        return getEnv("CHANGE_URL");
+    },
+    get pullRequestName() {
+        return getEnv("CHANGE_TITLE");
+    },
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { detect } from "./detect.js";

package/dist/index.js

@@ -0,0 +1 @@
+export { detect } from "./detect.js";

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const getEnv: (key: string) => string;
+export declare const parseURLPath: (urlString: string) => string;

package/dist/utils.js

@@ -0,0 +1,11 @@
+import { env } from "node:process";
+export const getEnv = (key) => env?.[key] ?? "";
+export const parseURLPath = (urlString) => {
+    try {
+        const { pathname } = new URL(urlString);
+        return pathname.replace(/^\/+/, "");
+    }
+    catch (error) {
+        return "";
+    }
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@allurereport/ci",
+  "version": "3.0.0-beta.17",
+  "description": "Utilities set to get useful report data from different CI",
+  "keywords": [
+    "allure",
+    "testing",
+    "report",
+    "plugin",
+    "html"
+  ],
+  "repository": "https://github.com/allure-framework/allure3",
+  "license": "Apache-2.0",
+  "author": "Qameta Software",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
+  "scripts": {
+    "build": "run clean && tsc --project ./tsconfig.json",
+    "clean": "rimraf ./dist",
+    "eslint": "eslint ./src/**/*.{js,jsx,ts,tsx}",
+    "eslint:format": "eslint --fix ./src/**/*.{js,jsx,ts,tsx}",
+    "test": "rimraf ./out && vitest run"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "3.0.0-beta.17"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2.6.1",
+    "@types/eslint": "^8.56.11",
+    "@types/node": "^20.17.9",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/runner": "^2.1.8",
+    "@vitest/snapshot": "^2.1.8",
+    "allure-vitest": "^3.0.9",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^50.0.0",
+    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.8"
+  }
+}