kiwicom/tox

tox多Python版本测试镜像

镜像概述

本镜像是一个集成tox工具与多版本Python环境的Docker镜像，旨在简化Python项目的跨版本兼容性测试流程。通过预配置多个Python解释器和tox自动化测试工具，开发者无需在本地环境安装和管理多个Python版本，即可快速执行针对不同Python版本的测试用例，确保项目在目标版本范围内的兼容性。

主要用途

• Python项目的跨版本兼容性验证
• 自动化测试流程中的环境标准化
• CI/CD流水线中的测试步骤集成
• 本地开发环境的测试环境隔离

核心功能与特性

• 多Python版本支持：预安装多个稳定Python版本（通常包括3.7、3.8、3.9、3.10、3.11等主流版本），满足不同项目的兼容性测试需求
• 内置tox工具：集成最新版tox，支持测试环境自动创建、依赖安装与测试执行
• 环境隔离：基于Docker容器的隔离机制，避免测试环境与本地开发环境冲突
• 轻量级基础：通常基于Python官方slim或Alpine镜像构建，平衡功能与镜像体积
• 灵活配置：支持通过tox.ini文件自定义测试环境、依赖与执行步骤

使用场景与适用范围

适用场景

• 开源Python库开发，需验证对多个Python版本的支持
• 企业级Python应用，需确保在生产环境Python版本的稳定性
• CI/CD流程中，作为自动化测试的标准化执行环境
• 本地开发时，快速验证代码在目标Python版本的兼容性

适用范围

• 基于tox管理测试流程的Python项目
• 需要跨2个及以上Python版本测试的项目
• 追求测试环境一致性与可重复性的团队或个人开发者

使用方法与配置说明

基本使用（Docker Run）

1. 准备项目与tox配置

确保项目根目录包含有效的tox.ini文件，定义测试环境与执行步骤。示例tox.ini配置：

ini
[tox]
envlist = py38, py39, py310
skipsdist = true  # 使用本地代码而非重新打包

[testenv]
deps =
    pytest
    pytest-cov
commands =
    pytest tests/ --cov=myproject

2. 运行测试命令

将项目目录挂载到容器中，并执行tox命令：

bash
docker run -v $(pwd):/app -w /app [镜像名称] tox

• -v $(pwd):/app：将当前目录（项目根目录）挂载到容器内的/app目录
• -w /app：设置容器工作目录为/app，确保tox读取项目中的tox.ini
• [镜像名称]：替换为实际使用的镜像标签（如tox-multi-python:latest）
• tox：执行tox命令，默认读取tox.ini配置并运行所有环境测试

3. 指定测试环境

通过TOXENV环境变量指定需运行的测试环境（对应tox.ini中的envlist）：

bash
docker run -v $(pwd):/app -w /app -e TOXENV=py39 [镜像名称] tox

上述命令仅执行py39环境的测试

Docker Compose配置示例

在项目中创建docker-compose.test.yml，集成测试服务：

yaml
version: '3.8'

services:
  tox-test:
    image: [镜像名称]
    volumes:
      - ./:/app
    working_dir: /app
    environment:
      - TOXENV=py38,py39  # 指定测试环境
    command: tox

执行测试：

bash
docker-compose -f docker-compose.test.yml up

配置参数说明

环境变量

tox.ini配置示例

基础测试环境配置（保存为项目根目录tox.ini）：

ini
[tox]
envlist = py37, py38, py39, py310, py311  # 需与镜像支持的Python版本匹配
skipsdist = true  # 使用挂载的本地代码，不重新打包

[testenv]
deps =
    # 测试依赖包
    pytest>=7.0
    pytest-cov>=4.0
    # 项目依赖（根据实际项目修改）
    requests>=2.26
commands =
    # 测试执行命令
    pytest tests/ --cov=myproject --cov-report=term

注意事项

• 确保tox.ini中定义的Python环境（如py38）与镜像支持的Python版本匹配，避免因版本缺失导致测试失败
• 本地项目文件需通过Docker卷挂载到容器内，确保tox能访问项目代码与配置文件
• 若需测试特定Python版本，可通过镜像标签选择包含目标版本的镜像（如tox-multi-python:3.11）