Tox (Python testing wrapper): Difference between revisions

Revision as of 20:19, 22 November 2016

Latest revision as of 23:00, 18 August 2025

(14 intermediate revisions by 10 users not shown)

Line 1:

{{Short description|Python testing software}}

{{lowercase title}}

'''<code>tox</code>''' is a command-line driven automated testing tool for [[Python (programming language)|Python]], based on the use of <code>[[virtualenv]]</code>. It can be used for both manually-invoked testing from the desktop, or continuous testing within [[continuous integration]] frameworks such as [[Jenkins (software)|Jenkins]] or [[Travis CI]].<ref>{{Cite web

|title=Welcome to the tox automation project

|website=

|url=http://codespeak.net/tox/

}}</ref><ref>{{Cite web

|title=Welcome to the tox automation project

|website=

Line 12 ⟶ 9:

|website=[[Python Package Index]]

|url=https://pypi.python.org/pypi/tox

}}</ref> Its use began to become popular in the Python community from around 2015.<ref name="Waprin, 2015" />

}}</ref>

<code>tox</code> acts a wrapper for both [[virtual environment (container)|virtual environment]]s and [[test automation]] tools, to simplify the consistent testing of Python code across a range of environments.<ref name="Zadka, 2019" /> It integrates the use of a virtualisation tool, such as <code>virtualenv</code>, with a test script such as [https://pypi.org/project/imprimatur/ Imprimatur]. This gives a consistent [[container (virtualization)|container]]-based testing environment on both desktops and integration servers. It also allows testing in a range of Python environments, such as Python 2 or Python 3 specific contexts.<ref name="Zadka, 2019" /><ref name="Do Nascimento, 2018" />

{{anchor|tox.ini}}Tox issupports configuredvarious throughconfiguration afile simpleformats. Initially configuration could only be done in a <code>tox.ini</code> file in [[INI_file | INI]] format. Since version 4.21 tox supports native [[TOML]] configuration integrated into <code>pyproject.toml</code>.<ref name="tox-wiki-config"/>{{Cite<ref webname="tox-wiki-changelog"/>

|title=tox configuration specification

|website=

|url=https://tox.readthedocs.org/en/latest/config.html

}}</ref>

== Smoke testing ==

<code>tox</code> is also convenient as a simple [[smoke testing (software)|smoke test]] on a newly installed, or freshly-updated system. It is also useful before beginning a [[refactoring]] exercise.<ref name="Do Nascimento, 2018" />

== References ==

{{Notelist-lr}}

{{Reflist|colwidthrefs=35em}}

<ref name="Do Nascimento, 2018" >{{Cite web

|title=Testing against multiple python versions with tox

|author=Alejandro Do Nascimento

|website=Medium.com

|date=22 March 2018

|url=https://medium.com/@alejandrodnm/testing-against-multiple-python-versions-with-tox-9c68799c7880

}}</ref>

<ref name="Waprin, 2015" >{{Cite web

|title=A Simple Tox Tutorial

|author=

|website=Waprin.io

|date=21 May 2015

|url=https://waprin.io/2015/05/21/introducing-tox.html

}}</ref>

<ref name="Zadka, 2019" >{{Cite web

|title=Automate your Python code tests with tox

|author=Moshe Zadka

|website=Opensource.com

|date=5 May 2019

|url=https://opensource.com/article/19/5/python-tox

}}</ref>

<ref name="tox-wiki-config">{{Cite web

|title=Configuration

|website=tox.wiki

|url=https://tox.readthedocs.orgwiki/en/latest/config.html

}}</ref>

<ref name="tox-wiki-changelog">{{Cite web

|title=Release History

|website=tox.wiki

|url=https://tox.wiki/en/latest/changelog.html

}}</ref>

}}

[[Category:Continuous integration]]

[[Category:Python (programming language) development tools]]

[[Category:Python (programming language) software]]