Merge pull request #19430 from backstage/rugvip/module

cli: added backend module templating factory

packages/cli/src/lib/new/factories/backendModule.test.ts

@@ -0,0 +1,121 @@
+/*
+ * Copyright 2021 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 fs from 'fs-extra';
+import mockFs from 'mock-fs';
+import { sep, resolve as resolvePath } from 'path';
+import { paths } from '../../paths';
+import { Task } from '../../tasks';
+import { FactoryRegistry } from '../FactoryRegistry';
+import { createMockOutputStream, mockPaths } from './common/testUtils';
+import { backendModule } from './backendModule';
+
+describe('backendModule factory', () => {
+  beforeEach(() => {
+    mockPaths({
+      targetRoot: '/root',
+    });
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+    jest.resetAllMocks();
+  });
+
+  it('should create a backend plugin', async () => {
+    mockFs({
+      '/root': {
+        packages: {
+          backend: {
+            'package.json': JSON.stringify({}),
+          },
+        },
+        plugins: mockFs.directory(),
+      },
+      [paths.resolveOwn('templates')]: mockFs.load(
+        paths.resolveOwn('templates'),
+      ),
+    });
+
+    const options = await FactoryRegistry.populateOptions(backendModule, {
+      id: 'test',
+      moduleId: 'tester-two',
+    });
+
+    let modified = false;
+
+    const [output, mockStream] = createMockOutputStream();
+    jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+    jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+    await backendModule.create(options, {
+      private: true,
+      isMonoRepo: true,
+      defaultVersion: '1.0.0',
+      markAsModified: () => {
+        modified = true;
+      },
+      createTemporaryDirectory: () => fs.mkdtemp('test'),
+    });
+
+    expect(modified).toBe(true);
+
+    expect(output).toEqual([
+      '',
+      'Creating backend module backstage-plugin-test-backend-module-tester-two',
+      'Checking Prerequisites:',
+      `availability  plugins${sep}test-backend-module-tester-two`,
+      'creating      temp dir',
+      'Executing Template:',
+      'copying       .eslintrc.js',
+      'templating    README.md.hbs',
+      'templating    package.json.hbs',
+      'templating    index.ts.hbs',
+      'templating    module.ts.hbs',
+      'Installing:',
+      `moving        plugins${sep}test-backend-module-tester-two`,
+      'backend       adding dependency',
+    ]);
+
+    await expect(
+      fs.readJson('/root/packages/backend/package.json'),
+    ).resolves.toEqual({
+      dependencies: {
+        'backstage-plugin-test-backend-module-tester-two': '^1.0.0',
+      },
+    });
+    const moduleFile = await fs.readFile(
+      '/root/plugins/test-backend-module-tester-two/src/module.ts',
+      'utf-8',
+    );
+
+    expect(moduleFile).toContain(
+      `const testModuleTesterTwo = createBackendModule({`,
+    );
+    expect(moduleFile).toContain(`pluginId: 'test',`);
+    expect(moduleFile).toContain(`moduleId: 'tester-two',`);
+
+    expect(Task.forCommand).toHaveBeenCalledTimes(2);
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+      cwd: resolvePath('/root/plugins/test-backend-module-tester-two'),
+      optional: true,
+    });
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+      cwd: resolvePath('/root/plugins/test-backend-module-tester-two'),
+      optional: true,
+    });
+  });
+});

packages/cli/src/lib/new/factories/backendModule.ts

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2021 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 fs from 'fs-extra';
+import chalk from 'chalk';
+import camelCase from 'lodash/camelCase';
+import { paths } from '../../paths';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
+import { createFactory, CreateContext } from '../types';
+import { addPackageDependency, Task } from '../../tasks';
+import {
+  moduleIdIdPrompt,
+  ownerPrompt,
+  pluginIdPrompt,
+} from './common/prompts';
+import { executePluginPackageTemplate } from './common/tasks';
+
+type Options = {
+  id: string;
+  moduleId: string;
+  owner?: string;
+  codeOwnersPath?: string;
+};
+
+export const backendModule = createFactory<Options>({
+  name: 'backend-module',
+  description: 'A new backend module',
+  optionsDiscovery: async () => ({
+    codeOwnersPath: await getCodeownersFilePath(paths.targetRoot),
+  }),
+  optionsPrompts: [pluginIdPrompt(), moduleIdIdPrompt(), ownerPrompt()],
+  async create(options: Options, ctx: CreateContext) {
+    const { id: pluginId, moduleId } = options;
+    const dirName = `${pluginId}-backend-module-${moduleId}`;
+    const name = ctx.scope
+      ? `@${ctx.scope}/plugin-${dirName}`
+      : `backstage-plugin-${dirName}`;
+
+    Task.log();
+    Task.log(`Creating backend module ${chalk.cyan(name)}`);
+
+    const targetDir = ctx.isMonoRepo
+      ? paths.resolveTargetRoot('plugins', dirName)
+      : paths.resolveTargetRoot(`backstage-plugin-${dirName}`);
+
+    const moduleCamelCase = camelCase(moduleId);
+    const modulePascalCase =
+      moduleCamelCase[0].toUpperCase() + moduleCamelCase.slice(1);
+    const moduleVar = `${camelCase(pluginId)}Module${modulePascalCase}`;
+    await executePluginPackageTemplate(ctx, {
+      targetDir,
+      templateName: 'default-backend-module',
+      values: {
+        pluginId,
+        moduleId,
+        name,
+        moduleVar,
+        packageVersion: ctx.defaultVersion,
+        privatePackage: ctx.private,
+        npmRegistry: ctx.npmRegistry,
+      },
+    });
+
+    if (await fs.pathExists(paths.resolveTargetRoot('packages/backend'))) {
+      await Task.forItem('backend', 'adding dependency', async () => {
+        await addPackageDependency(
+          paths.resolveTargetRoot('packages/backend/package.json'),
+          {
+            dependencies: {
+              [name]: `^${ctx.defaultVersion}`,
+            },
+          },
+        );
+      });
+    }
+
+    if (options.owner) {
+      await addCodeownersEntry(`/plugins/${dirName}`, options.owner);
+    }
+
+    await Task.forCommand('yarn install', { cwd: targetDir, optional: true });
+    await Task.forCommand('yarn lint --fix', {
+      cwd: targetDir,
+      optional: true,
+    });
+  },
+});

packages/cli/src/lib/new/factories/common/prompts.ts

@@ -33,6 +33,22 @@ export function pluginIdPrompt(): Prompt<{ id: string }> {
   };
 }
 
+export function moduleIdIdPrompt(): Prompt<{ moduleId: string }> {
+  return {
+    type: 'input',
+    name: 'moduleId',
+    message: 'Enter the ID of the module [required]',
+    validate: (value: string) => {
+      if (!value) {
+        return 'Please enter the ID of the module';
+      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
+        return 'Module IDs must be lowercase and contain only letters, digits, and dashes.';
+      }
+      return true;
+    },
+  };
+}
+
 export function ownerPrompt(): Prompt<{
   owner?: string;
   codeOwnersPath?: string;

packages/cli/src/lib/new/factories/index.ts

@@ -16,6 +16,7 @@
 
 export { frontendPlugin } from './frontendPlugin';
 export { backendPlugin } from './backendPlugin';
+export { backendModule } from './backendModule';
 export { webLibraryPackage } from './webLibraryPackage';
 export { pluginCommon } from './pluginCommon';
 export { pluginNode } from './pluginNode';

packages/cli/src/lib/version.ts

@@ -35,6 +35,8 @@ leaving any imports in place.
 */
 
 import { version as backendCommon } from '../../../../packages/backend-common/package.json';
+import { version as backendPluginApi } from '../../../../packages/backend-plugin-api/package.json';
+import { version as backendTestUtils } from '../../../../packages/backend-test-utils/package.json';
 import { version as cli } from '../../../../packages/cli/package.json';
 import { version as config } from '../../../../packages/config/package.json';
 import { version as coreAppApi } from '../../../../packages/core-app-api/package.json';
@@ -47,6 +49,8 @@ import { version as scaffolderBackend } from '../../../../plugins/scaffolder-bac
 
 export const packageVersions: Record<string, string> = {
   '@backstage/backend-common': backendCommon,
+  '@backstage/backend-plugin-api': backendPluginApi,
+  '@backstage/backend-test-utils': backendTestUtils,
   '@backstage/cli': cli,
   '@backstage/config': config,
   '@backstage/core-app-api': coreAppApi,