From e5e466931bfaa25d4ae2bf835ad3abf562052f30 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@blender.org>
Date: Mon, 21 Feb 2022 18:04:17 +0100
Subject: [PATCH] Worker: better way to get array command parameters

---
 internal/worker/command_blender.go  | 15 +++++--
 internal/worker/command_exe.go      | 30 +++++++++++++
 internal/worker/command_exe_test.go | 65 +++++++++++++++++++++++++++++
 3 files changed, 106 insertions(+), 4 deletions(-)
 create mode 100644 internal/worker/command_exe_test.go

diff --git a/internal/worker/command_blender.go b/internal/worker/command_blender.go
index 9386e13d..827de638 100644
--- a/internal/worker/command_blender.go
+++ b/internal/worker/command_blender.go
@@ -41,19 +41,26 @@ type BlenderSettings struct {
 // cmdBlender executes the "blender-render" command.
 func (ce *CommandExecutor) cmdBlenderRender(ctx context.Context, logger zerolog.Logger, taskID string, cmd api.Command) error {
 	settings := BlenderSettings{
-		exe:        cmd.Parameters["exe"].(string),
-		argsBefore: cmd.Parameters["argsBefore"].([]string),
-		blendfile:  cmd.Parameters["blendfile"].(string),
-		args:       cmd.Parameters["args"].([]string),
+		exe:       cmd.Parameters["exe"].(string),
+		blendfile: cmd.Parameters["blendfile"].(string),
 	}
+	var ok bool
 	if settings.exe == "" {
 		logger.Warn().Interface("command", cmd).Msg("missing 'exe' setting")
 		return fmt.Errorf("missing 'exe' setting: %+v", cmd)
 	}
+	if settings.argsBefore, ok = cmdSettingAsStrings(cmd, "argsBefore"); !ok {
+		logger.Warn().Interface("command", cmd).Msg("invalid 'argsBefore' setting")
+		return fmt.Errorf("invalid 'argsBefore' setting: %+v", cmd)
+	}
 	if settings.blendfile == "" {
 		logger.Warn().Interface("command", cmd).Msg("missing 'blendfile' setting")
 		return fmt.Errorf("missing 'blendfile' setting: %+v", cmd)
 	}
+	if settings.args, ok = cmdSettingAsStrings(cmd, "args"); !ok {
+		logger.Warn().Interface("command", cmd).Msg("invalid 'args' setting")
+		return fmt.Errorf("invalid 'args' setting: %+v", cmd)
+	}
 
 	cliArgs := make([]string, 0)
 	cliArgs = append(cliArgs, settings.argsBefore...)
diff --git a/internal/worker/command_exe.go b/internal/worker/command_exe.go
index debcff76..72d822c8 100644
--- a/internal/worker/command_exe.go
+++ b/internal/worker/command_exe.go
@@ -87,3 +87,33 @@ func (ce *CommandExecutor) Run(ctx context.Context, taskID string, cmd api.Comma
 
 	return runner(ctx, logger, taskID, cmd)
 }
+
+// cmdSettingAsStrings converts an array setting ([]interface{}) to a []string slice.
+func cmdSettingAsStrings(cmd api.Command, key string) ([]string, bool) {
+	setting, found := cmd.Parameters[key]
+	if !found {
+		return []string{}, false
+	}
+
+	if asStrSlice, ok := setting.([]string); ok {
+		return asStrSlice, true
+	}
+
+	interfSlice, ok := setting.([]interface{})
+	if !ok {
+		return []string{}, false
+	}
+
+	strSlice := make([]string, len(interfSlice))
+	for idx := range interfSlice {
+		switch v := interfSlice[idx].(type) {
+		case string:
+			strSlice[idx] = v
+		case fmt.Stringer:
+			strSlice[idx] = v.String()
+		default:
+			strSlice[idx] = fmt.Sprintf("%v", v)
+		}
+	}
+	return strSlice, true
+}
diff --git a/internal/worker/command_exe_test.go b/internal/worker/command_exe_test.go
new file mode 100644
index 00000000..352f1956
--- /dev/null
+++ b/internal/worker/command_exe_test.go
@@ -0,0 +1,65 @@
+package worker
+
+/* ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * Original Code Copyright (C) 2022 Blender Foundation.
+ *
+ * This file is part of Flamenco.
+ *
+ * Flamenco is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later
+ * version.
+ *
+ * Flamenco is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ * A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * Flamenco.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * ***** END GPL LICENSE BLOCK ***** */
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"gitlab.com/blender/flamenco-ng-poc/pkg/api"
+)
+
+func TestCmdSettingAsStrings(t *testing.T) {
+	cmd := api.Command{
+		Name: "test",
+		Parameters: map[string]interface{}{
+			"strings": []string{"a", "b"},
+			"ints":    []int{3, 4},
+			"floats":  []float64{0.47, 0.327},
+			"mixed":   []interface{}{"a", 47, 0.327},
+		},
+	}
+
+	{
+		slice, ok := cmdSettingAsStrings(cmd, "strings")
+		if ok {
+			assert.Equal(t, []string{"a", "b"}, slice)
+		} else {
+			t.Error("not ok")
+		}
+	}
+	{
+		_, ok := cmdSettingAsStrings(cmd, "ints")
+		assert.False(t, ok, "only []string or []interface{} are expected to work")
+	}
+	{
+		_, ok := cmdSettingAsStrings(cmd, "floats")
+		assert.False(t, ok, "only []string or []interface{} are expected to work")
+	}
+	{
+		slice, ok := cmdSettingAsStrings(cmd, "mixed")
+		if ok {
+			assert.Equal(t, []string{"a", "47", "0.327"}, slice)
+		} else {
+			t.Error("not ok")
+		}
+	}
+}