Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add KB-H078 in conan-center to test that system libs are all lowercase if host OS is Windows #480

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions hooks/conan-center.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@
"KB-H075": "REQUIREMENT OVERRIDE PARAMETER",
"KB-H076": "EITHER STATIC OR SHARED OF EACH LIB",
"KB-H077": "APPLE RELOCATABLE SHARED LIBS",
"KB-H078": "WINDOWS LOWERCASE SYSTEM LIBS",
}


Expand Down Expand Up @@ -1335,6 +1336,29 @@ def _test_component(component):
for c in conanfile.cpp_info.components:
_test_component(conanfile.cpp_info.components[c])

@run_test("KB-H078", output)
def test(out):
if conanfile.settings.get_safe("os") != "Windows":
return

uppercase_system_libs = []

def _collect_uppercase_system_libs(component):
uppercase_system_libs.extend([lib for lib in component.system_libs if not lib.islower())])
SpaceIm marked this conversation as resolved.
Show resolved Hide resolved

if not conanfile.cpp_info.components:
_collect_uppercase_system_libs(conanfile.cpp_info)
for c in conanfile.cpp_info.components:
_collect_uppercase_system_libs(conanfile.cpp_info.components[c])

if uppercase_system_libs:
uppercase_system_libs.sort()
out.error(
"All libs listed in system_libs should be lowercase if host OS is "
"Windows to support both native Windows build and cross-build from Linux. "
f"Found system libs with uppercase characters: {', '.join(uppercase_system_libs)}"
)


def _get_files_following_patterns(folder, patterns):
ret = []
Expand Down
105 changes: 105 additions & 0 deletions tests/test_hooks/conan-center/test_windows_lowercase_system_libs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import os
import platform
import textwrap

from parameterized import parameterized

from conans import tools

from tests.utils.test_cases.conan_client import ConanClientTestCase


class TestPackageInfoWindowsLowercaseSystemLibs(ConanClientTestCase):

def _get_environ(self, **kwargs):
kwargs = super(TestPackageInfoWindowsLowercaseSystemLibs, self)._get_environ(**kwargs)
kwargs.update({
"CONAN_HOOKS": os.path.join(os.path.dirname(__file__), os.pardir, os.pardir,
os.pardir, "hooks", "conan-center")
})
return kwargs

@staticmethod
def _conanfile_test_global_cpp_info(system_lib=None):
system_libs = "[{}]".format(f"\"{system_lib}\"" if system_lib else "")
return textwrap.dedent(f"""\
from conan import ConanFile
import os

class AConan(ConanFile):
settings = "os", "arch", "compiler", "build_type"
options = {{"shared": [True, False], "status": [True, False]}}
default_options = {{"shared": False, "status": True}}

def package_info(self):
if self.settings.os == "Windows":
self.cpp_info.system_libs = {system_libs}
else:
self.cpp_info.system_libs = ["FOO"]
""")

@staticmethod
def _conanfile_test_components_cpp_info(system_lib_a=None, system_lib_b=None):
system_libs_a = "[{}]".format(f"\"{system_lib_a}\"" if system_lib_a else "")
system_libs_b = "[{}]".format(f"\"{system_lib_b}\"" if system_lib_b else "")
return textwrap.dedent(f"""\
from conan import ConanFile
import os

class AConan(ConanFile):
settings = "os", "arch", "compiler", "build_type"
options = {{"shared": [True, False], "status": [True, False]}}
default_options = {{"shared": False, "status": True}}

def package_info(self):
if self.settings.os == "Windows":
self.cpp_info.components["a"].system_libs = {system_libs_a}
self.cpp_info.components["b"].system_libs = {system_libs_b}
else:
self.cpp_info.components["a"].system_libs = ["FOO"]
self.cpp_info.components["b"].system_libs = ["BAR"]
""")

@parameterized.expand([(None, ), ("ws2_32", ), ("Ws2_32", )])
def test_global_cpp_info(self, system_lib):
tools.save("conanfile.py", content=self._conanfile_test_global_cpp_info(system_lib))
output = self.conan(["create", ".", "name/version@user/test"])
if platform.system() != "Windows" or not system_lib or system_lib == system_lib.lower():
SpaceIm marked this conversation as resolved.
Show resolved Hide resolved
self.assertIn("[WINDOWS LOWERCASE SYSTEM LIBS (KB-H078)] OK", output)
else:
error_message = (
"ERROR: [WINDOWS LOWERCASE SYSTEM LIBS (KB-H078)] "
"All libs listed in system_libs should be lowercase if host OS is "
"Windows to support both native Windows build and cross-build from Linux. "
f"Found system libs with uppercase characters: {system_lib}"
)
self.assertIn(error_message, output)

@parameterized.expand([
(None, None),
("ws2_32", "ole32"),
("Ws2_32", "ole32"),
("ws2_32", "Ole32"),
("Ws2_32", "Ole32"),
])
def test_components_cpp_info(self, system_lib_a, system_lib_b):
tools.save("conanfile.py", content=self._conanfile_test_components_cpp_info(system_lib_a, system_lib_b))
output = self.conan(["create", ".", "name/version@user/test"])
if platform.system() != "Windows" or \
((not system_lib_a or system_lib_a == system_lib_a.lower()) and \
(not system_lib_b or system_lib_b == system_lib_b.lower())):
SpaceIm marked this conversation as resolved.
Show resolved Hide resolved
self.assertIn("[WINDOWS LOWERCASE SYSTEM LIBS (KB-H078)] OK", output)
else:
uppercase_libs = []
if system_lib_a and system_lib_a != system_lib_a.lower():
SpaceIm marked this conversation as resolved.
Show resolved Hide resolved
uppercase_libs.append(system_lib_a)
if system_lib_b and system_lib_b != system_lib_b.lower():
SpaceIm marked this conversation as resolved.
Show resolved Hide resolved
uppercase_libs.append(system_lib_b)
uppercase_libs.sort()
error_message = (
"ERROR: [WINDOWS LOWERCASE SYSTEM LIBS (KB-H078)] "
"All libs listed in system_libs should be lowercase if host OS is "
"Windows to support both native Windows build and cross-build from Linux. "
f"Found system libs with uppercase characters: {', '.join(uppercase_libs)}"
)
self.assertIn(error_message, output)