Rename onFailure to on_failure to match casing convention

Change-Id: Ifbd98ceb330ceed47a01cc560bf40885bc16b443

Author: benfogel

README.md

@@ -93,9 +93,9 @@ Below details the health check modules available as part of the solution, with s
 | CheckDataVolumes     | Checks that the expected # of Data Volumes are 100% imported and ready | **namespace**: namespace to run check against <br >   **count**: (Optional) expected # of DVs |
 | CheckHttpEndpoints   | Checks that a list of HTTP endpoints are reachable and return a successful status code | **endpoints**: A list of HTTP endpoints to check. Each endpoint has the following parameters: <ul><li> **name**: The name of the endpoint </li><li> **url**: The URL of the endpoint </li><li> **timeout**: (Optional) The timeout in seconds for the request </li><li> **method**: (Optional) The HTTP method to use (e.g. 'GET', 'POST') </li></ul> |
 
-### onFailure property
+### on_failure property
 
-Each health check module supports an `onFailure` property that allows you to control the behavior of the health check when it fails. The `onFailure` property can be set to one of two values:
+Each health check module supports an `on_failure` property that allows you to control the behavior of the health check when it fails. The `on_failure` property can be set to one of two values:
 
 - `fail` (default): If the health check fails, the entire group of checks (platform or workload) will be considered failed.
 - `ignore`: If the health check fails, the failure will be logged and tracked in metrics, but it will not affect the overall health status of the group.
@@ -110,17 +110,17 @@ platform_checks:
   module: CheckNodes
 - name: Robin Cluster Health
   module: CheckRobinCluster
-  onFailure: ignore
+  on_failure: ignore
 
 workload_checks:
 - name: VM Workloads Health
   module: CheckVirtualMachines
   parameters:
     namespace: vm-workloads
-  onFailure: fail
+  on_failure: fail
 - name: VM Disk Health
   module: CheckVirtualMachineDisks
-  onFailure: ignore
+  on_failure: ignore
 ```
 
 ## Building the image

app/app.py

@@ -121,7 +121,7 @@ def wait_on_futures(futures):
             for future in concurrent.futures.as_completed(futures):
                 config = futures[future]
                 name = config["name"]
-                on_failure = config.get("onFailure", "fail")
+                on_failure = config.get("on_failure", "fail")
                 try:
                     if not future.result():
                         if on_failure == "fail":

app/config.py

@@ -26,7 +26,7 @@ class HealthCheck(TypedDict):
     name: str
     module: str
     parameters: NotRequired[dict] = {}
-    onFailure: NotRequired[str] = "fail"
+    on_failure: NotRequired[str] = "fail"
 
 
 class Config(BaseModel):

app/test_app.py

@@ -44,12 +44,12 @@ def test_run_checks_onfailure_ignore(self, mock_health_check_map, mock_health_ch
                 {
                     "name": "CheckNodes",
                     "module": "CheckNodes",
-                    "onFailure": "ignore"
+                    "on_failure": "ignore"
                 },
                 {
                     "name": "CheckRobinCluster",
                     "module": "CheckRobinCluster",
-                    "onFailure": "fail"
+                    "on_failure": "fail"
                 }
             ],
             workload_checks=[]
@@ -89,7 +89,7 @@ def test_run_checks_onfailure_fail(self, mock_health_check_map, mock_health_chec
                 {
                     "name": "CheckNodes",
                     "module": "CheckNodes",
-                    "onFailure": "fail"
+                    "on_failure": "fail"
                 }
             ],
             workload_checks=[]

app/test_config.py

@@ -33,12 +33,12 @@ def test_optional_module_parameters(self):
         self.assertEqual(len(result.platform_checks), 4)
         self.assertEqual(len(result.workload_checks), 2)
 
-    def test_onfailure_property(self):
+    def test_on_failure_property(self):
         os.environ["APP_CONFIG_PATH"] = "testdata/onfailure_config.yaml"
         result = read_config()
-        self.assertEqual(result.platform_checks[1]["onFailure"], "ignore")
-        self.assertEqual(result.workload_checks[0]["onFailure"], "fail")
-        self.assertEqual(result.workload_checks[1]["onFailure"], "ignore")
+        self.assertEqual(result.platform_checks[1]["on_failure"], "ignore")
+        self.assertEqual(result.workload_checks[0]["on_failure"], "fail")
+        self.assertEqual(result.workload_checks[1]["on_failure"], "ignore")
         # Check default value
-        self.assertNotIn("onFailure", result.platform_checks[0])
+        self.assertNotIn("on_failure", result.platform_checks[0])
 

app/testdata/onfailure_config.yaml

@@ -3,14 +3,14 @@ platform_checks:
   module: CheckNodes
 - name: Robin Cluster Health
   module: CheckRobinCluster
-  onFailure: ignore
+  on_failure: ignore
 
 workload_checks:
 - name: VM Workloads Health
   module: CheckVirtualMachines
   parameters:
     namespace: vm-workloads
-  onFailure: fail
+  on_failure: fail
 - name: VM Disk Health
   module: CheckVirtualMachineDisks
-  onFailure: ignore
+  on_failure: ignore