@backstage-community/plugin-scaffolder-backend-module-blackduck 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @backstage-community/plugin-scaffolder-backend-module-blackduck
+
+## 0.0.1
+
+### Patch Changes
+
+- 638b35b: Implemented blackduck scaffolder - project creation action.
+- Updated dependencies [638b35b]
+  - @backstage-community/plugin-blackduck-common@0.2.1
+  - @backstage-community/plugin-blackduck-node@0.0.1

package/README.md

@@ -0,0 +1,70 @@
+# @backstage-community/plugin-scaffolder-backend-module-blackduck
+
+Welcome to the Blackduck scaffolder module.
+
+Available actions:
+
+1. `blackduck:create:project` to create Blackduck project along with version.
+
+## Getting Started
+
+Before you start make sure your existing backstage instance is already setup with [BlackDuck backend plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/blackduck/plugins/blackduck-backend)
+
+### Installation
+
+This module needs to be added to an existing backstage instance.
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/backend add @backstage-community/plugin-scaffolder-backend-module-blackduck
+```
+
+### Configuration(New Backend System)
+
+This backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/), here's how you can set that up:
+
+In your `packages/backend/src/index.ts` make the following changes:
+
+```diff
+  import { createBackend } from '@backstage/backend-defaults';
+
+  const backend = createBackend();
+
+  // ... other feature additions
+
++ backend.add(import('@backstage-community/plugin-scaffolder-backend-module-blackduck'));
+
+  // ...
+
+  backend.start();
+```
+
+### Example template
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: blackduck-create-project
+  title: Blackduck Template to Create Project
+  description: Template to create projects in BlackDuck instance
+spec:
+  owner: guests
+  type: service
+
+  parameters:
+    - title: Provide informance to create project
+      required:
+        - projectName
+      properties:
+        projectName:
+          title: Name
+          type: string
+          description: Unique name of the project
+  steps:
+    - id: blackduck-create-project
+      name: Blackduck Create Project
+      action: blackduck:create:project
+      input:
+        projectName: ${{parameters.projectName}}
+```

package/dist/actions/create-project.cjs.js

@@ -0,0 +1,92 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var pluginBlackduckNode = require('@backstage-community/plugin-blackduck-node');
+
+function createBlackduckProjectAction(blackDuckConfig, logger) {
+  return pluginScaffolderNode.createTemplateAction({
+    id: "blackduck:create:project",
+    description: "Create a Blackduck project",
+    schema: {
+      input: {
+        type: "object",
+        required: ["projectName"],
+        properties: {
+          projectName: {
+            title: "Project Name",
+            description: "Name of the project to be created",
+            type: "string"
+          },
+          projectVersion: {
+            title: "Project Version",
+            description: "Version of the project to be created",
+            type: "string"
+          },
+          versionPhase: {
+            title: "Version Phase",
+            description: "Phase Dev / QA / Prod",
+            type: "string"
+          },
+          versionDistribution: {
+            title: "Version Distribution",
+            description: "Distribution Internal / External",
+            type: "string"
+          },
+          instanceName: {
+            title: "Instance",
+            description: "Name of the Instance",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        projectName,
+        projectVersion,
+        versionPhase = "DEVELOPMENT",
+        versionDistribution = "INTERNAL",
+        instanceName = "default"
+      } = ctx.input;
+      ctx.logger.info(
+        `Creating BlackDuck project: ${projectName} with 
+        version: ${projectVersion} 
+        & phase: ${versionPhase}, distribution: ${versionDistribution} on Instance: ${instanceName}`
+      );
+      let blackduckApiUrl;
+      let blackduckApiToken;
+      try {
+        const hostConfig = blackDuckConfig.getHostConfigByName(instanceName);
+        blackduckApiUrl = hostConfig.host;
+        blackduckApiToken = hostConfig.token;
+      } catch (error) {
+        throw new Error("BlackDuck Config is not valid.");
+      }
+      if (!blackduckApiUrl || !blackduckApiToken) {
+        throw new Error("Blackduck API URL or Token not configured!");
+      }
+      const blackDuckApi = new pluginBlackduckNode.BlackDuckRestApi(
+        logger,
+        blackduckApiUrl,
+        blackduckApiToken
+      );
+      await blackDuckApi.auth();
+      const res = await blackDuckApi.createProject(
+        projectName,
+        projectVersion,
+        versionPhase,
+        versionDistribution
+      );
+      ctx.output("projectName", projectName);
+      ctx.output("projectVersion", projectVersion);
+      ctx.output("versionPhase", versionPhase);
+      ctx.output("versionDistribution", versionDistribution);
+      ctx.output("instanceName", instanceName);
+      ctx.output("status", `${res.status}`);
+      ctx.output("location", `${res.location}`);
+    }
+  });
+}
+
+exports.createBlackduckProjectAction = createBlackduckProjectAction;
+//# sourceMappingURL=create-project.cjs.js.map

package/dist/actions/create-project.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-project.cjs.js","sources":["../../src/actions/create-project.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport {\n  BlackDuckRestApi,\n  BlackDuckConfig,\n} from '@backstage-community/plugin-blackduck-node';\nimport { BD_CREATE_PROJECT_API_RESPONSE } from '@backstage-community/plugin-blackduck-node';\n\n/**\n * @public\n */\nexport function createBlackduckProjectAction(\n  blackDuckConfig: BlackDuckConfig,\n  logger: LoggerService,\n) {\n  // For more information on how to define custom actions, see\n  //   https://backstage.io/docs/features/software-templates/writing-custom-actions\n  return createTemplateAction<{\n    projectName: string;\n    projectVersion?: string;\n    versionPhase?: string;\n    versionDistribution?: string;\n    instanceName?: string;\n  }>({\n    id: 'blackduck:create:project',\n    description: 'Create a Blackduck project',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['projectName'],\n        properties: {\n          projectName: {\n            title: 'Project Name',\n            description: 'Name of the project to be created',\n            type: 'string',\n          },\n          projectVersion: {\n            title: 'Project Version',\n            description: 'Version of the project to be created',\n            type: 'string',\n          },\n          versionPhase: {\n            title: 'Version Phase',\n            description: 'Phase Dev / QA / Prod',\n            type: 'string',\n          },\n          versionDistribution: {\n            title: 'Version Distribution',\n            description: 'Distribution Internal / External',\n            type: 'string',\n          },\n          instanceName: {\n            title: 'Instance',\n            description: 'Name of the Instance',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        projectName,\n        projectVersion,\n        versionPhase = 'DEVELOPMENT',\n        versionDistribution = 'INTERNAL',\n        instanceName = 'default',\n      } = ctx.input;\n\n      ctx.logger.info(\n        `Creating BlackDuck project: ${projectName} with \n        version: ${projectVersion} \n        & phase: ${versionPhase}, distribution: ${versionDistribution} on Instance: ${instanceName}`,\n      );\n\n      let blackduckApiUrl: string;\n      let blackduckApiToken: string;\n\n      try {\n        const hostConfig = blackDuckConfig.getHostConfigByName(instanceName);\n        blackduckApiUrl = hostConfig.host;\n        blackduckApiToken = hostConfig.token;\n      } catch (error) {\n        throw new Error('BlackDuck Config is not valid.');\n      }\n\n      if (!blackduckApiUrl || !blackduckApiToken) {\n        throw new Error('Blackduck API URL or Token not configured!');\n      }\n\n      const blackDuckApi = new BlackDuckRestApi(\n        logger,\n        blackduckApiUrl,\n        blackduckApiToken,\n      );\n\n      await blackDuckApi.auth();\n\n      const res: BD_CREATE_PROJECT_API_RESPONSE =\n        await blackDuckApi.createProject(\n          projectName,\n          projectVersion,\n          versionPhase,\n          versionDistribution,\n        );\n\n      ctx.output('projectName', projectName);\n      ctx.output('projectVersion', projectVersion);\n      ctx.output('versionPhase', versionPhase);\n      ctx.output('versionDistribution', versionDistribution);\n      ctx.output('instanceName', instanceName);\n      ctx.output('status', `${res.status}`);\n      ctx.output('location', `${res.location}`);\n    },\n  });\n}\n"],"names":["createTemplateAction","BlackDuckRestApi"],"mappings":";;;;;AA0BgB,SAAA,4BAAA,CACd,iBACA,MACA,EAAA;AAGA,EAAA,OAAOA,yCAMJ,CAAA;AAAA,IACD,EAAI,EAAA,0BAAA;AAAA,IACJ,WAAa,EAAA,4BAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,aAAa,CAAA;AAAA,QACxB,UAAY,EAAA;AAAA,UACV,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,WAAa,EAAA,mCAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA,sCAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,eAAA;AAAA,YACP,WAAa,EAAA,uBAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,mBAAqB,EAAA;AAAA,YACnB,KAAO,EAAA,sBAAA;AAAA,YACP,WAAa,EAAA,kCAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,UAAA;AAAA,YACP,WAAa,EAAA,sBAAA;AAAA,YACb,IAAM,EAAA;AAAA;AACR;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,WAAA;AAAA,QACA,cAAA;AAAA,QACA,YAAe,GAAA,aAAA;AAAA,QACf,mBAAsB,GAAA,UAAA;AAAA,QACtB,YAAe,GAAA;AAAA,UACb,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,+BAA+B,WAAW,CAAA;AAAA,iBAAA,EAC/B,cAAc,CAAA;AAAA,iBAAA,EACd,YAAY,CAAA,gBAAA,EAAmB,mBAAmB,CAAA,cAAA,EAAiB,YAAY,CAAA;AAAA,OAC5F;AAEA,MAAI,IAAA,eAAA;AACJ,MAAI,IAAA,iBAAA;AAEJ,MAAI,IAAA;AACF,QAAM,MAAA,UAAA,GAAa,eAAgB,CAAA,mBAAA,CAAoB,YAAY,CAAA;AACnE,QAAA,eAAA,GAAkB,UAAW,CAAA,IAAA;AAC7B,QAAA,iBAAA,GAAoB,UAAW,CAAA,KAAA;AAAA,eACxB,KAAO,EAAA;AACd,QAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA;AAAA;AAGlD,MAAI,IAAA,CAAC,eAAmB,IAAA,CAAC,iBAAmB,EAAA;AAC1C,QAAM,MAAA,IAAI,MAAM,4CAA4C,CAAA;AAAA;AAG9D,MAAA,MAAM,eAAe,IAAIC,oCAAA;AAAA,QACvB,MAAA;AAAA,QACA,eAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,MAAM,aAAa,IAAK,EAAA;AAExB,MAAM,MAAA,GAAA,GACJ,MAAM,YAAa,CAAA,aAAA;AAAA,QACjB,WAAA;AAAA,QACA,cAAA;AAAA,QACA,YAAA;AAAA,QACA;AAAA,OACF;AAEF,MAAI,GAAA,CAAA,MAAA,CAAO,eAAe,WAAW,CAAA;AACrC,MAAI,GAAA,CAAA,MAAA,CAAO,kBAAkB,cAAc,CAAA;AAC3C,MAAI,GAAA,CAAA,MAAA,CAAO,gBAAgB,YAAY,CAAA;AACvC,MAAI,GAAA,CAAA,MAAA,CAAO,uBAAuB,mBAAmB,CAAA;AACrD,MAAI,GAAA,CAAA,MAAA,CAAO,gBAAgB,YAAY,CAAA;AACvC,MAAA,GAAA,CAAI,MAAO,CAAA,QAAA,EAAU,CAAG,EAAA,GAAA,CAAI,MAAM,CAAE,CAAA,CAAA;AACpC,MAAA,GAAA,CAAI,MAAO,CAAA,UAAA,EAAY,CAAG,EAAA,GAAA,CAAI,QAAQ,CAAE,CAAA,CAAA;AAAA;AAC1C,GACD,CAAA;AACH;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var createProject = require('./actions/create-project.cjs.js');
+var module$1 = require('./module.cjs.js');
+
+
+
+exports.createBlackduckProjectAction = createProject.createBlackduckProjectAction;
+exports.default = module$1.scaffolderModuleBlackduckModule;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

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

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import * as _backstage_types_index from '@backstage/types/index';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService } from '@backstage/backend-plugin-api';
+import { BlackDuckConfig } from '@backstage-community/plugin-blackduck-node';
+
+/**
+ * @public
+ */
+declare function createBlackduckProjectAction(blackDuckConfig: BlackDuckConfig, logger: LoggerService): _backstage_plugin_scaffolder_node.TemplateAction<{
+    projectName: string;
+    projectVersion?: string | undefined;
+    versionPhase?: string | undefined;
+    versionDistribution?: string | undefined;
+    instanceName?: string | undefined;
+}, _backstage_types_index.JsonObject>;
+
+/**
+ * @public
+ */
+declare const scaffolderModuleBlackduckModule: _backstage_backend_plugin_api.BackendFeature;
+
+export { createBlackduckProjectAction, scaffolderModuleBlackduckModule as default };

package/dist/module.cjs.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
+var createProject = require('./actions/create-project.cjs.js');
+var pluginBlackduckNode = require('@backstage-community/plugin-blackduck-node');
+
+const scaffolderModuleBlackduckModule = backendPluginApi.createBackendModule({
+  moduleId: "scaffolder:backend:module:blackduck",
+  pluginId: "scaffolder",
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolderActions: alpha.scaffolderActionsExtensionPoint,
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger
+      },
+      async init({ scaffolderActions, config, logger }) {
+        const blackDuckConfig = pluginBlackduckNode.BlackDuckConfig.fromConfig(config);
+        scaffolderActions.addActions(
+          createProject.createBlackduckProjectAction(blackDuckConfig, logger)
+        );
+      }
+    });
+  }
+});
+
+exports.scaffolderModuleBlackduckModule = scaffolderModuleBlackduckModule;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 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  createBackendModule,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport { createBlackduckProjectAction } from './actions';\nimport { BlackDuckConfig } from '@backstage-community/plugin-blackduck-node';\n\n/**\n * @public\n */\nexport const scaffolderModuleBlackduckModule = createBackendModule({\n  moduleId: 'scaffolder:backend:module:blackduck',\n  pluginId: 'scaffolder',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolderActions: scaffolderActionsExtensionPoint,\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n      },\n      async init({ scaffolderActions, config, logger }) {\n        const blackDuckConfig = BlackDuckConfig.fromConfig(config);\n        scaffolderActions.addActions(\n          createBlackduckProjectAction(blackDuckConfig, logger),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","BlackDuckConfig","createBlackduckProjectAction"],"mappings":";;;;;;;AA0BO,MAAM,kCAAkCA,oCAAoB,CAAA;AAAA,EACjE,QAAU,EAAA,qCAAA;AAAA,EACV,QAAU,EAAA,YAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAgB,EAAA;AACzB,IAAa,YAAA,CAAA;AAAA,MACX,IAAM,EAAA;AAAA,QACJ,iBAAmB,EAAAC,qCAAA;AAAA,QACnB,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,iBAAmB,EAAA,MAAA,EAAQ,QAAU,EAAA;AAChD,QAAM,MAAA,eAAA,GAAkBC,mCAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AACzD,QAAkB,iBAAA,CAAA,UAAA;AAAA,UAChBC,0CAAA,CAA6B,iBAAiB,MAAM;AAAA,SACtD;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@backstage-community/plugin-scaffolder-backend-module-blackduck",
+  "description": "The blackduck module for @backstage/plugin-scaffolder-backend",
+  "version": "0.0.1",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/blackduck/plugins/scaffolder-backend-module-blackduck"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder",
+    "pluginPackage": "@backstage/plugin-scaffolder-backend"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage-community/plugin-blackduck-common": "^0.2.1",
+    "@backstage-community/plugin-blackduck-node": "^0.0.1",
+    "@backstage/backend-plugin-api": "^1.1.1",
+    "@backstage/plugin-scaffolder-node": "^0.6.3"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.29.6",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.1.18"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ]
+    }
+  }
+}