Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 1 | """Tests for distutils.dist.""" |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 2 | import os |
Guido van Rossum | 34d1928 | 2007-08-09 01:03:29 +0000 | [diff] [blame] | 3 | import io |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 4 | import sys |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 5 | import unittest |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 6 | import warnings |
Tarek Ziadé | df872d4 | 2009-12-06 09:28:17 +0000 | [diff] [blame] | 7 | import textwrap |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 8 | |
Georg Brandl | 521ed52 | 2013-05-12 12:36:07 +0200 | [diff] [blame] | 9 | from unittest import mock |
| 10 | |
Jason R. Coombs | 3492e39 | 2013-11-10 18:15:03 -0500 | [diff] [blame] | 11 | from distutils.dist import Distribution, fix_help_options, DistributionMetadata |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 12 | from distutils.cmd import Command |
| 13 | |
Éric Araujo | 70ec44a | 2010-11-06 02:44:43 +0000 | [diff] [blame] | 14 | from test.support import TESTFN, captured_stdout, run_unittest |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 15 | from distutils.tests import support |
Serhiy Storchaka | 8402324 | 2015-11-12 19:46:23 +0200 | [diff] [blame] | 16 | from distutils import log |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 17 | |
| 18 | |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 19 | class test_dist(Command): |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 20 | """Sample distutils extension command.""" |
| 21 | |
| 22 | user_options = [ |
| 23 | ("sample-option=", "S", "help text"), |
Georg Brandl | 521ed52 | 2013-05-12 12:36:07 +0200 | [diff] [blame] | 24 | ] |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 25 | |
| 26 | def initialize_options(self): |
| 27 | self.sample_option = None |
| 28 | |
| 29 | |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 30 | class TestDistribution(Distribution): |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 31 | """Distribution subclasses that avoids the default search for |
| 32 | configuration files. |
| 33 | |
| 34 | The ._config_files attribute must be set before |
| 35 | .parse_config_files() is called. |
| 36 | """ |
| 37 | |
| 38 | def find_config_files(self): |
| 39 | return self._config_files |
| 40 | |
| 41 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 42 | class DistributionTestCase(support.LoggingSilencer, |
Andrew Kuchling | 2a1838b | 2013-11-10 18:11:00 -0500 | [diff] [blame] | 43 | support.TempdirManager, |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 44 | support.EnvironGuard, |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 45 | unittest.TestCase): |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 46 | |
| 47 | def setUp(self): |
Tarek Ziadé | bbf1f18 | 2009-05-10 12:20:44 +0000 | [diff] [blame] | 48 | super(DistributionTestCase, self).setUp() |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 49 | self.argv = sys.argv, sys.argv[:] |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 50 | del sys.argv[1:] |
| 51 | |
| 52 | def tearDown(self): |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 53 | sys.argv = self.argv[0] |
| 54 | sys.argv[:] = self.argv[1] |
Tarek Ziadé | bbf1f18 | 2009-05-10 12:20:44 +0000 | [diff] [blame] | 55 | super(DistributionTestCase, self).tearDown() |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 56 | |
| 57 | def create_distribution(self, configfiles=()): |
| 58 | d = TestDistribution() |
| 59 | d._config_files = configfiles |
| 60 | d.parse_config_files() |
| 61 | d.parse_command_line() |
| 62 | return d |
| 63 | |
| 64 | def test_command_packages_unspecified(self): |
| 65 | sys.argv.append("build") |
| 66 | d = self.create_distribution() |
| 67 | self.assertEqual(d.get_command_packages(), ["distutils.command"]) |
| 68 | |
| 69 | def test_command_packages_cmdline(self): |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 70 | from distutils.tests.test_dist import test_dist |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 71 | sys.argv.extend(["--command-packages", |
| 72 | "foo.bar,distutils.tests", |
| 73 | "test_dist", |
| 74 | "-Ssometext", |
| 75 | ]) |
| 76 | d = self.create_distribution() |
| 77 | # let's actually try to load our test command: |
| 78 | self.assertEqual(d.get_command_packages(), |
| 79 | ["distutils.command", "foo.bar", "distutils.tests"]) |
| 80 | cmd = d.get_command_obj("test_dist") |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 81 | self.assertIsInstance(cmd, test_dist) |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 82 | self.assertEqual(cmd.sample_option, "sometext") |
| 83 | |
Georg Brandl | 521ed52 | 2013-05-12 12:36:07 +0200 | [diff] [blame] | 84 | def test_venv_install_options(self): |
| 85 | sys.argv.append("install") |
| 86 | self.addCleanup(os.unlink, TESTFN) |
| 87 | |
| 88 | fakepath = '/somedir' |
| 89 | |
| 90 | with open(TESTFN, "w") as f: |
| 91 | print(("[install]\n" |
| 92 | "install-base = {0}\n" |
| 93 | "install-platbase = {0}\n" |
| 94 | "install-lib = {0}\n" |
| 95 | "install-platlib = {0}\n" |
| 96 | "install-purelib = {0}\n" |
| 97 | "install-headers = {0}\n" |
| 98 | "install-scripts = {0}\n" |
| 99 | "install-data = {0}\n" |
| 100 | "prefix = {0}\n" |
| 101 | "exec-prefix = {0}\n" |
| 102 | "home = {0}\n" |
| 103 | "user = {0}\n" |
| 104 | "root = {0}").format(fakepath), file=f) |
| 105 | |
| 106 | # Base case: Not in a Virtual Environment |
| 107 | with mock.patch.multiple(sys, prefix='/a', base_prefix='/a') as values: |
| 108 | d = self.create_distribution([TESTFN]) |
| 109 | |
| 110 | option_tuple = (TESTFN, fakepath) |
| 111 | |
| 112 | result_dict = { |
| 113 | 'install_base': option_tuple, |
| 114 | 'install_platbase': option_tuple, |
| 115 | 'install_lib': option_tuple, |
| 116 | 'install_platlib': option_tuple, |
| 117 | 'install_purelib': option_tuple, |
| 118 | 'install_headers': option_tuple, |
| 119 | 'install_scripts': option_tuple, |
| 120 | 'install_data': option_tuple, |
| 121 | 'prefix': option_tuple, |
| 122 | 'exec_prefix': option_tuple, |
| 123 | 'home': option_tuple, |
| 124 | 'user': option_tuple, |
| 125 | 'root': option_tuple, |
| 126 | } |
| 127 | |
| 128 | self.assertEqual( |
| 129 | sorted(d.command_options.get('install').keys()), |
| 130 | sorted(result_dict.keys())) |
| 131 | |
| 132 | for (key, value) in d.command_options.get('install').items(): |
| 133 | self.assertEqual(value, result_dict[key]) |
| 134 | |
| 135 | # Test case: In a Virtual Environment |
| 136 | with mock.patch.multiple(sys, prefix='/a', base_prefix='/b') as values: |
| 137 | d = self.create_distribution([TESTFN]) |
| 138 | |
| 139 | for key in result_dict.keys(): |
| 140 | self.assertNotIn(key, d.command_options.get('install', {})) |
| 141 | |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 142 | def test_command_packages_configfile(self): |
| 143 | sys.argv.append("build") |
Éric Araujo | bee5cef | 2010-11-05 23:51:56 +0000 | [diff] [blame] | 144 | self.addCleanup(os.unlink, TESTFN) |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 145 | f = open(TESTFN, "w") |
| 146 | try: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 147 | print("[global]", file=f) |
| 148 | print("command_packages = foo.bar, splat", file=f) |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 149 | finally: |
Éric Araujo | bee5cef | 2010-11-05 23:51:56 +0000 | [diff] [blame] | 150 | f.close() |
| 151 | |
| 152 | d = self.create_distribution([TESTFN]) |
| 153 | self.assertEqual(d.get_command_packages(), |
| 154 | ["distutils.command", "foo.bar", "splat"]) |
| 155 | |
| 156 | # ensure command line overrides config: |
| 157 | sys.argv[1:] = ["--command-packages", "spork", "build"] |
| 158 | d = self.create_distribution([TESTFN]) |
| 159 | self.assertEqual(d.get_command_packages(), |
| 160 | ["distutils.command", "spork"]) |
| 161 | |
| 162 | # Setting --command-packages to '' should cause the default to |
| 163 | # be used even if a config file specified something else: |
| 164 | sys.argv[1:] = ["--command-packages", "", "build"] |
| 165 | d = self.create_distribution([TESTFN]) |
| 166 | self.assertEqual(d.get_command_packages(), ["distutils.command"]) |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 167 | |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 168 | def test_empty_options(self): |
| 169 | # an empty options dictionary should not stay in the |
| 170 | # list of attributes |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 171 | |
| 172 | # catching warnings |
| 173 | warns = [] |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 174 | |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 175 | def _warn(msg): |
| 176 | warns.append(msg) |
| 177 | |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 178 | self.addCleanup(setattr, warnings, 'warn', warnings.warn) |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 179 | warnings.warn = _warn |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 180 | dist = Distribution(attrs={'author': 'xxx', 'name': 'xxx', |
| 181 | 'version': 'xxx', 'url': 'xxxx', |
| 182 | 'options': {}}) |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 183 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 184 | self.assertEqual(len(warns), 0) |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 185 | self.assertNotIn('options', dir(dist)) |
Tarek Ziadé | 4450dcf | 2008-12-29 22:38:38 +0000 | [diff] [blame] | 186 | |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 187 | def test_finalize_options(self): |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 188 | attrs = {'keywords': 'one,two', |
| 189 | 'platforms': 'one,two'} |
| 190 | |
| 191 | dist = Distribution(attrs=attrs) |
| 192 | dist.finalize_options() |
| 193 | |
| 194 | # finalize_option splits platforms and keywords |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 195 | self.assertEqual(dist.metadata.platforms, ['one', 'two']) |
| 196 | self.assertEqual(dist.metadata.keywords, ['one', 'two']) |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 197 | |
Berker Peksag | dcaed6b | 2017-11-23 21:34:20 +0300 | [diff] [blame^] | 198 | attrs = {'keywords': 'foo bar', |
| 199 | 'platforms': 'foo bar'} |
| 200 | dist = Distribution(attrs=attrs) |
| 201 | dist.finalize_options() |
| 202 | self.assertEqual(dist.metadata.platforms, ['foo bar']) |
| 203 | self.assertEqual(dist.metadata.keywords, ['foo bar']) |
| 204 | |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 205 | def test_get_command_packages(self): |
| 206 | dist = Distribution() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 207 | self.assertEqual(dist.command_packages, None) |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 208 | cmds = dist.get_command_packages() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 209 | self.assertEqual(cmds, ['distutils.command']) |
| 210 | self.assertEqual(dist.command_packages, |
| 211 | ['distutils.command']) |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 212 | |
| 213 | dist.command_packages = 'one,two' |
| 214 | cmds = dist.get_command_packages() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 215 | self.assertEqual(cmds, ['distutils.command', 'one', 'two']) |
Tarek Ziadé | f11be75 | 2009-06-01 22:36:26 +0000 | [diff] [blame] | 216 | |
Tarek Ziadé | 31d4607 | 2009-09-21 13:55:19 +0000 | [diff] [blame] | 217 | def test_announce(self): |
| 218 | # make sure the level is known |
| 219 | dist = Distribution() |
| 220 | args = ('ok',) |
| 221 | kwargs = {'level': 'ok2'} |
| 222 | self.assertRaises(ValueError, dist.announce, args, kwargs) |
| 223 | |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 224 | |
Andrew Kuchling | 2a1838b | 2013-11-10 18:11:00 -0500 | [diff] [blame] | 225 | def test_find_config_files_disable(self): |
| 226 | # Ticket #1180: Allow user to disable their home config file. |
| 227 | temp_home = self.mkdtemp() |
| 228 | if os.name == 'posix': |
| 229 | user_filename = os.path.join(temp_home, ".pydistutils.cfg") |
| 230 | else: |
| 231 | user_filename = os.path.join(temp_home, "pydistutils.cfg") |
| 232 | |
| 233 | with open(user_filename, 'w') as f: |
| 234 | f.write('[distutils]\n') |
| 235 | |
| 236 | def _expander(path): |
| 237 | return temp_home |
| 238 | |
| 239 | old_expander = os.path.expanduser |
| 240 | os.path.expanduser = _expander |
| 241 | try: |
| 242 | d = Distribution() |
| 243 | all_files = d.find_config_files() |
| 244 | |
| 245 | d = Distribution(attrs={'script_args': ['--no-user-cfg']}) |
| 246 | files = d.find_config_files() |
| 247 | finally: |
| 248 | os.path.expanduser = old_expander |
| 249 | |
| 250 | # make sure --no-user-cfg disables the user cfg file |
Jason R. Coombs | e9f0311 | 2013-11-15 19:38:51 -0500 | [diff] [blame] | 251 | self.assertEqual(len(all_files)-1, len(files)) |
Andrew Kuchling | 2a1838b | 2013-11-10 18:11:00 -0500 | [diff] [blame] | 252 | |
Tarek Ziadé | bbf1f18 | 2009-05-10 12:20:44 +0000 | [diff] [blame] | 253 | class MetadataTestCase(support.TempdirManager, support.EnvironGuard, |
| 254 | unittest.TestCase): |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 255 | |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 256 | def setUp(self): |
| 257 | super(MetadataTestCase, self).setUp() |
| 258 | self.argv = sys.argv, sys.argv[:] |
| 259 | |
| 260 | def tearDown(self): |
| 261 | sys.argv = self.argv[0] |
| 262 | sys.argv[:] = self.argv[1] |
| 263 | super(MetadataTestCase, self).tearDown() |
| 264 | |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 265 | def format_metadata(self, dist): |
| 266 | sio = io.StringIO() |
| 267 | dist.metadata.write_pkg_file(sio) |
| 268 | return sio.getvalue() |
| 269 | |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 270 | def test_simple_metadata(self): |
| 271 | attrs = {"name": "package", |
| 272 | "version": "1.0"} |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 273 | dist = Distribution(attrs) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 274 | meta = self.format_metadata(dist) |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 275 | self.assertIn("Metadata-Version: 1.0", meta) |
| 276 | self.assertNotIn("provides:", meta.lower()) |
| 277 | self.assertNotIn("requires:", meta.lower()) |
| 278 | self.assertNotIn("obsoletes:", meta.lower()) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 279 | |
| 280 | def test_provides(self): |
| 281 | attrs = {"name": "package", |
| 282 | "version": "1.0", |
| 283 | "provides": ["package", "package.sub"]} |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 284 | dist = Distribution(attrs) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 285 | self.assertEqual(dist.metadata.get_provides(), |
| 286 | ["package", "package.sub"]) |
| 287 | self.assertEqual(dist.get_provides(), |
| 288 | ["package", "package.sub"]) |
| 289 | meta = self.format_metadata(dist) |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 290 | self.assertIn("Metadata-Version: 1.1", meta) |
| 291 | self.assertNotIn("requires:", meta.lower()) |
| 292 | self.assertNotIn("obsoletes:", meta.lower()) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 293 | |
| 294 | def test_provides_illegal(self): |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 295 | self.assertRaises(ValueError, Distribution, |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 296 | {"name": "package", |
| 297 | "version": "1.0", |
| 298 | "provides": ["my.pkg (splat)"]}) |
| 299 | |
| 300 | def test_requires(self): |
| 301 | attrs = {"name": "package", |
| 302 | "version": "1.0", |
| 303 | "requires": ["other", "another (==1.0)"]} |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 304 | dist = Distribution(attrs) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 305 | self.assertEqual(dist.metadata.get_requires(), |
| 306 | ["other", "another (==1.0)"]) |
| 307 | self.assertEqual(dist.get_requires(), |
| 308 | ["other", "another (==1.0)"]) |
| 309 | meta = self.format_metadata(dist) |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 310 | self.assertIn("Metadata-Version: 1.1", meta) |
| 311 | self.assertNotIn("provides:", meta.lower()) |
| 312 | self.assertIn("Requires: other", meta) |
| 313 | self.assertIn("Requires: another (==1.0)", meta) |
| 314 | self.assertNotIn("obsoletes:", meta.lower()) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 315 | |
| 316 | def test_requires_illegal(self): |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 317 | self.assertRaises(ValueError, Distribution, |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 318 | {"name": "package", |
| 319 | "version": "1.0", |
| 320 | "requires": ["my.pkg (splat)"]}) |
| 321 | |
| 322 | def test_obsoletes(self): |
| 323 | attrs = {"name": "package", |
| 324 | "version": "1.0", |
| 325 | "obsoletes": ["other", "another (<1.0)"]} |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 326 | dist = Distribution(attrs) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 327 | self.assertEqual(dist.metadata.get_obsoletes(), |
| 328 | ["other", "another (<1.0)"]) |
| 329 | self.assertEqual(dist.get_obsoletes(), |
| 330 | ["other", "another (<1.0)"]) |
| 331 | meta = self.format_metadata(dist) |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 332 | self.assertIn("Metadata-Version: 1.1", meta) |
| 333 | self.assertNotIn("provides:", meta.lower()) |
| 334 | self.assertNotIn("requires:", meta.lower()) |
| 335 | self.assertIn("Obsoletes: other", meta) |
| 336 | self.assertIn("Obsoletes: another (<1.0)", meta) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 337 | |
| 338 | def test_obsoletes_illegal(self): |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 339 | self.assertRaises(ValueError, Distribution, |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 340 | {"name": "package", |
| 341 | "version": "1.0", |
| 342 | "obsoletes": ["my.pkg (splat)"]}) |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 343 | |
Éric Araujo | 13e8c8e | 2011-09-10 01:51:40 +0200 | [diff] [blame] | 344 | def test_classifier(self): |
| 345 | attrs = {'name': 'Boa', 'version': '3.0', |
| 346 | 'classifiers': ['Programming Language :: Python :: 3']} |
| 347 | dist = Distribution(attrs) |
Berker Peksag | dcaed6b | 2017-11-23 21:34:20 +0300 | [diff] [blame^] | 348 | self.assertEqual(dist.get_classifiers(), |
| 349 | ['Programming Language :: Python :: 3']) |
Éric Araujo | 13e8c8e | 2011-09-10 01:51:40 +0200 | [diff] [blame] | 350 | meta = self.format_metadata(dist) |
| 351 | self.assertIn('Metadata-Version: 1.1', meta) |
| 352 | |
Berker Peksag | dcaed6b | 2017-11-23 21:34:20 +0300 | [diff] [blame^] | 353 | def test_classifier_invalid_type(self): |
| 354 | attrs = {'name': 'Boa', 'version': '3.0', |
| 355 | 'classifiers': ('Programming Language :: Python :: 3',)} |
| 356 | msg = "'classifiers' should be a 'list', not 'tuple'" |
| 357 | with self.assertRaises(TypeError, msg=msg): |
| 358 | Distribution(attrs) |
| 359 | |
| 360 | def test_keywords(self): |
| 361 | attrs = {'name': 'Monty', 'version': '1.0', |
| 362 | 'keywords': ['spam', 'eggs', 'life of brian']} |
| 363 | dist = Distribution(attrs) |
| 364 | self.assertEqual(dist.get_keywords(), |
| 365 | ['spam', 'eggs', 'life of brian']) |
| 366 | |
| 367 | def test_keywords_invalid_type(self): |
| 368 | attrs = {'name': 'Monty', 'version': '1.0', |
| 369 | 'keywords': ('spam', 'eggs', 'life of brian')} |
| 370 | msg = "'keywords' should be a 'list', not 'tuple'" |
| 371 | with self.assertRaises(TypeError, msg=msg): |
| 372 | Distribution(attrs) |
| 373 | |
| 374 | def test_platforms(self): |
| 375 | attrs = {'name': 'Monty', 'version': '1.0', |
| 376 | 'platforms': ['GNU/Linux', 'Some Evil Platform']} |
| 377 | dist = Distribution(attrs) |
| 378 | self.assertEqual(dist.get_platforms(), |
| 379 | ['GNU/Linux', 'Some Evil Platform']) |
| 380 | |
| 381 | def test_platforms_invalid_types(self): |
| 382 | attrs = {'name': 'Monty', 'version': '1.0', |
| 383 | 'platforms': ('GNU/Linux', 'Some Evil Platform')} |
| 384 | msg = "'platforms' should be a 'list', not 'tuple'" |
| 385 | with self.assertRaises(TypeError, msg=msg): |
| 386 | Distribution(attrs) |
| 387 | |
Éric Araujo | 13e8c8e | 2011-09-10 01:51:40 +0200 | [diff] [blame] | 388 | def test_download_url(self): |
| 389 | attrs = {'name': 'Boa', 'version': '3.0', |
| 390 | 'download_url': 'http://example.org/boa'} |
| 391 | dist = Distribution(attrs) |
| 392 | meta = self.format_metadata(dist) |
| 393 | self.assertIn('Metadata-Version: 1.1', meta) |
| 394 | |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 395 | def test_long_description(self): |
| 396 | long_desc = textwrap.dedent("""\ |
| 397 | example:: |
| 398 | We start here |
| 399 | and continue here |
| 400 | and end here.""") |
| 401 | attrs = {"name": "package", |
| 402 | "version": "1.0", |
| 403 | "long_description": long_desc} |
| 404 | |
| 405 | dist = Distribution(attrs) |
| 406 | meta = self.format_metadata(dist) |
| 407 | meta = meta.replace('\n' + 8 * ' ', '\n') |
| 408 | self.assertIn(long_desc, meta) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 409 | |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 410 | def test_custom_pydistutils(self): |
| 411 | # fixes #2166 |
| 412 | # make sure pydistutils.cfg is found |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 413 | if os.name == 'posix': |
| 414 | user_filename = ".pydistutils.cfg" |
| 415 | else: |
| 416 | user_filename = "pydistutils.cfg" |
| 417 | |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 418 | temp_dir = self.mkdtemp() |
| 419 | user_filename = os.path.join(temp_dir, user_filename) |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 420 | f = open(user_filename, 'w') |
Éric Araujo | bee5cef | 2010-11-05 23:51:56 +0000 | [diff] [blame] | 421 | try: |
| 422 | f.write('.') |
| 423 | finally: |
| 424 | f.close() |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 425 | |
| 426 | try: |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 427 | dist = Distribution() |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 428 | |
| 429 | # linux-style |
| 430 | if sys.platform in ('linux', 'darwin'): |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 431 | os.environ['HOME'] = temp_dir |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 432 | files = dist.find_config_files() |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 433 | self.assertIn(user_filename, files) |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 434 | |
| 435 | # win32-style |
| 436 | if sys.platform == 'win32': |
| 437 | # home drive should be found |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 438 | os.environ['HOME'] = temp_dir |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 439 | files = dist.find_config_files() |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 440 | self.assertIn(user_filename, files, |
Georg Brandl | 521ed52 | 2013-05-12 12:36:07 +0200 | [diff] [blame] | 441 | '%r not found in %r' % (user_filename, files)) |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 442 | finally: |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 443 | os.remove(user_filename) |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 444 | |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 445 | def test_fix_help_options(self): |
| 446 | help_tuples = [('a', 'b', 'c', 'd'), (1, 2, 3, 4)] |
| 447 | fancy_options = fix_help_options(help_tuples) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 448 | self.assertEqual(fancy_options[0], ('a', 'b', 'c')) |
| 449 | self.assertEqual(fancy_options[1], (1, 2, 3)) |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 450 | |
| 451 | def test_show_help(self): |
| 452 | # smoke test, just makes sure some help is displayed |
Serhiy Storchaka | 8402324 | 2015-11-12 19:46:23 +0200 | [diff] [blame] | 453 | self.addCleanup(log.set_threshold, log._global_log.threshold) |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 454 | dist = Distribution() |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 455 | sys.argv = [] |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 456 | dist.help = 1 |
| 457 | dist.script_name = 'setup.py' |
| 458 | with captured_stdout() as s: |
| 459 | dist.parse_command_line() |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 460 | |
| 461 | output = [line for line in s.getvalue().split('\n') |
| 462 | if line.strip() != ''] |
Éric Araujo | fce67fc | 2011-09-10 01:34:44 +0200 | [diff] [blame] | 463 | self.assertTrue(output) |
Tarek Ziadé | d2dd51d | 2009-05-17 10:50:24 +0000 | [diff] [blame] | 464 | |
Tarek Ziadé | df872d4 | 2009-12-06 09:28:17 +0000 | [diff] [blame] | 465 | |
Jason R. Coombs | 3492e39 | 2013-11-10 18:15:03 -0500 | [diff] [blame] | 466 | def test_read_metadata(self): |
| 467 | attrs = {"name": "package", |
| 468 | "version": "1.0", |
| 469 | "long_description": "desc", |
| 470 | "description": "xxx", |
| 471 | "download_url": "http://example.com", |
| 472 | "keywords": ['one', 'two'], |
| 473 | "requires": ['foo']} |
| 474 | |
| 475 | dist = Distribution(attrs) |
| 476 | metadata = dist.metadata |
| 477 | |
| 478 | # write it then reloads it |
| 479 | PKG_INFO = io.StringIO() |
| 480 | metadata.write_pkg_file(PKG_INFO) |
| 481 | PKG_INFO.seek(0) |
| 482 | metadata.read_pkg_file(PKG_INFO) |
| 483 | |
Jason R. Coombs | e9f0311 | 2013-11-15 19:38:51 -0500 | [diff] [blame] | 484 | self.assertEqual(metadata.name, "package") |
| 485 | self.assertEqual(metadata.version, "1.0") |
| 486 | self.assertEqual(metadata.description, "xxx") |
| 487 | self.assertEqual(metadata.download_url, 'http://example.com') |
| 488 | self.assertEqual(metadata.keywords, ['one', 'two']) |
| 489 | self.assertEqual(metadata.platforms, ['UNKNOWN']) |
| 490 | self.assertEqual(metadata.obsoletes, None) |
| 491 | self.assertEqual(metadata.requires, ['foo']) |
Jason R. Coombs | 3492e39 | 2013-11-10 18:15:03 -0500 | [diff] [blame] | 492 | |
Fred Drake | d04573f | 2004-08-03 16:37:40 +0000 | [diff] [blame] | 493 | def test_suite(): |
Fred Drake | db7b002 | 2005-03-20 22:19:47 +0000 | [diff] [blame] | 494 | suite = unittest.TestSuite() |
| 495 | suite.addTest(unittest.makeSuite(DistributionTestCase)) |
| 496 | suite.addTest(unittest.makeSuite(MetadataTestCase)) |
| 497 | return suite |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 498 | |
| 499 | if __name__ == "__main__": |
Éric Araujo | 70ec44a | 2010-11-06 02:44:43 +0000 | [diff] [blame] | 500 | run_unittest(test_suite()) |