Merge pull request #199 from thom311/th/render-undefined-variables

[th/render-undefined-variables] task: rework setting template variables by moving to parent Task.get_template_args()

#199

Author: thom311

pluginMeasureCpu.py

@@ -61,13 +61,6 @@ def __init__(self, ts: TestSettings, task_role: TaskRole, tenant: bool):
         )
         self.pod_name = f"tools-pod-{self.node_name}-measure-cpu"
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-        return {
-            **super().get_template_args(),
-            "pod_name": self.pod_name,
-            "test_image": tftbase.get_tft_test_image(),
-        }
-
     def initialize(self) -> None:
         super().initialize()
         self.render_file("Server Pod Yaml")

pluginMeasurePower.py

@@ -69,13 +69,6 @@ def __init__(self, ts: TestSettings, task_role: TaskRole, tenant: bool):
         )
         self.pod_name = f"tools-pod-{self.node_name}-measure-cpu"
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-        return {
-            **super().get_template_args(),
-            "pod_name": self.pod_name,
-            "test_image": tftbase.get_tft_test_image(),
-        }
-
     def initialize(self) -> None:
         super().initialize()
         self.render_file("Server Pod Yaml")

pluginValidateOffload.py

@@ -166,13 +166,6 @@ def __init__(
         self.perf_pod_name = perf_instance.pod_name
         self.perf_pod_type = perf_instance.pod_type
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-        return {
-            **super().get_template_args(),
-            "pod_name": self.pod_name,
-            "test_image": tftbase.get_tft_test_image(),
-        }
-
     def initialize(self) -> None:
         super().initialize()
         self.render_file("Server Pod Yaml")

task.py

@@ -21,8 +21,8 @@
 
 from ktoolbox import common
 from ktoolbox import host
-from ktoolbox import netdev
 from ktoolbox import kjinja2
+from ktoolbox import netdev
 from ktoolbox.k8sClient import K8sClient
 
 import testConfig
@@ -332,22 +332,33 @@ def get_template_args(self) -> dict[str, str | list[str]]:
             "test_image": tftbase.get_tft_test_image(),
             "image_pull_policy": tftbase.get_tft_image_pull_policy(),
             "command": ["/usr/bin/container-entry-point.sh"],
-            "args": [],
+            "args": self._get_template_args_args(),
             "index": f"{self.index}",
             "node_name": self.node_name,
+            "pod_name": self.pod_name,
+            "port": self._get_template_args_port(),
             "secondary_network_nad": self.ts.connection.effective_secondary_network_nad,
             "use_secondary_network": (
                 "1" if self.ts.connection.secondary_network_nad else ""
             ),
-            "resource_name": self.ts.connection.resource_name
-            or Task._fetch_default_resource_name(
-                self.client,
-                self.get_namespace(),
-                self.ts.connection.secondary_network_nad,
-            )
-            or "",
+            "resource_name": (
+                self.ts.connection.resource_name
+                or Task._fetch_default_resource_name(
+                    self.client,
+                    self.get_namespace(),
+                    self.ts.connection.secondary_network_nad,
+                )
+                or ""
+            ),
+            "default_network": self.node.default_network,
         }
 
+    def _get_template_args_port(self) -> str:
+        return ""
+
+    def _get_template_args_args(self) -> list[str]:
+        return []
+
     def render_file(
         self,
         log_info: str,
@@ -371,7 +382,14 @@ def render_file(
             out_file=out_file_yaml,
         )
 
-        rendered_dict = yaml.safe_load(rendered)
+        try:
+            rendered_dict = yaml.safe_load(rendered)
+        except Exception as e:
+            logger.error(
+                f'"{in_file_template}" rendered as {repr(rendered)} is not valid YAML: {e}'
+            )
+            raise
+
         logger.debug(f'"{in_file_template}" contains: {json.dumps(rendered_dict)}')
 
     def initialize(self) -> None:
@@ -765,18 +783,8 @@ def __init__(self, ts: TestSettings):
         self.out_file_yaml = out_file_yaml
         self.pod_name = pod_name
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-
-        extra_args: dict[str, str] = {}
-        if self.connection_mode != ConnectionMode.EXTERNAL_IP:
-            extra_args["pod_name"] = self.pod_name
-            extra_args["port"] = f"{self.port}"
-
-        return {
-            **super().get_template_args(),
-            "default_network": self.ts.node_server.default_network,
-            **extra_args,
-        }
+    def _get_template_args_port(self) -> str:
+        return str(self.port)
 
     def initialize(self) -> None:
         super().initialize()
@@ -793,6 +801,11 @@ def initialize(self) -> None:
             self.create_ingress_multi_network_policy(self.port)
             self.create_egress_multi_network_policy(self.port)
 
+    def _get_template_args_args(self) -> list[str]:
+        if not self.exec_persistent:
+            return []
+        return self.cmd_line_args(for_template=True)
+
     def confirm_server_alive(self) -> None:
         if self.connection_mode == ConnectionMode.EXTERNAL_IP:
             # Podman scenario
@@ -816,8 +829,11 @@ def confirm_server_alive(self) -> None:
         self.ts.event_server_alive.set()
 
     @abstractmethod
+    def cmd_line_args(self, *, for_template: bool = False) -> list[str]:
+        raise RuntimeError()
+
     def _create_setup_operation_get_thread_action_cmd(self) -> str:
-        pass
+        return shlex.join(self.cmd_line_args())
 
     @abstractmethod
     def _create_setup_operation_get_cancel_action_cmd(self) -> str:
@@ -931,13 +947,6 @@ def __init__(self, ts: TestSettings, server: ServerTask):
         self.out_file_yaml = out_file_yaml
         self.pod_name = pod_name
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-        return {
-            **super().get_template_args(),
-            "default_network": self.ts.node_client.default_network,
-            "pod_name": self.pod_name,
-        }
-
     def initialize(self) -> None:
         super().initialize()
         self.render_file("Client Pod Yaml")

testTypeHttp.py

@@ -1,4 +1,3 @@
-import shlex
 import time
 
 from dataclasses import dataclass
@@ -34,7 +33,7 @@ def _create_server_client(self, ts: TestSettings) -> tuple[ServerTask, ClientTas
 
 
 class HttpServer(task.ServerTask):
-    def cmd_line_args(self) -> list[str]:
+    def cmd_line_args(self, *, for_template: bool = False) -> list[str]:
         return [
             "python3",
             "-m",
@@ -44,20 +43,6 @@ def cmd_line_args(self) -> list[str]:
             f"{self.port}",
         ]
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-
-        extra_args: dict[str, str | list[str]] = {}
-        if self.exec_persistent:
-            extra_args["args"] = self.cmd_line_args()
-
-        return {
-            **super().get_template_args(),
-            **extra_args,
-        }
-
-    def _create_setup_operation_get_thread_action_cmd(self) -> str:
-        return shlex.join(self.cmd_line_args())
-
     def _create_setup_operation_get_cancel_action_cmd(self) -> str:
         return "killall python3"
 

testTypeIperf.py

@@ -1,5 +1,5 @@
-import logging
 import json
+import logging
 import task
 
 from collections.abc import Mapping
@@ -108,19 +108,18 @@ def can_run_reverse(self) -> bool:
 
 
 class IperfServer(task.ServerTask):
-    def get_template_args(self) -> dict[str, str | list[str]]:
-
-        extra_args: dict[str, str | list[str]] = {}
-        if self.exec_persistent:
-            extra_args["args"] = [IPERF_EXE, "-s", "-p", f"{self.port}"]
-
-        return {
-            **super().get_template_args(),
-            **extra_args,
-        }
-
-    def _create_setup_operation_get_thread_action_cmd(self) -> str:
-        return f"{IPERF_EXE} -s -p {self.port} --one-off --json"
+    def cmd_line_args(self, *, for_template: bool = False) -> list[str]:
+        if for_template:
+            extra_args = []
+        else:
+            extra_args = ["--one-off", "--json"]
+        return [
+            IPERF_EXE,
+            "-s",
+            "-p",
+            f"{self.port}",
+            *extra_args,
+        ]
 
     def _create_setup_operation_get_cancel_action_cmd(self) -> str:
         return f"killall {IPERF_EXE}"

testTypeNetPerf.py

@@ -76,19 +76,13 @@ def _create_server_client(self, ts: TestSettings) -> tuple[ServerTask, ClientTas
 
 
 class NetPerfServer(task.ServerTask):
-    def get_template_args(self) -> dict[str, str | list[str]]:
-
-        extra_args: dict[str, str | list[str]] = {}
-        if self.exec_persistent:
-            extra_args["args"] = [NETPERF_SERVER_EXE, "-p", f"{self.port}", "-N"]
-
-        return {
-            **super().get_template_args(),
-            **extra_args,
-        }
-
-    def _create_setup_operation_get_thread_action_cmd(self) -> str:
-        return f"{NETPERF_SERVER_EXE} -p {self.port} -N"
+    def cmd_line_args(self, *, for_template: bool = False) -> list[str]:
+        return [
+            NETPERF_SERVER_EXE,
+            "-p",
+            f"{self.port}",
+            "-N",
+        ]
 
     def _create_setup_operation_get_cancel_action_cmd(self) -> str:
         return f"killall {NETPERF_SERVER_EXE}"

testTypeSimple.py

@@ -34,7 +34,7 @@ def _create_server_client(self, ts: TestSettings) -> tuple[ServerTask, ClientTas
 
 
 class SimpleServer(task.ServerTask):
-    def cmd_line_args(self) -> list[str]:
+    def cmd_line_args(self, *, for_template: bool = False) -> list[str]:
         return [
             CMD_SIMPLE_TCP_SERVER_CLIENT,
             "--server",
@@ -45,20 +45,6 @@ def cmd_line_args(self) -> list[str]:
             *(self.ts.cfg_descr.get_server().args or ()),
         ]
 
-    def get_template_args(self) -> dict[str, str | list[str]]:
-
-        extra_args: dict[str, str | list[str]] = {}
-        if self.exec_persistent:
-            extra_args["args"] = self.cmd_line_args()
-
-        return {
-            **super().get_template_args(),
-            **extra_args,
-        }
-
-    def _create_setup_operation_get_thread_action_cmd(self) -> str:
-        return shlex.join(self.cmd_line_args())
-
     def _create_setup_operation_get_cancel_action_cmd(self) -> str:
         return "killall python3"