fix(plugin-testops): allow local run for testops plugin (#687)

Author: vdvukhzhilov

packages/ci/README.md

@@ -9,5 +9,3 @@
 - 💬 [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/src/detect.ts

@@ -12,9 +12,9 @@ import { local } from "./detectors/local.js";
 
 /**
  * Tries to detect current CI
- * Returns CI descriptor if some detected, otherwise undefined
+ * Returns CI descriptor, otherwise local descriptor
  */
-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/detectors/local.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/index.ts

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

packages/plugin-testops/src/plugin.ts

@@ -1,7 +1,7 @@
 import { env } from "node:process";
 
-import { detect } from "@allurereport/ci";
-import type { CategoryDefinition, CiDescriptor, EnvironmentIdentity, TestStatus } from "@allurereport/core-api";
+import { detect, isLocalCiDescriptor } from "@allurereport/ci";
+import type { CategoryDefinition, EnvironmentIdentity, TestStatus } from "@allurereport/core-api";
 import { getWorstStatus } from "@allurereport/core-api";
 import { type AllureStore, type Plugin, type PluginContext, createPluginSummary } from "@allurereport/plugin-api";
 import { uniqBy, stubTrue } from "lodash-es";
@@ -24,22 +24,16 @@ const categoryDisplayName = (cat: UploadCategory): string =>
 
 export class TestOpsPlugin implements Plugin {
   #logger = new Logger("TestOpsPlugin");
-  #ci?: CiDescriptor;
+  #ci = detect();
   // @ts-expect-error - if client is not initialized it will not be used
   #client: TestOpsClient;
-  /**
-   * If the client is configured
-   */
-  #clientConfigured: boolean = false;
   #launchName: string = "";
   #launchTags: string[] = [];
   #uploadedTestResultsIds: Set<string> = new Set();
   #autocloseLaunch: boolean = false;
 
   constructor(readonly options: TestOpsPluginOptions) {
-    this.#ci = detect();
-
-    if (!this.#ci || this.#ci.type === "local") {
+    if (isLocalCiDescriptor(this.#ci) && !this.isOverridenByEnv) {
       this.#logger.info(
         `plugin is disabled - no CI environment detected. To enable, set ${bold("ALLURE_TESTOPS_ENABLED")}=true or ${bold("CI")}=true.`,
       );
@@ -58,7 +52,6 @@ export class TestOpsPlugin implements Plugin {
     // don't initialize the client when some options are missing
     // we can' throw an error here because it would break the report execution flow
     if ([accessToken, endpoint, projectId].every(Boolean)) {
-      this.#clientConfigured = true;
       this.#client = new TestOpsClient({
         baseUrl: endpoint,
         accessToken,
@@ -102,7 +95,7 @@ export class TestOpsPlugin implements Plugin {
   }
 
   get enabled(): boolean {
-    if (!this.#clientConfigured) {
+    if (!(this.#client instanceof TestOpsClient)) {
       return false;
     }
 

packages/plugin-testops/test/features/quality-gate.test.ts

@@ -7,9 +7,14 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
 import { TestOpsPlugin } from "../../src/plugin.js";
 import { handleBeforeEach, mockAllureStore, mockRequests } from "./helpers.js";
 
-vi.mock("@allurereport/ci", () => ({
-  detect: vi.fn(() => ({ type: "github" }) as CiDescriptor),
-}));
+vi.mock("@allurereport/ci", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("@allurereport/ci")>();
+
+  return {
+    ...actual,
+    detect: vi.fn(() => ({ type: "github" }) as CiDescriptor),
+  };
+});
 
 beforeEach(async () => {
   await epic("coverage");

packages/plugin-testops/test/plugin.test.ts

@@ -13,9 +13,14 @@ import { TestOpsPlugin } from "../src/plugin.js";
 import { resolvePluginOptions } from "../src/utils/index.js";
 import { AllureStoreMock, TestOpsClientMock } from "./utils.js";
 
-vi.mock("@allurereport/ci", () => ({
-  detect: vi.fn(),
-}));
+vi.mock("@allurereport/ci", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("@allurereport/ci")>();
+
+  return {
+    ...actual,
+    detect: vi.fn(),
+  };
+});
 
 vi.mock("../src/client.js", async () => {
   const utils = await import("./utils.js");
@@ -237,6 +242,11 @@ describe("testops plugin", () => {
     });
 
     describe("outside ci mode", () => {
+      beforeEach(() => {
+        vi.stubEnv("ALLURE_TESTOPS_ENABLED", "");
+        vi.stubEnv("CI", "");
+      });
+
       it("should return false from enabled getter when ci is local", () => {
         (detect as unknown as Mock).mockReturnValue({ type: "local" } as CiDescriptor);
         (resolvePluginOptions as Mock).mockReturnValue({
@@ -1108,6 +1118,11 @@ describe("testops plugin", () => {
     });
 
     describe("outside ci mode", () => {
+      beforeEach(() => {
+        vi.stubEnv("ALLURE_TESTOPS_ENABLED", "");
+        vi.stubEnv("CI", "");
+      });
+
       it("should not stop upload when ci is local", async () => {
         (detect as unknown as Mock).mockReturnValue({ type: "local" } as CiDescriptor);
         (resolvePluginOptions as Mock).mockReturnValue({