@opentapd/tplugin-cli 0.19.0

package/lib/deploy.js

@@ -0,0 +1,278 @@
+/* eslint-disable no-restricted-syntax */
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: deploy
+ */
+const chalk = require('chalk');
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const spinner = require('../util/spinner');
+const cliLint = require('./lint');
+const inquirer = require('inquirer');
+const tapdsdk = require('../util/tapd');
+const tpluginConf = require('../config');
+const SimpleGit = require('simple-git');
+const archiver = require('archiver');
+const crypto = require('crypto');
+const path = require('path');
+const { get } = require('lodash');
+
+// CLI部署
+module.exports = async () => {
+  // 先lint检查插件格式是否正常
+  if (!await cliLint()) {
+    process.exit(1);
+  }
+
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+  // 读取plugin.yaml 插件配置
+  const docObj = yaml.load(fs.readFileSync(yamlPath, 'utf8'));
+
+  if (!docObj.app || !docObj.app.code) {
+    console.log(chalk.red('找不到 app[code]标签, 请检查 plugin.yaml 格式。'));
+    process.exit(1);
+  }
+
+  if (tpluginConf.tapd.pluginEnv === 'oa') {
+    await oaEnvDeploy(docObj);
+  } else {
+    otherEnvDeploy(docObj);
+  }
+};
+
+// 使用timeout做sleep
+function sleep(time) {
+  return new Promise(resolve => setTimeout(resolve, time));
+}
+
+// OA环境部署
+async function oaEnvDeploy(docObj) {
+  const git = new SimpleGit();
+
+  // 获取代码提交状态
+  const status = await git.status();
+
+  // 有本地修改时，提醒手动 commit后再部署
+  if (!!status.modified.length) {
+    const statusHandle = await inquirer.prompt([{
+      type: 'confirm',
+      name: 'isBreak',
+      message: '本地存在未提交变更，是否手动提交后再进行部署',
+      default: true,
+    }]);
+
+    // 选择本地提交时，直接退出
+    if (statusHandle.isBreak) {
+      process.exit(1);
+    }
+  }
+
+  // 提醒通过平台进行部署
+  const tips = `通过平台部署代码: ${tpluginConf.tapd.openHost}/admin/${docObj.app.code}/codedeploy`;
+
+  // 获取本地分支列表
+  const localBranches = await git.branchLocal();
+  for (const branch in localBranches.branches) {
+    const item = localBranches.branches[branch];
+
+    if (!item.current) {
+      continue;
+    }
+
+    // 通过关键字，匹配 behind 和 ahead
+    const behind = item.label.search(/behind \d+/) >= 0;
+    const ahead = item.label.search(/ahead \d+/) >= 0;
+
+    // 本地代码不是最新时，提醒跟新代码
+    if (behind) {
+      console.log(chalk.red(`请更新到最新远端代码，再进行部署操作.\n${tips}`));
+      process.exit(1);
+    }
+
+    // 有commit，未push的commit时，提醒是否推送并部署
+    if (ahead) {
+      const isContinue = await inquirer.prompt([{
+        type: 'confirm',
+        name: 'template',
+        message: `有未推送到远程仓库的提交，是否推送并发布[发布节点: ${item.commit} ${item.label}]`,
+        default: true,
+      }]);
+      if (!isContinue) {
+        process.exit(1);
+      }
+
+      // push推送本地代码到 origin
+      await git.push('origin', item.name);
+    }
+
+    // 部署 docObj.app.code 仓库 item.name 分支的 item.commit 提交点的代码
+    await deploy(item.name, item.commit, docObj.app.code);
+  }
+}
+
+// 其他环境部署
+function otherEnvDeploy(docObj) {
+  // 压缩本地代码
+  zipCurrentWorkspace(docObj.app.code, async (zipFilePath) => {
+    // 开始传附件到tapd
+    await uploadZipFile(docObj.app.code, zipFilePath);
+    // 删除文件
+    removeZipFile(zipFilePath);
+    // 开始触发部署流水线
+    deploy('', '', docObj.app.code);
+  });
+}
+
+function removeZipFile(filePath) {
+  spinner.start('开始删除本地临时压缩文件');
+  try {
+    fs.unlinkSync(filePath); // 删除文件
+    spinner.succeed('临时压缩文件删除成功！');
+  } catch (err) {
+    console.error(err);
+    spinner.fail(`临时压缩文件删除失败！${err}`);
+  }
+}
+
+function zipCurrentWorkspace(code, callback) {
+  const zipPath = path.join(process.cwd(), '..');
+  spinner.start('开始压缩当前项目');
+  // 创建可写流来写数据
+  const fileName = `__${crypto.randomUUID({ disableEntropyCache: true })}.zip`;
+  const output = fs.createWriteStream(`${zipPath}/${fileName}`);
+  const archive = archiver('zip', {
+    zlib: { level: 9 },
+  });
+
+  output.on('close', () => {
+    spinner.succeed(`压缩完成: ${archive.pointer()} total bytes`);
+    callback(`${zipPath}/${fileName}`);
+  });
+
+  archive.on('warning', (err) => {
+    if (err.code === 'ENOENT') {
+      spinner.warn(`ENOENT:${err}`);
+    } else {
+      throw err;
+    }
+  });
+
+  archive.on('error', (err) => {
+    throw err;
+  });
+
+  archive.pipe(output);
+
+  archive.glob(
+    '**/*',
+    {
+      cwd: `${process.cwd()}/`,
+      dot: true,
+      ignore: ['node_modules/**', '.git/**'],
+    },
+    {
+      prefix: `${code}/`,
+    },
+  );
+
+  archive.finalize();
+}
+
+function uploadZipFile(code, filePath) {
+  spinner.start('开始上传压缩包');
+  return uploadToCos({
+    client_id: code,
+    file: fs.createReadStream(filePath),
+  })
+    .then(() => {
+      spinner.succeed('压缩包上传成功！');
+    })
+    .catch((e) => {
+      spinner.fail('压缩包上传失败！');
+      throw e;
+    });
+}
+
+function uploadToCos(...args) {
+  return tapdsdk.oAuthRequest.apply(tapdsdk, [
+    '/open_user_app/upload_zip_to_cos',
+    'POST',
+    ...args,
+  ]);
+}
+
+/**
+ * @description 部署插件
+ * @param branch 部署分支
+ * @param commit 部署的commit点
+ * @param code 插件code
+ */
+async function deploy(branch, commit, code) {
+  let buildId = '';
+  try {
+    spinner.start('启动部署任务');
+
+    // 触发部署流水线
+    const { data } = await tapdsdk.request({ url: 'open_user_app/bk_pipeline_start', params: {
+      branch,
+      commit_id: commit,
+      client_id: code,
+      plugin_env: tpluginConf.tapd.pluginEnv,
+    }, method: 'POST' });
+
+    // 流水线启动失败
+    if (!data.status || !data.data || !data.data.bk_build_id) {
+      const tips = `启动部署任务失败，Err:${data.info ? data.info : ''}'`;
+      spinner.fail(tips);
+      return false;
+    }
+
+    // 获取触发成功后的 buildId
+    buildId = data.data.bk_build_id;
+  } catch (e) {
+    spinner.fail('启动部署任务失败');
+    throw e;
+  }
+
+  spinner.succeed('部署任务启动成功');
+  spinner.start('部署中... ...');
+  let i = 0;
+  // 轮训等待部署任务结果
+  while (i++ < 60) {
+    let buildStatus = '';
+    try {
+      const { data } = await tapdsdk.request({ url: 'open_user_app/get_build_status', params: {
+        build_id: buildId,
+        client_id: code,
+      }, method: 'GET' });
+      // 判断部署流水线状态
+      buildStatus = get(data, 'data.build_status', '');
+    } catch (err) {
+      console.log(err);
+      await sleep(5000);
+      continue;
+    }
+
+    // 部署后，提示安装测试项目
+    if (buildStatus === 'SUCCEED') {
+      if (tpluginConf.tapd.pluginEnv === 'oa') {
+        spinner.succeed(`部署成功 => 分支[${branch}], 部署节点[${commit}]`);
+      }
+
+      const tips = `前往TAPD开放平台，添加项目进行测试。${tpluginConf.tapd.openHost}/admin/${code}/testdeploy`;
+      console.log(chalk.green(tips));
+
+      return undefined;
+    } if (buildStatus === 'FAILED') {
+      spinner.fail('部署失败！');
+      return new Error('部署失败!');
+    }
+    await sleep(5000);
+  }
+  // 超时时，提醒前往平台关注部署进度
+  const deployTips = `前往TAPD开放平台，查看部署进度。${tpluginConf.tapd.openHost}/admin/${code}/codedeploy`;
+  spinner.fail(deployTips);
+}

package/lib/encrypt.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: encrypt <value>
+ */
+
+const chalk = require('chalk');
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const spinner = require('../util/spinner');
+const tapdsdk = require('../util/tapd');
+const checkPluginYaml = require('../util/checkPluginYaml');
+
+
+/**
+ * CLI 加密指令
+ * @param value 需要加密的值
+ * @description 根据秘钥加密 value值，并输出到控制台中
+ */
+module.exports = async (value) => {
+  // 校验 plugin.yaml 文件合法性
+  checkPluginYaml();
+
+  spinner.start('开始校验plugin.yaml...');
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+
+  // 加载插件配置
+  const docObj = yaml.load(fs.readFileSync(yamlPath, 'utf8'));
+
+  if (!docObj.app.code) {
+    spinner.fail('plugin.yaml 格式错误app code not found!');
+    return false;
+  }
+
+  spinner.start('开始加密数据... ...');
+  // 发起加密请求
+  const data = await encrypt(docObj.app.code, value);
+
+  if (data.data) {
+    spinner.succeed('加密完成');
+    // 输出加密结果
+    console.log(`密文: ${chalk.yellow(data.data)}`);
+  } else {
+    spinner.fail('加密失败');
+  }
+};
+
+/**
+ * @param code 插件code
+ * @param value 加密前值
+ * @return object 加密请求的返回值
+ */
+async function encrypt(code, value) {
+  // 发起加密请求
+  const { data } = await tapdsdk.request({ url: 'open_user_app/encrypt', params: { data: value, code }, method: 'POST' });
+  return data;
+}

package/lib/init.js

@@ -0,0 +1,132 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: init
+ */
+
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const path = require('path');
+const { exec } = require('child_process');
+const spinner = require('../util/spinner');
+const getPluginCode = require('../util/getPluginCode');
+const tapdsdk = require('../util/tapd');
+const tpluginConf = require('../config');
+
+module.exports = async (defaultReload = false) => {
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+
+  // 判断plugin.yaml 是否正常存在
+  if (!fs.pathExistsSync(yamlPath)) {
+    console.log(chalk.red('当前目录未找到plugin.yaml文件'));
+    process.exit(1);
+  }
+
+  // 获取插件Code
+  const appCode = getPluginCode();
+
+  const envPath = `${process.cwd()}/.env.yaml`;
+
+  // 安装依赖
+  const modulesPath = path.join(process.cwd(), 'node_modules');
+  const packageJsonPath = path.join(process.cwd(), 'package.json');
+  if (fs.pathExistsSync(packageJsonPath) && !fs.pathExistsSync(modulesPath)) {
+    try {
+      spinner.start('稍等片刻，正在安装依赖...');
+      // 设置npm源到 mirror.tencent.com
+      // 安装依赖
+      if (tpluginConf.tapd.pluginEnv === 'oa') {
+        await execSync(`npm config set registry ${tpluginConf.npm.registry} && npm install`);
+      } else {
+        await execSync('npm install');
+      }
+      spinner.succeed('依赖安装成功');
+    } catch (e) {
+      e.title = '依赖安装失败，请手动npm install';
+      throw e;
+    }
+  }
+
+  const requirementPath = path.join(process.cwd(), 'requirements.txt');
+  if (fs.pathExistsSync(requirementPath)) {
+    try {
+      spinner.start('稍等片刻，正在安装依赖...');
+      if (tpluginConf.tapd.pluginEnv === 'oa') {
+        await execSync(`pip3 install -i ${tpluginConf.pip.baseURL} --extra-index-url ${tpluginConf.pip.extralURL} -r requirements.txt -t .`);
+      } else {
+        await execSync('pip3 install -r requirements.txt -t .');
+      }
+      spinner.succeed('依赖安装成功');
+    } catch (e) {
+      spinner.fail('依赖安装失败，请手动安装requirement');
+    }
+  }
+
+  // env.yaml 配置覆盖
+  if (!defaultReload) {
+    try {
+      fs.accessSync(envPath, fs.constants.F_OK);
+      // 是否覆盖原文件
+      const continueTmpl = await inquirer.prompt([{
+        type: 'list',
+        name: 'template',
+        message: '.env.yaml文件已经存在, 继续执行将覆盖文件?',
+        choices: ['continue', 'cancel'],
+      }]);
+
+      if (continueTmpl.template !== 'continue') {
+        process.exit(1);
+      }
+    } catch (e) {
+    }
+  }
+  spinner.start('获取初始化配置... ...');
+  let data = {};
+  try {
+    // 获取初始化信息
+    data = await init(appCode);
+    spinner.succeed('初始化配置获取成功');
+  } catch (err) {
+    err.title = '获取初始化数据失败';
+    throw err;
+  }
+
+  spinner.start('开始写入配置信息 .env.yaml');
+  try {
+    // 同步写数据到 .env.yaml 中
+    fs.writeFileSync(envPath, yaml.dump(data));
+    spinner.succeed('配置信息写入成功 .env.yaml');
+  } catch (err) {
+    spinner.fail(`${envPath} 写入失败. Err : ${err}`);
+  }
+  return true;
+};
+
+/**
+ * init(code): 拉取基本的插件信息
+ * @param {string} code 插件code
+ * @return {Object} 获取到的初始化信息
+ */
+async function init(code) {
+  // sdk调起获取请求
+  const { data } = await tapdsdk.request({ url: 'open_user_app/app_info', params: { code }, method: 'GET' });
+  if (data.status === 1 && data.data) {
+    return data.data;
+  }
+  throw new Error(`API error. Err:${data.info}`);
+}
+
+/**
+ * execSync(command) 异步执行命令 command
+ */
+function execSync(command) {
+  return new Promise((resolve, reject) => {
+    exec(command, (err) => {
+      err ? reject(err) : resolve();
+    });
+  });
+}

package/lib/install.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: install
+ */
+
+const inquirer = require('inquirer');
+const tapdsdk = require('../util/tapd');
+const checkPluginYaml = require('../util/checkPluginYaml');
+const selectWorkspace = require('../util/selectWorkspace');
+const getPluginCode = require('../util/getPluginCode');
+const spinner = require('../util/spinner');
+const tpluginConf = require('../config');
+
+module.exports = async () => {
+  checkPluginYaml();
+
+  const appCode = getPluginCode();
+
+  // 选择安装项目
+  const workspace = await selectWorkspace();
+
+  // 已经安装项目，重新选择时，更新到 最新版本
+  if (workspace.installed_type) {
+    const tips = `项目 [${workspace.id} : ${workspace.name}] 已经安装 [${workspace.app_version}] 版本应用. 继续执行将更新至最新版本,是否继续？`;
+    const continueTmpl = await inquirer.prompt([{
+      type: 'confirm',
+      name: 'template',
+      message: tips,
+    }]);
+    if (continueTmpl.template !== true) {
+      process.exit(1);
+    }
+  }
+  spinner.start(`开始安装应用到项目 [${workspace.id} : ${workspace.name}]`);
+  try {
+    // 安装最新版本插件到workspace中
+    const data = await install(appCode, workspace.id);
+    if (data.status) {
+      spinner.succeed(`最新版本应用已经安装到项目 [${workspace.id} : ${workspace.name}]. 前往测试 ${tpluginConf.tapd.tapdHost}/${workspace.pretty_name}`);
+    }
+  } catch (e) {
+    e.title = '安装测试项目失败';
+    throw e;
+  }
+};
+
+/**
+ * install workspace to app[code]
+ * @param {string} code 插件Code
+ * @param {string} workspaceId 项目ID
+ * @param {string} [version='$LATEST'] 安装的插件版本
+ */
+async function install(code, workspaceId, version = '$LATEST') {
+  const { data } = await tapdsdk.request({ url: 'open_user_app/open_app_authorize', params: { client_id: code, workspace_id: workspaceId, version }, method: 'POST' });
+  return data;
+}

package/lib/lint.js

@@ -0,0 +1,55 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ * Author: raferzeng@tencent.com
+ *
+ * The implementation of CLI: lint
+ */
+
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const spinner = require('../util/spinner');
+const tapdsdk = require('../util/tapd');
+const checkPluginYaml = require('../util/checkPluginYaml');
+
+// 检查插件格式
+module.exports = async () => {
+  // 校验plugin.yaml文件
+  checkPluginYaml();
+
+  spinner.start('开始校验plugin.yaml...');
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+
+  const docObj = yaml.load(fs.readFileSync(yamlPath, 'utf8'));
+  const doc = yaml.dump(docObj);
+
+  // 发起lint，远程校验文件配置内容
+  const res = await lint(doc);
+
+  // 异常提醒
+  if (!res || !res.status) {
+    spinner.fail('plugin.yaml校验异常，请稍后重试');
+    return false;
+  }
+
+  // 校验通过
+  if (res && res.status) {
+    spinner.succeed('plugin.yaml校验通过！');
+    return true;
+  }
+};
+
+/**
+ * lint() 发起校验请求，验证配置具体内容
+ * @param {string} doc - plugin.yaml配置内容
+ * @returns {Object} data - 校验结果
+ */
+async function lint(doc) {
+  try {
+    const { data } = await tapdsdk.request({ url: 'open_user_app/lint', params: { data: doc }, method: 'POST' });
+    return data;
+  } catch (e) {
+    e.title = 'plugin.yaml校验不通过';
+    throw e;
+  }
+}