refactor: move more commands to internal/cmd (#207)

* refactor: move more commands to internal/cmd

Part of https://github.com/ooni/probe/issues/1335.

We would like all commands to be at the same level of engine
rather than inside engine (now that we can do it).

* fix: update .gitignore

* refactor: also move jafar outside engine

* We should be good now?

internal/engine/shellx/shellx.go

@@ -0,0 +1,66 @@
+// Package shellx contains utilities to run external commands.
+package shellx
+
+import (
+	"errors"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/apex/log"
+	"github.com/google/shlex"
+	"github.com/ooni/probe-cli/v3/internal/engine/model"
+)
+
+type runconfig struct {
+	args     []string
+	loginfof func(format string, v ...interface{})
+	name     string
+	stdout   *os.File
+	stderr   *os.File
+}
+
+func run(config runconfig) error {
+	config.loginfof("exec: %s %s", config.name, strings.Join(config.args, " "))
+	cmd := exec.Command(config.name, config.args...)
+	cmd.Stdout = config.stdout
+	cmd.Stderr = config.stderr
+	err := cmd.Run()
+	config.loginfof("exec result: %+v", err)
+	return err
+}
+
+// Run executes the specified command with the specified args
+func Run(name string, arg ...string) error {
+	return run(runconfig{
+		args:     arg,
+		loginfof: log.Log.Infof,
+		name:     name,
+		stdout:   os.Stdout,
+		stderr:   os.Stderr,
+	})
+}
+
+// RunQuiet is like Run but it does not emit any output.
+func RunQuiet(name string, arg ...string) error {
+	return run(runconfig{
+		args:     arg,
+		loginfof: model.DiscardLogger.Infof,
+		name:     name,
+		stdout:   nil,
+		stderr:   nil,
+	})
+}
+
+// RunCommandline is like Run but its only argument is a command
+// line that will be splitted using the google/shlex package
+func RunCommandline(cmdline string) error {
+	args, err := shlex.Split(cmdline)
+	if err != nil {
+		return err
+	}
+	if len(args) < 1 {
+		return errors.New("shellx: no command to execute")
+	}
+	return Run(args[0], args[1:]...)
+}

internal/engine/shellx/shellx_test.go

@@ -0,0 +1,44 @@
+package shellx
+
+import "testing"
+
+func TestRun(t *testing.T) {
+	if err := Run("whoami"); err != nil {
+		t.Fatal(err)
+	}
+	if err := Run("./nonexistent/command"); err == nil {
+		t.Fatal("expected an error here")
+	}
+}
+
+func TestRunQuiet(t *testing.T) {
+	if err := RunQuiet("true"); err != nil {
+		t.Fatal(err)
+	}
+	if err := RunQuiet("./nonexistent/command"); err == nil {
+		t.Fatal("expected an error here")
+	}
+}
+
+func TestRunCommandline(t *testing.T) {
+	t.Run("when the command does not parse", func(t *testing.T) {
+		if err := RunCommandline(`"foobar`); err == nil {
+			t.Fatal("expected an error here")
+		}
+	})
+	t.Run("when we have no arguments", func(t *testing.T) {
+		if err := RunCommandline(""); err == nil {
+			t.Fatal("expected an error here")
+		}
+	})
+	t.Run("when we have a single argument", func(t *testing.T) {
+		if err := RunCommandline("ls"); err != nil {
+			t.Fatal(err)
+		}
+	})
+	t.Run("when we have more than one argument", func(t *testing.T) {
+		if err := RunCommandline("ls ."); err != nil {
+			t.Fatal(err)
+		}
+	})
+}