moduleIntegrationTestRunner Reference

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

Example#

Code
1import { moduleIntegrationTestRunner } from "@medusajs/test-utils"2import { BLOG_MODULE } from ".."3import BlogModuleService from "../service"4import Post from "../models/post"5
6moduleIntegrationTestRunner<BlogModuleService>({7  moduleName: BLOG_MODULE,8  moduleModels: [Post],9  resolve: "./src/modules/blog",10  testSuite: ({ service }) => {11    // TODO write tests12  },13})

Parameters#

Inputobject

Object parameter of test options.

moduleNamestring

The module's name.

resolvestring

The path to the module relative to the src directory.

testSuite() => void

The Jest tests to run.

moduleModelsDmlEntity[]Optional

The module's data models.

moduleOptionsRecord<string, any>Optional

Options to pass to the module.

injectedDependenciesRecord<string, any>Optional

Dependencies to inject into the module's container. The key is the registration name, and the value is the instance of the dependency.

schemastringOptional

The PostgreSQL schema that the database is created in.

debugbooleanOptional

Whether to show database log messages.

Default: false

cwdstringOptional

The current working directory. If not set, the directory that you run the test command from is considered the current working directory.

Test Suite Parameters#

The function passed to testSuite accepts the following parameters:

Inputobject

Object parameter of test utilities.

serviceany

An instance of the module's main service. Its type is the type argument passed to the moduleIntegrationTestRunner function.

dbConfigRecord<string, string>

The created database's configurations

MikroOrmWrapperTestDatabase

Utility functions to query and manage the database.

Was this page helpful?