@tsed/platform-http/lib/esm/testing/PlatformTest.js

A TypeScript Framework on top of Express

import { DITest, injector } from "@tsed/di";
import accepts from "accepts";
import { PlatformBuilder } from "../common/builder/PlatformBuilder.js";
import { PlatformContext } from "../common/domain/PlatformContext.js";
import { adapter } from "../common/index.js";
import { PlatformAdapter } from "../common/services/PlatformAdapter.js";
import { PlatformApplication } from "../common/services/PlatformApplication.js";
import { createInjector } from "../common/utils/createInjector.js";
import { getConfiguration } from "../common/utils/getConfiguration.js";
import { FakeAdapter } from "./FakeAdapter.js";
import { FakeResponse } from "./FakeResponse.js";
/**
 * @platform
 */
export class PlatformTest extends DITest {
    static async create(settings = {}) {
        settings.imports = [
            {
                token: PlatformAdapter,
                useClass: FakeAdapter
            },
            ...(settings.imports || [])
        ];
        PlatformTest.createInjector(getConfiguration(settings));
        await DITest.createContainer();
    }
    /**
     * Create a new injector with the right default services
     */
    static createInjector(settings = {}) {
        return createInjector(DITest.configure({ httpPort: false, httpsPort: false, ...settings }));
    }
    /**
     * Load the server silently without listening port and configure it on test profile.
     * @decorator
     * @param mod
     * @param listen
     * @param settings
     * @returns {Promise<void>}
     */
    static bootstrap(mod, { listen, ...settings } = {}) {
        return async function before() {
            let instance;
            // @ts-ignore
            settings = DITest.configure(settings);
            adapter(settings.adapter || adapter());
            const configuration = getConfiguration(settings, mod);
            instance = await PlatformBuilder.build(mod, configuration).bootstrap();
            await instance.listen(!!listen);
        };
    }
    /**
     * It injects services into the test function where you can alter, spy on, and manipulate them.
     *
     * The inject function has two parameters
     *
     * * an array of Service dependency injection tokens,
     * * a test function whose parameters correspond exactly to each item in the injection token array.
     *
     * @deprecated use PlatformTest.injector.invoke instead
     * @param targets
     * @param func
     */
    static inject(targets, func) {
        return async () => {
            await PlatformTest.create();
            const inj = injector();
            const deps = [];
            for (const target of targets) {
                deps.push(inj.has(target) ? inj.get(target) : await inj.invoke(target));
            }
            return func(...deps);
        };
    }
    /**
     * Return the raw application (express or koa).
     * Use this callback with SuperTest.
     *
     * ```typescript
     * let request: SuperTest.Agent;
     * beforeEach(PlatformTest.bootstrap(Server, {
     *   mount: {
     *     "/rest": [ProductsController]
     *   }
     * }));
     * beforeEach(() => {
     *   request = SuperTest(PlatformTest.callback());
     * });
     * ```
     */
    static callback() {
        return injector().get(PlatformApplication)?.callback();
    }
    static createRequest(options = {}) {
        return {
            headers: {},
            method: "GET",
            url: "/",
            query: {},
            get(key) {
                return this.headers[key.toLowerCase()];
            },
            accepts(mime) {
                return accepts(this).types([].concat(mime));
            },
            ...options
        };
    }
    static createResponse(options = {}) {
        return new FakeResponse(options);
    }
    static createRequestContext(options = {}) {
        const event = {
            ...options.event,
            request: options?.request?.request || options?.event?.request || PlatformTest.createRequest(),
            response: options?.response?.response || options?.event?.response || PlatformTest.createResponse()
        };
        const $ctx = new PlatformContext({
            id: "id",
            url: "/",
            ...options,
            event
        });
        if (options.endpoint) {
            $ctx.endpoint = options.endpoint;
        }
        return $ctx;
    }
}