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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
"""
Tests installation of our library.
"""
import glob
import os
import platform
import shutil
import sys
import tarfile
import time
import unittest
import stem
import stem.util.system
import stem.util.test_tools
import test
from stem.util.test_tools import asynchronous
INSTALLATION_TIMEOUT = 20 # usually takes ~5s
BASE_INSTALL_PATH = '/tmp/stem_test'
PYTHON_EXE = sys.executable if sys.executable else 'python'
INSTALL_MISMATCH_MSG = "Running 'python setup.py sdist' doesn't match our git contents in the following way. The manifest in our setup.py may need to be updated...\n\n"
SETUPTOOLS_LITTER = ('dist', 'stem.egg-info', 'stem_dry_run.egg-info') # setuptools cruft its 'clean' command won't clean up
def _assert_has_all_files(path):
"""
Check that all the files in the stem directory are present in the
installation. This is a very common gotcha since our setup.py
requires us to remember to add new modules and non-source files.
:raises: **AssertionError** files don't match our content
"""
expected, installed = set(), set()
for root, dirnames, filenames in os.walk(os.path.join(test.STEM_BASE, 'stem')):
for filename in filenames:
file_format = filename.split('.')[-1]
if file_format not in test.IGNORED_FILE_TYPES:
expected.add(os.path.join(root, filename)[len(test.STEM_BASE) + 1:])
for root, dirnames, filenames in os.walk(path):
for filename in filenames:
if not filename.endswith('.pyc') and 'egg-info' not in root:
installed.add(os.path.join(root, filename)[len(path) + 1:])
missing = expected.difference(installed)
extra = installed.difference(expected)
if missing:
raise AssertionError("The following files were expected to be in our installation but weren't. Maybe our setup.py needs to be updated?\n\n%s" % '\n'.join(missing))
elif extra:
raise AssertionError("The following files weren't expected to be in our installation.\n\n%s" % '\n'.join(extra))
class TestInstallation(unittest.TestCase):
@staticmethod
def run_tests(args):
test_install = stem.util.test_tools.ASYNC_TESTS['test.integ.installation.test_install']
test_install.run()
stem.util.test_tools.ASYNC_TESTS['test.integ.installation.test_sdist'].run(test_install.pid())
@asynchronous
def test_install():
"""
Installs with 'python setup.py install' and checks we can use what we
install.
"""
try:
try:
stem.util.system.call('%s setup.py install --root %s' % (PYTHON_EXE, BASE_INSTALL_PATH), timeout = 60, cwd = test.STEM_BASE)
stem.util.system.call('%s setup.py clean --all' % PYTHON_EXE, timeout = 60, cwd = test.STEM_BASE) # tidy up the build directory
if platform.python_implementation() == 'PyPy':
site_packages_paths = glob.glob('%s/*/*/site-packages' % BASE_INSTALL_PATH)
else:
site_packages_paths = glob.glob('%s/*/*/lib*/*/*-packages' % BASE_INSTALL_PATH)
except stem.util.system.CallError as exc:
msg = ["Unable to install with '%s': %s" % (exc.command, exc.msg)]
if exc.stdout:
msg += [
'-' * 40,
'stdout:',
'-' * 40,
exc.stdout.decode('utf-8'),
]
if exc.stderr:
msg += [
'-' * 40,
'stderr:',
'-' * 40,
exc.stderr.decode('utf-8'),
]
raise AssertionError('\n'.join(msg))
if not site_packages_paths:
all_files = glob.glob('%s/**' % BASE_INSTALL_PATH, recursive = True)
raise AssertionError('Unable to find site-packages, files include:\n\n%s' % '\n'.join(all_files))
elif len(site_packages_paths) > 1:
raise AssertionError('We should only have a single site-packages directory, but instead had: %s' % site_packages_paths)
install_path = site_packages_paths[0]
version_output = stem.util.system.call([PYTHON_EXE, '-c', "import sys;sys.path.insert(0, '%s');import stem;print(stem.__version__)" % install_path])[0]
if stem.__version__ != version_output:
raise AssertionError('We expected the installed version to be %s but was %s' % (stem.__version__, version_output))
_assert_has_all_files(install_path)
finally:
if os.path.exists(BASE_INSTALL_PATH):
shutil.rmtree(BASE_INSTALL_PATH)
for directory in SETUPTOOLS_LITTER:
path = os.path.join(test.STEM_BASE, directory)
if os.path.exists(path):
shutil.rmtree(path)
@asynchronous
def test_sdist(dependency_pid):
"""
Creates a source distribution tarball with 'python setup.py sdist' and
checks that it matches the content of our git repository. This primarily is
meant to test that our MANIFEST.in is up to date.
"""
started_at = time.time()
while stem.util.system.is_running(dependency_pid):
if time.time() > started_at + INSTALLATION_TIMEOUT:
raise AssertionError('Stem failed to install within %i seconds' % INSTALLATION_TIMEOUT)
time.sleep(0.1) # these tests must run serially
git_dir = os.path.join(test.STEM_BASE, '.git')
if not stem.util.system.is_available('git'):
raise unittest.case.SkipTest('(git unavailable)')
elif not os.path.exists(git_dir):
raise unittest.case.SkipTest('(not a git checkout)')
try:
try:
stem.util.system.call('%s setup.py sdist --dryrun' % PYTHON_EXE, timeout = 60, cwd = test.STEM_BASE)
except Exception as exc:
raise AssertionError("Unable to run 'python setup.py sdist': %s" % exc)
git_contents = [line.split()[-1] for line in stem.util.system.call('git --git-dir=%s ls-tree --full-tree -r HEAD' % git_dir)]
# tarball has a prefix 'stem-[verion]' directory so stipping that out
dist_content = glob.glob('%s/*' % os.path.join(test.STEM_BASE, 'dist'))
if len(dist_content) != 1:
raise AssertionError('We should only have a single file in our dist directory, but instead had: %s' % ', '.join(dist_content))
with tarfile.open(dist_content[0]) as dist_tar:
tar_contents = ['/'.join(info.name.split('/')[1:]) for info in dist_tar.getmembers() if info.isfile()]
issues = []
for path in git_contents:
if path not in tar_contents and path not in ['.gitignore', '.travis.yml']:
issues.append(' * %s is missing from our release tarball' % path)
for path in tar_contents:
if path not in git_contents and path not in ['MANIFEST.in', 'PKG-INFO', 'setup.cfg'] and not path.startswith('stem_dry_run.egg-info'):
issues.append(" * %s isn't expected in our release tarball" % path)
if issues:
raise AssertionError(INSTALL_MISMATCH_MSG + '\n'.join(issues))
finally:
for directory in SETUPTOOLS_LITTER:
path = os.path.join(test.STEM_BASE, directory)
if os.path.exists(path):
shutil.rmtree(path)
|
