docs: added documentation on testing tools (#8939)
- Added documentation on how to use Medusa's tools from the `medusa-test-utils` package to create integration and unit tests. - Added a manual reference on the `medusaIntegrationTestRunner` and `moduleIntegrationTestRunner` functions. Since the typings in the source code aren't very informative, I opted for a manual reference shedding light on the important bits. Closes DOCS-852
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,152 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
export const metadata = {
|
||||
title: `medusaIntegrationTestRunner Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This document provides a reference to the `medusaIntegrationTestRunner` function provided by the `medusa-test-utils` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import { medusaIntegrationTestRunner } from "medusa-test-utils"
|
||||
|
||||
medusaIntegrationTestRunner({
|
||||
testSuite: ({ api, getContainer }) => {
|
||||
// TODO write tests...
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList
|
||||
types={[
|
||||
{
|
||||
type: "`object`",
|
||||
name: "Input",
|
||||
description: "Object parameter of test options.",
|
||||
children: [
|
||||
{
|
||||
type: "`() => void`",
|
||||
name: "testSuite",
|
||||
description: "The Jest tests to run.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
type: "`string`",
|
||||
name: "dbName",
|
||||
description: "A name to use for the database. By default, a random name is generated.",
|
||||
},
|
||||
{
|
||||
type: "`string`",
|
||||
name: "schema",
|
||||
description: "The PostgreSQL schema that the database is created in.",
|
||||
},
|
||||
{
|
||||
type: "`Record<string, any>`",
|
||||
name: "env",
|
||||
description: "Environment variables to use in the test suite."
|
||||
},
|
||||
{
|
||||
type: "`boolean`",
|
||||
name: "debug",
|
||||
description: "Whether to show database log messages.",
|
||||
defaultValue: "false"
|
||||
}
|
||||
]
|
||||
}
|
||||
]}
|
||||
sectionTitle="Parameters"
|
||||
/>
|
||||
|
||||
## Test Suite Parameters
|
||||
|
||||
The function passed to `testSuite` accepts the following parameters:
|
||||
|
||||
<TypeList
|
||||
types={[
|
||||
{
|
||||
type: "`object`",
|
||||
name: "Input",
|
||||
description: "Object parameter of test utilities.",
|
||||
children: [
|
||||
{
|
||||
type: "Record<string, Function>",
|
||||
name: "api",
|
||||
description: "A set of methods used to send requests to the Medusa application.",
|
||||
optional: false,
|
||||
children: [
|
||||
{
|
||||
type: "(path: string) => Promise<any>",
|
||||
name: "get",
|
||||
description: "Send a GET request to the specified path."
|
||||
},
|
||||
{
|
||||
type: "(path: string, data?: any) => Promise<any>",
|
||||
name: "post",
|
||||
description: "Send a POST request to the specified path."
|
||||
},
|
||||
{
|
||||
type: "(path: string) => Promise<any>",
|
||||
name: "delete",
|
||||
description: "Send a DELETE request to the specified path."
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "`() => MedusaContainer`",
|
||||
name: "getContainer",
|
||||
description: "A name to use for the database. By default, a random name is generated.",
|
||||
},
|
||||
{
|
||||
type: "`Record<string, string>`",
|
||||
name: "dbConfig",
|
||||
description: "The created database's configurations",
|
||||
children: [
|
||||
{
|
||||
type: "`string`",
|
||||
name: "dbName",
|
||||
description: "The database's name."
|
||||
},
|
||||
{
|
||||
type: "`string`",
|
||||
name: "schema",
|
||||
description: "The PostgreSQL schema the database is created in."
|
||||
},
|
||||
{
|
||||
type: "`string`",
|
||||
name: "clientUrl",
|
||||
description: "The connection URL to the database."
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "`Record<string, Function>`",
|
||||
name: "dbUtils",
|
||||
description: "A set of methods to manage the database",
|
||||
children: [
|
||||
{
|
||||
type: "`(dbName: string) => Promise<void>`",
|
||||
name: "create",
|
||||
description: "Creates a database."
|
||||
},
|
||||
{
|
||||
type: "`(options: { schema?: string }) => Promise<void>`",
|
||||
name: "teardown",
|
||||
description: "Deletes all data in a database's tables."
|
||||
},
|
||||
{
|
||||
type: "`(dbName: string) => Promise<void>`",
|
||||
name: "shutdown",
|
||||
description: "Drops a database."
|
||||
},
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]}
|
||||
sectionTitle="Test Suite Parameters"
|
||||
/>
|
||||
@@ -0,0 +1,154 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
export const metadata = {
|
||||
title: `moduleIntegrationTestRunner Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This document provides a reference to the `moduleIntegrationTestRunner` function provided by the `medusa-test-utils` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import { moduleIntegrationTestRunner } from "medusa-test-utils"
|
||||
import { HELLO_MODULE } from ".."
|
||||
import HelloModuleService from "../service"
|
||||
import MyCustom from "../models/my-custom"
|
||||
|
||||
moduleIntegrationTestRunner<HelloModuleService>({
|
||||
moduleName: HELLO_MODULE,
|
||||
moduleModels: [MyCustom],
|
||||
resolve: "./modules/hello",
|
||||
testSuite: ({ service }) => {
|
||||
// TODO write tests
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList
|
||||
types={[
|
||||
{
|
||||
type: "`object`",
|
||||
name: "Input",
|
||||
description: "Object parameter of test options.",
|
||||
children: [
|
||||
{
|
||||
type: "`string`",
|
||||
name: "moduleName",
|
||||
description: "The module's name.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
type: "DmlEntity[]",
|
||||
name: "moduleModels",
|
||||
description: "The module's data models.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
type: "string",
|
||||
name: "resolve",
|
||||
description: "The path to the module relative to the `src` directory.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
type: "`() => void`",
|
||||
name: "testSuite",
|
||||
description: "The Jest tests to run.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
type: "`Record<string, any>`",
|
||||
name: "moduleOptions",
|
||||
description: "Options to pass to the module.",
|
||||
},
|
||||
{
|
||||
type: "`Record<string, any>`",
|
||||
name: "injectedDependencies",
|
||||
description: "Dependencies to inject into the module's container. They key is the registration name, and the value is the instance of the dependency.",
|
||||
},
|
||||
{
|
||||
type: "`string`",
|
||||
name: "schema",
|
||||
description: "The PostgreSQL schema that the database is created in.",
|
||||
},
|
||||
{
|
||||
type: "`boolean`",
|
||||
name: "debug",
|
||||
description: "Whether to show database log messages.",
|
||||
defaultValue: "false"
|
||||
}
|
||||
]
|
||||
}
|
||||
]}
|
||||
sectionTitle="Parameters"
|
||||
/>
|
||||
|
||||
## Test Suite Parameters
|
||||
|
||||
The function passed to `testSuite` accepts the following parameters:
|
||||
|
||||
<TypeList
|
||||
types={[
|
||||
{
|
||||
type: "`object`",
|
||||
name: "Input",
|
||||
description: "Object parameter of test utilities.",
|
||||
children: [
|
||||
{
|
||||
type: "any",
|
||||
name: "service",
|
||||
description: "An instance of the module's main service. Its type is the type argument passed to the `moduleIntegrationTestRunner` function.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
type: "`Record<string, string>`",
|
||||
name: "dbConfig",
|
||||
description: "The created database's configurations",
|
||||
children: [
|
||||
{
|
||||
type: "`string`",
|
||||
name: "schema",
|
||||
description: "The PostgreSQL schema the database is created in."
|
||||
},
|
||||
{
|
||||
type: "`string`",
|
||||
name: "clientUrl",
|
||||
description: "The connection URL to the database."
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "`TestDatabase`",
|
||||
name: "MikroOrmWrapper",
|
||||
description: "Utility functions to query and manage the database.",
|
||||
children: [
|
||||
{
|
||||
type: `[SqlEntityManager](https://mikro-orm.io/api/5.9/knex/class/EntityManager)`,
|
||||
name: "manager",
|
||||
description: "An instance of MikroORM's entity manager, which can be used to run queries and perform other database tasks."
|
||||
},
|
||||
{
|
||||
type: "`() => Promise<void>`",
|
||||
name: "setupDatabase",
|
||||
description: "Creates the database for the test."
|
||||
},
|
||||
{
|
||||
type: "`() => Promise<void>`",
|
||||
name: "clearDatabase",
|
||||
description: "Removes all data in the database's tables."
|
||||
},
|
||||
{
|
||||
type: "`() => SqlEntityManager`",
|
||||
name: "forkManager",
|
||||
description: "Returns a new entity manager."
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]}
|
||||
sectionTitle="Test Suite Parameters"
|
||||
/>
|
||||
@@ -0,0 +1,11 @@
|
||||
import { ChildDocs } from "docs-ui"
|
||||
|
||||
export const metadata = {
|
||||
title: `Medusa Test Functions Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This section of the documentation provides a reference to the testing functions provided by the `medusa-test-utils` package.
|
||||
|
||||
<ChildDocs />
|
||||
Reference in New Issue
Block a user