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

#	count	content
1	n/a	"""Tests for packaging.command.install."""
2	n/a
3	n/a	import os
4	n/a	import imp
5	n/a	import sys
6	n/a	from sysconfig import (get_scheme_names, get_config_vars,
7	n/a	_SCHEMES, get_config_var, get_path)
8	n/a
9	n/a	from packaging.command.build_ext import build_ext
10	n/a	from packaging.command.install_dist import install_dist
11	n/a	from packaging.compiler.extension import Extension
12	n/a	from packaging.dist import Distribution
13	n/a	from packaging.errors import PackagingOptionError
14	n/a
15	n/a	from packaging.tests import unittest, support
16	n/a
17	n/a
18	n/a	_CONFIG_VARS = get_config_vars()
19	n/a
20	n/a
21	n/a	def _make_ext_name(modname):
22	n/a	if os.name == 'nt' and sys.executable.endswith('_d.exe'):
23	n/a	modname += '_d'
24	n/a	return modname + get_config_var('SO')
25	n/a
26	n/a
27	n/a	class InstallTestCase(support.TempdirManager,
28	n/a	support.LoggingCatcher,
29	n/a	unittest.TestCase):
30	n/a
31	n/a	def test_home_installation_scheme(self):
32	n/a	# This ensure two things:
33	n/a	# - that --home generates the desired set of directory names
34	n/a	# - test --home is supported on all platforms
35	n/a	builddir = self.mkdtemp()
36	n/a	destination = os.path.join(builddir, "installation")
37	n/a
38	n/a	dist = Distribution({"name": "foopkg"})
39	n/a	dist.command_obj["build"] = support.DummyCommand(
40	n/a	build_base=builddir,
41	n/a	build_lib=os.path.join(builddir, "lib"),
42	n/a	)
43	n/a
44	n/a	old_posix_prefix = _SCHEMES.get('posix_prefix', 'platinclude')
45	n/a	old_posix_home = _SCHEMES.get('posix_home', 'platinclude')
46	n/a
47	n/a	new_path = '{platbase}/include/python{py_version_short}'
48	n/a	_SCHEMES.set('posix_prefix', 'platinclude', new_path)
49	n/a	_SCHEMES.set('posix_home', 'platinclude', '{platbase}/include/python')
50	n/a
51	n/a	try:
52	n/a	cmd = install_dist(dist)
53	n/a	cmd.home = destination
54	n/a	cmd.ensure_finalized()
55	n/a	finally:
56	n/a	_SCHEMES.set('posix_prefix', 'platinclude', old_posix_prefix)
57	n/a	_SCHEMES.set('posix_home', 'platinclude', old_posix_home)
58	n/a
59	n/a	self.assertEqual(cmd.install_base, destination)
60	n/a	self.assertEqual(cmd.install_platbase, destination)
61	n/a
62	n/a	def check_path(got, expected):
63	n/a	got = os.path.normpath(got)
64	n/a	expected = os.path.normpath(expected)
65	n/a	self.assertEqual(got, expected)
66	n/a
67	n/a	libdir = os.path.join(destination, "lib", "python")
68	n/a	check_path(cmd.install_lib, libdir)
69	n/a	check_path(cmd.install_platlib, libdir)
70	n/a	check_path(cmd.install_purelib, libdir)
71	n/a	check_path(cmd.install_headers,
72	n/a	os.path.join(destination, "include", "python", "foopkg"))
73	n/a	check_path(cmd.install_scripts, os.path.join(destination, "bin"))
74	n/a	check_path(cmd.install_data, destination)
75	n/a
76	n/a	def test_user_site(self):
77	n/a	# test install with --user
78	n/a	# preparing the environment for the test
79	n/a	self.old_user_base = get_config_var('userbase')
80	n/a	self.old_user_site = get_path('purelib', '%s_user' % os.name)
81	n/a	self.tmpdir = self.mkdtemp()
82	n/a	self.user_base = os.path.join(self.tmpdir, 'B')
83	n/a	self.user_site = os.path.join(self.tmpdir, 'S')
84	n/a	_CONFIG_VARS['userbase'] = self.user_base
85	n/a	scheme = '%s_user' % os.name
86	n/a	_SCHEMES.set(scheme, 'purelib', self.user_site)
87	n/a
88	n/a	def _expanduser(path):
89	n/a	if path[0] == '~':
90	n/a	path = os.path.normpath(self.tmpdir) + path[1:]
91	n/a	return path
92	n/a
93	n/a	self.old_expand = os.path.expanduser
94	n/a	os.path.expanduser = _expanduser
95	n/a
96	n/a	def cleanup():
97	n/a	_CONFIG_VARS['userbase'] = self.old_user_base
98	n/a	_SCHEMES.set(scheme, 'purelib', self.old_user_site)
99	n/a	os.path.expanduser = self.old_expand
100	n/a
101	n/a	self.addCleanup(cleanup)
102	n/a
103	n/a	schemes = get_scheme_names()
104	n/a	for key in ('nt_user', 'posix_user', 'os2_home'):
105	n/a	self.assertIn(key, schemes)
106	n/a
107	n/a	dist = Distribution({'name': 'xx'})
108	n/a	cmd = install_dist(dist)
109	n/a
110	n/a	# making sure the user option is there
111	n/a	options = [name for name, short, lable in
112	n/a	cmd.user_options]
113	n/a	self.assertIn('user', options)
114	n/a
115	n/a	# setting a value
116	n/a	cmd.user = True
117	n/a
118	n/a	# user base and site shouldn't be created yet
119	n/a	self.assertFalse(os.path.exists(self.user_base))
120	n/a	self.assertFalse(os.path.exists(self.user_site))
121	n/a
122	n/a	# let's run finalize
123	n/a	cmd.ensure_finalized()
124	n/a
125	n/a	# now they should
126	n/a	self.assertTrue(os.path.exists(self.user_base))
127	n/a	self.assertTrue(os.path.exists(self.user_site))
128	n/a
129	n/a	self.assertIn('userbase', cmd.config_vars)
130	n/a	self.assertIn('usersite', cmd.config_vars)
131	n/a
132	n/a	def test_handle_extra_path(self):
133	n/a	dist = Distribution({'name': 'xx', 'extra_path': 'path,dirs'})
134	n/a	cmd = install_dist(dist)
135	n/a
136	n/a	# two elements
137	n/a	cmd.handle_extra_path()
138	n/a	self.assertEqual(cmd.extra_path, ['path', 'dirs'])
139	n/a	self.assertEqual(cmd.extra_dirs, 'dirs')
140	n/a	self.assertEqual(cmd.path_file, 'path')
141	n/a
142	n/a	# one element
143	n/a	cmd.extra_path = ['path']
144	n/a	cmd.handle_extra_path()
145	n/a	self.assertEqual(cmd.extra_path, ['path'])
146	n/a	self.assertEqual(cmd.extra_dirs, 'path')
147	n/a	self.assertEqual(cmd.path_file, 'path')
148	n/a
149	n/a	# none
150	n/a	dist.extra_path = cmd.extra_path = None
151	n/a	cmd.handle_extra_path()
152	n/a	self.assertEqual(cmd.extra_path, None)
153	n/a	self.assertEqual(cmd.extra_dirs, '')
154	n/a	self.assertEqual(cmd.path_file, None)
155	n/a
156	n/a	# three elements (no way !)
157	n/a	cmd.extra_path = 'path,dirs,again'
158	n/a	self.assertRaises(PackagingOptionError, cmd.handle_extra_path)
159	n/a
160	n/a	def test_finalize_options(self):
161	n/a	dist = Distribution({'name': 'xx'})
162	n/a	cmd = install_dist(dist)
163	n/a
164	n/a	# must supply either prefix/exec-prefix/home or
165	n/a	# install-base/install-platbase -- not both
166	n/a	cmd.prefix = 'prefix'
167	n/a	cmd.install_base = 'base'
168	n/a	self.assertRaises(PackagingOptionError, cmd.finalize_options)
169	n/a
170	n/a	# must supply either home or prefix/exec-prefix -- not both
171	n/a	cmd.install_base = None
172	n/a	cmd.home = 'home'
173	n/a	self.assertRaises(PackagingOptionError, cmd.finalize_options)
174	n/a
175	n/a	# can't combine user with with prefix/exec_prefix/home or
176	n/a	# install_(plat)base
177	n/a	cmd.prefix = None
178	n/a	cmd.user = 'user'
179	n/a	self.assertRaises(PackagingOptionError, cmd.finalize_options)
180	n/a
181	n/a	def test_old_record(self):
182	n/a	# test pre-PEP 376 --record option (outside dist-info dir)
183	n/a	install_dir = self.mkdtemp()
184	n/a	project_dir, dist = self.create_dist(py_modules=['hello'],
185	n/a	scripts=['sayhi'])
186	n/a	os.chdir(project_dir)
187	n/a	self.write_file('hello.py', "def main(): print('o hai')")
188	n/a	self.write_file('sayhi', 'from hello import main; main()')
189	n/a
190	n/a	cmd = install_dist(dist)
191	n/a	dist.command_obj['install_dist'] = cmd
192	n/a	cmd.root = install_dir
193	n/a	cmd.record = os.path.join(project_dir, 'filelist')
194	n/a	cmd.ensure_finalized()
195	n/a	cmd.run()
196	n/a
197	n/a	with open(cmd.record) as f:
198	n/a	content = f.read()
199	n/a
200	n/a	found = [os.path.basename(line) for line in content.splitlines()]
201	n/a	expected = ['hello.py', 'hello.%s.pyc' % imp.get_tag(), 'sayhi',
202	n/a	'METADATA', 'INSTALLER', 'REQUESTED', 'RECORD']
203	n/a	self.assertEqual(sorted(found), sorted(expected))
204	n/a
205	n/a	# XXX test that fancy_getopt is okay with options named
206	n/a	# record and no-record but unrelated
207	n/a
208	n/a	def test_old_record_extensions(self):
209	n/a	# test pre-PEP 376 --record option with ext modules
210	n/a	install_dir = self.mkdtemp()
211	n/a	project_dir, dist = self.create_dist(ext_modules=[
212	n/a	Extension('xx', ['xxmodule.c'])])
213	n/a	os.chdir(project_dir)
214	n/a	support.copy_xxmodule_c(project_dir)
215	n/a
216	n/a	buildextcmd = build_ext(dist)
217	n/a	support.fixup_build_ext(buildextcmd)
218	n/a	buildextcmd.ensure_finalized()
219	n/a
220	n/a	cmd = install_dist(dist)
221	n/a	dist.command_obj['install_dist'] = cmd
222	n/a	dist.command_obj['build_ext'] = buildextcmd
223	n/a	cmd.root = install_dir
224	n/a	cmd.record = os.path.join(project_dir, 'filelist')
225	n/a	cmd.ensure_finalized()
226	n/a	cmd.run()
227	n/a
228	n/a	with open(cmd.record) as f:
229	n/a	content = f.read()
230	n/a
231	n/a	found = [os.path.basename(line) for line in content.splitlines()]
232	n/a	expected = [_make_ext_name('xx'),
233	n/a	'METADATA', 'INSTALLER', 'REQUESTED', 'RECORD']
234	n/a	self.assertEqual(found, expected)
235	n/a
236	n/a
237	n/a	def test_suite():
238	n/a	return unittest.makeSuite(InstallTestCase)
239	n/a
240	n/a	if __name__ == "__main__":
241	n/a	unittest.main(defaultTest="test_suite")