new CMakeDeps defines components (conan-io#17302)

* new CMakeDeps defines components

* avoid flaky tests

* fix

* skip private components

* per-component info too

Author: memsharded

conan/tools/cmake/cmakedeps2/cmakedeps.py

@@ -116,8 +116,11 @@ def get_property(self, prop, dep, comp_name=None, check_type=None):
         except KeyError:
             # Here we are not using the cpp_info = deduce_cpp_info(dep) because it is not
             # necessary for the properties
-            return dep.cpp_info.get_property(prop, check_type=check_type) if not comp_name \
-                else dep.cpp_info.components[comp_name].get_property(prop, check_type=check_type)
+            if not comp_name:
+                return dep.cpp_info.get_property(prop, check_type=check_type)
+            comp = dep.cpp_info.components.get(comp_name)  # it is a default dict
+            if comp is not None:
+                return comp.get_property(prop, check_type=check_type)
 
     def get_cmake_filename(self, dep, module_mode=None):
         """Get the name of the file for the find_package(XXX)"""

conan/tools/cmake/cmakedeps2/config.py

@@ -33,7 +33,28 @@ def _context(self):
         # FIXME: Proper escaping of paths for CMake and relativization
         # FIXME: build_module_paths coming from last config only
         build_modules_paths = [f.replace("\\", "/") for f in build_modules_paths]
-        return {"pkg_name": pkg_name,
+        components = self._cmakedeps.get_property("cmake_components", self._conanfile,
+                                                  check_type=list)
+        if components is None:  # Lets compute the default components names
+            components = []
+            # This assumes that cmake_components is only defined with not multi .libs=[lib1, lib2]
+            for name in self._conanfile.cpp_info.components:
+                if name.startswith("_"):  # Skip private components
+                    continue
+                comp_components = self._cmakedeps.get_property("cmake_components", self._conanfile,
+                                                               name, check_type=list)
+                if comp_components:
+                    components.extend(comp_components)
+                else:
+                    cmakename = self._cmakedeps.get_property("cmake_target_name", self._conanfile,
+                                                             name)
+                    if cmakename and "::" in cmakename:  # Remove package namespace
+                        cmakename = cmakename.split("::", 1)[1]
+                    components.append(cmakename or name)
+        components = " ".join(components) if components else ""
+        return {"filename": f,
+                "components": components,
+                "pkg_name": pkg_name,
                 "targets_include_file": targets_include,
                 "build_modules_paths": build_modules_paths}
 
@@ -58,4 +79,16 @@ def _template(self):
         message(STATUS "Conan: Including build module from '{{build_module}}'")
         include("{{ build_module }}")
         {% endfor %}
+
+        {% if components %}
+        set({{filename}}_PACKAGE_PROVIDED_COMPONENTS {{components}})
+        foreach(comp {%raw%}${{%endraw%}{{filename}}_FIND_COMPONENTS})
+          if(NOT ${comp} IN_LIST {{filename}}_PACKAGE_PROVIDED_COMPONENTS)
+            if({%raw%}${{%endraw%}{{filename}}_FIND_REQUIRED_${comp}})
+              message(STATUS "Conan: Error: '{{pkg_name}}' required COMPONENT '${comp}' not found")
+              set({{filename}}_FOUND FALSE)
+            endif()
+          endif()
+        endforeach()
+        {% endif %}
         """)

conan/tools/cmake/cmakedeps2/targets.py

@@ -32,7 +32,7 @@ def _context(self):
     @property
     def _template(self):
         return textwrap.dedent("""\
-            message(STATUS "Configuring Targets for {{ ref }}")
+            message(STATUS "Conan: Configuring Targets for {{ ref }}")
 
             # Load information for each installed configuration.
             file(GLOB _target_files "${CMAKE_CURRENT_LIST_DIR}/{{filename}}-Targets-*.cmake")

test/functional/toolchains/cmake/cmakedeps/test_cmakedeps_new.py

@@ -1164,3 +1164,85 @@ def generate(self):
         preset = "conan-default" if platform.system() == "Windows" else "conan-release"
         c.run_command(f"cmake --preset {preset} ")
         assert "Performing Test IT_COMPILES - Success" in c.out
+
+
+class TestCMakeComponents:
+
+    @pytest.mark.tool("cmake")
+    @pytest.mark.parametrize("components, found", [("comp1", True), ("compX", False)])
+    def test_components(self, components, found):
+        c = TestClient()
+        dep = textwrap.dedent("""
+            from conan import ConanFile
+            class Pkg(ConanFile):
+                name = "dep"
+                version = "0.1"
+                def package_info(self):
+                    self.cpp_info.set_property("cmake_components", ["comp1", "comp2"])
+            """)
+        c.save({"conanfile.py": dep})
+        c.run("create .")
+
+        consumer = textwrap.dedent("""
+            from conan import ConanFile
+            from conan.tools.cmake import CMake
+            class PkgConan(ConanFile):
+                settings = "os", "arch", "compiler", "build_type"
+                requires = "dep/0.1"
+                generators = "CMakeToolchain", "CMakeDeps"
+                def build(self):
+                    deps = CMake(self)
+                    deps.configure()
+            """)
+
+        cmakelist = textwrap.dedent(f"""\
+            cmake_minimum_required(VERSION 3.15)
+            project(Hello LANGUAGES NONE)
+
+            find_package(dep CONFIG REQUIRED COMPONENTS {components})
+            """)
+
+        c.save({"conanfile.py": consumer,
+                "CMakeLists.txt": cmakelist}, clean_first=True)
+        c.run(f"build . -c tools.cmake.cmakedeps:new={new_value}", assert_error=not found)
+        if not found:
+            assert f"Conan: Error: 'dep' required COMPONENT '{components}' not found" in c.out
+
+    def test_components_default_definition(self):
+        c = TestClient()
+        dep = textwrap.dedent("""
+            from conan import ConanFile
+            class Pkg(ConanFile):
+                name = "dep"
+                version = "0.1"
+                def package_info(self):
+                    # private component that should be skipped
+                    self.cpp_info.components["_private"].includedirs = ["include"]
+                    self.cpp_info.components["c1"].set_property("cmake_target_name", "MyC1")
+                    self.cpp_info.components["c2"].set_property("cmake_target_name", "Dep::MyC2")
+                    self.cpp_info.components["c3"].includedirs = ["include"]
+            """)
+        c.save({"conanfile.py": dep})
+        c.run("create .")
+        c.run(f"install --requires=dep/0.1 -g CMakeDeps -c tools.cmake.cmakedeps:new={new_value}")
+        cmake = c.load("dep-config.cmake")
+        assert 'set(dep_PACKAGE_PROVIDED_COMPONENTS MyC1 MyC2 c3)' in cmake
+
+    def test_components_individual_names(self):
+        c = TestClient()
+        dep = textwrap.dedent("""
+            from conan import ConanFile
+            class Pkg(ConanFile):
+                name = "dep"
+                version = "0.1"
+                def package_info(self):
+                    self.cpp_info.components["c1"].set_property("cmake_target_name", "MyC1")
+                    self.cpp_info.components["c1"].set_property("cmake_components", ["MyCompC1"])
+                    self.cpp_info.components["c2"].set_property("cmake_target_name", "Dep::MyC2")
+                    self.cpp_info.components["c3"].includedirs = ["include"]
+            """)
+        c.save({"conanfile.py": dep})
+        c.run("create .")
+        c.run(f"install --requires=dep/0.1 -g CMakeDeps -c tools.cmake.cmakedeps:new={new_value}")
+        cmake = c.load("dep-config.cmake")
+        assert 'set(dep_PACKAGE_PROVIDED_COMPONENTS MyCompC1 MyC2 c3)' in cmake

test/integration/lockfile/test_ci.py

@@ -202,7 +202,7 @@ def test_single_config_centralized_change_dep(client_setup):
     c.run("install --requires=app1/0.1@  --lockfile=app1_b_changed.lock "
           "--lockfile-out=app1_b_integrated.lock "
           "--build=missing  -s os=Windows")
-    assert "pkga" not in c.out
+    assert "pkga/" not in c.out
     c.assert_listed_binary({"pkgj/0.1": (pkgawin_01_id, "Cache"),
                             "pkgb/0.2": ("79caa65bc5877c4ada84a2b454775f47a5045d59", "Cache"),
                             "pkgc/0.1": ("67e4e9b17f41a4c71ff449eb29eb716b8f83767b", "Build"),

test/integration/lockfile/test_ci_revisions.py

@@ -208,7 +208,7 @@ def test_single_config_centralized_change_dep(client_setup):
     c.run("install --requires=app1/0.1@  --lockfile=app1_b_changed.lock "
           "--lockfile-out=app1_b_integrated.lock "
           "--build=missing  -s os=Windows")
-    assert "pkga" not in c.out
+    assert "pkga/" not in c.out
     c.assert_listed_binary({"pkgj/0.1": (pkgawin_01_id, "Cache"),
                             "pkgb/0.1": ("6142fb85ccd4e94afad85a8d01a87234eefa5600", "Cache"),
                             "pkgc/0.1": ("93cfcbc8109eedf4211558258ff5a844fdb62cca", "Build"),