Backstage
    Preparing search index...

    Mock implementations of the core services, to be used in tests.

    There are some variations among the services depending on what needs tests might have, but overall there are three main usage patterns:

    1. Creating an actual fake service instance, often with a simplified version of functionality, by calling the mock service itself as a function.
    // The function often accepts parameters that control its behavior
    const foo = mockServices.foo();
    1. Creating a mock service, where all methods are replaced with jest mocks, by calling the service's mock function.
    // You can optionally supply a subset of its methods to implement
    const foo = mockServices.foo.mock({
    someMethod: () => 'mocked result',
    });
    // After exercising your test, you can make assertions on the mock:
    expect(foo.someMethod).toHaveBeenCalledTimes(2);
    expect(foo.otherMethod).toHaveBeenCalledWith(testData);
    1. Creating a service factory that behaves similarly to the mock as per above.
    await startTestBackend({
    features: [
    mockServices.foo.factory({
    someMethod: () => 'mocked result',
    })
    ],
    });

    Namespaces

    auditor
    auth
    cache
    database
    discovery
    events
    httpAuth
    httpRouter
    lifecycle
    logger
    permissions
    permissionsRegistry
    rootConfig
    rootHealth
    rootHttpRouter
    rootInstanceMetadata
    rootLifecycle
    rootLogger
    scheduler
    urlReader
    userInfo

    Functions

    auth
    database
    discovery
    events
    httpAuth
    permissions
    rootConfig
    rootInstanceMetadata
    rootLogger
    scheduler
    userInfo