Skip to main content

TestDatabases

Home > @backstage/backend-test-utils > TestDatabases

Encapsulates the creation of ephemeral test database instances for use inside unit or integration tests.

Signature:

class TestDatabases 

Methods

MethodModifiersDescription
create(options)static

Creates an empty TestDatabases instance, and sets up Jest to clean up all of its acquired resources after all tests finish.

You typically want to create just a single instance like this at the top of your test file or describe block, and then call init many times on that instance inside the individual tests. Spinning up a "physical" database instance takes a considerable amount of time, slowing down tests. But initializing a new logical database inside that instance using init is very fast.

eachSupportedId()
init(id)Returns a fresh, unique, empty logical database on an instance of the given database ID platform.
setDefaults(options)static
supports(id)