Add CMake Conditional Inheritance

Author: Behemyth

cppython/plugins/cmake/builder.py

@@ -2,7 +2,7 @@
 
 from pathlib import Path
 
-from cppython.plugins.cmake.schema import CMakePresets, CMakeSyncData, ConfigurePreset
+from cppython.plugins.cmake.schema import CMakeData, CMakePresets, CMakeSyncData, ConfigurePreset
 
 
 class Builder:
@@ -114,7 +114,7 @@ def write_cppython_preset(
         return cppython_preset_file
 
     @staticmethod
-    def generate_root_preset(preset_file: Path, cppython_preset_file: Path) -> CMakePresets:
+    def generate_root_preset(preset_file: Path, cppython_preset_file: Path, cmake_data: CMakeData) -> CMakePresets:
         """Generates the top level root preset with the include reference.
 
         Args:
@@ -124,18 +124,34 @@ def generate_root_preset(preset_file: Path, cppython_preset_file: Path) -> CMake
         Returns:
             A CMakePresets object
         """
-        initial_root_preset = None
+        default_configure_preset = ConfigurePreset(
+            name=cmake_data.configuration_name,
+            inherits='cppython',
+        )
 
-        # If the file already exists, we need to compare it
         if preset_file.exists():
             with open(preset_file, encoding='utf-8') as file:
                 initial_json = file.read()
-            initial_root_preset = CMakePresets.model_validate_json(initial_json)
-            root_preset = initial_root_preset.model_copy(deep=True)
+            root_preset = CMakePresets.model_validate_json(initial_json)
+
+            if root_preset.configurePresets is None:
+                root_preset.configurePresets = [default_configure_preset]
+
+            # Set defaults
+            preset = next((p for p in root_preset.configurePresets if p.name == default_configure_preset.name), None)
+            if preset:
+                # If the name matches, we need to verify it inherits from cppython
+                if preset.inherits is None:
+                    preset.inherits = 'cppython'
+                elif isinstance(preset.inherits, str) and preset.inherits != 'cppython':
+                    preset.inherits = [preset.inherits, 'cppython']
+                elif isinstance(preset.inherits, list) and 'cppython' not in preset.inherits:
+                    preset.inherits.append('cppython')
+            else:
+                root_preset.configurePresets.append(default_configure_preset)
+
         else:
             # If the file doesn't exist, we need to default it for the user
-            # TODO: Forward the tool's build directory
-            default_configure_preset = ConfigurePreset(name='default', inherits='cppython', binaryDir='build')
             root_preset = CMakePresets(configurePresets=[default_configure_preset])
 
         # Get the relative path to the cppython preset file
@@ -153,7 +169,7 @@ def generate_root_preset(preset_file: Path, cppython_preset_file: Path) -> CMake
         return root_preset
 
     @staticmethod
-    def write_root_presets(preset_file: Path, cppython_preset_file: Path) -> None:
+    def write_root_presets(preset_file: Path, cppython_preset_file: Path, cmake_data: CMakeData) -> None:
         """Read the top level json file and insert the include reference.
 
         Receives a relative path to the tool cmake json file
@@ -172,7 +188,7 @@ def write_root_presets(preset_file: Path, cppython_preset_file: Path) -> None:
                 initial_json = file.read()
             initial_root_preset = CMakePresets.model_validate_json(initial_json)
 
-        root_preset = Builder.generate_root_preset(preset_file, cppython_preset_file)
+        root_preset = Builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data)
 
         # Only write the file if the data has changed
         if root_preset != initial_root_preset:

cppython/plugins/cmake/plugin.py

@@ -71,6 +71,6 @@ 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.builder.write_root_presets(self.data.preset_file, cppython_preset_file, self.data)
             case _:
                 raise ValueError('Unsupported sync data type')

tests/unit/plugins/cmake/test_presets.py

@@ -3,13 +3,51 @@
 from pathlib import Path
 
 from cppython.plugins.cmake.builder import Builder
-from cppython.plugins.cmake.schema import CMakePresets, CMakeSyncData
+from cppython.plugins.cmake.schema import CMakeData, CMakePresets, CMakeSyncData
 from cppython.utility.utility import TypeName
 
 
-class TestCMakePresets:
+class TestBuilder:
     """Tests for the CMakePresets class"""
 
+    @staticmethod
+    def test_generate_root_preset_new(tmp_path: Path) -> 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'
+        cmake_data = CMakeData(preset_file=preset_file, configuration_name='test-configuration')
+
+        # 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)
+        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:
+        """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'
+        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))
+
+        # Should add the new preset and include
+        result = builder.generate_root_preset(preset_file, cppython_preset_file, cmake_data)
+        assert result.configurePresets is not None
+        assert any(p.name == 'test-configuration' for p in result.configurePresets)
+
+
+class TestWrites:
+    """Tests for writing the CMakePresets class"""
+
     @staticmethod
     def test_provider_write(tmp_path: Path) -> None:
         """Verifies that the provider preset writing works as intended
@@ -78,7 +116,9 @@ def test_root_write(tmp_path: Path) -> None:
 
         cppython_preset_file = builder.write_cppython_preset(cppython_preset_directory, provider_directory, data)
 
-        builder.write_root_presets(root_file, cppython_preset_file)
+        builder.write_root_presets(
+            root_file, cppython_preset_file, CMakeData(preset_file=root_file, configuration_name='default')
+        )
 
     @staticmethod
     def test_relative_root_write(tmp_path: Path) -> None:
@@ -112,4 +152,6 @@ 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)
-        builder.write_root_presets(root_file, cppython_preset_file)
+        builder.write_root_presets(
+            root_file, cppython_preset_file, CMakeData(preset_file=root_file, configuration_name='default')
+        )