如何在Jenkins任务中运行带有命令行参数的Python程序

1. 前置环境配置 #

• 确保运行任务的Jenkins节点已经安装了项目匹配的Python版本，提前配置好pip源。如果有依赖隔离需求，可以预先在节点上创建虚拟环境，避免不同项目的依赖冲突。
• 任务执行前可以先加一行python --version的命令，确认环境调用的Python版本符合预期。

2. 配置Jenkins参数化构建 #

因为你的Python程序需要接收命令行参数，直接开启Jenkins任务的参数化能力即可：

• 自由风格任务：勾选「参数化构建过程」选项，根据你Python程序需要的参数类型添加对应配置项，比如字符串参数、布尔开关、下拉选项参数，参数名可以和Python程序接收的参数名对应，方便后续调用。
• 流水线任务：直接在Jenkinsfile的parameters块中定义参数即可。

3. 编写执行脚本 #

你可以根据任务类型选择对应的执行逻辑：

自由风格任务（shell节点示例） #

在构建步骤中添加「执行shell」步骤，内容参考：

# 进入Jenkins拉取的项目代码目录
cd $WORKSPACE
# 可选：激活虚拟环境
source ./venv/bin/activate
# 安装项目依赖
pip install -r requirements.txt
# 运行Python程序，直接把Jenkins构建参数作为命令行参数传入
# 注意包含空格的参数外层要加双引号，避免被shell拆分
python your_script.py --param1 "$JENKINS_PARAM1" --param2 $JENKINS_PARAM2

流水线任务示例 #

直接用如下Jenkinsfile配置即可：

pipeline {
    agent any
    // 定义构建参数
    parameters {
        string(name: 'PARAM1', defaultValue: 'test', description: '对应Python程序的--param1参数')
        booleanParam(name: 'PARAM2', defaultValue: false, description: '对应Python程序的--param2开关参数')
    }
    stages {
        stage('安装依赖') {
            steps {
                sh 'cd $WORKSPACE && pip install -r requirements.txt'
            }
        }
        stage('执行集成测试') {
            steps {
                sh 'cd $WORKSPACE && python your_script.py --param1 "${params.PARAM1}" --param2 ${params.PARAM2}'
            }
        }
    }
    post {
        always {
            // 可选：如果你的集成测试输出了JUnit格式的报告，添加此步骤可以在Jenkins页面展示测试结果
            junit 'test_result.xml'
        }
    }
}

4. 结果判定 #

• 如果你的Python程序执行失败时会返回非0的退出码，Jenkins会自动识别并将任务标记为失败，刚好适配集成测试的结果判定需求。
• 如果你需要更精细的测试结果统计，只需要让Python集成测试脚本输出JUnit格式的XML报告，再添加上文提到的junit步骤即可在Jenkins任务页面看到每个测试用例的执行情况。

5. 验证调试 #

第一次触发构建时，Jenkins会弹出参数填写界面，填入你需要的参数值后启动构建，查看控制台输出就能确认Python程序是否正确接收到参数，执行结果是否符合预期。

内容的提问来源于stack exchange，提问作者Rajmahendra