Ensure CMake install instructions are consistent

Author: arichardson

pycheribuild/projects/cmake_project.py

@@ -39,7 +39,7 @@
 from ..config.chericonfig import BuildType
 from ..processutils import commandline_to_str
 from ..targets import target_manager
-from ..utils import InstallInstructions, OSInfo, include_local_file
+from ..utils import InstallInstructions, include_local_file
 
 __all__ = ["CMakeProject"]
 
@@ -80,16 +80,7 @@ def _bool_to_str(self, value: bool) -> str:
         return "TRUE" if value else "FALSE"
 
     def _configure_tool_install_instructions(self) -> InstallInstructions:
-        return OSInfo.install_instructions(
-            "cmake",
-            False,
-            default="cmake",
-            homebrew="cmake",
-            zypper="cmake",
-            apt="cmake",
-            freebsd="cmake",
-            cheribuild_target="cmake",
-        )
+        return InstallInstructions.cmake()
 
     @property
     def _get_version_args(self) -> dict:

pycheribuild/projects/kdevelop.py

@@ -31,6 +31,7 @@
 from .cross.llvm import BuildCheriLLVM
 from .project import BuildType, DefaultInstallDir, GitRepository
 from .simple_project import SimpleProject
+from ..utils import InstallInstructions
 
 
 # doesn't seem to be part of distro packages
@@ -70,9 +71,7 @@ class StartKDevelop(SimpleProject):
 
     def check_system_dependencies(self) -> None:
         super().check_system_dependencies()
-        self.check_required_system_tool(
-            "cmake", default="cmake", homebrew="cmake", zypper="cmake", apt="cmake", freebsd="cmake"
-        )
+        self.check_required_system_tool("cmake", instructions=InstallInstructions.cmake())
         self.check_required_system_tool("qtpaths")
 
     def process(self):

pycheribuild/projects/project.py

@@ -238,9 +238,7 @@ def __infer_command(self) -> str:
             self.__project.check_required_system_tool("ninja", homebrew="ninja", apt="ninja-build")
             return "ninja"
         elif self.kind == MakeCommandKind.CMake:
-            self.__project.check_required_system_tool(
-                "cmake", default="cmake", homebrew="cmake", zypper="cmake", apt="cmake", freebsd="cmake"
-            )
+            self.__project.check_required_system_tool("cmake", instructions=InstallInstructions.cmake())
             assert self.subkind is not None
             return "cmake"
         else:

pycheribuild/projects/simple_project.py

@@ -1168,10 +1168,11 @@ def check_required_system_tool(
             )
         if executable in self.__checked_system_tools:
             # If we already checked for this tool, the install instructions should match
-            assert instructions.fixit_hint() == self.__checked_system_tools[executable].fixit_hint(), executable
+            existing = self.__checked_system_tools[executable]
+            assert instructions.cheribuild_target == existing.cheribuild_target
+            assert instructions.alternative == existing.alternative
+            assert instructions.fixit_hint() == existing.fixit_hint(), f"mismatched instructions for {executable}"
             return  # already checked
-        assert instructions.cheribuild_target == cheribuild_target
-        assert instructions.alternative == alternative_instructions
         self._validate_cheribuild_target_for_system_deps(instructions.cheribuild_target)
         if not shutil.which(str(executable)):
             self.dependency_error(
@@ -1212,7 +1213,10 @@ def check_required_pkg_config(
             )
         if package in self.__checked_pkg_config:
             # If we already checked for this pkg-config .pc file, the install instructions should match
-            assert instructions.fixit_hint() == self.__checked_pkg_config[package].fixit_hint(), package
+            existing = self.__checked_pkg_config[package]
+            assert instructions.cheribuild_target == existing.cheribuild_target
+            assert instructions.alternative == existing.alternative
+            assert instructions.fixit_hint() == existing.fixit_hint(), f"mismatched instructions for {package}"
             return  # already checked
         self._validate_cheribuild_target_for_system_deps(instructions.cheribuild_target)
         try:

pycheribuild/utils.py

@@ -369,6 +369,19 @@ def fixit_hint(self) -> str:
             result += "\nAlternatively " + self.alternative
         return result
 
+    @classmethod
+    def cmake(cls):
+        return OSInfo.install_instructions(
+            "cmake",
+            False,
+            default="cmake",
+            homebrew="cmake",
+            zypper="cmake",
+            apt="cmake",
+            freebsd="cmake",
+            cheribuild_target="cmake",
+        )
+
 
 class OSInfo:
     IS_LINUX: bool = sys.platform.startswith("linux")

tests/run_smoke_tests.sh

@@ -54,7 +54,7 @@ try_run "${srcdir}/cheribuild.py" --dump-config
 try_run sh -c "\"${srcdir}/combine-files.py\" | \"$(command -v python3)\" - --get-config-option output-root"
 try_run "${srcdir}/cheribuild.py" -p __run_everything__ --clean --build --test --benchmark
 # Also check that we can run --pretend mode with all tools missing.
-try_run env PATH=/does/not/exist "$(command -v python3)" "${srcdir}/cheribuild.py" -p __run_everything__ --clean --build --test --benchmark
+try_run env PATH=/does/not/exist "$(command -v python3)" "${srcdir}/cheribuild.py" -p __run_everything__ --clean --build --test --benchmark --source-root=/tmp/does-not-exist
 try_run env WORKSPACE=/tmp "${srcdir}/jenkins-cheri-build.py" --allow-more-than-one-target --build --test --cpu=default -p __run_everything__
 # Check that the CheriBSD test script works
 try_run "${srcdir}/test-scripts/run_cheribsd_tests.py" -p --architecture morello-purecap --ssh-key path/to/test/ssh_key.pub --qemu-cmd /path/to/sdk/bin/qemu-system-morello --disk-image /path/to/output/cheribsd-morello-purecap.img --test-output-dir=/path/to/build/test-results/run-morello-purecap