Add AC test 'Unknown check parameter rule sets'

si-23 · si-23 · commit fde8cbfddf34 · 2025-03-26T16:05:33.000+01:00
CMK-22492

Change-Id: Ic26cb10be03c235a5aac490599900f581fdcbbf5
diff --git a/cmk/automations/results.py b/cmk/automations/results.py
@@ -777,3 +777,15 @@ def automation_call() -> str:
 
 
 result_type_registry.register(BakeAgentsResult)
+
+
+@dataclass
+class UnknownCheckParameterRuleSetsResult(ABCAutomationResult):
+    result: Sequence[str]
+
+    @staticmethod
+    def automation_call() -> str:
+        return "find-unknown-check-parameter-rule-sets"
+
+
+result_type_registry.register(UnknownCheckParameterRuleSetsResult)
diff --git a/cmk/base/automations/check_mk.py b/cmk/base/automations/check_mk.py
@@ -108,6 +108,7 @@
     SetAutochecksTable,
     SetAutochecksV2Result,
     SpecialAgentResult,
+    UnknownCheckParameterRuleSetsResult,
     UpdateDNSCacheResult,
     UpdateHostLabelsResult,
     UpdatePasswordsMergedFileResult,
@@ -3167,3 +3168,30 @@ def execute(
 
 
 automations.register(AutomationCreateDiagnosticsDump())
+
+
+class AutomationFindUnknownCheckParameterRuleSets(Automation):
+    cmd = "find-unknown-check-parameter-rule-sets"
+    needs_config = True
+    needs_checks = True
+
+    def execute(
+        self,
+        args: list[str],
+        called_from_automation_helper: bool,
+    ) -> UnknownCheckParameterRuleSetsResult:
+        known_check_rule_sets = {
+            str(plugin.check_ruleset_name)
+            for plugin in agent_based_register.get_previously_loaded_plugins().check_plugins.values()
+            if plugin.check_ruleset_name
+        }
+        return UnknownCheckParameterRuleSetsResult(
+            [
+                rule_set
+                for rule_set in config.checkgroup_parameters
+                if rule_set not in known_check_rule_sets
+            ]
+        )
+
+
+automations.register(AutomationFindUnknownCheckParameterRuleSets())
diff --git a/cmk/base/core_config.py b/cmk/base/core_config.py
@@ -36,7 +36,6 @@
 
 import cmk.base.api.agent_based.register as agent_based_register
 from cmk.base import config
-from cmk.base.api.agent_based.plugin_classes import CheckPlugin
 from cmk.base.config import ConfigCache, ObjectAttributes
 from cmk.base.nagios_utils import do_check_nagiosconfig
 
@@ -392,7 +391,6 @@ def _create_core_config(
     config_warnings.initialize()
 
     _verify_non_duplicate_hosts(duplicates)
-    _verify_non_deprecated_checkgroups(plugins.check_plugins.values())
 
     # recompute and save passwords, to ensure consistency:
     passwords = config_cache.collect_passwords()
@@ -414,30 +412,6 @@ def _create_core_config(
     )
 
 
-def _verify_non_deprecated_checkgroups(check_plugins: Iterable[CheckPlugin]) -> None:
-    """Verify that the user has no deprecated check groups configured."""
-    # 'check_plugin.check_ruleset_name' is of type RuleSetName, which is an PluginName (good),
-    # but config.checkgroup_parameters contains strings (todo)
-    check_ruleset_names_with_plugin = {
-        str(plugin.check_ruleset_name) for plugin in check_plugins if plugin.check_ruleset_name
-    }
-
-    for checkgroup in config.checkgroup_parameters:
-        if checkgroup not in check_ruleset_names_with_plugin:
-            config_warnings.warn(
-                'Found configured rules of deprecated check group "%s". These rules are not used '
-                "by any check plug-in. Maybe this check group has been renamed during an update, "
-                "in this case you will have to migrate your configuration to the new ruleset manually. "
-                "Please check out the release notes of the involved versions. "
-                'You may use the page "Deprecated rules" in the "Rule search" to view your rules '
-                "and move them to the new rulesets. "
-                "If this is not the case, the rules could be related to a disabled or removed "
-                "extension package (mkp). You would have to enable/upload the corresponding package "
-                "and remove the related rules before disabling/removing the package again."
-                % checkgroup
-            )
-
-
 def _verify_non_duplicate_hosts(duplicates: Collection[HostName]) -> None:
     if duplicates:
         config_warnings.warn(
diff --git a/cmk/gui/deprecations.py b/cmk/gui/deprecations.py
@@ -212,8 +212,7 @@ def render(self, version: str) -> str:
                     " by migrating or removing this plug-in."
                 )
             case "unsorted":
-                title = _("Unsorted")
-
+                title = self.ident
                 info = ""
                 recommendation = _(
                     "We highly recommend solving this issue already in your installation."
@@ -300,8 +299,8 @@ def _find_ac_test_result_problems(
 
             else:
                 problem = problem_by_ident.setdefault(
-                    "unsorted",
-                    _ACTestResultProblem("unsorted", "unsorted"),
+                    ac_test_result.text,
+                    _ACTestResultProblem(ac_test_result.text, "unsorted"),
                 )
 
             problem.add_ac_test_result(site_id, ac_test_result)
diff --git a/cmk/gui/wato/_ac_tests.py b/cmk/gui/wato/_ac_tests.py
@@ -55,6 +55,7 @@
     ACTestCategories,
     ACTestRegistry,
 )
+from cmk.gui.watolib.check_mk_automations import find_unknown_check_parameter_rule_sets
 from cmk.gui.watolib.config_domain_name import ABCConfigDomain
 from cmk.gui.watolib.config_domains import ConfigDomainOMD
 from cmk.gui.watolib.rulesets import SingleRulesetRecursively
@@ -89,6 +90,7 @@ def register(ac_test_registry: ACTestRegistry) -> None:
     ac_test_registry.register(ACTestSizeOfExtensions)
     ac_test_registry.register(ACTestBrokenGUIExtension)
     ac_test_registry.register(ACTestESXDatasources)
+    ac_test_registry.register(ACTestUnknownCheckParameterRuleSets)
     ac_test_registry.register(ACTestDeprecatedV1CheckPlugins)
     ac_test_registry.register(ACTestDeprecatedCheckPlugins)
     ac_test_registry.register(ACTestDeprecatedInventoryPlugins)
@@ -1332,6 +1334,50 @@ def _compute_deprecation_result(
     )
 
 
+class ACTestUnknownCheckParameterRuleSets(ACTest):
+    def category(self) -> str:
+        return ACTestCategories.deprecations
+
+    def title(self) -> str:
+        return _("Unknown check parameter rule sets")
+
+    def help(self) -> str:
+        return _(
+            "These rule sets are configured in your site, but not used by any check plug-in."
+            " There are two main reasons to have such rule sets configured:"
+            "<ol>"
+            "<li> Rule sets which were used by builtin check plugins that have been deprecated and"
+            " removed in the past. These can be cleaned up without any negative side effect.</li>"
+            "<li> Rule sets which belong to disabled or removed extension packages. If you plan to"
+            " keep it removed, you can safely clean them up. In case the extension package was"
+            " temporarily disabled, you may consider keeping the rule sets in place.</li>"
+            "</ol>"
+        )
+
+    def is_relevant(self) -> bool:
+        return True
+
+    def execute(self) -> Iterator[ACSingleResult]:
+        site_id = omd_site()
+        if rule_sets := find_unknown_check_parameter_rule_sets().result:
+            for rule_set in rule_sets:
+                yield ACSingleResult(
+                    state=ACResultState.CRIT,
+                    text=(
+                        _("Found configured rules of unknown check parameter rule set %r.")
+                        % rule_set
+                    ),
+                    site_id=site_id,
+                )
+            return
+
+        yield ACSingleResult(
+            state=ACResultState.OK,
+            text=_("No unknown check parameter rule sets found."),
+            site_id=site_id,
+        )
+
+
 class ACTestDeprecatedV1CheckPlugins(ACTest):
     def category(self) -> str:
         return ACTestCategories.deprecations
diff --git a/cmk/gui/watolib/check_mk_automations.py b/cmk/gui/watolib/check_mk_automations.py
@@ -559,3 +559,12 @@ def bake_agents(
         ),
         results.BakeAgentsResult,
     )
+
+
+def find_unknown_check_parameter_rule_sets() -> results.UnknownCheckParameterRuleSetsResult:
+    return _deserialize(
+        _automation_serialized(
+            "find-unknown-check-parameter-rule-sets",
+        ),
+        results.UnknownCheckParameterRuleSetsResult,
+    )
diff --git a/tests/unit/cmk/base/test_unit_automations.py b/tests/unit/cmk/base/test_unit_automations.py
@@ -56,6 +56,7 @@ def test_registered_automations() -> None:
         "update-dns-cache",
         "update-host-labels",
         "update-passwords-merged-file",
+        "find-unknown-check-parameter-rule-sets",
     ]
 
     if cmk_version.edition(paths.omd_root) is not cmk_version.Edition.CRE:
diff --git a/tests/unit/cmk/gui/test_deprecations.py b/tests/unit/cmk/gui/test_deprecations.py
@@ -191,7 +191,7 @@ def test__filter_non_ok_ac_test_results(
             {},
             [
                 _ACTestResultProblem(
-                    ident="unsorted",
+                    ident="text",
                     type="unsorted",
                     _ac_test_results={
                         SiteId("site_id_1"): [
@@ -477,13 +477,13 @@ def test__find_ac_test_result_problems(
     [
         pytest.param(
             _ACTestResultProblem(
-                ident="ident",
+                ident="A text",
                 type="unsorted",
                 _ac_test_results={
                     SiteId("site_id"): [
                         ACTestResult(
                             ACResultState.WARN,
-                            "text",
+                            "A text",
                             "test_id",
                             "deprecations",
                             "Title",
@@ -494,19 +494,19 @@ def test__find_ac_test_result_problems(
                     ],
                 },
             ),
-            "Unsorted",
+            "A text",
             "This may partially work in Checkmk 2.3.0 but will stop working from the next major version onwards.",
             id="unsorted-warn",
         ),
         pytest.param(
             _ACTestResultProblem(
-                ident="ident",
+                ident="A text",
                 type="unsorted",
                 _ac_test_results={
                     SiteId("site_id"): [
                         ACTestResult(
                             ACResultState.CRIT,
-                            "text",
+                            "A text",
                             "test_id",
                             "deprecations",
                             "Title",
@@ -517,7 +517,7 @@ def test__find_ac_test_result_problems(
                     ],
                 },
             ),
-            "Unsorted",
+            "A text",
             "This does not work in Checkmk 2.3.0.",
             id="unsorted-crit",
         ),
diff --git a/tests/unit/cmk/gui/watolib/test_analyze_configuration.py b/tests/unit/cmk/gui/watolib/test_analyze_configuration.py
@@ -36,6 +36,7 @@ def test_registered_ac_tests() -> None:
         "ACTestCheckMKFetcherUsage",
         "ACTestCheckMKCheckerNumber",
         "ACTestCheckMKCheckerUsage",
+        "ACTestUnknownCheckParameterRuleSets",
         "ACTestDeprecatedV1CheckPlugins",
         "ACTestDeprecatedCheckPlugins",
         "ACTestDeprecatedInventoryPlugins",

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,7 @@ def test_registered_automations() -> None:`
`56`	`56`	`"update-dns-cache",`
`57`	`57`	`"update-host-labels",`
`58`	`58`	`"update-passwords-merged-file",`
	`59`	`+ "find-unknown-check-parameter-rule-sets",`
`59`	`60`	`]`
`60`	`61`
`61`	`62`	`if cmk_version.edition(paths.omd_root) is not cmk_version.Edition.CRE:`