virst

.dockerignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
+
+.git*
+Dockerfile
+.dockerignore

.eslintignore

+webpack.config.js
+dist/*
+build/*
\ No newline at end of file

.eslintrc.js

+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
\ No newline at end of file

.gitlab-ci.yml

+stages:
+  - install
+  - build
+  - deploy
+
+variables:
+  GIT_DEPTH: "1"
+
+npm_ci:
+  stage: install
+  tags:
+    - linux
+  script:
+    - npm ci
+  artifacts:
+    paths:
+      - node_modules
+
+.build_base:
+  stage: build
+  tags:
+    - linux
+  dependencies:
+    - npm_ci
+
+build:
+  extends: .build_base
+  script: npm run build
+  artifacts:
+    paths:
+      - dist/
+
+test:
+  extends: .build_base
+  script: npm run test
+
+deploy_npm:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - apt update;apt -y install coreutils
+    - echo $NPMRC | base64 --decode > ~/.npmrc
+    - npm publish . --access public
+  only:
+    - master

.npmignore

+/install-npm.sh
+.git*
+/data
+/output
+/config.yaml
+.idea
+.dockerignore
+Dockerfile
+/src
+/dist/full
+/coverage
+/tests
+/dist/tests
+/dev
+/dist/dev
+/webpack.config.js
+/.eslint*
+.*ignore
+.prettierrc*

.prettierrc

+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
\ No newline at end of file

LICENSE

+The MIT License (MIT)
+
+Copyright (c) 2021 Nanahira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

 # koishi-plugin-libvirt
 
-Koishi 的 LibVirt 管理器。
\ No newline at end of file
+Koishi 的 LibVirt 管理器。。
+
+## 安装
+
+### npm
+
+```bash
+sudo apt -y install --no-install-recommends libvirt-dev libvirt-clients
+npm install koishi-plugin-libvirt
+```
+
+你需要安装 `libvirt-dev` 这个包。
+
+## 配置
+
+详见 `config.ts` 部分，或详见 Schema 描述配置。

dev/extras.ts

+import { Context } from 'koishi';
+
+export default class ExtrasInDev {
+  constructor(ctx: Context) {}
+}

dev/index.ts

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+import ConsolePlugin from '@koishijs/plugin-console';
+import SandboxPlugin from '@koishijs/plugin-sandbox';
+import DatabasePlugin from '@koishijs/plugin-database-memory';
+import CachePlugin from '@koishijs/plugin-cache-lru';
+import ExtrasInDev from './extras';
+
+const app = new App({
+  port: 14514,
+  host: 'localhost',
+  prefix: '.',
+});
+
+// Console and sandbox
+app.plugin(SandboxPlugin);
+app.plugin(ConsolePlugin, {
+  open: false,
+});
+
+// Some services
+app.plugin(CachePlugin);
+app.plugin(DatabasePlugin);
+
+// Some extras
+app.plugin(ExtrasInDev);
+
+// Target plugin
+app.plugin(TargetPlugin, {});
+
+app.start();

install-npm.sh

+#!/bin/bash
+npm install --save \
+	source-map-support \
+	koishi-thirdeye
+
+npm install --save-peer \
+	koishi@latest
+
+npm install --save-dev \
+	@types/node \
+	typescript \
+	'@typescript-eslint/eslint-plugin@^4.28.2' \
+	'@typescript-eslint/parser@^4.28.2 '\
+	'eslint@^7.30.0' \
+	'eslint-config-prettier@^8.3.0' \
+	'eslint-plugin-prettier@^3.4.0' \
+	prettier \
+	raw-loader \
+	ts-loader \
+	webpack \
+	webpack-cli \
+	ws \
+	ts-node \
+	@koishijs/plugin-console \
+	@koishijs/plugin-sandbox \
+	@koishijs/plugin-database-memory \
+	@koishijs/plugin-cache-lru \
+	jest \
+	ts-jest \
+	@types/jest

package.json

+{
+  "name": "koishi-plugin-libvirt",
+  "description": "Koishi 的 LibVirt 管理器。",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "lint": "eslint --fix .",
+    "build": "webpack",
+    "start": "ts-node ./dev",
+    "test": "jest --passWithNoTests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://code.mycard.moe/3rdeye/koishi-plugin-libvirt.git"
+  },
+  "author": "Nanahira <nanahira@momobako.com>",
+  "license": "MIT",
+  "keywords": [
+    "Koishi.js",
+    "qqbot",
+    "cqhttp",
+    "onebot"
+  ],
+  "bugs": {
+    "url": "https://code.mycard.moe/3rdeye/koishi-plugin-libvirt/issues"
+  },
+  "homepage": "https://code.mycard.moe/3rdeye/koishi-plugin-libvirt",
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "tests",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "@avaflow/libvirt": "^0.0.7",
+    "koishi-thirdeye": "^8.3.3",
+    "lodash": "^4.17.21",
+    "source-map-support": "^0.5.21"
+  },
+  "peerDependencies": {
+    "koishi": "^4.3.1"
+  },
+  "devDependencies": {
+    "@koishijs/plugin-cache-lru": "^1.0.0-rc.0",
+    "@koishijs/plugin-console": "^3.1.2",
+    "@koishijs/plugin-database-memory": "^1.0.2",
+    "@koishijs/plugin-sandbox": "^1.0.2",
+    "@types/jest": "^27.4.0",
+    "@types/lodash": "^4.14.178",
+    "@types/node": "^17.0.19",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.4.0",
+    "eslint-plugin-prettier": "^3.4.1",
+    "jest": "^27.5.1",
+    "prettier": "^2.5.1",
+    "raw-loader": "^4.0.2",
+    "ts-jest": "^27.1.3",
+    "ts-loader": "^9.2.6",
+    "ts-node": "^10.5.0",
+    "typescript": "^4.5.5",
+    "webpack": "^5.69.1",
+    "webpack-cli": "^4.9.2",
+    "ws": "^8.5.0"
+  }
+}

src/config.ts

+import 'source-map-support/register';
+import { DefineSchema, RegisterSchema } from 'koishi-thirdeye';
+import libvirt from '@avaflow/libvirt';
+
+@RegisterSchema()
+export class HypervisorConfig {
+  @DefineSchema({ required: true, description: '主机连接地址。' })
+  uri: string;
+
+  @DefineSchema({ required: true, description: '主机名称。' })
+  name: string;
+
+  @DefineSchema({ default: false, description: '是否为默认主机。' })
+  isDefault?: boolean;
+
+  async toHypervisor() {
+    const hypervisor = new libvirt.Hypervisor({ uri: this.uri });
+    await hypervisor.connectOpen();
+    return { name: this.name, uri: this.uri, hypervisor };
+  }
+
+  async hypervisorInfo() {
+    try {
+      const { hypervisor } = await this.toHypervisor();
+      const info = await hypervisor.nodeGetInfo();
+      await hypervisor.connectClose();
+      return `${this.name} (${info.model} ${info.cpus} CPUs ${
+        info.memory / 1024
+      } MB)`;
+    } catch (e) {
+      console.error(e);
+      return `${this.name} (连接失败)`;
+    }
+  }
+}
+
+@RegisterSchema()
+export class LibVirtPluginConfig {
+  constructor(config: LibVirtPluginConfigLike) {}
+
+  @DefineSchema({
+    type: HypervisorConfig,
+    default: [{ name: 'localhost', isDefault: true, uri: 'qemu:///system' }],
+  })
+  servers: HypervisorConfig[];
+
+  @DefineSchema({ description: 'virsh 命令程序的路径。', default: 'virsh' })
+  virshPath: string;
+
+  findHypervisorDef(name: string) {
+    if (!name) return this.servers.find((server) => server.isDefault);
+    const exact = this.servers.find((server) => server.name === name);
+    if (exact) return exact;
+    const prefix = this.servers.find((server) => server.name.startsWith(name));
+    if (prefix) return prefix;
+    return this.servers.find((server) => server.name.includes(name));
+  }
+}
+
+export interface LibVirtPluginConfigLike {
+  servers?: { uri: string; name: string; isDefault?: boolean }[];
+  virsh?: string;
+}

src/index.ts

+import 'source-map-support/register';
+import { LibVirtPluginConfig, LibVirtPluginConfigLike } from './config';
+import {
+  DefinePlugin,
+  BasePlugin,
+  InjectLogger,
+  UseCommand,
+  PutOption,
+  CommandExample,
+  LifecycleEvents,
+} from 'koishi-thirdeye';
+import { Logger } from 'koishi';
+import _ from 'lodash';
+import { DomainStateToText, getDomainsFromHypervisor } from './utils';
+export * from './config';
+import util from 'util';
+import { execFile } from 'child_process';
+
+const connectFailMessage = `未找到主机或连接失败，请检查配置或主机连接。`;
+
+@DefinePlugin({ name: 'libvirt', schema: LibVirtPluginConfig })
+export default class LibVirtPlugin
+  extends BasePlugin<LibVirtPluginConfig, LibVirtPluginConfigLike>
+  implements LifecycleEvents
+{
+  @InjectLogger()
+  private logger: Logger;
+
+  private async connect(name: string) {
+    const hypervisor = this.config.findHypervisorDef(name);
+    if (!hypervisor) return;
+    try {
+      return await hypervisor.toHypervisor();
+    } catch (e) {
+      this.logger.error(`Failed to connect to hypervisor ${name}`, e.message);
+    }
+  }
+
+  @UseCommand('virt', '虚拟机管理', { empty: true })
+  async virtCommand() {}
+
+  @UseCommand('virt.hosts', '查看主机列表')
+  async virtHostsCommand(
+    @PutOption('host', '-s <name:string>  指定主机') host: string,
+  ) {
+    const defs = _.compact(
+      host ? [this.config.findHypervisorDef(host)] : this.config.servers,
+    );
+    if (!defs.length) {
+      return '没有可用的主机。';
+    }
+    return (await Promise.all(defs.map((def) => def.hypervisorInfo()))).join(
+      '\n',
+    );
+  }
+
+  @UseCommand('virt.vm', '查看虚拟机列表')
+  @CommandExample('virt.vm -s localhost  查看 localhost 主机的虚拟机列表。')
+  @CommandExample(
+    'virt.vm -s localhost -m ubuntu  查看 localhost 主机的 ubuntu 虚拟机信息。',
+  )
+  async virtVmsCommand(
+    @PutOption('host', '-s <name:string>  指定主机') host: string,
+    @PutOption('vm', '-m <name:string>  指定虚拟机') vm: string,
+    @PutOption('displayUuid', '-u  显示 uuid') displayUuid: boolean,
+  ) {
+    const { name, hypervisor } = (await this.connect(host)) || {};
+    if (!hypervisor) return connectFailMessage;
+    let domains = await getDomainsFromHypervisor(hypervisor);
+    if (vm) {
+      domains = domains.filter(
+        (d) => d.name === vm || d.id?.toString() === vm || d.uuid === vm,
+      );
+    }
+    if (!domains.length) {
+      await hypervisor.connectClose();
+      return '没有可用的虚拟机。';
+    }
+    const result = domains
+      .map(
+        (d) =>
+          `${d.id || '-'} ${d.name} ${DomainStateToText(d.info.state)} (${
+            d.info.nrVirtCpu
+          } vCPUs, ${d.info.memory / 1024} / ${d.info.maxMem / 1024} MiB)${
+            displayUuid ? `\n  UUID: ${d.uuid}` : ''
+          }`,
+      )
+      .join('\n');
+    await hypervisor.connectClose();
+    return `${name} 主机的虚拟机列表:\n${result}`;
+  }
+
+  private async virtActionCommand(
+    actionName: string,
+    verb: string = actionName,
+    host: string,
+    vm: string,
+  ) {
+    if (!vm) return '请指定虚拟机。';
+    const { name, uri, hypervisor } = (await this.connect(host)) || {};
+    if (!hypervisor) return connectFailMessage;
+    const domain = (await getDomainsFromHypervisor(hypervisor)).find(
+      (d) => d.name === vm || d.id?.toString() === vm || d.uuid === vm,
+    );
+    await hypervisor.connectClose();
+    if (!domain) {
+      return `未找到虚拟机 ${vm} 。`;
+    }
+    try {
+      const { stdout, stderr } = await util.promisify(execFile)(
+        'virsh',
+        ['--connect', uri, actionName, domain.name],
+        { encoding: 'utf8' },
+      );
+      return `${name} 主机的虚拟机 ${vm} ${verb}成功:\n${stdout}${
+        stderr ? `\n${stderr}` : ''
+      }`;
+    } catch (e) {
+      const errorMessage = e.stderr || e.message;
+      this.logger.error(
+        `Failed to ${actionName} domain ${domain.name}: ${errorMessage}`,
+      );
+      return `${name} 主机的虚拟机 ${vm} ${verb}发生错误：${errorMessage}`;
+    }
+  }
+
+  private defineActionCommand(action: string, verb: string = action) {
+    this.ctx
+      .command(`virt.${action}`, `${verb}虚拟机`)
+      .example(
+        `virt.${action} -s localhost -m ubuntu  ${verb} localhost 上的 ubuntu 虚拟机。`,
+      )
+      .option('host', '-s <name:string>  指定主机')
+      .option('vm', '-m <name:string>  指定虚拟机')
+      .action((a) =>
+        this.virtActionCommand(action, verb, a.options.host, a.options.vm),
+      );
+    return this;
+  }
+
+  onApply() {
+    this.defineActionCommand('start', '启动')
+      .defineActionCommand('shutdown', '关闭')
+      .defineActionCommand('destroy', '强制关闭')
+      .defineActionCommand('reset', '强制重启')
+      .defineActionCommand('reboot', '重启')
+      .defineActionCommand('suspend', '挂起')
+      .defineActionCommand('resume', '恢复');
+  }
+}

src/utils.ts

+import { DomainInfo, DomainState, Hypervisor } from '@avaflow/libvirt';
+
+export const getDomainsFromHypervisor = async (hypervisor: Hypervisor) => {
+  const domains = await hypervisor.connectListAllDomains();
+  return Promise.all(
+    domains.map(async (domain) => {
+      const [id, info, name, uuid] = (await Promise.all([
+        hypervisor.domainGetID(domain),
+        hypervisor.domainGetInfo(domain),
+        hypervisor.domainGetName(domain),
+        hypervisor.domainGetUUIDString(domain),
+        //hypervisor.domainGetXMLDesc(domain),
+      ])) as [number, DomainInfo, string, string];
+      return {
+        id,
+        domain,
+        info,
+        name,
+        uuid,
+      };
+    }),
+  );
+};
+
+export const DomainStateToText = (state: DomainState) => {
+  switch (state) {
+    case DomainState.NOSTATE:
+      return '未知';
+    case DomainState.RUNNING:
+      return '运行中';
+    case DomainState.BLOCKED:
+      return '阻塞';
+    case DomainState.PAUSED:
+      return '暂停';
+    case DomainState.SHUTDOWN:
+      return '正在关机';
+    case DomainState.SHUTOFF:
+      return '已关闭';
+    case DomainState.CRASHED:
+      return '崩溃';
+    case DomainState.PMSUSPENDED:
+      return '暂停';
+  }
+};

tests/sample.spec.ts

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+
+describe('Test of plugin.', () => {
+  let app: App;
+
+  beforeEach(async () => {
+    app = new App();
+    // app.plugin(TargetPlugin);
+    await app.start();
+  });
+
+  it('should pass', () => {
+    expect(true).toBe(true);
+  });
+});

tsconfig.json

+{
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "commonjs",
+		"target": "es2021",
+		"esModuleInterop": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"declaration": true,
+		"sourceMap": true,
+		"skipLibCheck": true
+	},
+	"compileOnSave": true,
+	"allowJs": true,
+	"include": [
+		"*.ts",
+		"src/**/*.ts",
+		"tests/**/*.ts",
+		"dev/**/*.ts"
+	]
+}

webpack.config.js

+const path = require('path');
+const packgeInfo = require('./package.json');
+
+function externalsFromDep() {
+  return Object.fromEntries(
+    [
+      ...Object.keys(packgeInfo.dependencies || {}),
+      ...Object.keys(packgeInfo.peerDependencies || {}),
+    ]
+      .filter((dep) => dep !== 'source-map-support')
+      .map((dep) => [dep, dep]),
+  );
+}
+
+const packAll = !!process.env.PACK_ALL;
+
+module.exports = {
+  entry: './src/index.ts',
+  mode: 'production',
+  target: 'node',
+  devtool: 'source-map',
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+      { test: /\.mustache$/, use: 'raw-loader' },
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+  output: {
+    filename: 'index.js',
+    library: {
+      type: 'commonjs',
+    },
+    path: path.resolve(__dirname, packAll ? 'dist/full' : 'dist'),
+  },
+  externals: {
+    koishi: 'koishi',
+    ...(packAll ? {} : externalsFromDep()),
+  },
+};