[feature] Add hooks for validate method

conan/internal/conan_app.py

@@ -44,6 +44,7 @@ def __init__(self, conan_api):
         """
         global_conf = conan_api.config.global_conf
         self.global_conf = global_conf
+        self.conan_api = conan_api
         cache_folder = conan_api.home_folder
         self.cache_folder = cache_folder
         self.cache = PkgCache(self.cache_folder, global_conf)

conans/client/graph/compatibility.py

@@ -106,13 +106,14 @@ def _should_migrate_file(file_path):
 
 class BinaryCompatibility:
 
-    def __init__(self, compatibility_plugin_folder):
+    def __init__(self, compatibility_plugin_folder, hook_manager):
         compatibility_file = os.path.join(compatibility_plugin_folder, "compatibility.py")
         if not os.path.exists(compatibility_file):
             raise ConanException("The 'compatibility.py' plugin file doesn't exist. If you want "
                                  "to disable it, edit its contents instead of removing it")
         mod, _ = load_python_file(compatibility_file)
         self._compatibility = mod.compatibility
+        self._hook_manager = hook_manager
 
     def compatibles(self, conanfile):
         compat_infos = []
@@ -143,7 +144,7 @@ def compatibles(self, conanfile):
             conanfile.settings = c.settings
             conanfile.settings_target = c.settings_target
             conanfile.options = c.options
-            run_validate_package_id(conanfile)
+            run_validate_package_id(conanfile, self._hook_manager)
             pid = c.package_id()
             if pid not in result and not c.invalid:
                 result[pid] = c

conans/client/graph/compute_pid.py

@@ -6,7 +6,7 @@
 from conan.internal.model.info import ConanInfo, RequirementsInfo, RequirementInfo, PythonRequiresInfo
 
 
-def compute_package_id(node, modes, config_version):
+def compute_package_id(node, modes, config_version, hook_manager):
     """
     Compute the binary package ID of this node
     """
@@ -50,7 +50,7 @@ def compute_package_id(node, modes, config_version):
                                config_version=config_version.copy() if config_version else None)
     conanfile.original_info = conanfile.info.clone()
 
-    run_validate_package_id(conanfile)
+    run_validate_package_id(conanfile, hook_manager)
 
     if conanfile.info.settings_target:
         # settings_target has beed added to conan package via package_id api
@@ -60,24 +60,28 @@ def compute_package_id(node, modes, config_version):
     node.package_id = info.package_id()
 
 
-def run_validate_package_id(conanfile):
+def run_validate_package_id(conanfile, hook_manager):
     # IMPORTANT: This validation code must run before calling info.package_id(), to mark "invalid"
     if hasattr(conanfile, "validate_build"):
         with conanfile_exception_formatter(conanfile, "validate_build"):
+            hook_manager.execute("pre_validate_build", conanfile=conanfile)
             with conanfile_remove_attr(conanfile, ['cpp_info'], "validate_build"):
                 try:
                     conanfile.validate_build()
                 except ConanInvalidConfiguration as e:
                     # This 'cant_build' will be ignored if we don't have to build the node.
                     conanfile.info.cant_build = str(e)
+            hook_manager.execute("post_validate_build", conanfile=conanfile)
 
     if hasattr(conanfile, "validate"):
         with conanfile_exception_formatter(conanfile, "validate"):
+            hook_manager.execute("pre_validate", conanfile=conanfile)
             with conanfile_remove_attr(conanfile, ['cpp_info'], "validate"):
                 try:
                     conanfile.validate()
                 except ConanInvalidConfiguration as e:
                     conanfile.info.invalid = str(e)
+            hook_manager.execute("post_validate", conanfile=conanfile)
 
     # Once we are done, call package_id() to narrow and change possible values
     if hasattr(conanfile, "package_id"):

conans/client/graph/graph_binaries.py

@@ -29,10 +29,11 @@ def __init__(self, conan_app, global_conf):
         self._home_folder = conan_app.cache_folder
         self._global_conf = global_conf
         self._remote_manager = conan_app.remote_manager
+        self._hook_manager = conan_app.conan_api.config.hook_manager
         # These are the nodes with pref (not including PREV) that have been evaluated
         self._evaluated = {}  # {pref: [nodes]}
         compat_folder = HomePaths(conan_app.cache_folder).compatibility_plugin_path
-        self._compatibility = BinaryCompatibility(compat_folder)
+        self._compatibility = BinaryCompatibility(compat_folder, self._hook_manager)
         unknown_mode = global_conf.get("core.package_id:default_unknown_mode", default="semver_mode")
         non_embed = global_conf.get("core.package_id:default_non_embed_mode", default="minor_mode")
         # recipe_revision_mode already takes into account the package_id
@@ -397,7 +398,7 @@ def _config_version(self):
         return RequirementsInfo(result)
 
     def _evaluate_package_id(self, node, config_version):
-        compute_package_id(node, self._modes, config_version=config_version)
+        compute_package_id(node, self._modes, config_version, self._hook_manager)
 
         # TODO: layout() execution don't need to be evaluated at GraphBuilder time.
         # it could even be delayed until installation time, but if we got enough info here for
@@ -458,7 +459,7 @@ def _evaluate_single(n):
         if node.path is not None:
             if node.path.endswith(".py"):
                 # For .py we keep evaluating the package_id, validate(), etc
-                compute_package_id(node, self._modes, config_version=config_version)
+                compute_package_id(node, self._modes, config_version, self._hook_manager)
             # To support the ``[layout]`` in conanfile.txt
             if hasattr(node.conanfile, "layout"):
                 with conanfile_exception_formatter(node.conanfile, "layout"):

conans/client/hook_manager.py

@@ -4,6 +4,8 @@
 from conan.errors import ConanException
 
 valid_hook_methods = ["pre_export", "post_export",
+                      "pre_validate_build", "post_validate_build",
+                      "pre_validate", "post_validate",
                       "pre_source", "post_source",
                       "pre_generate", "post_generate",
                       "pre_build", "post_build", "post_build_fail",

test/integration/extensions/hooks/hook_test.py

@@ -1,5 +1,6 @@
 import os
 import textwrap
+import pytest
 
 from conan.test.assets.genconanfile import GenConanfile
 from conan.test.utils.tools import TestClient
@@ -21,6 +22,18 @@ def post_export(conanfile):
     assert conanfile.export_sources_folder, "export_sources_folder not defined"
     assert conanfile.recipe_folder, "recipe_folder not defined"
 
+def pre_validate_build(conanfile):
+    conanfile.output.info("Hello")
+
+def post_validate_build(conanfile):
+    conanfile.output.info("Hello")
+
+def pre_validate(conanfile):
+    conanfile.output.info("Hello")
+
+def post_validate(conanfile):
+    conanfile.output.info("Hello")
+
 def pre_source(conanfile):
     conanfile.output.info("Hello")
     assert conanfile.source_folder, "source_folder not defined"
@@ -111,6 +124,8 @@ def test_complete_hook(self):
         assert f"pkg/0.1: {hook_msg} post_package(): Hello" in c.out
         assert f"pkg/0.1: {hook_msg} pre_package_info(): Hello" in c.out
         assert f"pkg/0.1: {hook_msg} post_package_info(): Hello" in c.out
+        assert "pre_validate_build()" not in c.out
+        assert "post_validate_build()" not in c.out
 
     def test_import_hook(self):
         """ Test that a hook can import another random python file
@@ -176,3 +191,23 @@ def build(self):
         assert "conanfile.py: [HOOK - my_hook/hook_my_hook.py] post_build_fail(): Hello" in c.out
         assert "ERROR: conanfile.py: Error in build() method, line 5" in c.out
 
+    @pytest.mark.parametrize("method", ["validate_build", "validate"])
+    def test_validate_hook(self, method):
+        """ The validate_build and validate hooks are executed only if the method is declared
+            in the recipe.
+        """
+        c = TestClient()
+        hook_path = os.path.join(c.paths.hooks_path, "testing", "hook_complete.py")
+        save(hook_path, complete_hook)
+
+        conanfile = textwrap.dedent("""
+            from conan import ConanFile
+            class Pkg(ConanFile):
+                def {method}(self):
+                    pass
+            """.format(method=method))
+        c.save({"conanfile.py": conanfile})
+
+        c.run("create . --name=foo --version=0.1.0")
+        assert f"foo/0.1.0: [HOOK - testing/hook_complete.py] pre_{method}(): Hello" in c.out
+        assert f"foo/0.1.0: [HOOK - testing/hook_complete.py] post_{method}(): Hello" in c.out