@taole/deploy-helper 0.5.3 → 1.0.0-beta.0

package/deploy.mjs

@@ -0,0 +1,204 @@
+import { hasChangeMe } from './util.mjs';
+import { runPipeline, checkYunxiaoToken } from './lib/pipelineApi.mjs';
+import { log } from './lib/util.mjs';
+import { simpleGit } from 'simple-git';
+import { getScpClient, TEST_SERVER_HOST } from './util.mjs';
+
+
+class Deployer {
+    async deploy(workDir, mode, config) {
+        // 检查配置中是否存在默认值(CHANGE_ME)
+        const result = hasChangeMe(JSON.stringify(config));
+        if (result) {
+            throw new Error(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
+        }
+
+        const needHandleAssets = config.assets && config.assets.dest;
+        const needHandleEntry = config.entry && config.entry.dest && (mode === 'prod' || (mode === 'test' && !config.entry.onlyProd));
+        const entryTestBranch = (config.entry && config.entry.testBranch) || "test";
+        const entryProdBranch = (config.entry && config.entry.prodBranch) || "master";
+        const entryTargetBranch = mode === 'prod' ? entryProdBranch : entryTestBranch;
+
+        // 检查流水线配置
+        checkYunxiaoToken(config, mode);
+
+
+        // 检查项目
+        // 1. 检查项目是否存在
+        let assetsDest = null;
+        let entryDest = null;
+        if (needHandleAssets) {
+            assetsDest = join(workDir, config.assets.dest);
+            if (!fs.existsSync(assetsDest)) {
+                throw new Error(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
+            }
+        }
+        // entry.dest
+        if (needHandleEntry) {
+            entryDest = join(workDir, config.entry.dest);
+            if (!fs.existsSync(entryDest)) {
+                throw new Error(`entry.dest路径不存在: ${entryDest}, 请先创建`);
+            }
+        }
+
+        // 2. 检查项目是否clean
+        let assetsGit = null;
+        let assetsStatus = null;
+        if (needHandleAssets) {
+            assetsGit = simpleGit(assetsDest);
+            assetsStatus = await assetsGit.status();
+            if (!assetsStatus.isClean()) {
+                throw new Error(`${assetsDest}目前有未提交内容, 请先处理`);
+            }
+        }
+
+        let entryGit;
+        let entryStatus;
+        if (needHandleEntry) {
+            entryGit = simpleGit(entryDest);
+            entryStatus = await entryGit.status();
+            if (!entryStatus.isClean()) {
+                throw new Error(`${entryDest}目前有未提交内容, 请先处理`);
+            }
+        }
+
+
+        // 3. 检查assets项目分支，并切换至master分支
+        // assets项目固定使用master分支
+        if (needHandleAssets && assetsStatus.current !== "master") {
+            log(`${assetsDest}当前分支不是master, 切换至master分支`);
+            await assetsGit.checkout("master");
+            log(`${assetsDest}切换至master分支成功`);
+        }
+        if (needHandleEntry && entryStatus.current !== entryTargetBranch) {
+            log(`${entryDest}当前分支不是${entryTargetBranch}, 切换至${entryTargetBranch}分支`);
+            await entryGit.checkout(entryTargetBranch);
+            log(`${entryDest}切换至${entryTargetBranch}分支成功`);
+        }
+
+        // 4. 执行git pull
+        if (assetsGit) {
+            log(`${assetsDest}执行git pull`);
+            await assetsGit.pull();
+            log(`${assetsDest} git pull done`);
+        }
+        if (entryGit) {
+            log(`${entryDest}执行git pull`);
+            await entryGit.pull();
+            log(`${entryDest} git pull done`);
+        }
+
+        // 5. 复制构建产物
+        // 5.1 复制assets
+        if (needHandleAssets) {
+            let assetsFilesCount = 0;
+            const assetsFiles = config.assets.files;
+            for (const [src, dest] of Object.entries(assetsFiles)) {
+                const srcPath = join(workDir, src);
+                if (!fs.existsSync(srcPath)) {
+                    throw new Error(`${srcPath}不存在，请确认构建产物是否正确`);
+                }
+                const destPath = join(assetsDest, dest);
+                if (fs.statSync(srcPath).isDirectory()) {
+                    fs.cpSync(srcPath, destPath, { recursive: true });
+                } else {
+                    fs.copyFileSync(srcPath, destPath);
+                }
+                log(`assets copy: ${srcPath} -> ${destPath}`);
+                assetsFilesCount++;
+            }
+            // log(`assets copy done.`);
+        }
+        // 5.2 复制entry
+        if (needHandleEntry) {
+            const entryFiles = config.entry.files;
+            for (const [src, dest] of Object.entries(entryFiles)) {
+                const srcPath = join(workDir, src);
+                if (!fs.existsSync(srcPath)) {
+                    throw new Error(`${srcPath}不存在，请确认构建产物是否正确`);
+                }
+                if (fs.statSync(srcPath).isDirectory()) {
+                    throw new Error(`entry: ${srcPath}是目录，不支持entry为目录的部署`);
+                }
+                const destPath = join(entryDest, dest);
+                fs.copyFileSync(srcPath, destPath);
+                log(`entry copy: ${srcPath} -> ${destPath}`);
+            }
+            // log(`entry copy done.`);
+        }
+
+        // 6. 提交
+        let canPushAssets = false;
+        let canPushEntry = false;
+        if (needHandleAssets) {
+            assetsStatus = await assetsGit.status();
+            if (!assetsStatus.isClean()) {
+                canPushAssets = true;
+                await assetsGit.add(".");
+                const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
+                const assetsCommitResult = await assetsGit.commit(assetsCommit);
+                log(`assets commit: ${assetsCommit}`);
+                log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
+            } else {
+                log(`${assetsDest} 未发现修改内容,跳过提交`);
+            }
+        }
+        if (needHandleEntry) {
+            entryStatus = await entryGit.status();
+            if (!entryStatus.isClean()) {
+                canPushEntry = true;
+                await entryGit.add(".");
+                const entryCommit = `${config.entry.commit || "feat:部署入口文件"} by deploy-helper`;
+                const entryCommitResult = await entryGit.commit(entryCommit);
+                log(`entry commit: ${entryCommit}`);
+                log(`entry commit: ${JSON.stringify(entryCommitResult.summary)}`);
+            } else {
+                log(`${entryDest} 未发现修改内容,跳过提交`);
+            }
+        }
+
+        // 7. 推送
+        if (canPushAssets) {
+            log(`assets push start`);
+            try {
+                await assetsGit.push();
+            } catch (error) {
+                await assetsGit.push();
+            }
+            log(`assets push done.`);
+        }
+        if (canPushEntry) {
+            log(`entry push start`);
+            try {
+                await entryGit.push();
+            } catch (error) {
+                await entryGit.push();
+            }
+            log(`entry push done.`);
+        }
+
+        try {
+            // 8 测试环境将entry scp至测试环境
+            if (mode === 'test' && config.testSync) {
+                const syncTestFiles = config.testSync;
+                const scpClient = await getScpClient();
+                for (const [src, dest] of Object.entries(syncTestFiles)) {
+                    const srcPath = join(workDir, src);
+                    const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
+                    log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
+                    await scpClient.uploadFile(srcPath, destPath)
+                }
+            }
+        } catch (error) {
+            log(`scp error: ${error}`);
+            if (assetsFilesCount > 0) {
+                log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
+            }
+        }
+        // 处理触发流水线的任务
+        await runPipeline(config, mode);
+    }
+}
+
+
+export default new Deployer();

package/deploy2.mjs

@@ -0,0 +1,9 @@
+class Deployer2 {
+    async deploy(workDir, mode, config) {
+        // check
+        // run
+    }
+}
+
+
+export default new Deployer2();

package/index.mjs

@@ -1,20 +1,19 @@
 #!/usr/bin/env node
 
-import { Client } from 'node-scp'
 import fs from 'fs';
 import { join, basename, dirname } from "path";
-import { simpleGit } from 'simple-git';
-import { homedir } from 'os'
 import { runPipeline, checkYunxiaoToken, triggerPipeline } from './lib/pipelineApi.mjs';
 import { setDebug, log } from './lib/util.mjs';
 import path from 'path';
 import { fileURLToPath } from 'url';
+import Deployer from './deploy.mjs';
+import { getScpClient, TEST_SERVER_HOST } from './util.mjs';
+
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 
-const TEST_SERVER_HOST = "192.168.0.35";
 /**
  * 加载配置
  * @returns 配置对象
@@ -56,6 +55,14 @@ async function initConfigJson() {
     },
     "testSync": {
         "dist/index.html": "events/CHANGE_ME.htm"
+    },
+    "prodPipeline":{
+        "pipelines": [
+            {
+                "name": "OfficialSite OR SOMEOTHER",
+                "waitResult": true
+            }
+        ]
     }
 }`;
     fs.writeFileSync(configJsonPath, content, { encoding: "utf-8" });
@@ -63,27 +70,6 @@ async function initConfigJson() {
     process.exit(0);
 }
 
-function hasChangeMe(content) {
-    return content.includes("CHANGE_ME");
-}
-
-async function getScpClient() {
-    let scpClient = null;
-    // 不能放密码。。残念
-    const scpClientConfig = {
-        host: TEST_SERVER_HOST,
-        username: 'root',
-        tryKeyboard: true,
-    }
-    const sshKeyPath = join(homedir(), ".ssh/id_rsa");
-    if (fs.existsSync(sshKeyPath)) {
-        scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
-    } else {
-        log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
-    }
-    scpClient = await Client(scpClientConfig);
-    return scpClient;
-}
 
 async function getVersion() {
     const packageJsonPath = join(__dirname, "package.json");
@@ -92,6 +78,11 @@ async function getVersion() {
 }
 
 
+function getDeployer(){
+    return new Deployer();
+}
+
+
 async function main() {
     const version = await getVersion();
 
@@ -189,233 +180,11 @@ async function main() {
         log(`deploy mode: ${mode}`);
         log(`workDir: ${workDir}`);
 
-        // 读取配置
         const config = await loadConfig();
-        // log(`config`, config);
-
-        const result = hasChangeMe(JSON.stringify(config));
-        if (result) {
-            log(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
-            process.exit(1);
-        }
-
-
-        const needHandleAssets = config.assets && config.assets.dest;
-
-        // 需要处理entry
-        const needHandleEntry = config.entry && config.entry.dest && (mode === 'prod' || (mode === 'test' && !config.entry.onlyProd));
-        const entryTestBranch = (config.entry && config.entry.testBranch) || "test";
-        const entryProdBranch = (config.entry && config.entry.prodBranch) || "master";
-        const entryTargetBranch = mode === 'prod' ? entryProdBranch : entryTestBranch;
-        // const currentProdBranch = config.prodBranch || "master";
-
-
-        // 检查流水线配置
-        checkYunxiaoToken(config, mode);
-
-
-        // 检查项目
-        // 1. 检查项目是否存在
-        let assetsDest = null;
-        let entryDest = null;
-        if (needHandleAssets) {
-            assetsDest = join(workDir, config.assets.dest);
-            if (!fs.existsSync(assetsDest)) {
-                log(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
-                process.exit(1);
-            }
-        }
-        // entry.dest
-        if (needHandleEntry) {
-            entryDest = join(workDir, config.entry.dest);
-            if (!fs.existsSync(entryDest)) {
-                log(`entry.dest路径不存在: ${entryDest}, 请先创建`);
-                process.exit(1);
-            }
-        }
-
-        // 2. 检查项目是否clean
-        let assetsGit = null;
-        let assetsStatus = null;
-        if (needHandleAssets) {
-            assetsGit = simpleGit(assetsDest);
-            assetsStatus = await assetsGit.status();
-            if (!assetsStatus.isClean()) {
-                log(`${assetsDest}目前有未提交内容, 请先处理`);
-                return;
-            }
-        }
-
-        let entryGit;
-        let entryStatus;
-        if (needHandleEntry) {
-            entryGit = simpleGit(entryDest);
-            entryStatus = await entryGit.status();
-            if (!entryStatus.isClean()) {
-                log(`${entryDest}目前有未提交内容, 请先处理`);
-                return;
-            }
-        }
-
-        // 2.1如果是prod模式，检查当前项目是不是处于主分支
-        // if (mode === 'prod') {
-        //     const currentGit = simpleGit(workDir);
-        //     const currentStatus = await currentGit.status();
-        //     if (!currentStatus.isClean()) {
-        //         log(`当前项目有未提交内容, 请先处理`);
-        //         process.exit(1);
-        //     }
-        //     if (currentStatus.branch !== currentProdBranch) {
-        //         log(`当前项目分支${currentStatus.branch}不是${currentProdBranch}分支, 请切换至${currentProdBranch}分支再执行prod命令`);
-        //         process.exit(1);
-        //     }
-        // }
-
-        // 3. 检查assets项目分支，并切换至master分支
-        // assets项目固定使用master分支
-        if (needHandleAssets && assetsStatus.current !== "master") {
-            log(`${assetsDest}当前分支不是master, 切换至master分支`);
-            await assetsGit.checkout("master");
-            log(`${assetsDest}切换至master分支成功`);
-        }
-        if (needHandleEntry && entryStatus.current !== entryTargetBranch) {
-            log(`${entryDest}当前分支不是${entryTargetBranch}, 切换至${entryTargetBranch}分支`);
-            await entryGit.checkout(entryTargetBranch);
-            log(`${entryDest}切换至${entryTargetBranch}分支成功`);
-        }
-
-        // 4. 执行git pull
-        if (assetsGit) {
-            log(`${assetsDest}执行git pull`);
-            await assetsGit.pull();
-            log(`${assetsDest} git pull done`);
-        }
-        if (entryGit) {
-            log(`${entryDest}执行git pull`);
-            await entryGit.pull();
-            log(`${entryDest} git pull done`);
-        }
-
-        // 5. 复制构建产物
-        // 5.1 复制assets
-        if (needHandleAssets) {
-            let assetsFilesCount = 0;
-            const assetsFiles = config.assets.files;
-            for (const [src, dest] of Object.entries(assetsFiles)) {
-                const srcPath = join(workDir, src);
-                if (!fs.existsSync(srcPath)) {
-                    log(`${srcPath}不存在，请确认构建产物是否正确`);
-                    return;
-                }
-                const destPath = join(assetsDest, dest);
-                if (fs.statSync(srcPath).isDirectory()) {
-                    fs.cpSync(srcPath, destPath, { recursive: true });
-                } else {
-                    fs.copyFileSync(srcPath, destPath);
-                }
-                log(`assets copy: ${srcPath} -> ${destPath}`);
-                assetsFilesCount++;
-            }
-            // log(`assets copy done.`);
-        }
-        // 5.2 复制entry
-        if (needHandleEntry) {
-            const entryFiles = config.entry.files;
-            for (const [src, dest] of Object.entries(entryFiles)) {
-                const srcPath = join(workDir, src);
-                if (!fs.existsSync(srcPath)) {
-                    log(`${srcPath}不存在，请确认构建产物是否正确`);
-                    return;
-                }
-                if (fs.statSync(srcPath).isDirectory()) {
-                    log(`entry: ${srcPath}是目录，不支持entry为目录的部署`);
-                    return;
-                }
-                const destPath = join(entryDest, dest);
-                fs.copyFileSync(srcPath, destPath);
-                log(`entry copy: ${srcPath} -> ${destPath}`);
-            }
-            // log(`entry copy done.`);
-        }
-
-        // 6. 提交
-        let canPushAssets = false;
-        let canPushEntry = false;
-        if (needHandleAssets) {
-            assetsStatus = await assetsGit.status();
-            if (!assetsStatus.isClean()) {
-                canPushAssets = true;
-                await assetsGit.add(".");
-                const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
-                const assetsCommitResult = await assetsGit.commit(assetsCommit);
-                log(`assets commit: ${assetsCommit}`);
-                log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
-            } else {
-                log(`${assetsDest} 未发现修改内容,跳过提交`);
-            }
-        }
-        if (needHandleEntry) {
-            entryStatus = await entryGit.status();
-            if (!entryStatus.isClean()) {
-                canPushEntry = true;
-                await entryGit.add(".");
-                const entryCommit = `${config.entry.commit || "feat:部署入口文件"} by deploy-helper`;
-                const entryCommitResult = await entryGit.commit(entryCommit);
-                log(`entry commit: ${entryCommit}`);
-                log(`entry commit: ${JSON.stringify(entryCommitResult.summary)}`);
-            } else {
-                log(`${entryDest} 未发现修改内容,跳过提交`);
-            }
-        }
-
-        // 7. 推送
-        if (canPushAssets) {
-            log(`assets push start`);
-            try {
-                await assetsGit.push();
-            } catch (error) {
-                await assetsGit.push();
-            }
-            log(`assets push done.`);
-        }
-        if (canPushEntry) {
-            log(`entry push start`);
-            try {
-                await entryGit.push();
-            } catch (error) {
-                await entryGit.push();
-            }
-            log(`entry push done.`);
-        }
-
-        try {
-            // 8 测试环境将entry scp至测试环境
-            if (mode === 'test' && config.testSync) {
-                const syncTestFiles = config.testSync;
-                const scpClient = await getScpClient();
-                for (const [src, dest] of Object.entries(syncTestFiles)) {
-                    const srcPath = join(workDir, src);
-                    const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
-                    log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
-                    await scpClient.uploadFile(srcPath, destPath)
-                }
-            }
-        } catch (error) {
-            log(`scp error: ${error}`);
-            log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
-            if (assetsFilesCount > 0) {
-                log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
-            }
-            process.exit(1);
-        }
-
-
-        // 处理触发流水线的任务
-        await runPipeline(config, mode);
-
+        const deployer = getDeployer();
+        await deployer.deploy(workDir, mode, config);
         log(`deploy-helper deploy done.`);
         process.exit(0);
-
     } catch (error) {
         log(`error occurred in deploy-helper`, error);
         process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taole/deploy-helper",
-  "version": "0.5.3",
+  "version": "1.0.0-beta.0",
   "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
   "main": "index.mjs",
   "type": "module",
@@ -17,6 +17,9 @@
   },
   "files": [
     "index.mjs",
+    "deploy.mjs",
+    "deploy2.mjs",
+    "util.mjs",
     "lib",
     "modules/alibabacloud-devops-mcp-server/dist"
   ],

package/util.mjs

@@ -0,0 +1,22 @@
+import { Client } from 'node-scp'
+
+
+export function hasChangeMe(content) {
+    return content.includes("CHANGE_ME");
+}
+
+export const TEST_SERVER_HOST = "192.168.0.35";
+
+
+
+export async function getScpClient() {
+    let scpClient = null;
+    const scpClientConfig = {
+        host: TEST_SERVER_HOST,
+        username: 'root',
+        tryKeyboard: false,
+        password: 'tuwan123!@#', // u cant see me
+    }
+    scpClient = await Client(scpClientConfig);
+    return scpClient;
+}