backend-test-utils: mark backend system utils as stable

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-02-14 10:51:23 +01:00
parent c3c928db92
commit 17b573e4be
4 changed files with 13 additions and 8 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-test-utils': patch
---
The new backend system testing utilities have now been marked as stable API.
+4 -4
View File
@@ -28,7 +28,7 @@ import { UrlReaderService } from '@backstage/backend-plugin-api';
// @public (undocumented)
export function isDockerDisabledForTests(): boolean;
// @alpha (undocumented)
// @public (undocumented)
export namespace mockServices {
// (undocumented)
export namespace cache {
@@ -126,7 +126,7 @@ export function setupRequestMockHandlers(worker: {
resetHandlers: () => void;
}): void;
// @alpha (undocumented)
// @public (undocumented)
export function startTestBackend<
TServices extends any[],
TExtensionPoints extends any[],
@@ -134,12 +134,12 @@ export function startTestBackend<
options: TestBackendOptions<TServices, TExtensionPoints>,
): Promise<TestBackend>;
// @alpha (undocumented)
// @public (undocumented)
export interface TestBackend extends Backend {
readonly server: ExtendedHttpServer;
}
// @alpha (undocumented)
// @public (undocumented)
export interface TestBackendOptions<
TServices extends any[],
TExtensionPoints extends any[],
@@ -58,7 +58,7 @@ function simpleFactory<
}
/**
* @alpha
* @public
*/
export namespace mockServices {
export function config(options?: config.Options): ConfigService {
@@ -36,7 +36,7 @@ import { mockServices } from '../services';
import { ConfigReader } from '@backstage/config';
import express from 'express';
/** @alpha */
/** @public */
export interface TestBackendOptions<
TServices extends any[],
TExtensionPoints extends any[],
@@ -60,7 +60,7 @@ export interface TestBackendOptions<
features?: BackendFeature[];
}
/** @alpha */
/** @public */
export interface TestBackend extends Backend {
/**
* Provides access to the underling HTTP server for use with utilities
@@ -89,7 +89,7 @@ const defaultServiceFactories = [
const backendInstancesToCleanUp = new Array<Backend>();
/** @alpha */
/** @public */
export async function startTestBackend<
TServices extends any[],
TExtensionPoints extends any[],