教程:做一个简单的发版脚本

2025-01-21开发环境3 分钟197 次阅读
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面

前言

目前所在的这家公司虽然上微服务,但发版稍微麻烦,得登录去发布平台,点击发布,而且有时候如果 master 合过来的代码,必须全部发版一次,这就导致每次手动点击发布的效率非常低。

尤其是在依赖关系复杂的情况下,若服务未及时更新最新代码,可能会引发依赖异常。因此,我决定编写一个脚本,实现按指定顺序快速发版,以确保依赖关系的正确性并大幅提高发版效率。

下面我将以我目前所在公司的发布平台为例,编写本地可以快速发布的脚本代码。

教程

首先编写 main.py

python 复制代码
import requests
import json

# 发布平台对应的登录URL、发版URL 和所需 Headers
loginUrl = 'http://xxxxx:8080/login'
deployUrl = "http://xxxxx:8080/auth/project/deploy/queue"

headers = {
    "Content-Type": "application/json",
    "Cookie": "xxxxxx"
}

# 需要发版的 number 列表
default_numbers = [
    "test-uat-permission-api",

    "test-uat-platform-api",
    "test-uat-data-trace",
    "test-uat-member",
    "test-uat-marketing-service",
    "test-uat-pay-service",
    "test-uat-order-service",
    "test-uat-data-service",
    "test-uat-pay-notify-gateway",

    "test-uat-external",
    "test-uat-permission-service",
    "test-uat-configuration-service",

    "test-uat-bops-api",
    "test-uat-app-api",
    "test-uat-event-aggregate",
    "test-uat-data-stat",
    "test-uat-bops-web"
]


def login(username, password):
    """
    登录并获取 Token
    :param username: 登录用户名
    :param password: 登录密码
    :return: 登录成功返回 Token 字符串,失败返回 None
    """
    try:
        # 发送POST请求,设置为JSON格式
        payload = {"userName": username, "passwd": password}
        response = requests.post(url=loginUrl, data=json.dumps(payload), headers={
            "Content-Type": "application/json"
        })

        # 打印响应状态码
        print("状态码:", response.status_code)
        if response.status_code == 200:
            response_json = response.json()
            print("响应正文:", response_json)
            code = response_json.get("code")
            if code == 200:
                cookies = response.cookies.get_dict()
                # 构造 Cookie 字符串
                cookie_string = "; ".join([f"{key}={value}" for key, value in cookies.items()])
                # 打印Cookie和Session信息
                print("Cookies:", cookie_string)
                headers["Cookie"] = cookie_string
                print("headers:", headers)
                return True
            print("登录异常:", response_json.get("error"))
        return False
    except requests.RequestException as e:
        print("请求发生错误:", str(e))
        return False


def send_request(number, headers, url):
    """
    发送请求并处理响应
    :param number: 发版的 number 参数
    :param headers: 请求头
    :param url: 请求的 URL
    :return: True 表示成功,False 表示失败
    """
    try:
        payload = {"number": number}
        response = requests.post(url, headers=headers, data=json.dumps(payload))
        if response.status_code == 401:
            print("认证失败 (401),终止脚本执行。")
            return False

        if response.status_code == 200:
            result = response.json()
            if result.get("success"):
                print(f"发版成功: {number}")
                return True
            else:
                print(f"发版失败: {number},响应: {result}")
        else:
            print(f"请求失败: {number},状态码: {response.status_code},响应: {response.text}")
    except Exception as e:
        print(f"处理 {number} 时发生异常: {str(e)}")
    return False


def deploy(numbers, post_url=None):
    """
    执行发版流程
    :param numbers: 需要发版的 number 列表
    :param post_url: 请求的 URL
    """
    for number in numbers:
        if not send_request(number, headers, post_url):
            break


if __name__ == "__main__":
    import argparse

    # 解析命令行参数
    parser = argparse.ArgumentParser(description="发版脚本")
    parser.add_argument("--number", help="指定发版的 number 参数")
    parser.add_argument("--url", help="自定义 Url")
    parser.add_argument("--username", help="登录用户名")
    parser.add_argument("--password", help="登录密码")
    args = parser.parse_args()

    url = args.url or deployUrl
    username = args.username or "test"
    password = args.password or "test"
    print("正在尝试登录...")
    if login(username, password):
        print("登录成功")
        # 如果指定了 number,则只发对应的 number
        if args.number:
            deploy([args.number], post_url=url)
        else:
            deploy(default_numbers, post_url=url)
    else:
        print("登录失败,无法执行发版流程。")

编写 deploy.sh

bash 复制代码
#!/bin/bash

# 获取当前脚本所在的绝对路径
# 获取实际脚本的路径(处理符号链接)
source="${BASH_SOURCE[0]}"
while [ -h "$source" ]; do
    dir=$(cd -P "$(dirname "$source")" && pwd)
    source=$(readlink "$source")
    [[ $source != /* ]] && source="$dir/$source"
done
script_dir=$(cd -P "$(dirname "$source")" && pwd)

# 构建 Python 脚本的绝对路径
python_file="$script_dir/main.py"

# 提示用户输入参数
echo "以下是可用的默认 number 列表:"
echo "---------------------------------------"
default_numbers=(
    "test-uat-permission-api"
    "test-uat-platform-api"
    "test-uat-data-trace"
    "test-uat-member"
    "test-uat-marketing-service"
    "test-uat-pay-service"
    "test-uat-order-service"
    "test-uat-data-service"
    "test-uat-pay-notify-gateway"
    "test-uat-external"
    "test-uat-permission-service"
    "test-uat-configuration-service"
    "test-uat-bops-api"
    "test-uat-app-api"
    "test-uat-event-aggregate"
    "test-uat-data-stat"
    "test-uat-bops-web"
)
# 显示 numbers 列表供用户选择
echo "请选择一个 number 参数:"
for i in "${!default_numbers[@]}"; do
    echo "$((i + 1))) ${default_numbers[$i]}"
done

# 提示用户选择序号
read -p "请输入序号 (1-${#default_numbers[@]}): " index

# 验证输入的序号是否有效
if [[ "$index" =~ ^[0-9]+$ ]] && [ "$index" -ge 1 ] && [ "$index" -le "${#default_numbers[@]}" ]; then
    number="${default_numbers[$((index - 1))]}"
    echo "已选择: $number"
else
    echo "无效的序号,退出脚本。"
    exit 1
fi
echo "---------------------------------------"

read -p "请输入 url 参数 (按 Enter 跳过): " url
read -p "请输入用户名 (username): " username
read -sp "请输入密码 (password): " password
echo # 换行

# 构建基础命令
cmd="python \"$python_file\""

# 动态拼接参数
if [ -n "$number" ]; then
    cmd+=" --number \"$number\""
fi

if [ -n "$url" ]; then
    cmd+=" --url \"$url\""
fi

if [ -n "$username" ]; then
    cmd+=" --username \"$username\""
fi

if [ -n "$password" ]; then
    cmd+=" --password \"$password\""
fi

# 显示最终命令并运行
echo "运行命令: $cmd"
eval $cmd

效果

image.png

结语

完成以上代码,我们就能快速实现本地发版啦。当然,以上代码只是我的过程分享,可以参考思路,结合自身实际需求做相应调整。

觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句