medusaIntegrationTestRunner Reference

This is a reference to the medusaIntegrationTestRunner function provided by the @medusajs/test-utils package.

Example#

Code
1import { medusaIntegrationTestRunner } from "@medusajs/test-utils"2
3medusaIntegrationTestRunner({4  testSuite: ({ api, getContainer }) => {5    // TODO write tests...6  },7})

Parameters#

Inputobject

Object parameter of test options.

testSuite(options: MedusaSuiteOptions) => void

The Jest tests to run. It accepts Test Suite Parameters

dbNamestringOptional

A name to use for the database. If not specified, the database name will be of the format medusa-<moduleName>-integration-<randomNumber>.

schemastringOptional

The PostgreSQL schema that the database is created in.

Default: public

envRecord<string, any>Optional

Environment variables to pass to the test suite.

debugbooleanOptional

Whether to show database log messages.

Default: false

moduleNamestringOptional

The name of the module being tested. If not specified, a random name will be generated.

medusaConfigFilestringOptional

The path to the medusa-config.ts file, excluding medusa-config.ts. This path is used as the current working directory as well.

Default: cwd (current working directory)

hooksobjectOptional

An object containing hooks to run at different points in the test lifecycle.

Test Suite Parameters#

The function passed to testSuite accepts the following parameters:

Inputobject

Object parameter of test utilities.

apiRecord<string, Function>

A set of methods used to send requests to the Medusa application.

getContainer() => MedusaContainer

A function that returns the Medusa container.

dbConfigRecord<string, string>

The created database's configurations

dbUtilsRecord<string, Function>

A set of methods to manage the database

utilsobject

A set of utility functions for the test suite.

Was this page helpful?