Custom cmake_binary

Author: Behemyth

cppython/plugins/cmake/resolution.py

@@ -1,5 +1,7 @@
 """Builder to help resolve cmake state"""
 
+import os
+from pathlib import Path
 from typing import Any
 
 from cppython.core.schema import CorePluginData
@@ -24,4 +26,13 @@ def resolve_cmake_data(data: dict[str, Any], core_data: CorePluginData) -> CMake
     if not modified_preset_file.is_absolute():
         modified_preset_file = root_directory / modified_preset_file
 
-    return CMakeData(preset_file=modified_preset_file, configuration_name=parsed_data.configuration_name)
+    # Resolve cmake binary: environment variable takes precedence over configuration
+    cmake_binary: Path | None = None
+    if env_binary := os.environ.get('CMAKE_BINARY'):
+        cmake_binary = Path(env_binary)
+    elif parsed_data.cmake_binary:
+        cmake_binary = parsed_data.cmake_binary
+
+    return CMakeData(
+        preset_file=modified_preset_file, configuration_name=parsed_data.configuration_name, cmake_binary=cmake_binary
+    )

cppython/plugins/cmake/schema.py

@@ -111,6 +111,7 @@ class CMakeData(CPPythonModel):
 
     preset_file: Path
     configuration_name: str
+    cmake_binary: Path | None
 
 
 class CMakeConfiguration(CPPythonModel):
@@ -131,3 +132,10 @@ class CMakeConfiguration(CPPythonModel):
             '"default-release" will also be written'
         ),
     ] = 'default'
+    cmake_binary: Annotated[
+        Path | None,
+        Field(
+            description='Path to a specific CMake binary to use. If not specified, uses "cmake" from PATH. '
+            'Can be overridden via CMAKE_BINARY environment variable.'
+        ),
+    ] = None

cppython/plugins/conan/builder.py

@@ -176,7 +176,11 @@ def export_sources(self):
             file.write(result)
 
     def generate_conanfile(
-        self, directory: DirectoryPath, dependencies: list[ConanDependency], name: str, version: str
+        self,
+        directory: DirectoryPath,
+        dependencies: list[ConanDependency],
+        name: str,
+        version: str,
     ) -> None:
         """Generate a conanfile.py file for the project."""
         conan_file = directory / self._filename

cppython/plugins/conan/plugin.py

@@ -45,6 +45,9 @@ def __init__(
 
         self._ensure_default_profiles()
 
+        # Initialize cmake_binary with system default. It may be overridden during sync.
+        self._cmake_binary = 'cmake'
+
     @staticmethod
     def features(directory: Path) -> SupportedFeatures:
         """Queries conan support
@@ -149,8 +152,11 @@ def _run_conan_install(self, conanfile_path: Path, update: bool, build_type: str
         if build_type:
             command_args.extend(['-s', f'build_type={build_type}'])
 
-        # Log the command being executed
-        logger.info('Executing conan command: conan %s', ' '.join(command_args))
+        # Add cmake binary configuration if specified
+        if self._cmake_binary and self._cmake_binary != 'cmake':
+            # Quote the path if it contains spaces
+            cmake_path = f'"{self._cmake_binary}"' if ' ' in self._cmake_binary else self._cmake_binary
+            command_args.extend(['-c', f'tools.cmake:cmake_program={cmake_path}'])
 
         try:
             # Use reusable Conan API instance instead of subprocess
@@ -200,10 +206,28 @@ def sync_data(self, consumer: SyncConsumer) -> SyncData:
         """
         for sync_type in consumer.sync_types():
             if sync_type == CMakeSyncData:
-                return self._create_cmake_sync_data()
+                return self._sync_with_cmake(consumer)
 
         raise NotSupportedError(f'Unsupported sync types: {consumer.sync_types()}')
 
+    def _sync_with_cmake(self, consumer: SyncConsumer) -> CMakeSyncData:
+        """Synchronize with CMake generator and create sync data.
+
+        Args:
+            consumer: The CMake generator consumer
+
+        Returns:
+            CMakeSyncData configured for Conan integration
+        """
+        # Extract cmake_binary from CMakeGenerator if available
+        if isinstance(consumer, CMakeGenerator) and not os.environ.get('CMAKE_BINARY'):
+            # Only override if not already set from environment variable
+            # Convert Path to string, or use 'cmake' if None
+            cmake_path = consumer.data.cmake_binary
+            self._cmake_binary = str(cmake_path) if cmake_path else 'cmake'
+
+        return self._create_cmake_sync_data()
+
     def _create_cmake_sync_data(self) -> CMakeSyncData:
         """Creates CMake synchronization data with Conan toolchain configuration.
 
@@ -243,8 +267,11 @@ def publish(self) -> None:
             # Add build mode (build everything for publishing)
             command_args.extend(['--build', 'missing'])
 
-            # Log the command being executed
-            logger.info('Executing conan create command: conan %s', ' '.join(command_args))
+            # Add cmake binary configuration if specified
+            if self._cmake_binary and self._cmake_binary != 'cmake':
+                # Quote the path if it contains spaces
+                cmake_path = f'"{self._cmake_binary}"' if ' ' in self._cmake_binary else self._cmake_binary
+                command_args.extend(['-c', f'tools.cmake:cmake_program={cmake_path}'])
 
             # Run conan create using reusable Conan API instance
             # Change to project directory since Conan API might not handle cwd like subprocess

cppython/project.py

@@ -68,9 +68,11 @@ def install(self) -> None:
         self.logger.info('Installing project')
         self.logger.info('Installing %s provider', self._data.plugins.provider.name())
 
+        # Sync before install to allow provider to access generator's resolved configuration
+        self._data.sync()
+
         # Let provider handle its own exceptions for better error context
         self._data.plugins.provider.install()
-        self._data.sync()
 
     def update(self) -> None:
         """Updates project dependencies
@@ -88,9 +90,11 @@ def update(self) -> None:
         self.logger.info('Updating project')
         self.logger.info('Updating %s provider', self._data.plugins.provider.name())
 
+        # Sync before update to allow provider to access generator's resolved configuration
+        self._data.sync()
+
         # Let provider handle its own exceptions for better error context
         self._data.plugins.provider.update()
-        self._data.sync()
 
     def publish(self) -> None:
         """Publishes the project

examples/conan_cmake/library/pyproject.toml

@@ -18,6 +18,7 @@ install-path = "install"
 dependencies = ["fmt>=11.2.0"]
 
 [tool.cppython.generators.cmake]
+cmake_binary = "C:/Program Files/CMake/bin/cmake.exe"
 
 [tool.cppython.providers.conan]
 

examples/conan_cmake/simple/pyproject.toml

@@ -18,6 +18,7 @@ install-path = "install"
 dependencies = ["fmt>=11.2.0"]
 
 [tool.cppython.generators.cmake]
+cmake_binary = "C:/Program Files/CMake/bin/cmake.exe"
 
 [tool.cppython.providers.conan]
 

examples/vcpkg_cmake/simple/pyproject.toml

@@ -18,6 +18,7 @@ install-path = "install"
 dependencies = ["fmt>=11.2.0"]
 
 [tool.cppython.generators.cmake]
+cmake_binary = "C:/Program Files/CMake/bin/cmake.exe"
 
 [tool.cppython.providers.vcpkg]
 

tests/integration/examples/test_conan_cmake.py

@@ -5,6 +5,7 @@
 """
 
 import subprocess
+import tomllib
 from pathlib import Path
 from tomllib import loads
 
@@ -14,7 +15,7 @@
 from cppython.core.schema import ProjectConfiguration
 from cppython.project import Project
 
-pytest_plugins = ['tests.fixtures.example', 'tests.fixtures.conan']
+pytest_plugins = ['tests.fixtures.example', 'tests.fixtures.conan', 'tests.fixtures.cmake']
 
 
 class TestConanCMake:
@@ -37,15 +38,23 @@ def _create_project(skip_upload: bool = True) -> Project:
         return Project(config, interface, pyproject_data)
 
     @staticmethod
-    def _run_cmake_configure() -> None:
-        """Run CMake configuration and assert success."""
-        result = subprocess.run(['cmake', '--preset=default'], capture_output=True, text=True, check=False)
+    def _run_cmake_configure(cmake_binary: str) -> None:
+        """Run CMake configuration and assert success.
+
+        Args:
+            cmake_binary: Path or command name for the CMake binary to use
+        """
+        result = subprocess.run([cmake_binary, '--preset=default'], capture_output=True, text=True, check=False)
         assert result.returncode == 0, f'CMake configuration failed: {result.stderr}'
 
     @staticmethod
-    def _run_cmake_build() -> None:
-        """Run CMake build and assert success."""
-        result = subprocess.run(['cmake', '--build', 'build'], capture_output=True, text=True, check=False)
+    def _run_cmake_build(cmake_binary: str) -> None:
+        """Run CMake build and assert success.
+
+        Args:
+            cmake_binary: Path or command name for the CMake binary to use
+        """
+        result = subprocess.run([cmake_binary, '--build', 'build'], capture_output=True, text=True, check=False)
         assert result.returncode == 0, f'CMake build failed: {result.stderr}'
 
     @staticmethod
@@ -70,12 +79,25 @@ def _ensure_conan_config(pyproject_data: dict) -> None:
     @staticmethod
     def test_simple(example_runner: CliRunner) -> None:
         """Simple project"""
+        # Read cmake_binary from the current pyproject.toml (we're in the example directory)
+        pyproject_path = Path.cwd() / 'pyproject.toml'
+        with pyproject_path.open('rb') as file:
+            pyproject_data = tomllib.load(file)
+
+        cmake_binary = (
+            pyproject_data.get('tool', {})
+            .get('cppython', {})
+            .get('generators', {})
+            .get('cmake', {})
+            .get('cmake_binary', 'cmake')
+        )
+
         # Create project and install dependencies
         project = TestConanCMake._create_project(skip_upload=False)
         project.install()
 
         # Configure and verify build
-        TestConanCMake._run_cmake_configure()
+        TestConanCMake._run_cmake_configure(cmake_binary)
         TestConanCMake._verify_build_artifacts()
 
         # Test publishing with skip_upload enabled
@@ -85,13 +107,26 @@ def test_simple(example_runner: CliRunner) -> None:
     @staticmethod
     def test_library(example_runner: CliRunner) -> None:
         """Test library creation and packaging workflow"""
+        # Read cmake_binary from the current pyproject.toml (we're in the example directory)
+        pyproject_path = Path.cwd() / 'pyproject.toml'
+        with pyproject_path.open('rb') as file:
+            pyproject_data = tomllib.load(file)
+
+        cmake_binary = (
+            pyproject_data.get('tool', {})
+            .get('cppython', {})
+            .get('generators', {})
+            .get('cmake', {})
+            .get('cmake_binary', 'cmake')
+        )
+
         # Create project and install dependencies
         project = TestConanCMake._create_project(skip_upload=False)
         project.install()
 
         # Configure, build, and verify
-        TestConanCMake._run_cmake_configure()
-        TestConanCMake._run_cmake_build()
+        TestConanCMake._run_cmake_configure(cmake_binary)
+        TestConanCMake._run_cmake_build(cmake_binary)
         build_path = TestConanCMake._verify_build_artifacts()
 
         # Verify library files exist (platform-specific)

tests/integration/examples/test_vcpkg_cmake.py

@@ -5,6 +5,7 @@
 """
 
 import subprocess
+import tomllib
 from pathlib import Path
 from tomllib import loads
 
@@ -15,7 +16,7 @@
 from cppython.core.schema import ProjectConfiguration
 from cppython.project import Project
 
-pytest_plugins = ['tests.fixtures.example', 'tests.fixtures.vcpkg']
+pytest_plugins = ['tests.fixtures.example', 'tests.fixtures.vcpkg', 'tests.fixtures.cmake']
 
 
 @pytest.mark.skip(reason='Address file locks.')
@@ -53,12 +54,25 @@ def _ensure_vcpkg_config(pyproject_data: dict) -> None:
     @staticmethod
     def test_simple(example_runner: CliRunner) -> None:
         """Simple project"""
+        # Read cmake_binary from the current pyproject.toml (we're in the example directory)
+        pyproject_path = Path.cwd() / 'pyproject.toml'
+        with pyproject_path.open('rb') as file:
+            pyproject_data = tomllib.load(file)
+
+        cmake_binary = (
+            pyproject_data.get('tool', {})
+            .get('cppython', {})
+            .get('generators', {})
+            .get('cmake', {})
+            .get('cmake_binary', 'cmake')
+        )
+
         # Create project and install dependencies
         project = TestVcpkgCMake._create_project(skip_upload=False)
         project.install()
 
         # Run the CMake configuration command
-        result = subprocess.run(['cmake', '--preset=default'], capture_output=True, text=True, check=False)
+        result = subprocess.run([cmake_binary, '--preset=default'], capture_output=True, text=True, check=False)
 
         assert result.returncode == 0, f'Cmake failed: {result.stderr}'