Python code coverage for Lib/packaging/tests/test_command_install_distinfo.py

#	count	content
1	n/a	"""Tests for ``packaging.command.install_distinfo``.
2	n/a
3	n/a	Writing of the RESOURCES file is tested in test_command_install_data.
4	n/a	"""
5	n/a
6	n/a	import os
7	n/a	import csv
8	n/a	import hashlib
9	n/a	import sysconfig
10	n/a
11	n/a	from packaging.command.install_distinfo import install_distinfo
12	n/a	from packaging.command.cmd import Command
13	n/a	from packaging.compiler.extension import Extension
14	n/a	from packaging.metadata import Metadata
15	n/a	from packaging.tests import unittest, support
16	n/a
17	n/a
18	n/a	class DummyInstallCmd(Command):
19	n/a
20	n/a	def __init__(self, dist=None):
21	n/a	self.outputs = []
22	n/a	self.distribution = dist
23	n/a
24	n/a	def __getattr__(self, name):
25	n/a	return None
26	n/a
27	n/a	def ensure_finalized(self):
28	n/a	pass
29	n/a
30	n/a	def get_outputs(self):
31	n/a	return (self.outputs +
32	n/a	self.get_finalized_command('install_distinfo').get_outputs())
33	n/a
34	n/a
35	n/a	class InstallDistinfoTestCase(support.TempdirManager,
36	n/a	support.LoggingCatcher,
37	n/a	unittest.TestCase):
38	n/a
39	n/a	checkLists = lambda self, x, y: self.assertListEqual(sorted(x), sorted(y))
40	n/a
41	n/a	def test_empty_install(self):
42	n/a	pkg_dir, dist = self.create_dist(name='foo',
43	n/a	version='1.0')
44	n/a	install_dir = self.mkdtemp()
45	n/a
46	n/a	install = DummyInstallCmd(dist)
47	n/a	dist.command_obj['install_dist'] = install
48	n/a
49	n/a	cmd = install_distinfo(dist)
50	n/a	dist.command_obj['install_distinfo'] = cmd
51	n/a
52	n/a	cmd.install_dir = install_dir
53	n/a	cmd.ensure_finalized()
54	n/a	cmd.run()
55	n/a
56	n/a	self.checkLists(os.listdir(install_dir), ['foo-1.0.dist-info'])
57	n/a
58	n/a	dist_info = os.path.join(install_dir, 'foo-1.0.dist-info')
59	n/a	self.checkLists(os.listdir(dist_info),
60	n/a	['METADATA', 'RECORD', 'REQUESTED', 'INSTALLER'])
61	n/a	with open(os.path.join(dist_info, 'INSTALLER')) as fp:
62	n/a	self.assertEqual(fp.read(), 'distutils')
63	n/a	with open(os.path.join(dist_info, 'REQUESTED')) as fp:
64	n/a	self.assertEqual(fp.read(), '')
65	n/a	meta_path = os.path.join(dist_info, 'METADATA')
66	n/a	self.assertTrue(Metadata(path=meta_path).check())
67	n/a
68	n/a	def test_installer(self):
69	n/a	pkg_dir, dist = self.create_dist(name='foo',
70	n/a	version='1.0')
71	n/a	install_dir = self.mkdtemp()
72	n/a
73	n/a	install = DummyInstallCmd(dist)
74	n/a	dist.command_obj['install_dist'] = install
75	n/a
76	n/a	cmd = install_distinfo(dist)
77	n/a	dist.command_obj['install_distinfo'] = cmd
78	n/a
79	n/a	cmd.install_dir = install_dir
80	n/a	cmd.installer = 'bacon-python'
81	n/a	cmd.ensure_finalized()
82	n/a	cmd.run()
83	n/a
84	n/a	dist_info = os.path.join(install_dir, 'foo-1.0.dist-info')
85	n/a	with open(os.path.join(dist_info, 'INSTALLER')) as fp:
86	n/a	self.assertEqual(fp.read(), 'bacon-python')
87	n/a
88	n/a	def test_requested(self):
89	n/a	pkg_dir, dist = self.create_dist(name='foo',
90	n/a	version='1.0')
91	n/a	install_dir = self.mkdtemp()
92	n/a
93	n/a	install = DummyInstallCmd(dist)
94	n/a	dist.command_obj['install_dist'] = install
95	n/a
96	n/a	cmd = install_distinfo(dist)
97	n/a	dist.command_obj['install_distinfo'] = cmd
98	n/a
99	n/a	cmd.install_dir = install_dir
100	n/a	cmd.requested = False
101	n/a	cmd.ensure_finalized()
102	n/a	cmd.run()
103	n/a
104	n/a	dist_info = os.path.join(install_dir, 'foo-1.0.dist-info')
105	n/a	self.checkLists(os.listdir(dist_info),
106	n/a	['METADATA', 'RECORD', 'INSTALLER'])
107	n/a
108	n/a	def test_no_record(self):
109	n/a	pkg_dir, dist = self.create_dist(name='foo',
110	n/a	version='1.0')
111	n/a	install_dir = self.mkdtemp()
112	n/a
113	n/a	install = DummyInstallCmd(dist)
114	n/a	dist.command_obj['install_dist'] = install
115	n/a
116	n/a	cmd = install_distinfo(dist)
117	n/a	dist.command_obj['install_distinfo'] = cmd
118	n/a
119	n/a	cmd.install_dir = install_dir
120	n/a	cmd.no_record = True
121	n/a	cmd.ensure_finalized()
122	n/a	cmd.run()
123	n/a
124	n/a	dist_info = os.path.join(install_dir, 'foo-1.0.dist-info')
125	n/a	self.checkLists(os.listdir(dist_info),
126	n/a	['METADATA', 'REQUESTED', 'INSTALLER'])
127	n/a
128	n/a	def test_record_basic(self):
129	n/a	install_dir = self.mkdtemp()
130	n/a	modules_dest = os.path.join(install_dir, 'lib')
131	n/a	scripts_dest = os.path.join(install_dir, 'bin')
132	n/a	project_dir, dist = self.create_dist(
133	n/a	name='Spamlib', version='0.1',
134	n/a	py_modules=['spam'], scripts=['spamd'],
135	n/a	ext_modules=[Extension('_speedspam', ['_speedspam.c'])])
136	n/a
137	n/a	# using a real install_dist command is too painful, so we use a mock
138	n/a	# class that's only a holder for options to be used by install_distinfo
139	n/a	# and we create placeholder files manually instead of using build_*.
140	n/a	# the install_* commands will still be consulted by install_distinfo.
141	n/a	os.chdir(project_dir)
142	n/a	self.write_file('spam', '# Python module')
143	n/a	self.write_file('spamd', '# Python script')
144	n/a	extmod = '_speedspam' + sysconfig.get_config_var('SO')
145	n/a	self.write_file(extmod, '')
146	n/a
147	n/a	install = DummyInstallCmd(dist)
148	n/a	install.outputs = ['spam', 'spamd', extmod]
149	n/a	install.install_lib = modules_dest
150	n/a	install.install_scripts = scripts_dest
151	n/a	dist.command_obj['install_dist'] = install
152	n/a
153	n/a	cmd = install_distinfo(dist)
154	n/a	cmd.ensure_finalized()
155	n/a	dist.command_obj['install_distinfo'] = cmd
156	n/a	cmd.run()
157	n/a
158	n/a	# checksum and size are not hard-coded for METADATA as it is
159	n/a	# platform-dependent (line endings)
160	n/a	metadata = os.path.join(modules_dest, 'Spamlib-0.1.dist-info',
161	n/a	'METADATA')
162	n/a	with open(metadata, 'rb') as fp:
163	n/a	content = fp.read()
164	n/a
165	n/a	metadata_size = str(len(content))
166	n/a	metadata_md5 = hashlib.md5(content).hexdigest()
167	n/a
168	n/a	record = os.path.join(modules_dest, 'Spamlib-0.1.dist-info', 'RECORD')
169	n/a	with open(record, encoding='utf-8') as fp:
170	n/a	content = fp.read()
171	n/a
172	n/a	found = []
173	n/a	for line in content.splitlines():
174	n/a	filename, checksum, size = line.split(',')
175	n/a	filename = os.path.basename(filename)
176	n/a	found.append((filename, checksum, size))
177	n/a
178	n/a	expected = [
179	n/a	('spam', '6ab2f288ef2545868effe68757448b45', '15'),
180	n/a	('spamd', 'd13e6156ce78919a981e424b2fdcd974', '15'),
181	n/a	(extmod, 'd41d8cd98f00b204e9800998ecf8427e', '0'),
182	n/a	('METADATA', metadata_md5, metadata_size),
183	n/a	('INSTALLER', '44e3fde05f3f537ed85831969acf396d', '9'),
184	n/a	('REQUESTED', 'd41d8cd98f00b204e9800998ecf8427e', '0'),
185	n/a	('RECORD', '', ''),
186	n/a	]
187	n/a	self.assertEqual(found, expected)
188	n/a
189	n/a	def test_record(self):
190	n/a	pkg_dir, dist = self.create_dist(name='foo',
191	n/a	version='1.0')
192	n/a	install_dir = self.mkdtemp()
193	n/a
194	n/a	install = DummyInstallCmd(dist)
195	n/a	dist.command_obj['install_dist'] = install
196	n/a
197	n/a	fake_dists = os.path.join(os.path.dirname(__file__), 'fake_dists')
198	n/a	fake_dists = os.path.realpath(fake_dists)
199	n/a
200	n/a	# for testing, we simply add all files from _backport's fake_dists
201	n/a	dirs = []
202	n/a	for dir in os.listdir(fake_dists):
203	n/a	full_path = os.path.join(fake_dists, dir)
204	n/a	if (not dir.endswith('.egg') or dir.endswith('.egg-info') or
205	n/a	dir.endswith('.dist-info')) and os.path.isdir(full_path):
206	n/a	dirs.append(full_path)
207	n/a
208	n/a	for dir in dirs:
209	n/a	for path, subdirs, files in os.walk(dir):
210	n/a	install.outputs += [os.path.join(path, f) for f in files]
211	n/a	install.outputs += [os.path.join('path', f + 'c')
212	n/a	for f in files if f.endswith('.py')]
213	n/a
214	n/a	cmd = install_distinfo(dist)
215	n/a	dist.command_obj['install_distinfo'] = cmd
216	n/a
217	n/a	cmd.install_dir = install_dir
218	n/a	cmd.ensure_finalized()
219	n/a	cmd.run()
220	n/a
221	n/a	dist_info = os.path.join(install_dir, 'foo-1.0.dist-info')
222	n/a
223	n/a	expected = []
224	n/a	for f in install.get_outputs():
225	n/a	if (f.endswith(('.pyc', '.pyo')) or f == os.path.join(
226	n/a	install_dir, 'foo-1.0.dist-info', 'RECORD')):
227	n/a	expected.append([f, '', ''])
228	n/a	else:
229	n/a	size = os.path.getsize(f)
230	n/a	md5 = hashlib.md5()
231	n/a	with open(f, 'rb') as fp:
232	n/a	md5.update(fp.read())
233	n/a	hash = md5.hexdigest()
234	n/a	expected.append([f, hash, str(size)])
235	n/a
236	n/a	parsed = []
237	n/a	with open(os.path.join(dist_info, 'RECORD'), 'r') as f:
238	n/a	reader = csv.reader(f, delimiter=',',
239	n/a	lineterminator=os.linesep,
240	n/a	quotechar='"')
241	n/a	parsed = list(reader)
242	n/a
243	n/a	self.maxDiff = None
244	n/a	self.checkLists(parsed, expected)
245	n/a
246	n/a
247	n/a	def test_suite():
248	n/a	return unittest.makeSuite(InstallDistinfoTestCase)
249	n/a
250	n/a
251	n/a	if __name__ == "__main__":
252	n/a	unittest.main(defaultTest="test_suite")