cli: add create factory for scaffolder modules

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

.changeset/shiny-starfishes-float.md

@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Added a scaffolder backend module template for the `create` command.

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

@@ -17,3 +17,4 @@
 export { frontendPlugin } from './frontendPlugin';
 export { backendPlugin } from './backendPlugin';
 export { pluginCommon } from './pluginCommon';
+export { scaffolderModule } from './scaffolderModule';

packages/cli/src/lib/create/factories/scaffolderModule.test.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 { paths } from '../../paths';
+import { Task } from '../../tasks';
+import { FactoryRegistry } from '../FactoryRegistry';
+import { createMockOutputStream, mockPaths } from './common/testUtils';
+import { scaffolderModule } from './scaffolderModule';
+
+describe('scaffolderModule factory', () => {
+  beforeEach(() => {
+    mockPaths({
+      targetRoot: '/root',
+    });
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+    jest.resetAllMocks();
+  });
+
+  it('should create a scaffolder backend module package', async () => {
+    mockFs({
+      '/root': {
+        plugins: mockFs.directory(),
+      },
+      [paths.resolveOwn('templates')]: mockFs.load(
+        paths.resolveOwn('templates'),
+      ),
+    });
+
+    const options = await FactoryRegistry.populateOptions(scaffolderModule, {
+      id: 'test',
+    });
+
+    let modified = false;
+
+    const [output, mockStream] = createMockOutputStream();
+    jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+    jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+    await scaffolderModule.create(options, {
+      private: true,
+      isMonoRepo: true,
+      defaultVersion: '1.0.0',
+      markAsModified: () => {
+        modified = true;
+      },
+      createTemporaryDirectory: (name: string) => fs.mkdtemp(name),
+    });
+
+    expect(modified).toBe(true);
+
+    expect(output).toEqual([
+      '',
+      'Creating module backstage-plugin-scaffolder-backend-module-test',
+      'Checking Prerequisites:',
+      'availability  plugins/scaffolder-backend-module-test ✔',
+      'creating      temp dir ✔',
+      'Executing Template:',
+      'copying       .eslintrc.js ✔',
+      'templating    README.md.hbs ✔',
+      'templating    package.json.hbs ✔',
+      'copying       tsconfig.json ✔',
+      'templating    index.ts.hbs ✔',
+      'copying       index.ts ✔',
+      'copying       example.test.ts ✔',
+      'copying       example.ts ✔',
+      'copying       index.ts ✔',
+      'Installing:',
+      'moving        plugins/scaffolder-backend-module-test ✔',
+    ]);
+
+    await expect(
+      fs.readJson('/root/plugins/scaffolder-backend-module-test/package.json'),
+    ).resolves.toEqual(
+      expect.objectContaining({
+        name: 'backstage-plugin-scaffolder-backend-module-test',
+        description: 'The test module for @backstage/plugin-scaffolder-backend',
+        private: true,
+        version: '1.0.0',
+      }),
+    );
+
+    expect(Task.forCommand).toHaveBeenCalledTimes(2);
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+      cwd: '/root/plugins/scaffolder-backend-module-test',
+      optional: true,
+    });
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+      cwd: '/root/plugins/scaffolder-backend-module-test',
+      optional: true,
+    });
+  });
+});

packages/cli/src/lib/create/factories/scaffolderModule.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 chalk from 'chalk';
+import { paths } from '../../paths';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
+import { createFactory, CreateContext } from '../types';
+import { Task } from '../../tasks';
+import { ownerPrompt } from './common/prompts';
+import { executePluginPackageTemplate } from './common/tasks';
+
+type Options = {
+  id: string;
+  owner?: string;
+  codeOwnersPath?: string;
+};
+
+export const scaffolderModule = createFactory<Options>({
+  name: 'scaffolder-module',
+  description:
+    'An module exporting custom actions for @backstage/plugin-scaffolder-backend',
+  optionsDiscovery: async () => ({
+    codeOwnersPath: await getCodeownersFilePath(paths.targetRoot),
+  }),
+  optionsPrompts: [
+    {
+      type: 'input',
+      name: 'id',
+      message: 'Enter the name of the module [required]',
+      validate: (value: string) => {
+        if (!value) {
+          return 'Please enter the name of the module';
+        } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
+          return 'Module names must be lowercase and contain only letters, digits, and dashes.';
+        }
+        return true;
+      },
+    },
+    ownerPrompt(),
+  ],
+  async create(options: Options, ctx: CreateContext) {
+    const { id } = options;
+    const slug = `scaffolder-backend-module-${id}`;
+
+    let name = `backstage-plugin-${slug}`;
+    if (ctx.scope) {
+      if (ctx.scope === 'backstage') {
+        name = `@backstage/plugin-${slug}`;
+      } else {
+        name = `@${ctx.scope}/backstage-plugin-${slug}`;
+      }
+    }
+
+    Task.log();
+    Task.log(`Creating module ${chalk.cyan(name)}`);
+
+    const targetDir = ctx.isMonoRepo
+      ? paths.resolveTargetRoot('plugins', slug)
+      : paths.resolveTargetRoot(`backstage-plugin-${slug}`);
+
+    await executePluginPackageTemplate(ctx, {
+      targetDir,
+      templateName: 'scaffolder-module',
+      values: {
+        id,
+        name,
+        privatePackage: ctx.private,
+        npmRegistry: ctx.npmRegistry,
+        pluginVersion: ctx.defaultVersion,
+      },
+    });
+
+    if (options.owner) {
+      await addCodeownersEntry(`/plugins/${slug}`, 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/version.ts

@@ -42,6 +42,7 @@ import { version as corePluginApi } from '@backstage/core-plugin-api/package.jso
 import { version as devUtils } from '@backstage/dev-utils/package.json';
 import { version as testUtils } from '@backstage/test-utils/package.json';
 import { version as theme } from '@backstage/theme/package.json';
+import { version as scaffolderBackend } from '@backstage/plugin-scaffolder-backend/package.json';
 
 export const packageVersions: Record<string, string> = {
   '@backstage/backend-common': backendCommon,
@@ -53,6 +54,7 @@ export const packageVersions: Record<string, string> = {
   '@backstage/dev-utils': devUtils,
   '@backstage/test-utils': testUtils,
   '@backstage/theme': theme,
+  '@backstage/plugin-scaffolder-backend': scaffolderBackend,
 };
 
 export function findVersion() {

packages/cli/templates/scaffolder-module/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: [require.resolve('@backstage/cli/config/eslint.backend')],
+};

packages/cli/templates/scaffolder-module/README.md.hbs

@@ -0,0 +1,5 @@
+# {{name}}
+
+The {{id}} module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend).
+
+_This plugin was created through the Backstage CLI_

packages/cli/templates/scaffolder-module/package.json.hbs

@@ -0,0 +1,37 @@
+{
+  "name": "{{name}}",
+  "description": "The {{id}} module for @backstage/plugin-scaffolder-backend",
+  "version": "{{pluginVersion}}",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+{{#if privatePackage}}
+  "private": {{privatePackage}},
+{{/if}}
+  "publishConfig": {
+{{#if npmRegistry}}
+    "registry": "{{npmRegistry}}",
+{{/if}}
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "build": "backstage-cli build --output cjs,types",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/plugin-scaffolder-backend": "{{versionQuery '@backstage/plugin-scaffolder-backend'}}"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "{{versionQuery '@backstage/backend-common'}}",
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

packages/cli/templates/scaffolder-module/src/actions/example/example.test.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 { PassThrough } from 'stream';
+import { createAcmeExampleAction } from './example';
+import { getVoidLogger } from '@backstage/backend-common';
+
+describe('acme:example', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should call action', async () => {
+    const action = createAcmeExampleAction();
+
+    const logger = getVoidLogger();
+    jest.spyOn(logger, 'info');
+
+    await action.handler({
+      input: {
+        myParameter: 'test',
+      },
+      workspacePath: '/tmp',
+      logger,
+      logStream: new PassThrough(),
+      output: jest.fn(),
+      createTemporaryDirectory() {
+        // Usage of mock-fs is recommended for testing of filesystem operations
+        throw new Error('Not implemented');
+      },
+    });
+
+    expect(logger.info).toHaveBeenCalledWith(
+      'Running example template with parameters: test',
+    );
+  });
+});

packages/cli/templates/scaffolder-module/src/actions/example/example.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 { createTemplateAction } from '@backstage/plugin-scaffolder-backend';
+
+/**
+ * Creates an `acme:example` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://example.com} for more information.
+ *
+ * @public
+ */
+export function createAcmeExampleAction() {
+  // For more information on how to define custom actions, see
+  //   https://backstage.io/docs/features/software-templates/writing-custom-actions
+  return createTemplateAction<{
+    myParameter: string;
+  }>({
+    id: 'acme:example',
+    description: 'Runs Yeoman on an installed Yeoman generator',
+    schema: {
+      input: {
+        type: 'object',
+        required: ['myParameter'],
+        properties: {
+          myParameter: {
+            title: 'An example parameter',
+            description: 'This is the schema for our example parameter',
+            type: 'string',
+          },
+        },
+      },
+    },
+    async handler(ctx) {
+      ctx.logger.info(
+        `Running example template with parameters: ${ctx.input.myParameter}`,
+      );
+
+      await new Promise(resolve => setTimeout(resolve, 1000));
+    },
+  });
+}

packages/cli/templates/scaffolder-module/src/actions/example/index.ts

@@ -0,0 +1 @@
+export { createAcmeExampleAction } from './example';

packages/cli/templates/scaffolder-module/src/actions/index.ts

@@ -0,0 +1 @@
+export * from './example';

packages/cli/templates/scaffolder-module/src/index.ts.hbs

@@ -0,0 +1,8 @@
+/***/
+/**
+ * The {{id}} module for @backstage/plugin-scaffolder-backend.
+ *
+ * @packageDocumentation
+ */
+
+export * from './actions';

packages/cli/templates/scaffolder-module/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@backstage/cli/config/tsconfig.json",
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "outDir": "dist-types",
+    "rootDir": "."
+  }
+}