Add --argument option to the exec driver

Allows to pass arguments to all benchmarked commands (especially using `temci short exec`), closes #95.
parttimenerd · Sep 24, 2019 · 74086d2 · 74086d2
1 parent 320f412
commit 74086d2
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 8 deletions.
diff --git a/doc/temci_exec.rst b/doc/temci_exec.rst
@@ -32,10 +32,21 @@ as ``temci exec``:
 
     Usage: temci short exec [OPTIONS] COMMANDS
 
-    -wd, --without_description COMMAND
-        Benchmark the command and use itself as its description.
-    -d, --with_description DESCRIPTION COMMAND...
-        Benchmark the command and set its description attribute.
+    -wd, --without_description COMMAND:
+          Benchmark the command and use
+          itself as its description. Appends
+          '$ARGUMENT' to the command if the string
+          isn't present. Use the '--argument' option
+          to set the value that this string is
+          replaced with.
+    -d, --with_description DESCRIPTION COMMAND:
+          Benchmark the command
+          and set its description attribute.Appends
+          '$ARGUMENT' to the command if the string
+          isn't present. Use the '--argument' option
+          to set the value that this string is
+          replaced with.
+    
     …
     (options of temci exec)
 

diff --git a/temci/run/run_driver.py b/temci/run/run_driver.py
@@ -509,7 +509,9 @@ def _match_return_code(self, error_messages: _Err, cmd: str, err: str, exptected
                                                              "Not all runners support it."),
     "plugin_order": ListOrTuple(Str()) // Default(["drop_fs_caches", "sync", "sleep", "preheat", "flush_cpu_caches"])
                     // Description("Order in which the plugins are used, plugins that do not "
-                                   "appear in this list are used before all others")
+                                   "appear in this list are used before all others"),
+    "argument": Str() // Default("") // Description("Argument passed to all benchmarked commands by replacing "
+                                                    "$ARGUMENT with this value in the command")
 }, unknown_keys=True))
 class ExecRunDriver(AbstractRunDriver):
     """
@@ -655,7 +657,8 @@ def _exec_command(self, cmds: list, block: RunProgramBlock,
                                                            shlex.quote(center)) + post
         else:
             cmd = pre + " " + center + " " + post
-        cmd = cmd.replace("&SUDO&", "$SUDO$") .replace("&&", "&")
+        arg = self.misc_settings["argument"] if "argument" in self.misc_settings else ""
+        cmd = cmd.replace("&SUDO&", "$SUDO$").replace("&&", "&").replace("$ARGUMENT", arg)
         cwd = block["cwds"][rand_index]
         executed_cmd = block["cmd_prefix"] + [cmd]
         if cpuset is not None and has_root_privileges():

diff --git a/temci/scripts/cli.py b/temci/scripts/cli.py
@@ -143,11 +143,19 @@ def cli():
             "exec": CmdOptionList(CmdOption("with_description",
                                     type_scheme=ListOrTuple(Tuple(Str(), Str()))
                                                 // Description("DESCRIPTION COMMAND: Benchmark the command and set its"
-                                                               " description attribute."),
+                                                               " description attribute."
+                                                               "Appends '$ARGUMENT' "
+                                                               "to the command if the string isn't present. "
+                                                               "Use the '--argument' option to set the value "
+                                                               "that this string is replaced with."),
                                     short="d", completion_hints={"zsh": "_command"}),
                           CmdOption("without_description", short="wd",
                                     type_scheme=ListOrTuple(Str()) // Description("COMMAND: Benchmark the command and use "
-                                                                           "itself as its description."),
+                                                                           "itself as its description. "
+                                                                           "Appends '$ARGUMENT' "
+                                                                           "to the command if the string isn't present. "
+                                                                           "Use the '--argument' option to set the value "
+                                                                           "that this string is replaced with."),
                                     completion_hints={"zsh": "_command"}),
                           run_options["run_driver_specific"]["exec"],
                           run_options["common"]
@@ -260,6 +268,10 @@ def temci__short__exec(commands: list, with_description: list = None, without_de
                 "description": cmd
             }
         })
+    for run in runs:
+        con = run["run_config"]
+        if "$ARGUMENT" not in con["run_cmd"]:
+            con["run_cmd"][0] += " $ARGUMENT"
     Settings()["run/driver"] = "exec"
     benchmark_and_exit(runs)
 

diff --git a/tests/test_run.py b/tests/test_run.py
@@ -105,3 +105,7 @@ def test_discard_blocks_on_error():
 
 def test_temci_short_shell():
     assert "42" in run_temci_proc("short shell echo 42").out
+
+
+def test_pass_arguments():
+    assert run_temci("short exec exit --argument 1", expect_success=False).ret_code == ErrorCode.PROGRAM_ERROR.value