innovaphone(licenses): improve check results

We first want the check summary to match our v2 standards which is
yielding individual results with `<label>: <value>` summaries. This made
it so that only the utilization result needed the calculated state and
levels message.

As noted in the comment in this commit, we are not using the check
levels helper here because the legacy plugin was using an exclusive
check for the level boundaries. So as to not break behavior with
existing commits, we are continue to roll our own check levels
implementation in this check.

Change-Id: Ifd1aa8fa0b81472fbccb38256d932506fe2227cf

Author: logan-connolly

cmk/plugins/innovaphone/agent_based/innovaphone_licenses.py

@@ -52,19 +52,25 @@ def discover_innovaphone_licenses(section: LicenseUsage) -> DiscoveryResult:
 
 
 def check_innovaphone_licenses(params: Mapping[str, Any], section: LicenseUsage) -> CheckResult:
-    perc_used = section.utilization
+    yield Result(state=State.OK, summary=f"Used: {section.used}")
+    yield Result(state=State.OK, summary=f"Total: {section.total}")
+
     warn, crit = params["levels"]
-    utilization_message = f" ({perc_used:.0f}%)" if perc_used is not None else ""
-    message = f"Used {section.used}/{section.total} Licences{utilization_message}"
-    levels = f"Warning/ Critical at ({warn}/{crit})"
-    if perc_used is None:
-        yield Result(state=State.UNKNOWN, summary=message)
-    elif perc_used > crit:
-        yield Result(state=State.CRIT, summary=message + levels)
-    elif perc_used > warn:
-        yield Result(state=State.WARN, summary=message + levels)
-    else:
-        yield Result(state=State.OK, summary=message)
+    levels_info = f"(warn/crit at {warn:.0f}%/{crit:.0f}%)"
+
+    # NOTE: not using check levels here because the legacy plugin used a exclusive relationship for
+    # both the warn and critical thresholds. So, we are essentially rolling our own here. That may
+    # change in the future, but requires a deeper look into what that means for deployed envs.
+    match section.utilization:
+        case None:
+            yield Result(state=State.UNKNOWN, summary="Utilization: n/a")
+        case float(value) if value > crit:
+            yield Result(state=State.CRIT, summary=f"Utilization: {value:.0f}% {levels_info}")
+        case float(value) if value > warn:
+            yield Result(state=State.WARN, summary=f"Utilization: {value:.0f}% {levels_info}")
+        case _:
+            yield Result(state=State.OK, summary=f"Utilization: {section.utilization:.0f}%")
+
     yield Metric("licenses", section.used, boundaries=(0, section.total))
 
 

tests/unit/cmk/plugins/innovaphone/agent_based/test_innovaphone_licenses.py

@@ -59,7 +59,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=0, total=0),
             [
-                Result(state=State.UNKNOWN, summary="Used 0/0 Licences"),
+                Result(state=State.OK, summary="Used: 0"),
+                Result(state=State.OK, summary="Total: 0"),
+                Result(state=State.UNKNOWN, summary="Utilization: n/a"),
                 Metric("licenses", 0.0, boundaries=(0.0, 0.0)),
             ],
             id="zero values",
@@ -68,7 +70,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=0, total=100),
             [
-                Result(state=State.OK, summary="Used 0/100 Licences (0%)"),
+                Result(state=State.OK, summary="Used: 0"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.OK, summary="Utilization: 0%"),
                 Metric("licenses", 0.0, boundaries=(0.0, 100.0)),
             ],
             id="zero utilization with nonzero total",
@@ -77,7 +81,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=50, total=100),
             [
-                Result(state=State.OK, summary="Used 50/100 Licences (50%)"),
+                Result(state=State.OK, summary="Used: 50"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.OK, summary="Utilization: 50%"),
                 Metric("licenses", 50.0, boundaries=(0.0, 100.0)),
             ],
             id="ok state",
@@ -86,7 +92,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=90, total=100),
             [
-                Result(state=State.OK, summary="Used 90/100 Licences (90%)"),
+                Result(state=State.OK, summary="Used: 90"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.OK, summary="Utilization: 90%"),
                 Metric("licenses", 90.0, boundaries=(0.0, 100.0)),
             ],
             id="ok state at warn boundary",
@@ -95,10 +103,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=92, total=100),
             [
-                Result(
-                    state=State.WARN,
-                    summary="Used 92/100 Licences (92%)Warning/ Critical at (90.0/95.0)",
-                ),
+                Result(state=State.OK, summary="Used: 92"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.WARN, summary="Utilization: 92% (warn/crit at 90%/95%)"),
                 Metric("licenses", 92.0, boundaries=(0.0, 100.0)),
             ],
             id="warn state",
@@ -107,10 +114,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=95, total=100),
             [
-                Result(
-                    state=State.WARN,
-                    summary="Used 95/100 Licences (95%)Warning/ Critical at (90.0/95.0)",
-                ),
+                Result(state=State.OK, summary="Used: 95"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.WARN, summary="Utilization: 95% (warn/crit at 90%/95%)"),
                 Metric("licenses", 95.0, boundaries=(0.0, 100.0)),
             ],
             id="warn state at crit boundary",
@@ -119,10 +125,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=96, total=100),
             [
-                Result(
-                    state=State.CRIT,
-                    summary="Used 96/100 Licences (96%)Warning/ Critical at (90.0/95.0)",
-                ),
+                Result(state=State.OK, summary="Used: 96"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.CRIT, summary="Utilization: 96% (warn/crit at 90%/95%)"),
                 Metric("licenses", 96.0, boundaries=(0.0, 100.0)),
             ],
             id="crit state",
@@ -131,10 +136,9 @@ def test_discover_innovaphone_licenses() -> None:
             {"levels": (90.0, 95.0)},
             LicenseUsage(used=110, total=100),
             [
-                Result(
-                    state=State.CRIT,
-                    summary="Used 110/100 Licences (110%)Warning/ Critical at (90.0/95.0)",
-                ),
+                Result(state=State.OK, summary="Used: 110"),
+                Result(state=State.OK, summary="Total: 100"),
+                Result(state=State.CRIT, summary="Utilization: 110% (warn/crit at 90%/95%)"),
                 Metric("licenses", 110.0, boundaries=(0.0, 100.0)),
             ],
             id="used > total",