@backstage/backend-test-utils 0.3.9-next.0 → 0.4.0-next.2

package/dist/index.d.ts

@@ -1,15 +1,67 @@
 /// <reference types="node" />
 /// <reference types="jest" />
+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, BackstageServicePrincipal } 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 * as _backstage_backend_app_api from '@backstage/backend-app-api';
 import { Backend, ExtendedHttpServer } from '@backstage/backend-app-api';
 import * as _backstage_plugin_events_node from '@backstage/plugin-events-node';
 import { JsonObject } from '@backstage/types';
 
-/** @public */
-declare function isDockerDisabledForTests(): boolean;
+/**
+ * The possible caches to test against.
+ *
+ * @public
+ */
+type TestCacheId = 'MEMORY' | 'REDIS_7' | 'MEMCACHED_1';
+
+/**
+ * Encapsulates the creation of ephemeral test cache instances for use inside
+ * unit or integration tests.
+ *
+ * @public
+ */
+declare class TestCaches {
+    private readonly instanceById;
+    private readonly supportedIds;
+    private static defaultIds?;
+    /**
+     * Creates an empty `TestCaches` instance, and sets up Jest to clean up all of
+     * its acquired resources after all tests finish.
+     *
+     * You typically want to create just a single instance like this at the top of
+     * your test file or `describe` block, and then call `init` many times on that
+     * instance inside the individual tests. Spinning up a "physical" cache
+     * instance takes a considerable amount of time, slowing down tests. But
+     * wiping the contents of an instance using `init` is very fast.
+     */
+    static create(options?: {
+        ids?: TestCacheId[];
+        disableDocker?: boolean;
+    }): TestCaches;
+    static setDefaults(options: {
+        ids?: TestCacheId[];
+    }): void;
+    private constructor();
+    supports(id: TestCacheId): boolean;
+    eachSupportedId(): [TestCacheId][];
+    /**
+     * Returns a fresh, empty cache for the given driver.
+     *
+     * @param id - The ID of the cache to use, e.g. 'REDIS_7'
+     * @returns Cache connection properties
+     */
+    init(id: TestCacheId): Promise<{
+        store: string;
+        connection: string;
+        keyv: Keyv;
+    }>;
+    private initAny;
+    private initMemcached;
+    private initRedis;
+    private shutdown;
+}
 
 /**
  * The possible databases to test against.
@@ -25,7 +77,8 @@ type TestDatabaseId = 'POSTGRES_16' | 'POSTGRES_15' | 'POSTGRES_14' | 'POSTGRES_
  * @public
  */
 declare class TestDatabases {
-    private readonly instanceById;
+    private readonly engineFactoryByDriver;
+    private readonly engineByTestDatabaseId;
     private readonly supportedIds;
     private static defaultIds?;
     /**
@@ -57,10 +110,6 @@ declare class TestDatabases {
      * @returns A `Knex` connection object
      */
     init(id: TestDatabaseId): Promise<Knex>;
-    private initAny;
-    private initPostgres;
-    private initMysql;
-    private initSqlite;
     private shutdown;
 }
 
@@ -559,9 +608,9 @@ declare namespace mockCredentials {
     /**
      * Creates a mocked credentials object for a service principal.
      *
-     * The default subject is 'external:test-service'.
+     * The default subject is 'external:test-service', and no access restrictions.
      */
-    function service(subject?: string): BackstageCredentials<BackstageServicePrincipal>;
+    function service(subject?: string, accessRestrictions?: BackstagePrincipalAccessRestrictions): BackstageCredentials<BackstageServicePrincipal>;
     /**
      * Utilities related to service credentials.
      */
@@ -590,4 +639,7 @@ declare namespace mockCredentials {
     }
 }
 
-export { type MockDirectory, type MockDirectoryContent, type MockDirectoryContentCallback, type MockDirectoryContentCallbackContext, type MockDirectoryContentOptions, type MockDirectoryOptions, ServiceFactoryTester, type ServiceFactoryTesterOptions, type ServiceMock, type TestBackend, type TestBackendOptions, type TestDatabaseId, TestDatabases, createMockDirectory, isDockerDisabledForTests, mockCredentials, mockServices, setupRequestMockHandlers, startTestBackend };
+/** @public */
+declare function isDockerDisabledForTests(): boolean;
+
+export { type MockDirectory, type MockDirectoryContent, type MockDirectoryContentCallback, type MockDirectoryContentCallbackContext, type MockDirectoryContentOptions, type MockDirectoryOptions, ServiceFactoryTester, type ServiceFactoryTesterOptions, type ServiceMock, type TestBackend, type TestBackendOptions, type TestCacheId, TestCaches, type TestDatabaseId, TestDatabases, createMockDirectory, isDockerDisabledForTests, mockCredentials, mockServices, setupRequestMockHandlers, startTestBackend };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-test-utils",
-  "version": "0.3.9-next.0",
+  "version": "0.4.0-next.2",
   "description": "Test helpers library for Backstage backends",
   "backstage": {
     "role": "node-library"
@@ -42,28 +42,33 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-app-api": "^0.7.6-next.0",
-    "@backstage/backend-common": "^0.22.1-next.0",
-    "@backstage/backend-plugin-api": "^0.6.19-next.0",
+    "@backstage/backend-app-api": "^0.7.6-next.2",
+    "@backstage/backend-plugin-api": "^0.6.19-next.2",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.4.14-next.0",
-    "@backstage/plugin-events-node": "^0.3.5-next.0",
+    "@backstage/plugin-auth-node": "^0.4.14-next.2",
+    "@backstage/plugin-events-node": "^0.3.5-next.1",
     "@backstage/types": "^1.1.1",
+    "@keyv/memcache": "^1.3.5",
+    "@keyv/redis": "^2.5.3",
+    "@types/keyv": "^4.2.0",
     "better-sqlite3": "^9.0.0",
     "cookie": "^0.6.0",
     "express": "^4.17.1",
     "fs-extra": "^11.0.0",
+    "keyv": "^4.5.2",
     "knex": "^3.0.0",
     "msw": "^1.0.0",
     "mysql2": "^3.0.0",
     "pg": "^8.11.3",
+    "pg-connection-string": "^2.3.0",
     "testcontainers": "^10.0.0",
     "textextensions": "^5.16.0",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.6-next.0",
+    "@backstage/cli": "^0.26.7-next.2",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   },