test(common): add comprehensive unit tests for auth helpers (hoppscotch#5211)

Co-authored-by: jamesgeorge007 <[email protected]>

Author: anwarulislam

packages/hoppscotch-common/src/helpers/auth/auth-types.ts

@@ -34,23 +34,23 @@ export async function generateAuthHeaders(
 ): Promise<HoppRESTHeader[]> {
   switch (auth.authType) {
     case "basic":
-      return generateBasicAuthHeaders(auth, request, envVars, showKeyIfSecret)
+      return generateBasicAuthHeaders(auth, envVars, showKeyIfSecret)
     case "bearer":
-      return generateBearerAuthHeaders(auth, request, envVars, showKeyIfSecret)
+      return generateBearerAuthHeaders(auth, envVars, showKeyIfSecret)
     case "api-key":
       return auth.addTo === "HEADERS"
-        ? generateApiKeyAuthHeaders(auth, request, envVars, showKeyIfSecret)
+        ? generateApiKeyAuthHeaders(auth, envVars, showKeyIfSecret)
         : []
     case "oauth-2":
-      return generateOAuth2AuthHeaders(auth, request, envVars, showKeyIfSecret)
+      return generateOAuth2AuthHeaders(auth, envVars, showKeyIfSecret)
     case "digest":
       return generateDigestAuthHeaders(auth, request, envVars, showKeyIfSecret)
     case "aws-signature":
       return generateAwsSignatureAuthHeaders(auth, request, envVars)
     case "hawk":
       return generateHawkAuthHeaders(auth, request, envVars, showKeyIfSecret)
     case "jwt":
-      return generateJwtAuthHeaders(auth, request, envVars, showKeyIfSecret)
+      return generateJwtAuthHeaders(auth, envVars, showKeyIfSecret)
     default:
       return []
   }
@@ -68,14 +68,14 @@ export async function generateAuthParams(
   switch (auth.authType) {
     case "api-key":
       return auth.addTo === "QUERY_PARAMS"
-        ? generateApiKeyAuthParams(auth, request, envVars, showKeyIfSecret)
+        ? generateApiKeyAuthParams(auth, envVars, showKeyIfSecret)
         : []
     case "oauth-2":
-      return generateOAuth2AuthParams(auth, request, envVars, showKeyIfSecret)
+      return generateOAuth2AuthParams(auth, envVars, showKeyIfSecret)
     case "aws-signature":
       return generateAwsSignatureAuthParams(auth, request, envVars)
     case "jwt":
-      return generateJwtAuthParams(auth, request, envVars)
+      return generateJwtAuthParams(auth, envVars)
     default:
       return []
   }

packages/hoppscotch-common/src/helpers/auth/types/__tests__/api-key.spec.ts

@@ -0,0 +1,93 @@
+import { HoppRESTAuth } from "@hoppscotch/data"
+import { describe, expect, test } from "vitest"
+import { generateApiKeyAuthHeaders, generateApiKeyAuthParams } from "../api-key"
+import { mockEnvVars } from "./test-utils"
+
+describe("API Key Auth", () => {
+  describe("generateApiKeyAuthHeaders", () => {
+    test("generates headers when addTo is HEADERS", async () => {
+      const auth: HoppRESTAuth & { authType: "api-key" } = {
+        authActive: true,
+        authType: "api-key",
+        addTo: "HEADERS",
+        key: "X-API-Key",
+        value: "<<API_VALUE>>",
+      }
+
+      const headers = await generateApiKeyAuthHeaders(auth, mockEnvVars)
+
+      expect(headers).toHaveLength(1)
+      expect(headers[0]).toEqual({
+        active: true,
+        key: "X-API-Key",
+        value: "secret-value",
+        description: "",
+      })
+    })
+
+    test("returns empty array when addTo is not HEADERS", async () => {
+      const auth: HoppRESTAuth & { authType: "api-key" } = {
+        authActive: true,
+        authType: "api-key",
+        addTo: "QUERY_PARAMS",
+        key: "api_key",
+        value: "test-value",
+      }
+
+      const headers = await generateApiKeyAuthHeaders(auth, mockEnvVars)
+
+      expect(headers).toHaveLength(0)
+    })
+
+    test("handles template strings in key and value", async () => {
+      const auth: HoppRESTAuth & { authType: "api-key" } = {
+        authActive: true,
+        authType: "api-key",
+        addTo: "HEADERS",
+        key: "<<API_KEY>>",
+        value: "<<API_VALUE>>",
+      }
+
+      const headers = await generateApiKeyAuthHeaders(auth, mockEnvVars)
+
+      expect(headers[0].key).toBe("test-key-123")
+      expect(headers[0].value).toBe("secret-value")
+    })
+  })
+
+  describe("generateApiKeyAuthParams", () => {
+    test("generates params when addTo is QUERY_PARAMS", async () => {
+      const auth: HoppRESTAuth & { authType: "api-key" } = {
+        authActive: true,
+        authType: "api-key",
+        addTo: "QUERY_PARAMS",
+        key: "api_key",
+        value: "<<API_VALUE>>",
+      }
+
+      const params = await generateApiKeyAuthParams(auth, mockEnvVars)
+
+      expect(params).toHaveLength(1)
+      expect(params[0]).toEqual({
+        active: true,
+        key: "api_key",
+        value: "secret-value",
+        description: "",
+      })
+    })
+
+    test("returns empty array when addTo is not QUERY_PARAMS", async () => {
+      const auth: HoppRESTAuth & { authType: "api-key" } = {
+        authActive: true,
+        authType: "api-key",
+        addTo: "HEADERS",
+        key: "X-API-Key",
+        value: "test-value",
+      }
+
+      const params = await generateApiKeyAuthParams(auth, mockEnvVars)
+
+      expect(params).toHaveLength(0)
+    })
+  })
+})

packages/hoppscotch-common/src/helpers/auth/types/__tests__/aws-signature.spec.ts

@@ -1,10 +1,10 @@
-import { describe, expect, test, vi, beforeEach, afterEach } from "vitest"
-import { makeRESTRequest } from "@hoppscotch/data"
+import type { Environment, HoppRESTAuth } from "@hoppscotch/data"
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest"
 import {
   generateAwsSignatureAuthHeaders,
   generateAwsSignatureAuthParams,
 } from "../aws-signature"
-import type { HoppRESTAuth, Environment } from "@hoppscotch/data"
+import { createBaseRequest } from "./test-utils"
 
 vi.mock("aws4fetch", () => ({
   AwsV4Signer: vi.fn().mockImplementation((config) => ({
@@ -69,33 +69,6 @@ describe("AWS Signature Auth", () => {
     ...overrides,
   })
 
-  // Helper function to create base request
-  const createBaseRequest = (
-    overrides: Partial<Parameters<typeof makeRESTRequest>[0]> = {}
-  ) => {
-    const baseRequest: Parameters<typeof makeRESTRequest>[0] = {
-      method: "GET",
-      endpoint: "https://s3.amazonaws.com/bucket/key",
-      name: "Test Request",
-      params: [],
-      headers: [],
-      preRequestScript: "",
-      testScript: "",
-      auth: {
-        authType: "inherit",
-        authActive: true,
-      },
-      body: {
-        contentType: null,
-        body: null,
-      },
-      requestVariables: [],
-      responses: {},
-    }
-
-    return makeRESTRequest({ ...baseRequest, ...overrides })
-  }
-
   beforeEach(() => {
     vi.clearAllMocks()
     vi.useFakeTimers()

packages/hoppscotch-common/src/helpers/auth/types/__tests__/basic.spec.ts

@@ -0,0 +1,53 @@
+import { HoppRESTAuth } from "@hoppscotch/data"
+import { describe, expect, test } from "vitest"
+import { generateBasicAuthHeaders } from "../basic"
+import { mockEnvVars } from "./test-utils"
+
+describe("Basic Auth", () => {
+  describe("generateBasicAuthHeaders", () => {
+    test("generates basic auth header with credentials", async () => {
+      const auth: HoppRESTAuth & { authType: "basic" } = {
+        authActive: true,
+        authType: "basic",
+        username: "admin",
+        password: "secret123",
+      }
+
+      const headers = await generateBasicAuthHeaders(auth, mockEnvVars)
+
+      expect(headers).toHaveLength(1)
+      expect(headers[0]).toEqual({
+        active: true,
+        key: "Authorization",
+        value: `Basic ${btoa("admin:secret123")}`,
+        description: "",
+      })
+    })
+
+    test("handles template strings in username and password", async () => {
+      const auth: HoppRESTAuth & { authType: "basic" } = {
+        authActive: true,
+        authType: "basic",
+        username: "<<USERNAME>>",
+        password: "<<PASSWORD>>",
+      }
+
+      const headers = await generateBasicAuthHeaders(auth, mockEnvVars)
+
+      expect(headers[0].value).toBe(`Basic ${btoa("testuser:testpass")}`)
+    })
+
+    test("handles empty credentials", async () => {
+      const auth: HoppRESTAuth & { authType: "basic" } = {
+        authActive: true,
+        authType: "basic",
+        username: "",
+        password: "",
+      }
+
+      const headers = await generateBasicAuthHeaders(auth, mockEnvVars)
+
+      expect(headers[0].value).toBe(`Basic ${btoa(":")}`)
+    })
+  })
+})

packages/hoppscotch-common/src/helpers/auth/types/__tests__/bearer.spec.ts

@@ -0,0 +1,52 @@
+import { describe, test, expect } from "vitest"
+import { generateBearerAuthHeaders } from "../bearer"
+import { createBaseRequest, mockEnvVars } from "./test-utils"
+import { HoppRESTAuth } from "@hoppscotch/data"
+
+describe("Bearer Auth", () => {
+  describe("generateBearerAuthHeaders", () => {
+    test("generates bearer auth header with token", async () => {
+      const auth: HoppRESTAuth & { authType: "bearer" } = {
+        authActive: true,
+        authType: "bearer",
+        token: "abc123token",
+      }
+
+      const headers = await generateBearerAuthHeaders(auth, mockEnvVars)
+
+      expect(headers).toHaveLength(1)
+      expect(headers[0]).toEqual({
+        active: true,
+        key: "Authorization",
+        value: "Bearer abc123token",
+        description: "",
+      })
+    })
+
+    test("handles template strings in token", async () => {
+      const auth: HoppRESTAuth & { authType: "bearer" } = {
+        authActive: true,
+        authType: "bearer",
+        token: "<<ACCESS_TOKEN>>",
+      }
+
+      const headers = await generateBearerAuthHeaders(auth, mockEnvVars)
+
+      expect(headers[0].value).toBe(
+        "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
+      )
+    })
+
+    test("handles empty token", async () => {
+      const auth: HoppRESTAuth & { authType: "bearer" } = {
+        authActive: true,
+        authType: "bearer",
+        token: "",
+      }
+
+      const headers = await generateBearerAuthHeaders(auth, mockEnvVars)
+
+      expect(headers[0].value).toBe("Bearer ")
+    })
+  })
+})