Skip to main content

TestServer

A real Vendure server against which the e2e tests should be run.

Signature

app

propertyINestApplication

constructor

method(vendureConfig: Required<VendureConfig>) => TestServer

init

method(options: TestServerOptions) => Promise<void>

Bootstraps an instance of Vendure server and populates the database according to the options passed in. Should be called in the beforeAll function.

The populated data is saved into an .sqlite file for each test file. On subsequent runs, this file is loaded so that the populate step can be skipped, which speeds up the tests significantly.

bootstrap

method() =>

Bootstraps a Vendure server instance. Generally the .init() method should be used, as that will also populate the test data. However, the bootstrap() method is sometimes useful in tests which need to start and stop a Vendure instance multiple times without re-populating data.

destroy

method() =>

Destroy the Vendure server instance and clean up all resources. Should be called after all tests have run, e.g. in an afterAll function.

Was this chapter helpful?
Report Issue
Edited Feb 25, 2026ยทEdit this page