test_util.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. """Tests for distutils.util."""
  2. import os
  3. import sys
  4. import unittest
  5. from copy import copy
  6. from test.support import run_unittest
  7. from unittest import mock
  8. from distutils.errors import DistutilsPlatformError, DistutilsByteCompileError
  9. from distutils.util import (get_platform, convert_path, change_root,
  10. check_environ, split_quoted, strtobool,
  11. rfc822_escape, byte_compile,
  12. grok_environment_error)
  13. from distutils import util # used to patch _environ_checked
  14. from distutils.sysconfig import get_config_vars
  15. from distutils import sysconfig
  16. from distutils.tests import support
  17. import _osx_support
  18. class UtilTestCase(support.EnvironGuard, unittest.TestCase):
  19. def setUp(self):
  20. super(UtilTestCase, self).setUp()
  21. # saving the environment
  22. self.name = os.name
  23. self.platform = sys.platform
  24. self.version = sys.version
  25. self.sep = os.sep
  26. self.join = os.path.join
  27. self.isabs = os.path.isabs
  28. self.splitdrive = os.path.splitdrive
  29. self._config_vars = copy(sysconfig._config_vars)
  30. # patching os.uname
  31. if hasattr(os, 'uname'):
  32. self.uname = os.uname
  33. self._uname = os.uname()
  34. else:
  35. self.uname = None
  36. self._uname = None
  37. os.uname = self._get_uname
  38. def tearDown(self):
  39. # getting back the environment
  40. os.name = self.name
  41. sys.platform = self.platform
  42. sys.version = self.version
  43. os.sep = self.sep
  44. os.path.join = self.join
  45. os.path.isabs = self.isabs
  46. os.path.splitdrive = self.splitdrive
  47. if self.uname is not None:
  48. os.uname = self.uname
  49. else:
  50. del os.uname
  51. sysconfig._config_vars.clear()
  52. sysconfig._config_vars.update(self._config_vars)
  53. super(UtilTestCase, self).tearDown()
  54. def _set_uname(self, uname):
  55. self._uname = uname
  56. def _get_uname(self):
  57. return self._uname
  58. def test_get_platform(self):
  59. # windows XP, 32bits
  60. os.name = 'nt'
  61. sys.version = ('2.4.4 (#71, Oct 18 2006, 08:34:43) '
  62. '[MSC v.1310 32 bit (Intel)]')
  63. sys.platform = 'win32'
  64. self.assertEqual(get_platform(), 'win32')
  65. # windows XP, amd64
  66. os.name = 'nt'
  67. sys.version = ('2.4.4 (#71, Oct 18 2006, 08:34:43) '
  68. '[MSC v.1310 32 bit (Amd64)]')
  69. sys.platform = 'win32'
  70. self.assertEqual(get_platform(), 'win-amd64')
  71. # macbook
  72. os.name = 'posix'
  73. sys.version = ('2.5 (r25:51918, Sep 19 2006, 08:49:13) '
  74. '\n[GCC 4.0.1 (Apple Computer, Inc. build 5341)]')
  75. sys.platform = 'darwin'
  76. self._set_uname(('Darwin', 'macziade', '8.11.1',
  77. ('Darwin Kernel Version 8.11.1: '
  78. 'Wed Oct 10 18:23:28 PDT 2007; '
  79. 'root:xnu-792.25.20~1/RELEASE_I386'), 'i386'))
  80. _osx_support._remove_original_values(get_config_vars())
  81. get_config_vars()['MACOSX_DEPLOYMENT_TARGET'] = '10.3'
  82. get_config_vars()['CFLAGS'] = ('-fno-strict-aliasing -DNDEBUG -g '
  83. '-fwrapv -O3 -Wall -Wstrict-prototypes')
  84. cursize = sys.maxsize
  85. sys.maxsize = (2 ** 31)-1
  86. try:
  87. self.assertEqual(get_platform(), 'macosx-10.3-i386')
  88. finally:
  89. sys.maxsize = cursize
  90. # macbook with fat binaries (fat, universal or fat64)
  91. _osx_support._remove_original_values(get_config_vars())
  92. get_config_vars()['MACOSX_DEPLOYMENT_TARGET'] = '10.4'
  93. get_config_vars()['CFLAGS'] = ('-arch ppc -arch i386 -isysroot '
  94. '/Developer/SDKs/MacOSX10.4u.sdk '
  95. '-fno-strict-aliasing -fno-common '
  96. '-dynamic -DNDEBUG -g -O3')
  97. self.assertEqual(get_platform(), 'macosx-10.4-fat')
  98. _osx_support._remove_original_values(get_config_vars())
  99. os.environ['MACOSX_DEPLOYMENT_TARGET'] = '10.1'
  100. self.assertEqual(get_platform(), 'macosx-10.4-fat')
  101. _osx_support._remove_original_values(get_config_vars())
  102. get_config_vars()['CFLAGS'] = ('-arch x86_64 -arch i386 -isysroot '
  103. '/Developer/SDKs/MacOSX10.4u.sdk '
  104. '-fno-strict-aliasing -fno-common '
  105. '-dynamic -DNDEBUG -g -O3')
  106. self.assertEqual(get_platform(), 'macosx-10.4-intel')
  107. _osx_support._remove_original_values(get_config_vars())
  108. get_config_vars()['CFLAGS'] = ('-arch x86_64 -arch ppc -arch i386 -isysroot '
  109. '/Developer/SDKs/MacOSX10.4u.sdk '
  110. '-fno-strict-aliasing -fno-common '
  111. '-dynamic -DNDEBUG -g -O3')
  112. self.assertEqual(get_platform(), 'macosx-10.4-fat3')
  113. _osx_support._remove_original_values(get_config_vars())
  114. get_config_vars()['CFLAGS'] = ('-arch ppc64 -arch x86_64 -arch ppc -arch i386 -isysroot '
  115. '/Developer/SDKs/MacOSX10.4u.sdk '
  116. '-fno-strict-aliasing -fno-common '
  117. '-dynamic -DNDEBUG -g -O3')
  118. self.assertEqual(get_platform(), 'macosx-10.4-universal')
  119. _osx_support._remove_original_values(get_config_vars())
  120. get_config_vars()['CFLAGS'] = ('-arch x86_64 -arch ppc64 -isysroot '
  121. '/Developer/SDKs/MacOSX10.4u.sdk '
  122. '-fno-strict-aliasing -fno-common '
  123. '-dynamic -DNDEBUG -g -O3')
  124. self.assertEqual(get_platform(), 'macosx-10.4-fat64')
  125. for arch in ('ppc', 'i386', 'x86_64', 'ppc64'):
  126. _osx_support._remove_original_values(get_config_vars())
  127. get_config_vars()['CFLAGS'] = ('-arch %s -isysroot '
  128. '/Developer/SDKs/MacOSX10.4u.sdk '
  129. '-fno-strict-aliasing -fno-common '
  130. '-dynamic -DNDEBUG -g -O3'%(arch,))
  131. self.assertEqual(get_platform(), 'macosx-10.4-%s'%(arch,))
  132. # linux debian sarge
  133. os.name = 'posix'
  134. sys.version = ('2.3.5 (#1, Jul 4 2007, 17:28:59) '
  135. '\n[GCC 4.1.2 20061115 (prerelease) (Debian 4.1.1-21)]')
  136. sys.platform = 'linux2'
  137. self._set_uname(('Linux', 'aglae', '2.6.21.1dedibox-r7',
  138. '#1 Mon Apr 30 17:25:38 CEST 2007', 'i686'))
  139. self.assertEqual(get_platform(), 'linux-i686')
  140. # XXX more platforms to tests here
  141. def test_convert_path(self):
  142. # linux/mac
  143. os.sep = '/'
  144. def _join(path):
  145. return '/'.join(path)
  146. os.path.join = _join
  147. self.assertEqual(convert_path('/home/to/my/stuff'),
  148. '/home/to/my/stuff')
  149. # win
  150. os.sep = '\\'
  151. def _join(*path):
  152. return '\\'.join(path)
  153. os.path.join = _join
  154. self.assertRaises(ValueError, convert_path, '/home/to/my/stuff')
  155. self.assertRaises(ValueError, convert_path, 'home/to/my/stuff/')
  156. self.assertEqual(convert_path('home/to/my/stuff'),
  157. 'home\\to\\my\\stuff')
  158. self.assertEqual(convert_path('.'),
  159. os.curdir)
  160. def test_change_root(self):
  161. # linux/mac
  162. os.name = 'posix'
  163. def _isabs(path):
  164. return path[0] == '/'
  165. os.path.isabs = _isabs
  166. def _join(*path):
  167. return '/'.join(path)
  168. os.path.join = _join
  169. self.assertEqual(change_root('/root', '/old/its/here'),
  170. '/root/old/its/here')
  171. self.assertEqual(change_root('/root', 'its/here'),
  172. '/root/its/here')
  173. # windows
  174. os.name = 'nt'
  175. def _isabs(path):
  176. return path.startswith('c:\\')
  177. os.path.isabs = _isabs
  178. def _splitdrive(path):
  179. if path.startswith('c:'):
  180. return ('', path.replace('c:', ''))
  181. return ('', path)
  182. os.path.splitdrive = _splitdrive
  183. def _join(*path):
  184. return '\\'.join(path)
  185. os.path.join = _join
  186. self.assertEqual(change_root('c:\\root', 'c:\\old\\its\\here'),
  187. 'c:\\root\\old\\its\\here')
  188. self.assertEqual(change_root('c:\\root', 'its\\here'),
  189. 'c:\\root\\its\\here')
  190. # BugsBunny os (it's a great os)
  191. os.name = 'BugsBunny'
  192. self.assertRaises(DistutilsPlatformError,
  193. change_root, 'c:\\root', 'its\\here')
  194. # XXX platforms to be covered: mac
  195. def test_check_environ(self):
  196. util._environ_checked = 0
  197. os.environ.pop('HOME', None)
  198. check_environ()
  199. self.assertEqual(os.environ['PLAT'], get_platform())
  200. self.assertEqual(util._environ_checked, 1)
  201. @unittest.skipUnless(os.name == 'posix', 'specific to posix')
  202. def test_check_environ_getpwuid(self):
  203. util._environ_checked = 0
  204. os.environ.pop('HOME', None)
  205. try:
  206. import pwd
  207. except ImportError:
  208. raise unittest.SkipTest("Test requires pwd module.")
  209. # only set pw_dir field, other fields are not used
  210. result = pwd.struct_passwd((None, None, None, None, None,
  211. '/home/distutils', None))
  212. with mock.patch.object(pwd, 'getpwuid', return_value=result):
  213. check_environ()
  214. self.assertEqual(os.environ['HOME'], '/home/distutils')
  215. util._environ_checked = 0
  216. os.environ.pop('HOME', None)
  217. # bpo-10496: Catch pwd.getpwuid() error
  218. with mock.patch.object(pwd, 'getpwuid', side_effect=KeyError):
  219. check_environ()
  220. self.assertNotIn('HOME', os.environ)
  221. def test_split_quoted(self):
  222. self.assertEqual(split_quoted('""one"" "two" \'three\' \\four'),
  223. ['one', 'two', 'three', 'four'])
  224. def test_strtobool(self):
  225. yes = ('y', 'Y', 'yes', 'True', 't', 'true', 'True', 'On', 'on', '1')
  226. no = ('n', 'no', 'f', 'false', 'off', '0', 'Off', 'No', 'N')
  227. for y in yes:
  228. self.assertTrue(strtobool(y))
  229. for n in no:
  230. self.assertFalse(strtobool(n))
  231. def test_rfc822_escape(self):
  232. header = 'I am a\npoor\nlonesome\nheader\n'
  233. res = rfc822_escape(header)
  234. wanted = ('I am a%(8s)spoor%(8s)slonesome%(8s)s'
  235. 'header%(8s)s') % {'8s': '\n'+8*' '}
  236. self.assertEqual(res, wanted)
  237. def test_dont_write_bytecode(self):
  238. # makes sure byte_compile raise a DistutilsError
  239. # if sys.dont_write_bytecode is True
  240. old_dont_write_bytecode = sys.dont_write_bytecode
  241. sys.dont_write_bytecode = True
  242. try:
  243. self.assertRaises(DistutilsByteCompileError, byte_compile, [])
  244. finally:
  245. sys.dont_write_bytecode = old_dont_write_bytecode
  246. def test_grok_environment_error(self):
  247. # test obsolete function to ensure backward compat (#4931)
  248. exc = IOError("Unable to find batch file")
  249. msg = grok_environment_error(exc)
  250. self.assertEqual(msg, "error: Unable to find batch file")
  251. def test_suite():
  252. return unittest.TestLoader().loadTestsFromTestCase(UtilTestCase)
  253. if __name__ == "__main__":
  254. run_unittest(test_suite())