tests: Improve logging and exceptions.

+ Mention commit-hash when package is installed successfully.
+ Display the package details, rather than only the package version.
    'package details' includes the version & edition.

CMK-33087

Change-Id: Ia0ae73f423834cf7e2276604284090f87d8debc2
(cherry picked from commit 7df9e54)

Author: dhsh-checkmk

tests/scripts/install-cmk.py

@@ -73,9 +73,9 @@ def main():
     manager = ABCPackageManager.factory()
     try:
         if args.uninstall:
-            manager.uninstall(version.version_rc_aware, version.edition)
+            manager.uninstall(version)
         else:
-            manager.install(version.version_rc_aware, version.edition)
+            manager.install(version)
     except subprocess.CalledProcessError as excp:
         excp.add_note(f"Failed to {operation} {version.edition} {version.version}!")
         logger.exception(excp)

tests/testlib/package_manager.py

@@ -27,7 +27,7 @@
 
 from cmk.ccc.version import Edition
 
-logger = logging.getLogger()
+logger = logging.getLogger(__name__)
 
 PackageUrl = NewType("PackageUrl", str)
 
@@ -116,18 +116,19 @@ def download(
 
         return target_path
 
-    def install(self, version: str, edition: Edition) -> None:
-        package_name = self.package_name(edition, version)
-        build_system_path = self._build_system_package_path(version, package_name)
+    def install(self, version: CMKVersion) -> None:
+        version_ = version.version_rc_aware
+        package_name = self.package_name(version.edition, version_)
+        build_system_path = self._build_system_package_path(version_, package_name)
         packages_dir = Path(__file__).parent.parent.parent / "package_download"
         if (package_path := packages_dir / package_name).exists():
             logger.info("Install from locally available package %s", package_path)
-            self._write_package_hash(version, edition, package_path)
+            self._write_package_hash(version_, version.edition, package_path)
             self._install_package(package_path)
 
         elif build_system_path.exists():
             logger.info("Install from build system package (%s)", build_system_path)
-            self._write_package_hash(version, edition, build_system_path)
+            self._write_package_hash(version_, version.edition, build_system_path)
             self._install_package(build_system_path)
 
         else:
@@ -137,19 +138,28 @@ def install(self, version: str, edition: Edition) -> None:
                 # should be found.
                 logger.info("Try install from tstbuild")
                 self._download_package(
-                    self.package_url_internal(version, package_name), package_path
+                    self.package_url_internal(version_, package_name), package_path
                 )
             except requests.exceptions.HTTPError:
                 logger.info("Could not Install from tstbuild, trying download portal...")
-                self._download_package(self.package_url_public(version, package_name), package_path)
+                self._download_package(
+                    self.package_url_public(version_, package_name), package_path
+                )
 
             logger.info("Install from tstbuild or portal (%s)", package_path)
-            self._write_package_hash(version, edition, package_path)
+            self._write_package_hash(version_, version.edition, package_path)
             self._install_package(package_path)
             os.unlink(package_path)
 
-    def uninstall(self, version: str, edition: Edition) -> None:
-        package_name = self.package_name(edition, version)
+        logger.info(
+            "Checkmk package '%s' built using commit: '%s'",
+            version.omd_version(),
+            version.commit_hash,
+        )
+
+    def uninstall(self, version: CMKVersion) -> None:
+        version_ = version.version_rc_aware
+        package_name = self.package_name(version.edition, version_)
         self._uninstall_package(package_name)
 
     def _write_package_hash(self, version: str, edition: Edition, package_path: Path) -> None:

tests/testlib/site.py

@@ -856,17 +856,22 @@ def install_cmk(self) -> None:
                         os.environ, VERSION=self.version.version, EDITION=self.version.edition.short
                     ),
                 )
+                logger.info(
+                    "Checkmk package '%s' built using commit: '%s'",
+                    self.version.omd_version(),
+                    self.version.commit_hash,
+                )
             except subprocess.CalledProcessError as excp:
                 excp.add_note("Execute 'tests/scripts/install-cmk.py' manually to debug the issue.")
                 excp.add_note(excp.stdout)
                 excp.add_note(excp.stderr)
                 if excp.returncode == 22:
                     raise RuntimeError(
-                        f"Version {self.version.version} could not be installed!"
+                        f"Checkmk package {self.version.omd_version()} could not be installed!"
                     ) from excp
                 if excp.returncode == 11:
                     raise FileNotFoundError(
-                        f"Version {self.version.version} could not be downloaded!"
+                        f"Checkmk package {self.version.omd_version()} could not be downloaded!"
                     ) from excp
                 raise excp
 

tests/testlib/version.py

@@ -10,6 +10,7 @@
 import re
 import time
 from collections.abc import Callable
+from pathlib import Path
 from typing import Final, Self
 
 from packaging.version import Version
@@ -80,6 +81,20 @@ def __init__(
         self.branch: Final = branch
         self.branch_version: Final = branch_version
 
+    @property
+    def commit_hash(self) -> str:
+        short_hand = self.omd_version()
+        try:
+            return Path(f"/opt/omd/versions/{short_hand}/share/doc/COMMIT").read_text().strip()
+        except FileNotFoundError as excp:
+            if self.is_installed():
+                excp.add_note(
+                    f"Checkmk package '{short_hand}' is installed! Checkmk packaging issues?"
+                )
+            else:
+                excp.add_note(f"Missing Checkmk package '{short_hand}' installation!")
+            raise excp
+
     @staticmethod
     def _get_default_version() -> str:
         if os.path.exists("/etc/alternatives/omd"):