test_build_clib.py 4.57 KB
Newer Older
1 2
"""Tests for distutils.command.build_clib."""
import unittest
3 4
import os
import sys
5

6
from test.support import run_unittest, missing_compiler_executable
7

8 9 10
from distutils.command.build_clib import build_clib
from distutils.errors import DistutilsSetupError
from distutils.tests import support
11
from distutils.spawn import find_executable
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

class BuildCLibTestCase(support.TempdirManager,
                        support.LoggingSilencer,
                        unittest.TestCase):

    def test_check_library_dist(self):
        pkg_dir, dist = self.create_dist()
        cmd = build_clib(dist)

        # 'libraries' option must be a list
        self.assertRaises(DistutilsSetupError, cmd.check_library_list, 'foo')

        # each element of 'libraries' must a 2-tuple
        self.assertRaises(DistutilsSetupError, cmd.check_library_list,
                          ['foo1', 'foo2'])

        # first element of each tuple in 'libraries'
        # must be a string (the library name)
        self.assertRaises(DistutilsSetupError, cmd.check_library_list,
                          [(1, 'foo1'), ('name', 'foo2')])

        # library name may not contain directory separators
        self.assertRaises(DistutilsSetupError, cmd.check_library_list,
                          [('name', 'foo1'),
                           ('another/name', 'foo2')])

        # second element of each tuple must be a dictionary (build info)
        self.assertRaises(DistutilsSetupError, cmd.check_library_list,
                          [('name', {}),
                           ('another', 'foo2')])

        # those work
        libs = [('name', {}), ('name', {'ok': 'good'})]
        cmd.check_library_list(libs)

47 48 49 50 51 52 53 54 55 56 57 58 59
    def test_get_source_files(self):
        pkg_dir, dist = self.create_dist()
        cmd = build_clib(dist)

        # "in 'libraries' option 'sources' must be present and must be
        # a list of source filenames
        cmd.libraries = [('name', {})]
        self.assertRaises(DistutilsSetupError, cmd.get_source_files)

        cmd.libraries = [('name', {'sources': 1})]
        self.assertRaises(DistutilsSetupError, cmd.get_source_files)

        cmd.libraries = [('name', {'sources': ['a', 'b']})]
60
        self.assertEqual(cmd.get_source_files(), ['a', 'b'])
61 62

        cmd.libraries = [('name', {'sources': ('a', 'b')})]
63
        self.assertEqual(cmd.get_source_files(), ['a', 'b'])
64 65 66

        cmd.libraries = [('name', {'sources': ('a', 'b')}),
                         ('name2', {'sources': ['c', 'd']})]
67
        self.assertEqual(cmd.get_source_files(), ['a', 'b', 'c', 'd'])
68 69 70 71 72 73 74 75 76 77 78 79

    def test_build_libraries(self):

        pkg_dir, dist = self.create_dist()
        cmd = build_clib(dist)
        class FakeCompiler:
            def compile(*args, **kw):
                pass
            create_static_lib = compile

        cmd.compiler = FakeCompiler()

80
        # build_libraries is also doing a bit of typo checking
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
        lib = [('name', {'sources': 'notvalid'})]
        self.assertRaises(DistutilsSetupError, cmd.build_libraries, lib)

        lib = [('name', {'sources': list()})]
        cmd.build_libraries(lib)

        lib = [('name', {'sources': tuple()})]
        cmd.build_libraries(lib)

    def test_finalize_options(self):
        pkg_dir, dist = self.create_dist()
        cmd = build_clib(dist)

        cmd.include_dirs = 'one-dir'
        cmd.finalize_options()
96
        self.assertEqual(cmd.include_dirs, ['one-dir'])
97 98 99

        cmd.include_dirs = None
        cmd.finalize_options()
100
        self.assertEqual(cmd.include_dirs, [])
101 102 103

        cmd.distribution.libraries = 'WONTWORK'
        self.assertRaises(DistutilsSetupError, cmd.finalize_options)
104

105
    @unittest.skipIf(sys.platform == 'win32', "can't test on Windows")
106 107 108 109 110
    def test_run(self):
        pkg_dir, dist = self.create_dist()
        cmd = build_clib(dist)

        foo_c = os.path.join(pkg_dir, 'foo.c')
111
        self.write_file(foo_c, 'int main(void) { return 1;}\n')
112 113 114 115 116 117 118
        cmd.libraries = [('foo', {'sources': [foo_c]})]

        build_temp = os.path.join(pkg_dir, 'build')
        os.mkdir(build_temp)
        cmd.build_temp = build_temp
        cmd.build_clib = build_temp

119 120 121 122 123
        # Before we run the command, we want to make sure
        # all commands are present on the system.
        ccmd = missing_compiler_executable()
        if ccmd is not None:
            self.skipTest('The %r command is not found' % ccmd)
124 125 126 127 128

        # this should work
        cmd.run()

        # let's check the result
129
        self.assertIn('libfoo.a', os.listdir(build_temp))
130

131 132 133 134
def test_suite():
    return unittest.makeSuite(BuildCLibTestCase)

if __name__ == "__main__":
135
    run_unittest(test_suite())