test_build_clib.py 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. """Tests for distutils.command.build_clib."""
  2. import unittest
  3. import os
  4. import sys
  5. from test.support import run_unittest
  6. from .py35compat import missing_compiler_executable
  7. from distutils.command.build_clib import build_clib
  8. from distutils.errors import DistutilsSetupError
  9. from distutils.tests import support
  10. class BuildCLibTestCase(support.TempdirManager,
  11. support.LoggingSilencer,
  12. unittest.TestCase):
  13. def test_check_library_dist(self):
  14. pkg_dir, dist = self.create_dist()
  15. cmd = build_clib(dist)
  16. # 'libraries' option must be a list
  17. self.assertRaises(DistutilsSetupError, cmd.check_library_list, 'foo')
  18. # each element of 'libraries' must a 2-tuple
  19. self.assertRaises(DistutilsSetupError, cmd.check_library_list,
  20. ['foo1', 'foo2'])
  21. # first element of each tuple in 'libraries'
  22. # must be a string (the library name)
  23. self.assertRaises(DistutilsSetupError, cmd.check_library_list,
  24. [(1, 'foo1'), ('name', 'foo2')])
  25. # library name may not contain directory separators
  26. self.assertRaises(DistutilsSetupError, cmd.check_library_list,
  27. [('name', 'foo1'),
  28. ('another/name', 'foo2')])
  29. # second element of each tuple must be a dictionary (build info)
  30. self.assertRaises(DistutilsSetupError, cmd.check_library_list,
  31. [('name', {}),
  32. ('another', 'foo2')])
  33. # those work
  34. libs = [('name', {}), ('name', {'ok': 'good'})]
  35. cmd.check_library_list(libs)
  36. def test_get_source_files(self):
  37. pkg_dir, dist = self.create_dist()
  38. cmd = build_clib(dist)
  39. # "in 'libraries' option 'sources' must be present and must be
  40. # a list of source filenames
  41. cmd.libraries = [('name', {})]
  42. self.assertRaises(DistutilsSetupError, cmd.get_source_files)
  43. cmd.libraries = [('name', {'sources': 1})]
  44. self.assertRaises(DistutilsSetupError, cmd.get_source_files)
  45. cmd.libraries = [('name', {'sources': ['a', 'b']})]
  46. self.assertEqual(cmd.get_source_files(), ['a', 'b'])
  47. cmd.libraries = [('name', {'sources': ('a', 'b')})]
  48. self.assertEqual(cmd.get_source_files(), ['a', 'b'])
  49. cmd.libraries = [('name', {'sources': ('a', 'b')}),
  50. ('name2', {'sources': ['c', 'd']})]
  51. self.assertEqual(cmd.get_source_files(), ['a', 'b', 'c', 'd'])
  52. def test_build_libraries(self):
  53. pkg_dir, dist = self.create_dist()
  54. cmd = build_clib(dist)
  55. class FakeCompiler:
  56. def compile(*args, **kw):
  57. pass
  58. create_static_lib = compile
  59. cmd.compiler = FakeCompiler()
  60. # build_libraries is also doing a bit of typo checking
  61. lib = [('name', {'sources': 'notvalid'})]
  62. self.assertRaises(DistutilsSetupError, cmd.build_libraries, lib)
  63. lib = [('name', {'sources': list()})]
  64. cmd.build_libraries(lib)
  65. lib = [('name', {'sources': tuple()})]
  66. cmd.build_libraries(lib)
  67. def test_finalize_options(self):
  68. pkg_dir, dist = self.create_dist()
  69. cmd = build_clib(dist)
  70. cmd.include_dirs = 'one-dir'
  71. cmd.finalize_options()
  72. self.assertEqual(cmd.include_dirs, ['one-dir'])
  73. cmd.include_dirs = None
  74. cmd.finalize_options()
  75. self.assertEqual(cmd.include_dirs, [])
  76. cmd.distribution.libraries = 'WONTWORK'
  77. self.assertRaises(DistutilsSetupError, cmd.finalize_options)
  78. @unittest.skipIf(sys.platform == 'win32', "can't test on Windows")
  79. def test_run(self):
  80. pkg_dir, dist = self.create_dist()
  81. cmd = build_clib(dist)
  82. foo_c = os.path.join(pkg_dir, 'foo.c')
  83. self.write_file(foo_c, 'int main(void) { return 1;}\n')
  84. cmd.libraries = [('foo', {'sources': [foo_c]})]
  85. build_temp = os.path.join(pkg_dir, 'build')
  86. os.mkdir(build_temp)
  87. cmd.build_temp = build_temp
  88. cmd.build_clib = build_temp
  89. # Before we run the command, we want to make sure
  90. # all commands are present on the system.
  91. ccmd = missing_compiler_executable()
  92. if ccmd is not None:
  93. self.skipTest('The %r command is not found' % ccmd)
  94. # this should work
  95. cmd.run()
  96. # let's check the result
  97. self.assertIn('libfoo.a', os.listdir(build_temp))
  98. def test_suite():
  99. return unittest.makeSuite(BuildCLibTestCase)
  100. if __name__ == "__main__":
  101. run_unittest(test_suite())