Pythonize pbench-register-tool-trigger

Replaced shell script with python script and make it installable.

Signed-off-by: Charles Short <[email protected]>

Author: Charles Short

agent/Makefile

@@ -44,7 +44,6 @@ util-scripts = \
 	pbench-postprocess-tools-cdm \
 	pbench-register-tool \
 	pbench-register-tool-set \
-	pbench-register-tool-trigger \
 	pbench-send-tools \
 	pbench-start-tools \
 	pbench-stop-tools \
@@ -253,6 +252,7 @@ install-python3-setup: install-util-scripts install-lib
 	${COPY} ${DESTDIR}/python3/bin/pbench-clear-results ${UTILDIR}/
 	${COPY} ${DESTDIR}/python3/bin/pbench-cleanup ${UTILDIR}/
 	${COPY} ${DESTDIR}/python3/bin/pbench-list-tools ${UTILDIR}/
+	${COPY} ${DESTDIR}/python3/bin/pbench-register-tool-trigger ${UTILDIR}/
 	rm -rf ${DESTDIR}/python3
 	${COPY} ../lib/pbench ${LIBDIR}/
 	rm -r $$(find ${LIBDIR} -name __pycache__) ${LIBDIR}/pbench/test ${LIBDIR}/pbench/server ${LIBDIR}/pbench/cli/server

agent/util-scripts/gold/pbench-register-tool-trigger/test-15.txt

@@ -336,7 +336,6 @@ declare -A tools=(
     [test-11.12]="pbench-register-tool-set"
     [test-11.13]="pbench-register-tool-set"
     [test-11.14]="pbench-register-tool-set"
-    [test-15]="pbench-register-tool-trigger"
     [test-19]="test-tool-trigger"
     [test-20]="pbench-move-results"
     [test-21]="pbench-move-results"
@@ -353,8 +352,6 @@ declare -A tools=(
     [test-32]="pbench-copy-results"
     [test-33]="pbench-move-results"
     [test-34]="pbench-copy-results"
-    [test-35]="pbench-register-tool-trigger"
-    [test-36]="pbench-register-tool-trigger"
     [test-37]="pbench-copy-results"
     [test-38]="pbench-copy-results"
     [test-39]="pbench-copy-results"
@@ -422,7 +419,6 @@ declare -A options=(
     # verify --group option works along side --no-install
     [test-11.12]="--group=other --no-install"
     [test-11.13]="--help"
-    [test-15]="--group=default --start-trigger=\"START DEFAULT\" --stop-trigger=\"STOP DEFAULT\""
     # pbench-move-results
     [test-20]="--help"
     # pbench-move-results - no args, nothing to do
@@ -444,8 +440,6 @@ declare -A options=(
     #[test-33]=""
     # pbench-copy-results - no args, 2 bad, 1 good result directory moved
     #[test-34]=""
-    [test-35]="--group=default --start-trigger=\"START:DEFAULT\" --stop-trigger=\"STOP DEFAULT\""
-    [test-36]="--group=default --start-trigger=\"START DEFAULT\" --stop-trigger=\"STOP:DEFAULT\""
     # pbench-copy-results - same controller specified as in metadata.log, no-op
     [test-37]="--controller=testhost.example.com"
     # pbench-copy-results - explicit controller different from recorded controller
@@ -484,8 +478,6 @@ declare -A expected_status=(
     [test-11.08]=1
     [test-11.11]=1
     [test-29]=1
-    [test-35]=1
-    [test-36]=1
     [test-44]=1
     [test-46]=1
     [test-47]=1

agent/util-scripts/gold/pbench-register-tool-trigger/test-35.txt

@@ -0,0 +1,112 @@
+"""
+pbench-register-tool-trigger
+
+The sole purpose of this script is to register tool triggers for a given
+tool group of your choosing.  During the execution of a benchmark, the
+output of the benchmark is used to trigger the starting of tools and the
+stopping of tools.
+
+For a list of performance tools, look at the ${pbench_bin}/tool-scripts
+directory.
+
+"""
+import logging
+import sys
+
+import click
+
+from pbench.agent.utils import setup_logging
+from pbench.cli.agent import CliContext, pass_cli_context
+from pbench.cli.agent.commands.triggers.base import TriggerCommand
+from pbench.cli.agent.options import common_options
+
+LOG = logging.getLogger(__name__)
+
+
+class TriggerRegister(TriggerCommand):
+    """Register tool trigger"""
+
+    def __init__(self, context):
+        super().__init__(context)
+
+        setup_logging(debug=False, logfile=None)
+
+    def execute(self):
+        if self.verify_tool_group(self.context.group) != 0:
+            return 1
+
+        if ":" in self.context.start:
+            LOG.error(
+                '%s: the start trigger cannot have a colon in it: "%s"',
+                self.name,
+                self.context.start,
+            )
+            return 1
+
+        if ":" in self.context.stop:
+            LOG.error(
+                '%s: the stop trigger cannot have a colon in it: "%s"',
+                self.name,
+                self.context.stop,
+            )
+            return 1
+
+        # Remember this trigger
+        trigger = self.tool_group_dir / "__trigger__"
+        trigger.write_text(f"{self.context.start}:{self.context.stop}\n")
+        click.secho(
+            f'tool trigger strings for start: "{self.context.start}" and for stop: "{self.context.stop}" are now registered for tool group: "{self.context.group}"'
+        )
+
+        return 0
+
+
+def _group_option(f):
+    """Group option"""
+
+    def callback(ctxt, param, value):
+        clictxt = ctxt.ensure_object(CliContext)
+        clictxt.group = value
+        return value
+
+    return click.option(
+        "-g",
+        "--groups",
+        "--group",
+        default="default",
+        expose_value=False,
+        callback=callback,
+    )(f)
+
+
+def _start_option(f):
+    def callback(ctxt, param, value):
+        clictxt = ctxt.ensure_object(CliContext)
+        clictxt.start = value
+        return value
+
+    return click.option(
+        "--start-trigger", required=True, expose_value=False, callback=callback,
+    )(f)
+
+
+def _stop_option(f):
+    def callback(ctxt, param, value):
+        clictxt = ctxt.ensure_object(CliContext)
+        clictxt.stop = value
+        return value
+
+    return click.option(
+        "--stop-trigger", required=True, expose_value=False, callback=callback,
+    )(f)
+
+
+@click.command(help="list registered triggers")
+@common_options
+@_group_option
+@_start_option
+@_stop_option
+@pass_cli_context
+def main(ctxt):
+    status = TriggerRegister(ctxt).execute()
+    sys.exit(status)