"""Tests for distutils.command.build_clib."""
import os
from distutils.command.build_clib import build_clib
from distutils.errors import DistutilsSetupError
from distutils.tests import missing_compiler_executable, support
import pytest
class TestBuildCLib(support.TempdirManager):
def test_check_library_dist(self):
pkg_dir, dist = self.create_dist()
cmd = build_clib(dist)
# 'libraries' option must be a list
with pytest.raises(DistutilsSetupError):
cmd.check_library_list('foo')
# each element of 'libraries' must a 2-tuple
with pytest.raises(DistutilsSetupError):
cmd.check_library_list(['foo1', 'foo2'])
# first element of each tuple in 'libraries'
# must be a string (the library name)
with pytest.raises(DistutilsSetupError):
cmd.check_library_list([(1, 'foo1'), ('name', 'foo2')])
# library name may not contain directory separators
with pytest.raises(DistutilsSetupError):
cmd.check_library_list(
[('name', 'foo1'), ('another/name', 'foo2')],
)
# second element of each tuple must be a dictionary (build info)
with pytest.raises(DistutilsSetupError):
cmd.check_library_list(
[('name', {}), ('another', 'foo2')],
)
# those work
libs = [('name', {}), ('name', {'ok': 'good'})]
cmd.check_library_list(libs)
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', {})]
with pytest.raises(DistutilsSetupError):
cmd.get_source_files()
cmd.libraries = [('name', {'sources': 1})]
with pytest.raises(DistutilsSetupError):
cmd.get_source_files()
cmd.libraries = [('name', {'sources': ['a', 'b']})]
assert cmd.get_source_files() == ['a', 'b']
cmd.libraries = [('name', {'sources': ('a', 'b')})]
assert cmd.get_source_files() == ['a', 'b']
cmd.libraries = [
('name', {'sources': ('a', 'b')}),
('name2', {'sources': ['c', 'd']}),
]
assert cmd.get_source_files() == ['a', 'b', 'c', 'd']
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()
# build_libraries is also doing a bit of typo checking
lib = [('name', {'sources': 'notvalid'})]
with pytest.raises(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()
assert cmd.include_dirs == ['one-dir']
cmd.include_dirs = None
cmd.finalize_options()
assert cmd.include_dirs == []
cmd.distribution.libraries = 'WONTWORK'
with pytest.raises(DistutilsSetupError):
cmd.finalize_options()
@pytest.mark.skipif('platform.system() == "Windows"')
def test_run(self):
pkg_dir, dist = self.create_dist()
cmd = build_clib(dist)
foo_c = os.path.join(pkg_dir, 'foo.c')
self.write_file(foo_c, 'int main(void) { return 1;}\n')
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
# 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(f'The {ccmd!r} command is not found')
# this should work
cmd.run()
# let's check the result
assert 'libfoo.a' in os.listdir(build_temp)
|