Add BinaryDir Stubbing

Author: Behemyth

cppython/plugins/cmake/builder.py

@@ -114,20 +114,24 @@ def write_cppython_preset(
         return cppython_preset_file
 
     @staticmethod
-    def generate_root_preset(preset_file: Path, cppython_preset_file: Path, cmake_data: CMakeData) -> CMakePresets:
+    def generate_root_preset(
+        preset_file: Path, cppython_preset_file: Path, cmake_data: CMakeData, build_directory: Path
+    ) -> CMakePresets:
         """Generates the top level root preset with the include reference.
 
         Args:
             preset_file: Preset file to modify
             cppython_preset_file: Path to the cppython preset file to include
             cmake_data: The CMake data to use
+            build_directory: The build directory to use
 
         Returns:
             A CMakePresets object
         """
         default_configure_preset = ConfigurePreset(
             name=cmake_data.configuration_name,
             inherits='cppython',
+            binaryDir=build_directory.as_posix(),
         )
 
         if preset_file.exists():
@@ -170,7 +174,9 @@ def generate_root_preset(preset_file: Path, cppython_preset_file: Path, cmake_da
         return root_preset
 
     @staticmethod
-    def write_root_presets(preset_file: Path, cppython_preset_file: Path, cmake_data: CMakeData) -> None:
+    def write_root_presets(
+        preset_file: Path, cppython_preset_file: Path, cmake_data: CMakeData, build_directory: Path
+    ) -> None:
         """Read the top level json file and insert the include reference.
 
         Receives a relative path to the tool cmake json file
@@ -182,6 +188,7 @@ def write_root_presets(preset_file: Path, cppython_preset_file: Path, cmake_data
             preset_file: Preset file to modify
             cppython_preset_file: Path to the cppython preset file to include
             cmake_data: The CMake data to use
+            build_directory: The build directory to use
         """
         initial_root_preset = None
 
@@ -190,7 +197,7 @@ def write_root_presets(preset_file: Path, cppython_preset_file: Path, cmake_data
                 initial_json = file.read()
             initial_root_preset = CMakePresets.model_validate_json(initial_json)
 
-        root_preset = Builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data)
+        root_preset = Builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data, build_directory)
 
         # Only write the file if the data has changed
         if root_preset != initial_root_preset:

cppython/plugins/cmake/plugin.py

@@ -71,6 +71,8 @@ def sync(self, sync_data: SyncData) -> None:
                     self._cppython_preset_directory, self._provider_directory, sync_data
                 )
 
-                self.builder.write_root_presets(self.data.preset_file, cppython_preset_file, self.data)
+                self.builder.write_root_presets(
+                    self.data.preset_file, cppython_preset_file, self.data, self.core_data.cppython_data.build_path
+                )
             case _:
                 raise ValueError('Unsupported sync data type')

cppython/plugins/cmake/schema.py

@@ -54,6 +54,10 @@ class ConfigurePreset(CPPythonModel, extra='allow'):
     inherits: Annotated[
         str | list[str] | None, Field(description='The inherits field allows inheriting from other presets.')
     ] = None
+    binaryDir: Annotated[
+        str | None,
+        Field(description='The path to the output binary directory.'),
+    ] = None
     cacheVariables: dict[str, None | bool | str | CacheVariable] | None = None
 
 

tests/integration/examples/test_conan_cmake.py

@@ -28,5 +28,7 @@ def test_simple(example_runner: CliRunner) -> None:
 
         assert result.returncode == 0, f'Cmake failed: {result.stderr}'
 
+        path = Path('build').absolute()
+
         # Verify that the build directory contains the expected files
-        assert (Path('build') / 'CMakeCache.txt').exists(), 'build/CMakeCache.txt not found'
+        assert (path / 'CMakeCache.txt').exists(), f'{path / "CMakeCache.txt"} not found'

tests/unit/plugins/cmake/test_presets.py

@@ -2,6 +2,7 @@
 
 from pathlib import Path
 
+from cppython.core.schema import ProjectData
 from cppython.plugins.cmake.builder import Builder
 from cppython.plugins.cmake.schema import CMakeData, CMakePresets, CMakeSyncData
 from cppython.utility.utility import TypeName
@@ -11,36 +12,40 @@ class TestBuilder:
     """Tests for the CMakePresets class"""
 
     @staticmethod
-    def test_generate_root_preset_new(tmp_path: Path) -> None:
+    def test_generate_root_preset_new(project_data: ProjectData) -> None:
         """Test generate_root_preset when the preset file does not exist"""
         builder = Builder()
-        preset_file = tmp_path / 'CMakePresets.json'
-        cppython_preset_file = tmp_path / 'cppython.json'
+        preset_file = project_data.project_root / 'CMakePresets.json'
+        cppython_preset_file = project_data.project_root / 'cppython.json'
         cmake_data = CMakeData(preset_file=preset_file, configuration_name='test-configuration')
 
+        build_directory = project_data.project_root / 'build'
+
         # The function should create a new preset with the correct name and inheritance
-        result = builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data)
+        result = builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data, build_directory)
         assert result.configurePresets is not None
         assert any(p.name == 'test-configuration' for p in result.configurePresets)
 
         preset = next(p for p in result.configurePresets if p.name == 'test-configuration')
         assert preset.inherits == 'cppython'
 
     @staticmethod
-    def test_generate_root_preset_existing(tmp_path: Path) -> None:
+    def test_generate_root_preset_existing(project_data: ProjectData) -> None:
         """Test generate_root_preset when the preset file already exists"""
         builder = Builder()
-        preset_file = tmp_path / 'CMakePresets.json'
-        cppython_preset_file = tmp_path / 'cppython.json'
+        preset_file = project_data.project_root / 'CMakePresets.json'
+        cppython_preset_file = project_data.project_root / 'cppython.json'
         cmake_data = CMakeData(preset_file=preset_file, configuration_name='test-configuration')
 
         # Create an initial preset file with a different preset
         initial_presets = CMakePresets(configurePresets=[])
         with open(preset_file, 'w', encoding='utf-8') as f:
             f.write(initial_presets.model_dump_json(exclude_none=True, by_alias=False, indent=4))
 
+        build_directory = project_data.project_root / 'build'
+
         # Should add the new preset and include
-        result = builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data)
+        result = builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data, build_directory)
         assert result.configurePresets is not None
         assert any(p.name == 'test-configuration' for p in result.configurePresets)
 
@@ -86,15 +91,15 @@ def test_cppython_write(tmp_path: Path) -> None:
         builder.write_cppython_preset(tmp_path, provider_directory, data)
 
     @staticmethod
-    def test_root_write(tmp_path: Path) -> None:
+    def test_root_write(project_data: ProjectData) -> None:
         """Verifies that the root preset writing works as intended
 
         Args:
-            tmp_path: The input path the use
+            project_data: The project data with a temporary workspace
         """
         builder = Builder()
 
-        cppython_preset_directory = tmp_path / 'cppython'
+        cppython_preset_directory = project_data.project_root / 'cppython'
         cppython_preset_directory.mkdir(parents=True, exist_ok=True)
 
         provider_directory = cppython_preset_directory / 'providers'
@@ -104,7 +109,7 @@ def test_root_write(tmp_path: Path) -> None:
         with includes_file.open('w', encoding='utf-8') as file:
             file.write('example contents')
 
-        root_file = tmp_path / 'CMakePresets.json'
+        root_file = project_data.project_root / 'CMakePresets.json'
         presets = CMakePresets()
 
         serialized = presets.model_dump_json(exclude_none=True, by_alias=False, indent=4)
@@ -116,20 +121,24 @@ def test_root_write(tmp_path: Path) -> None:
 
         cppython_preset_file = builder.write_cppython_preset(cppython_preset_directory, provider_directory, data)
 
+        build_directory = project_data.project_root / 'build'
         builder.write_root_presets(
-            root_file, cppython_preset_file, CMakeData(preset_file=root_file, configuration_name='default')
+            root_file,
+            cppython_preset_file,
+            CMakeData(preset_file=root_file, configuration_name='default'),
+            build_directory,
         )
 
     @staticmethod
-    def test_relative_root_write(tmp_path: Path) -> None:
+    def test_relative_root_write(project_data: ProjectData) -> None:
         """Verifies that the root preset writing works as intended
 
         Args:
-            tmp_path: The input path the use
+            project_data: The project data with a temporary workspace
         """
         builder = Builder()
 
-        cppython_preset_directory = tmp_path / 'tool' / 'cppython'
+        cppython_preset_directory = project_data.project_root / 'tool' / 'cppython'
         cppython_preset_directory.mkdir(parents=True, exist_ok=True)
 
         provider_directory = cppython_preset_directory / 'providers'
@@ -139,7 +148,7 @@ def test_relative_root_write(tmp_path: Path) -> None:
         with includes_file.open('w', encoding='utf-8') as file:
             file.write('example contents')
 
-        relative_indirection = tmp_path / 'nested'
+        relative_indirection = project_data.project_root / 'nested'
         relative_indirection.mkdir(parents=True, exist_ok=True)
 
         root_file = relative_indirection / 'CMakePresets.json'
@@ -152,6 +161,11 @@ def test_relative_root_write(tmp_path: Path) -> None:
         builder.write_provider_preset(provider_directory, data)
 
         cppython_preset_file = builder.write_cppython_preset(cppython_preset_directory, provider_directory, data)
+
+        build_directory = project_data.project_root / 'build'
         builder.write_root_presets(
-            root_file, cppython_preset_file, CMakeData(preset_file=root_file, configuration_name='default')
+            root_file,
+            cppython_preset_file,
+            CMakeData(preset_file=root_file, configuration_name='default'),
+            build_directory,
         )