Removed some easily avoidable multiple inheritance

This is a purely mechanical minimum change, one can and probably
should massage the class hierarchy afterwards a bit: Various
classes pairs can be merged into each other. But that's something
for a future commit, the main point here is that WatoMode is only
used in a single-inheritance way.

Change-Id: I785df6f81a175f9cac27dbb37e17cc1a7995e42d

Author: spt29

cmk/gui/BUILD

@@ -1088,6 +1088,7 @@ py_library(
         "//cmk/gui/utils:transaction_manager",
         "//cmk/gui/utils:urls",
         "//cmk/gui/valuespec",
+        "//cmk/gui/watolib:registries",
         "//cmk/utils",
         "//packages/cmk-ccc:site",
         "//packages/cmk-ccc:user",

cmk/gui/backup/handler.py

@@ -84,6 +84,7 @@
 )
 from cmk.gui.utils.user_errors import user_errors
 from cmk.gui.valuespec import AbsoluteDirname, ID, SchedulePeriod
+from cmk.gui.watolib.mode import WatoMode
 from cmk.rulesets.internal.form_specs import (
     ListExtended,
     SimplePassword,
@@ -448,7 +449,7 @@ def _cron_cmdline(self) -> str:
         return "mkbackup backup %s >/dev/null" % self.ident
 
 
-class PageBackup:
+class ModeBackup(WatoMode[object]):
     def title(self) -> str:
         return _("Site backup")
 
@@ -744,7 +745,7 @@ def _show_job_list(self, backup_jobs: Sequence[Job]) -> None:
                     )
 
 
-class PageEditBackupJob:
+class ModeEditBackupJob(WatoMode[object]):
     def __init__(self, key_store: keypair_store.KeypairStore) -> None:
         super().__init__()
         self.key_store = key_store
@@ -999,8 +1000,9 @@ def backup_key_choices(self) -> Sequence[SingleChoiceElementExtended]:
             for ident, title in self.key_store.choices()
         ]
 
+    @classmethod
     def backup_target_choices(
-        self, backup_config: BackupConfig
+        cls, backup_config: BackupConfig
     ) -> Sequence[SingleChoiceElementExtended[str]]:
         return [
             SingleChoiceElementExtended(
@@ -1122,7 +1124,7 @@ def show_job_details(job: MKBackupJob) -> None:
     html.close_table()
 
 
-class PageBackupJobState:
+class ModeBackupJobState(WatoMode[object]):
     def __init__(self) -> None:
         super().__init__()
         self._from_vars()
@@ -1767,7 +1769,7 @@ def _show_target_list(targets: Iterable[Target], targets_are_cma: bool) -> None:
             table.cell(_("Destination"), target.render_destination())
 
 
-class PageBackupTargets:
+class ModeBackupTargets(WatoMode[object]):
     def title(self) -> str:
         return _("Site backup targets")
 
@@ -1835,7 +1837,7 @@ def page(self, config: Config) -> None:
         _show_site_and_system_targets(BackupConfig.load())
 
 
-class PageEditBackupTarget:
+class ModeEditBackupTarget(WatoMode[object]):
     def __init__(self) -> None:
         super().__init__()
         target_ident = request.var("target")
@@ -2007,7 +2009,7 @@ class BackupKeypairStore(keypair_store.KeypairStore):
     pass
 
 
-class PageBackupKeyManagement(key_mgmt.PageKeyManagement):
+class ModeBackupKeyManagement(key_mgmt.ModeKeyManagement):
     edit_mode = "backup_edit_key"
     upload_mode = "backup_upload_key"
     download_mode = "backup_download_key"
@@ -2042,7 +2044,7 @@ def component_name(self) -> CertManagementEvent.ComponentType:
         return "backup encryption keys"
 
 
-class PageBackupEditKey(key_mgmt.PageEditKey):
+class ModeBackupEditKey(key_mgmt.ModeEditKey):
     back_mode = "backup_keys"
 
     def title(self) -> str:
@@ -2062,7 +2064,7 @@ def component_name(self) -> CertManagementEvent.ComponentType:
         return "backup encryption keys"
 
 
-class PageBackupUploadKey(key_mgmt.PageUploadKey):
+class ModeBackupUploadKey(key_mgmt.ModeUploadKey):
     back_mode = "backup_keys"
 
     def title(self) -> str:
@@ -2082,7 +2084,7 @@ def component_name(self) -> CertManagementEvent.ComponentType:
         return "backup encryption keys"
 
 
-class PageBackupDownloadKey(key_mgmt.PageDownloadKey):
+class ModeBackupDownloadKey(key_mgmt.ModeDownloadKey):
     back_mode = "backup_keys"
 
     def title(self) -> str:
@@ -2163,7 +2165,7 @@ def start(self, **env_updates: str) -> None:
         super().start(**env_updates)
 
 
-class PageBackupRestore:
+class ModeBackupRestore(WatoMode[object]):
     def __init__(self, key_store: keypair_store.KeypairStore) -> None:
         super().__init__()
         self.key_store = key_store

cmk/gui/backup/pages.py

@@ -35,7 +35,7 @@ def register(page_registry: PageRegistry, mode_registry: ModeRegistry) -> None:
     mode_registry.register(ModeBackupRestore)
 
 
-class ModeBackup(handler.PageBackup, WatoMode):
+class ModeBackup(handler.ModeBackup):
     @classmethod
     def name(cls) -> str:
         return "backup"
@@ -51,7 +51,7 @@ def title(self) -> str:
         return _("Site backup")
 
 
-class ModeBackupTargets(handler.PageBackupTargets, WatoMode):
+class ModeBackupTargets(handler.ModeBackupTargets):
     @classmethod
     def name(cls) -> str:
         return "backup_targets"
@@ -65,7 +65,7 @@ def parent_mode(cls) -> type[WatoMode] | None:
         return ModeBackup
 
 
-class ModeEditBackupTarget(handler.PageEditBackupTarget, WatoMode):
+class ModeEditBackupTarget(handler.ModeEditBackupTarget):
     @classmethod
     def name(cls) -> str:
         return "edit_backup_target"
@@ -79,7 +79,7 @@ def parent_mode(cls) -> type[WatoMode] | None:
         return ModeBackupTargets
 
 
-class ModeEditBackupJob(handler.PageEditBackupJob, WatoMode):
+class ModeEditBackupJob(handler.ModeEditBackupJob):
     @classmethod
     def name(cls) -> str:
         return "edit_backup_job"
@@ -96,7 +96,7 @@ def __init__(self) -> None:
         super().__init__(key_store=make_site_backup_keypair_store())
 
 
-class ModeBackupJobState(handler.PageBackupJobState, WatoMode):
+class ModeBackupJobState(handler.ModeBackupJobState):
     @classmethod
     def name(cls) -> str:
         return "backup_job_state"
@@ -132,7 +132,7 @@ def make_site_backup_keypair_store() -> handler.BackupKeypairStore:
     return handler.BackupKeypairStore(cmk.utils.paths.default_config_dir / "backup_keys.mk", "keys")
 
 
-class ModeBackupKeyManagement(handler.PageBackupKeyManagement, WatoMode):
+class ModeBackupKeyManagement(handler.ModeBackupKeyManagement):
     @classmethod
     def name(cls) -> str:
         return "backup_keys"
@@ -149,7 +149,7 @@ def __init__(self) -> None:
         super().__init__(key_store=make_site_backup_keypair_store())
 
 
-class ModeBackupEditKey(handler.PageBackupEditKey, WatoMode):
+class ModeBackupEditKey(handler.ModeBackupEditKey):
     @classmethod
     def name(cls) -> str:
         return "backup_edit_key"
@@ -166,7 +166,7 @@ def __init__(self) -> None:
         super().__init__(key_store=make_site_backup_keypair_store())
 
 
-class ModeBackupUploadKey(handler.PageBackupUploadKey, WatoMode):
+class ModeBackupUploadKey(handler.ModeBackupUploadKey):
     @classmethod
     def name(cls) -> str:
         return "backup_upload_key"
@@ -192,7 +192,7 @@ def _upload_key(self, key_file: str, alias: str, passphrase: Password) -> None:
         super()._upload_key(key_file, alias, passphrase)
 
 
-class ModeBackupDownloadKey(handler.PageBackupDownloadKey, WatoMode):
+class ModeBackupDownloadKey(handler.ModeBackupDownloadKey):
     @classmethod
     def name(cls) -> str:
         return "backup_download_key"
@@ -209,7 +209,7 @@ def __init__(self) -> None:
         super().__init__(key_store=make_site_backup_keypair_store())
 
 
-class ModeBackupRestore(handler.PageBackupRestore, WatoMode):
+class ModeBackupRestore(handler.ModeBackupRestore):
     @classmethod
     def name(cls) -> str:
         return "backup_restore"

cmk/gui/key_mgmt.py

@@ -44,12 +44,13 @@
     TextAreaUnicode,
     TextInput,
 )
+from cmk.gui.watolib.mode import WatoMode
 from cmk.utils.certs import CertManagementEvent
 from cmk.utils.keypair_store import Key, KeyAlreadyExists, KeyId, KeypairMap, KeypairStore
 from cmk.utils.security_event import log_security_event
 
 
-class PageKeyManagement:
+class ModeKeyManagement(WatoMode[object]):
     edit_mode = "edit_key"
     upload_mode = "upload_key"
     download_mode = "download_key"
@@ -198,7 +199,7 @@ def page(self, config: Config) -> None:
                 table.cell(_("Key ID"), key_id)
 
 
-class PageEditKey:
+class ModeEditKey(WatoMode[object]):
     back_mode: str
 
     def __init__(self, key_store: KeypairStore) -> None:
@@ -297,7 +298,7 @@ def _passphrase_help(self) -> str:
         raise NotImplementedError()
 
 
-class PageUploadKey:
+class ModeUploadKey(WatoMode[object]):
     back_mode: str
 
     def __init__(self, key_store: KeypairStore) -> None:
@@ -464,7 +465,7 @@ def _passphrase_help(self) -> str:
         raise NotImplementedError()
 
 
-class PageDownloadKey:
+class ModeDownloadKey(WatoMode[object]):
     back_mode: str
 
     def __init__(self, key_store: KeypairStore) -> None:

tests/unit/cmk/gui/test_backup_unit.py

@@ -10,13 +10,12 @@
 import cmk.utils.paths
 from cmk.ccc.user import UserId
 from cmk.crypto.password import Password
-from cmk.gui.backup.handler import BackupConfig, PageEditBackupJob
+from cmk.gui.backup.handler import BackupConfig, ModeEditBackupJob
 from cmk.gui.backup.pages import ModeBackupEditKey
 from cmk.gui.logged_in import user
 from cmk.utils.backup.config import CMASystemConfig, Config, SiteConfig
 from cmk.utils.backup.targets import TargetId
 from cmk.utils.backup.targets.config import LocalTargetConfig, TargetConfig
-from cmk.utils.keypair_store import KeypairStore
 
 
 @pytest.mark.usefixtures("request_context")
@@ -44,10 +43,7 @@ def test_backup_key_create_web(monkeypatch: pytest.MonkeyPatch) -> None:
         store_path.unlink()
 
 
-@pytest.mark.usefixtures("request_context")
-def test_backup_target_choices_with_hyphenated_ident(
-    tmp_path: Path,
-) -> None:
+def test_backup_target_choices_with_hyphenated_ident(tmp_path: Path) -> None:
     """Regression test for CMK-32749: backup target IDs with hyphens must not raise ValueError.
 
     Before the fix, SingleChoiceElement validated that 'name' was a valid Python identifier,
@@ -68,11 +64,8 @@ def test_backup_target_choices_with_hyphenated_ident(
     )
     backup_config = BackupConfig(raw_config)
 
-    key_store = KeypairStore(tmp_path / "backup_keys.mk", "keys")
-    page = PageEditBackupJob(key_store)
-
     # Must not raise ValueError
-    choices = page.backup_target_choices(backup_config)
+    choices = ModeEditBackupJob.backup_target_choices(backup_config)
 
     assert len(choices) == 1
     assert choices[0].name == "backup-local"