From e360c28f226e6beec820f0c96221ec5b615203a4 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 8 Jul 2022 11:18:50 +0200 Subject: [PATCH] Rename scaffolderCatalogModule Signed-off-by: Johan Haals --- packages/backend/src/next/index.ts | 4 +- .../extension/ScaffolderCatalogModule.test.ts | 42 +++++++++++++++++++ ...xtension.ts => ScaffolderCatalogModule.ts} | 4 +- .../scaffolder-backend/src/extension/index.ts | 2 +- 4 files changed, 47 insertions(+), 5 deletions(-) create mode 100644 plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.test.ts rename plugins/scaffolder-backend/src/extension/{ScaffolderCatalogExtension.ts => ScaffolderCatalogModule.ts} (92%) diff --git a/packages/backend/src/next/index.ts b/packages/backend/src/next/index.ts index 9deab2feeb..cda7ae4007 100644 --- a/packages/backend/src/next/index.ts +++ b/packages/backend/src/next/index.ts @@ -16,7 +16,7 @@ import { createBackend } from '@backstage/backend-app-api'; import { catalogPlugin } from '@backstage/plugin-catalog-backend'; -import { scaffolderCatalogExtension } from '@backstage/plugin-scaffolder-backend'; +import { scaffolderCatalogModule } from '@backstage/plugin-scaffolder-backend'; // export const appPlugin = createBackendPlugin({ // id: 'app', @@ -47,5 +47,5 @@ const backend = createBackend({ }); backend.add(catalogPlugin({})); -backend.add(scaffolderCatalogExtension({})); +backend.add(scaffolderCatalogModule({})); backend.start(); diff --git a/plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.test.ts b/plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.test.ts new file mode 100644 index 0000000000..f07eb0f7ae --- /dev/null +++ b/plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.test.ts @@ -0,0 +1,42 @@ +/* + * Copyright 2022 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { BackendInitRegistry } from '@backstage/backend-plugin-api'; +import { ScaffolderEntitiesProcessor } from '../processor'; +import { scaffolderCatalogModule } from './ScaffolderCatalogModule'; + +describe('ScaffolderCatalogModule', () => { + it('should register the extension point', () => { + // TODO(jhaals): clean this up and add test helpers for backend system. + const ext = scaffolderCatalogModule({}); + expect(ext.id).toBe('catalog.scaffolder.module'); + const registry: jest.Mocked = { + registerInit: jest.fn(), + } as any; + ext.register(registry); + + const extensionPoint = { + addProcessor: jest.fn(), + }; + + registry.registerInit.mock.calls[0][0].init({ + catalogProcessingExtensionPoint: extensionPoint, + }); + expect(extensionPoint.addProcessor).toHaveBeenCalledWith( + new ScaffolderEntitiesProcessor(), + ); + }); +}); diff --git a/plugins/scaffolder-backend/src/extension/ScaffolderCatalogExtension.ts b/plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.ts similarity index 92% rename from plugins/scaffolder-backend/src/extension/ScaffolderCatalogExtension.ts rename to plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.ts index 9ca140a952..bdce46a31a 100644 --- a/plugins/scaffolder-backend/src/extension/ScaffolderCatalogExtension.ts +++ b/plugins/scaffolder-backend/src/extension/ScaffolderCatalogModule.ts @@ -21,8 +21,8 @@ import { ScaffolderEntitiesProcessor } from '../processor'; * @alpha * Registers the ScaffolderEntitiesProcessor with the catalog processing extension point. */ -export const scaffolderCatalogExtension = createBackendModule({ - moduleId: 'scaffolder.extention', +export const scaffolderCatalogModule = createBackendModule({ + moduleId: 'scaffolder.module', pluginId: 'catalog', register(env) { env.registerInit({ diff --git a/plugins/scaffolder-backend/src/extension/index.ts b/plugins/scaffolder-backend/src/extension/index.ts index 672e29e2ee..c827d9cafd 100644 --- a/plugins/scaffolder-backend/src/extension/index.ts +++ b/plugins/scaffolder-backend/src/extension/index.ts @@ -13,4 +13,4 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -export { scaffolderCatalogExtension } from './ScaffolderCatalogExtension'; +export { scaffolderCatalogModule } from './ScaffolderCatalogModule';