fix typo.

Author: guettli

Tests/kaas/sonobuoy_handler/sonobuoy_handler.py

@@ -43,7 +43,7 @@ def __init__(
         check_name="sonobuoy_handler",
         kubeconfig=None,
         result_dir_name="sonobuoy_results",
-        sonobuoy_config="kaas/sonobuoy-config.yaml",
+        scs_sonobuoy_config_yaml="kaas/sonobuoy-config.yaml",
         args=(),
     ):
         self.check_name = check_name
@@ -57,9 +57,9 @@ def __init__(
         logger.debug(f"working from {self.working_directory}")
         logger.debug(f"placing results at {self.result_dir_name}")
         logger.debug(f"sonobuoy executable at {self.sonobuoy}")
-        if not os.path.exists(sonobuoy_config):
-            raise RuntimeError(f"sonobuoy_config {sonobuoy_config} does not exist.")
-        self.sonobuoy_config = sonobuoy_config
+        if not os.path.exists(scs_sonobuoy_config_yaml):
+            raise RuntimeError(f"scs_sonobuoy_config_yaml {scs_sonobuoy_config_yaml} does not exist.")
+        self.scs_sonobuoy_config_yaml = scs_sonobuoy_config_yaml
         self.args = (arg0 for arg in args for arg0 in shlex.split(str(arg)))
 
     def _invoke_sonobuoy(self, *args, **kwargs):
@@ -104,7 +104,7 @@ def _sonobuoy_retrieve_result(self, plugin='e2e'):
         yaml_path = os.path.join(result_dir, 'plugins', plugin, 'sonobuoy_results.yaml')
         logger.debug(f"parsing results from {yaml_path}")
 
-        return sonobuoy_parse_result(plugin, yaml_path, self.sonobuoy_config)
+        return sonobuoy_parse_result(plugin, yaml_path, self.scs_sonobuoy_config_yaml)
 
     def run(self):
         """
@@ -125,8 +125,8 @@ def run(self):
             self._sonobuoy_delete()
 
 
-def sonobuoy_parse_result(plugin, sonobuoy_results_yaml_path, sonobuoy_config):
-    ok_to_fail_regex_list = _load_ok_to_fail_regex_list(sonobuoy_config)
+def sonobuoy_parse_result(plugin, sonobuoy_results_yaml_path, scs_sonobuoy_config_yaml):
+    ok_to_fail_regex_list = _load_ok_to_fail_regex_list(scs_sonobuoy_config_yaml)
     with open(sonobuoy_results_yaml_path, "r") as fileobj:
         result_obj = yaml.load(fileobj.read(), yaml.SafeLoader)
 
@@ -149,42 +149,42 @@ def sonobuoy_parse_result(plugin, sonobuoy_results_yaml_path, sonobuoy_config):
     return counter
 
 
-def _load_ok_to_fail_regex_list(sonobuoy_config):
-    with open(sonobuoy_config, "r") as fileobj:
+def _load_ok_to_fail_regex_list(scs_sonobuoy_config_yaml):
+    with open(scs_sonobuoy_config_yaml, "r") as fileobj:
         config_obj = yaml.load(fileobj.read(), yaml.SafeLoader) or {}
     if not isinstance(config_obj, dict):
-        raise ValueError(f"Invalid sonobuoy config format in {sonobuoy_config}: top-level YAML object must be a mapping")
+        raise ValueError(f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: top-level YAML object must be a mapping")
     allowed_top_level_keys = {"okToFail"}
     unknown_top_level_keys = set(config_obj) - allowed_top_level_keys
     if unknown_top_level_keys:
         raise ValueError(
-            f"Invalid sonobuoy config format in {sonobuoy_config}: unknown top-level keys: {sorted(unknown_top_level_keys)}"
+            f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: unknown top-level keys: {sorted(unknown_top_level_keys)}"
         )
     ok_to_fail_items = config_obj.get("okToFail", ())
     if not isinstance(ok_to_fail_items, list):
-        raise ValueError(f"Invalid sonobuoy config format in {sonobuoy_config}: okToFail must be a list")
+        raise ValueError(f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: okToFail must be a list")
 
     ok_to_fail_regex_list = []
     for idx, entry in enumerate(ok_to_fail_items):
         if not isinstance(entry, dict):
             raise ValueError(
-                f"Invalid sonobuoy config format in {sonobuoy_config}: okToFail[{idx}] must be a mapping"
+                f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: okToFail[{idx}] must be a mapping"
             )
         allowed_entry_keys = {"regex", "reason"}
         unknown_entry_keys = set(entry) - allowed_entry_keys
         if unknown_entry_keys:
             raise ValueError(
-                f"Invalid sonobuoy config format in {sonobuoy_config}: okToFail[{idx}] has unknown keys: {sorted(unknown_entry_keys)}"
+                f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: okToFail[{idx}] has unknown keys: {sorted(unknown_entry_keys)}"
             )
         regex = entry.get("regex")
         if not isinstance(regex, str) or not regex.strip():
             raise ValueError(
-                f"Invalid sonobuoy config format in {sonobuoy_config}: okToFail[{idx}].regex must be a non-empty string"
+                f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: okToFail[{idx}].regex must be a non-empty string"
             )
         reason = entry.get("reason")
         if not isinstance(reason, str) or not reason.strip():
             raise ValueError(
-                f"Invalid sonobuoy config format in {sonobuoy_config}: okToFail[{idx}].reason must be a non-empty string"
+                f"Invalid sonobuoy config format in {scs_sonobuoy_config_yaml}: okToFail[{idx}].reason must be a non-empty string"
             )
         ok_to_fail_regex_list.append((regex, reason))
     return ok_to_fail_regex_list
@@ -198,7 +198,7 @@ def ok_to_fail(ok_to_fail_regex_list, test_name):
     return False
 
 
-def check_sonobuoy_result(sonobuoy_config, result_yaml):
-    counter = sonobuoy_parse_result("", result_yaml, sonobuoy_config)
+def check_sonobuoy_result(scs_sonobuoy_config_yaml, result_yaml):
+    counter = sonobuoy_parse_result("", result_yaml, scs_sonobuoy_config_yaml)
     for key, value in counter.items():
         print(f"{key}: {value}")