feat: add some action

Author: hoangndst

plugins/scaffolder-backend-module-kusion/README.md

@@ -10,8 +10,6 @@ You need to add the following to your `app-config.yaml`. For example:
 backend:
 kusion:
   baseUrl: 'http://localhost:3000'
-  proxyPath: '/api/v1' # Optional - Default is '/api/v1'
-  token: 'your-token'
 ```
 
 ### From your Backstage root directory

plugins/scaffolder-backend-module-kusion/package.json

@@ -4,6 +4,10 @@
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
+  "author": {
+    "email": "[email protected]",
+    "name": "hoangndst"
+  },
   "private": true,
   "publishConfig": {
     "access": "public",
@@ -28,6 +32,7 @@
     "@backstage/backend-plugin-api": "^1.0.2",
     "@backstage/config": "^1.3.0",
     "@backstage/plugin-scaffolder-node": "^0.6.0",
+    "@kusionstack/kusion-api-client-sdk": "^1.1.3",
     "node-fetch": "^2.7.0",
     "yaml": "^2.6.1"
   },

plugins/scaffolder-backend-module-kusion/src/actions/backend/createBackend.test.ts

@@ -1,6 +1,10 @@
 import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
 import { Config } from '@backstage/config';
-import { createKusionApi } from '../../api';
+import { configKusionApi } from '../../api';
+import {
+  BackendService,
+  CreateBackendData,
+} from '@kusionstack/kusion-api-client-sdk';
 import { examples } from './createBackend.example';
 
 /**
@@ -73,33 +77,35 @@ export function createCreateBackendAction(options: { config: Config }) {
     },
     async handler(ctx) {
       const { name, description, backendConfig } = ctx.input;
-      const kusionApi = createKusionApi({ configApi: config });
-      const requestBody = {
-        name,
-        description,
-        backendConfig,
+      configKusionApi({ configApi: config });
+      const requestBody: CreateBackendData = {
+        body: {
+          name: name,
+          description: description,
+          backendConfig: backendConfig,
+        },
       };
 
       ctx.logger.info(
         'Creating backend with the following request body: ',
         requestBody,
       );
 
-      const response = await kusionApi.post('backends', requestBody);
+      const response = await BackendService.createBackend(requestBody);
 
-      if (!response.success || response.data === undefined) {
+      if (!response.data?.success) {
         ctx.logger.error(`
-          Unable to create backend, ${response.message}`);
-        ctx.output('success', response.success);
-        ctx.output('message', response.message);
-        ctx.output('data', '{}');
-        throw new Error(`Unable to create backend, ${response.message}`);
+          Unable to create backend, ${response.data?.message}`);
+        ctx.output('success', response.data?.success);
+        ctx.output('message', response.data?.message);
+        ctx.output('data', JSON.stringify(response.data?.data));
+        throw new Error(`Unable to create backend, ${response.data?.message}`);
       }
 
       ctx.logger.info('Backend created successfully');
-      ctx.output('success', response.success);
-      ctx.output('message', response.message);
-      ctx.output('data', JSON.stringify(response.data));
+      ctx.output('success', response.data?.success);
+      ctx.output('message', response.data?.message);
+      ctx.output('data', JSON.stringify(response.data?.data));
     },
   });
 }

plugins/scaffolder-backend-module-kusion/src/actions/backend/createBackend.ts

@@ -14,14 +14,23 @@
  * limitations under the License.
  */
 
-const DEFAULT_PROXY_PATH = '/api/v1';
+import { TemplateExample } from '@backstage/plugin-scaffolder-node';
+import yaml from 'yaml';
 
-type KusionResponse = {
-  success: boolean;
-  message: string;
-  data?: any;
-  traceID?: string;
-  startTime?: Date;
-  endTime?: Date;
-  costTime?: number;
-};
+export const examples: TemplateExample[] = [
+  {
+    description: 'Delete a backend in Kusion',
+    example: yaml.stringify({
+      steps: [
+        {
+          id: 'delete-backend',
+          action: 'kusion:backend:delete',
+          name: 'Delete backend',
+          input: {
+            id: '1',
+          },
+        },
+      ],
+    }),
+  },
+];

…r-backend-module-kusion/src/api/types.ts …actions/backend/deleteBackend.example.tsplugins/scaffolder-backend-module-kusion/src/api/types.ts renamed to plugins/scaffolder-backend-module-kusion/src/actions/backend/deleteBackend.example.ts plugins/scaffolder-backend-module-kusion/src/api/types.ts renamed to plugins/scaffolder-backend-module-kusion/src/actions/backend/deleteBackend.example.ts

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2024 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-node';
+import { Config } from '@backstage/config';
+import { configKusionApi } from '../../api';
+import {
+  BackendService,
+  DeleteBackendData,
+} from '@kusionstack/kusion-api-client-sdk';
+import { examples } from './deleteBackend.example';
+
+/**
+ * Creates a `kusion:backend:delete` Scaffolder action.
+ *
+ * @public
+ */
+export function createDeleteBackendAction(options: { config: Config }) {
+  const { config } = options;
+  return createTemplateAction<{
+    id: string;
+  }>({
+    id: 'kusion:backend:delete',
+    examples,
+    schema: {
+      input: {
+        type: 'object',
+        required: ['id'],
+        properties: {
+          id: {
+            title: 'Backend ID',
+            type: 'string',
+          },
+        },
+      },
+      output: {
+        type: 'object',
+        properties: {
+          success: {
+            title: 'Success',
+            type: 'boolean',
+          },
+          message: {
+            title: 'Message',
+            type: 'string',
+          },
+          data: {
+            title: 'Data',
+            type: 'object',
+          },
+        },
+      },
+    },
+    async handler(ctx) {
+      const { id } = ctx.input;
+      configKusionApi({ configApi: config });
+
+      ctx.logger.info('Deleting backend with ID: %s', id);
+
+      const request: DeleteBackendData = {
+        path: {
+          backendID: Number(id),
+        },
+      };
+
+      const response = await BackendService.deleteBackend(request);
+
+      if (!response.data?.success) {
+        ctx.logger.error(`
+            Unable to delete backend, ${response.data?.message}`);
+        ctx.output('success', response.data?.success);
+        ctx.output('message', response.data?.message);
+        ctx.output('data', JSON.stringify(response.data?.data));
+        throw new Error(`Unable to delete backend, ${response.data?.message}`);
+      }
+
+      ctx.logger.info('Backend deleted successfully');
+      ctx.output('success', response.data?.success);
+      ctx.output('message', response.data?.message);
+      ctx.output('data', response.data?.data);
+    },
+  });
+}

plugins/scaffolder-backend-module-kusion/src/actions/backend/deleteBackend.ts

@@ -1 +1,2 @@
-export * from "../backend"
+export * from "./createBackend";
+export * from "./deleteBackend";

plugins/scaffolder-backend-module-kusion/src/actions/backend/index.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2024 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 { TemplateExample } from '@backstage/plugin-scaffolder-node';
+import yaml from 'yaml';
+
+export const examples: TemplateExample[] = [
+  {
+    description: 'Create an organization in Kusion',
+    example: yaml.stringify({
+      steps: [
+        {
+          id: 'create-organization',
+          action: 'kusion:organization:create',
+          name: 'Create Organization',
+          input: {
+            name: 'my-workspace',
+            description: 'This is my organization',
+            labels: ['label1', 'label2'],
+            owners: ['owner1', 'owner2'],
+          },
+        },
+      ],
+    }),
+  },
+];