feat(plugin-testops): attach git information on launch create

Author: vdvukhzhilov

.gitignore

@@ -60,3 +60,5 @@ allure-results.zip
 docs/kb/.obsidian/
 
 .tmp
+/.tmp
+/.agent-workspace

.pnp.cjs

@@ -8,6 +8,4 @@
 - 📢 [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:
+---

packages/ci/README.md

@@ -14,7 +14,7 @@ import { local } from "./detectors/local.js";
  * Tries to detect current CI
  * Returns CI descriptor if some detected, otherwise undefined
  */
-export const detect = (): CiDescriptor | undefined => {
+export const detect = (): CiDescriptor => {
   return (
     [amazon, azure, bitbucket, circle, drone, github, gitlab, jenkins].find((descriptor) => descriptor.detected) ??
     local

packages/ci/src/detect.ts

@@ -2,10 +2,9 @@ import { join } from "node:path/posix";
 
 import { type CiDescriptor, CiType } from "@allurereport/core-api";
 
+import { resolveGithubPullRequestNumber } from "../helpers/github.js";
 import { getEnv } from "../utils.js";
 
-const pullRequestSuffixRe = /\/merge$/;
-
 const getBaseURL = () => getEnv("GITHUB_SERVER_URL");
 
 const getRunID = () => getEnv("GITHUB_RUN_ID");
@@ -62,13 +61,12 @@ export const github: CiDescriptor = {
   },
 
   get pullRequestUrl(): string {
-    const refName = getEnv("GITHUB_REF_NAME");
+    const pullRequestNumber = resolveGithubPullRequestNumber();
 
-    if (!pullRequestSuffixRe.test(refName)) {
+    if (!pullRequestNumber) {
       return "";
     }
 
-    const pullRequestNumber = refName.replace(pullRequestSuffixRe, "");
     const serverUrl = getEnv("GITHUB_SERVER_URL");
     const repo = getRepo();
     const pathname = join(repo, "pull", pullRequestNumber);
@@ -77,14 +75,12 @@ export const github: CiDescriptor = {
   },
 
   get pullRequestName(): string {
-    const refName = getEnv("GITHUB_REF_NAME");
+    const pullRequestNumber = resolveGithubPullRequestNumber();
 
-    if (!pullRequestSuffixRe.test(refName)) {
+    if (!pullRequestNumber) {
       return "";
     }
 
-    const pullRequestNumber = refName.replace(pullRequestSuffixRe, "");
-
     return `Pull request #${pullRequestNumber}`;
   },
 };

packages/ci/src/detectors/github.ts

@@ -62,3 +62,6 @@ export const local: CiDescriptor = {
     return "";
   },
 };
+
+export const isLocalCiDescriptor = (ci: CiDescriptor): ci is Omit<CiDescriptor, "type"> & { type: CiType.Local } =>
+  ci.type === CiType.Local;

packages/ci/src/detectors/local.ts

@@ -0,0 +1,72 @@
+import { type CiDescriptor, type CiGitHints } from "@allurereport/core-api";
+
+import { resolveRepositoryFromGitUrl, stripRefsHeads } from "../helpers/gitProvider.js";
+import { getEnv } from "../utils.js";
+
+const parseBranchFromSourceVersion = (sourceVersion: string): string | undefined => {
+  const branchMatch = sourceVersion.match(/refs\/heads\/(?<branch>[^/^]+)/)?.groups?.branch;
+
+  if (branchMatch) {
+    return branchMatch;
+  }
+
+  const branchTrigger = getEnv("CODEBUILD_WEBHOOK_TRIGGER");
+
+  if (branchTrigger.startsWith("branch/")) {
+    return branchTrigger.slice("branch/".length);
+  }
+
+  return undefined;
+};
+
+const parsePullRequestFromSourceVersion = (sourceVersion: string): string | undefined => {
+  const prPrefixMatch = sourceVersion.match(/^pr\/(?<id>\d+)$/i)?.groups?.id;
+
+  if (prPrefixMatch) {
+    return prPrefixMatch;
+  }
+
+  return sourceVersion.match(/refs\/pull\/(?<id>\d+)\//)?.groups?.id;
+};
+
+const parsePullRequestFromWebhookTrigger = (): string | undefined => {
+  const trigger = getEnv("CODEBUILD_WEBHOOK_TRIGGER");
+
+  return trigger.match(/^pr\/(?<id>\d+)$/i)?.groups?.id;
+};
+
+export const resolveAmazonGitHints = (ci: CiDescriptor): CiGitHints => {
+  const repoUrl = getEnv("CODEBUILD_SOURCE_REPO_URL");
+  const repository = repoUrl ? resolveRepositoryFromGitUrl(repoUrl) : undefined;
+
+  if (!repository) {
+    return {};
+  }
+
+  const sourceVersion = getEnv("CODEBUILD_SOURCE_VERSION");
+  const pullRequestId = parsePullRequestFromWebhookTrigger() || parsePullRequestFromSourceVersion(sourceVersion);
+  const pullRequest = pullRequestId
+    ? {
+        id: pullRequestId,
+        url: ci.pullRequestUrl || undefined,
+        title: ci.pullRequestName || undefined,
+      }
+    : undefined;
+
+  const headRef = getEnv("CODEBUILD_WEBHOOK_HEAD_REF");
+
+  return {
+    provider: repository.provider,
+    repository: {
+      slug: repository.slug,
+      url: repository.url,
+    },
+    sourceBranch:
+      (headRef ? stripRefsHeads(headRef) : undefined) ||
+      parseBranchFromSourceVersion(sourceVersion) ||
+      ci.jobRunBranch ||
+      undefined,
+    targetBranch: stripRefsHeads(getEnv("CODEBUILD_WEBHOOK_BASE_REF")) || undefined,
+    pullRequest,
+  };
+};

packages/ci/src/gitHints/amazon.ts

@@ -0,0 +1,71 @@
+import { type CiDescriptor, type CiGitHints, GitProvider } from "@allurereport/core-api";
+
+import { resolveRepositoryFromGitUrl, stripRefsHeads } from "../helpers/gitProvider.js";
+import { getEnv } from "../utils.js";
+
+const mapAzureRepositoryProvider = (provider: string): GitProvider | undefined => {
+  switch (provider) {
+    case "GitHub":
+      return GitProvider.Github;
+    case "Bitbucket":
+      return GitProvider.Bitbucket;
+    default:
+      return undefined;
+  }
+};
+
+const normalizeBranchRef = (branch: string): string | undefined => {
+  const trimmed = branch.trim();
+
+  return trimmed ? stripRefsHeads(trimmed) : undefined;
+};
+
+export const resolveAzureGitHints = (ci: CiDescriptor): CiGitHints => {
+  const repositoryUrl = getEnv("BUILD_REPOSITORY_URI") || getEnv("SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI") || undefined;
+  const fromUrl = repositoryUrl ? resolveRepositoryFromGitUrl(repositoryUrl) : undefined;
+  const fromProvider = mapAzureRepositoryProvider(getEnv("BUILD_REPOSITORY_PROVIDER"));
+
+  const provider = fromUrl?.provider ?? fromProvider;
+
+  if (!provider) {
+    return {};
+  }
+
+  const slug = fromUrl?.slug ?? (getEnv("BUILD_REPOSITORY_NAME") || undefined);
+  const url = fromUrl?.url ?? repositoryUrl;
+
+  if (!slug) {
+    return {};
+  }
+
+  const pullRequestNumber =
+    getEnv("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER") || getEnv("SYSTEM_PULLREQUEST_PULLREQUESTID");
+  const pullRequest = pullRequestNumber
+    ? {
+        id: pullRequestNumber,
+        url: ci.pullRequestUrl || undefined,
+        title: ci.pullRequestName || undefined,
+      }
+    : undefined;
+
+  const sourceBranch =
+    normalizeBranchRef(getEnv("SYSTEM_PULLREQUEST_SOURCEBRANCH")) ||
+    getEnv("BUILD_SOURCEBRANCHNAME") ||
+    ci.jobRunBranch ||
+    undefined;
+  const targetBranch =
+    normalizeBranchRef(getEnv("SYSTEM_PULLREQUEST_TARGETBRANCH")) ||
+    getEnv("SYSTEM_PULLREQUEST_TARGETBRANCHNAME") ||
+    undefined;
+
+  return {
+    provider,
+    repository: {
+      slug,
+      url,
+    },
+    sourceBranch,
+    targetBranch,
+    pullRequest,
+  };
+};

packages/ci/src/gitHints/azure.ts

@@ -0,0 +1,34 @@
+import { type CiDescriptor, type CiGitHints, GitProvider } from "@allurereport/core-api";
+
+import { getEnv } from "../utils.js";
+
+export const resolveBitbucketGitHints = (ci: CiDescriptor): CiGitHints => {
+  const repositorySlug = getEnv("BITBUCKET_REPO_FULL_NAME");
+  const origin = getEnv("BITBUCKET_GIT_HTTP_ORIGIN");
+  const repository = repositorySlug
+    ? {
+        slug: repositorySlug,
+        url: origin || undefined,
+      }
+    : undefined;
+
+  const sourceBranch = getEnv("BITBUCKET_BRANCH") || ci.jobRunBranch || undefined;
+  const targetBranch = getEnv("BITBUCKET_PR_DESTINATION_BRANCH") || undefined;
+
+  const prId = getEnv("BITBUCKET_PR_ID");
+  const pullRequest = prId
+    ? {
+        id: prId,
+        url: ci.pullRequestUrl || undefined,
+        title: ci.pullRequestName || undefined,
+      }
+    : undefined;
+
+  return {
+    provider: GitProvider.Bitbucket,
+    repository,
+    sourceBranch,
+    targetBranch,
+    pullRequest,
+  };
+};

packages/ci/src/gitHints/bitbucket.ts

@@ -0,0 +1,41 @@
+import { type CiDescriptor, type CiGitHints } from "@allurereport/core-api";
+
+import { parsePullRequestNumberFromUrl, resolveRepositoryFromGitUrl } from "../helpers/gitProvider.js";
+import { getEnv } from "../utils.js";
+
+export const resolveCircleGitHints = (ci: CiDescriptor): CiGitHints => {
+  const repositoryUrl = getEnv("CIRCLE_REPOSITORY_URL");
+  const repository = repositoryUrl ? resolveRepositoryFromGitUrl(repositoryUrl) : undefined;
+
+  if (!repository) {
+    return {};
+  }
+
+  const pullRequestUrl = getEnv("CIRCLE_PULL_REQUEST");
+  const pullRequestNumber = pullRequestUrl ? parsePullRequestNumberFromUrl(pullRequestUrl) : undefined;
+
+  if (!pullRequestNumber) {
+    return {
+      provider: repository.provider,
+      repository: {
+        slug: repository.slug,
+        url: repository.url,
+      },
+      sourceBranch: getEnv("CIRCLE_BRANCH") || ci.jobRunBranch || undefined,
+    };
+  }
+
+  return {
+    provider: repository.provider,
+    repository: {
+      slug: repository.slug,
+      url: repository.url,
+    },
+    sourceBranch: getEnv("CIRCLE_BRANCH") || ci.jobRunBranch || undefined,
+    pullRequest: {
+      id: pullRequestNumber,
+      url: ci.pullRequestUrl || pullRequestUrl || undefined,
+      title: ci.pullRequestName || undefined,
+    },
+  };
+};