convert constants to enums

Author: nora-codecov

services/notification/notifiers/mixins/status.py

@@ -25,33 +25,37 @@ class StatusResult(TypedDict):
     included_helper_text: dict[str, str]
 
 
-CUSTOM_TARGET_TEXT_PATCH_KEY = "custom_target_helper_text_patch"
-CUSTOM_TARGET_TEXT_PROJECT_KEY = "custom_target_helper_text_project"
-CUSTOM_RCB_INDIRECT_CHANGES_KEY = "custom_rcb_indirect_changes_helper_text"
-CUSTOM_RCB_ADJUST_BASE_KEY = "custom_rcb_adjust_base_helper_text"
-CUSTOM_TARGET_TEXT_VALUE = (
-    "Your {context} {notification_type} has failed because the {point_of_comparison} coverage ({coverage}%) is below the target coverage ({target}%). "
-    "You can increase the {point_of_comparison} coverage or adjust the "
-    "[target](https://docs.codecov.com/docs/commit-status#target) coverage."
-)
-CUSTOM_RCB_INDIRECT_CHANGES_VALUE = (
-    "Your {context} {notification_type} has failed because you have indirect coverage changes. "
-    "Learn more about [Unexpected Coverage Changes](https://docs.codecov.com/docs/unexpected-coverage-changes) "
-    "and [reasons for indirect coverage changes](https://docs.codecov.com/docs/unexpected-coverage-changes#reasons-for-indirect-changes)."
-)
-CUSTOM_RCB_TEXT_VALUE = (
-    "Your project {notification_type} has failed because the head coverage ({coverage}%) "
-    "is below the [adjusted base coverage](https://docs.codecov.com/docs/removed-code-behavior#option-3-default-adjust_base) ({adjusted_base_cov}%). "
-    "You can increase the head coverage or adjust the "
-    "[Removed Code Behavior](https://docs.codecov.com/docs/removed-code-behavior)."
-)
+class HelperTextKey(str, Enum):
+    CUSTOM_TARGET_PATCH = "custom_target_helper_text_patch"
+    CUSTOM_TARGET_PROJECT = "custom_target_helper_text_project"
+    RCB_INDIRECT_CHANGES = "rcb_indirect_changes_helper_text"
+    RCB_ADJUST_BASE = "rcb_adjust_base_helper_text"
+
+
+class HelperTextTemplate(str, Enum):
+    CUSTOM_TARGET = (
+        "Your {context} {notification_type} has failed because the {point_of_comparison} coverage ({coverage}%) is below the target coverage ({target}%). "
+        "You can increase the {point_of_comparison} coverage or adjust the "
+        "[target](https://docs.codecov.com/docs/commit-status#target) coverage."
+    )
+    INDIRECT_CHANGES = (
+        "Your {context} {notification_type} has failed because you have indirect coverage changes. "
+        "Learn more about [Unexpected Coverage Changes](https://docs.codecov.com/docs/unexpected-coverage-changes) "
+        "and [reasons for indirect coverage changes](https://docs.codecov.com/docs/unexpected-coverage-changes#reasons-for-indirect-changes)."
+    )
+    RCB_ADJUST_BASE = (
+        "Your project {notification_type} has failed because the head coverage ({coverage}%) "
+        "is below the [adjusted base coverage](https://docs.codecov.com/docs/removed-code-behavior#option-3-default-adjust_base) ({adjusted_base_cov}%). "
+        "You can increase the head coverage or adjust the "
+        "[Removed Code Behavior](https://docs.codecov.com/docs/removed-code-behavior)."
+    )
 
 
 HELPER_TEXT_MAP = {
-    CUSTOM_TARGET_TEXT_PATCH_KEY: CUSTOM_TARGET_TEXT_VALUE,
-    CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE,
-    CUSTOM_RCB_INDIRECT_CHANGES_KEY: CUSTOM_RCB_INDIRECT_CHANGES_VALUE,
-    CUSTOM_RCB_ADJUST_BASE_KEY: CUSTOM_RCB_TEXT_VALUE,
+    HelperTextKey.CUSTOM_TARGET_PATCH: HelperTextTemplate.CUSTOM_TARGET,
+    HelperTextKey.CUSTOM_TARGET_PROJECT: HelperTextTemplate.CUSTOM_TARGET,
+    HelperTextKey.RCB_INDIRECT_CHANGES: HelperTextTemplate.INDIRECT_CHANGES,
+    HelperTextKey.RCB_ADJUST_BASE: HelperTextTemplate.RCB_ADJUST_BASE,
 }
 
 
@@ -130,14 +134,18 @@ def get_patch_status(
                         f"{coverage_rounded}% of diff hit (target {target_rounded}%)"
                     )
                 if state == StatusState.failure.value and is_custom_target:
-                    helper_text = HELPER_TEXT_MAP[CUSTOM_TARGET_TEXT_PATCH_KEY].format(
+                    helper_text = HELPER_TEXT_MAP[
+                        HelperTextKey.CUSTOM_TARGET_PATCH
+                    ].value.format(
                         context=self.context,
                         notification_type=notification_type,
                         point_of_comparison=self.context,
                         coverage=coverage_rounded,
                         target=target_rounded,
                     )
-                    included_helper_text[CUSTOM_TARGET_TEXT_PATCH_KEY] = helper_text
+                    included_helper_text[HelperTextKey.CUSTOM_TARGET_PATCH.value] = (
+                        helper_text
+                    )
             return StatusResult(
                 state=state, message=message, included_helper_text=included_helper_text
             )
@@ -334,9 +342,9 @@ def _apply_adjust_base_behavior(
         coverage_rounded = round_number(self.current_yaml, head_coverage)
 
         # their comparison failed despite the adjusted base, give them helper text about it
-        helper_text[CUSTOM_RCB_ADJUST_BASE_KEY] = HELPER_TEXT_MAP[
-            CUSTOM_RCB_ADJUST_BASE_KEY
-        ].format(
+        helper_text[HelperTextKey.RCB_ADJUST_BASE.value] = HELPER_TEXT_MAP[
+            HelperTextKey.RCB_ADJUST_BASE
+        ].value.format(
             notification_type=notification_type,
             coverage=coverage_rounded,
             adjusted_base_cov=rounded_base_adjusted_coverage,
@@ -370,8 +378,8 @@ def _apply_fully_covered_patch_behavior(
             )
 
             # their comparison failed because of unexpected/indirect changes, give them helper text about it
-            helper_text[CUSTOM_RCB_INDIRECT_CHANGES_KEY] = HELPER_TEXT_MAP[
-                CUSTOM_RCB_INDIRECT_CHANGES_KEY
+            helper_text[HelperTextKey.RCB_INDIRECT_CHANGES] = HELPER_TEXT_MAP[
+                HelperTextKey.RCB_INDIRECT_CHANGES
             ].format(
                 context=self.context,
                 notification_type=notification_type,
@@ -550,14 +558,16 @@ def _get_project_status(
             target_rounded = round_number(self.current_yaml, target_coverage)
             message = f"{head_coverage_rounded}% (target {target_rounded}%)"
             if state == StatusState.failure.value:
-                helper_text = HELPER_TEXT_MAP[CUSTOM_TARGET_TEXT_PROJECT_KEY].format(
+                helper_text = HELPER_TEXT_MAP[
+                    HelperTextKey.CUSTOM_TARGET_PROJECT
+                ].value.format(
                     context=self.context,
                     notification_type=notification_type,
                     point_of_comparison=self.point_of_comparison,
                     coverage=head_coverage_rounded,
                     target=target_rounded,
                 )
-                included_helper_text[CUSTOM_TARGET_TEXT_PROJECT_KEY] = helper_text
+                included_helper_text[HelperTextKey.CUSTOM_TARGET_PROJECT] = helper_text
             return StatusResult(
                 state=state, message=message, included_helper_text=included_helper_text
             )

services/notification/notifiers/tests/unit/test_checks.py

@@ -21,8 +21,8 @@
     ChecksWithFallback,
 )
 from services.notification.notifiers.mixins.status import (
-    CUSTOM_TARGET_TEXT_PATCH_KEY,
-    CUSTOM_TARGET_TEXT_VALUE,
+    HelperTextKey,
+    HelperTextTemplate,
 )
 from services.notification.notifiers.status import PatchStatusNotifier
 from tests.helpers import mock_all_plans_and_tiers
@@ -798,7 +798,7 @@ def test_build_payload_target_coverage_failure(
                 "annotations": [],
             },
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PATCH_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PATCH: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="patch",
                     notification_type="check",
                     point_of_comparison="patch",

services/notification/notifiers/tests/unit/test_status.py

@@ -21,12 +21,9 @@
 from services.decoration import Decoration
 from services.notification.notifiers.base import NotificationResult
 from services.notification.notifiers.mixins.status import (
-    CUSTOM_RCB_INDIRECT_CHANGES_KEY,
-    CUSTOM_RCB_ADJUST_BASE_KEY,
-    CUSTOM_TARGET_TEXT_PATCH_KEY,
-    CUSTOM_TARGET_TEXT_PROJECT_KEY,
-    CUSTOM_TARGET_TEXT_VALUE,
     HELPER_TEXT_MAP,
+    HelperTextKey,
+    HelperTextTemplate,
 )
 from services.notification.notifiers.status import (
     ChangesStatusNotifier,
@@ -1611,9 +1608,9 @@ def test_notify_pass_via_removals_only_behavior(
                 (
                     None,
                     {
-                        CUSTOM_RCB_ADJUST_BASE_KEY: HELPER_TEXT_MAP[
-                            CUSTOM_RCB_ADJUST_BASE_KEY
-                        ].format(
+                        HelperTextKey.RCB_ADJUST_BASE.value: HELPER_TEXT_MAP[
+                            HelperTextKey.RCB_ADJUST_BASE
+                        ].value.format(
                             notification_type="status",
                             coverage=94.27,
                             adjusted_base_cov=94.28,
@@ -1744,7 +1741,7 @@ def test_notify_removed_code_behavior_fail(
             "message": "60.00% (target 80.00%)",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PROJECT: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="project",
                     notification_type="status",
                     point_of_comparison="head",
@@ -1798,9 +1795,9 @@ def test_notify_adjust_base_behavior_fail(
             "message": f"50.00% (-10.00%) compared to {sample_comparison.project_coverage_base.commit.commitid[:7]}",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_RCB_ADJUST_BASE_KEY: HELPER_TEXT_MAP[
-                    CUSTOM_RCB_ADJUST_BASE_KEY
-                ].format(
+                HelperTextKey.RCB_ADJUST_BASE.value: HELPER_TEXT_MAP[
+                    HelperTextKey.RCB_ADJUST_BASE
+                ].value.format(
                     notification_type="status",
                     coverage="50.00",
                     adjusted_base_cov=71.43,
@@ -1880,7 +1877,7 @@ def test_notify_adjust_base_behavior_skips_if_target_coverage_defined(
             "message": "50.00% (target 80.00%)",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PROJECT: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="project",
                     notification_type="status",
                     point_of_comparison="head",
@@ -1912,7 +1909,7 @@ def test_notify_removed_code_behavior_unknown(
             "message": "60.00% (target 80.00%)",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PROJECT: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="project",
                     notification_type="status",
                     point_of_comparison="head",
@@ -1973,7 +1970,7 @@ def test_notify_fully_covered_patch_behavior_fail(
             "message": "50.00% (target 70.00%)",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PROJECT: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="project",
                     notification_type="status",
                     point_of_comparison="head",
@@ -2035,16 +2032,16 @@ def test_notify_fully_covered_patch_behavior_fail_indirect_changes(
             "message": "50.00% (target 70.00%)",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PROJECT.value: HelperTextTemplate.CUSTOM_TARGET.value.format(
                     context="project",
                     notification_type="status",
                     point_of_comparison="head",
                     coverage="50.00",
                     target="70.00",
                 ),
-                CUSTOM_RCB_INDIRECT_CHANGES_KEY: HELPER_TEXT_MAP[
-                    CUSTOM_RCB_INDIRECT_CHANGES_KEY
-                ].format(
+                HelperTextKey.RCB_INDIRECT_CHANGES.value: HELPER_TEXT_MAP[
+                    HelperTextKey.RCB_INDIRECT_CHANGES
+                ].value.format(
                     context="project",
                     notification_type="status",
                 ),
@@ -2329,7 +2326,7 @@ def test_build_payload_target_coverage_failure(
             "message": "66.67% of diff hit (target 70.00%)",
             "state": "failure",
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PATCH_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PATCH: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="patch",
                     notification_type="status",
                     point_of_comparison="patch",

services/notification/tests/unit/test_notification_service.py

@@ -31,9 +31,8 @@
     ChecksWithFallback,
 )
 from services.notification.notifiers.mixins.status import (
-    CUSTOM_TARGET_TEXT_PATCH_KEY,
-    CUSTOM_TARGET_TEXT_PROJECT_KEY,
-    CUSTOM_TARGET_TEXT_VALUE,
+    HelperTextKey,
+    HelperTextTemplate,
 )
 from tests.helpers import mock_all_plans_and_tiers
 
@@ -774,7 +773,7 @@ def test_notify_individual_checks_patch_and_project_notifier_included_helper_tex
                 "annotations": [],
             },
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PATCH_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PATCH: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="patch",
                     notification_type="check",
                     point_of_comparison="patch",
@@ -797,7 +796,7 @@ def test_notify_individual_checks_patch_and_project_notifier_included_helper_tex
                 "annotations": [],
             },
             "included_helper_text": {
-                CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE.format(
+                HelperTextKey.CUSTOM_TARGET_PROJECT: HelperTextTemplate.CUSTOM_TARGET.format(
                     context="project",
                     notification_type="check",
                     point_of_comparison="head",
@@ -866,11 +865,11 @@ def test_notify_individual_checks_patch_and_project_notifier_included_helper_tex
                 assert (
                     ":x: "
                     + checks_patch_result["included_helper_text"][
-                        CUSTOM_TARGET_TEXT_PATCH_KEY
+                        HelperTextKey.CUSTOM_TARGET_PATCH
                     ]
                     and ":x: "
                     + checks_proj_result["included_helper_text"][
-                        CUSTOM_TARGET_TEXT_PROJECT_KEY
+                        HelperTextKey.CUSTOM_TARGET_PROJECT
                     ]
                     in r["result"].data_sent["message"]
                 )