Tarek Ziadé | d2bb1a5 | 2009-05-06 07:17:52 +0000 | [diff] [blame] | 1 | """Tests for distutils.command.build_clib.""" |
| 2 | import unittest |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 3 | import os |
| 4 | import sys |
Tarek Ziadé | d2bb1a5 | 2009-05-06 07:17:52 +0000 | [diff] [blame] | 5 | |
Éric Araujo | 54274ad | 2011-02-03 00:12:18 +0000 | [diff] [blame] | 6 | from test.test_support import run_unittest |
| 7 | |
Tarek Ziadé | d2bb1a5 | 2009-05-06 07:17:52 +0000 | [diff] [blame] | 8 | from distutils.command.build_clib import build_clib |
| 9 | from distutils.errors import DistutilsSetupError |
| 10 | from distutils.tests import support |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 11 | from distutils.spawn import find_executable |
Tarek Ziadé | d2bb1a5 | 2009-05-06 07:17:52 +0000 | [diff] [blame] | 12 | |
| 13 | class BuildCLibTestCase(support.TempdirManager, |
| 14 | support.LoggingSilencer, |
| 15 | unittest.TestCase): |
| 16 | |
| 17 | def test_check_library_dist(self): |
| 18 | pkg_dir, dist = self.create_dist() |
| 19 | cmd = build_clib(dist) |
| 20 | |
| 21 | # 'libraries' option must be a list |
| 22 | self.assertRaises(DistutilsSetupError, cmd.check_library_list, 'foo') |
| 23 | |
| 24 | # each element of 'libraries' must a 2-tuple |
| 25 | self.assertRaises(DistutilsSetupError, cmd.check_library_list, |
| 26 | ['foo1', 'foo2']) |
| 27 | |
| 28 | # first element of each tuple in 'libraries' |
| 29 | # must be a string (the library name) |
| 30 | self.assertRaises(DistutilsSetupError, cmd.check_library_list, |
| 31 | [(1, 'foo1'), ('name', 'foo2')]) |
| 32 | |
| 33 | # library name may not contain directory separators |
| 34 | self.assertRaises(DistutilsSetupError, cmd.check_library_list, |
| 35 | [('name', 'foo1'), |
| 36 | ('another/name', 'foo2')]) |
| 37 | |
| 38 | # second element of each tuple must be a dictionary (build info) |
| 39 | self.assertRaises(DistutilsSetupError, cmd.check_library_list, |
| 40 | [('name', {}), |
| 41 | ('another', 'foo2')]) |
| 42 | |
| 43 | # those work |
| 44 | libs = [('name', {}), ('name', {'ok': 'good'})] |
| 45 | cmd.check_library_list(libs) |
| 46 | |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 47 | def test_get_source_files(self): |
| 48 | pkg_dir, dist = self.create_dist() |
| 49 | cmd = build_clib(dist) |
| 50 | |
| 51 | # "in 'libraries' option 'sources' must be present and must be |
| 52 | # a list of source filenames |
| 53 | cmd.libraries = [('name', {})] |
| 54 | self.assertRaises(DistutilsSetupError, cmd.get_source_files) |
| 55 | |
| 56 | cmd.libraries = [('name', {'sources': 1})] |
| 57 | self.assertRaises(DistutilsSetupError, cmd.get_source_files) |
| 58 | |
| 59 | cmd.libraries = [('name', {'sources': ['a', 'b']})] |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 60 | self.assertEqual(cmd.get_source_files(), ['a', 'b']) |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 61 | |
| 62 | cmd.libraries = [('name', {'sources': ('a', 'b')})] |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 63 | self.assertEqual(cmd.get_source_files(), ['a', 'b']) |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 64 | |
| 65 | cmd.libraries = [('name', {'sources': ('a', 'b')}), |
| 66 | ('name2', {'sources': ['c', 'd']})] |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 67 | self.assertEqual(cmd.get_source_files(), ['a', 'b', 'c', 'd']) |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 68 | |
| 69 | def test_build_libraries(self): |
| 70 | |
| 71 | pkg_dir, dist = self.create_dist() |
| 72 | cmd = build_clib(dist) |
| 73 | class FakeCompiler: |
| 74 | def compile(*args, **kw): |
| 75 | pass |
| 76 | create_static_lib = compile |
| 77 | |
| 78 | cmd.compiler = FakeCompiler() |
| 79 | |
Ezio Melotti | 5dd99eb | 2013-08-17 16:07:38 +0300 | [diff] [blame] | 80 | # build_libraries is also doing a bit of typo checking |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 81 | lib = [('name', {'sources': 'notvalid'})] |
| 82 | self.assertRaises(DistutilsSetupError, cmd.build_libraries, lib) |
| 83 | |
| 84 | lib = [('name', {'sources': list()})] |
| 85 | cmd.build_libraries(lib) |
| 86 | |
| 87 | lib = [('name', {'sources': tuple()})] |
| 88 | cmd.build_libraries(lib) |
| 89 | |
| 90 | def test_finalize_options(self): |
| 91 | pkg_dir, dist = self.create_dist() |
| 92 | cmd = build_clib(dist) |
| 93 | |
| 94 | cmd.include_dirs = 'one-dir' |
| 95 | cmd.finalize_options() |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 96 | self.assertEqual(cmd.include_dirs, ['one-dir']) |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 97 | |
| 98 | cmd.include_dirs = None |
| 99 | cmd.finalize_options() |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 100 | self.assertEqual(cmd.include_dirs, []) |
Tarek Ziadé | ccf608c | 2009-05-06 08:05:47 +0000 | [diff] [blame] | 101 | |
| 102 | cmd.distribution.libraries = 'WONTWORK' |
| 103 | self.assertRaises(DistutilsSetupError, cmd.finalize_options) |
Tarek Ziadé | d2bb1a5 | 2009-05-06 07:17:52 +0000 | [diff] [blame] | 104 | |
Serhiy Storchaka | 57bc6da | 2013-12-18 16:45:37 +0200 | [diff] [blame] | 105 | @unittest.skipIf(sys.platform == 'win32', "can't test on Windows") |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 106 | def test_run(self): |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 107 | pkg_dir, dist = self.create_dist() |
| 108 | cmd = build_clib(dist) |
| 109 | |
| 110 | foo_c = os.path.join(pkg_dir, 'foo.c') |
Tarek Ziadé | 68e27eb | 2009-05-11 08:45:17 +0000 | [diff] [blame] | 111 | self.write_file(foo_c, 'int main(void) { return 1;}\n') |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 112 | cmd.libraries = [('foo', {'sources': [foo_c]})] |
| 113 | |
| 114 | build_temp = os.path.join(pkg_dir, 'build') |
| 115 | os.mkdir(build_temp) |
| 116 | cmd.build_temp = build_temp |
| 117 | cmd.build_clib = build_temp |
| 118 | |
| 119 | # before we run the command, we want to make sure |
| 120 | # all commands are present on the system |
| 121 | # by creating a compiler and checking its executables |
Ned Deily | c47a459 | 2012-02-11 20:40:24 +0100 | [diff] [blame] | 122 | from distutils.ccompiler import new_compiler |
| 123 | from distutils.sysconfig import customize_compiler |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 124 | |
| 125 | compiler = new_compiler() |
| 126 | customize_compiler(compiler) |
| 127 | for ccmd in compiler.executables.values(): |
| 128 | if ccmd is None: |
| 129 | continue |
| 130 | if find_executable(ccmd[0]) is None: |
Serhiy Storchaka | 57bc6da | 2013-12-18 16:45:37 +0200 | [diff] [blame] | 131 | self.skipTest('The %r command is not found' % ccmd[0]) |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 132 | |
| 133 | # this should work |
| 134 | cmd.run() |
| 135 | |
| 136 | # let's check the result |
Serhiy Storchaka | 25a23ef | 2013-11-17 00:29:27 +0200 | [diff] [blame] | 137 | self.assertIn('libfoo.a', os.listdir(build_temp)) |
Tarek Ziadé | 99f660a | 2009-05-07 21:20:34 +0000 | [diff] [blame] | 138 | |
Tarek Ziadé | d2bb1a5 | 2009-05-06 07:17:52 +0000 | [diff] [blame] | 139 | def test_suite(): |
| 140 | return unittest.makeSuite(BuildCLibTestCase) |
| 141 | |
| 142 | if __name__ == "__main__": |
Éric Araujo | 54274ad | 2011-02-03 00:12:18 +0000 | [diff] [blame] | 143 | run_unittest(test_suite()) |