From f00048781f9c4c2b2650fcc0c37ec786fed6d212 Mon Sep 17 00:00:00 2001
From: Thibault Saunier <tsaunier@igalia.com>
Date: Tue, 12 Jan 2021 15:37:08 -0300
Subject: [PATCH] validate:scenario: Add a `run-command` action type

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-devtools/-/merge_requests/235>
---
 validate/gst/validate/gst-validate-scenario.c      | 83 ++++++++++++++++++++++
 .../run_command_with_envvars.validatetest          | 17 +++++
 2 files changed, 100 insertions(+)
 create mode 100644 validate/tests/launcher_tests/run_command_with_envvars.validatetest

diff --git a/validate/gst/validate/gst-validate-scenario.c b/validate/gst/validate/gst-validate-scenario.c
index 9e84c5d..6d6e8de 100644
--- a/validate/gst/validate/gst-validate-scenario.c
+++ b/validate/gst/validate/gst-validate-scenario.c
@@ -3148,6 +3148,68 @@ done:
   return res;
 }
 
+static gboolean
+set_env_var (GQuark field_id, GValue * value,
+    GSubprocessLauncher * subproc_launcher)
+{
+  g_subprocess_launcher_setenv (subproc_launcher, g_quark_to_string (field_id),
+      g_value_get_string (value), TRUE);
+
+  return TRUE;
+}
+
+static GstValidateExecuteActionReturn
+_run_command (GstValidateScenario * scenario, GstValidateAction * action)
+{
+  gchar **argv = NULL, *_stderr;
+  GError *error = NULL;
+  const GValue *env = NULL;
+  GSubprocess *subproc = NULL;
+  GSubprocessLauncher *subproc_launcher = NULL;
+  GstValidateExecuteActionReturn res =
+      GST_VALIDATE_EXECUTE_ACTION_ERROR_REPORTED;
+
+  REPORT_UNLESS ((argv = gst_validate_utils_get_strv (action->structure,
+              "argv")), done,
+      "Couldn't find `argv` as array of strings in %" GST_PTR_FORMAT,
+      action->structure);
+
+  subproc_launcher = g_subprocess_launcher_new (G_SUBPROCESS_FLAGS_STDERR_PIPE);
+  g_subprocess_launcher_unsetenv (subproc_launcher, "GST_VALIDATE_SCENARIO");
+  g_subprocess_launcher_unsetenv (subproc_launcher, "GST_VALIDATE_CONFIG");
+
+  env = gst_structure_get_value (action->structure, "env");
+  REPORT_UNLESS (!env || GST_VALUE_HOLDS_STRUCTURE (env), done,
+      "The `env` parameter should be a GstStructure, got %s",
+      G_VALUE_TYPE_NAME (env));
+  if (env) {
+    gst_structure_foreach (gst_value_get_structure (env),
+        (GstStructureForeachFunc) set_env_var, subproc_launcher);
+  }
+
+  REPORT_UNLESS (
+      (subproc =
+          g_subprocess_launcher_spawnv (subproc_launcher,
+              (const gchar * const *) argv, &error)), done,
+      "Couldn't start subprocess: %s", error->message);
+
+  REPORT_UNLESS (g_subprocess_communicate_utf8 (subproc, NULL, NULL, NULL,
+          &_stderr, &error), done, "Failed to run check: %s", error->message);
+
+  REPORT_UNLESS (g_subprocess_get_exit_status (subproc) == 0,
+      done, "Sub command failed. Stderr: %s", _stderr);
+
+  res = GST_VALIDATE_EXECUTE_ACTION_OK;
+
+done:
+  if (argv)
+    g_strfreev (argv);
+  g_clear_object (&subproc_launcher);
+  g_clear_object (&subproc);
+
+  return res;
+}
+
 static GstValidateExecuteActionReturn
 _execute_check_position (GstValidateScenario * scenario,
     GstValidateAction * action)
@@ -7152,6 +7214,27 @@ register_action_types (void)
       }),
       "Check current pipeline position.\n", GST_VALIDATE_ACTION_TYPE_NONE);
 
+  REGISTER_ACTION_TYPE("run-command", _run_command,
+      ((GstValidateActionParameter[]) {
+          {
+            .name = "argv",
+            .description = "The subprocess arguments",
+            .mandatory = TRUE,
+            .types = "(string){array,}",
+            NULL
+          },
+          {
+            .name = "env",
+            .description = "Extra environment variables to set",
+            .mandatory = FALSE,
+            .types = "GstStructure",
+            NULL
+          },
+        {NULL}
+      }),
+      "Check current pipeline position.\n",
+      GST_VALIDATE_ACTION_TYPE_CAN_BE_OPTIONAL);
+
     REGISTER_ACTION_TYPE("foreach", NULL,
         ((GstValidateActionParameter[]) {
             { .name = "actions",
diff --git a/validate/tests/launcher_tests/run_command_with_envvars.validatetest b/validate/tests/launcher_tests/run_command_with_envvars.validatetest
new file mode 100644
index 0000000..804515e
--- /dev/null
+++ b/validate/tests/launcher_tests/run_command_with_envvars.validatetest
@@ -0,0 +1,17 @@
+meta,
+    args = {
+        "videotestsrc ! fakesink sync=true",
+    },
+    handles-states=true,
+    ignore-eos=true
+
+run-command,
+    argv={
+        python3, -c, "import os; assert os.environ['ENVVAR_CHECK'] == 'set'",
+    },
+    env=[
+        vars,
+            ENVVAR_CHECK="set",
+    ]
+
+stop
-- 
2.7.4