| 1 | n/a | """Tests for the packaging.uninstall module.""" |
|---|
| 2 | n/a | import os |
|---|
| 3 | n/a | import logging |
|---|
| 4 | n/a | import packaging.util |
|---|
| 5 | n/a | |
|---|
| 6 | n/a | from packaging.errors import PackagingError |
|---|
| 7 | n/a | from packaging.install import remove |
|---|
| 8 | n/a | from packaging.database import disable_cache, enable_cache |
|---|
| 9 | n/a | |
|---|
| 10 | n/a | from packaging.tests import unittest, support |
|---|
| 11 | n/a | |
|---|
| 12 | n/a | SETUP_CFG = """ |
|---|
| 13 | n/a | [metadata] |
|---|
| 14 | n/a | name = %(name)s |
|---|
| 15 | n/a | version = %(version)s |
|---|
| 16 | n/a | |
|---|
| 17 | n/a | [files] |
|---|
| 18 | n/a | packages = |
|---|
| 19 | n/a | %(pkg)s |
|---|
| 20 | n/a | %(pkg)s.sub |
|---|
| 21 | n/a | """ |
|---|
| 22 | n/a | |
|---|
| 23 | n/a | |
|---|
| 24 | n/a | class UninstallTestCase(support.TempdirManager, |
|---|
| 25 | n/a | support.LoggingCatcher, |
|---|
| 26 | n/a | support.EnvironRestorer, |
|---|
| 27 | n/a | unittest.TestCase): |
|---|
| 28 | n/a | |
|---|
| 29 | n/a | restore_environ = ['PLAT'] |
|---|
| 30 | n/a | |
|---|
| 31 | n/a | def setUp(self): |
|---|
| 32 | n/a | super(UninstallTestCase, self).setUp() |
|---|
| 33 | n/a | self.addCleanup(enable_cache) |
|---|
| 34 | n/a | self.addCleanup(packaging.util._path_created.clear) |
|---|
| 35 | n/a | disable_cache() |
|---|
| 36 | n/a | |
|---|
| 37 | n/a | def get_path(self, dist, name): |
|---|
| 38 | n/a | # the dist argument must contain an install_dist command correctly |
|---|
| 39 | n/a | # initialized with a prefix option and finalized befored this method |
|---|
| 40 | n/a | # can be called successfully; practically, this means that you should |
|---|
| 41 | n/a | # call self.install_dist before self.get_path |
|---|
| 42 | n/a | cmd = dist.get_command_obj('install_dist') |
|---|
| 43 | n/a | return getattr(cmd, 'install_' + name) |
|---|
| 44 | n/a | |
|---|
| 45 | n/a | def make_dist(self, name='Foo', **kw): |
|---|
| 46 | n/a | kw['name'] = name |
|---|
| 47 | n/a | pkg = name.lower() |
|---|
| 48 | n/a | if 'version' not in kw: |
|---|
| 49 | n/a | kw['version'] = '0.1' |
|---|
| 50 | n/a | project_dir, dist = self.create_dist(**kw) |
|---|
| 51 | n/a | kw['pkg'] = pkg |
|---|
| 52 | n/a | |
|---|
| 53 | n/a | pkg_dir = os.path.join(project_dir, pkg) |
|---|
| 54 | n/a | os.makedirs(os.path.join(pkg_dir, 'sub')) |
|---|
| 55 | n/a | |
|---|
| 56 | n/a | self.write_file((project_dir, 'setup.cfg'), SETUP_CFG % kw) |
|---|
| 57 | n/a | self.write_file((pkg_dir, '__init__.py'), '#') |
|---|
| 58 | n/a | self.write_file((pkg_dir, pkg + '_utils.py'), '#') |
|---|
| 59 | n/a | self.write_file((pkg_dir, 'sub', '__init__.py'), '#') |
|---|
| 60 | n/a | self.write_file((pkg_dir, 'sub', pkg + '_utils.py'), '#') |
|---|
| 61 | n/a | |
|---|
| 62 | n/a | return project_dir |
|---|
| 63 | n/a | |
|---|
| 64 | n/a | def install_dist(self, name='Foo', dirname=None, **kw): |
|---|
| 65 | n/a | if not dirname: |
|---|
| 66 | n/a | dirname = self.make_dist(name, **kw) |
|---|
| 67 | n/a | os.chdir(dirname) |
|---|
| 68 | n/a | |
|---|
| 69 | n/a | dist = support.TestDistribution() |
|---|
| 70 | n/a | # for some unfathomable reason, the tests will fail horribly if the |
|---|
| 71 | n/a | # parse_config_files method is not called, even if it doesn't do |
|---|
| 72 | n/a | # anything useful; trying to build and use a command object manually |
|---|
| 73 | n/a | # also fails |
|---|
| 74 | n/a | dist.parse_config_files() |
|---|
| 75 | n/a | dist.finalize_options() |
|---|
| 76 | n/a | dist.run_command('install_dist', |
|---|
| 77 | n/a | {'prefix': ('command line', self.mkdtemp())}) |
|---|
| 78 | n/a | |
|---|
| 79 | n/a | site_packages = self.get_path(dist, 'purelib') |
|---|
| 80 | n/a | return dist, site_packages |
|---|
| 81 | n/a | |
|---|
| 82 | n/a | def test_uninstall_unknown_distribution(self): |
|---|
| 83 | n/a | dist, site_packages = self.install_dist('Foospam') |
|---|
| 84 | n/a | self.assertRaises(PackagingError, remove, 'Foo', |
|---|
| 85 | n/a | paths=[site_packages]) |
|---|
| 86 | n/a | |
|---|
| 87 | n/a | def test_uninstall(self): |
|---|
| 88 | n/a | dist, site_packages = self.install_dist() |
|---|
| 89 | n/a | self.assertIsFile(site_packages, 'foo', '__init__.py') |
|---|
| 90 | n/a | self.assertIsFile(site_packages, 'foo', 'sub', '__init__.py') |
|---|
| 91 | n/a | self.assertIsFile(site_packages, 'Foo-0.1.dist-info', 'RECORD') |
|---|
| 92 | n/a | self.assertTrue(remove('Foo', paths=[site_packages])) |
|---|
| 93 | n/a | self.assertIsNotFile(site_packages, 'foo', 'sub', '__init__.py') |
|---|
| 94 | n/a | self.assertIsNotFile(site_packages, 'Foo-0.1.dist-info', 'RECORD') |
|---|
| 95 | n/a | |
|---|
| 96 | n/a | def test_uninstall_error_handling(self): |
|---|
| 97 | n/a | # makes sure if there are OSErrors (like permission denied) |
|---|
| 98 | n/a | # remove() stops and displays a clean error |
|---|
| 99 | n/a | dist, site_packages = self.install_dist('Meh') |
|---|
| 100 | n/a | |
|---|
| 101 | n/a | # breaking os.rename |
|---|
| 102 | n/a | old = os.rename |
|---|
| 103 | n/a | |
|---|
| 104 | n/a | def _rename(source, target): |
|---|
| 105 | n/a | raise OSError(42, 'impossible operation') |
|---|
| 106 | n/a | |
|---|
| 107 | n/a | os.rename = _rename |
|---|
| 108 | n/a | try: |
|---|
| 109 | n/a | self.assertFalse(remove('Meh', paths=[site_packages])) |
|---|
| 110 | n/a | finally: |
|---|
| 111 | n/a | os.rename = old |
|---|
| 112 | n/a | |
|---|
| 113 | n/a | logs = [log for log in self.get_logs(logging.INFO) |
|---|
| 114 | n/a | if log.startswith('Error:')] |
|---|
| 115 | n/a | self.assertEqual(logs, ['Error: [Errno 42] impossible operation']) |
|---|
| 116 | n/a | |
|---|
| 117 | n/a | self.assertTrue(remove('Meh', paths=[site_packages])) |
|---|
| 118 | n/a | |
|---|
| 119 | n/a | |
|---|
| 120 | n/a | def test_suite(): |
|---|
| 121 | n/a | return unittest.makeSuite(UninstallTestCase) |
|---|
| 122 | n/a | |
|---|
| 123 | n/a | if __name__ == '__main__': |
|---|
| 124 | n/a | unittest.main(defaultTest='test_suite') |
|---|