Class TestUtils

Test utils has a collection of helper methods to make testing experience great for AdonisJS applications. It provides utilities for HTTP testing, context creation, and cookie handling.

Example

const testUtils = new TestUtils(app)
await testUtils.boot()

const ctx = await testUtils.createHttpContext()
const httpUtils = testUtils.httpServer()

Hierarchy

default
- TestUtils

Index

Constructors

constructor

new TestUtils(app: ApplicationService): TestUtils
Creates a new TestUtils instance
Parameters
- app: ApplicationService
  The application service instance
Returns TestUtils
Overrides Macroable.constructor
- Defined in src/test_utils/main.ts:53

Properties

cookies

cookies: CookieClient

Cookie client instance for handling cookies in tests

app

app: ApplicationService

The application service instance

Accessors

isBooted

get isBooted(): boolean
Check if utils have been booted

Returns boolean
- Defined in src/test_utils/main.ts:39

Methods

boot

boot(): Promise<void>
Boot test utils. It requires the app to be booted and container to have all the bindings

Returns Promise<void>
- Defined in src/test_utils/main.ts:61

httpServer

httpServer(): HttpServerUtils
Returns an instance of the HTTP server testing utils

Returns HttpServerUtils
- Defined in src/test_utils/main.ts:72

createHttpContext

createHttpContext(
    options?: {
        req?: IncomingMessage;
        res?: ServerResponse<IncomingMessage>;
    },
): Promise<HttpContext>
Create an instance of HTTP context for testing
Parameters
- options: { req?: IncomingMessage; res?: ServerResponse<IncomingMessage> } = {}
  Options for creating HTTP context with custom req/res objects
Returns Promise<HttpContext>
- Defined in src/test_utils/main.ts:81

Class TestUtils

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TestUtils

Properties

cookies

app

Accessors

isBooted

Returns boolean

Methods

boot

Returns Promise<void>

httpServer

Returns HttpServerUtils

createHttpContext

Parameters

Returns Promise<HttpContext>

Settings

On This Page