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

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/backend-test-utils
 
+## 0.4.0
+
+### Minor Changes
+
+- 805cbe7: Added `TestCaches` that functions just like `TestDatabases`
+
+### Patch Changes
+
+- 78a0b08: Internal refactor to handle `BackendFeature` contract change.
+- 9e63318: Made it possible to give access restrictions to `mockCredentials.service`
+- 006b3e8: The type `MockDirectoryOptions` was renamed to `CreateMockDirectoryOptions` so that it's clear these options are exclusive to the mock directory factory.
+- 0634fdc: Refactored `TestDatabases` to no longer depend on `backend-common`
+- 6a576dc: Fix the logger service mock to prevent returning `undefined` from the `child` method.
+- 6c11f6e: Use imports from backend-defaults instead of the deprecated ones from backend-app-api
+- Updated dependencies
+  - @backstage/backend-app-api@0.7.6
+  - @backstage/backend-plugin-api@0.6.19
+  - @backstage/plugin-auth-node@0.4.14
+  - @backstage/backend-defaults@0.3.0
+  - @backstage/plugin-events-node@0.3.5
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
+## 0.4.0-next.3
+
+### Patch Changes
+
+- 006b3e8: The type `MockDirectoryOptions` was renamed to `CreateMockDirectoryOptions` so that it's clear these options are exclusive to the mock directory factory.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.19-next.3
+  - @backstage/plugin-auth-node@0.4.14-next.3
+  - @backstage/plugin-events-node@0.3.5-next.2
+  - @backstage/backend-app-api@0.7.6-next.3
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.4.0-next.2
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -15,9 +15,20 @@ var fs = require('fs-extra');
 var textextensions = require('textextensions');
 var path = require('path');
 var backendAppApi = require('@backstage/backend-app-api');
+var cache = require('@backstage/backend-defaults/cache');
+var database = require('@backstage/backend-defaults/database');
+var discovery = require('@backstage/backend-defaults/discovery');
+var httpRouter = require('@backstage/backend-defaults/httpRouter');
+var lifecycle = require('@backstage/backend-defaults/lifecycle');
+var logger = require('@backstage/backend-defaults/logger');
+var permissions = require('@backstage/backend-defaults/permissions');
+var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
+var rootLifecycle = require('@backstage/backend-defaults/rootLifecycle');
+var scheduler = require('@backstage/backend-defaults/scheduler');
+var urlReader = require('@backstage/backend-defaults/urlReader');
 var config = require('@backstage/config');
-var cookie = require('cookie');
 var pluginEventsNode = require('@backstage/plugin-events-node');
+var cookie = require('cookie');
 var express = require('express');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
@@ -944,64 +955,6 @@ function createMockDirectory(options) {
   return mocker;
 }
 
-class MockIdentityService {
-  getIdentity(_options) {
-    return Promise.resolve({
-      token: "mock-token",
-      identity: {
-        type: "user",
-        userEntityRef: "user:default/mock-user",
-        ownershipEntityRefs: []
-      }
-    });
-  }
-}
-
-const levels = {
-  none: 0,
-  error: 1,
-  warn: 2,
-  info: 3,
-  debug: 4
-};
-class MockRootLoggerService {
-  #level;
-  #meta;
-  static create(options) {
-    const level = options?.level ?? "none";
-    if (!(level in levels)) {
-      throw new Error(`Invalid log level '${level}'`);
-    }
-    return new MockRootLoggerService(levels[level], {});
-  }
-  error(message, meta) {
-    this.#log("error", message, meta);
-  }
-  warn(message, meta) {
-    this.#log("warn", message, meta);
-  }
-  info(message, meta) {
-    this.#log("info", message, meta);
-  }
-  debug(message, meta) {
-    this.#log("debug", message, meta);
-  }
-  child(meta) {
-    return new MockRootLoggerService(this.#level, { ...this.#meta, ...meta });
-  }
-  constructor(level, meta) {
-    this.#level = level;
-    this.#meta = meta;
-  }
-  #log(level, message, meta) {
-    const levelValue = levels[level] ?? 0;
-    if (levelValue <= this.#level) {
-      const labels = Object.entries(this.#meta).map(([key, value]) => `${key}=${value}`).join(",");
-      console[level](`${labels} ${message}`, meta);
-    }
-  }
-}
-
 const DEFAULT_MOCK_USER_ENTITY_REF = "user:default/mock";
 const DEFAULT_MOCK_SERVICE_SUBJECT = "external:test-service";
 const MOCK_AUTH_COOKIE = "backstage-auth";
@@ -1317,6 +1270,64 @@ class MockHttpAuthService {
   }
 }
 
+class MockIdentityService {
+  getIdentity(_options) {
+    return Promise.resolve({
+      token: "mock-token",
+      identity: {
+        type: "user",
+        userEntityRef: "user:default/mock-user",
+        ownershipEntityRefs: []
+      }
+    });
+  }
+}
+
+const levels = {
+  none: 0,
+  error: 1,
+  warn: 2,
+  info: 3,
+  debug: 4
+};
+class MockRootLoggerService {
+  #level;
+  #meta;
+  static create(options) {
+    const level = options?.level ?? "none";
+    if (!(level in levels)) {
+      throw new Error(`Invalid log level '${level}'`);
+    }
+    return new MockRootLoggerService(levels[level], {});
+  }
+  error(message, meta) {
+    this.#log("error", message, meta);
+  }
+  warn(message, meta) {
+    this.#log("warn", message, meta);
+  }
+  info(message, meta) {
+    this.#log("info", message, meta);
+  }
+  debug(message, meta) {
+    this.#log("debug", message, meta);
+  }
+  child(meta) {
+    return new MockRootLoggerService(this.#level, { ...this.#meta, ...meta });
+  }
+  constructor(level, meta) {
+    this.#level = level;
+    this.#meta = meta;
+  }
+  #log(level, message, meta) {
+    const levelValue = levels[level] ?? 0;
+    if (levelValue <= this.#level) {
+      const labels = Object.entries(this.#meta).map(([key, value]) => `${key}=${value}`).join(",");
+      console[level](`${labels} ${message}`, meta);
+    }
+  }
+}
+
 class MockUserInfoService {
   customInfo;
   constructor(customInfo) {
@@ -1468,8 +1479,8 @@ exports.mockServices = void 0;
       listPublicServiceKeys: jest.fn()
     }));
   })(auth = mockServices2.auth || (mockServices2.auth = {}));
-  function discovery() {
-    return backendAppApi.HostDiscovery.fromConfig(
+  function discovery$1() {
+    return discovery.HostDiscovery.fromConfig(
       new config.ConfigReader({
         backend: {
           // Invalid port to make sure that requests are always mocked
@@ -1479,14 +1490,14 @@ exports.mockServices = void 0;
       })
     );
   }
-  mockServices2.discovery = discovery;
+  mockServices2.discovery = discovery$1;
   ((discovery2) => {
-    discovery2.factory = backendAppApi.discoveryServiceFactory;
+    discovery2.factory = discovery.discoveryServiceFactory;
     discovery2.mock = simpleMock(backendPluginApi.coreServices.discovery, () => ({
       getBaseUrl: jest.fn(),
       getExternalBaseUrl: jest.fn()
     }));
-  })(discovery = mockServices2.discovery || (mockServices2.discovery = {}));
+  })(discovery$1 = mockServices2.discovery || (mockServices2.discovery = {}));
   function httpAuth(options) {
     return new MockHttpAuthService(
       options?.pluginId ?? "test",
@@ -1527,7 +1538,7 @@ exports.mockServices = void 0;
     }));
   })(userInfo = mockServices2.userInfo || (mockServices2.userInfo = {}));
   ((cache2) => {
-    cache2.factory = backendAppApi.cacheServiceFactory;
+    cache2.factory = cache.cacheServiceFactory;
     cache2.mock = simpleMock(backendPluginApi.coreServices.cache, () => ({
       delete: jest.fn(),
       get: jest.fn(),
@@ -1536,54 +1547,54 @@ exports.mockServices = void 0;
     }));
   })(mockServices2.cache || (mockServices2.cache = {}));
   ((database2) => {
-    database2.factory = backendAppApi.databaseServiceFactory;
+    database2.factory = database.databaseServiceFactory;
     database2.mock = simpleMock(backendPluginApi.coreServices.database, () => ({
       getClient: jest.fn()
     }));
   })(mockServices2.database || (mockServices2.database = {}));
   ((httpRouter2) => {
-    httpRouter2.factory = backendAppApi.httpRouterServiceFactory;
+    httpRouter2.factory = httpRouter.httpRouterServiceFactory;
     httpRouter2.mock = simpleMock(backendPluginApi.coreServices.httpRouter, () => ({
       use: jest.fn(),
       addAuthPolicy: jest.fn()
     }));
   })(mockServices2.httpRouter || (mockServices2.httpRouter = {}));
   ((rootHttpRouter2) => {
-    rootHttpRouter2.factory = backendAppApi.rootHttpRouterServiceFactory;
+    rootHttpRouter2.factory = rootHttpRouter.rootHttpRouterServiceFactory;
     rootHttpRouter2.mock = simpleMock(backendPluginApi.coreServices.rootHttpRouter, () => ({
       use: jest.fn()
     }));
   })(mockServices2.rootHttpRouter || (mockServices2.rootHttpRouter = {}));
   ((lifecycle2) => {
-    lifecycle2.factory = backendAppApi.lifecycleServiceFactory;
+    lifecycle2.factory = lifecycle.lifecycleServiceFactory;
     lifecycle2.mock = simpleMock(backendPluginApi.coreServices.lifecycle, () => ({
       addShutdownHook: jest.fn(),
       addStartupHook: jest.fn()
     }));
   })(mockServices2.lifecycle || (mockServices2.lifecycle = {}));
   ((logger2) => {
-    logger2.factory = backendAppApi.loggerServiceFactory;
+    logger2.factory = logger.loggerServiceFactory;
     logger2.mock = simpleMock(
       backendPluginApi.coreServices.logger,
       () => createLoggerMock()
     );
   })(mockServices2.logger || (mockServices2.logger = {}));
   ((permissions2) => {
-    permissions2.factory = backendAppApi.permissionsServiceFactory;
+    permissions2.factory = permissions.permissionsServiceFactory;
     permissions2.mock = simpleMock(backendPluginApi.coreServices.permissions, () => ({
       authorize: jest.fn(),
       authorizeConditional: jest.fn()
     }));
   })(mockServices2.permissions || (mockServices2.permissions = {}));
   ((rootLifecycle2) => {
-    rootLifecycle2.factory = backendAppApi.rootLifecycleServiceFactory;
+    rootLifecycle2.factory = rootLifecycle.rootLifecycleServiceFactory;
     rootLifecycle2.mock = simpleMock(backendPluginApi.coreServices.rootLifecycle, () => ({
       addShutdownHook: jest.fn(),
       addStartupHook: jest.fn()
     }));
   })(mockServices2.rootLifecycle || (mockServices2.rootLifecycle = {}));
   ((scheduler2) => {
-    scheduler2.factory = backendAppApi.schedulerServiceFactory;
+    scheduler2.factory = scheduler.schedulerServiceFactory;
     scheduler2.mock = simpleMock(backendPluginApi.coreServices.scheduler, () => ({
       createScheduledTaskRunner: jest.fn(),
       getScheduledTasks: jest.fn(),
@@ -1592,7 +1603,7 @@ exports.mockServices = void 0;
     }));
   })(mockServices2.scheduler || (mockServices2.scheduler = {}));
   ((urlReader2) => {
-    urlReader2.factory = backendAppApi.urlReaderServiceFactory;
+    urlReader2.factory = urlReader.urlReaderServiceFactory;
     urlReader2.mock = simpleMock(backendPluginApi.coreServices.urlReader, () => ({
       readTree: jest.fn(),
       readUrl: jest.fn(),