@backstage/backend-test-utils 0.5.0 → 0.6.0-next.0

package/dist/index.d.ts

@@ -1,14 +1,19 @@
 /// <reference types="node" />
 /// <reference types="jest" />
+/// <reference types="qs" />
+/// <reference types="express" />
 import Keyv from 'keyv';
 import { Knex } from 'knex';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { ServiceFactory, ServiceRef, ExtensionPoint, BackendFeature, RootConfigService, LoggerService, TokenManagerService, IdentityService, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, BackstageNonePrincipal, BackstageUserPrincipal, BackstagePrincipalAccessRestrictions, BackstageServicePrincipal } from '@backstage/backend-plugin-api';
+import { ServiceFactory, ServiceRef, ExtensionPoint, BackendFeature, RootConfigService, LoggerService, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, BackstageNonePrincipal, BackstageUserPrincipal, BackstagePrincipalAccessRestrictions, BackstageServicePrincipal } from '@backstage/backend-plugin-api';
 import { Backend } from '@backstage/backend-app-api';
 import * as _backstage_backend_defaults_rootHttpRouter from '@backstage/backend-defaults/rootHttpRouter';
 import { ExtendedHttpServer } from '@backstage/backend-defaults/rootHttpRouter';
 import * as _backstage_plugin_events_node from '@backstage/plugin-events-node';
 import { JsonObject } from '@backstage/types';
+import * as express from 'express';
+import * as qs from 'qs';
+import * as express_serve_static_core from 'express-serve-static-core';
 
 /**
  * The possible caches to test against.
@@ -405,37 +410,27 @@ declare namespace mockServices {
         type Options = {
             data?: JsonObject;
         };
-        const factory: ServiceFactory<RootConfigService, "root", "singleton" | "multiton"> & ((options?: Options | undefined) => ServiceFactory<RootConfigService, "root", "singleton" | "multiton">);
+        const factory: (options?: Options | undefined) => ServiceFactory<RootConfigService, "root", "singleton" | "multiton">;
     }
     function rootLogger(options?: rootLogger.Options): LoggerService;
     namespace rootLogger {
         type Options = {
             level?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         };
-        const factory: ServiceFactory<LoggerService, "root", "singleton" | "multiton"> & ((options?: Options | undefined) => ServiceFactory<LoggerService, "root", "singleton" | "multiton">);
+        const factory: (options?: Options | undefined) => ServiceFactory<LoggerService, "root", "singleton" | "multiton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootLoggerService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootLoggerService>;
     }
-    function tokenManager(): TokenManagerService;
-    namespace tokenManager {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<TokenManagerService, "plugin", "singleton", undefined>;
-        const mock: (partialImpl?: Partial<TokenManagerService> | undefined) => ServiceMock<TokenManagerService>;
-    }
-    function identity(): IdentityService;
-    namespace identity {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<IdentityService, "plugin", "singleton", undefined>;
-        const mock: (partialImpl?: Partial<IdentityService> | undefined) => ServiceMock<IdentityService>;
-    }
     function auth(options?: {
         pluginId?: string;
         disableDefaultAuthPolicy?: boolean;
     }): AuthService;
     namespace auth {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<AuthService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<AuthService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<AuthService> | undefined) => ServiceMock<AuthService>;
     }
     function discovery(): DiscoveryService;
     namespace discovery {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<DiscoveryService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<DiscoveryService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<DiscoveryService> | undefined) => ServiceMock<DiscoveryService>;
     }
     /**
@@ -464,9 +459,9 @@ declare namespace mockServices {
          * the default mock user principal. This behavior can be configured with the
          * `defaultCredentials` option.
          */
-        const factory: ((options?: {
+        const factory: (options?: {
             defaultCredentials?: BackstageCredentials;
-        }) => ServiceFactory<HttpAuthService, "plugin", "singleton">) & ServiceFactory<HttpAuthService, "plugin", "singleton">;
+        }) => ServiceFactory<HttpAuthService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<HttpAuthService> | undefined) => ServiceMock<HttpAuthService>;
     }
     /**
@@ -484,55 +479,55 @@ declare namespace mockServices {
          * By default it extracts the user's entity ref from a user principal and
          * returns that as the only ownership entity ref.
          */
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<UserInfoService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<UserInfoService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<UserInfoService> | undefined) => ServiceMock<UserInfoService>;
     }
     namespace cache {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.CacheService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.CacheService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.CacheService> | undefined) => ServiceMock<_backstage_backend_plugin_api.CacheService>;
     }
     namespace database {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.DatabaseService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.DatabaseService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.DatabaseService> | undefined) => ServiceMock<_backstage_backend_plugin_api.DatabaseService>;
     }
     namespace rootHealth {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.RootHealthService, "root", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.RootHealthService, "root", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootHealthService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootHealthService>;
     }
     namespace httpRouter {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.HttpRouterService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.HttpRouterService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.HttpRouterService> | undefined) => ServiceMock<_backstage_backend_plugin_api.HttpRouterService>;
     }
     namespace rootHttpRouter {
-        const factory: ((options?: _backstage_backend_defaults_rootHttpRouter.RootHttpRouterFactoryOptions | undefined) => ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root", "singleton">) & ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root", "singleton">;
+        const factory: () => ((options?: _backstage_backend_defaults_rootHttpRouter.RootHttpRouterFactoryOptions | undefined) => ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root", "singleton">) & ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootHttpRouterService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootHttpRouterService>;
     }
     namespace lifecycle {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.LifecycleService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.LifecycleService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.LifecycleService> | undefined) => ServiceMock<_backstage_backend_plugin_api.LifecycleService>;
     }
     namespace logger {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<LoggerService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<LoggerService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<LoggerService> | undefined) => ServiceMock<LoggerService>;
     }
     namespace permissions {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.PermissionsService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.PermissionsService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.PermissionsService> | undefined) => ServiceMock<_backstage_backend_plugin_api.PermissionsService>;
     }
     namespace rootLifecycle {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.RootLifecycleService, "root", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.RootLifecycleService, "root", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.RootLifecycleService> | undefined) => ServiceMock<_backstage_backend_plugin_api.RootLifecycleService>;
     }
     namespace scheduler {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.SchedulerService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.SchedulerService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.SchedulerService> | undefined) => ServiceMock<_backstage_backend_plugin_api.SchedulerService>;
     }
     namespace urlReader {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.UrlReaderService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_backend_plugin_api.UrlReaderService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.UrlReaderService> | undefined) => ServiceMock<_backstage_backend_plugin_api.UrlReaderService>;
     }
     namespace events {
-        const factory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_plugin_events_node.EventsService, "plugin", "singleton", undefined>;
+        const factory: () => ServiceFactory<_backstage_plugin_events_node.EventsService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<_backstage_plugin_events_node.EventsService> | undefined) => ServiceMock<_backstage_plugin_events_node.EventsService>;
     }
 }
@@ -644,4 +639,10 @@ declare namespace mockCredentials {
     }
 }
 
-export { type CreateMockDirectoryOptions, type MockDirectory, type MockDirectoryContent, type MockDirectoryContentCallback, type MockDirectoryContentCallbackContext, type MockDirectoryContentOptions, ServiceFactoryTester, type ServiceFactoryTesterOptions, type ServiceMock, type TestBackend, type TestBackendOptions, type TestCacheId, TestCaches, type TestDatabaseId, TestDatabases, createMockDirectory, mockCredentials, mockServices, registerMswTestHooks, startTestBackend };
+/**
+ * A mock for error handler middleware that can be used in router tests.
+ * @public
+ */
+declare function mockErrorHandler(): express.ErrorRequestHandler<express_serve_static_core.ParamsDictionary, any, any, qs.ParsedQs, Record<string, any>>;
+
+export { type CreateMockDirectoryOptions, type MockDirectory, type MockDirectoryContent, type MockDirectoryContentCallback, type MockDirectoryContentCallbackContext, type MockDirectoryContentOptions, ServiceFactoryTester, type ServiceFactoryTesterOptions, type ServiceMock, type TestBackend, type TestBackendOptions, type TestCacheId, TestCaches, type TestDatabaseId, TestDatabases, createMockDirectory, mockCredentials, mockErrorHandler, mockServices, registerMswTestHooks, startTestBackend };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-test-utils",
-  "version": "0.5.0",
+  "version": "0.6.0-next.0",
   "description": "Test helpers library for Backstage backends",
   "backstage": {
     "role": "node-library"
@@ -42,17 +42,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-app-api": "^0.9.0",
-    "@backstage/backend-defaults": "^0.4.2",
-    "@backstage/backend-plugin-api": "^0.8.0",
+    "@backstage/backend-app-api": "^0.10.0-next.0",
+    "@backstage/backend-defaults": "^0.5.0-next.0",
+    "@backstage/backend-plugin-api": "^0.9.0-next.0",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.5.0",
-    "@backstage/plugin-events-node": "^0.3.9",
+    "@backstage/plugin-auth-node": "^0.5.2-next.0",
+    "@backstage/plugin-events-node": "^0.4.0-next.0",
     "@backstage/types": "^1.1.1",
     "@keyv/memcache": "^1.3.5",
     "@keyv/redis": "^2.5.3",
+    "@types/express": "^4.17.6",
+    "@types/express-serve-static-core": "^4.17.5",
     "@types/keyv": "^4.2.0",
+    "@types/qs": "^6.9.6",
     "better-sqlite3": "^11.0.0",
     "cookie": "^0.6.0",
     "express": "^4.17.1",
@@ -69,7 +72,7 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.27.0",
+    "@backstage/cli": "^0.27.1-next.0",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   },