mirantis/tox

mbentley/tox镜像中文文档

镜像概述

本镜像基于Ubuntu 18.04构建，提供开源测试工具tox的容器化运行环境，旨在简化Python项目的测试流程，实现多版本Python环境的自动化隔离与测试执行。

核心功能

• 自动化创建独立的Python测试环境，避免版本冲突
• 支持多Python版本（如3.7、3.8等）的兼容性验证
• 集成依赖安装、测试命令执行等全流程自动化
• 通过环境变量与卷挂载实现个性化配置

使用场景

• Python项目本地多版本测试验证
• 持续集成（CI）流程中的自动化测试环节
• 保持测试环境一致性，避免本地环境污染

配置说明

环境变量

• MY_USERNAME: 容器内运行tox的用户名（建议与宿主用户一致）
• MY_UID: 容器内用户UID（与宿主UID匹配，解决权限问题）
• MY_GID: 容器内用户GID（与宿主GID匹配）

卷挂载

• ${HOME}/.cache: 挂载宿主缓存目录，存储tox下载的依赖包
• ${HOME}/.gitconfig: 只读挂载git配置（可选，用于版本控制）
• ${HOME}/.ssh: 只读挂载SSH密钥（可选，访问私有代码仓库）
• ${PWD}: 挂载当前项目目录到容器/data路径，作为工作目录

部署示例

拉取镜像

bash
docker pull mbentley/tox

基本运行命令

1. 提前创建必要目录：

bash
mkdir ${HOME}/.cache ${HOME}/.local

2. 执行tox帮助命令：

bash
docker run -it --rm \
  --name tox \
  -e MY_USERNAME="${USER}" \
  -e MY_UID="$(id -u)" \
  -e MY_GID="$(id -g)" \
  --tmpfs /tmp \
  --tmpfs /var/log \
  -v "${HOME}/.cache":/home/"${USER}/.cache" \
  -v "${HOME}/.gitconfig":"/home/${USER}/.gitconfig":ro \
  -v "${HOME}/.local":"/home/${USER}/.local" \
  -v "${HOME}/.ssh":/home/"${USER}/.ssh":ro \
  -v "${PWD}":/data \
  -w /data \
  mbentley/tox \
    tox --help

使用Docker卷保存缓存

bash
docker run -it --rm \
  --name tox \
  -e MY_USERNAME="${USER}" \
  -e MY_UID="$(id -u)" \
  -e MY_GID="$(id -g)" \
  --tmpfs /tmp \
  --tmpfs /var/log \
  -v tox-cache:/home/"${USER}/.cache" \
  -v tox-local:"/home/${USER}/.local" \
  -v "${HOME}/.gitconfig":"/home/${USER}/.gitconfig":ro \
  -v "${HOME}/.ssh":/home/"${USER}/.ssh":ro \
  -v "${PWD}":/data \
  -w /data \
  mbentley/tox \
    tox --help

自定义bash函数简化调用

添加以下函数到~/.bashrc，即可直接用tox命令调用容器：

bash
tox() {
  docker run -it --rm \
    --name "tox-$(date +%s)" \
    -e MY_USERNAME="${USER}" \
    -e MY_UID="$(id -u)" \
    -e MY_GID="$(id -g)" \
    --tmpfs /tmp \
    --tmpfs /var/log \
    -v tox-cache:/home/"${USER}/.cache" \
    -v tox-local:"/home/${USER}/.local" \
    -v "${HOME}/.gitconfig":"/home/${USER}/.gitconfig":ro \
    -v "${HOME}/.ssh":/home/"${USER}/.ssh":ro \
    -v "${PWD}":/data \
    -w /data \
    mbentley/tox \
      tox ${@}
}