mockApis
Home > @backstage/test-utils
> mockApis
Mock implementations of the core utility APIs, to be used in tests.
Signature:
namespace mockApis
Remarks
There are some variations among the APIs depending on what needs tests might have, but overall there are three main usage patterns:
1: Creating an actual fake API instance, often with a simplified version of functionality, by calling the mock API itself as a function.
// The function often accepts parameters that control its behavior
const foo = mockApis.foo();
2: Creating a mock API, where all methods are replaced with jest mocks, by calling the API's mock
function.
// You can optionally supply a subset of its methods to implement
const foo = mockApis.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);
3: Creating an API factory that behaves similarly to the mock as per above.
const factory = mockApis.foo.factory({
someMethod: () => 'mocked result',
});
Functions
Function |
Description |
---|---|
Mock implementation of AnalyticsApi. | |
Fake implementation of ConfigApi with optional data supplied. | |
Fake implementation of DiscoveryApi. By default returns URLs on the form | |
Fake implementation of IdentityApi. By default returns no token or profile info, and the user | |
Fake implementation of PermissionApi. By default allows all actions. | |
Fake implementation of StorageApi. Stores data temporarily in memory. | |
Fake implementation of . By default returns the default translation. |
Namespaces
Namespace |
Description |
---|---|
Mock implementations of AnalyticsApi. | |
Mock helpers for ConfigApi. | |
Mock implementations of DiscoveryApi. | |
Mock implementations of IdentityApi. | |
Mock implementation of PermissionApi. | |
Mock implementations of StorageApi. | |
Mock implementations of . |