Python Tox介绍和使用

愿景： 标准化python中的测试

Tox立志于自动和标准化python中的测试。它是“使python软件打包，测试和发布的流程更容易“这一愿景更容易的一部分。

什么是tox?

tox是一个通用的virtualenv管理和测试命令行工具。你可以用来：

• 针对不同版本的python及其翻译器，校验你的包均安装正确
• 在每一个环境中，配置你的测试工具，并执行测试
• 作为一个前端的持续集成的服务器，极大的减少了模版和合并CI以及基于shell的测试

基础示例

首先，使用'pip install tox'安装‘tox’。

然后，在setup.py的同层目录下，创建tox.ini文件，并配置关于你项目和测试项目的最基本的信息。

如下：

# content of: tox.ini , put in same dir as setup.py
[tox]
envlist = py27,py36

[testenv]
# install pytest in the virtualenv where commands will be executed
deps = pytest
commands =
    # NOTE: you can run any command line tool here - not just tests
    pytest

你也可以通过运行‘tox-quickstart’然后回答问题而自动生成一个模版文件tox.ini

然后运行tox针对python2.7和python3.6去编译，安装和测试你的项目

当第二次运行tox的时候,执行速率会更快。这是因为，它会利用virtualenv内的东西，而不会像重新创建和安装依赖。

配置和用法用例提供了更多的参考。

系统概述

 

tox工作流程大致经历了一下阶段：

1. 配置

加载tox.ini， 然后和命令行传入的选项以及当前操作系统的环境变量进行合并

2. 打包

通过调用‘python setup.py sdist’来为当前的项目生包源码分发包

如果没有setup.py可跳过该步。

3. 环境 ​​​​​​​ 

针对每一个环境例如py27, py36做：

1） 环境创建

默认会使用virtualenv创建一个新的环境，tox会根据你的环境命名自动发现可用的Python编译器版本（例如，py27意味着Python2.7）。一般当有影响项目的变化发生时，环境重建会被自动触发。强制重建，可使用tox -r/--recreate。

2）安装

根据deps的配置来安装环境的依赖包，然后安装已经打好的包。默认，pip用来安装包，而定制化安装则可使用install_command。

如果你的依赖有变化，需要手动receate环境。

3）命令

在这个指定的目录下，执行指定的命令。执行过程中，遇到任何非0返回值，则会失败退出中止程序执行。注意，如果执行的命令用单引号包裹，则意味着忽略退出值。

4. 报告

输出每一个环境的输出报告，例如：

____________________ summary ____________________
py27: commands succeeded
ERROR:   py36: commands failed

只有当所有环境都成功执行，tox则会返回退出值0。这个情况下，你会看到返回信息Congratulations.

tox会为很好的隔离环境：

它会为你剥去非passenv传入的环境变量。另外， 它PATH变量也发生变化，它会优先使用当先活跃的tox环境。

当前特性

1）自动化Python相关的测试行为

2）针对多种翻译器和依赖配置，测试Python包

3） 插件提供了执行中的hooks

4) 默认使用pip和setuptools，支持通过install_command=ARGV来配置installer命令

5）兼容不同版本的Python

6) 平台兼容

7）和可持续集成服务器例如Jenkins等整合

相关项目

tox已经影响了Python自动化领域的一些其它项目。如果tox不满足你的需求，你想进行更多的调研，我们建议看看以下项目:

1）Invoke是一个通用目的任务执行的包，和Make相似。

2）Nox 和tox很相似，但是方法不同。主要区别是，Nox不使用配置文件而使用Python脚本。如果你觉tox.ini太限制，则可以试一试NOX