1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
"""
Setup scripts can use this to add setup.py test support for pytest runner.
Recommended usage:
- add pytest-runner to your 'setup_requires'
- include 'pytest' and any other testing requirements to 'tests_require'
- invoke tests with setup.py ptr
Alternate usage:
- include this file (ptr.py) in your repo
- add these lines to your setup.py::
execfile('ptr.py')
setup_params = PyTest.install(dict(...))
setuptools.setup(**setup_params)
Where '...' are your normal keyword parameters to setup()
- invoke your tests with setup.py test
"""
import os as _os
import setuptools.command.test as _pytest_runner_test
class PyTest(_pytest_runner_test.test):
user_options = [
('junitxml=', None, "Output jUnit XML test results to specified "
"file"),
('extras', None, "Install (all) setuptools extras when running tests"),
('index-url=', None, "Specify an index url from which to retrieve "
"dependencies"),
('allow-hosts=', None, "Whitelist of comma-separated hosts to allow "
"when retrieving dependencies"),
]
def initialize_options(self):
self.junitxml = None
self.extras = False
self.index_url = None
self.allow_hosts = None
def finalize_options(self):
pass
def run(self):
"""
Override run to ensure requirements are available in this session (but
don't install them anywhere).
"""
self._build_egg_fetcher()
if self.distribution.install_requires:
self.distribution.fetch_build_eggs(self.distribution.install_requires)
if self.distribution.tests_require:
self.distribution.fetch_build_eggs(self.distribution.tests_require)
if self.distribution.extras_require and self.extras:
map(self.distribution.fetch_build_eggs,
self.distribution.extras_require.values())
if self.dry_run:
self.announce('skipping tests (dry run)')
return
self.with_project_on_sys_path(self.run_tests)
def _build_egg_fetcher(self):
"""Build an egg fetcher that respects index_url and allow_hosts"""
# modified from setuptools.dist:Distribution.fetch_build_egg
from setuptools.command.easy_install import easy_install
main_dist = self.distribution
# construct a fake distribution to store the args for easy_install
dist = main_dist.__class__({'script_args': ['easy_install']})
dist.parse_config_files()
opts = dist.get_option_dict('easy_install')
keep = (
'find_links', 'site_dirs', 'index_url', 'optimize',
'site_dirs', 'allow_hosts'
)
for key in opts.keys():
if key not in keep:
del opts[key] # don't use any other settings
if main_dist.dependency_links:
links = main_dist.dependency_links[:]
if 'find_links' in opts:
links = opts['find_links'][1].split() + links
opts['find_links'] = ('setup', links)
if self.allow_hosts:
opts['allow_hosts'] = ('test', self.allow_hosts)
if self.index_url:
opts['index_url'] = ('test', self.index_url)
cmd = easy_install(
dist, args=["x"], install_dir=_os.curdir, exclude_scripts=True,
always_copy=False, build_directory=None, editable=False,
upgrade=False, multi_version=True, no_report = True
)
cmd.ensure_finalized()
main_dist._egg_fetcher = cmd
def run_tests(self):
"""
Override run_tests to invoke pytest.
"""
import pytest
import sys
# hide command-line arguments from pytest.main
argv_saved = list(sys.argv)
del sys.argv[1:]
if getattr(self, 'junitxml', None):
sys.argv.append('--junitxml=%s' % self.junitxml)
pytest.main()
sys.argv[:] = argv_saved
@classmethod
def install(cls, setup_params):
"""
Given a dictionary of keyword parameters to be passed to setup(),
update those parameters with tests_require and cmdclass to make
pytest available.
"""
reqs = setup_params.setdefault('tests_require', [])
if not any('pytest' in req for req in reqs):
reqs.extend(['pytest>=2.1.2'])
setup_params.setdefault('cmdclass', {}).update(
test=cls,
)
return setup_params
|
