dockerExecute 函数和docker.build的区别解析_Docker

一、dockerexecute介绍

dockerexecute 通常是一个自定义的函数或者由特定的 jenkins 库（如 piper-lib）提供，用于在 docker 容器中执行特定的命令。这类函数可以帮助在构建或测试阶段管理 docker 容器的生命周期，确保步骤在容器内运行。它的作用是启动一个 docker 容器，并在该容器中执行提供的命令.

1、使用场景：

执行需要隔离环境的任务：当你需要在指定的 docker 容器中运行特定的命令，例如运行测试脚本、构建项目等。
保证环境一致性：确保在一个隔离的、标准化的 docker 容器中运行任务，从而消除环境差异带来的问题。
动态设置：允许对容器的配置进行更细粒度的控制，如动态设置环境变量、挂载卷等。

2、dockerexecute方法的使用介绍

因为我的测试背景正好是公司内部的 docker 镜像存储库中的有一个现成的专用于测试的镜像；所以我直接在这个pipline脚本中去运用了这个方法，给大家看个例子顺便讲解一下：

stage('test') {
    node {
        dockerexecute(script: this,
        dockerimage: "your-docker-image",
        dockername: 'your-docker-name'{
// 在 docker 容器内部执行以下命令
                    sh '''
                        //例如安装依赖,设置环境变量,执行关键脚本等等
                        python main.py
                        '''
}

3、dockerexecute 接受的参数解释：

script: this:
- 把 this 传递给 script 参数。它通常用于在 dockerexecute 函数内部引用当前脚本或上下文。
dockerimage: "your-docker-image",
- 指定 docker 镜像的名称。这个镜像往往包含了你所需要的环境（例如特定版本的 python 及相关工具和依赖）。
dockername: 'your-docker-name'
- 设置 docker 容器的名称。这有助于在 jenkins 日志和其他地方识别运行的容器。

作用总结

在指定的 docker 镜像基础上启动一个 docker 容器。
参数 script: this 引用当前脚本上下文。
参数 dockerimage 指定要使用的 docker 镜像。
参数 dockername 为启动的容器命名。

二、docker.build介绍

docker.build 是 jenkins 的 docker 插件提供的一个方法，用于构建 docker 镜像。它会读取当前目录下的 dockerfile 并构建一个新的 docker 镜像，有助于将你的应用和所有的依赖封装到一个标准的镜像中。

1、使用场景：

构建新的 docker 镜像：当你需要基于 dockerfile 构建一个新的 docker 镜像时使用。
版本控制和部署：将应用打包成 docker 镜像，作为 ci/cd 流程的一部分提交到 docker registry 或用于部署。

2、结合使用

典型的工作流可能涉及先用 docker.build 构建镜像，然后用该镜像运行某些任务，如测试套件。

3、定义场景

假设你有一个 python 项目，你想要构建并在 docker 容器中运行测试。
你需要在项目根目录下创建一个jenkinsfile和一个dockerfile

（1）dockerfile示例：

# 使用已有基础镜像
from your-docker-image
# 设置工作目录
workdir /web-test
# 安装系统依赖包括 chromedriver 和 google-chrome
run apt-get update && apt-get install -y \
    xvfb \
    x11-utils \
    libgl1-mesa-glx \
    wget \
    unzip \
    curl \
    gnupg \
    && apt-get clean \
    && rm -rf /var/lib/apt/lists/*
# 安装 chromedriver
run wget -o /tmp/chromedriver.zip https://chromedriver.storage.googleapis.com/113.0.5672.63/chromedriver_linux64.zip \
    && unzip /tmp/chromedriver.zip -d /usr/local/bin/ \
    && rm /tmp/chromedriver.zip
# 下载并安装 google-chrome
run wget -o /tmp/google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
    && apt-get update && apt-get install -y --no-install-recommends /tmp/google-chrome.deb \
    && rm /tmp/google-chrome.deb
# 将 requirements.txt 复制到工作目录
copy requirements.txt .
# 安装 python 依赖
run pip install --no-cache-dir -r requirements.txt
# 将项目文件复制到工作目录
copy . .
# 设置环境变量
env display=:99
# 启动 xvfb 并运行应用
cmd xvfb :99 -screen 0 1920x1080x24 & python pana/generatereport.py

（2）jenkinsfile示例：

@library(["piper-lib", "piper-lib-os"]) _
pipeline {
    agent any
    stages {
        stage('checkout') {
            steps {
                checkout scm
            }
        }
        stage('build-image') {
            steps {
                script {
                    // 使用当前目录下的 dockerfile 构建新的 docker 镜像
                    docker.build('my-repo/my-python-app:latest', '-f dockerfile .')
                }
            }
        }
        stage('test') {
            steps {
                script {
                    dockerexecute(script: this,
                    dockerimage: "my-repo/my-python-app:latest",
                    dockername: 'python') {
                        sh '''
                            set -e
                            # 设置 display 环境变量
                            export display=:99
                            # 启动 xvfb 并在后台运行
                            xvfb :99 -screen 0 1920x1080x24 &
                            # 等待 xvfb 完全启动
                            sleep 5
                            # 打印 python 版本信息
                            python --version
                            # 升级 pip
                            python -m pip install --upgrade pip
                            # 切换到工作目录
                            cd $workspace
                            # 安装 python 依赖
                            python -m pip install -r requirements.txt
                            # 运行 python 脚本
                            python pana/generatereport.py
                            # 可选：确保完成后停止 xvfb
                            killall xvfb
                        '''
                    }
                }
            }
        }
    }
    post {
        always {
            echo 'cleaning up...'
            // 放置任何清理步骤
        }
        success {
            echo 'pipeline succeeded'
        }
        failure {
            echo 'pipeline failed'
        }
    }
}