diff options
Diffstat (limited to 'Lib/packaging/tests/test_metadata.py')
| -rw-r--r-- | Lib/packaging/tests/test_metadata.py | 454 |
1 files changed, 0 insertions, 454 deletions
diff --git a/Lib/packaging/tests/test_metadata.py b/Lib/packaging/tests/test_metadata.py deleted file mode 100644 index 54a7af3..0000000 --- a/Lib/packaging/tests/test_metadata.py +++ /dev/null @@ -1,454 +0,0 @@ -"""Tests for packaging.metadata.""" -import os -import sys -from textwrap import dedent -from io import StringIO - -from packaging.errors import (MetadataConflictError, MetadataMissingError, - MetadataUnrecognizedVersionError) -from packaging.metadata import Metadata, PKG_INFO_PREFERRED_VERSION - -from packaging.tests import unittest -from packaging.tests.support import (LoggingCatcher, TempdirManager, - EnvironRestorer) - - -class MetadataTestCase(LoggingCatcher, - TempdirManager, - EnvironRestorer, - unittest.TestCase): - - maxDiff = None - restore_environ = ['HOME'] - - def setUp(self): - super(MetadataTestCase, self).setUp() - self.argv = sys.argv, sys.argv[:] - - def tearDown(self): - sys.argv = self.argv[0] - sys.argv[:] = self.argv[1] - super(MetadataTestCase, self).tearDown() - - #### Test various methods of the Metadata class - - def test_instantiation(self): - PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO') - with open(PKG_INFO, 'r', encoding='utf-8') as f: - contents = f.read() - fp = StringIO(contents) - - m = Metadata() - self.assertRaises(MetadataUnrecognizedVersionError, m.items) - - m = Metadata(PKG_INFO) - self.assertEqual(len(m.items()), 22) - - m = Metadata(fileobj=fp) - self.assertEqual(len(m.items()), 22) - - m = Metadata(mapping=dict(name='Test', version='1.0')) - self.assertEqual(len(m.items()), 11) - - d = dict(m.items()) - self.assertRaises(TypeError, Metadata, - PKG_INFO, fileobj=fp) - self.assertRaises(TypeError, Metadata, - PKG_INFO, mapping=d) - self.assertRaises(TypeError, Metadata, - fileobj=fp, mapping=d) - self.assertRaises(TypeError, Metadata, - PKG_INFO, mapping=m, fileobj=fp) - - def test_metadata_markers(self): - # see if we can be platform-aware - PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO') - with open(PKG_INFO, 'r', encoding='utf-8') as f: - content = f.read() % sys.platform - metadata = Metadata(platform_dependent=True) - - metadata.read_file(StringIO(content)) - self.assertEqual(metadata['Requires-Dist'], ['bar']) - metadata['Name'] = "baz; sys.platform == 'blah'" - # FIXME is None or 'UNKNOWN' correct here? - # where is that documented? - self.assertEqual(metadata['Name'], None) - - # test with context - context = {'sys.platform': 'okook'} - metadata = Metadata(platform_dependent=True, execution_context=context) - metadata.read_file(StringIO(content)) - self.assertEqual(metadata['Requires-Dist'], ['foo']) - - def test_mapping_api(self): - PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO') - with open(PKG_INFO, 'r', encoding='utf-8') as f: - content = f.read() % sys.platform - metadata = Metadata(fileobj=StringIO(content)) - self.assertIn('Version', metadata.keys()) - self.assertIn('0.5', metadata.values()) - self.assertIn(('Version', '0.5'), metadata.items()) - - metadata.update({'version': '0.6'}) - self.assertEqual(metadata['Version'], '0.6') - metadata.update([('version', '0.7')]) - self.assertEqual(metadata['Version'], '0.7') - - # make sure update method checks values like the set method does - metadata.update({'version': '1--2'}) - self.assertEqual(len(self.get_logs()), 1) - - # XXX caveat: the keys method and friends are not 3.x-style views - # should be changed or documented - self.assertEqual(list(metadata), metadata.keys()) - - def test_read_metadata(self): - fields = {'name': 'project', - 'version': '1.0', - 'description': 'desc', - 'summary': 'xxx', - 'download_url': 'http://example.com', - 'keywords': ['one', 'two'], - 'requires_dist': ['foo']} - - metadata = Metadata(mapping=fields) - PKG_INFO = StringIO() - metadata.write_file(PKG_INFO) - PKG_INFO.seek(0) - - metadata = Metadata(fileobj=PKG_INFO) - - self.assertEqual(metadata['name'], 'project') - self.assertEqual(metadata['version'], '1.0') - self.assertEqual(metadata['summary'], 'xxx') - self.assertEqual(metadata['download_url'], 'http://example.com') - self.assertEqual(metadata['keywords'], ['one', 'two']) - self.assertEqual(metadata['platform'], []) - self.assertEqual(metadata['obsoletes'], []) - self.assertEqual(metadata['requires-dist'], ['foo']) - - def test_write_metadata(self): - # check support of non-ASCII values - tmp_dir = self.mkdtemp() - my_file = os.path.join(tmp_dir, 'f') - - metadata = Metadata(mapping={'author': 'Mister Café', - 'name': 'my.project', - 'author': 'Café Junior', - 'summary': 'Café torréfié', - 'description': 'Héhéhé', - 'keywords': ['café', 'coffee']}) - metadata.write(my_file) - - # the file should use UTF-8 - metadata2 = Metadata() - with open(my_file, encoding='utf-8') as fp: - metadata2.read_file(fp) - - # XXX when keywords are not defined, metadata will have - # 'Keywords': [] but metadata2 will have 'Keywords': [''] - # because of a value.split(',') in Metadata.get - self.assertEqual(metadata.items(), metadata2.items()) - - # ASCII also works, it's a subset of UTF-8 - metadata = Metadata(mapping={'author': 'Mister Cafe', - 'name': 'my.project', - 'author': 'Cafe Junior', - 'summary': 'Cafe torrefie', - 'description': 'Hehehe'}) - metadata.write(my_file) - - metadata2 = Metadata() - with open(my_file, encoding='utf-8') as fp: - metadata2.read_file(fp) - - def test_metadata_read_write(self): - PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO') - metadata = Metadata(PKG_INFO) - out = StringIO() - metadata.write_file(out) - - out.seek(0) - res = Metadata() - res.read_file(out) - self.assertEqual(metadata.values(), res.values()) - - #### Test checks - - def test_check_version(self): - metadata = Metadata() - metadata['Name'] = 'vimpdb' - metadata['Home-page'] = 'http://pypi.python.org' - metadata['Author'] = 'Monty Python' - metadata.docutils_support = False - missing, warnings = metadata.check() - self.assertEqual(missing, ['Version']) - - def test_check_version_strict(self): - metadata = Metadata() - metadata['Name'] = 'vimpdb' - metadata['Home-page'] = 'http://pypi.python.org' - metadata['Author'] = 'Monty Python' - metadata.docutils_support = False - self.assertRaises(MetadataMissingError, metadata.check, strict=True) - - def test_check_name(self): - metadata = Metadata() - metadata['Version'] = '1.0' - metadata['Home-page'] = 'http://pypi.python.org' - metadata['Author'] = 'Monty Python' - metadata.docutils_support = False - missing, warnings = metadata.check() - self.assertEqual(missing, ['Name']) - - def test_check_name_strict(self): - metadata = Metadata() - metadata['Version'] = '1.0' - metadata['Home-page'] = 'http://pypi.python.org' - metadata['Author'] = 'Monty Python' - metadata.docutils_support = False - self.assertRaises(MetadataMissingError, metadata.check, strict=True) - - def test_check_author(self): - metadata = Metadata() - metadata['Version'] = '1.0' - metadata['Name'] = 'vimpdb' - metadata['Home-page'] = 'http://pypi.python.org' - metadata.docutils_support = False - missing, warnings = metadata.check() - self.assertEqual(missing, ['Author']) - - def test_check_homepage(self): - metadata = Metadata() - metadata['Version'] = '1.0' - metadata['Name'] = 'vimpdb' - metadata['Author'] = 'Monty Python' - metadata.docutils_support = False - missing, warnings = metadata.check() - self.assertEqual(missing, ['Home-page']) - - def test_check_predicates(self): - metadata = Metadata() - metadata['Version'] = 'rr' - metadata['Name'] = 'vimpdb' - metadata['Home-page'] = 'http://pypi.python.org' - metadata['Author'] = 'Monty Python' - metadata['Requires-dist'] = ['Foo (a)'] - metadata['Obsoletes-dist'] = ['Foo (a)'] - metadata['Provides-dist'] = ['Foo (a)'] - missing, warnings = metadata.check() - self.assertEqual(len(warnings), 4) - - #### Test fields and metadata versions - - def test_metadata_versions(self): - metadata = Metadata(mapping={'name': 'project', 'version': '1.0'}) - self.assertEqual(metadata['Metadata-Version'], - PKG_INFO_PREFERRED_VERSION) - self.assertNotIn('Provides', metadata) - self.assertNotIn('Requires', metadata) - self.assertNotIn('Obsoletes', metadata) - - metadata['Classifier'] = ['ok'] - self.assertEqual(metadata['Metadata-Version'], '1.1') - - metadata = Metadata() - metadata['Download-URL'] = 'ok' - self.assertEqual(metadata['Metadata-Version'], '1.1') - - metadata = Metadata() - metadata['Obsoletes'] = 'ok' - self.assertEqual(metadata['Metadata-Version'], '1.1') - - del metadata['Obsoletes'] - metadata['Obsoletes-Dist'] = 'ok' - self.assertEqual(metadata['Metadata-Version'], '1.2') - - self.assertRaises(MetadataConflictError, metadata.set, - 'Obsoletes', 'ok') - - del metadata['Obsoletes'] - del metadata['Obsoletes-Dist'] - metadata['Version'] = '1' - self.assertEqual(metadata['Metadata-Version'], '1.0') - - # make sure the _best_version function works okay with - # non-conflicting fields from 1.1 and 1.2 (i.e. we want only the - # requires/requires-dist and co. pairs to cause a conflict, not all - # fields in _314_MARKERS) - metadata = Metadata() - metadata['Requires-Python'] = '3' - metadata['Classifier'] = ['Programming language :: Python :: 3'] - self.assertEqual(metadata['Metadata-Version'], '1.2') - - PKG_INFO = os.path.join(os.path.dirname(__file__), - 'SETUPTOOLS-PKG-INFO') - metadata = Metadata(PKG_INFO) - self.assertEqual(metadata['Metadata-Version'], '1.0') - - PKG_INFO = os.path.join(os.path.dirname(__file__), - 'SETUPTOOLS-PKG-INFO2') - metadata = Metadata(PKG_INFO) - self.assertEqual(metadata['Metadata-Version'], '1.1') - - # Update the _fields dict directly to prevent 'Metadata-Version' - # from being updated by the _set_best_version() method. - metadata._fields['Metadata-Version'] = '1.618' - self.assertRaises(MetadataUnrecognizedVersionError, metadata.keys) - - def test_version(self): - Metadata(mapping={'author': 'xxx', - 'name': 'xxx', - 'version': 'xxx', - 'home_page': 'xxxx'}) - logs = self.get_logs() - self.assertEqual(1, len(logs)) - self.assertIn('not a valid version', logs[0]) - - def test_description(self): - PKG_INFO = os.path.join(os.path.dirname(__file__), 'PKG-INFO') - with open(PKG_INFO, 'r', encoding='utf-8') as f: - content = f.read() % sys.platform - metadata = Metadata() - metadata.read_file(StringIO(content)) - - # see if we can read the description now - DESC = os.path.join(os.path.dirname(__file__), 'LONG_DESC.txt') - with open(DESC) as f: - wanted = f.read() - self.assertEqual(wanted, metadata['Description']) - - # save the file somewhere and make sure we can read it back - out = StringIO() - metadata.write_file(out) - out.seek(0) - - out.seek(0) - metadata = Metadata() - metadata.read_file(out) - self.assertEqual(wanted, metadata['Description']) - - def test_description_folding(self): - # make sure the indentation is preserved - out = StringIO() - desc = dedent("""\ - example:: - We start here - and continue here - and end here. - """) - - metadata = Metadata() - metadata['description'] = desc - metadata.write_file(out) - - folded_desc = desc.replace('\n', '\n' + (7 * ' ') + '|') - self.assertIn(folded_desc, out.getvalue()) - - def test_project_url(self): - metadata = Metadata() - metadata['Project-URL'] = [('one', 'http://ok')] - self.assertEqual(metadata['Project-URL'], [('one', 'http://ok')]) - self.assertEqual(metadata['Metadata-Version'], '1.2') - - # make sure this particular field is handled properly when written - fp = StringIO() - metadata.write_file(fp) - self.assertIn('Project-URL: one,http://ok', fp.getvalue().split('\n')) - - fp.seek(0) - metadata = Metadata() - metadata.read_file(fp) - self.assertEqual(metadata['Project-Url'], [('one', 'http://ok')]) - - # TODO copy tests for v1.1 requires, obsoletes and provides from distutils - # (they're useless but we support them so we should test them anyway) - - def test_provides_dist(self): - fields = {'name': 'project', - 'version': '1.0', - 'provides_dist': ['project', 'my.project']} - metadata = Metadata(mapping=fields) - self.assertEqual(metadata['Provides-Dist'], - ['project', 'my.project']) - self.assertEqual(metadata['Metadata-Version'], '1.2', metadata) - self.assertNotIn('Requires', metadata) - self.assertNotIn('Obsoletes', metadata) - - @unittest.skip('needs to be implemented') - def test_provides_illegal(self): - # TODO check the versions (like distutils does for old provides field) - self.assertRaises(ValueError, Metadata, - mapping={'name': 'project', - 'version': '1.0', - 'provides_dist': ['my.pkg (splat)']}) - - def test_requires_dist(self): - fields = {'name': 'project', - 'version': '1.0', - 'requires_dist': ['other', 'another (==1.0)']} - metadata = Metadata(mapping=fields) - self.assertEqual(metadata['Requires-Dist'], - ['other', 'another (==1.0)']) - self.assertEqual(metadata['Metadata-Version'], '1.2') - self.assertNotIn('Provides', metadata) - self.assertEqual(metadata['Requires-Dist'], - ['other', 'another (==1.0)']) - self.assertNotIn('Obsoletes', metadata) - - # make sure write_file uses one RFC 822 header per item - fp = StringIO() - metadata.write_file(fp) - lines = fp.getvalue().split('\n') - self.assertIn('Requires-Dist: other', lines) - self.assertIn('Requires-Dist: another (==1.0)', lines) - - # test warnings for invalid version predicates - # XXX this would cause no warnings if we used update (or the mapping - # argument of the constructor), see comment in Metadata.update - metadata = Metadata() - metadata['Requires-Dist'] = 'Funky (Groovie)' - metadata['Requires-Python'] = '1-4' - self.assertEqual(len(self.get_logs()), 2) - - # test multiple version predicates - metadata = Metadata() - - # XXX check PEP and see if 3 == 3.0 - metadata['Requires-Python'] = '>=2.6, <3.0' - metadata['Requires-Dist'] = ['Foo (>=2.6, <3.0)'] - self.assertEqual(self.get_logs(), []) - - @unittest.skip('needs to be implemented') - def test_requires_illegal(self): - self.assertRaises(ValueError, Metadata, - mapping={'name': 'project', - 'version': '1.0', - 'requires': ['my.pkg (splat)']}) - - def test_obsoletes_dist(self): - fields = {'name': 'project', - 'version': '1.0', - 'obsoletes_dist': ['other', 'another (<1.0)']} - metadata = Metadata(mapping=fields) - self.assertEqual(metadata['Obsoletes-Dist'], - ['other', 'another (<1.0)']) - self.assertEqual(metadata['Metadata-Version'], '1.2') - self.assertNotIn('Provides', metadata) - self.assertNotIn('Requires', metadata) - self.assertEqual(metadata['Obsoletes-Dist'], - ['other', 'another (<1.0)']) - - @unittest.skip('needs to be implemented') - def test_obsoletes_illegal(self): - self.assertRaises(ValueError, Metadata, - mapping={'name': 'project', - 'version': '1.0', - 'obsoletes': ['my.pkg (splat)']}) - - -def test_suite(): - return unittest.makeSuite(MetadataTestCase) - -if __name__ == '__main__': - unittest.main(defaultTest='test_suite') |