test_discovery.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  1. import os
  2. import re
  3. import sys
  4. import unittest
  5. import unittest.test
  6. class TestDiscovery(unittest.TestCase):
  7. # Heavily mocked tests so I can avoid hitting the filesystem
  8. def test_get_name_from_path(self):
  9. loader = unittest.TestLoader()
  10. loader._top_level_dir = '/foo'
  11. name = loader._get_name_from_path('/foo/bar/baz.py')
  12. self.assertEqual(name, 'bar.baz')
  13. if not __debug__:
  14. # asserts are off
  15. return
  16. with self.assertRaises(AssertionError):
  17. loader._get_name_from_path('/bar/baz.py')
  18. def test_find_tests(self):
  19. loader = unittest.TestLoader()
  20. original_listdir = os.listdir
  21. def restore_listdir():
  22. os.listdir = original_listdir
  23. original_isfile = os.path.isfile
  24. def restore_isfile():
  25. os.path.isfile = original_isfile
  26. original_isdir = os.path.isdir
  27. def restore_isdir():
  28. os.path.isdir = original_isdir
  29. path_lists = [['test1.py', 'test2.py', 'not_a_test.py', 'test_dir',
  30. 'test.foo', 'test-not-a-module.py', 'another_dir'],
  31. ['test3.py', 'test4.py', ]]
  32. os.listdir = lambda path: path_lists.pop(0)
  33. self.addCleanup(restore_listdir)
  34. def isdir(path):
  35. return path.endswith('dir')
  36. os.path.isdir = isdir
  37. self.addCleanup(restore_isdir)
  38. def isfile(path):
  39. # another_dir is not a package and so shouldn't be recursed into
  40. return not path.endswith('dir') and not 'another_dir' in path
  41. os.path.isfile = isfile
  42. self.addCleanup(restore_isfile)
  43. loader._get_module_from_name = lambda path: path + ' module'
  44. loader.loadTestsFromModule = lambda module: module + ' tests'
  45. top_level = os.path.abspath('/foo')
  46. loader._top_level_dir = top_level
  47. suite = list(loader._find_tests(top_level, 'test*.py'))
  48. expected = [name + ' module tests' for name in
  49. ('test1', 'test2')]
  50. expected.extend([('test_dir.%s' % name) + ' module tests' for name in
  51. ('test3', 'test4')])
  52. self.assertEqual(suite, expected)
  53. def test_find_tests_with_package(self):
  54. loader = unittest.TestLoader()
  55. original_listdir = os.listdir
  56. def restore_listdir():
  57. os.listdir = original_listdir
  58. original_isfile = os.path.isfile
  59. def restore_isfile():
  60. os.path.isfile = original_isfile
  61. original_isdir = os.path.isdir
  62. def restore_isdir():
  63. os.path.isdir = original_isdir
  64. directories = ['a_directory', 'test_directory', 'test_directory2']
  65. path_lists = [directories, [], [], []]
  66. os.listdir = lambda path: path_lists.pop(0)
  67. self.addCleanup(restore_listdir)
  68. os.path.isdir = lambda path: True
  69. self.addCleanup(restore_isdir)
  70. os.path.isfile = lambda path: os.path.basename(path) not in directories
  71. self.addCleanup(restore_isfile)
  72. class Module(object):
  73. paths = []
  74. load_tests_args = []
  75. def __init__(self, path):
  76. self.path = path
  77. self.paths.append(path)
  78. if os.path.basename(path) == 'test_directory':
  79. def load_tests(loader, tests, pattern):
  80. self.load_tests_args.append((loader, tests, pattern))
  81. return 'load_tests'
  82. self.load_tests = load_tests
  83. def __eq__(self, other):
  84. return self.path == other.path
  85. # Silence py3k warning
  86. __hash__ = None
  87. loader._get_module_from_name = lambda name: Module(name)
  88. def loadTestsFromModule(module, use_load_tests):
  89. if use_load_tests:
  90. raise self.failureException('use_load_tests should be False for packages')
  91. return module.path + ' module tests'
  92. loader.loadTestsFromModule = loadTestsFromModule
  93. loader._top_level_dir = '/foo'
  94. # this time no '.py' on the pattern so that it can match
  95. # a test package
  96. suite = list(loader._find_tests('/foo', 'test*'))
  97. # We should have loaded tests from the test_directory package by calling load_tests
  98. # and directly from the test_directory2 package
  99. self.assertEqual(suite,
  100. ['load_tests', 'test_directory2' + ' module tests'])
  101. self.assertEqual(Module.paths, ['test_directory', 'test_directory2'])
  102. # load_tests should have been called once with loader, tests and pattern
  103. self.assertEqual(Module.load_tests_args,
  104. [(loader, 'test_directory' + ' module tests', 'test*')])
  105. def test_discover(self):
  106. loader = unittest.TestLoader()
  107. original_isfile = os.path.isfile
  108. original_isdir = os.path.isdir
  109. def restore_isfile():
  110. os.path.isfile = original_isfile
  111. os.path.isfile = lambda path: False
  112. self.addCleanup(restore_isfile)
  113. orig_sys_path = sys.path[:]
  114. def restore_path():
  115. sys.path[:] = orig_sys_path
  116. self.addCleanup(restore_path)
  117. full_path = os.path.abspath(os.path.normpath('/foo'))
  118. with self.assertRaises(ImportError):
  119. loader.discover('/foo/bar', top_level_dir='/foo')
  120. self.assertEqual(loader._top_level_dir, full_path)
  121. self.assertIn(full_path, sys.path)
  122. os.path.isfile = lambda path: True
  123. os.path.isdir = lambda path: True
  124. def restore_isdir():
  125. os.path.isdir = original_isdir
  126. self.addCleanup(restore_isdir)
  127. _find_tests_args = []
  128. def _find_tests(start_dir, pattern):
  129. _find_tests_args.append((start_dir, pattern))
  130. return ['tests']
  131. loader._find_tests = _find_tests
  132. loader.suiteClass = str
  133. suite = loader.discover('/foo/bar/baz', 'pattern', '/foo/bar')
  134. top_level_dir = os.path.abspath('/foo/bar')
  135. start_dir = os.path.abspath('/foo/bar/baz')
  136. self.assertEqual(suite, "['tests']")
  137. self.assertEqual(loader._top_level_dir, top_level_dir)
  138. self.assertEqual(_find_tests_args, [(start_dir, 'pattern')])
  139. self.assertIn(top_level_dir, sys.path)
  140. def test_discover_with_modules_that_fail_to_import(self):
  141. loader = unittest.TestLoader()
  142. listdir = os.listdir
  143. os.listdir = lambda _: ['test_this_does_not_exist.py']
  144. isfile = os.path.isfile
  145. os.path.isfile = lambda _: True
  146. orig_sys_path = sys.path[:]
  147. def restore():
  148. os.path.isfile = isfile
  149. os.listdir = listdir
  150. sys.path[:] = orig_sys_path
  151. self.addCleanup(restore)
  152. suite = loader.discover('.')
  153. self.assertIn(os.getcwd(), sys.path)
  154. self.assertEqual(suite.countTestCases(), 1)
  155. test = list(list(suite)[0])[0] # extract test from suite
  156. with self.assertRaises(ImportError):
  157. test.test_this_does_not_exist()
  158. def test_command_line_handling_parseArgs(self):
  159. # Haha - take that uninstantiable class
  160. program = object.__new__(unittest.TestProgram)
  161. args = []
  162. def do_discovery(argv):
  163. args.extend(argv)
  164. program._do_discovery = do_discovery
  165. program.parseArgs(['something', 'discover'])
  166. self.assertEqual(args, [])
  167. program.parseArgs(['something', 'discover', 'foo', 'bar'])
  168. self.assertEqual(args, ['foo', 'bar'])
  169. def test_command_line_handling_do_discovery_too_many_arguments(self):
  170. class Stop(Exception):
  171. pass
  172. def usageExit():
  173. raise Stop
  174. program = object.__new__(unittest.TestProgram)
  175. program.usageExit = usageExit
  176. program.testLoader = None
  177. with self.assertRaises(Stop):
  178. # too many args
  179. program._do_discovery(['one', 'two', 'three', 'four'])
  180. def test_command_line_handling_do_discovery_uses_default_loader(self):
  181. program = object.__new__(unittest.TestProgram)
  182. class Loader(object):
  183. args = []
  184. def discover(self, start_dir, pattern, top_level_dir):
  185. self.args.append((start_dir, pattern, top_level_dir))
  186. return 'tests'
  187. program.testLoader = Loader()
  188. program._do_discovery(['-v'])
  189. self.assertEqual(Loader.args, [('.', 'test*.py', None)])
  190. def test_command_line_handling_do_discovery_calls_loader(self):
  191. program = object.__new__(unittest.TestProgram)
  192. class Loader(object):
  193. args = []
  194. def discover(self, start_dir, pattern, top_level_dir):
  195. self.args.append((start_dir, pattern, top_level_dir))
  196. return 'tests'
  197. program._do_discovery(['-v'], Loader=Loader)
  198. self.assertEqual(program.verbosity, 2)
  199. self.assertEqual(program.test, 'tests')
  200. self.assertEqual(Loader.args, [('.', 'test*.py', None)])
  201. Loader.args = []
  202. program = object.__new__(unittest.TestProgram)
  203. program._do_discovery(['--verbose'], Loader=Loader)
  204. self.assertEqual(program.test, 'tests')
  205. self.assertEqual(Loader.args, [('.', 'test*.py', None)])
  206. Loader.args = []
  207. program = object.__new__(unittest.TestProgram)
  208. program._do_discovery([], Loader=Loader)
  209. self.assertEqual(program.test, 'tests')
  210. self.assertEqual(Loader.args, [('.', 'test*.py', None)])
  211. Loader.args = []
  212. program = object.__new__(unittest.TestProgram)
  213. program._do_discovery(['fish'], Loader=Loader)
  214. self.assertEqual(program.test, 'tests')
  215. self.assertEqual(Loader.args, [('fish', 'test*.py', None)])
  216. Loader.args = []
  217. program = object.__new__(unittest.TestProgram)
  218. program._do_discovery(['fish', 'eggs'], Loader=Loader)
  219. self.assertEqual(program.test, 'tests')
  220. self.assertEqual(Loader.args, [('fish', 'eggs', None)])
  221. Loader.args = []
  222. program = object.__new__(unittest.TestProgram)
  223. program._do_discovery(['fish', 'eggs', 'ham'], Loader=Loader)
  224. self.assertEqual(program.test, 'tests')
  225. self.assertEqual(Loader.args, [('fish', 'eggs', 'ham')])
  226. Loader.args = []
  227. program = object.__new__(unittest.TestProgram)
  228. program._do_discovery(['-s', 'fish'], Loader=Loader)
  229. self.assertEqual(program.test, 'tests')
  230. self.assertEqual(Loader.args, [('fish', 'test*.py', None)])
  231. Loader.args = []
  232. program = object.__new__(unittest.TestProgram)
  233. program._do_discovery(['-t', 'fish'], Loader=Loader)
  234. self.assertEqual(program.test, 'tests')
  235. self.assertEqual(Loader.args, [('.', 'test*.py', 'fish')])
  236. Loader.args = []
  237. program = object.__new__(unittest.TestProgram)
  238. program._do_discovery(['-p', 'fish'], Loader=Loader)
  239. self.assertEqual(program.test, 'tests')
  240. self.assertEqual(Loader.args, [('.', 'fish', None)])
  241. self.assertFalse(program.failfast)
  242. self.assertFalse(program.catchbreak)
  243. Loader.args = []
  244. program = object.__new__(unittest.TestProgram)
  245. program._do_discovery(['-p', 'eggs', '-s', 'fish', '-v', '-f', '-c'],
  246. Loader=Loader)
  247. self.assertEqual(program.test, 'tests')
  248. self.assertEqual(Loader.args, [('fish', 'eggs', None)])
  249. self.assertEqual(program.verbosity, 2)
  250. self.assertTrue(program.failfast)
  251. self.assertTrue(program.catchbreak)
  252. def setup_module_clash(self):
  253. class Module(object):
  254. __file__ = 'bar/foo.py'
  255. sys.modules['foo'] = Module
  256. full_path = os.path.abspath('foo')
  257. original_listdir = os.listdir
  258. original_isfile = os.path.isfile
  259. original_isdir = os.path.isdir
  260. def cleanup():
  261. os.listdir = original_listdir
  262. os.path.isfile = original_isfile
  263. os.path.isdir = original_isdir
  264. del sys.modules['foo']
  265. if full_path in sys.path:
  266. sys.path.remove(full_path)
  267. self.addCleanup(cleanup)
  268. def listdir(_):
  269. return ['foo.py']
  270. def isfile(_):
  271. return True
  272. def isdir(_):
  273. return True
  274. os.listdir = listdir
  275. os.path.isfile = isfile
  276. os.path.isdir = isdir
  277. return full_path
  278. def test_detect_module_clash(self):
  279. full_path = self.setup_module_clash()
  280. loader = unittest.TestLoader()
  281. mod_dir = os.path.abspath('bar')
  282. expected_dir = os.path.abspath('foo')
  283. msg = re.escape(r"'foo' module incorrectly imported from %r. Expected %r. "
  284. "Is this module globally installed?" % (mod_dir, expected_dir))
  285. self.assertRaisesRegexp(
  286. ImportError, '^%s$' % msg, loader.discover,
  287. start_dir='foo', pattern='foo.py'
  288. )
  289. self.assertEqual(sys.path[0], full_path)
  290. def test_module_symlink_ok(self):
  291. full_path = self.setup_module_clash()
  292. original_realpath = os.path.realpath
  293. mod_dir = os.path.abspath('bar')
  294. expected_dir = os.path.abspath('foo')
  295. def cleanup():
  296. os.path.realpath = original_realpath
  297. self.addCleanup(cleanup)
  298. def realpath(path):
  299. if path == os.path.join(mod_dir, 'foo.py'):
  300. return os.path.join(expected_dir, 'foo.py')
  301. return path
  302. os.path.realpath = realpath
  303. loader = unittest.TestLoader()
  304. loader.discover(start_dir='foo', pattern='foo.py')
  305. def test_discovery_from_dotted_path(self):
  306. loader = unittest.TestLoader()
  307. tests = [self]
  308. expectedPath = os.path.abspath(os.path.dirname(unittest.test.__file__))
  309. self.wasRun = False
  310. def _find_tests(start_dir, pattern):
  311. self.wasRun = True
  312. self.assertEqual(start_dir, expectedPath)
  313. return tests
  314. loader._find_tests = _find_tests
  315. suite = loader.discover('unittest.test')
  316. self.assertTrue(self.wasRun)
  317. self.assertEqual(suite._tests, tests)
  318. if __name__ == '__main__':
  319. unittest.main()