feat(api-key): Add the endpoints and workflows for api key module

2024-02-21 16:52:37 +01:00
parent d9636f4631
commit 0582545065
27 changed files with 779 additions and 42 deletions
@@ -0,0 +1,109 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IApiKeyModuleService } from "@medusajs/types"
+import path from "path"
+import { startBootstrapApp } from "../../../../environment-helpers/bootstrap-app"
+import { useApi } from "../../../../environment-helpers/use-api"
+import { getContainer } from "../../../../environment-helpers/use-container"
+import { initDb, useDb } from "../../../../environment-helpers/use-db"
+import adminSeeder from "../../../../helpers/admin-seeder"
+import { ApiKeyType } from "@medusajs/utils"
+
+jest.setTimeout(50000)
+
+const env = { MEDUSA_FF_MEDUSA_V2: true }
+const adminHeaders = {
+  headers: { "x-medusa-access-token": "test_token" },
+}
+
+describe("API Keys - Admin", () => {
+  let dbConnection
+  let appContainer
+  let shutdownServer
+  let service: IApiKeyModuleService
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", "..", ".."))
+    dbConnection = await initDb({ cwd, env } as any)
+    shutdownServer = await startBootstrapApp({ cwd, env })
+    appContainer = getContainer()
+    service = appContainer.resolve(ModuleRegistrationName.API_KEY)
+  })
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+    await shutdownServer()
+  })
+
+  beforeEach(async () => {
+    await adminSeeder(dbConnection)
+  })
+
+  afterEach(async () => {
+    const db = useDb()
+    await db.teardown()
+  })
+
+  it("should correctly implement the entire lifecycle of an api key", async () => {
+    const api = useApi() as any
+    const created = await api.post(
+      `/admin/api-keys`,
+      {
+        title: "Test Secret Key",
+        type: ApiKeyType.SECRET,
+      },
+      adminHeaders
+    )
+
+    expect(created.status).toEqual(200)
+    expect(created.data.apiKey).toEqual(
+      expect.objectContaining({
+        id: created.data.apiKey.id,
+        title: "Test Secret Key",
+        created_by: "test",
+      })
+    )
+    // On create we get the token in raw form so we can store it.
+    expect(created.data.apiKey.token).toContain("sk_")
+
+    const updated = await api.post(
+      `/admin/api-keys/${created.data.apiKey.id}`,
+      {
+        title: "Updated Secret Key",
+      },
+      adminHeaders
+    )
+
+    expect(updated.status).toEqual(200)
+    expect(updated.data.apiKey).toEqual(
+      expect.objectContaining({
+        id: created.data.apiKey.id,
+        title: "Updated Secret Key",
+      })
+    )
+
+    const revoked = await api.post(
+      `/admin/api-keys/${created.data.apiKey.id}/revoke`,
+      {},
+      adminHeaders
+    )
+
+    expect(revoked.status).toEqual(200)
+    expect(revoked.data.apiKey).toEqual(
+      expect.objectContaining({
+        id: created.data.apiKey.id,
+        revoked_by: "test",
+      })
+    )
+    expect(revoked.data.apiKey.revoked_at).toBeTruthy()
+
+    const deleted = await api.delete(
+      `/admin/api-keys/${created.data.apiKey.id}`,
+      adminHeaders
+    )
+    const listedApiKeys = await api.get(`/admin/api-keys`, adminHeaders)
+
+    expect(deleted.status).toEqual(200)
+    expect(listedApiKeys.data.apiKeys).toHaveLength(0)
+  })
+})