python-daemon

#24 Refactor testing by introducing tox.

Closed 5 years ago by bignose. Opened 5 years ago by hberaud.

hberaud/python-daemon refactor-tests into master

Refactor testing by introducing tox.

Hervé Beraud • 5 years ago

99324f5

doc/hacking.txt

file modified

		`@@ -192,6 +192,14 @@`
		`development tree when accompanied by corresponding additions or`
		`changes to the unit tests.`

		`+ To launch unit test using the following commands::`
		`+`
		`+ $ tox`
		`+`
		`+ You can also check specific environment by using::`
		`+`
		`+ $ tox -e py37`
		`+`
		`Test-driven development`
		`-----------------------`

pyproject.toml

file removed

-16

		`@@ -1,16 +0,0 @@`
bignose commented 5 years ago This file was added in order to support systems that use it. Why remove it? If there is a problem in this file, I would like to fix the file and keep its functionality intact. If there is a problem with some third-party system (e.g. Tox), that does not seem good enough reason to remove this file.
		`- # pyproject.toml`
		`- # Build system requirements for Python code in this code base.`
		`- # Documentation: <URL:https://www.python.org/dev/peps/pep-0518/>.`
		`-`
		`- [build-system]`
		`-`
		`- # Minimum requirements for the build system.`
		`- requires = ["setuptools", "wheel", "docutils"]`
		`-`
		`-`
		`- # Local-variables:`
		`- # coding: utf-8`
		`- # mode: conf`
		`- # mode: toml`
		`- # End:`
		`- # vim: fileencoding=utf-8 filetype=toml :`

test-requirements.txt

file added

		`@@ -0,0 +1,5 @@`
		`+ unittest2>=0.5.1`
		`+ testtools`
		`+ testscenarios>=0.4`
		`+ mock>=1.3`
		`+ docutils`

tox.ini

file added

+13

		`@@ -0,0 +1,13 @@`
		`+ # tox (https://tox.readthedocs.io/) is a tool for running tests`
		`+ # in multiple virtualenvs. This configuration file will run the`
		`+ # test suite on all supported python versions. To use it, "pip install tox"`
		`+ # and then run "tox" from this directory.`
		`+`
		`+ [tox]`
		`+ envlist = py35, py36, py37, pep8, docs`
		`+`
		`+ [testenv]`
		`+ deps = -r{toxinidir}/test-requirements.txt`
		`+`
		`+ commands =`
		`+ python -m unittest discover`

hberaud commented 5 years ago

Since we have propose to refactor the project
release management by using pbr we now propose with this
commit to refactor testing by using tox[1].

Why using tox? tox introduce virtualenv for testing
and allow to test your project with multiple version
of python in the same time. Also tox is a standard tools
in python community and made the testing more straightforward
for your contributors and maintainers.

This commit introduce:
- introduce requirements file for tests dependancies;
- remove PEP 518 since pbr was introduced and your pyproject.toml was incompatible with tox;
- improve hacking doc by explain to your contributors how to test theirs changes.

Using it:
- install tox (pip install tox);
- launch tests (tox)

tox[1] allow simplify python testing by introducing:
- virtualenv;
- specific targets;
- cross testing;
- integrated with many CI platforms.

In order merge this pull request before => https://pagure.io/python-daemon/pull-request/23

[1] https://tox.readthedocs.io/en/latest/

Co-authored-by: Hobbestigrou hobbestigrou@erakis.eu

rebased onto 99324f5

5 years ago

hberaud commented 5 years ago