@lazycatcloud/lzc-cli 1.1.2 → 1.1.5

package/cmds/publish.js

@@ -0,0 +1,116 @@
+import env from "../lib/env.js";
+import Builder from "../lib/builder.js";
+import path from "path";
+import Semver from "semver";
+import inquirer from "inquirer";
+import Archiver from "../lib/archiver.js";
+import { isValidApp, contextDirname as getLibDir } from "../lib/utils.js";
+import fs from "fs";
+import execa from "execa";
+import { GLOBAL_CONFIG_DIR } from "../lib/utils.js";
+
+const REGISTRY_REPO = "registry.lazycat.cloud";
+const APPDB_DIR = path.join(GLOBAL_CONFIG_DIR, "appdb");
+
+export default class Publisher {
+  constructor() {
+    env.load(process.cwd());
+  }
+  async run() {
+    const { appDir, _ } = isValidApp(process.cwd());
+    const builder = new Builder();
+    const contextDir = process.cwd();
+
+    console.log(getLibDir());
+    //
+    const { tag, newVersion } = await this.generateTag();
+
+    const dockerfile = path.join(env.get("BUILD_CONTEXT"), "Dockerfile");
+    await builder.dockerLocalBuild(contextDir, dockerfile, tag);
+
+    // 该操作确保了 appdb 的存在
+    execa.sync(path.join(getLibDir(), "git/git-reset.sh"), {
+      cwd: appDir,
+      env: {
+        APPDB_DIR,
+      },
+      stdio: "inherit",
+    });
+
+    // 生成新的应用
+    const outputDir = path.join(APPDB_DIR, env.get("APP_ID"));
+
+    if (!fs.existsSync(outputDir)) {
+      fs.mkdirSync(outputDir, { recursive: true });
+    }
+    const buildDir = path.join(process.cwd(), env.get("BUILD_CONTEXT"));
+
+    const archiver = new Archiver(outputDir);
+    await archiver.load(appDir);
+    await archiver.add(buildDir);
+    archiver.replace(
+      `
+x-lazycat-app:
+  version: ${newVersion}
+services:
+  ${env.get("APP_ID")}:
+    image: ${tag}
+      `.trim()
+    );
+
+    execa.sync(path.join(getLibDir(), "git/git-commit.sh"), {
+      cwd: APPDB_DIR,
+      env: {
+        APP_ID: env.get("APP_ID"),
+        APP_VERSION: newVersion,
+      },
+      stdio: "inherit",
+    });
+
+    // confirm git push
+    const { push } = await inquirer.prompt([
+      {
+        name: "push",
+        message: `确定发布版本 ${newVersion}`,
+        type: "confirm",
+      },
+    ]);
+
+    if (push) {
+      execa.sync("git", ["push"], {
+        cwd: APPDB_DIR,
+      });
+      // 更新版本
+      env.set({ APP_VERSION: newVersion });
+    }
+  }
+
+  async generateTag() {
+    const currentVersion = Semver.parse(env.get("APP_VERSION"));
+    if (currentVersion == null) throw new Error("无法获取当前版本号");
+
+    const newVersion = Semver.inc(currentVersion, "patch");
+    const answer = await inquirer.prompt({
+      name: "version",
+      message: "请填写新的版本号",
+      type: "input",
+      default: () => newVersion,
+      validate: (input) => {
+        let v = Semver.parse(input);
+        if (v) {
+          if (Semver.lte(v, currentVersion)) {
+            return "该版本号小于当前版本";
+          }
+          return true;
+        } else {
+          return "请输入正确的版本号";
+        }
+      },
+    });
+
+    return {
+      tag: `${REGISTRY_REPO}/${env.get("APP_ID")}:${answer.version}`,
+      newVersion: answer.version,
+    };
+  }
+}

package/lib/box/check_qemu.js

@@ -0,0 +1,27 @@
+// 检测当前系统是否安装 qemu 软件
+import commandExist from "command-exists";
+import chalk from "chalk";
+
+export class CheckQemu {
+  constructor() {
+    this.commands = ["qemu-img", "qemu-system-x86_64", "pgrep"];
+  }
+
+  async init() {
+    let ps = [];
+    this.commands.forEach((cmd) => {
+      let p = new Promise((resolve, reject) => {
+        commandExist(cmd)
+          .then(resolve)
+          .catch(() => {
+            console.error(
+              chalk.red(`${cmd} 命令没有发现，请通过系统包管理器安装对应的包`)
+            );
+            reject();
+          });
+      });
+      ps.push(p);
+    });
+    return Promise.all(ps);
+  }
+}

package/lib/box/hportal.js

@@ -101,6 +101,7 @@ export function showBoxInfo(vmInfos, rmInfos) {
 
   if (boxIds.length == 0) {
     console.log("没有找到任何盒子，创建一个吧!");
+    return;
   }
 
   let result = [];

package/lib/box/index.js

@@ -6,8 +6,9 @@ import { QemuVM, QemuResource } from "./qemu_vm_mgr.js";
 import { contextDirname } from "../utils.js";
 import env, { sdkEnv } from "../env.js";
 import { HportalManager, showBoxInfo } from "./hportal.js";
+import { CheckQemu } from "./check_qemu.js";
 
-async function initQemuVM() {
+async function initQemuVM(ensureResources = false) {
   let defaultSchemeFile = path.join(
     contextDirname(),
     "box",
@@ -24,9 +25,13 @@ async function initQemuVM() {
     scheme.path = path.join(contextDirname(), "box-emulator", scheme.path);
   }
 
-  // 使用本地网络 api 调试 new QemuResource(scheme.path, "http://127.0.0.1");
-  let resource = new QemuResource(scheme.path);
-  await resource.init();
+  fs.mkdirSync(scheme.path, { recursive: true });
+
+  if (ensureResources) {
+    // 使用本地网络 api 调试 new QemuResource(scheme.path, "http://127.0.0.1");
+    let resource = new QemuResource(scheme.path);
+    await resource.init();
+  }
 
   let m = new QemuVM(scheme);
   return m;
@@ -44,21 +49,35 @@ export function boxCommand(box) {
       command: "create",
       desc: "创建一个虚拟盒子，并注册运行",
       handler: async () => {
-        let m = await initQemuVM();
-        let { boxName, boxId, user, password } = await m.createVM();
+        let cq = new CheckQemu();
+        await cq.init();
+
+        let boxId;
+        let m = await initQemuVM(true);
+        let answer = await m.askBoxInfo();
+
+        try {
+          // 创建盒子阶段，如果出错，将直接删除所有的资源。
+          boxId = await m.createVM(answer);
+        } catch (error) {
+          console.error(error);
+          await m.cleanVM(answer.boxName);
+          return;
+        }
+
         // 如果没有指定默认的盒子名称将会将第一个盒子作为默认的盒子
         let defaultBoxName = env.get("DEFAULT_BOXNAME");
         if (!defaultBoxName) {
           // 新创建的盒子在初始化的时候，盒子里面需要安装hc的组件，需要一点时间，
           // 所以这里并不对sdk url进行校验是否有效
-          await sdkEnv.setDefaultBoxName(boxName, false);
+          await sdkEnv.setDefaultBoxName(answer.boxName, false);
         }
 
         let h = await initHportal();
         console.log("添加盒子到 Hportal ......");
-        await h.addBox(boxName);
+        await h.addBox(answer.boxName);
         console.log("正在使用管理员帐号密码登录中......");
-        await h.loginBox(boxId, user, password);
+        await h.loginBox(boxId, answer.adminName, answer.adminPass);
         console.log("登录成功！");
       },
     },
@@ -107,7 +126,7 @@ export function boxCommand(box) {
         let rmInfos = await rm.boxs(boxName, defaultBoxName);
 
         // 过滤条件不满足
-        if (vmInfos.length == 0 && rmInfos == 0 && boxName != "") {
+        if (vmInfos.length == 0 && rmInfos == 0 && boxName) {
           console.log(`${boxName} 盒子不存在`);
           let allVmInfos = await m.infoVM("", defaultBoxName);
           let allRmInfos = await rm.boxs("", defaultBoxName);

package/lib/box/qemu_vm_mgr.js

@@ -5,9 +5,11 @@ import path from "node:path";
 import inquirer from "inquirer";
 import https from "node:https";
 import http from "node:http";
-import lz4 from "lz4";
 import process from "node:process";
 import net from "node:net";
+import fetch from "node-fetch";
+import zlib from "node:zlib";
+import os from "node:os";
 
 async function getFreePort() {
   return new Promise((resolve, reject) => {
@@ -37,8 +39,8 @@ export class QemuResource {
    * downloadUrl system-disk 下载路径
    */
   constructor(
-    diskDir = "~/.local/share/lazycat/box-emulator",
-    downloadUrl = "https://dl.lazycat.cloud/sdk/vm"
+    diskDir = "~/.cache/box-emulator",
+    downloadUrl = "https://dl.lazycat.cloud/sdk"
   ) {
     this.diskDir = diskDir;
     this.downloadUrl = downloadUrl;
@@ -46,32 +48,96 @@ export class QemuResource {
 
   async init() {
     fs.mkdirSync(this.diskDir, { recursive: true });
-    await this.ensureSystemDisk();
+    let shouldUpdate = await this.shouldUpdate();
+    if (shouldUpdate) {
+      let answer = await inquirer.prompt([
+        {
+          type: "confirm",
+          name: "yesorno",
+          message: `检测到盒子系统具有更新，是否需要重新下载盒子系统镜像？`,
+          default: true,
+        },
+      ]);
+      if (!answer.yesorno) {
+        shouldUpdate = false;
+      }
+    }
+    await this.ensureSystemDisk(shouldUpdate);
+  }
+
+  /**
+   * 根据下载到的 md5 和本地缓存的 md5 进行比较，如果不一样，则代表具有更新，
+   * 然后提示用户是否更新。
+   * 如果在获取 md5 的过程中，发生网络错误，则跳过更新检查。
+   * 目前的更新，只是使用 md5 来判断是否需要重新下载 md5, 并不会使用 md5 来判断所下载的数据是否正确。
+   */
+  async shouldUpdate() {
+    let oldMd5Path = path.join(this.diskDir, "disk-system.qcow2.md5");
+
+    // 如果不存在 md5 文件，直接返回需要更新
+    try {
+      fs.accessSync(oldMd5Path);
+    } catch {
+      return true;
+    }
+
+    // 拉取最新的 md5
+    let newMd5;
+    try {
+      let url = `${this.downloadUrl}/vm/disk-system.qcow2.md5`;
+      let res = await fetch(url);
+      if (res.status !== 200) {
+        return false;
+      }
+      newMd5 = await res.text();
+    } catch {
+      return false;
+    }
+
+    let oldMd5 = fs.readFileSync(oldMd5Path, { encoding: "utf-8" });
+    return oldMd5 !== newMd5;
   }
 
   /**
    * 确保 qemu 系统盘的镜像存在，如果不存在，将会从 downloadUrl 中下载
    */
-  async ensureSystemDisk() {
+  async ensureSystemDisk(update = false) {
     let systemDiskFile = path.join(this.diskDir, "disk-system.qcow2");
-    try {
-      fs.accessSync(systemDiskFile);
-      return;
-    } catch {}
+    if (!update) {
+      try {
+        fs.accessSync(systemDiskFile);
+        return;
+      } catch {}
+    }
 
+    await this.downloadOVMF();
     await this.downloadSystemDisk();
     await this.downloadPrivateKey();
+    await this.downloadSystemDiskMd5();
+  }
+
+  async downloadOVMF() {
+    let name = `${os.arch()}.OVMF.fd`;
+    let savePath = path.join(this.diskDir, name);
+    let url = `${this.downloadUrl}/${name}`;
+    await this.download(url, savePath);
+  }
+
+  async downloadSystemDiskMd5() {
+    let savePath = path.join(this.diskDir, "disk-system.qcow2.md5");
+    let url = `${this.downloadUrl}/vm/disk-system.qcow2.md5`;
+    await this.download(url, savePath);
   }
 
   async downloadSystemDisk() {
     let savePath = path.join(this.diskDir, "disk-system.qcow2");
-    let url = `${this.downloadUrl}/disk-system.qcow2.lz4`;
+    let url = `${this.downloadUrl}/vm/disk-system.qcow2.gz`;
     await this.download(url, savePath, true);
   }
 
   async downloadPrivateKey() {
     let savePath = path.join(this.diskDir, "id_rsa");
-    let url = `${this.downloadUrl}/id_rsa`;
+    let url = `${this.downloadUrl}/vm/id_rsa`;
     await this.download(url, savePath);
     fs.chmodSync(savePath, 0o400);
     return;
@@ -90,7 +156,7 @@ export class QemuResource {
     );
   }
 
-  download(url, savePath, enableLz4 = false) {
+  download(url, savePath, enableGzip = false) {
     let tmpPath = savePath + ".tmp";
     const options = new URL(url);
     let request = url.startsWith("https") ? https.request : http.request;
@@ -110,8 +176,8 @@ export class QemuResource {
         });
 
         let outputFile = fs.createWriteStream(tmpPath, { flags: "w+" });
-        if (enableLz4) {
-          let decoder = lz4.createDecoderStream();
+        if (enableGzip) {
+          let decoder = zlib.createUnzip();
           res.pipe(decoder).pipe(outputFile);
         } else {
           res.pipe(outputFile);
@@ -144,7 +210,10 @@ export class QemuVM {
     let args = await this.buildQemuArgs(name, vmDir);
     let p = spawn("qemu-system-x86_64", args, {
       detached: true,
-      stdio: ["ignore", "ignore", "inherit"],
+      stdio: ["pipe", "ignore", "inherit"],
+    });
+    p.on("error", (e) => {
+      throw e;
     });
     console.log("启动中...");
 
@@ -165,14 +234,21 @@ export class QemuVM {
           return;
         }
 
-        let boxid = this.readBoxid(name);
-        if (boxid) {
-          p.unref();
-          resolve(boxid);
+        let boxId = this.readBoxid(name);
+        if (boxId) {
           clearInterval(id);
+          p.unref();
+          resolve(boxId);
           console.log("启动成功!");
         }
       }, 1000);
+
+      // 当在等待期间，ctrl-c 退出
+      process.on("SIGINT", () => {
+        p.kill();
+        clearInterval(id);
+        reject("exit");
+      });
     });
   }
 
@@ -200,22 +276,19 @@ export class QemuVM {
   /**
    * 创建一个指定的虚拟机，并启动等待注册成功。
    **/
-  async createVM() {
-    let answer = await this.askBoxInfo();
-
-    let vmDir = this.ensureVmDir(answer.boxName);
+  async createVM({ boxName, adminName, adminPass }) {
+    let vmDir = this.ensureVmDir(boxName);
     this.ensureVolumeDir(vmDir);
     await this.buildDisks(vmDir);
-    let boxId = await this.startVM(answer.boxName, vmDir);
+    let boxId = await this.startVM(boxName, vmDir);
     console.log("盒子ID: ", boxId);
 
-    let boxName = await this.registerVM(boxId, answer);
-    return {
+    await this.registerVM(boxId, {
       boxName,
-      boxId,
-      user: answer.adminName,
-      password: answer.adminPass,
-    };
+      adminName,
+      adminPass,
+    });
+    return boxId;
   }
 
   /**
@@ -244,29 +317,20 @@ export class QemuVM {
         mask: "*",
         validate: noEmpty,
       },
-      {
-        type: "input",
-        name: "origin",
-        message: "注册服务器地址",
-        default: "origin.lazycat.cloud",
-      },
     ]);
   }
 
   /**
    * 调用 hportal client 进行注册
    **/
-  async registerVM(boxid, { boxName, adminName, adminPass, origin }) {
+  async registerVM(boxid, { boxName, adminName, adminPass }) {
     // prettier-ignore
-    spawnSync("sudo",[
-      "-S",
-      "home-portal-client",
+    spawnSync("home-portal-client",[
       "-setup", "-boxid", boxid,
       "-boxname", boxName,
       "-user", adminName,
       "-password", adminPass,
-      "-origin", origin,
-    ], {stdio: ["inherit", "inherit", "inherit"]})
+    ], {stdio: "inherit"})
     return boxName;
   }
 
@@ -330,7 +394,11 @@ export class QemuVM {
    * 寻找默认可用的 bios 文件
    */
   findBIOS() {
-    let includes = ["/usr/share/ovmf/x64/OVMF.fd", "/usr/share/ovmf/OVMF.fd"];
+    let includes = [
+      "/usr/share/ovmf/x64/OVMF.fd",
+      "/usr/share/ovmf/OVMF.fd",
+      path.join(this.scheme.path, `${os.arch()}.OVMF.fd`),
+    ];
     for (let file of includes) {
       try {
         fs.accessSync(file, fs.constants.F_OK);
@@ -350,7 +418,7 @@ export class QemuVM {
     // prettier-ignore
     let args = [
       "-name", `${this.scheme.name}-${this.scheme.uuid}-vm-${name}`,
-      "-machine", "pc,accel=kvm",
+      "-machine", "pc,accel=kvm,accel=kvf,accel=xen,accel=hax,accel=nvmm,accel=whpx,accel=tcg",
       "-m", `${this.scheme.memory}`,
       "-smp", "4,sockets=4,cores=1,threads=1",
       "-bios", bios,
@@ -394,16 +462,33 @@ export class QemuVM {
     console.log(`${name} 盒子已停止`);
   }
 
+  /**
+   * 清理盒子，用于注册失败或者在注册过程中用户手动中止的情况
+   */
+  async cleanVM(name) {
+    let vmDir = path.join(this.scheme.path, `vm-${name}`);
+
+    try {
+      fs.accessSync(vmDir);
+    } catch {
+      return;
+    }
+    fs.rmSync(vmDir, { recursive: true, force: true });
+  }
+
   /**
    * 删除虚拟盒子
+   * @param {boolean} silence - 是否提示错误，如果被删除的盒子不存在
    */
-  async deleteVM(name) {
+  async deleteVM(name, silence = false) {
     let vmDir = path.join(this.scheme.path, `vm-${name}`);
 
     try {
       fs.accessSync(vmDir);
     } catch {
-      console.log(`${name} 盒子不存在或者该盒子为一个真实盒子`);
+      if (!silence) {
+        console.log(`${name} 盒子不存在或者该盒子为一个真实盒子`);
+      }
       return;
     }
 

package/lib/builder.js

@@ -4,12 +4,12 @@ import path from "path";
 import chalk from "chalk";
 import execa from "execa";
 // import { archiveFolder } from "./utils.js";
-import { DockerClient } from "./sdk.js";
+import { dockerPullLzcAppsImage, DockerClient } from "./sdk.js";
 import { DockerfileParser } from "dockerfile-ast";
 import glob from "fast-glob";
 import ignore from "@balena/dockerignore";
 import { createLogUpdate } from "log-update";
-import env from "./env.js";
+import env, { sdkEnv } from "./env.js";
 import Dockerode from "dockerode";
 
 export const PRE_BUILD_FILE = "build.sh";
@@ -209,10 +209,21 @@ export default class Builder {
    */
   async dockerRemoteBuildV2(contextDir, dockerfile, tag = env.get("APP_ID")) {
     const src = await this.collectContextFromDockerFile(contextDir, dockerfile);
-    const host = new URL(env.get("SDK_URL")).host;
+    const host = new URL(sdkEnv.sdkUrl).host;
     console.log(host);
     const docker = await new DockerClient(host).init();
     try {
+      // TODO, 使用 docker.pull 方法会失败, 原因未知, 使用 workaround 方案
+      // docker.pull(
+      //   "hello-world",
+      //   // "registry.lazycat.cloud/lzc/lzcapp:0.1",
+      //   // { authconfig: { auth: "bG5rczpsbmtzMjAyMA==" } },
+      //   (err, stream) => {
+      //     console.log("====", err, stream);
+      //   }
+      // );
+      await dockerPullLzcAppsImage(host);
+
       return new Promise(async (resolve, reject) => {
         let refresher = new StatusRefresher();
 

package/lib/dev.js

@@ -1,6 +1,7 @@
 import execa from "execa";
 import { execSync } from "child_process";
 import fs from "fs";
+import chalk from "chalk";
 import {
   GitIgnore,
   isDirSync,
@@ -9,16 +10,17 @@ import {
   APP_SDK_HOSTNAME,
 } from "./utils.js";
 import path from "path";
-import env from "./env.js";
+import env, { sdkEnv } from "./env.js";
 import _get from "lodash.get";
 import { execPreBuild } from "./builder.js";
 import Key from "./key.js";
 import chokidar from "chokidar";
+import commandExists from "command-exists";
 
 import Archiver from "../lib/archiver.js";
 
 async function sdkSSHAddr(env) {
-  let url = await env.get("SDK_URL");
+  let url = sdkEnv.sdkUrl;
   return `${APP_SDK_HOSTNAME}@${urlHostname(url)}:2222`;
 }
 
@@ -48,7 +50,7 @@ class DevModule {
         ...env.all,
         APP_IMAGE_NAME: env.get("APP_ID"),
       };
-      await execPreBuild(buildDir, allEnv);
+      await execPreBuild(buildDir, buildDir, allEnv);
       let arch = new Archiver(this.tempDir);
       await arch.load(this.cwd, allEnv);
       await arch.add(buildDir);
@@ -136,6 +138,13 @@ class DevModule {
       "-i",
       keyFile,
     ].join(" ");
+    // 检查rsync工具是否存在:提示用户
+    const rsyncExisted = commandExists.sync('rsync')
+    if (!rsyncExisted) {
+      console.log(chalk.red("请检查 rsync 是否安装，路径是否正确!"));
+      process.exit();
+    }
+    // FIXME: 下方执行命令不确定是否有兼容性问题
     execSync(
       `rsync --rsh='${rsh}' -czrPR . root@${appAddr}:/root/${this.appId} --filter=':- .gitignore' --exclude='node_modules' --exclude='.git' --delete`,
       { stdio: ["ignore", "ignore", "inherit"] }
@@ -196,6 +205,7 @@ class DevModule {
         ignoreInitial: true,
       })
       .on("all", (event, path) => {
+        // console.log(event, path);
         this.syncProject(keyFile, appAddr);
       });
   }
@@ -253,7 +263,7 @@ class DevModule {
 
     try {
       // 确保 sdk 能通过公钥正常访问
-      await new Key().ensure(env.get("SDK_URL"));
+      await new Key().ensure(sdkEnv.sdkUrl);
 
       keyFile = path.join(this.tempDir, "debug/ssh/id_ed25519");
       appAddr = this.getAddress();

package/lib/env.js

@@ -270,7 +270,7 @@ class SDKEnv {
       await this.installSDK(url);
     }
 
-    env.set({ DEFAULT_BOXNAME: boxname, SDK_URL: url }, true);
+    env.set({ DEFAULT_BOXNAME: boxname }, true);
   }
 
   buildSdkUrl(boxname) {

package/lib/git/git-commit.sh

@@ -1,7 +1,7 @@
 # executed under appdb
 
-git fetch origin
-git reset --hard
-
+# git fetch origin
+# git reset --hard
+#
 git add ${APP_ID}
 git commit -m "[lzc-cli publish] bump ${APP_ID} version to ${APP_VERSION}"

package/lib/sdk.js

@@ -124,3 +124,28 @@ export class SSHClient {
     );
   }
 }
+
+export async function dockerPullLzcAppsImage(host) {
+  console.log(chalk.yellow("* 更新lzcapp镜像, 未来可能会移除此操作"));
+  const opts = await connectOptions(host);
+  const client = new SSHClient(opts);
+  await client.connect();
+  try {
+    const stream = await client.exec(
+      "docker pull registry.lazycat.cloud/lzc/lzcapp:0.1"
+    );
+
+    return new Promise((resolve, reject) => {
+      stream.stdout.pipe(process.stdout);
+      stream.stderr.pipe(process.stdout);
+      stream.on("close", () => {
+        client.close();
+        resolve();
+      });
+      stream.on("error", (e) => reject(e));
+    });
+  } catch (e) {
+    client.close();
+    throw e;
+  }
+}