extend coverage-xm` command: item key now coverage-xml-line-rate

+ small refactorings

Author: seebi

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/)
 
-## [0.11.0] 2025-03-xx
+## [0.11.0] 2025-03-21
 
 ### Added
 
@@ -15,6 +15,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - `extend gitlab-link` command:
   - option `--field` to optionally change the target of the expression pattern
 
+### Changed
+
+- `extend coverage-xml` command:
+  - item key now `coverage-xml-line-rate`
+
 
 ## [0.10.1] 2025-03-21
 

cimd/commands/extract/coverage_xml.py

@@ -1,15 +1,23 @@
 """coverage-xml command"""
 
+from enum import Enum
+
 import click
 from defusedxml.ElementTree import ParseError, parse
 
 from cimd.classes.context import ApplicationContext
 from cimd.classes.metadata import Item
 from cimd.classes.shields_link import ShieldsLink
 
-BEST_THRESHOLD = 90
-GOOD_THRESHOLD = 75
-MEDIUM_THRESHOLD = 50
+COMMAND_AND_PREFIX = "coverage-xml"
+
+
+class Threshold(float, Enum):
+    """Color thresholds"""
+
+    MEDIUM = 50
+    GOOD = 75
+    BEST = 90
 
 
 def image_for_line_rate_item(line_rate: float) -> ShieldsLink:
@@ -18,18 +26,18 @@ def image_for_line_rate_item(line_rate: float) -> ShieldsLink:
     same colors as in genbadge project:
     https://github.com/smarie/python-genbadge/blob/main/genbadge/utils_coverage.py#L105C1-L119C17
     """
-    if line_rate < MEDIUM_THRESHOLD:
+    if line_rate < Threshold.MEDIUM:
         color = "red"
-    elif line_rate < GOOD_THRESHOLD:
+    elif line_rate < Threshold.GOOD:
         color = "orange"
-    elif line_rate < BEST_THRESHOLD:
+    elif line_rate < Threshold.BEST:
         color = "green"
     else:
         color = "brightgreen"
     return ShieldsLink(label="Coverage", message=f"{line_rate!s}%", color=color)
 
 
-@click.command(name="coverage-xml")
+@click.command(name=COMMAND_AND_PREFIX)
 @click.argument(
     "XML_FILE",
     type=click.Path(exists=True, dir_okay=False, file_okay=True, readable=True, resolve_path=True),
@@ -52,7 +60,7 @@ def coverage_xml_command(app: ApplicationContext, xml_file: str, replace: bool)
         raise click.UsageError(f"{xml_file} - {error!s}") from error
     root = xml.getroot()
     line_rate: float = round(float(root.attrib.get("line-rate")) * 100, ndigits=2)
-    key = "coverage-py-line-rate"
+    key = f"{COMMAND_AND_PREFIX}-line-rate"
     new_item = Item(
         value=str(line_rate),
         label="Coverage",

cimd/commands/extract/junit_xml.py

@@ -9,6 +9,8 @@
 from cimd.classes.metadata import Item
 from cimd.classes.shields_link import ShieldsLink
 
+COMMAND_AND_PREFIX = "junit-xml"
+
 COLORS = {
     "FAILURES": "red",
     "ERRORS": "orange",
@@ -58,7 +60,7 @@ def junit_xml_command(app: ApplicationContext, xml_file: str, replace: bool) ->
     }
     for _ in counter:
         count = counter.get(_, 0)
-        key = f"junit-xml-{_.lower()}"
+        key = f"{COMMAND_AND_PREFIX}-{_.lower()}"
         new_item = Item(
             value=str(count),
             label=f"Test {_.title()}",

cimd/commands/extract/trivy_scans.py

@@ -9,6 +9,8 @@
 from cimd.classes.metadata import Item
 from cimd.classes.shields_link import ShieldsLink
 
+COMMAND_AND_PREFIX = "trivy-scan"
+
 COLORS = {
     "CRITICAL": "red",
     "HIGH": "orange",
@@ -56,7 +58,7 @@ def image_for_severity_count(severity: str, count: int) -> str:
     return ShieldsLink(label=severity, message=str(count), color=color, logo="trivy").to_string()
 
 
-@click.command(name="trivy-scan")
+@click.command(name=COMMAND_AND_PREFIX)
 @click.argument(
     "JSON_FILE",
     type=click.Path(exists=True, dir_okay=False, file_okay=True, readable=True, resolve_path=True),
@@ -96,7 +98,7 @@ def trivy_scan_command(
         severities = list(set(severities))
     for _ in severities:
         count = counter.get(_, 0)
-        key = f"trivy-scan-{_.lower()}"
+        key = f"{COMMAND_AND_PREFIX}-{_.lower()}"
         new_item = Item(
             value=str(count),
             label=_,

tests/test_extract_coverage_xml.py

@@ -44,7 +44,7 @@ def test_success(fixture_data: FixtureData) -> None:
     assert run(command=("list", "--keys-only")).line_count == 0
     run(command=("extract", "coverage-xml", fixture_data.filepath))
     assert run(command=("list", "--keys-only")).line_count == 1
-    assert run(command=("get", "coverage-py-line-rate")).lines[0] == str(fixture_data.line_rate)
+    assert run(command=("get", "coverage-xml-line-rate")).lines[0] == str(fixture_data.line_rate)
 
 
 def test_fail() -> None: