@backstage/backend-test-utils 1.6.0-next.2 → 1.7.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,70 @@
 # @backstage/backend-test-utils
 
+## 1.7.0-next.0
+
+### Minor Changes
+
+- ead925a: Add a standard `toString` on credentials objects
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.11.1-next.0
+  - @backstage/backend-app-api@1.2.4
+  - @backstage/plugin-auth-node@0.6.4
+  - @backstage/backend-plugin-api@1.4.0
+  - @backstage/plugin-events-node@0.4.12
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-permission-common@0.9.0
+
+## 1.6.0
+
+### Minor Changes
+
+- 6dfb7be: Added `mockServices.permissions()` that can return actual results.
+- c999c25: Added an `actionsRegistryServiceMock` and `actionsServiceMock` to `/alpha` export for the experimental services.
+
+  This allows you to write tests for your actions by doing something similar to the following:
+
+  ```ts
+  import { actionsRegistryServiceMock } from '@backstage/backend-test-utils/alpha';
+
+  const mockActionsRegistry = actionsRegistryServiceMock();
+  const mockCatalog = catalogServiceMock({
+    entities: [
+     ...
+    ],
+  });
+
+  createGetCatalogEntityAction({
+    catalog: mockCatalog,
+    actionsRegistry: mockActionsRegistry,
+  });
+
+  await expect(
+    mockActionsRegistry.invoke({
+      id: 'test:get-catalog-entity',
+      input: { name: 'test' },
+    }),
+  ).resolves.toEqual(...)
+  ```
+
+### Patch Changes
+
+- 12c1fd4: Make the `user` credentials mock behave more like production
+- Updated dependencies
+  - @backstage/backend-defaults@0.11.0
+  - @backstage/plugin-auth-node@0.6.4
+  - @backstage/backend-app-api@1.2.4
+  - @backstage/backend-plugin-api@1.4.0
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-events-node@0.4.12
+  - @backstage/plugin-permission-common@0.9.0
+
 ## 1.6.0-next.2
 
 ### Patch Changes

package/dist/alpha/services/ActionsRegistryServiceMock.cjs.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var mockServices = require('../../services/mockServices.cjs.js');
+require('../../services/mockCredentials.cjs.js');
+var MockActionsRegistry = require('./MockActionsRegistry.cjs.js');
+var simpleMock = require('./simpleMock.cjs.js');
+var alpha$1 = require('@backstage/backend-plugin-api/alpha');
+var alpha = require('@backstage/backend-defaults/alpha');
+
+function actionsRegistryServiceMock(options) {
+  return MockActionsRegistry.MockActionsRegistry.create({
+    logger: options?.logger ?? mockServices.mockServices.logger.mock()
+  });
+}
+((actionsRegistryServiceMock2) => {
+  actionsRegistryServiceMock2.factory = () => alpha.actionsRegistryServiceFactory;
+  actionsRegistryServiceMock2.mock = simpleMock.simpleMock(
+    alpha$1.actionsRegistryServiceRef,
+    () => ({
+      register: jest.fn()
+    })
+  );
+})(actionsRegistryServiceMock || (actionsRegistryServiceMock = {}));
+
+exports.actionsRegistryServiceMock = actionsRegistryServiceMock;
+//# sourceMappingURL=ActionsRegistryServiceMock.cjs.js.map

package/dist/alpha/services/ActionsRegistryServiceMock.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionsRegistryServiceMock.cjs.js","sources":["../../../src/alpha/services/ActionsRegistryServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { mockServices } from '../../services';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { MockActionsRegistry } from './MockActionsRegistry';\nimport { simpleMock } from './simpleMock';\nimport {\n  ActionsRegistryService,\n  actionsRegistryServiceRef,\n} from '@backstage/backend-plugin-api/alpha';\nimport { actionsRegistryServiceFactory } from '@backstage/backend-defaults/alpha';\n\n/**\n * @alpha\n */\nexport function actionsRegistryServiceMock(options?: {\n  logger: LoggerService;\n}): MockActionsRegistry {\n  return MockActionsRegistry.create({\n    logger: options?.logger ?? mockServices.logger.mock(),\n  });\n}\n\n/**\n * @alpha\n */\nexport namespace actionsRegistryServiceMock {\n  export const factory = () => actionsRegistryServiceFactory;\n\n  export const mock = simpleMock<ActionsRegistryService>(\n    actionsRegistryServiceRef,\n    () => ({\n      register: jest.fn(),\n    }),\n  );\n}\n"],"names":["MockActionsRegistry","mockServices","actionsRegistryServiceMock","actionsRegistryServiceFactory","simpleMock","actionsRegistryServiceRef"],"mappings":";;;;;;;;;AA4BO,SAAS,2BAA2B,OAEnB,EAAA;AACtB,EAAA,OAAOA,wCAAoB,MAAO,CAAA;AAAA,IAChC,MAAQ,EAAA,OAAA,EAAS,MAAU,IAAAC,yBAAA,CAAa,OAAO,IAAK;AAAA,GACrD,CAAA;AACH;AAAA,CAKO,CAAUC,2BAAV,KAAA;AACE,EAAMA,2BAAAA,CAAA,UAAU,MAAMC,mCAAA;AAEtB,EAAMD,4BAAA,IAAO,GAAAE,qBAAA;AAAA,IAClBC,iCAAA;AAAA,IACA,OAAO;AAAA,MACL,QAAA,EAAU,KAAK,EAAG;AAAA,KACpB;AAAA,GACF;AAAA,CARe,EAAA,0BAAA,KAAA,0BAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/alpha/services/ActionsServiceMock.cjs.js

@@ -0,0 +1,15 @@
+'use strict';
+
+var simpleMock = require('./simpleMock.cjs.js');
+var alpha$1 = require('@backstage/backend-plugin-api/alpha');
+var alpha = require('@backstage/backend-defaults/alpha');
+
+exports.actionsServiceMock = void 0;
+((actionsServiceMock2) => {
+  actionsServiceMock2.factory = () => alpha.actionsServiceFactory;
+  actionsServiceMock2.mock = simpleMock.simpleMock(alpha$1.actionsServiceRef, () => ({
+    invoke: jest.fn(),
+    list: jest.fn()
+  }));
+})(exports.actionsServiceMock || (exports.actionsServiceMock = {}));
+//# sourceMappingURL=ActionsServiceMock.cjs.js.map

package/dist/alpha/services/ActionsServiceMock.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionsServiceMock.cjs.js","sources":["../../../src/alpha/services/ActionsServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { simpleMock } from './simpleMock';\nimport {\n  ActionsService,\n  actionsServiceRef,\n} from '@backstage/backend-plugin-api/alpha';\nimport { actionsServiceFactory } from '@backstage/backend-defaults/alpha';\n\n/**\n * @alpha\n */\nexport namespace actionsServiceMock {\n  export const factory = () => actionsServiceFactory;\n\n  export const mock = simpleMock<ActionsService>(actionsServiceRef, () => ({\n    invoke: jest.fn(),\n    list: jest.fn(),\n  }));\n}\n"],"names":["actionsServiceMock","actionsServiceFactory","simpleMock","actionsServiceRef"],"mappings":";;;;;;AA0BiBA;AAAA,CAAV,CAAUA,mBAAV,KAAA;AACE,EAAMA,mBAAAA,CAAA,UAAU,MAAMC,2BAAA;AAEtB,EAAMD,mBAAA,CAAA,IAAA,GAAOE,qBAA2B,CAAAC,yBAAA,EAAmB,OAAO;AAAA,IACvE,MAAA,EAAQ,KAAK,EAAG,EAAA;AAAA,IAChB,IAAA,EAAM,KAAK,EAAG;AAAA,GACd,CAAA,CAAA;AAAA,CANa,EAAAH,0BAAA,KAAAA,0BAAA,GAAA,EAAA,CAAA,CAAA;;"}

package/dist/alpha/services/MockActionsRegistry.cjs.js

@@ -0,0 +1,83 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var zod = require('zod');
+var zodToJsonSchema = require('zod-to-json-schema');
+require('../../services/mockServices.cjs.js');
+var mockCredentials = require('../../services/mockCredentials.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var zodToJsonSchema__default = /*#__PURE__*/_interopDefaultCompat(zodToJsonSchema);
+
+class MockActionsRegistry {
+  constructor(logger) {
+    this.logger = logger;
+  }
+  static create(opts) {
+    return new MockActionsRegistry(opts.logger);
+  }
+  actions = /* @__PURE__ */ new Map();
+  async list() {
+    return {
+      actions: Array.from(this.actions.entries()).map(([id, action]) => ({
+        id,
+        name: action.name,
+        title: action.title,
+        description: action.description,
+        attributes: {
+          destructive: action.attributes?.destructive ?? true,
+          idempotent: action.attributes?.idempotent ?? false,
+          readOnly: action.attributes?.readOnly ?? false
+        },
+        schema: {
+          input: action.schema?.input ? zodToJsonSchema__default.default(action.schema.input(zod.z)) : zodToJsonSchema__default.default(zod.z.object({})),
+          output: action.schema?.output ? zodToJsonSchema__default.default(action.schema.output(zod.z)) : zodToJsonSchema__default.default(zod.z.object({}))
+        }
+      }))
+    };
+  }
+  async invoke(opts) {
+    const action = this.actions.get(opts.id);
+    if (!action) {
+      const availableActionIds = Array.from(this.actions.keys()).join(", ");
+      throw new errors.NotFoundError(
+        `Action "${opts.id}" not found, available actions: ${availableActionIds ? `"${availableActionIds}"` : "none"}`
+      );
+    }
+    const input = action.schema?.input ? action.schema.input(zod.z).safeParse(opts.input) : { success: true, data: void 0 };
+    if (!input.success) {
+      throw new errors.InputError(`Invalid input to action "${opts.id}"`, input.error);
+    }
+    try {
+      const result = await action.action({
+        input: input.data,
+        credentials: opts.credentials ?? mockCredentials.mockCredentials.none(),
+        logger: this.logger
+      });
+      const output = action.schema?.output ? action.schema.output(zod.z).safeParse(result?.output) : { success: true, data: result?.output };
+      if (!output.success) {
+        throw new errors.InputError(
+          `Invalid output from action "${opts.id}"`,
+          output.error
+        );
+      }
+      return { output: output.data };
+    } catch (error) {
+      throw new errors.ForwardedError(
+        `Failed execution of action "${opts.id}"`,
+        error
+      );
+    }
+  }
+  register(options) {
+    const id = `test:${options.name}`;
+    if (this.actions.has(id)) {
+      throw new Error(`Action with id "${id}" is already registered`);
+    }
+    this.actions.set(id, options);
+  }
+}
+
+exports.MockActionsRegistry = MockActionsRegistry;
+//# sourceMappingURL=MockActionsRegistry.cjs.js.map

package/dist/alpha/services/MockActionsRegistry.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockActionsRegistry.cjs.js","sources":["../../../src/alpha/services/MockActionsRegistry.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  BackstageCredentials,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { ForwardedError, InputError, NotFoundError } from '@backstage/errors';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { z, AnyZodObject } from 'zod';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { mockCredentials } from '../../services';\nimport {\n  ActionsRegistryActionOptions,\n  ActionsRegistryService,\n  ActionsService,\n  ActionsServiceAction,\n} from '@backstage/backend-plugin-api/alpha';\n\n/**\n * A mock implementation of the ActionsRegistryService and ActionsService that can be used in tests.\n *\n * This is useful for testing actions that are registered with the ActionsRegistryService and ActionsService.\n *\n * The plugin ID is hardcoded to `testing` in the mock implementation.\n *\n * @example\n * ```ts\n * const actionsRegistry = mockServices.actionsRegistry();\n *\n * actionsRegistry.register({\n *   name: 'test',\n *   title: 'Test',\n *   description: 'Test',\n *   schema: {\n *     input: z.object({ name: z.string() }),\n *     output: z.object({ name: z.string() }),\n *   },\n *   action: async ({ input }) => ({ output: { name: input.name } }),\n * });\n *\n *\n * const result = await actionsRegistry.invoke({\n *   id: 'testing:test',\n *   input: { name: 'test' },\n * });\n *\n * expect(result).toEqual({ output: { name: 'test' } });\n * ```\n *\n * @alpha\n */\nexport class MockActionsRegistry\n  implements ActionsRegistryService, ActionsService\n{\n  private constructor(private readonly logger: LoggerService) {}\n\n  static create(opts: { logger: LoggerService }) {\n    return new MockActionsRegistry(opts.logger);\n  }\n\n  readonly actions: Map<string, ActionsRegistryActionOptions<any, any>> =\n    new Map();\n\n  async list(): Promise<{ actions: ActionsServiceAction[] }> {\n    return {\n      actions: Array.from(this.actions.entries()).map(([id, action]) => ({\n        id,\n        name: action.name,\n        title: action.title,\n        description: action.description,\n        attributes: {\n          destructive: action.attributes?.destructive ?? true,\n          idempotent: action.attributes?.idempotent ?? false,\n          readOnly: action.attributes?.readOnly ?? false,\n        },\n        schema: {\n          input: action.schema?.input\n            ? zodToJsonSchema(action.schema.input(z))\n            : zodToJsonSchema(z.object({})),\n          output: action.schema?.output\n            ? zodToJsonSchema(action.schema.output(z))\n            : zodToJsonSchema(z.object({})),\n        } as ActionsServiceAction['schema'],\n      })),\n    };\n  }\n\n  async invoke(opts: {\n    id: string;\n    input?: JsonObject;\n    credentials?: BackstageCredentials;\n  }): Promise<{ output: JsonValue }> {\n    const action = this.actions.get(opts.id);\n\n    if (!action) {\n      const availableActionIds = Array.from(this.actions.keys()).join(', ');\n      throw new NotFoundError(\n        `Action \"${opts.id}\" not found, available actions: ${\n          availableActionIds ? `\"${availableActionIds}\"` : 'none'\n        }`,\n      );\n    }\n\n    const input = action.schema?.input\n      ? action.schema.input(z).safeParse(opts.input)\n      : ({ success: true, data: undefined } as const);\n\n    if (!input.success) {\n      throw new InputError(`Invalid input to action \"${opts.id}\"`, input.error);\n    }\n\n    try {\n      const result = await action.action({\n        input: input.data,\n        credentials: opts.credentials ?? mockCredentials.none(),\n        logger: this.logger,\n      });\n\n      const output = action.schema?.output\n        ? action.schema.output(z).safeParse(result?.output)\n        : ({ success: true, data: result?.output } as const);\n\n      if (!output.success) {\n        throw new InputError(\n          `Invalid output from action \"${opts.id}\"`,\n          output.error,\n        );\n      }\n\n      return { output: output.data };\n    } catch (error) {\n      throw new ForwardedError(\n        `Failed execution of action \"${opts.id}\"`,\n        error,\n      );\n    }\n  }\n\n  register<\n    TInputSchema extends AnyZodObject,\n    TOutputSchema extends AnyZodObject,\n  >(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void {\n    // hardcode test: prefix similar to how the default actions registry does it\n    // and other places around the testing ecosystem:\n    // https://github.com/backstage/backstage/blob/a9219496d5c073aaa0b8caf32ece10455cf65e61/packages/backend-test-utils/src/next/services/mockServices.ts#L321\n    // https://github.com/backstage/backstage/blob/861f162b4a39117b824669d67a951ed1db142e3d/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts#L99\n    const id = `test:${options.name}`;\n\n    if (this.actions.has(id)) {\n      throw new Error(`Action with id \"${id}\" is already registered`);\n    }\n\n    this.actions.set(id, options);\n  }\n}\n"],"names":["zodToJsonSchema","z","NotFoundError","InputError","mockCredentials","ForwardedError"],"mappings":";;;;;;;;;;;;AAgEO,MAAM,mBAEb,CAAA;AAAA,EACU,YAA6B,MAAuB,EAAA;AAAvB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA;AAAwB,EAE7D,OAAO,OAAO,IAAiC,EAAA;AAC7C,IAAO,OAAA,IAAI,mBAAoB,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA;AAC5C,EAES,OAAA,uBACH,GAAI,EAAA;AAAA,EAEV,MAAM,IAAqD,GAAA;AACzD,IAAO,OAAA;AAAA,MACL,OAAS,EAAA,KAAA,CAAM,IAAK,CAAA,IAAA,CAAK,OAAQ,CAAA,OAAA,EAAS,CAAA,CAAE,GAAI,CAAA,CAAC,CAAC,EAAA,EAAI,MAAM,CAAO,MAAA;AAAA,QACjE,EAAA;AAAA,QACA,MAAM,MAAO,CAAA,IAAA;AAAA,QACb,OAAO,MAAO,CAAA,KAAA;AAAA,QACd,aAAa,MAAO,CAAA,WAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,WAAA,EAAa,MAAO,CAAA,UAAA,EAAY,WAAe,IAAA,IAAA;AAAA,UAC/C,UAAA,EAAY,MAAO,CAAA,UAAA,EAAY,UAAc,IAAA,KAAA;AAAA,UAC7C,QAAA,EAAU,MAAO,CAAA,UAAA,EAAY,QAAY,IAAA;AAAA,SAC3C;AAAA,QACA,MAAQ,EAAA;AAAA,UACN,OAAO,MAAO,CAAA,MAAA,EAAQ,KAClB,GAAAA,gCAAA,CAAgB,OAAO,MAAO,CAAA,KAAA,CAAMC,KAAC,CAAC,IACtCD,gCAAgB,CAAAC,KAAA,CAAE,MAAO,CAAA,EAAE,CAAC,CAAA;AAAA,UAChC,QAAQ,MAAO,CAAA,MAAA,EAAQ,MACnB,GAAAD,gCAAA,CAAgB,OAAO,MAAO,CAAA,MAAA,CAAOC,KAAC,CAAC,IACvCD,gCAAgB,CAAAC,KAAA,CAAE,MAAO,CAAA,EAAE,CAAC;AAAA;AAClC,OACA,CAAA;AAAA,KACJ;AAAA;AACF,EAEA,MAAM,OAAO,IAIsB,EAAA;AACjC,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,OAAQ,CAAA,GAAA,CAAI,KAAK,EAAE,CAAA;AAEvC,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAM,MAAA,kBAAA,GAAqB,MAAM,IAAK,CAAA,IAAA,CAAK,QAAQ,IAAK,EAAC,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AACpE,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAA,QAAA,EAAW,KAAK,EAAE,CAAA,gCAAA,EAChB,qBAAqB,CAAI,CAAA,EAAA,kBAAkB,MAAM,MACnD,CAAA;AAAA,OACF;AAAA;AAGF,IAAA,MAAM,QAAQ,MAAO,CAAA,MAAA,EAAQ,KACzB,GAAA,MAAA,CAAO,OAAO,KAAM,CAAAD,KAAC,CAAE,CAAA,SAAA,CAAU,KAAK,KAAK,CAAA,GAC1C,EAAE,OAAS,EAAA,IAAA,EAAM,MAAM,KAAU,CAAA,EAAA;AAEtC,IAAI,IAAA,CAAC,MAAM,OAAS,EAAA;AAClB,MAAA,MAAM,IAAIE,iBAAW,CAAA,CAAA,yBAAA,EAA4B,KAAK,EAAE,CAAA,CAAA,CAAA,EAAK,MAAM,KAAK,CAAA;AAAA;AAG1E,IAAI,IAAA;AACF,MAAM,MAAA,MAAA,GAAS,MAAM,MAAA,CAAO,MAAO,CAAA;AAAA,QACjC,OAAO,KAAM,CAAA,IAAA;AAAA,QACb,WAAa,EAAA,IAAA,CAAK,WAAe,IAAAC,+BAAA,CAAgB,IAAK,EAAA;AAAA,QACtD,QAAQ,IAAK,CAAA;AAAA,OACd,CAAA;AAED,MAAA,MAAM,SAAS,MAAO,CAAA,MAAA,EAAQ,SAC1B,MAAO,CAAA,MAAA,CAAO,OAAOH,KAAC,CAAA,CAAE,SAAU,CAAA,MAAA,EAAQ,MAAM,CAC/C,GAAA,EAAE,SAAS,IAAM,EAAA,IAAA,EAAM,QAAQ,MAAO,EAAA;AAE3C,MAAI,IAAA,CAAC,OAAO,OAAS,EAAA;AACnB,QAAA,MAAM,IAAIE,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,UACtC,MAAO,CAAA;AAAA,SACT;AAAA;AAGF,MAAO,OAAA,EAAE,MAAQ,EAAA,MAAA,CAAO,IAAK,EAAA;AAAA,aACtB,KAAO,EAAA;AACd,MAAA,MAAM,IAAIE,qBAAA;AAAA,QACR,CAAA,4BAAA,EAA+B,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,QACtC;AAAA,OACF;AAAA;AACF;AACF,EAEA,SAGE,OAA0E,EAAA;AAK1E,IAAM,MAAA,EAAA,GAAK,CAAQ,KAAA,EAAA,OAAA,CAAQ,IAAI,CAAA,CAAA;AAE/B,IAAA,IAAI,IAAK,CAAA,OAAA,CAAQ,GAAI,CAAA,EAAE,CAAG,EAAA;AACxB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAmB,gBAAA,EAAA,EAAE,CAAyB,uBAAA,CAAA,CAAA;AAAA;AAGhE,IAAK,IAAA,CAAA,OAAA,CAAQ,GAAI,CAAA,EAAA,EAAI,OAAO,CAAA;AAAA;AAEhC;;;;"}

package/dist/alpha/services/simpleMock.cjs.js

@@ -0,0 +1,28 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+function simpleMock(ref, mockFactory) {
+  return (partialImpl) => {
+    const mock = mockFactory();
+    if (partialImpl) {
+      for (const [key, impl] of Object.entries(partialImpl)) {
+        if (typeof impl === "function") {
+          mock[key].mockImplementation(impl);
+        } else {
+          mock[key] = impl;
+        }
+      }
+    }
+    return Object.assign(mock, {
+      factory: backendPluginApi.createServiceFactory({
+        service: ref,
+        deps: {},
+        factory: () => mock
+      })
+    });
+  };
+}
+
+exports.simpleMock = simpleMock;
+//# sourceMappingURL=simpleMock.cjs.js.map

package/dist/alpha/services/simpleMock.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simpleMock.cjs.js","sources":["../../../src/alpha/services/simpleMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  createServiceFactory,\n  ServiceFactory,\n  ServiceRef,\n} from '@backstage/backend-plugin-api';\n\n/** @alpha */\nexport type ServiceMock<TService> = {\n  factory: ServiceFactory<TService>;\n} & {\n  [Key in keyof TService]: TService[Key] extends (\n    ...args: infer Args\n  ) => infer Return\n    ? TService[Key] & jest.MockInstance<Return, Args>\n    : TService[Key];\n};\n\n/** @internal */\nexport function simpleMock<TService>(\n  ref: ServiceRef<TService, any>,\n  mockFactory: () => jest.Mocked<TService>,\n): (partialImpl?: Partial<TService>) => ServiceMock<TService> {\n  return partialImpl => {\n    const mock = mockFactory();\n    if (partialImpl) {\n      for (const [key, impl] of Object.entries(partialImpl)) {\n        if (typeof impl === 'function') {\n          (mock as any)[key].mockImplementation(impl);\n        } else {\n          (mock as any)[key] = impl;\n        }\n      }\n    }\n    return Object.assign(mock, {\n      factory: createServiceFactory({\n        service: ref,\n        deps: {},\n        factory: () => mock,\n      }),\n    }) as ServiceMock<TService>;\n  };\n}\n"],"names":["createServiceFactory"],"mappings":";;;;AAiCgB,SAAA,UAAA,CACd,KACA,WAC4D,EAAA;AAC5D,EAAA,OAAO,CAAe,WAAA,KAAA;AACpB,IAAA,MAAM,OAAO,WAAY,EAAA;AACzB,IAAA,IAAI,WAAa,EAAA;AACf,MAAA,KAAA,MAAW,CAAC,GAAK,EAAA,IAAI,KAAK,MAAO,CAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AACrD,QAAI,IAAA,OAAO,SAAS,UAAY,EAAA;AAC9B,UAAC,IAAa,CAAA,GAAG,CAAE,CAAA,kBAAA,CAAmB,IAAI,CAAA;AAAA,SACrC,MAAA;AACL,UAAC,IAAA,CAAa,GAAG,CAAI,GAAA,IAAA;AAAA;AACvB;AACF;AAEF,IAAO,OAAA,MAAA,CAAO,OAAO,IAAM,EAAA;AAAA,MACzB,SAASA,qCAAqB,CAAA;AAAA,QAC5B,OAAS,EAAA,GAAA;AAAA,QACT,MAAM,EAAC;AAAA,QACP,SAAS,MAAM;AAAA,OAChB;AAAA,KACF,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/alpha.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var ActionsRegistryServiceMock = require('./alpha/services/ActionsRegistryServiceMock.cjs.js');
+var MockActionsRegistry = require('./alpha/services/MockActionsRegistry.cjs.js');
+var ActionsServiceMock = require('./alpha/services/ActionsServiceMock.cjs.js');
+
+
+
+Object.defineProperty(exports, "actionsRegistryServiceMock", {
+	enumerable: true,
+	get: function () { return ActionsRegistryServiceMock.actionsRegistryServiceMock; }
+});
+exports.MockActionsRegistry = MockActionsRegistry.MockActionsRegistry;
+Object.defineProperty(exports, "actionsServiceMock", {
+	enumerable: true,
+	get: function () { return ActionsServiceMock.actionsServiceMock; }
+});
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,89 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { ServiceFactory, LoggerService, BackstageCredentials } from '@backstage/backend-plugin-api';
+import { JsonObject, JsonValue } from '@backstage/types';
+import { AnyZodObject } from 'zod';
+import { ActionsRegistryService, ActionsService, ActionsRegistryActionOptions, ActionsServiceAction } from '@backstage/backend-plugin-api/alpha';
+
+/** @alpha */
+type ServiceMock<TService> = {
+    factory: ServiceFactory<TService>;
+} & {
+    [Key in keyof TService]: TService[Key] extends (...args: infer Args) => infer Return ? TService[Key] & jest.MockInstance<Return, Args> : TService[Key];
+};
+
+/**
+ * A mock implementation of the ActionsRegistryService and ActionsService that can be used in tests.
+ *
+ * This is useful for testing actions that are registered with the ActionsRegistryService and ActionsService.
+ *
+ * The plugin ID is hardcoded to `testing` in the mock implementation.
+ *
+ * @example
+ * ```ts
+ * const actionsRegistry = mockServices.actionsRegistry();
+ *
+ * actionsRegistry.register({
+ *   name: 'test',
+ *   title: 'Test',
+ *   description: 'Test',
+ *   schema: {
+ *     input: z.object({ name: z.string() }),
+ *     output: z.object({ name: z.string() }),
+ *   },
+ *   action: async ({ input }) => ({ output: { name: input.name } }),
+ * });
+ *
+ *
+ * const result = await actionsRegistry.invoke({
+ *   id: 'testing:test',
+ *   input: { name: 'test' },
+ * });
+ *
+ * expect(result).toEqual({ output: { name: 'test' } });
+ * ```
+ *
+ * @alpha
+ */
+declare class MockActionsRegistry implements ActionsRegistryService, ActionsService {
+    private readonly logger;
+    private constructor();
+    static create(opts: {
+        logger: LoggerService;
+    }): MockActionsRegistry;
+    readonly actions: Map<string, ActionsRegistryActionOptions<any, any>>;
+    list(): Promise<{
+        actions: ActionsServiceAction[];
+    }>;
+    invoke(opts: {
+        id: string;
+        input?: JsonObject;
+        credentials?: BackstageCredentials;
+    }): Promise<{
+        output: JsonValue;
+    }>;
+    register<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject>(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void;
+}
+
+/**
+ * @alpha
+ */
+declare function actionsRegistryServiceMock(options?: {
+    logger: LoggerService;
+}): MockActionsRegistry;
+/**
+ * @alpha
+ */
+declare namespace actionsRegistryServiceMock {
+    const factory: () => _backstage_backend_plugin_api.ServiceFactory<ActionsRegistryService, "plugin", "singleton">;
+    const mock: (partialImpl?: Partial<ActionsRegistryService> | undefined) => ServiceMock<ActionsRegistryService>;
+}
+
+/**
+ * @alpha
+ */
+declare namespace actionsServiceMock {
+    const factory: () => _backstage_backend_plugin_api.ServiceFactory<ActionsService, "plugin", "singleton">;
+    const mock: (partialImpl?: Partial<ActionsService> | undefined) => ServiceMock<ActionsService>;
+}
+
+export { MockActionsRegistry, type ServiceMock, actionsRegistryServiceMock, actionsServiceMock };

package/dist/index.cjs.js

@@ -4,10 +4,10 @@ var TestCaches = require('./cache/TestCaches.cjs.js');
 var TestDatabases = require('./database/TestDatabases.cjs.js');
 var registerMswTestHooks = require('./msw/registerMswTestHooks.cjs.js');
 var MockDirectory = require('./filesystem/MockDirectory.cjs.js');
-var ServiceFactoryTester = require('./next/wiring/ServiceFactoryTester.cjs.js');
-var TestBackend = require('./next/wiring/TestBackend.cjs.js');
-var mockServices = require('./next/services/mockServices.cjs.js');
-var mockCredentials = require('./next/services/mockCredentials.cjs.js');
+var mockServices = require('./services/mockServices.cjs.js');
+var mockCredentials = require('./services/mockCredentials.cjs.js');
+var ServiceFactoryTester = require('./wiring/ServiceFactoryTester.cjs.js');
+var TestBackend = require('./wiring/TestBackend.cjs.js');
 var errorHandler = require('./util/errorHandler.cjs.js');
 
 
@@ -16,8 +16,6 @@ exports.TestCaches = TestCaches.TestCaches;
 exports.TestDatabases = TestDatabases.TestDatabases;
 exports.registerMswTestHooks = registerMswTestHooks.registerMswTestHooks;
 exports.createMockDirectory = MockDirectory.createMockDirectory;
-exports.ServiceFactoryTester = ServiceFactoryTester.ServiceFactoryTester;
-exports.startTestBackend = TestBackend.startTestBackend;
 Object.defineProperty(exports, "mockServices", {
 	enumerable: true,
 	get: function () { return mockServices.mockServices; }
@@ -26,5 +24,7 @@ Object.defineProperty(exports, "mockCredentials", {
 	enumerable: true,
 	get: function () { return mockCredentials.mockCredentials; }
 });
+exports.ServiceFactoryTester = ServiceFactoryTester.ServiceFactoryTester;
+exports.startTestBackend = TestBackend.startTestBackend;
 exports.mockErrorHandler = errorHandler.mockErrorHandler;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -1,11 +1,12 @@
 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, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, DatabaseService, BackstageNonePrincipal, BackstageUserPrincipal, BackstagePrincipalAccessRestrictions, BackstageServicePrincipal } from '@backstage/backend-plugin-api';
-import { Backend } from '@backstage/backend-app-api';
-import { ExtendedHttpServer } from '@backstage/backend-defaults/rootHttpRouter';
+import { ServiceFactory, RootConfigService, LoggerService, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, DatabaseService, PermissionsService, BackstageNonePrincipal, BackstageUserPrincipal, BackstagePrincipalAccessRestrictions, BackstageServicePrincipal, ServiceRef, ExtensionPoint, BackendFeature } from '@backstage/backend-plugin-api';
 import { EventsService } from '@backstage/plugin-events-node';
+import { AuthorizeResult } from '@backstage/plugin-permission-common';
 import { JsonObject } from '@backstage/types';
+import { Backend } from '@backstage/backend-app-api';
+import { ExtendedHttpServer } from '@backstage/backend-defaults/rootHttpRouter';
 import * as express from 'express';
 import * as qs from 'qs';
 import * as express_serve_static_core from 'express-serve-static-core';
@@ -315,91 +316,13 @@ interface CreateMockDirectoryOptions {
  */
 declare function createMockDirectory(options?: CreateMockDirectoryOptions): MockDirectory;
 
-/**
- * Options for {@link ServiceFactoryTester}.
- * @public
- */
-interface ServiceFactoryTesterOptions {
-    /**
-     * Additional service factories to make available as dependencies.
-     *
-     * @remarks
-     *
-     * If a service factory is provided for a service that already has a default
-     * implementation, the provided factory will override the default.
-     */
-    dependencies?: Array<ServiceFactory>;
-}
-/**
- * A utility to help test service factories in isolation.
- *
- * @public
- */
-declare class ServiceFactoryTester<TService, TScope extends 'root' | 'plugin', TInstances extends 'singleton' | 'multiton' = 'singleton'> {
-    #private;
-    /**
-     * Creates a new {@link ServiceFactoryTester} used to test the provided subject.
-     *
-     * @param subject - The service factory to test.
-     * @param options - Additional options
-     * @returns A new tester instance for the provided subject.
-     */
-    static from<TService, TScope extends 'root' | 'plugin', TInstances extends 'singleton' | 'multiton' = 'singleton'>(subject: ServiceFactory<TService, TScope, TInstances>, options?: ServiceFactoryTesterOptions): ServiceFactoryTester<TService, TScope, TInstances>;
-    private constructor();
-    /**
-     * Returns the service instance for the subject.
-     *
-     * @remarks
-     *
-     * If the subject is a plugin scoped service factory a plugin ID
-     * can be provided to instantiate the service for a specific plugin.
-     *
-     * By default the plugin ID 'test' is used.
-     */
-    getSubject(...args: 'root' extends TScope ? [] : [pluginId?: string]): Promise<TInstances extends 'multiton' ? TService[] : TService>;
-    /**
-     * Return the service instance for any of the provided dependencies or built-in services.
-     *
-     * @remarks
-     *
-     * A plugin ID can optionally be provided for plugin scoped services, otherwise the plugin ID 'test' is used.
-     */
-    getService<TGetService, TGetScope extends 'root' | 'plugin', TGetInstances extends 'singleton' | 'multiton' = 'singleton'>(service: ServiceRef<TGetService, TGetScope, TGetInstances>, ...args: 'root' extends TGetScope ? [] : [pluginId?: string]): Promise<TGetInstances extends 'multiton' ? TGetService[] : TGetService>;
-}
-
-/** @public */
-interface TestBackendOptions<TExtensionPoints extends any[]> {
-    extensionPoints?: readonly [
-        ...{
-            [index in keyof TExtensionPoints]: [
-                ExtensionPoint<TExtensionPoints[index]>,
-                Partial<TExtensionPoints[index]>
-            ];
-        }
-    ];
-    features?: Array<BackendFeature | Promise<{
-        default: BackendFeature;
-    }>>;
-}
-/** @public */
-interface TestBackend extends Backend {
-    /**
-     * Provides access to the underling HTTP server for use with utilities
-     * such as `supertest`.
-     *
-     * If the root http router service has been replaced, this will throw an error.
-     */
-    readonly server: ExtendedHttpServer;
-}
-/** @public */
-declare function startTestBackend<TExtensionPoints extends any[]>(options: TestBackendOptions<TExtensionPoints>): Promise<TestBackend>;
-
 /** @public */
 type ServiceMock<TService> = {
     factory: ServiceFactory<TService>;
 } & {
     [Key in keyof TService]: TService[Key] extends (...args: infer Args) => infer Return ? TService[Key] & jest.MockInstance<Return, Args> : TService[Key];
 };
+
 /**
  * Mock implementations of the core services, to be used in tests.
  *
@@ -582,9 +505,29 @@ declare namespace mockServices {
         const factory: () => ServiceFactory<LoggerService, "plugin", "singleton">;
         const mock: (partialImpl?: Partial<LoggerService> | undefined) => ServiceMock<LoggerService>;
     }
+    /**
+     * Creates a functional mock implementation of the
+     * {@link @backstage/backend-plugin-api#PermissionsService}.
+     */
+    function permissions(options?: {
+        result: AuthorizeResult.ALLOW | AuthorizeResult.DENY;
+    }): PermissionsService;
     namespace permissions {
-        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>;
+        /**
+         * Creates a mock factory for the
+         * {@link @backstage/backend-plugin-api#coreServices.permissions}. Just
+         * returns the given `result` if you supply one. Otherwise, it returns the
+         * regular default permissions factory.
+         */
+        const factory: (options?: {
+            result: AuthorizeResult.ALLOW | AuthorizeResult.DENY;
+        }) => ServiceFactory<PermissionsService, "plugin", "singleton">;
+        /**
+         * Creates a mock of the
+         * {@link @backstage/backend-plugin-api#coreServices.permissions},
+         * optionally with some given method implementations.
+         */
+        const mock: (partialImpl?: Partial<PermissionsService> | undefined) => ServiceMock<PermissionsService>;
     }
     namespace permissionsRegistry {
         const factory: () => ServiceFactory<_backstage_backend_plugin_api.PermissionsRegistryService, "plugin", "singleton">;
@@ -602,14 +545,6 @@ declare namespace mockServices {
         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 actions {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.ActionsService, "plugin", "singleton">;
-        const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.ActionsService> | undefined) => ServiceMock<_backstage_backend_plugin_api.ActionsService>;
-    }
-    namespace actionsRegistry {
-        const factory: () => ServiceFactory<_backstage_backend_plugin_api.ActionsRegistryService, "plugin", "singleton">;
-        const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.ActionsRegistryService> | undefined) => ServiceMock<_backstage_backend_plugin_api.ActionsRegistryService>;
-    }
     /**
      * Creates a functional mock implementation of the
      * {@link @backstage/backend-events-node#eventsServiceRef}.
@@ -745,6 +680,85 @@ declare namespace mockCredentials {
     }
 }
 
+/**
+ * Options for {@link ServiceFactoryTester}.
+ * @public
+ */
+interface ServiceFactoryTesterOptions {
+    /**
+     * Additional service factories to make available as dependencies.
+     *
+     * @remarks
+     *
+     * If a service factory is provided for a service that already has a default
+     * implementation, the provided factory will override the default.
+     */
+    dependencies?: Array<ServiceFactory>;
+}
+/**
+ * A utility to help test service factories in isolation.
+ *
+ * @public
+ */
+declare class ServiceFactoryTester<TService, TScope extends 'root' | 'plugin', TInstances extends 'singleton' | 'multiton' = 'singleton'> {
+    #private;
+    /**
+     * Creates a new {@link ServiceFactoryTester} used to test the provided subject.
+     *
+     * @param subject - The service factory to test.
+     * @param options - Additional options
+     * @returns A new tester instance for the provided subject.
+     */
+    static from<TService, TScope extends 'root' | 'plugin', TInstances extends 'singleton' | 'multiton' = 'singleton'>(subject: ServiceFactory<TService, TScope, TInstances>, options?: ServiceFactoryTesterOptions): ServiceFactoryTester<TService, TScope, TInstances>;
+    private constructor();
+    /**
+     * Returns the service instance for the subject.
+     *
+     * @remarks
+     *
+     * If the subject is a plugin scoped service factory a plugin ID
+     * can be provided to instantiate the service for a specific plugin.
+     *
+     * By default the plugin ID 'test' is used.
+     */
+    getSubject(...args: 'root' extends TScope ? [] : [pluginId?: string]): Promise<TInstances extends 'multiton' ? TService[] : TService>;
+    /**
+     * Return the service instance for any of the provided dependencies or built-in services.
+     *
+     * @remarks
+     *
+     * A plugin ID can optionally be provided for plugin scoped services, otherwise the plugin ID 'test' is used.
+     */
+    getService<TGetService, TGetScope extends 'root' | 'plugin', TGetInstances extends 'singleton' | 'multiton' = 'singleton'>(service: ServiceRef<TGetService, TGetScope, TGetInstances>, ...args: 'root' extends TGetScope ? [] : [pluginId?: string]): Promise<TGetInstances extends 'multiton' ? TGetService[] : TGetService>;
+}
+
+/** @public */
+interface TestBackendOptions<TExtensionPoints extends any[]> {
+    extensionPoints?: readonly [
+        ...{
+            [index in keyof TExtensionPoints]: [
+                ExtensionPoint<TExtensionPoints[index]>,
+                Partial<TExtensionPoints[index]>
+            ];
+        }
+    ];
+    features?: Array<BackendFeature | Promise<{
+        default: BackendFeature;
+    }>>;
+}
+/** @public */
+interface TestBackend extends Backend {
+    /**
+     * Provides access to the underling HTTP server for use with utilities
+     * such as `supertest`.
+     *
+     * If the root http router service has been replaced, this will throw an error.
+     */
+    readonly server: ExtendedHttpServer;
+}
+/** @public */
+declare function startTestBackend<TExtensionPoints extends any[]>(options: TestBackendOptions<TExtensionPoints>): Promise<TestBackend>;
+
 /**
  * A mock for error handler middleware that can be used in router tests.
  * @public