Chore/integration tests modules utils (#6581)

new wrapper for medusa integration tests.
for now it is only applied to the modules directory, but it could be used in the api integration tests or any other integrations that requires a db and a server up and running. 

It is not perfect, but I wanted to have something working and centralised before improving it, also avoiding too many conflicts with other prs

integration-tests/modules/__tests__/users/create-user.spec.ts

@@ -1,10 +1,5 @@
-import { initDb, useDb } from "../../../environment-helpers/use-db"
-
-import { AxiosInstance } from "axios"
 import { createAdminUser } from "../../helpers/create-admin-user"
-import path from "path"
-import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
-import { useApi } from "../../../environment-helpers/use-api"
+import { medusaIntegrationTestRunner } from "medusa-test-utils"
 
 jest.setTimeout(50000)
 
@@ -13,43 +8,26 @@ const adminHeaders = {
   headers: { "x-medusa-access-token": "test_token" },
 }
 
-describe("POST /admin/users", () => {
-  let dbConnection
-  let shutdownServer
+medusaIntegrationTestRunner({
+  env,
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    describe("POST /admin/users", () => {
+      beforeEach(async () => {
+        await createAdminUser(dbConnection, adminHeaders, getContainer())
+      })
 
-  beforeAll(async () => {
-    const cwd = path.resolve(path.join(__dirname, "..", ".."))
-    dbConnection = await initDb({ cwd, env } as any)
-    shutdownServer = await startBootstrapApp({ cwd, env })
-  })
+      it("create a user", async () => {
+        const body = {
+          email: "test_member@test.com",
+        }
 
-  beforeEach(async () => {
-    await createAdminUser(dbConnection, adminHeaders)
-  })
+        const response = await api.post(`/admin/users`, body, adminHeaders)
 
-  afterAll(async () => {
-    const db = useDb()
-    await db.shutdown()
-    await shutdownServer()
-  })
-
-  afterEach(async () => {
-    const db = useDb()
-    await db.teardown()
-  })
-
-  it("create a user", async () => {
-    const api = useApi()! as AxiosInstance
-
-    const body = {
-      email: "test_member@test.com",
-    }
-
-    const response = await api.post(`/admin/users`, body, adminHeaders)
-
-    expect(response.status).toEqual(200)
-    expect(response.data).toEqual({
-      user: expect.objectContaining(body),
+        expect(response.status).toEqual(200)
+        expect(response.data).toEqual({
+          user: expect.objectContaining(body),
+        })
+      })
     })
-  })
+  },
 })

integration-tests/modules/__tests__/users/delete-user.spec.ts

@@ -1,13 +1,7 @@
-import { initDb, useDb } from "../../../environment-helpers/use-db"
-
-import { AxiosInstance } from "axios"
 import { IUserModuleService } from "@medusajs/types"
 import { ModuleRegistrationName } from "@medusajs/modules-sdk"
 import { createAdminUser } from "../../helpers/create-admin-user"
-import { getContainer } from "../../../environment-helpers/use-container"
-import path from "path"
-import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
-import { useApi } from "../../../environment-helpers/use-api"
+import { medusaIntegrationTestRunner } from "medusa-test-utils"
 
 jest.setTimeout(50000)
 
@@ -16,56 +10,46 @@ const adminHeaders = {
   headers: { "x-medusa-access-token": "test_token" },
 }
 
-describe("DELETE /admin/users/:id", () => {
-  let dbConnection
-  let appContainer
-  let shutdownServer
-  let userModuleService: IUserModuleService
+medusaIntegrationTestRunner({
+  env,
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    describe("DELETE /admin/users/:id", () => {
+      let appContainer
+      let userModuleService: IUserModuleService
 
-  beforeAll(async () => {
-    const cwd = path.resolve(path.join(__dirname, "..", ".."))
-    dbConnection = await initDb({ cwd, env } as any)
-    shutdownServer = await startBootstrapApp({ cwd, env })
-    appContainer = getContainer()
-    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
-  })
+      beforeAll(async () => {
+        appContainer = getContainer()
+        userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+      })
 
-  beforeEach(async () => {
-    await createAdminUser(dbConnection, adminHeaders)
-  })
+      beforeEach(async () => {
+        await createAdminUser(dbConnection, adminHeaders, appContainer)
+      })
 
-  afterAll(async () => {
-    const db = useDb()
-    await db.shutdown()
-    await shutdownServer()
-  })
+      it("should delete a single user", async () => {
+        const user = await userModuleService.create({
+          email: "member@test.com",
+        })
 
-  afterEach(async () => {
-    const db = useDb()
-    await db.teardown()
-  })
+        const response = await api.delete(
+          `/admin/users/${user.id}`,
+          adminHeaders
+        )
 
-  it("should delete a single user", async () => {
-    const user = await userModuleService.create({
-      email: "member@test.com",
+        expect(response.status).toEqual(200)
+        expect(response.data).toEqual({
+          id: user.id,
+          object: "user",
+          deleted: true,
+        })
+
+        const { response: deletedResponse } = await api
+          .get(`/admin/users/${user.id}`, adminHeaders)
+          .catch((e) => e)
+
+        expect(deletedResponse.status).toEqual(404)
+        expect(deletedResponse.data.type).toEqual("not_found")
+      })
     })
-
-    const api = useApi()! as AxiosInstance
-
-    const response = await api.delete(`/admin/users/${user.id}`, adminHeaders)
-
-    expect(response.status).toEqual(200)
-    expect(response.data).toEqual({
-      id: user.id,
-      object: "user",
-      deleted: true,
-    })
-
-    const { response: deletedResponse } = await api
-      .get(`/admin/users/${user.id}`, adminHeaders)
-      .catch((e) => e)
-
-    expect(deletedResponse.status).toEqual(404)
-    expect(deletedResponse.data.type).toEqual("not_found")
-  })
+  },
 })

integration-tests/modules/__tests__/users/get-me.spec.ts

@@ -1,10 +1,5 @@
-import { initDb, useDb } from "../../../environment-helpers/use-db"
-
-import { AxiosInstance } from "axios"
-import path from "path"
-import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
-import { useApi } from "../../../environment-helpers/use-api"
 import { createAdminUser } from "../../helpers/create-admin-user"
+import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
 
 jest.setTimeout(50000)
 
@@ -13,39 +8,22 @@ const adminHeaders = {
   headers: { "x-medusa-access-token": "test_token" },
 }
 
-describe("POST /admin/users/me", () => {
-  let dbConnection
-  let shutdownServer
+medusaIntegrationTestRunner({
+  env,
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    describe("POST /admin/users/me", () => {
+      beforeEach(async () => {
+        await createAdminUser(dbConnection, adminHeaders)
+      })
 
-  beforeAll(async () => {
-    const cwd = path.resolve(path.join(__dirname, "..", ".."))
-    dbConnection = await initDb({ cwd, env } as any)
-    shutdownServer = await startBootstrapApp({ cwd, env })
-  })
+      it("gets the current user", async () => {
+        const response = await api.get(`/admin/users/me`, adminHeaders)
 
-  beforeEach(async () => {
-    await createAdminUser(dbConnection, adminHeaders)
-  })
-
-  afterAll(async () => {
-    const db = useDb()
-    await db.shutdown()
-    await shutdownServer()
-  })
-
-  afterEach(async () => {
-    const db = useDb()
-    await db.teardown()
-  })
-
-  it("gets the current user", async () => {
-    const api = useApi()! as AxiosInstance
-
-    const response = await api.get(`/admin/users/me`, adminHeaders)
-
-    expect(response.status).toEqual(200)
-    expect(response.data).toEqual({
-      user: expect.objectContaining({ id: "admin_user" }),
+        expect(response.status).toEqual(200)
+        expect(response.data).toEqual({
+          user: expect.objectContaining({ id: "admin_user" }),
+        })
+      })
     })
-  })
+  },
 })

integration-tests/modules/__tests__/users/list-users.spec.ts

@@ -1,13 +1,7 @@
-import { initDb, useDb } from "../../../environment-helpers/use-db"
-
-import { AxiosInstance } from "axios"
 import { IUserModuleService } from "@medusajs/types"
 import { ModuleRegistrationName } from "@medusajs/modules-sdk"
 import { createAdminUser } from "../../helpers/create-admin-user"
-import { getContainer } from "../../../environment-helpers/use-container"
-import path from "path"
-import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
-import { useApi } from "../../../environment-helpers/use-api"
+import { medusaIntegrationTestRunner } from "medusa-test-utils"
 
 jest.setTimeout(50000)
 
@@ -16,57 +10,44 @@ const adminHeaders = {
   headers: { "x-medusa-access-token": "test_token" },
 }
 
-describe("GET /admin/users", () => {
-  let dbConnection
-  let appContainer
-  let shutdownServer
-  let userModuleService: IUserModuleService
+medusaIntegrationTestRunner({
+  env,
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    describe("GET /admin/users", () => {
+      let appContainer
+      let userModuleService: IUserModuleService
 
-  beforeAll(async () => {
-    const cwd = path.resolve(path.join(__dirname, "..", ".."))
-    dbConnection = await initDb({ cwd, env } as any)
-    shutdownServer = await startBootstrapApp({ cwd, env })
-    appContainer = getContainer()
-    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
-  })
+      beforeAll(async () => {
+        appContainer = getContainer()
+        userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+      })
 
-  beforeEach(async () => {
-    await createAdminUser(dbConnection, adminHeaders)
-  })
+      beforeEach(async () => {
+        await createAdminUser(dbConnection, adminHeaders, appContainer)
+      })
 
-  afterAll(async () => {
-    const db = useDb()
-    await db.shutdown()
-    await shutdownServer()
-  })
+      it("should list users", async () => {
+        await userModuleService.create([
+          {
+            email: "member@test.com",
+          },
+        ])
 
-  afterEach(async () => {
-    const db = useDb()
-    await db.teardown()
-  })
+        const response = await api.get(`/admin/users`, adminHeaders)
 
-  it("should list users", async () => {
-    await userModuleService.create([
-      {
-        email: "member@test.com",
-      },
-    ])
-
-    const api = useApi()! as AxiosInstance
-
-    const response = await api.get(`/admin/users`, adminHeaders)
-
-    expect(response.status).toEqual(200)
-    expect(response.data).toEqual({
-      users: expect.arrayContaining([
-        expect.objectContaining({
-          email: "admin@medusa.js",
-        }),
-        expect.objectContaining({ email: "member@test.com" }),
-      ]),
-      count: 2,
-      offset: 0,
-      limit: 50,
+        expect(response.status).toEqual(200)
+        expect(response.data).toEqual({
+          users: expect.arrayContaining([
+            expect.objectContaining({
+              email: "admin@medusa.js",
+            }),
+            expect.objectContaining({ email: "member@test.com" }),
+          ]),
+          count: 2,
+          offset: 0,
+          limit: 50,
+        })
+      })
     })
-  })
+  },
 })

integration-tests/modules/__tests__/users/retrieve-user.spec.ts

@@ -1,13 +1,7 @@
-import { initDb, useDb } from "../../../environment-helpers/use-db"
-
-import { AxiosInstance } from "axios"
 import { IUserModuleService } from "@medusajs/types"
 import { ModuleRegistrationName } from "@medusajs/modules-sdk"
 import { createAdminUser } from "../../helpers/create-admin-user"
-import { getContainer } from "../../../environment-helpers/use-container"
-import path from "path"
-import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
-import { useApi } from "../../../environment-helpers/use-api"
+import { medusaIntegrationTestRunner } from "medusa-test-utils"
 
 jest.setTimeout(50000)
 
@@ -16,47 +10,34 @@ const adminHeaders = {
   headers: { "x-medusa-access-token": "test_token" },
 }
 
-describe("GET /admin/users/:id", () => {
-  let dbConnection
-  let appContainer
-  let shutdownServer
-  let userModuleService: IUserModuleService
+medusaIntegrationTestRunner({
+  env,
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    describe("GET /admin/users/:id", () => {
+      let appContainer
+      let userModuleService: IUserModuleService
 
-  beforeAll(async () => {
-    const cwd = path.resolve(path.join(__dirname, "..", ".."))
-    dbConnection = await initDb({ cwd, env } as any)
-    shutdownServer = await startBootstrapApp({ cwd, env })
-    appContainer = getContainer()
-    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
-  })
+      beforeAll(async () => {
+        appContainer = getContainer()
+        userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+      })
 
-  beforeEach(async () => {
-    await createAdminUser(dbConnection, adminHeaders)
-  })
+      beforeEach(async () => {
+        await createAdminUser(dbConnection, adminHeaders, appContainer)
+      })
 
-  afterAll(async () => {
-    const db = useDb()
-    await db.shutdown()
-    await shutdownServer()
-  })
+      it("should retrieve a single user", async () => {
+        const user = await userModuleService.create({
+          email: "member@test.com",
+        })
 
-  afterEach(async () => {
-    const db = useDb()
-    await db.teardown()
-  })
+        const response = await api.get(`/admin/users/${user.id}`, adminHeaders)
 
-  it("should retrieve a single user", async () => {
-    const user = await userModuleService.create({
-      email: "member@test.com",
+        expect(response.status).toEqual(200)
+        expect(response.data.user).toEqual(
+          expect.objectContaining({ email: "member@test.com" })
+        )
+      })
     })
-
-    const api = useApi()! as AxiosInstance
-
-    const response = await api.get(`/admin/users/${user.id}`, adminHeaders)
-
-    expect(response.status).toEqual(200)
-    expect(response.data.user).toEqual(
-      expect.objectContaining({ email: "member@test.com" })
-    )
-  })
+  },
 })

integration-tests/modules/__tests__/users/update-user.spec.ts

@@ -1,13 +1,7 @@
-import { initDb, useDb } from "../../../environment-helpers/use-db"
-
-import { AxiosInstance } from "axios"
 import { IUserModuleService } from "@medusajs/types"
 import { ModuleRegistrationName } from "@medusajs/modules-sdk"
 import { createAdminUser } from "../../helpers/create-admin-user"
-import { getContainer } from "../../../environment-helpers/use-container"
-import path from "path"
-import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
-import { useApi } from "../../../environment-helpers/use-api"
+import { medusaIntegrationTestRunner } from "medusa-test-utils"
 
 jest.setTimeout(50000)
 
@@ -16,53 +10,40 @@ const adminHeaders = {
   headers: { "x-medusa-access-token": "test_token" },
 }
 
-describe("POST /admin/users/:id", () => {
-  let dbConnection
-  let appContainer
-  let shutdownServer
-  let userModuleService: IUserModuleService
+medusaIntegrationTestRunner({
+  env,
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    describe("POST /admin/users/:id", () => {
+      let appContainer
+      let userModuleService: IUserModuleService
 
-  beforeAll(async () => {
-    const cwd = path.resolve(path.join(__dirname, "..", ".."))
-    dbConnection = await initDb({ cwd, env } as any)
-    shutdownServer = await startBootstrapApp({ cwd, env })
-    appContainer = getContainer()
-    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
-  })
+      beforeAll(async () => {
+        appContainer = getContainer()
+        userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+      })
 
-  beforeEach(async () => {
-    await createAdminUser(dbConnection, adminHeaders)
-  })
+      beforeEach(async () => {
+        await createAdminUser(dbConnection, adminHeaders, appContainer)
+      })
 
-  afterAll(async () => {
-    const db = useDb()
-    await db.shutdown()
-    await shutdownServer()
-  })
+      it("should update a single user", async () => {
+        const user = await userModuleService.create({
+          email: "member@test.com",
+        })
 
-  afterEach(async () => {
-    const db = useDb()
-    await db.teardown()
-  })
+        const body = {
+          first_name: "John",
+          last_name: "Doe",
+        }
+        const response = await api.post(
+          `/admin/users/${user.id}`,
+          body,
+          adminHeaders
+        )
 
-  it("should update a single user", async () => {
-    const user = await userModuleService.create({
-      email: "member@test.com",
+        expect(response.status).toEqual(200)
+        expect(response.data.user).toEqual(expect.objectContaining(body))
+      })
     })
-
-    const api = useApi()! as AxiosInstance
-
-    const body = {
-      first_name: "John",
-      last_name: "Doe",
-    }
-    const response = await api.post(
-      `/admin/users/${user.id}`,
-      body,
-      adminHeaders
-    )
-
-    expect(response.status).toEqual(200)
-    expect(response.data.user).toEqual(expect.objectContaining(body))
-  })
+  },
 })