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

#	count	content
1	n/a	"""Tests for packaging.metadata."""
2	n/a	import os
3	n/a	import sys
4	n/a	from textwrap import dedent
5	n/a	from io import StringIO
6	n/a
7	n/a	from packaging.errors import (MetadataConflictError, MetadataMissingError,
8	n/a	MetadataUnrecognizedVersionError)
9	n/a	from packaging.metadata import Metadata, PKG_INFO_PREFERRED_VERSION
10	n/a
11	n/a	from packaging.tests import unittest
12	n/a	from packaging.tests.support import (LoggingCatcher, TempdirManager,
13	n/a	EnvironRestorer)
14	n/a
15	n/a
16	n/a	class MetadataTestCase(LoggingCatcher,
17	n/a	TempdirManager,
18	n/a	EnvironRestorer,
19	n/a	unittest.TestCase):
20	n/a
21	n/a	maxDiff = None
22	n/a	restore_environ = ['HOME']
23	n/a
24	n/a	def setUp(self):
25	n/a	super(MetadataTestCase, self).setUp()
26	n/a	self.argv = sys.argv, sys.argv[:]
27	n/a
28	n/a	def tearDown(self):
29	n/a	sys.argv = self.argv[0]
30	n/a	sys.argv[:] = self.argv[1]
31	n/a	super(MetadataTestCase, self).tearDown()
32	n/a
33	n/a	#### Test various methods of the Metadata class
34	n/a
35	n/a	def test_instantiation(self):
36	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO')
37	n/a	with open(PKG_INFO, 'r', encoding='utf-8') as f:
38	n/a	contents = f.read()
39	n/a	fp = StringIO(contents)
40	n/a
41	n/a	m = Metadata()
42	n/a	self.assertRaises(MetadataUnrecognizedVersionError, m.items)
43	n/a
44	n/a	m = Metadata(PKG_INFO)
45	n/a	self.assertEqual(len(m.items()), 22)
46	n/a
47	n/a	m = Metadata(fileobj=fp)
48	n/a	self.assertEqual(len(m.items()), 22)
49	n/a
50	n/a	m = Metadata(mapping=dict(name='Test', version='1.0'))
51	n/a	self.assertEqual(len(m.items()), 11)
52	n/a
53	n/a	d = dict(m.items())
54	n/a	self.assertRaises(TypeError, Metadata,
55	n/a	PKG_INFO, fileobj=fp)
56	n/a	self.assertRaises(TypeError, Metadata,
57	n/a	PKG_INFO, mapping=d)
58	n/a	self.assertRaises(TypeError, Metadata,
59	n/a	fileobj=fp, mapping=d)
60	n/a	self.assertRaises(TypeError, Metadata,
61	n/a	PKG_INFO, mapping=m, fileobj=fp)
62	n/a
63	n/a	def test_metadata_markers(self):
64	n/a	# see if we can be platform-aware
65	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO')
66	n/a	with open(PKG_INFO, 'r', encoding='utf-8') as f:
67	n/a	content = f.read() % sys.platform
68	n/a	metadata = Metadata(platform_dependent=True)
69	n/a
70	n/a	metadata.read_file(StringIO(content))
71	n/a	self.assertEqual(metadata['Requires-Dist'], ['bar'])
72	n/a	metadata['Name'] = "baz; sys.platform == 'blah'"
73	n/a	# FIXME is None or 'UNKNOWN' correct here?
74	n/a	# where is that documented?
75	n/a	self.assertEqual(metadata['Name'], None)
76	n/a
77	n/a	# test with context
78	n/a	context = {'sys.platform': 'okook'}
79	n/a	metadata = Metadata(platform_dependent=True, execution_context=context)
80	n/a	metadata.read_file(StringIO(content))
81	n/a	self.assertEqual(metadata['Requires-Dist'], ['foo'])
82	n/a
83	n/a	def test_mapping_api(self):
84	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO')
85	n/a	with open(PKG_INFO, 'r', encoding='utf-8') as f:
86	n/a	content = f.read() % sys.platform
87	n/a	metadata = Metadata(fileobj=StringIO(content))
88	n/a	self.assertIn('Version', metadata.keys())
89	n/a	self.assertIn('0.5', metadata.values())
90	n/a	self.assertIn(('Version', '0.5'), metadata.items())
91	n/a
92	n/a	metadata.update({'version': '0.6'})
93	n/a	self.assertEqual(metadata['Version'], '0.6')
94	n/a	metadata.update([('version', '0.7')])
95	n/a	self.assertEqual(metadata['Version'], '0.7')
96	n/a
97	n/a	# make sure update method checks values like the set method does
98	n/a	metadata.update({'version': '1--2'})
99	n/a	self.assertEqual(len(self.get_logs()), 1)
100	n/a
101	n/a	# XXX caveat: the keys method and friends are not 3.x-style views
102	n/a	# should be changed or documented
103	n/a	self.assertEqual(list(metadata), metadata.keys())
104	n/a
105	n/a	def test_read_metadata(self):
106	n/a	fields = {'name': 'project',
107	n/a	'version': '1.0',
108	n/a	'description': 'desc',
109	n/a	'summary': 'xxx',
110	n/a	'download_url': 'http://example.com',
111	n/a	'keywords': ['one', 'two'],
112	n/a	'requires_dist': ['foo']}
113	n/a
114	n/a	metadata = Metadata(mapping=fields)
115	n/a	PKG_INFO = StringIO()
116	n/a	metadata.write_file(PKG_INFO)
117	n/a	PKG_INFO.seek(0)
118	n/a
119	n/a	metadata = Metadata(fileobj=PKG_INFO)
120	n/a
121	n/a	self.assertEqual(metadata['name'], 'project')
122	n/a	self.assertEqual(metadata['version'], '1.0')
123	n/a	self.assertEqual(metadata['summary'], 'xxx')
124	n/a	self.assertEqual(metadata['download_url'], 'http://example.com')
125	n/a	self.assertEqual(metadata['keywords'], ['one', 'two'])
126	n/a	self.assertEqual(metadata['platform'], [])
127	n/a	self.assertEqual(metadata['obsoletes'], [])
128	n/a	self.assertEqual(metadata['requires-dist'], ['foo'])
129	n/a
130	n/a	def test_write_metadata(self):
131	n/a	# check support of non-ASCII values
132	n/a	tmp_dir = self.mkdtemp()
133	n/a	my_file = os.path.join(tmp_dir, 'f')
134	n/a
135	n/a	metadata = Metadata(mapping={'author': 'Mister CafÃ©',
136	n/a	'name': 'my.project',
137	n/a	'author': 'CafÃ© Junior',
138	n/a	'summary': 'CafÃ© torrÃ©fiÃ©',
139	n/a	'description': 'HÃ©hÃ©hÃ©',
140	n/a	'keywords': ['cafÃ©', 'coffee']})
141	n/a	metadata.write(my_file)
142	n/a
143	n/a	# the file should use UTF-8
144	n/a	metadata2 = Metadata()
145	n/a	with open(my_file, encoding='utf-8') as fp:
146	n/a	metadata2.read_file(fp)
147	n/a
148	n/a	# XXX when keywords are not defined, metadata will have
149	n/a	# 'Keywords': [] but metadata2 will have 'Keywords': ['']
150	n/a	# because of a value.split(',') in Metadata.get
151	n/a	self.assertEqual(metadata.items(), metadata2.items())
152	n/a
153	n/a	# ASCII also works, it's a subset of UTF-8
154	n/a	metadata = Metadata(mapping={'author': 'Mister Cafe',
155	n/a	'name': 'my.project',
156	n/a	'author': 'Cafe Junior',
157	n/a	'summary': 'Cafe torrefie',
158	n/a	'description': 'Hehehe'})
159	n/a	metadata.write(my_file)
160	n/a
161	n/a	metadata2 = Metadata()
162	n/a	with open(my_file, encoding='utf-8') as fp:
163	n/a	metadata2.read_file(fp)
164	n/a
165	n/a	def test_metadata_read_write(self):
166	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO')
167	n/a	metadata = Metadata(PKG_INFO)
168	n/a	out = StringIO()
169	n/a	metadata.write_file(out)
170	n/a
171	n/a	out.seek(0)
172	n/a	res = Metadata()
173	n/a	res.read_file(out)
174	n/a	self.assertEqual(metadata.values(), res.values())
175	n/a
176	n/a	#### Test checks
177	n/a
178	n/a	def test_check_version(self):
179	n/a	metadata = Metadata()
180	n/a	metadata['Name'] = 'vimpdb'
181	n/a	metadata['Home-page'] = 'http://pypi.python.org'
182	n/a	metadata['Author'] = 'Monty Python'
183	n/a	metadata.docutils_support = False
184	n/a	missing, warnings = metadata.check()
185	n/a	self.assertEqual(missing, ['Version'])
186	n/a
187	n/a	def test_check_version_strict(self):
188	n/a	metadata = Metadata()
189	n/a	metadata['Name'] = 'vimpdb'
190	n/a	metadata['Home-page'] = 'http://pypi.python.org'
191	n/a	metadata['Author'] = 'Monty Python'
192	n/a	metadata.docutils_support = False
193	n/a	self.assertRaises(MetadataMissingError, metadata.check, strict=True)
194	n/a
195	n/a	def test_check_name(self):
196	n/a	metadata = Metadata()
197	n/a	metadata['Version'] = '1.0'
198	n/a	metadata['Home-page'] = 'http://pypi.python.org'
199	n/a	metadata['Author'] = 'Monty Python'
200	n/a	metadata.docutils_support = False
201	n/a	missing, warnings = metadata.check()
202	n/a	self.assertEqual(missing, ['Name'])
203	n/a
204	n/a	def test_check_name_strict(self):
205	n/a	metadata = Metadata()
206	n/a	metadata['Version'] = '1.0'
207	n/a	metadata['Home-page'] = 'http://pypi.python.org'
208	n/a	metadata['Author'] = 'Monty Python'
209	n/a	metadata.docutils_support = False
210	n/a	self.assertRaises(MetadataMissingError, metadata.check, strict=True)
211	n/a
212	n/a	def test_check_author(self):
213	n/a	metadata = Metadata()
214	n/a	metadata['Version'] = '1.0'
215	n/a	metadata['Name'] = 'vimpdb'
216	n/a	metadata['Home-page'] = 'http://pypi.python.org'
217	n/a	metadata.docutils_support = False
218	n/a	missing, warnings = metadata.check()
219	n/a	self.assertEqual(missing, ['Author'])
220	n/a
221	n/a	def test_check_homepage(self):
222	n/a	metadata = Metadata()
223	n/a	metadata['Version'] = '1.0'
224	n/a	metadata['Name'] = 'vimpdb'
225	n/a	metadata['Author'] = 'Monty Python'
226	n/a	metadata.docutils_support = False
227	n/a	missing, warnings = metadata.check()
228	n/a	self.assertEqual(missing, ['Home-page'])
229	n/a
230	n/a	def test_check_predicates(self):
231	n/a	metadata = Metadata()
232	n/a	metadata['Version'] = 'rr'
233	n/a	metadata['Name'] = 'vimpdb'
234	n/a	metadata['Home-page'] = 'http://pypi.python.org'
235	n/a	metadata['Author'] = 'Monty Python'
236	n/a	metadata['Requires-dist'] = ['Foo (a)']
237	n/a	metadata['Obsoletes-dist'] = ['Foo (a)']
238	n/a	metadata['Provides-dist'] = ['Foo (a)']
239	n/a	missing, warnings = metadata.check()
240	n/a	self.assertEqual(len(warnings), 4)
241	n/a
242	n/a	#### Test fields and metadata versions
243	n/a
244	n/a	def test_metadata_versions(self):
245	n/a	metadata = Metadata(mapping={'name': 'project', 'version': '1.0'})
246	n/a	self.assertEqual(metadata['Metadata-Version'],
247	n/a	PKG_INFO_PREFERRED_VERSION)
248	n/a	self.assertNotIn('Provides', metadata)
249	n/a	self.assertNotIn('Requires', metadata)
250	n/a	self.assertNotIn('Obsoletes', metadata)
251	n/a
252	n/a	metadata['Classifier'] = ['ok']
253	n/a	self.assertEqual(metadata['Metadata-Version'], '1.1')
254	n/a
255	n/a	metadata = Metadata()
256	n/a	metadata['Download-URL'] = 'ok'
257	n/a	self.assertEqual(metadata['Metadata-Version'], '1.1')
258	n/a
259	n/a	metadata = Metadata()
260	n/a	metadata['Obsoletes'] = 'ok'
261	n/a	self.assertEqual(metadata['Metadata-Version'], '1.1')
262	n/a
263	n/a	del metadata['Obsoletes']
264	n/a	metadata['Obsoletes-Dist'] = 'ok'
265	n/a	self.assertEqual(metadata['Metadata-Version'], '1.2')
266	n/a
267	n/a	self.assertRaises(MetadataConflictError, metadata.set,
268	n/a	'Obsoletes', 'ok')
269	n/a
270	n/a	del metadata['Obsoletes']
271	n/a	del metadata['Obsoletes-Dist']
272	n/a	metadata['Version'] = '1'
273	n/a	self.assertEqual(metadata['Metadata-Version'], '1.0')
274	n/a
275	n/a	# make sure the _best_version function works okay with
276	n/a	# non-conflicting fields from 1.1 and 1.2 (i.e. we want only the
277	n/a	# requires/requires-dist and co. pairs to cause a conflict, not all
278	n/a	# fields in _314_MARKERS)
279	n/a	metadata = Metadata()
280	n/a	metadata['Requires-Python'] = '3'
281	n/a	metadata['Classifier'] = ['Programming language :: Python :: 3']
282	n/a	self.assertEqual(metadata['Metadata-Version'], '1.2')
283	n/a
284	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__),
285	n/a	'SETUPTOOLS-PKG-INFO')
286	n/a	metadata = Metadata(PKG_INFO)
287	n/a	self.assertEqual(metadata['Metadata-Version'], '1.0')
288	n/a
289	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__),
290	n/a	'SETUPTOOLS-PKG-INFO2')
291	n/a	metadata = Metadata(PKG_INFO)
292	n/a	self.assertEqual(metadata['Metadata-Version'], '1.1')
293	n/a
294	n/a	# Update the _fields dict directly to prevent 'Metadata-Version'
295	n/a	# from being updated by the _set_best_version() method.
296	n/a	metadata._fields['Metadata-Version'] = '1.618'
297	n/a	self.assertRaises(MetadataUnrecognizedVersionError, metadata.keys)
298	n/a
299	n/a	def test_version(self):
300	n/a	Metadata(mapping={'author': 'xxx',
301	n/a	'name': 'xxx',
302	n/a	'version': 'xxx',
303	n/a	'home_page': 'xxxx'})
304	n/a	logs = self.get_logs()
305	n/a	self.assertEqual(1, len(logs))
306	n/a	self.assertIn('not a valid version', logs[0])
307	n/a
308	n/a	def test_description(self):
309	n/a	PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO')
310	n/a	with open(PKG_INFO, 'r', encoding='utf-8') as f:
311	n/a	content = f.read() % sys.platform
312	n/a	metadata = Metadata()
313	n/a	metadata.read_file(StringIO(content))
314	n/a
315	n/a	# see if we can read the description now
316	n/a	DESC = os.path.join(os.path.dirname(__file__), 'LONG_DESC.txt')
317	n/a	with open(DESC) as f:
318	n/a	wanted = f.read()
319	n/a	self.assertEqual(wanted, metadata['Description'])
320	n/a
321	n/a	# save the file somewhere and make sure we can read it back
322	n/a	out = StringIO()
323	n/a	metadata.write_file(out)
324	n/a	out.seek(0)
325	n/a
326	n/a	out.seek(0)
327	n/a	metadata = Metadata()
328	n/a	metadata.read_file(out)
329	n/a	self.assertEqual(wanted, metadata['Description'])
330	n/a
331	n/a	def test_description_folding(self):
332	n/a	# make sure the indentation is preserved
333	n/a	out = StringIO()
334	n/a	desc = dedent("""\
335	n/a	example::
336	n/a	We start here
337	n/a	and continue here
338	n/a	and end here.
339	n/a	""")
340	n/a
341	n/a	metadata = Metadata()
342	n/a	metadata['description'] = desc
343	n/a	metadata.write_file(out)
344	n/a
345	n/a	folded_desc = desc.replace('\n', '\n' + (7 * ' ') + '\|')
346	n/a	self.assertIn(folded_desc, out.getvalue())
347	n/a
348	n/a	def test_project_url(self):
349	n/a	metadata = Metadata()
350	n/a	metadata['Project-URL'] = [('one', 'http://ok')]
351	n/a	self.assertEqual(metadata['Project-URL'], [('one', 'http://ok')])
352	n/a	self.assertEqual(metadata['Metadata-Version'], '1.2')
353	n/a
354	n/a	# make sure this particular field is handled properly when written
355	n/a	fp = StringIO()
356	n/a	metadata.write_file(fp)
357	n/a	self.assertIn('Project-URL: one,http://ok', fp.getvalue().split('\n'))
358	n/a
359	n/a	fp.seek(0)
360	n/a	metadata = Metadata()
361	n/a	metadata.read_file(fp)
362	n/a	self.assertEqual(metadata['Project-Url'], [('one', 'http://ok')])
363	n/a
364	n/a	# TODO copy tests for v1.1 requires, obsoletes and provides from distutils
365	n/a	# (they're useless but we support them so we should test them anyway)
366	n/a
367	n/a	def test_provides_dist(self):
368	n/a	fields = {'name': 'project',
369	n/a	'version': '1.0',
370	n/a	'provides_dist': ['project', 'my.project']}
371	n/a	metadata = Metadata(mapping=fields)
372	n/a	self.assertEqual(metadata['Provides-Dist'],
373	n/a	['project', 'my.project'])
374	n/a	self.assertEqual(metadata['Metadata-Version'], '1.2', metadata)
375	n/a	self.assertNotIn('Requires', metadata)
376	n/a	self.assertNotIn('Obsoletes', metadata)
377	n/a
378	n/a	@unittest.skip('needs to be implemented')
379	n/a	def test_provides_illegal(self):
380	n/a	# TODO check the versions (like distutils does for old provides field)
381	n/a	self.assertRaises(ValueError, Metadata,
382	n/a	mapping={'name': 'project',
383	n/a	'version': '1.0',
384	n/a	'provides_dist': ['my.pkg (splat)']})
385	n/a
386	n/a	def test_requires_dist(self):
387	n/a	fields = {'name': 'project',
388	n/a	'version': '1.0',
389	n/a	'requires_dist': ['other', 'another (==1.0)']}
390	n/a	metadata = Metadata(mapping=fields)
391	n/a	self.assertEqual(metadata['Requires-Dist'],
392	n/a	['other', 'another (==1.0)'])
393	n/a	self.assertEqual(metadata['Metadata-Version'], '1.2')
394	n/a	self.assertNotIn('Provides', metadata)
395	n/a	self.assertEqual(metadata['Requires-Dist'],
396	n/a	['other', 'another (==1.0)'])
397	n/a	self.assertNotIn('Obsoletes', metadata)
398	n/a
399	n/a	# make sure write_file uses one RFC 822 header per item
400	n/a	fp = StringIO()
401	n/a	metadata.write_file(fp)
402	n/a	lines = fp.getvalue().split('\n')
403	n/a	self.assertIn('Requires-Dist: other', lines)
404	n/a	self.assertIn('Requires-Dist: another (==1.0)', lines)
405	n/a
406	n/a	# test warnings for invalid version predicates
407	n/a	# XXX this would cause no warnings if we used update (or the mapping
408	n/a	# argument of the constructor), see comment in Metadata.update
409	n/a	metadata = Metadata()
410	n/a	metadata['Requires-Dist'] = 'Funky (Groovie)'
411	n/a	metadata['Requires-Python'] = '1-4'
412	n/a	self.assertEqual(len(self.get_logs()), 2)
413	n/a
414	n/a	# test multiple version predicates
415	n/a	metadata = Metadata()
416	n/a
417	n/a	# XXX check PEP and see if 3 == 3.0
418	n/a	metadata['Requires-Python'] = '>=2.6, <3.0'
419	n/a	metadata['Requires-Dist'] = ['Foo (>=2.6, <3.0)']
420	n/a	self.assertEqual(self.get_logs(), [])
421	n/a
422	n/a	@unittest.skip('needs to be implemented')
423	n/a	def test_requires_illegal(self):
424	n/a	self.assertRaises(ValueError, Metadata,
425	n/a	mapping={'name': 'project',
426	n/a	'version': '1.0',
427	n/a	'requires': ['my.pkg (splat)']})
428	n/a
429	n/a	def test_obsoletes_dist(self):
430	n/a	fields = {'name': 'project',
431	n/a	'version': '1.0',
432	n/a	'obsoletes_dist': ['other', 'another (<1.0)']}
433	n/a	metadata = Metadata(mapping=fields)
434	n/a	self.assertEqual(metadata['Obsoletes-Dist'],
435	n/a	['other', 'another (<1.0)'])
436	n/a	self.assertEqual(metadata['Metadata-Version'], '1.2')
437	n/a	self.assertNotIn('Provides', metadata)
438	n/a	self.assertNotIn('Requires', metadata)
439	n/a	self.assertEqual(metadata['Obsoletes-Dist'],
440	n/a	['other', 'another (<1.0)'])
441	n/a
442	n/a	@unittest.skip('needs to be implemented')
443	n/a	def test_obsoletes_illegal(self):
444	n/a	self.assertRaises(ValueError, Metadata,
445	n/a	mapping={'name': 'project',
446	n/a	'version': '1.0',
447	n/a	'obsoletes': ['my.pkg (splat)']})
448	n/a
449	n/a
450	n/a	def test_suite():
451	n/a	return unittest.makeSuite(MetadataTestCase)
452	n/a
453	n/a	if __name__ == '__main__':
454	n/a	unittest.main(defaultTest='test_suite')