| 1 | n/a | """Tests for packaging.command.install_data.""" |
|---|
| 2 | n/a | import os |
|---|
| 3 | n/a | import sys |
|---|
| 4 | n/a | import sysconfig |
|---|
| 5 | n/a | import packaging.database |
|---|
| 6 | n/a | from sysconfig import _get_default_scheme |
|---|
| 7 | n/a | from packaging.tests import unittest, support |
|---|
| 8 | n/a | from packaging.command.install_data import install_data |
|---|
| 9 | n/a | from packaging.command.install_dist import install_dist |
|---|
| 10 | n/a | from packaging.command.install_distinfo import install_distinfo |
|---|
| 11 | n/a | |
|---|
| 12 | n/a | |
|---|
| 13 | n/a | class InstallDataTestCase(support.TempdirManager, |
|---|
| 14 | n/a | support.LoggingCatcher, |
|---|
| 15 | n/a | unittest.TestCase): |
|---|
| 16 | n/a | |
|---|
| 17 | n/a | def setUp(self): |
|---|
| 18 | n/a | super(InstallDataTestCase, self).setUp() |
|---|
| 19 | n/a | scheme = _get_default_scheme() |
|---|
| 20 | n/a | old_items = sysconfig._SCHEMES.items(scheme) |
|---|
| 21 | n/a | |
|---|
| 22 | n/a | def restore(): |
|---|
| 23 | n/a | sysconfig._SCHEMES.remove_section(scheme) |
|---|
| 24 | n/a | sysconfig._SCHEMES.add_section(scheme) |
|---|
| 25 | n/a | for option, value in old_items: |
|---|
| 26 | n/a | sysconfig._SCHEMES.set(scheme, option, value) |
|---|
| 27 | n/a | |
|---|
| 28 | n/a | self.addCleanup(restore) |
|---|
| 29 | n/a | |
|---|
| 30 | n/a | def test_simple_run(self): |
|---|
| 31 | n/a | pkg_dir, dist = self.create_dist() |
|---|
| 32 | n/a | cmd = install_data(dist) |
|---|
| 33 | n/a | cmd.install_dir = inst = os.path.join(pkg_dir, 'inst') |
|---|
| 34 | n/a | scheme = _get_default_scheme() |
|---|
| 35 | n/a | |
|---|
| 36 | n/a | sysconfig._SCHEMES.set(scheme, 'inst', |
|---|
| 37 | n/a | os.path.join(pkg_dir, 'inst')) |
|---|
| 38 | n/a | sysconfig._SCHEMES.set(scheme, 'inst2', |
|---|
| 39 | n/a | os.path.join(pkg_dir, 'inst2')) |
|---|
| 40 | n/a | |
|---|
| 41 | n/a | one = os.path.join(pkg_dir, 'one') |
|---|
| 42 | n/a | self.write_file(one, 'xxx') |
|---|
| 43 | n/a | inst2 = os.path.join(pkg_dir, 'inst2') |
|---|
| 44 | n/a | two = os.path.join(pkg_dir, 'two') |
|---|
| 45 | n/a | self.write_file(two, 'xxx') |
|---|
| 46 | n/a | |
|---|
| 47 | n/a | # FIXME this creates a literal \{inst2\} directory! |
|---|
| 48 | n/a | cmd.data_files = {one: '{inst}/one', two: '{inst2}/two'} |
|---|
| 49 | n/a | self.assertCountEqual(cmd.get_inputs(), [one, two]) |
|---|
| 50 | n/a | |
|---|
| 51 | n/a | # let's run the command |
|---|
| 52 | n/a | cmd.ensure_finalized() |
|---|
| 53 | n/a | cmd.run() |
|---|
| 54 | n/a | |
|---|
| 55 | n/a | # let's check the result |
|---|
| 56 | n/a | self.assertEqual(len(cmd.get_outputs()), 2) |
|---|
| 57 | n/a | rtwo = os.path.split(two)[-1] |
|---|
| 58 | n/a | self.assertTrue(os.path.exists(os.path.join(inst2, rtwo))) |
|---|
| 59 | n/a | rone = os.path.split(one)[-1] |
|---|
| 60 | n/a | self.assertTrue(os.path.exists(os.path.join(inst, rone))) |
|---|
| 61 | n/a | cmd.outfiles = [] |
|---|
| 62 | n/a | |
|---|
| 63 | n/a | # let's try with warn_dir one |
|---|
| 64 | n/a | cmd.warn_dir = True |
|---|
| 65 | n/a | cmd.finalized = False |
|---|
| 66 | n/a | cmd.ensure_finalized() |
|---|
| 67 | n/a | cmd.run() |
|---|
| 68 | n/a | |
|---|
| 69 | n/a | # let's check the result |
|---|
| 70 | n/a | self.assertEqual(len(cmd.get_outputs()), 2) |
|---|
| 71 | n/a | self.assertTrue(os.path.exists(os.path.join(inst2, rtwo))) |
|---|
| 72 | n/a | self.assertTrue(os.path.exists(os.path.join(inst, rone))) |
|---|
| 73 | n/a | cmd.outfiles = [] |
|---|
| 74 | n/a | |
|---|
| 75 | n/a | # now using root and empty dir |
|---|
| 76 | n/a | cmd.root = os.path.join(pkg_dir, 'root') |
|---|
| 77 | n/a | three = os.path.join(cmd.install_dir, 'three') |
|---|
| 78 | n/a | self.write_file(three, 'xx') |
|---|
| 79 | n/a | |
|---|
| 80 | n/a | sysconfig._SCHEMES.set(scheme, 'inst3', cmd.install_dir) |
|---|
| 81 | n/a | |
|---|
| 82 | n/a | cmd.data_files = {one: '{inst}/one', two: '{inst2}/two', |
|---|
| 83 | n/a | three: '{inst3}/three'} |
|---|
| 84 | n/a | cmd.finalized = False |
|---|
| 85 | n/a | cmd.ensure_finalized() |
|---|
| 86 | n/a | cmd.run() |
|---|
| 87 | n/a | |
|---|
| 88 | n/a | # let's check the result |
|---|
| 89 | n/a | self.assertEqual(len(cmd.get_outputs()), 3) |
|---|
| 90 | n/a | self.assertTrue(os.path.exists(os.path.join(inst2, rtwo))) |
|---|
| 91 | n/a | self.assertTrue(os.path.exists(os.path.join(inst, rone))) |
|---|
| 92 | n/a | |
|---|
| 93 | n/a | def test_resources(self): |
|---|
| 94 | n/a | install_dir = self.mkdtemp() |
|---|
| 95 | n/a | scripts_dir = self.mkdtemp() |
|---|
| 96 | n/a | project_dir, dist = self.create_dist( |
|---|
| 97 | n/a | name='Spamlib', version='0.1', |
|---|
| 98 | n/a | data_files={'spamd': '{scripts}/spamd'}) |
|---|
| 99 | n/a | |
|---|
| 100 | n/a | os.chdir(project_dir) |
|---|
| 101 | n/a | self.write_file('spamd', '# Python script') |
|---|
| 102 | n/a | sysconfig._SCHEMES.set(_get_default_scheme(), 'scripts', scripts_dir) |
|---|
| 103 | n/a | sys.path.insert(0, install_dir) |
|---|
| 104 | n/a | packaging.database.disable_cache() |
|---|
| 105 | n/a | self.addCleanup(sys.path.remove, install_dir) |
|---|
| 106 | n/a | self.addCleanup(packaging.database.enable_cache) |
|---|
| 107 | n/a | |
|---|
| 108 | n/a | cmd = install_dist(dist) |
|---|
| 109 | n/a | cmd.outputs = ['spamd'] |
|---|
| 110 | n/a | cmd.install_lib = install_dir |
|---|
| 111 | n/a | dist.command_obj['install_dist'] = cmd |
|---|
| 112 | n/a | |
|---|
| 113 | n/a | cmd = install_data(dist) |
|---|
| 114 | n/a | cmd.install_dir = install_dir |
|---|
| 115 | n/a | cmd.ensure_finalized() |
|---|
| 116 | n/a | dist.command_obj['install_data'] = cmd |
|---|
| 117 | n/a | cmd.run() |
|---|
| 118 | n/a | |
|---|
| 119 | n/a | cmd = install_distinfo(dist) |
|---|
| 120 | n/a | cmd.ensure_finalized() |
|---|
| 121 | n/a | dist.command_obj['install_distinfo'] = cmd |
|---|
| 122 | n/a | cmd.run() |
|---|
| 123 | n/a | |
|---|
| 124 | n/a | # first a few sanity checks |
|---|
| 125 | n/a | self.assertEqual(os.listdir(scripts_dir), ['spamd']) |
|---|
| 126 | n/a | self.assertEqual(os.listdir(install_dir), ['Spamlib-0.1.dist-info']) |
|---|
| 127 | n/a | |
|---|
| 128 | n/a | # now the real test |
|---|
| 129 | n/a | fn = os.path.join(install_dir, 'Spamlib-0.1.dist-info', 'RESOURCES') |
|---|
| 130 | n/a | with open(fn, encoding='utf-8') as fp: |
|---|
| 131 | n/a | content = fp.read().strip() |
|---|
| 132 | n/a | |
|---|
| 133 | n/a | expected = 'spamd,%s' % os.path.join(scripts_dir, 'spamd') |
|---|
| 134 | n/a | self.assertEqual(content, expected) |
|---|
| 135 | n/a | |
|---|
| 136 | n/a | # just to be sure, we also test that get_file works here, even though |
|---|
| 137 | n/a | # packaging.database has its own test file |
|---|
| 138 | n/a | with packaging.database.get_file('Spamlib', 'spamd') as fp: |
|---|
| 139 | n/a | content = fp.read() |
|---|
| 140 | n/a | |
|---|
| 141 | n/a | self.assertEqual('# Python script', content) |
|---|
| 142 | n/a | |
|---|
| 143 | n/a | |
|---|
| 144 | n/a | def test_suite(): |
|---|
| 145 | n/a | return unittest.makeSuite(InstallDataTestCase) |
|---|
| 146 | n/a | |
|---|
| 147 | n/a | if __name__ == "__main__": |
|---|
| 148 | n/a | unittest.main(defaultTest="test_suite") |
|---|