@loopback/testlab

Variables

• expect

Functions

• createClientForHandler()
• createRestAppClient()
• createStubInstance()
• createUnexpectedHttpErrorLogger()
• givenHttpServerConfig()
• httpGetAsync()
• httpsGetAsync()
• inject()
• skipIf()
• skipOnTravis()
• stubExpressContext()
• stubHandlerContext()
• stubServerRequest()
• stubServerResponse()
• toJSON()
• validateApiSpec()

Classes

• TestSandbox

  • copyFile()
  • delete()
  • mkdir()
  • path
  • reset()
  • writeJsonFile()
  • writeTextFile()

Interfaces

• ExpressContextStub

  • app
  • request
  • response
  • result
• HandlerContextStub

  • request
  • response
  • result
• HostPort

  • host
  • port
• HttpOptions

  • protocol
• HttpsOptions

  • protocol
• RestApplicationLike

  • restServer
• RestServerLike

  • rootUrl
  • url
• TestSandboxOptions

  • subdir

Type Aliases

• Client
• ObservedResponse
• ShotCallback
• ShotResponseCtor
• StubbedInstanceWithSinonAccessor
• TestDefinition

Namespaces

• should

  • should

variable expect

const expect: Internal;

function createClientForHandler

createClientForHandler: (
    handler: (req: http.IncomingMessage, res: http.ServerResponse) => void
) => supertest.SuperTest<supertest.Test>;

• Create a SuperTest client connected to an HTTP server listening on an ephemeral port and calling handler to handle incoming requests.

  Parameter handler

function createRestAppClient

createRestAppClient: (
    app: RestApplicationLike
) => supertest.SuperTest<supertest.Test>;

• Create a SuperTest client for a running RestApplication instance. It is the responsibility of the caller to ensure that the app is running and to stop the application after all tests are done.

  Parameter app

  A running (listening) instance of a RestApplication.

function createStubInstance

createStubInstance: <TType extends object>(
    constructor: sinon.StubbableType<TType>
) => StubbedInstanceWithSinonAccessor<TType>;

• Creates a new object with the given functions as the prototype and stubs all implemented functions.

  Note: The given constructor function is not invoked. See also the stub API.

  This is a helper method replacing sinon.createStubInstance and working around the limitations of TypeScript and Sinon, where Sinon is not able to list private/protected members in the type definition of the stub instance and therefore the stub instance cannot be assigned to places expecting TType. See also - https://github.com/Microsoft/TypeScript/issues/13543 - https://github.com/DefinitelyTyped/DefinitelyTyped/issues/14811

  Parameter constructor

  Object or class to stub.

  Returns

  A stubbed version of the constructor, with an extra property stubs providing access to stub API for individual methods.

function createUnexpectedHttpErrorLogger

createUnexpectedHttpErrorLogger: (expectedStatusCode?: number) => LogError;

• Creates a Logger that logs an Error if the HTTP status code is not expected

  Parameter expectedStatusCode

  HTTP status code that is expected

function givenHttpServerConfig

givenHttpServerConfig: <T extends HttpOptions | HttpsOptions>(
    customConfig?: T
) => HostPort & T;

• Create an HTTP-server configuration that works well in test environments. - Ask the operating system to assign a free (ephemeral) port. - Use IPv4 localhost 127.0.0.1 to avoid known IPv6 issues in Docker-based environments like Travis-CI. - Provide default TLS key & cert when protocol is set to https.

  Parameter customConfig

  Additional configuration options to apply.

function httpGetAsync

httpGetAsync: (
    urlString: string,
    agent?: http.Agent
) => Promise<IncomingMessage>;

• Async wrapper for making HTTP GET requests

  Parameter urlString

function httpsGetAsync

httpsGetAsync: (
    urlString: string,
    agent?: https.Agent
) => Promise<IncomingMessage>;

• Async wrapper for making HTTPS GET requests

  Parameter urlString

function inject

inject: (
    dispatchFunc: ShotListener,
    options: ShotRequestOptions
) => Promise<ResponseObject>;

function skipIf

skipIf: <ARGS extends unknown[], RETVAL>(
    skip: boolean,
    verb: TestDefinition<ARGS, RETVAL> & { skip: TestDefinition<ARGS, RETVAL> },
    name: string,
    ...args: ARGS
) => RETVAL;

• Helper function for skipping tests when a certain condition is met.

  Parameter skip

  Should the test case/suite be skipped?

  Parameter verb

  The function to invoke to define the test case or the test suite, e.g. it or describe.

  Parameter name

  The test name (the first argument of verb function).

  Parameter args

  Additional arguments (framework specific), typically a function implementing the test.

  Example 1

  skipIf(
    !features.freeFormProperties,
    describe,
   'free-form properties (strict: false)',
    () => {
      // the tests
    }
  );

function skipOnTravis

skipOnTravis: <ARGS extends unknown[], RETVAL>(
    verb: TestDefinition<ARGS, RETVAL> & { skip: TestDefinition<ARGS, RETVAL> },
    name: string,
    ...args: ARGS
) => RETVAL;

• Helper function for skipping tests on Travis CI.

  Parameter verb

  The function to invoke to define the test case or the test suite, e.g. it or describe.

  Parameter name

  The test name (the first argument of verb function).

  Parameter args

  Additional arguments (framework specific), typically a function implementing the test.

  Example 1

  skipOnTravis(it, 'does something when some condition', async () => {
    // the test
  });

function stubExpressContext

stubExpressContext: (requestOptions?: ShotRequestOptions) => ExpressContextStub;

function stubHandlerContext

stubHandlerContext: (requestOptions?: ShotRequestOptions) => HandlerContextStub;

function stubServerRequest

stubServerRequest: (options: ShotRequestOptions) => IncomingMessage;

function stubServerResponse

stubServerResponse: (
    request: IncomingMessage,
    onEnd: ShotCallback
) => ServerResponse;

function toJSON

toJSON: {
    (value: Date): string;
    (value: Function): undefined;
    (value: unknown[]): unknown[];
    (value: object): object;
    (value: undefined): undefined;
    (value: null): null;
    (value: number): number;
    (value: boolean): boolean;
    (value: string): string;
    (value: unknown[]): unknown[];
    (value: unknown[]): unknown[];
    (value: unknown[]): unknown[];
    (value: object): object;
    (value: object): object;
    (value: object): object;
};

• JSON encoding does not preserve properties that are undefined As a result, deepEqual checks fail because the expected model value contains these undefined property values, while the actual result returned by REST API does not. Use this function to convert a model instance into a data object as returned by REST API

function validateApiSpec

validateApiSpec: (spec: any) => Promise<void>;

type Client

type Client = supertest.SuperTest<supertest.Test>;

type ObservedResponse

type ObservedResponse = ResponseObject;

type ShotCallback

type ShotCallback = (response: ResponseObject) => void;

type ShotResponseCtor

type ShotResponseCtor = new (
    request: IncomingMessage,
    onEnd: ShotCallback
) => ServerResponse;

type StubbedInstanceWithSinonAccessor

type StubbedInstanceWithSinonAccessor<T> = T & {
    stubs: sinon.SinonStubbedInstance<T>;
};

type TestDefinition

type TestDefinition<ARGS extends unknown[], RETVAL> = (
    name: string,
    ...args: ARGS
) => RETVAL;

• A function defining a new test case or a test suite, e.g. it or describe.