@certd/pipeline 1.0.0

package/src/registry/registry.ts

@@ -0,0 +1,57 @@
+export type Registrable = {
+  name: string;
+  title: string;
+  desc?: string;
+};
+
+export type RegistryItem<T> = {
+  define: Registrable;
+  target: T;
+};
+export class Registry<T> {
+  storage: {
+    [key: string]: RegistryItem<T>;
+  } = {};
+
+  register(key: string, value: RegistryItem<T>) {
+    if (!key || value == null) {
+      return;
+    }
+    this.storage[key] = value;
+  }
+
+  get(name: string): RegistryItem<T> {
+    if (!name) {
+      throw new Error("插件名称不能为空");
+    }
+
+    const plugin = this.storage[name];
+    if (!plugin) {
+      throw new Error(`插件${name}还未注册`);
+    }
+    return plugin;
+  }
+
+  getStorage() {
+    return this.storage;
+  }
+
+  getDefineList() {
+    const list = [];
+    for (const key in this.storage) {
+      const define = this.getDefine(key);
+      if (define) {
+        list.push({ ...define, key });
+      }
+    }
+    return list;
+  }
+
+  getDefine(key: string) {
+    const item = this.storage[key];
+    if (!item) {
+      return;
+    }
+    return item.define;
+  }
+}

package/src/utils/index.ts

@@ -0,0 +1,7 @@
+import sleep from "./util.sleep";
+import { request } from "./util.request";
+export * from "./util.log";
+export const utils = {
+  sleep,
+  http: request,
+};

package/src/utils/util.log.ts

@@ -0,0 +1,35 @@
+import log4js, { LoggingEvent, Logger } from "log4js";
+
+const OutputAppender = {
+  configure: (config: any, layouts: any, findAppender: any, levels: any) => {
+    let layout = layouts.basicLayout;
+    if (config.layout) {
+      layout = layouts.layout(config.layout.type, config.layout);
+    }
+    function customAppender(layout: any, timezoneOffset: any) {
+      return (loggingEvent: LoggingEvent) => {
+        if (loggingEvent.context.outputHandler?.write) {
+          const text = `${layout(loggingEvent, timezoneOffset)}\n`;
+          loggingEvent.context.outputHandler.write(text);
+        }
+      };
+    }
+    return customAppender(layout, config.timezoneOffset);
+  },
+};
+
+// @ts-ignore
+log4js.configure({
+  appenders: { std: { type: "stdout" }, output: { type: OutputAppender } },
+  categories: { default: { appenders: ["std"], level: "info" }, pipeline: { appenders: ["std", "output"], level: "info" } },
+});
+export const logger = log4js.getLogger("default");
+
+export function buildLogger(write: (text: string) => void) {
+  const logger = log4js.getLogger("pipeline");
+  logger.addContext("outputHandler", {
+    write,
+  });
+  return logger;
+}
+export type ILogger = Logger;

package/src/utils/util.request.ts

@@ -0,0 +1,58 @@
+import axios from "axios";
+// @ts-ignore
+import qs from "qs";
+import { logger } from "./util.log";
+/**
+ * @description 创建请求实例
+ */
+function createService() {
+  // 创建一个 axios 实例
+  const service = axios.create();
+  // 请求拦截
+  service.interceptors.request.use(
+    (config: any) => {
+      if (config.formData) {
+        config.data = qs.stringify(config.formData, {
+          arrayFormat: "indices",
+          allowDots: true,
+        }); // 序列化请求参数
+        delete config.formData;
+      }
+      return config;
+    },
+    (error: Error) => {
+      // 发送失败
+      logger.error(error);
+      return Promise.reject(error);
+    }
+  );
+  // 响应拦截
+  service.interceptors.response.use(
+    (response: any) => {
+      logger.info("http response:", JSON.stringify(response.data));
+      return response.data;
+    },
+    (error: any) => {
+      // const status = _.get(error, 'response.status')
+      // switch (status) {
+      //   case 400: error.message = '请求错误'; break
+      //   case 401: error.message = '未授权，请登录'; break
+      //   case 403: error.message = '拒绝访问'; break
+      //   case 404: error.message = `请求地址出错: ${error.response.config.url}`; break
+      //   case 408: error.message = '请求超时'; break
+      //   case 500: error.message = '服务器内部错误'; break
+      //   case 501: error.message = '服务未实现'; break
+      //   case 502: error.message = '网关错误'; break
+      //   case 503: error.message = '服务不可用'; break
+      //   case 504: error.message = '网关超时'; break
+      //   case 505: error.message = 'HTTP版本不受支持'; break
+      //   default: break
+      // }
+      logger.error("请求出错：", error.response.config.url, error);
+      return Promise.reject(error);
+    }
+  );
+  return service;
+}
+
+export const request = createService();

package/src/utils/util.sleep.ts

@@ -0,0 +1,7 @@
+export default function (timeout: number) {
+  return new Promise((resolve) => {
+    setTimeout(() => {
+      resolve({});
+    }, timeout);
+  });
+}

package/test/cert.fake.test.ts

@@ -0,0 +1,58 @@
+export const fakeCrt = `-----BEGIN CERTIFICATE-----
+MIIFSTCCBDGgAwIBAgITAPoZZk/LhVIyXoic2NnJyxubezANBgkqhkiG9w0BAQsF
+ADAiMSAwHgYDVQQDDBdGYWtlIExFIEludGVybWVkaWF0ZSBYMTAeFw0yMDEyMTQx
+NjA1NTFaFw0yMTAzMTQxNjA1NTFaMBsxGTAXBgNVBAMMECouZG9jbWlycm9yLmNs
+dWIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC75tGrYjly+RpcZehQ
+my1EpaXElT4L60pINKV2YDKnBrcSSo1c6rO7nFh12eC/ju4WwYUep0RVmBDF8xD0
+I1Sd1uuDTQWP0UT1X9yqdXtjvxpUqoCHAzG633f3sJRFul7mDLuC9tRCuae9o7qP
+EZ827XOmjBR35dso9I2GEE4828J3YE3tSKtobZlM+30jozLEcsO0PTyM5mq5PPjP
+VI3fGLcEaBmLZf5ixz4XkcY9IAhyAMYf03cT2wRoYPBaDdXblgCYL6sFtIMbzl3M
+Di94PB8NyoNSsC2nmBdWi54wFOgBvY/4ljsX/q7X3EqlSvcA0/M6/c/J9kJ3eupv
+jV8nAgMBAAGjggJ9MIICeTAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYB
+BQUHAwEGCCsGAQUFBwMCMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFAkdTjSCV3KD
+x28sf98MrwVfyFYgMB8GA1UdIwQYMBaAFMDMA0a5WCDMXHJw8+EuyyCm9Wg6MHcG
+CCsGAQUFBwEBBGswaTAyBggrBgEFBQcwAYYmaHR0cDovL29jc3Auc3RnLWludC14
+MS5sZXRzZW5jcnlwdC5vcmcwMwYIKwYBBQUHMAKGJ2h0dHA6Ly9jZXJ0LnN0Zy1p
+bnQteDEubGV0c2VuY3J5cHQub3JnLzArBgNVHREEJDAighAqLmRvY21pcnJvci5j
+bHVigg5kb2NtaXJyb3IuY2x1YjBMBgNVHSAERTBDMAgGBmeBDAECATA3BgsrBgEE
+AYLfEwEBATAoMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxldHNlbmNyeXB0Lm9y
+ZzCCAQQGCisGAQQB1nkCBAIEgfUEgfIA8AB1ABboacHRlerXw/iXGuPwdgH3jOG2
+nTGoUhi2g38xqBUIAAABdmI3LM4AAAQDAEYwRAIgaiNqXSEq+sxp8eqlJXp/KFdO
+so5mT50MoRsLF8Inu0ACIDP46+ekng7I0BlmyIPmbqFcZgnZFVWLLCdLYijhVyOL
+AHcA3Zk0/KXnJIDJVmh9gTSZCEmySfe1adjHvKs/XMHzbmQAAAF2YjcuxwAABAMA
+SDBGAiEAxpeB8/w4YkHZ62nH20h128VtuTSmYDCnF7EK2fQyeZYCIQDbJlF2wehZ
+sF1BeE7qnYYqCTP0dYIrQ9HWtBa/MbGOKTANBgkqhkiG9w0BAQsFAAOCAQEAL2di
+HKh6XcZtGk0BFxJa51sCZ3MLu9+Zy90kCRD4ooP5x932WxVM25+LBRd+xSzx+TRL
+UVrlKp9GdMYX1JXL4Vf2NwzuFO3snPDe/qizD/3+D6yo8eKJ/LD82t5kLWAD2rto
+YfVSTKwfNIBBJwHUnjviBPJmheHHCKmz8Ct6/6QxFAeta9TAMn0sFeVCQnmAq7HL
+jrunq0tNHR/EKG0ITPLf+6P7MxbmpYNnq918766l0tKsW8oo8ZSGEwKU2LMaSiAa
+hasyl/2gMnYXjtKOjDcnR8oLpbrOg0qpVbynmJin1HP835oHPPAZ1gLsqYTTizNz
+AHxTaXliTVvS83dogw==
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIEqzCCApOgAwIBAgIRAIvhKg5ZRO08VGQx8JdhT+UwDQYJKoZIhvcNAQELBQAw
+GjEYMBYGA1UEAwwPRmFrZSBMRSBSb290IFgxMB4XDTE2MDUyMzIyMDc1OVoXDTM2
+MDUyMzIyMDc1OVowIjEgMB4GA1UEAwwXRmFrZSBMRSBJbnRlcm1lZGlhdGUgWDEw
+ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDtWKySDn7rWZc5ggjz3ZB0
+8jO4xti3uzINfD5sQ7Lj7hzetUT+wQob+iXSZkhnvx+IvdbXF5/yt8aWPpUKnPym
+oLxsYiI5gQBLxNDzIec0OIaflWqAr29m7J8+NNtApEN8nZFnf3bhehZW7AxmS1m0
+ZnSsdHw0Fw+bgixPg2MQ9k9oefFeqa+7Kqdlz5bbrUYV2volxhDFtnI4Mh8BiWCN
+xDH1Hizq+GKCcHsinDZWurCqder/afJBnQs+SBSL6MVApHt+d35zjBD92fO2Je56
+dhMfzCgOKXeJ340WhW3TjD1zqLZXeaCyUNRnfOmWZV8nEhtHOFbUCU7r/KkjMZO9
+AgMBAAGjgeMwgeAwDgYDVR0PAQH/BAQDAgGGMBIGA1UdEwEB/wQIMAYBAf8CAQAw
+HQYDVR0OBBYEFMDMA0a5WCDMXHJw8+EuyyCm9Wg6MHoGCCsGAQUFBwEBBG4wbDA0
+BggrBgEFBQcwAYYoaHR0cDovL29jc3Auc3RnLXJvb3QteDEubGV0c2VuY3J5cHQu
+b3JnLzA0BggrBgEFBQcwAoYoaHR0cDovL2NlcnQuc3RnLXJvb3QteDEubGV0c2Vu
+Y3J5cHQub3JnLzAfBgNVHSMEGDAWgBTBJnSkikSg5vogKNhcI5pFiBh54DANBgkq
+hkiG9w0BAQsFAAOCAgEABYSu4Il+fI0MYU42OTmEj+1HqQ5DvyAeyCA6sGuZdwjF
+UGeVOv3NnLyfofuUOjEbY5irFCDtnv+0ckukUZN9lz4Q2YjWGUpW4TTu3ieTsaC9
+AFvCSgNHJyWSVtWvB5XDxsqawl1KzHzzwr132bF2rtGtazSqVqK9E07sGHMCf+zp
+DQVDVVGtqZPHwX3KqUtefE621b8RI6VCl4oD30Olf8pjuzG4JKBFRFclzLRjo/h7
+IkkfjZ8wDa7faOjVXx6n+eUQ29cIMCzr8/rNWHS9pYGGQKJiY2xmVC9h12H99Xyf
+zWE9vb5zKP3MVG6neX1hSdo7PEAb9fqRhHkqVsqUvJlIRmvXvVKTwNCP3eCjRCCI
+PTAvjV+4ni786iXwwFYNz8l3PmPLCyQXWGohnJ8iBm+5nk7O2ynaPVW0U2W+pt2w
+SVuvdDM5zGv2f9ltNWUiYZHJ1mmO97jSY/6YfdOUH66iRtQtDkHBRdkNBsMbD+Em
+2TgBldtHNSJBfB3pm9FblgOcJ0FSWcUDWJ7vO0+NTXlgrRofRT6pVywzxVo6dND0
+WzYlTWeUVsO40xJqhgUQRER9YLOLxJ0O6C8i0xFxAMKOtSdodMB3RIwt7RFQ0uyt
+n5Z5MqkYhlMI3J1tPRTp1nEt9fyGspBOO05gi148Qasp+3N+svqKomoQglNoAxU=
+-----END CERTIFICATE-----`;

package/test/echo-plugin.ts

@@ -0,0 +1,30 @@
+import { Autowire, ILogger, IsTaskPlugin, ITaskPlugin, TaskInput, TaskOutput } from "../src";
+
+@IsTaskPlugin({
+  name: "EchoPlugin",
+  title: "测试插件【echo】",
+})
+export class EchoPlugin implements ITaskPlugin {
+  @TaskInput({
+    title: "cert",
+    component: {
+      name: "pi-output-selector",
+    },
+    helper: "输出选择",
+  })
+  cert!: any;
+
+  @Autowire()
+  logger!: ILogger;
+
+  @TaskOutput({
+    title: "cert info",
+  })
+  certInfo!: any;
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  async onInstance(): Promise<void> {}
+  async execute(): Promise<void> {
+    console.log("input :cert", this.cert);
+  }
+}

package/test/index.test.ts

@@ -0,0 +1,16 @@
+import { expect } from "chai";
+import "mocha";
+import { EchoPlugin } from "./echo-plugin";
+describe("task_plugin", function () {
+  it("#taskplugin", function () {
+    console.log("before new plugin");
+    const echoPlugin = new EchoPlugin();
+    console.log("before set property", echoPlugin);
+    echoPlugin.cert = { test: 1 };
+    console.log("before execute");
+    // @ts-ignore
+    echoPlugin.execute();
+    console.log("after execute");
+    expect(echoPlugin.cert.test).eq(1);
+  });
+});

package/test/pipeline/access-service-test.ts

@@ -0,0 +1,10 @@
+import { IAccess, IAccessService } from "../../src";
+// @ts-ignore
+import { aliyunSecret } from "../user.secret";
+export class AccessServiceTest implements IAccessService {
+  async getById(id: any): Promise<IAccess> {
+    return {
+      ...aliyunSecret,
+    } as any;
+  }
+}

package/test/pipeline/init.test.ts

@@ -0,0 +1,15 @@
+import { ContextFactory } from "../../src/core/context";
+import { FileStorage } from "../../src/core/storage";
+import { AccessServiceTest } from "./access-service-test";
+import { logger } from "../../src/utils/util.log";
+
+const contextFactory = new ContextFactory(new FileStorage());
+
+const userContext = contextFactory.getContext("user", "test");
+const pipelineContext = contextFactory.getContext("pipeline", "test");
+export const pluginInitProps = {
+  accessService: new AccessServiceTest(),
+  pipelineContext: pipelineContext,
+  userContext: userContext,
+  logger: logger,
+};

package/test/pipeline/pipeline.define.ts

@@ -0,0 +1,66 @@
+import { ConcurrencyStrategy, NextStrategy, Pipeline, RunStrategy } from "../../src";
+
+let idIndex = 0;
+function generateId() {
+  idIndex++;
+  return idIndex + "";
+}
+export const pipeline: Pipeline = {
+  version: 1,
+  id: generateId(),
+  title: "测试管道",
+  userId: 1,
+  triggers: [],
+  stages: [
+    {
+      id: generateId(),
+      title: "证书申请阶段",
+      concurrency: ConcurrencyStrategy.Serial,
+      next: NextStrategy.AllSuccess,
+      tasks: [
+        {
+          id: generateId(),
+          title: "申请证书任务",
+          steps: [
+            {
+              id: generateId(),
+              title: "申请证书",
+              type: "CertApply",
+              input: {
+                domains: ["*.docmirror.cn"],
+                email: "xiaojunnuo@qq.com",
+                dnsProviderType: "aliyun",
+                accessId: "111",
+              },
+            },
+          ],
+        },
+      ],
+    },
+    {
+      id: generateId(),
+      title: "证书部署阶段",
+      concurrency: ConcurrencyStrategy.Serial,
+      next: NextStrategy.AllSuccess,
+      tasks: [
+        {
+          id: generateId(),
+          title: "测试输出参数任务",
+          steps: [
+            {
+              id: generateId(),
+              title: "输出参数（echo插件）",
+              type: "EchoPlugin",
+              input: {
+                cert: "cert",
+              },
+              strategy: {
+                runStrategy: RunStrategy.SkipWhenSucceed,
+              },
+            },
+          ],
+        },
+      ],
+    },
+  ],
+};

package/test/pipeline/pipeline.test.ts

@@ -0,0 +1,18 @@
+//import { expect } from "chai";
+import "mocha";
+import { Executor, RunHistory } from "../../src";
+import { pipeline } from "./pipeline.define";
+import { AccessServiceTest } from "./access-service-test";
+import { FileStorage } from "../../src/core/storage";
+describe("pipeline", function () {
+  it("#pipeline", async function () {
+    this.timeout(120000);
+    async function onChanged(history: RunHistory) {
+      console.log("changed:");
+    }
+
+    const executor = new Executor({ userId: "test", pipeline, onChanged, accessService: new AccessServiceTest(), storage: new FileStorage() });
+    await executor.run(1, "user");
+    // expect(define.name).eq("EchoPlugin");
+  });
+});

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "strict": true,
+    "jsx": "preserve",
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ESNext", "DOM"],
+    "skipLibCheck": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "./dist/ts"
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue","test/**/*.ts"],
+}

package/vite.config.js

@@ -0,0 +1,35 @@
+import { defineConfig } from "vite";
+import typescript from "@rollup/plugin-typescript";
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [],
+  build: {
+    lib: {
+      entry: "src/index.ts",
+      name: "pipeline",
+    },
+    rollupOptions: {
+      plugins: [
+        typescript({
+          target: "esnext",
+          rootDir: "src",
+          declaration: true,
+          declarationDir: "dist/d",
+          exclude: ["./node_modules/**", "./src/**/*.vue"],
+          allowSyntheticDefaultImports: true,
+        }),
+      ],
+      external: ["vue", "lodash", "dayjs", "@fast-crud/fast-crud"],
+      output: {
+        // Provide global variables to use in the UMD build
+        // for externalized deps
+        globals: {
+          vue: "Vue",
+          lodash: "_",
+          dayjs: "dayjs",
+          "@fast-crud/fast-crud": "FastCrud",
+        },
+      },
+    },
+  },
+});