MDBF-143: prep - CMakeGenerator - add builddir

The builddir doesn't need to be the current dir. This
adds builddir as an option with its default value of None
meaning that the previous default behaviour is observed.

builddir as chosen for consistency with the CompileCMake command
and it looks a little out of place beside source_path in consistency
of naming.

Also source_path uses a CMake -S argument rather than just defaulting
to this source_path value for additional clarity.

Author: grooverdan

configuration/steps/generators/cmake/generator.py

@@ -21,6 +21,7 @@ def __init__(
         use_ccache: bool = False,
         compiler: CompilerCommand = None,
         source_path: str = ".",
+        builddir: str = None,
     ):
         """
         Initializes the CMakeGenerator with an optional list of flags.
@@ -31,8 +32,12 @@ def __init__(
             compiler: An instance of CompilerCommand if you want to set it explicitly.
             source_path: The source path to the base CMakeLists.txt file.
                          Default path is "in source build".
+            builddir: The path of the build directory. Default is None.
         """
-        super().__init__(base_cmd=["cmake", source_path], flags=flags)
+        base_command=["cmake", "-S", source_path]
+        if builddir:
+            base_command+=["-B", builddir]
+        super().__init__(base_cmd=base_command, flags=flags)
 
         if use_ccache:
             self._use_ccache()

configuration/test/unit/test_cmake_generator.py

@@ -28,7 +28,7 @@ def test_initialization_with_flags(self):
             command,
             [
                 "cmake",
-                ".",
+                "-S" ".",
                 "-DCMAKE_BUILD_TYPE=RelWithDebInfo",
                 "-DCMAKE_INSTALL_PREFIX=/usr/local",
                 "-DPLUGIN_ARCHIVE=YES",
@@ -52,7 +52,7 @@ def test_append_flags_successful(self):
             command,
             [
                 "cmake",
-                ".",
+                "-S" ".",
                 "-DCMAKE_AR=ar",
                 "-DCMAKE_LIBRARY_PATH=/usr/lib",
             ],
@@ -79,7 +79,7 @@ def test_set_compiler(self):
             command,
             [
                 "cmake",
-                ".",
+                "-S" ".",
                 "-DCMAKE_CXX_COMPILER=g++",
                 "-DCMAKE_C_COMPILER=gcc",
             ],
@@ -95,7 +95,7 @@ def test_use_ccache(self):
             command,
             [
                 "cmake",
-                ".",
+                "-S" ".",
                 "-DCMAKE_CXX_COMPILER_LAUNCHER=ccache",
                 "-DCMAKE_C_COMPILER_LAUNCHER=ccache",
             ],
@@ -108,7 +108,7 @@ def test_generate_with_no_flags(self):
         """
         generator = CMakeGenerator(flags=[])
         command = generator.generate()
-        self.assertEqual(command, ["cmake", "."])
+        self.assertEqual(command, ["cmake", "-S", "."])
 
     def test_set_build_config(self):
         """
@@ -124,7 +124,7 @@ def test_set_build_config(self):
             command,
             [
                 "cmake",
-                ".",
+                "-S" ".",
                 "-DBUILD_CONFIG=mysql_release",
             ],
         )
@@ -158,7 +158,7 @@ def test_set_build_config_with_other_flags(self):
             command,
             [
                 "cmake",
-                ".",
+                "-S" ".",
                 "-DBUILD_CONFIG=mysql_release",
                 "-DCMAKE_INSTALL_PREFIX=/usr/lib/test",
             ],