17280 FIX Grouping of services in table views

Grouping services in table views did not previously work as expected.

With [Werk 15494](https://checkmk.com/werk/15494), a new service grouping
feature was introduced that did not work as expected in certain situations after
[Werk 15550](https://checkmk.com/werk/15550) fixed a crash related to
service grouping.

Another issue fixed with [Werk 17278](https://checkmk.com/werk/15494) partially
broke the feature even more.

The original feature also had a bug where when using non-matching
groups, the group title would be displayed incorrectly, in specific situations.

All of the above are now fixed and the original feature is restored and
working again.

SUP-19435

Change-Id: I86ffd5845957dc4b4a51733cac19499d50a897f0

Author: loocars

.werks/17280.md

@@ -0,0 +1,28 @@
+[//]: # (werk v2)
+# Grouping of services in table views
+
+key        | value
+---------- | ---
+date       | 2025-02-07T06:32:29+00:00
+version    | 2.4.0b1
+class      | fix
+edition    | cre
+component  | multisite
+level      | 1
+compatible | yes
+
+Grouping services in table views did not previously work as expected.
+
+With [Werk 15494](https://checkmk.com/werk/15494), a new service grouping
+feature was introduced that did not work as expected in certain situations after
+[Werk 15550](https://checkmk.com/werk/15550) fixed a crash related to
+service grouping.
+
+Another issue fixed with [Werk 17278](https://checkmk.com/werk/15494) partially
+broke the feature even more.
+
+The original feature also had a bug where when using non-matching
+groups, the group title would be displayed incorrectly, in specific situations.
+
+All of the above are now fixed and the original feature is restored and
+working again.

cmk/gui/views/layout/layouts.py

@@ -11,8 +11,6 @@
 
 from cmk.ccc.exceptions import MKGeneralException
 
-from cmk.utils.regex import escape_regex_chars
-
 from cmk.gui import utils
 from cmk.gui.config import active_config
 from cmk.gui.data_source import row_id
@@ -404,22 +402,26 @@ def calculate_view_grouping_of_services(
     return groupings, rows_with_ids
 
 
+def get_group_spec(group_spec: GroupSpec, service_name: str) -> GroupSpec:
+    if re.findall(r"\\\d", group_spec["title"]):
+        return GroupSpec(
+            title=re.sub(
+                pattern=group_spec["pattern"],
+                repl=group_spec["title"],
+                string=service_name,
+            ),
+            pattern=group_spec["pattern"],
+            min_items=group_spec["min_items"],
+        )
+    return group_spec
+
+
 def try_to_match_group(row: Row) -> GroupSpec | None:
     for group_spec in active_config.service_view_grouping:
         if row.get("service_description") and re.match(
             group_spec["pattern"], row["service_description"]
         ):
-            if re.findall(r"(\([^)]*\))", group_spec["pattern"]):
-                return GroupSpec(
-                    title=re.sub(
-                        group_spec["pattern"],
-                        escape_regex_chars(group_spec["title"]),
-                        row["service_description"],
-                    ),
-                    pattern=group_spec["pattern"],
-                    min_items=group_spec["min_items"],
-                )
-            return group_spec
+            return get_group_spec(group_spec, row["service_description"])
 
     return None
 

tests/unit/cmk/gui/views/layout/test_layouts.py

@@ -0,0 +1,118 @@
+#!/usr/bin/env python3
+# Copyright (C) 2025 Checkmk GmbH - License: GNU General Public License v2
+# This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
+# conditions defined in the file COPYING, which is part of this source code package.
+
+import pytest
+
+from cmk.gui.type_defs import GroupSpec
+from cmk.gui.views.layout.layouts import get_group_spec
+
+
+@pytest.mark.parametrize(
+    "group_spec, expected_group_spec, service_name",
+    [
+        pytest.param(
+            GroupSpec(
+                title="Hardware",
+                pattern="(?i:cpu)|(?i:interface).*",
+                min_items=2,
+            ),
+            GroupSpec(
+                title="Hardware",
+                pattern="(?i:cpu)|(?i:interface).*",
+                min_items=2,
+            ),
+            "Interface 1",
+            id="non-capturing groups case 1 (SUP-19435)",
+        ),
+        pytest.param(
+            GroupSpec(
+                title="Hardware",
+                pattern="(?i:cpu)|(?i:interface).*",
+                min_items=2,
+            ),
+            GroupSpec(
+                title="Hardware",
+                pattern="(?i:cpu)|(?i:interface).*",
+                min_items=2,
+            ),
+            "CPU load",
+            id="non-capturing groups case 2 (SUP-19435)",
+        ),
+        pytest.param(
+            GroupSpec(
+                title="CPU",
+                pattern="(?!.*(CPU)).*",
+                min_items=2,
+            ),
+            GroupSpec(
+                title="CPU",
+                pattern="(?!.*(CPU)).*",
+                min_items=2,
+            ),
+            "CPU load",
+            id="non-capturing groups case 3 (SUP-21609)",
+        ),
+        pytest.param(
+            GroupSpec(
+                title=r"Oracle instance \1",
+                pattern="ORA ([A-Za-z0-9]+).*",
+                min_items=2,
+            ),
+            GroupSpec(
+                title="Oracle instance 1337",
+                pattern="ORA ([A-Za-z0-9]+).*",
+                min_items=2,
+            ),
+            "ORA 1337",
+            id="match group replacement (SUP-13124)",
+        ),
+        pytest.param(
+            GroupSpec(
+                title="LocalChecks",
+                pattern="local_",
+                min_items=2,
+            ),
+            GroupSpec(
+                title="LocalChecks",
+                pattern="local_",
+                min_items=2,
+            ),
+            r"local_\PTest",
+            id=r"Bad escape \P (SUP-14585)",
+        ),
+        pytest.param(
+            GroupSpec(
+                title=r"LocalChecks \1",
+                pattern="local_(.*)",
+                min_items=2,
+            ),
+            GroupSpec(
+                title=r"LocalChecks \PTest",
+                pattern="local_(.*)",
+                min_items=2,
+            ),
+            r"local_\PTest",
+            id=r"Bad escape \P (SUP-14585)",
+        ),
+        pytest.param(
+            GroupSpec(
+                title=r"Foo \1 Bar \2",
+                pattern=r"my_(\d+)_services_(\d+)",
+                min_items=2,
+            ),
+            GroupSpec(
+                title=r"Foo 10 Bar 20",
+                pattern=r"my_(\d+)_services_(\d+)",
+                min_items=2,
+            ),
+            "my_10_services_20",
+            id="two match groups replacement",
+        ),
+    ],
+)
+def test_get_group_spec(
+    group_spec: GroupSpec, expected_group_spec: GroupSpec, service_name: str
+) -> None:
+    assert get_group_spec(group_spec, service_name) == expected_group_spec