testsuite: Added helper functions to run arduino-cli

cmaglie · cmaglie · commit dae32426366a · 2022-08-05T17:57:04.000+02:00
diff --git a/testsuite/arduino-cli.go b/testsuite/arduino-cli.go
@@ -0,0 +1,107 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2022 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package integrationtest
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"io"
+	"testing"
+
+	"github.com/arduino/arduino-cli/executils"
+	"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/require"
+	"google.golang.org/grpc"
+)
+
+// ArduinoCLI is an Arduino CLI client.
+type ArduinoCLI struct {
+	path          *paths.Path
+	t             *require.Assertions
+	proc          *executils.Process
+	cliConfigPath *paths.Path
+	daemonAddr    string
+	daemonConn    *grpc.ClientConn
+	daemonClient  commands.ArduinoCoreServiceClient
+}
+
+// NewArduinoCliWithinEnvironment creates a new Arduino CLI client inside the given environment.
+func NewArduinoCliWithinEnvironment(t *testing.T, cliPath *paths.Path, env *Environment) *ArduinoCLI {
+	cli := NewArduinoCli(t, cliPath)
+	cli.cliConfigPath = env.Root().Join("arduino-cli.yaml")
+	config := fmt.Sprintf(`
+directories:
+  data: %s
+  downloads: %s
+  user: %s
+`,
+		env.Root().Join("arduino15"),
+		env.Root().Join("arduino15/staging"),
+		env.Root().Join("Arduino"))
+	require.NoError(t, cli.cliConfigPath.WriteFile([]byte(config)))
+	return cli
+}
+
+// NewArduinoCli creates a new Arduino CLI client.
+func NewArduinoCli(t *testing.T, cliPath *paths.Path) *ArduinoCLI {
+	return &ArduinoCLI{
+		path: cliPath,
+		t:    require.New(t),
+	}
+}
+
+// CleanUp closes the Arduino CLI client.
+func (cli *ArduinoCLI) CleanUp() {
+	if cli.proc != nil {
+		cli.proc.Kill()
+		cli.proc.Wait()
+	}
+}
+
+// Run executes the given arduino-cli command and returns the output.
+func (cli *ArduinoCLI) Run(args ...string) ([]byte, []byte, error) {
+	if cli.cliConfigPath != nil {
+		args = append([]string{"--config-file", cli.cliConfigPath.String()}, args...)
+	}
+	cliProc, err := executils.NewProcessFromPath(nil, cli.path, args...)
+	cli.t.NoError(err)
+	stdout, err := cliProc.StdoutPipe()
+	cli.t.NoError(err)
+	stderr, err := cliProc.StderrPipe()
+	cli.t.NoError(err)
+	_, err = cliProc.StdinPipe()
+	cli.t.NoError(err)
+
+	cli.t.NoError(cliProc.Start())
+
+	var stdoutBuf, stderrBuf bytes.Buffer
+	stdoutCtx, stdoutCancel := context.WithCancel(context.Background())
+	stderrCtx, stderrCancel := context.WithCancel(context.Background())
+	go func() {
+		io.Copy(&stdoutBuf, stdout)
+		stdoutCancel()
+	}()
+	go func() {
+		io.Copy(&stderrBuf, stderr)
+		stderrCancel()
+	}()
+	cliErr := cliProc.Wait()
+	<-stdoutCtx.Done()
+	<-stderrCtx.Done()
+	return stdoutBuf.Bytes(), stderrBuf.Bytes(), cliErr
+}
