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

Author: vdvukhzhilov

.pnp.cjs

@@ -1,9 +1,14 @@
 import { type CiDescriptor, CiType } from "@allurereport/core-api";
 
+import { resolveRepositoryFromGitUrl, stripRefsHeads } from "../helpers/gitProvider.js";
 import { getEnv, getReponameFromRepoUrl } from "../utils.js";
 
 const AMAZON_REGEXP = /^arn:aws:codebuild:([^:]+):([\d]+):(?:build|build-batch)\/([^:]+):([\da-f-]+)$/;
 const PIPELINE_REGEXP = /^(?:codepipeline\/)(.+)$/;
+const REF_PREFIX = "refs/";
+const BRANCH_REF_PREFIX = "refs/heads/";
+const TAG_REF_PREFIX = "refs/tags/";
+const GIT_SHA_REGEXP = /^[\da-f]{40}$/i;
 
 export const parseArnValues = (source: string): string[] => {
   if (!source) {
@@ -35,6 +40,103 @@ export const getPipelineName = (): string => {
   return initiator.match(PIPELINE_REGEXP)?.[1] ?? "";
 };
 
+const stripCommitSuffix = (sourceVersion: string): string => sourceVersion.replace(/\^\{[^}]+\}$/, "");
+
+const parseBranchFromWebhookTrigger = (): string | undefined => {
+  const branchTrigger = getEnv("CODEBUILD_WEBHOOK_TRIGGER") || "";
+
+  if (branchTrigger.startsWith("branch/")) {
+    const branch = branchTrigger.slice("branch/".length);
+
+    return branch || undefined;
+  }
+
+  return undefined;
+};
+
+const isTagWebhookTrigger = (): boolean => (getEnv("CODEBUILD_WEBHOOK_TRIGGER") || "").startsWith("tag/");
+
+const parseBranchFromSourceVersion = (sourceVersion?: string): string | undefined => {
+  const normalizedSourceVersion = stripCommitSuffix((sourceVersion ?? "").trim());
+
+  if (!normalizedSourceVersion) {
+    return undefined;
+  }
+
+  if (normalizedSourceVersion.startsWith(BRANCH_REF_PREFIX)) {
+    const branch = normalizedSourceVersion.slice(BRANCH_REF_PREFIX.length);
+
+    return branch || undefined;
+  }
+
+  if (
+    normalizedSourceVersion.startsWith(TAG_REF_PREFIX) ||
+    normalizedSourceVersion.match(/^pr\/\d+$/i) ||
+    normalizedSourceVersion.match(/^refs\/pull\/\d+\//i)
+  ) {
+    return undefined;
+  }
+
+  if (normalizedSourceVersion.startsWith(REF_PREFIX)) {
+    return undefined;
+  }
+
+  const triggerBranch = parseBranchFromWebhookTrigger();
+
+  if (triggerBranch) {
+    return triggerBranch;
+  }
+
+  if (isTagWebhookTrigger() || GIT_SHA_REGEXP.test(normalizedSourceVersion)) {
+    return undefined;
+  }
+
+  return normalizedSourceVersion;
+};
+
+const parseBranchFromWebhookHeadRef = (headRef?: string): string | undefined => {
+  const normalizedHeadRef = (headRef ?? "").trim();
+
+  if (!normalizedHeadRef || normalizedHeadRef.startsWith(TAG_REF_PREFIX) || isTagWebhookTrigger()) {
+    return undefined;
+  }
+
+  if (normalizedHeadRef.startsWith(BRANCH_REF_PREFIX)) {
+    const branch = normalizedHeadRef.slice(BRANCH_REF_PREFIX.length);
+
+    return branch || undefined;
+  }
+
+  if (normalizedHeadRef.startsWith(REF_PREFIX)) {
+    return undefined;
+  }
+
+  return normalizedHeadRef;
+};
+
+const parsePullRequestFromSourceVersion = (sourceVersion?: string): string | undefined => {
+  const normalizedSourceVersion = sourceVersion ?? "";
+  const prPrefixMatch = normalizedSourceVersion.match(/^pr\/(?<id>\d+)$/i)?.groups?.id;
+
+  if (prPrefixMatch) {
+    return prPrefixMatch;
+  }
+
+  return normalizedSourceVersion.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;
+};
+
+const getRepository = () => {
+  const repoUrl = getEnv("CODEBUILD_SOURCE_REPO_URL");
+
+  return repoUrl ? resolveRepositoryFromGitUrl(repoUrl) : undefined;
+};
+
 export const amazon: CiDescriptor = {
   type: CiType.Amazon,
 
@@ -151,9 +253,8 @@ export const amazon: CiDescriptor = {
 
   get jobRunBranch(): string {
     const sourceVersion = getEnv("CODEBUILD_SOURCE_VERSION");
-    const { branch } = sourceVersion?.match?.(/refs\/heads\/(?<branch>\S+)\^\{(?<commithash>\S+)\}/)?.groups ?? {};
 
-    return branch ?? "";
+    return parseBranchFromSourceVersion(sourceVersion) ?? "";
   },
 
   get pullRequestUrl(): string {
@@ -163,4 +264,45 @@ export const amazon: CiDescriptor = {
   get pullRequestName(): string {
     return "";
   },
+
+  get provider() {
+    return getRepository()?.provider;
+  },
+
+  get repository() {
+    const repository = getRepository();
+
+    return repository
+      ? {
+          slug: repository.slug,
+          url: repository.url,
+        }
+      : undefined;
+  },
+
+  get sourceBranch() {
+    return (
+      parseBranchFromWebhookHeadRef(getEnv("CODEBUILD_WEBHOOK_HEAD_REF")) ||
+      parseBranchFromSourceVersion(getEnv("CODEBUILD_SOURCE_VERSION")) ||
+      this.jobRunBranch ||
+      undefined
+    );
+  },
+
+  get targetBranch() {
+    return stripRefsHeads(getEnv("CODEBUILD_WEBHOOK_BASE_REF")) || undefined;
+  },
+
+  get pullRequest() {
+    const pullRequestId =
+      parsePullRequestFromWebhookTrigger() || parsePullRequestFromSourceVersion(getEnv("CODEBUILD_SOURCE_VERSION"));
+
+    return pullRequestId
+      ? {
+          id: pullRequestId,
+          url: this.pullRequestUrl || undefined,
+          title: this.pullRequestName || undefined,
+        }
+      : undefined;
+  },
 };

packages/ci/src/detectors/amazon.ts

@@ -1,7 +1,12 @@
-import { type CiDescriptor, CiType } from "@allurereport/core-api";
+import { type CiDescriptor, CiType, GitProvider } from "@allurereport/core-api";
 
+import { resolveRepositoryFromGitUrl } from "../helpers/gitProvider.js";
 import { getEnv } from "../utils.js";
 
+const REF_PREFIX = "refs/";
+const BRANCH_REF_PREFIX = "refs/heads/";
+const TAG_REF_PREFIX = "refs/tags/";
+
 export const getRootURL = (): string => getEnv("SYSTEM_COLLECTIONURI");
 
 export const getBuildID = (): string => getEnv("BUILD_BUILDID");
@@ -10,6 +15,59 @@ export const getDefinitionID = (): string => getEnv("SYSTEM_DEFINITIONID");
 
 export const getProjectID = (): string => getEnv("SYSTEM_TEAMPROJECTID");
 
+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() ?? "";
+
+  if (!trimmed || trimmed.startsWith(TAG_REF_PREFIX)) {
+    return undefined;
+  }
+
+  if (trimmed.startsWith(BRANCH_REF_PREFIX)) {
+    const branchName = trimmed.slice(BRANCH_REF_PREFIX.length);
+
+    return branchName || undefined;
+  }
+
+  if (trimmed.startsWith(REF_PREFIX)) {
+    return undefined;
+  }
+
+  return trimmed;
+};
+
+const getSourceBranch = (): string | undefined => {
+  const sourceBranch = getEnv("BUILD_SOURCEBRANCH");
+
+  if (sourceBranch) {
+    return normalizeBranchRef(sourceBranch);
+  }
+
+  return normalizeBranchRef(getEnv("BUILD_SOURCEBRANCHNAME"));
+};
+
+const getPullRequestId = (): string | undefined => {
+  return getEnv("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER") || getEnv("SYSTEM_PULLREQUEST_PULLREQUESTID") || undefined;
+};
+
+const getRepositoryUrl = () => getEnv("BUILD_REPOSITORY_URI") || getEnv("SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI");
+
+const getRepositoryFromUrl = () => {
+  const repositoryUrl = getRepositoryUrl();
+
+  return repositoryUrl ? resolveRepositoryFromGitUrl(repositoryUrl) : undefined;
+};
+
 export const azure: CiDescriptor = {
   type: CiType.Azure,
 
@@ -48,20 +106,24 @@ export const azure: CiDescriptor = {
   },
 
   get jobRunBranch(): string {
-    return getEnv("BUILD_SOURCEBRANCHNAME");
+    return getSourceBranch() ?? "";
   },
 
   get pullRequestUrl(): string {
     const repositoryProvider = getEnv("BUILD_REPOSITORY_PROVIDER");
-    const repositoryUrl = getEnv("SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI");
-    const pullRequestNumber = getEnv("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER");
+    const repositoryUrl = getEnv("SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI") || getEnv("BUILD_REPOSITORY_URI");
+    const pullRequestId = getPullRequestId();
+
+    if (!repositoryUrl || !pullRequestId) {
+      return "";
+    }
 
     if (repositoryProvider === "GitHub") {
-      return `${repositoryUrl}/pull/${pullRequestNumber}`;
+      return `${repositoryUrl}/pull/${pullRequestId}`;
     }
 
     if (repositoryProvider === "TfsGit" || repositoryProvider === "TfsVersionControl") {
-      return `${repositoryUrl}/pullrequest/${pullRequestNumber}`;
+      return `${repositoryUrl}/pullrequest/${pullRequestId}`;
     }
 
     return "";
@@ -70,4 +132,47 @@ export const azure: CiDescriptor = {
   get pullRequestName(): string {
     return "";
   },
+
+  get provider() {
+    return getRepositoryFromUrl()?.provider ?? mapAzureRepositoryProvider(getEnv("BUILD_REPOSITORY_PROVIDER"));
+  },
+
+  get repository() {
+    const repositoryUrl = getRepositoryUrl();
+    const fromUrl = repositoryUrl ? resolveRepositoryFromGitUrl(repositoryUrl) : undefined;
+    const slug = fromUrl?.slug ?? (getEnv("BUILD_REPOSITORY_NAME") || undefined);
+
+    if (!this.provider || !slug) {
+      return undefined;
+    }
+
+    return {
+      slug,
+      url: fromUrl?.url ?? repositoryUrl,
+    };
+  },
+
+  get sourceBranch() {
+    return normalizeBranchRef(getEnv("SYSTEM_PULLREQUEST_SOURCEBRANCH")) || getSourceBranch() || undefined;
+  },
+
+  get targetBranch() {
+    return (
+      normalizeBranchRef(getEnv("SYSTEM_PULLREQUEST_TARGETBRANCH")) ||
+      normalizeBranchRef(getEnv("SYSTEM_PULLREQUEST_TARGETBRANCHNAME")) ||
+      undefined
+    );
+  },
+
+  get pullRequest() {
+    const pullRequestNumber = getPullRequestId();
+
+    return pullRequestNumber
+      ? {
+          id: pullRequestNumber,
+          url: this.pullRequestUrl || undefined,
+          title: this.pullRequestName || undefined,
+        }
+      : undefined;
+  },
 };