feat: git flow for testops plugin

Author: vdvukhzhilov

.gitignore

@@ -56,4 +56,5 @@ allure-results.zip
 
 *storybook.log
 
-.tmp
+/.tmp
+/.agent-workspace

.pnp.cjs

@@ -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,42 @@
+import { type CiDescriptor, type CiGitHints, GitProvider } from "@allurereport/core-api";
+
+import { getEnv } from "../utils.js";
+
+const pullRequestSuffixRe = /\/merge$/;
+
+const stripRefsHeads = (ref: string): string => ref.replace(/^refs\/heads\//, "");
+
+export const resolveGithubGitHints = (ci: CiDescriptor): CiGitHints => {
+  const repositorySlug = getEnv("GITHUB_REPOSITORY");
+  const serverUrl = getEnv("GITHUB_SERVER_URL");
+  const repository = repositorySlug
+    ? {
+        slug: repositorySlug,
+        url: serverUrl ? `${serverUrl}/${repositorySlug}` : undefined,
+      }
+    : undefined;
+
+  const headRef = getEnv("GITHUB_HEAD_REF");
+  const baseRef = getEnv("GITHUB_BASE_REF");
+  const sourceBranch = headRef || stripRefsHeads(getEnv("GITHUB_REF")) || ci.jobRunBranch || undefined;
+  const targetBranch = baseRef || undefined;
+
+  const refName = getEnv("GITHUB_REF_NAME");
+  const pullRequestId = pullRequestSuffixRe.test(refName) ? refName.replace(pullRequestSuffixRe, "") : "";
+
+  const pullRequest = pullRequestId
+    ? {
+        id: pullRequestId,
+        url: ci.pullRequestUrl || undefined,
+        title: ci.pullRequestName || undefined,
+      }
+    : undefined;
+
+  return {
+    provider: GitProvider.Github,
+    repository,
+    sourceBranch,
+    targetBranch,
+    pullRequest,
+  };
+};

packages/ci/src/gitHints/github.ts

@@ -0,0 +1,35 @@
+import { type CiDescriptor, type CiGitHints, GitProvider } from "@allurereport/core-api";
+
+import { getEnv } from "../utils.js";
+
+export const resolveGitlabGitHints = (ci: CiDescriptor): CiGitHints => {
+  const projectPath = getEnv("CI_PROJECT_PATH");
+  const projectUrl = getEnv("CI_PROJECT_URL");
+  const repository = projectPath
+    ? {
+        slug: projectPath,
+        url: projectUrl || undefined,
+      }
+    : undefined;
+
+  const mergeRequestSource = getEnv("CI_MERGE_REQUEST_SOURCE_BRANCH_NAME");
+  const sourceBranch = mergeRequestSource || getEnv("CI_COMMIT_REF_NAME") || ci.jobRunBranch || undefined;
+  const targetBranch = getEnv("CI_MERGE_REQUEST_TARGET_BRANCH_NAME") || undefined;
+
+  const mergeRequestIid = getEnv("CI_MERGE_REQUEST_IID");
+  const pullRequest = mergeRequestIid
+    ? {
+        id: mergeRequestIid,
+        url: ci.pullRequestUrl || undefined,
+        title: getEnv("CI_MERGE_REQUEST_TITLE") || ci.pullRequestName || undefined,
+      }
+    : undefined;
+
+  return {
+    provider: GitProvider.Gitlab,
+    repository,
+    sourceBranch,
+    targetBranch,
+    pullRequest,
+  };
+};

packages/ci/src/gitHints/gitlab.ts

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

packages/ci/src/index.ts

@@ -0,0 +1,18 @@
+import { type CiDescriptor, type CiGitHints, CiType } from "@allurereport/core-api";
+
+import { resolveBitbucketGitHints } from "./gitHints/bitbucket.js";
+import { resolveGithubGitHints } from "./gitHints/github.js";
+import { resolveGitlabGitHints } from "./gitHints/gitlab.js";
+
+export const resolveGitHints = (ci: CiDescriptor): CiGitHints => {
+  switch (ci.type) {
+    case CiType.Github:
+      return resolveGithubGitHints(ci);
+    case CiType.Gitlab:
+      return resolveGitlabGitHints(ci);
+    case CiType.Bitbucket:
+      return resolveBitbucketGitHints(ci);
+    default:
+      return {};
+  }
+};

packages/ci/src/resolveGitHints.ts

@@ -0,0 +1,51 @@
+import { CiType, type CiDescriptor, GitProvider } from "@allurereport/core-api";
+import { type Mock, beforeEach, describe, expect, it, vi } from "vitest";
+
+import { resolveBitbucketGitHints } from "../src/gitHints/bitbucket.js";
+import { getEnv } from "../src/utils.js";
+
+vi.mock("../src/utils.js", () => ({
+  getEnv: vi.fn(),
+}));
+
+const bitbucketCi = {
+  type: CiType.Bitbucket,
+  jobRunBranch: "feature/foo",
+  pullRequestUrl: "https://bitbucket.org/myorg/myrepo/pull-requests/15",
+  pullRequestName: "",
+} as CiDescriptor;
+
+beforeEach(() => {
+  vi.clearAllMocks();
+});
+
+describe("resolveBitbucketGitHints", () => {
+  it("maps repository, branches, and pull request", () => {
+    (getEnv as Mock).mockImplementation((key: string) => {
+      const env: Record<string, string> = {
+        BITBUCKET_REPO_FULL_NAME: "myorg/myrepo",
+        BITBUCKET_GIT_HTTP_ORIGIN: "https://bitbucket.org/myorg/myrepo",
+        BITBUCKET_BRANCH: "feature/foo",
+        BITBUCKET_PR_DESTINATION_BRANCH: "main",
+        BITBUCKET_PR_ID: "15",
+      };
+
+      return env[key] ?? "";
+    });
+
+    expect(resolveBitbucketGitHints(bitbucketCi)).toEqual({
+      provider: GitProvider.Bitbucket,
+      repository: {
+        slug: "myorg/myrepo",
+        url: "https://bitbucket.org/myorg/myrepo",
+      },
+      sourceBranch: "feature/foo",
+      targetBranch: "main",
+      pullRequest: {
+        id: "15",
+        url: "https://bitbucket.org/myorg/myrepo/pull-requests/15",
+        title: undefined,
+      },
+    });
+  });
+});

packages/ci/test/resolveGitHints.bitbucket.test.ts

@@ -0,0 +1,69 @@
+import { CiType, type CiDescriptor, GitProvider } from "@allurereport/core-api";
+import { type Mock, beforeEach, describe, expect, it, vi } from "vitest";
+
+import { resolveGithubGitHints } from "../src/gitHints/github.js";
+import { getEnv } from "../src/utils.js";
+
+vi.mock("../src/utils.js", () => ({
+  getEnv: vi.fn(),
+}));
+
+const githubCi = {
+  type: CiType.Github,
+  jobRunBranch: "feature/foo",
+  pullRequestUrl: "https://github.com/myorg/myrepo/pull/42",
+  pullRequestName: "Pull request #42",
+} as CiDescriptor;
+
+beforeEach(() => {
+  vi.clearAllMocks();
+});
+
+describe("resolveGithubGitHints", () => {
+  it("maps repository, branches, and pull request for PR workflow", () => {
+    (getEnv as Mock).mockImplementation((key: string) => {
+      const env: Record<string, string> = {
+        GITHUB_REPOSITORY: "myorg/myrepo",
+        GITHUB_SERVER_URL: "https://github.com",
+        GITHUB_HEAD_REF: "feature/foo",
+        GITHUB_BASE_REF: "main",
+        GITHUB_REF_NAME: "42/merge",
+        GITHUB_REF: "refs/heads/feature/foo",
+      };
+
+      return env[key] ?? "";
+    });
+
+    expect(resolveGithubGitHints(githubCi)).toEqual({
+      provider: GitProvider.Github,
+      repository: {
+        slug: "myorg/myrepo",
+        url: "https://github.com/myorg/myrepo",
+      },
+      sourceBranch: "feature/foo",
+      targetBranch: "main",
+      pullRequest: {
+        id: "42",
+        url: "https://github.com/myorg/myrepo/pull/42",
+        title: "Pull request #42",
+      },
+    });
+  });
+
+  it("uses GITHUB_REF branch when HEAD_REF is empty", () => {
+    (getEnv as Mock).mockImplementation((key: string) => {
+      if (key === "GITHUB_REPOSITORY") {
+        return "myorg/myrepo";
+      }
+
+      if (key === "GITHUB_REF") {
+        return "refs/heads/main";
+      }
+
+      return "";
+    });
+
+    expect(resolveGithubGitHints(githubCi).sourceBranch).toBe("main");
+    expect(resolveGithubGitHints(githubCi).pullRequest).toBeUndefined();
+  });
+});

packages/ci/test/resolveGitHints.github.test.ts

@@ -0,0 +1,53 @@
+import { CiType, type CiDescriptor, GitProvider } from "@allurereport/core-api";
+import { type Mock, beforeEach, describe, expect, it, vi } from "vitest";
+
+import { resolveGitlabGitHints } from "../src/gitHints/gitlab.js";
+import { getEnv } from "../src/utils.js";
+
+vi.mock("../src/utils.js", () => ({
+  getEnv: vi.fn(),
+}));
+
+const gitlabCi = {
+  type: CiType.Gitlab,
+  jobRunBranch: "feature/foo",
+  pullRequestUrl: "https://gitlab.com/myorg/myrepo/-/merge_requests/7",
+  pullRequestName: "Fix things",
+} as CiDescriptor;
+
+beforeEach(() => {
+  vi.clearAllMocks();
+});
+
+describe("resolveGitlabGitHints", () => {
+  it("maps merge request metadata and branches", () => {
+    (getEnv as Mock).mockImplementation((key: string) => {
+      const env: Record<string, string> = {
+        CI_PROJECT_PATH: "myorg/myrepo",
+        CI_PROJECT_URL: "https://gitlab.com/myorg/myrepo",
+        CI_MERGE_REQUEST_SOURCE_BRANCH_NAME: "feature/foo",
+        CI_MERGE_REQUEST_TARGET_BRANCH_NAME: "main",
+        CI_MERGE_REQUEST_IID: "7",
+        CI_MERGE_REQUEST_TITLE: "Fix things",
+        CI_COMMIT_REF_NAME: "feature/foo",
+      };
+
+      return env[key] ?? "";
+    });
+
+    expect(resolveGitlabGitHints(gitlabCi)).toEqual({
+      provider: GitProvider.Gitlab,
+      repository: {
+        slug: "myorg/myrepo",
+        url: "https://gitlab.com/myorg/myrepo",
+      },
+      sourceBranch: "feature/foo",
+      targetBranch: "main",
+      pullRequest: {
+        id: "7",
+        url: "https://gitlab.com/myorg/myrepo/-/merge_requests/7",
+        title: "Fix things",
+      },
+    });
+  });
+});