CMake.ctest() runner new tools.cmake:ctest_args conf (#19198)

* CMake.ctest() runner new tools.cmake:ctest_args conf

* remove --quiet when necessary

* remove managemnt of --quiet

* fix test

Author: memsharded

conan/internal/model/conf.py

@@ -93,6 +93,7 @@
     "tools.cmake.cmake_layout:test_folder": "(Experimental) Allow configuring the base folder of the build for test_package",
     "tools.cmake:cmake_program": "Path to CMake executable",
     "tools.cmake.cmakedeps:new": "Use the new CMakeDeps generator",
+    "tools.cmake:ctest_args": "To inject list of arguments to CMake.ctest() runner",
     "tools.cmake:install_strip": "(Deprecated) Add --strip to cmake.install(). Use tools.build:install_strip instead",
     "tools.deployer:symlinks": "Set to False to disable deployers copying symlinks",
     "tools.files.download:retry": "Number of retries in case of failure when downloading",

conan/tools/cmake/cmake.py

@@ -68,8 +68,8 @@ def configure(self, variables=None, build_script_folder=None, cli_args=None,
         :ref:`CMakeToolchain<conan-cmake-toolchain>` to get:
 
            - The generator, to append ``-G="xxx"``.
-           - The path to the toolchain and append ``-DCMAKE_TOOLCHAIN_FILE=/path/conan_toolchain.cmake``
-           - The declared ``cache variables`` and append ``-Dxxx``.
+           - Toolchain path to append ``-DCMAKE_TOOLCHAIN_FILE=/path/conan_toolchain.cmake``
+           - The declared ``cache variables`` to append ``-Dxxx``.
 
         and call ``cmake``.
 
@@ -83,9 +83,9 @@ def configure(self, variables=None, build_script_folder=None, cli_args=None,
                                     ``self.folders.source`` at the ``layout()`` method.
         :param cli_args: List of arguments ``[arg1, arg2, ...]`` that will be passed
                          as extra CLI arguments to pass to cmake invocation
-        :param subfolder: (Experimental): The name of a subfolder to be created inside the ``build_folder``
-                                          and the ``package_folder``. If not provided, files will be placed
-                                          in the ``build_folder`` and the ``package_folder`` root.
+        :param subfolder: (Experimental): subfolder to be created inside the ``build_folder`` and
+                                          the ``package_folder``. If not provided, files will be
+                                          placed in the ``build_folder`` and ``package_folder`` root.
         :param stdout: Use it to redirect stdout to this stream
         :param stderr: Use it to redirect stderr to this stream
         """
@@ -186,23 +186,25 @@ def build(self, build_type=None, target=None, cli_args=None, build_tool_args=Non
                            for a multi-configuration generator (e.g. Visual Studio, XCode).
                            This value will be ignored for single-configuration generators, they will
                            use the one defined in the toolchain file during the install step.
-        :param target: The name of a single build target as a string, or names of multiple build targets in a
-                       list of strings to be passed to the ``--target`` argument.
+        :param target: The name of a single build target as a string, or names of multiple build
+                       targets in a list of strings to be passed to the ``--target`` argument.
         :param cli_args: A list of arguments ``[arg1, arg2, ...]`` that will be passed to the
                          ``cmake --build ... arg1 arg2`` command directly.
         :param build_tool_args: A list of arguments ``[barg1, barg2, ...]`` for the underlying
                                 build system that will be passed to the command
                                 line after the ``--`` indicator: ``cmake --build ... -- barg1 barg2``
-        :param subfolder: (Experimental): The name of a subfolder to be created inside the ``build_folder``
-                                          and the ``package_folder``. If not provided, files will be placed
-                                          in the ``build_folder`` and the ``package_folder`` root.
+        :param subfolder: (Experimental): subfolder to be created inside the ``build_folder`` and
+                                          the ``package_folder``. If not provided, files will be
+                                          placed in the ``build_folder`` and ``package_folder`` root.
         :param stdout: Use it to redirect stdout to this stream
         :param stderr: Use it to redirect stderr to this stream
         """
         self._conanfile.output.info("Running CMake.build()")
-        self._build(build_type, target, cli_args, build_tool_args, subfolder=subfolder, stdout=stdout, stderr=stderr)
+        self._build(build_type, target, cli_args, build_tool_args, subfolder=subfolder,
+                    stdout=stdout, stderr=stderr)
 
-    def install(self, build_type=None, component=None, cli_args=None, stdout=None, stderr=None, subfolder=None):
+    def install(self, build_type=None, component=None, cli_args=None, stdout=None, stderr=None,
+                subfolder=None):
         """
         Equivalent to running ``cmake --install``
 
@@ -213,9 +215,9 @@ def install(self, build_type=None, component=None, cli_args=None, stdout=None, s
                            not build type.
         :param cli_args: A list of arguments ``[arg1, arg2, ...]`` for the underlying build system
                          that will be passed to the command line: ``cmake --install ... arg1 arg2``
-        :param subfolder: (Experimental): The name of a subfolder to be created inside the ``build_folder``
-                                          and the ``package_folder``. If not provided, files will be placed
-                                          in the ``build_folder`` and the ``package_folder`` root.
+        :param subfolder: (Experimental): subfolder to be created inside the ``build_folder`` and
+                                          the ``package_folder``. If not provided, files will be
+                                          placed in the ``build_folder`` and ``package_folder`` root.
         :param stdout: Use it to redirect stdout to this stream
         :param stderr: Use it to redirect stderr to this stream
         """
@@ -236,10 +238,12 @@ def install(self, build_type=None, component=None, cli_args=None, stdout=None, s
             arg_list.extend(["--component", component])
         arg_list.extend(self._compilation_verbosity_arg)
 
-        deprecated_install_strip = self._conanfile.conf.get("tools.cmake:install_strip", check_type=bool)
+        deprecated_install_strip = self._conanfile.conf.get("tools.cmake:install_strip",
+                                                            check_type=bool)
         if deprecated_install_strip:
-            self._conanfile.output.warning("The 'tools.cmake:install_strip' configuration is deprecated, "
-                                           "use 'tools.build:install_strip' instead.", warn_tag="deprecated")
+            self._conanfile.output.warning("The 'tools.cmake:install_strip' configuration is "
+                                           "deprecated, use 'tools.build:install_strip' instead.",
+                                           warn_tag="deprecated")
 
         do_strip = self._conanfile.conf.get("tools.build:install_strip", check_type=bool)
         if do_strip or deprecated_install_strip:
@@ -287,7 +291,8 @@ def ctest(self, cli_args=None, env="", stdout=None, stderr=None):
         """
         Equivalent to running ctest ...
 
-        :param cli_args: List of arguments ``[arg1, arg2, ...]`` to be passed as extra ctest command line arguments
+        :param cli_args: List of arguments ``[arg1, arg2, ...]`` to be passed as extra ctest
+                         command line arguments
         :param env: the environment files to activate, by default conanbuild + conanrun
         :param stdout: Use it to redirect stdout to this stream
         :param stderr: Use it to redirect stderr to this stream
@@ -304,11 +309,19 @@ def ctest(self, cli_args=None, env="", stdout=None, stderr=None):
         if njobs:
             arg_list.append(f"--parallel {njobs}")
 
+        arg_list.extend(cli_args or [])
+
         verbosity = self._conanfile.conf.get("tools.build:verbosity", choices=("quiet", "verbose"))
         if verbosity:
+            # https://cmake.org/cmake/help/latest/manual/ctest.1.html
+            # Options such as --verbose, --extra-verbose, and --debug are
+            # ignored if --quiet is specified.
             arg_list.append(f"--{verbosity}")
 
-        arg_list.extend(cli_args or [])
+        extra_args = self._conanfile.conf.get("tools.cmake:ctest_args", check_type=list)
+        if extra_args:
+            arg_list.extend(extra_args)
+
         arg_list = " ".join(filter(None, arg_list))
         command = f"ctest {arg_list}"
 

test/unittests/tools/cmake/test_cmake_install.py

@@ -10,7 +10,6 @@
 from conan.test.utils.tools import redirect_output
 
 
-
 def test_run_install_component():
     """
     Testing that the proper component is installed.
@@ -80,6 +79,7 @@ def test_run_install_strip(config, deprecated):
         assert "tools.cmake:install_strip" not in stderr
     assert "--strip" in conanfile.command
 
+
 def test_run_install_cli_args():
     """
     Testing that the passing cli_args to install works

test/unittests/tools/cmake/test_cmake_test.py

@@ -58,3 +58,27 @@ def test_cli_args_configure():
     cmake = CMake(conanfile)
     cmake.configure(cli_args=["--graphviz=foo.dot"])
     assert "--graphviz=foo.dot" in conanfile.command
+
+
+def test_run_ctest():
+    settings = Settings.loads(default_settings_yml)
+    settings.os = "Windows"
+    settings.arch = "x86"
+    settings.build_type = "Release"
+    settings.compiler = "msvc"
+    settings.compiler.runtime = "dynamic"
+    settings.compiler.version = "193"
+
+    conanfile = ConanFileMock()
+    conanfile.conf = Conf()
+    conanfile.conf.define("tools.cmake:ctest_args", ["--debug", "--output-junit myfile"])
+    conanfile.conf.define("tools.build:verbosity", "verbose")
+
+    conanfile.folders.generators = "."
+    conanfile.folders.set_base_generators(temp_folder())
+    conanfile.settings = settings
+
+    write_cmake_presets(conanfile, "toolchain", "Ninja", {})
+    cmake = CMake(conanfile)
+    cmake.ctest(cli_args=["--schedule-random", "--quiet"])
+    assert "--schedule-random --quiet --verbose --debug --output-junit myfile" in conanfile.command