@backstage/cli 0.8.1 → 0.10.0

package/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',
+    );
+  });
+});

package/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));
+    },
+  });
+}

package/templates/scaffolder-module/src/actions/example/index.ts

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

package/templates/scaffolder-module/src/actions/index.ts

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

package/templates/scaffolder-module/src/index.ts.hbs

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

package/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": "."
+  }
+}

package/dist/cjs/buildImage-62344040.cjs.js

@@ -1,77 +0,0 @@
-'use strict';
-
-var chalk = require('chalk');
-var fs = require('fs-extra');
-var path = require('path');
-var index$1 = require('./index-69ec4ee3.cjs.js');
-var index = require('./index-1db5f8d6.cjs.js');
-var run = require('./run-a312f9a6.cjs.js');
-var parallel = require('./parallel-a4714c72.cjs.js');
-require('os');
-require('tar');
-require('commander');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/config/package.json');
-require('@backstage/errors');
-require('child_process');
-require('util');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-
-const PKG_PATH = "package.json";
-var buildImage = async (cmd) => {
-  if (cmd.args.includes("--help")) {
-    await run.run("docker", ["image", "build", "--help"]);
-    return;
-  }
-  console.warn(chalk.yellow(`
-The backend:build-image command is deprecated and will be removed in the future.
-Please use the backend:bundle command instead along with your own Docker setup.
-
-  https://backstage.io/docs/deployment/docker
-`));
-  const pkgPath = index.paths.resolveTarget(PKG_PATH);
-  const pkg = await fs__default['default'].readJson(pkgPath);
-  const appConfigs = await findAppConfigs();
-  const npmrc = await fs__default['default'].pathExists(index.paths.resolveTargetRoot(".npmrc")) ? [".npmrc"] : [];
-  const tempDistWorkspace = await index$1.createDistWorkspace([pkg.name], {
-    buildDependencies: Boolean(cmd.build),
-    files: [
-      "package.json",
-      "yarn.lock",
-      ...npmrc,
-      ...appConfigs,
-      {src: index.paths.resolveTarget("Dockerfile"), dest: "Dockerfile"}
-    ],
-    parallel: parallel.parseParallel(process.env[parallel.PARALLEL_ENV_VAR]),
-    skeleton: "skeleton.tar"
-  });
-  console.log(`Dist workspace ready at ${tempDistWorkspace}`);
-  await run.run("docker", ["image", "build", ".", ...cmd.args], {
-    cwd: tempDistWorkspace
-  });
-  await fs__default['default'].remove(tempDistWorkspace);
-};
-async function findAppConfigs() {
-  const files = [];
-  for (const name of await fs__default['default'].readdir(index.paths.targetRoot)) {
-    if (name.startsWith("app-config.") && name.endsWith(".yaml")) {
-      files.push(name);
-    }
-  }
-  if (index.paths.targetRoot !== index.paths.targetDir) {
-    const dirPath = path.relative(index.paths.targetRoot, index.paths.targetDir);
-    for (const name of await fs__default['default'].readdir(index.paths.targetDir)) {
-      if (name.startsWith("app-config.") && name.endsWith(".yaml")) {
-        files.push(path.join(dirPath, name));
-      }
-    }
-  }
-  return files;
-}
-
-exports.default = buildImage;
-//# sourceMappingURL=buildImage-62344040.cjs.js.map