Skip to content

[conan-center] KB-H040 Do not allow cpp_info.filename usage #397

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 4, 2022
Merged

[conan-center] KB-H040 Do not allow cpp_info.filename usage #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e636b9
Merge branch 'master' of https://github.com/conan-io/hooks
uilianries Mar 3, 2022
165858b
Block cpp_info.filename usage
uilianries Mar 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions hooks/conan-center.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,16 +447,17 @@ def test(out):

@run_test("KB-H040", output)
def test(out):
if "self.cpp_info.name =" in conanfile_content:
out.error("CCI uses the name of the package for cmake generator."
" Use 'cpp_info.names' instead.")

for generator in ["cmake", "cmake_multi"]:
if "self.cpp_info.names['{}']".format(generator) in conanfile_content or \
'self.cpp_info.names["{}"]'.format(generator) in conanfile_content:
out.error("CCI uses the name of the package for {0} generator. "
"Conanfile should not contain 'self.cpp_info.names['{0}']'. "
" Use 'cmake_find_package' and 'cmake_find_package_multi' instead.".format(generator))
match = re.search(r"self\.cpp_info\.(name|filename)\s?=", conanfile_content)
if match:
out.error("CCI uses the name of the package for cmake generator and filename by default."
" Replace 'cpp_info.{0}' by 'cpp_info.{0}s[<generator>]'.".format(match.group(1)))

match = re.search(r"self\.cpp_info\.(names|filenames)\[\s?['\"](cmake|cmake_multi)['\"]\s?\]", conanfile_content)
if match:
out.error("CCI uses the name of the package for {0} generator. "
"Conanfile should not contain 'self.cpp_info.{1}['{0}']'. "
"Use 'cmake_find_package' and 'cmake_find_package_multi' instead.".format(match.group(2),
match.group(1)))

@run_test("KB-H041", output)
def test(out):
Expand Down
35 changes: 0 additions & 35 deletions tests/test_hooks/conan-center/test_conan-center.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,41 +719,6 @@ def configure(self):
output = self.conan(['export', '.', 'name/version@user/test'], expected_return_code=ERROR_GENERAL)
self.assertIn("ERROR: [NOT ALLOWED ATTRIBUTES (KB-H039)] Conanfile should not contain attributes: 'scm'", output)

@pytest.mark.skipif(Version(conan_version) < "1.21", reason="requires Conan 1.21 or higher")
def test_no_target_name(self):
conanfile = textwrap.dedent("""\
from conans import ConanFile
class AConan(ConanFile):
def package_info(self):
{}

""")
pkg_config = 'self.cpp_info.names["pkg_config"] = "foolib"'
regular = 'self.cpp_info.name = "Foo"'
cmake = 'self.cpp_info.names["cmake"] = "Foo"'
cmake_multi = 'self.cpp_info.names["cmake_multi"] = "Foo"'
cmake_find = 'self.cpp_info.names["cmake_find_package"] = "Foo"'
cmake_find_multi = 'self.cpp_info.names["cmake_find_package_multi"] = "Foo"'

tools.save('conanfile.py', content=conanfile.replace("{}", regular))
output = self.conan(['create', '.', 'name/version@user/test'])
self.assertIn("ERROR: [NO TARGET NAME (KB-H040)] "
"CCI uses the name of the package for cmake generator."
" Use 'cpp_info.names' instead.", output)

for line, gen in [(cmake, "cmake"), (cmake_multi, "cmake_multi")]:
tools.save('conanfile.py', content=conanfile.replace("{}", line))
output = self.conan(['create', '.', 'name/version@user/test'])
self.assertIn("ERROR: [NO TARGET NAME (KB-H040)] CCI uses the name of the package for "
"{0} generator. Conanfile should not contain "
"'self.cpp_info.names['{0}']'. "
" Use 'cmake_find_package' and 'cmake_find_package_multi' instead.".format(gen), output)

for it in [pkg_config, cmake_find, cmake_find_multi]:
tools.save('conanfile.py', content=conanfile.replace("{}", it))
output = self.conan(['create', '.', 'name/version@user/test'])
self.assertIn("[NO TARGET NAME (KB-H040)] OK", output)

def test_cmake_verbose_makefile(self):
conanfile = self.conanfile_base.format(placeholder="exports_sources = \"CMakeLists.txt\"")

Expand Down
66 changes: 66 additions & 0 deletions tests/test_hooks/conan-center/test_no_target_name.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import os
import textwrap
import pytest

from conans import tools

from tests.utils.test_cases.conan_client import ConanClientTestCase


class TestNoTargetName(ConanClientTestCase):
conanfile = textwrap.dedent("""\
from conans import ConanFile
class AConan(ConanFile):
def package_info(self):
{}

""")

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

def test_with_name(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.name = "Foo"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("ERROR: [NO TARGET NAME (KB-H040)] CCI uses the name of the package for cmake generator and "
"filename by default. Replace 'cpp_info.name' by 'cpp_info.names[<generator>]'.", output)

def test_with_filename(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.filename = "Foobar"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("ERROR: [NO TARGET NAME (KB-H040)] CCI uses the name of the package for cmake generator and "
"filename by default. Replace 'cpp_info.filename' by 'cpp_info.filenames[<generator>]'.", output)

def test_with_cmake_generator(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.names["cmake"] = "Foo"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("ERROR: [NO TARGET NAME (KB-H040)] CCI uses the name of the package for cmake generator. "
"Conanfile should not contain 'self.cpp_info.names['cmake']'. "
"Use 'cmake_find_package' and 'cmake_find_package_multi' instead.", output)

def test_with_cmake_multi_generator(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.names["cmake_multi"] = "Foo"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("ERROR: [NO TARGET NAME (KB-H040)] CCI uses the name of the package for cmake_multi generator. "
"Conanfile should not contain 'self.cpp_info.names['cmake_multi']'. "
"Use 'cmake_find_package' and 'cmake_find_package_multi' instead.", output)

def test_with_pkg_config(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.names["pkg_config"] = "foolib"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("[NO TARGET NAME (KB-H040)] OK", output)

def test_with_cmake_find_package(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.names["cmake_find_package"] = '
'"foolib"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("[NO TARGET NAME (KB-H040)] OK", output)

def test_with_cmake_find_package_multi(self):
tools.save('conanfile.py', content=self.conanfile.replace("{}", 'self.cpp_info.names'
'["cmake_find_package_multi"] = "foolib"'))
output = self.conan(['export', '.', 'name/version@user/test'])
self.assertIn("[NO TARGET NAME (KB-H040)] OK", output)