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

#	count	content
1	n/a	"""Tests for packaging.dist."""
2	n/a	import os
3	n/a	import sys
4	n/a	import textwrap
5	n/a
6	n/a	import packaging.dist
7	n/a
8	n/a	from packaging.dist import Distribution
9	n/a	from packaging.command.cmd import Command
10	n/a	from packaging.errors import PackagingModuleError, PackagingOptionError
11	n/a	from packaging.tests import support, unittest
12	n/a	from packaging.tests.support import create_distribution, use_command
13	n/a	from test.support import unload
14	n/a
15	n/a
16	n/a	class test_dist(Command):
17	n/a	"""Custom command used for testing."""
18	n/a
19	n/a	user_options = [
20	n/a	('sample-option=', 'S',
21	n/a	"help text"),
22	n/a	]
23	n/a
24	n/a	def initialize_options(self):
25	n/a	self.sample_option = None
26	n/a	self._record = []
27	n/a
28	n/a	def finalize_options(self):
29	n/a	if self.sample_option is None:
30	n/a	self.sample_option = 'default value'
31	n/a
32	n/a	def run(self):
33	n/a	self._record.append('test_dist has run')
34	n/a
35	n/a
36	n/a	class DistributionTestCase(support.TempdirManager,
37	n/a	support.LoggingCatcher,
38	n/a	support.EnvironRestorer,
39	n/a	unittest.TestCase):
40	n/a
41	n/a	restore_environ = ['HOME', 'PLAT']
42	n/a
43	n/a	def setUp(self):
44	n/a	super(DistributionTestCase, self).setUp()
45	n/a	# XXX this is ugly, we should fix the functions to accept args
46	n/a	# (defaulting to sys.argv)
47	n/a	self.argv = sys.argv, sys.argv[:]
48	n/a	del sys.argv[1:]
49	n/a
50	n/a	def tearDown(self):
51	n/a	sys.argv = self.argv[0]
52	n/a	sys.argv[:] = self.argv[1]
53	n/a	super(DistributionTestCase, self).tearDown()
54	n/a
55	n/a	@unittest.skip('needs to be updated')
56	n/a	def test_debug_mode(self):
57	n/a	tmpdir = self.mkdtemp()
58	n/a	setupcfg = os.path.join(tmpdir, 'setup.cfg')
59	n/a	with open(setupcfg, "w") as f:
60	n/a	f.write("[global]\n")
61	n/a	f.write("command_packages = foo.bar, splat")
62	n/a
63	n/a	files = [setupcfg]
64	n/a	sys.argv.append("build")
65	n/a	__, stdout = captured_stdout(create_distribution, files)
66	n/a	self.assertEqual(stdout, '')
67	n/a	# XXX debug mode does not exist anymore, test logging levels in this
68	n/a	# test instead
69	n/a	packaging.dist.DEBUG = True
70	n/a	try:
71	n/a	__, stdout = captured_stdout(create_distribution, files)
72	n/a	self.assertEqual(stdout, '')
73	n/a	finally:
74	n/a	packaging.dist.DEBUG = False
75	n/a
76	n/a	def test_bad_attr(self):
77	n/a	Distribution(attrs={'author': 'xxx',
78	n/a	'name': 'xxx',
79	n/a	'version': '1.2',
80	n/a	'home_page': 'xxxx',
81	n/a	'badoptname': 'xxx'})
82	n/a	logs = self.get_logs()
83	n/a	self.assertEqual(len(logs), 1)
84	n/a	self.assertIn('unknown argument', logs[0])
85	n/a
86	n/a	def test_empty_options(self):
87	n/a	# an empty options dictionary should not stay in the
88	n/a	# list of attributes
89	n/a	dist = Distribution(attrs={'author': 'xxx', 'name': 'xxx',
90	n/a	'version': '1.2', 'home_page': 'xxxx',
91	n/a	'options': {}})
92	n/a
93	n/a	self.assertEqual(self.get_logs(), [])
94	n/a	self.assertNotIn('options', dir(dist))
95	n/a
96	n/a	def test_non_empty_options(self):
97	n/a	# TODO: how to actually use options is not documented except
98	n/a	# for a few cryptic comments in dist.py. If this is to stay
99	n/a	# in the public API, it deserves some better documentation.
100	n/a
101	n/a	# Here is an example of how it's used out there:
102	n/a	# http://svn.pythonmac.org/py2app/py2app/trunk/doc/
103	n/a	# index.html#specifying-customizations
104	n/a	dist = Distribution(attrs={'author': 'xxx',
105	n/a	'name': 'xxx',
106	n/a	'version': 'xxx',
107	n/a	'home_page': 'xxxx',
108	n/a	'options': {'sdist': {'owner': 'root'}}})
109	n/a
110	n/a	self.assertIn('owner', dist.get_option_dict('sdist'))
111	n/a
112	n/a	def test_finalize_options(self):
113	n/a	attrs = {'keywords': 'one,two',
114	n/a	'platform': 'one,two'}
115	n/a
116	n/a	dist = Distribution(attrs=attrs)
117	n/a	dist.finalize_options()
118	n/a
119	n/a	# finalize_option splits platforms and keywords
120	n/a	self.assertEqual(dist.metadata['platform'], ['one', 'two'])
121	n/a	self.assertEqual(dist.metadata['keywords'], ['one', 'two'])
122	n/a
123	n/a	def test_custom_pydistutils(self):
124	n/a	# Bug #2166: make sure pydistutils.cfg is found
125	n/a	if os.name == 'posix':
126	n/a	user_filename = ".pydistutils.cfg"
127	n/a	else:
128	n/a	user_filename = "pydistutils.cfg"
129	n/a
130	n/a	temp_dir = self.mkdtemp()
131	n/a	user_filename = os.path.join(temp_dir, user_filename)
132	n/a	with open(user_filename, 'w') as f:
133	n/a	f.write('.')
134	n/a
135	n/a	dist = Distribution()
136	n/a
137	n/a	os.environ['HOME'] = temp_dir
138	n/a	files = dist.find_config_files()
139	n/a	self.assertIn(user_filename, files)
140	n/a
141	n/a	def test_find_config_files_disable(self):
142	n/a	# Bug #1180: Allow users to disable their own config file.
143	n/a	temp_home = self.mkdtemp()
144	n/a	if os.name == 'posix':
145	n/a	user_filename = os.path.join(temp_home, ".pydistutils.cfg")
146	n/a	else:
147	n/a	user_filename = os.path.join(temp_home, "pydistutils.cfg")
148	n/a
149	n/a	with open(user_filename, 'w') as f:
150	n/a	f.write('[distutils2]\n')
151	n/a
152	n/a	def _expander(path):
153	n/a	return temp_home
154	n/a
155	n/a	old_expander = os.path.expanduser
156	n/a	os.path.expanduser = _expander
157	n/a	try:
158	n/a	d = packaging.dist.Distribution()
159	n/a	all_files = d.find_config_files()
160	n/a
161	n/a	d = packaging.dist.Distribution(attrs={'script_args':
162	n/a	['--no-user-cfg']})
163	n/a	files = d.find_config_files()
164	n/a	finally:
165	n/a	os.path.expanduser = old_expander
166	n/a
167	n/a	# make sure --no-user-cfg disables the user cfg file
168	n/a	self.assertEqual((len(all_files) - 1), len(files))
169	n/a
170	n/a	def test_special_hooks_parsing(self):
171	n/a	temp_home = self.mkdtemp()
172	n/a	config_files = [os.path.join(temp_home, "config1.cfg"),
173	n/a	os.path.join(temp_home, "config2.cfg")]
174	n/a
175	n/a	# Store two aliased hooks in config files
176	n/a	self.write_file((temp_home, "config1.cfg"),
177	n/a	'[test_dist]\npre-hook.a = type')
178	n/a	self.write_file((temp_home, "config2.cfg"),
179	n/a	'[test_dist]\npre-hook.b = type')
180	n/a
181	n/a	use_command(self, 'packaging.tests.test_dist.test_dist')
182	n/a
183	n/a	dist = create_distribution(config_files)
184	n/a	cmd = dist.get_command_obj("test_dist")
185	n/a	self.assertEqual(cmd.pre_hook, {"a": 'type', "b": 'type'})
186	n/a
187	n/a	def test_hooks_get_run(self):
188	n/a	temp_home = self.mkdtemp()
189	n/a	module_name = os.path.split(temp_home)[-1]
190	n/a	pyname = '%s.py' % module_name
191	n/a	config_file = os.path.join(temp_home, "config1.cfg")
192	n/a	hooks_module = os.path.join(temp_home, pyname)
193	n/a
194	n/a	self.write_file(config_file, textwrap.dedent('''\
195	n/a	[test_dist]
196	n/a	pre-hook.test = %(modname)s.log_pre_call
197	n/a	post-hook.test = %(modname)s.log_post_call'''
198	n/a	% {'modname': module_name}))
199	n/a
200	n/a	self.write_file(hooks_module, textwrap.dedent('''\
201	n/a	record = []
202	n/a
203	n/a	def log_pre_call(cmd):
204	n/a	record.append('pre-%s' % cmd.get_command_name())
205	n/a
206	n/a	def log_post_call(cmd):
207	n/a	record.append('post-%s' % cmd.get_command_name())
208	n/a	'''))
209	n/a
210	n/a	use_command(self, 'packaging.tests.test_dist.test_dist')
211	n/a	d = create_distribution([config_file])
212	n/a	cmd = d.get_command_obj("test_dist")
213	n/a
214	n/a	# prepare the call recorders
215	n/a	sys.path.append(temp_home)
216	n/a	self.addCleanup(sys.path.remove, temp_home)
217	n/a	self.addCleanup(unload, module_name)
218	n/a	record = __import__(module_name).record
219	n/a
220	n/a	cmd.run = lambda: record.append('run')
221	n/a	cmd.finalize_options = lambda: record.append('finalize')
222	n/a	d.run_command('test_dist')
223	n/a
224	n/a	self.assertEqual(record, ['finalize',
225	n/a	'pre-test_dist',
226	n/a	'run',
227	n/a	'post-test_dist'])
228	n/a
229	n/a	def test_hooks_importable(self):
230	n/a	temp_home = self.mkdtemp()
231	n/a	config_file = os.path.join(temp_home, "config1.cfg")
232	n/a
233	n/a	self.write_file(config_file, textwrap.dedent('''\
234	n/a	[test_dist]
235	n/a	pre-hook.test = nonexistent.dotted.name'''))
236	n/a
237	n/a	use_command(self, 'packaging.tests.test_dist.test_dist')
238	n/a	d = create_distribution([config_file])
239	n/a	cmd = d.get_command_obj("test_dist")
240	n/a	cmd.ensure_finalized()
241	n/a
242	n/a	self.assertRaises(PackagingModuleError, d.run_command, 'test_dist')
243	n/a
244	n/a	def test_hooks_callable(self):
245	n/a	temp_home = self.mkdtemp()
246	n/a	config_file = os.path.join(temp_home, "config1.cfg")
247	n/a
248	n/a	self.write_file(config_file, textwrap.dedent('''\
249	n/a	[test_dist]
250	n/a	pre-hook.test = packaging.tests.test_dist.__doc__'''))
251	n/a
252	n/a	use_command(self, 'packaging.tests.test_dist.test_dist')
253	n/a	d = create_distribution([config_file])
254	n/a	cmd = d.get_command_obj("test_dist")
255	n/a	cmd.ensure_finalized()
256	n/a
257	n/a	self.assertRaises(PackagingOptionError, d.run_command, 'test_dist')
258	n/a
259	n/a
260	n/a	def test_suite():
261	n/a	return unittest.makeSuite(DistributionTestCase)
262	n/a
263	n/a	if __name__ == "__main__":
264	n/a	unittest.main(defaultTest="test_suite")