testsuite: added some helpers to improve daemon testing

Author: cmaglie

internal/integrationtest/arduino-cli.go

@@ -23,7 +23,6 @@ import (
 	"os"
 	"strings"
 	"sync"
-	"testing"
 	"time"
 
 	"github.com/arduino/arduino-cli/executils"
@@ -42,6 +41,9 @@ type ArduinoCLI struct {
 	proc          *executils.Process
 	cliEnvVars    []string
 	cliConfigPath *paths.Path
+	stagingDir    *paths.Path
+	dataDir       *paths.Path
+	sketchbookDir *paths.Path
 	daemonAddr    string
 	daemonConn    *grpc.ClientConn
 	daemonClient  commands.ArduinoCoreServiceClient
@@ -56,28 +58,26 @@ type ArduinoCLIConfig struct {
 // NewArduinoCliWithinEnvironment creates a new Arduino CLI client inside the given environment.
 func NewArduinoCliWithinEnvironment(env *testsuite.Environment, config *ArduinoCLIConfig) *ArduinoCLI {
 	color.NoColor = false
-	cli := NewArduinoCli(env.T(), config)
-	staging := env.SharedDownloadsDir()
-	if !config.UseSharedStagingFolder {
-		staging = env.RootDir().Join("arduino15/staging")
+	cli := &ArduinoCLI{
+		path:          config.ArduinoCLIPath,
+		t:             require.New(env.T()),
+		dataDir:       env.RootDir().Join("arduino15"),
+		sketchbookDir: env.RootDir().Join("Arduino"),
+		stagingDir:    env.RootDir().Join("arduino15/staging"),
 	}
+	if config.UseSharedStagingFolder {
+		cli.stagingDir = env.SharedDownloadsDir()
+	}
+
 	cli.cliEnvVars = []string{
-		fmt.Sprintf("ARDUINO_DATA_DIR=%s", env.RootDir().Join("arduino15")),
-		fmt.Sprintf("ARDUINO_DOWNLOADS_DIR=%s", staging),
-		fmt.Sprintf("ARDUINO_SKETCHBOOK_DIR=%s", env.RootDir().Join("Arduino")),
+		fmt.Sprintf("ARDUINO_DATA_DIR=%s", cli.dataDir),
+		fmt.Sprintf("ARDUINO_DOWNLOADS_DIR=%s", cli.stagingDir),
+		fmt.Sprintf("ARDUINO_SKETCHBOOK_DIR=%s", cli.sketchbookDir),
 	}
 	env.RegisterCleanUpCallback(cli.CleanUp)
 	return cli
 }
 
-// NewArduinoCli creates a new Arduino CLI client.
-func NewArduinoCli(t *testing.T, config *ArduinoCLIConfig) *ArduinoCLI {
-	return &ArduinoCLI{
-		path: config.ArduinoCLIPath,
-		t:    require.New(t),
-	}
-}
-
 // CleanUp closes the Arduino CLI client.
 func (cli *ArduinoCLI) CleanUp() {
 	if cli.proc != nil {
@@ -86,6 +86,16 @@ func (cli *ArduinoCLI) CleanUp() {
 	}
 }
 
+// DataDir returns the data directory
+func (cli *ArduinoCLI) DataDir() *paths.Path {
+	return cli.dataDir
+}
+
+// SketchbookDir returns the sketchbook directory
+func (cli *ArduinoCLI) SketchbookDir() *paths.Path {
+	return cli.sketchbookDir
+}
+
 // Run executes the given arduino-cli command and returns the output.
 func (cli *ArduinoCLI) Run(args ...string) ([]byte, []byte, error) {
 	if cli.cliConfigPath != nil {

internal/integrationtest/daemon/arduino-cli_daemon_test.go

@@ -13,7 +13,7 @@
 // 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
+package daemon_test
 
 import (
 	"context"
@@ -22,28 +22,17 @@ import (
 	"testing"
 	"time"
 
-	"github.com/arduino/arduino-cli/internal/integrationtest"
 	"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
-	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
-	"go.bug.st/testsuite"
 )
 
 func TestArduinoCliDaemon(t *testing.T) {
 	t.Skip("Deactivated for now")
 	t.SkipNow()
 
-	env := testsuite.NewEnvironment(t)
+	env, cli := createEnvForDaemon(t)
 	defer env.CleanUp()
 
-	cli := integrationtest.NewArduinoCliWithinEnvironment(env, &integrationtest.ArduinoCLIConfig{
-		ArduinoCLIPath:         paths.New("..", "..", "arduino-cli"),
-		UseSharedStagingFolder: true,
-	})
-
-	_, _, err := cli.Run("core", "update-index")
-	require.NoError(t, err)
-
 	_ = cli.StartDaemon(false)
 
 	inst := cli.Create()

internal/integrationtest/daemon/daemon_test.go

@@ -0,0 +1,40 @@
+// 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 daemon_test
+
+import (
+	"testing"
+
+	"github.com/arduino/arduino-cli/internal/integrationtest"
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/require"
+	"go.bug.st/testsuite"
+)
+
+func createEnvForDaemon(t *testing.T) (*testsuite.Environment, *integrationtest.ArduinoCLI) {
+	env := testsuite.NewEnvironment(t)
+
+	cli := integrationtest.NewArduinoCliWithinEnvironment(env, &integrationtest.ArduinoCLIConfig{
+		ArduinoCLIPath:         paths.New("..", "..", "..", "arduino-cli"),
+		UseSharedStagingFolder: true,
+	})
+
+	_, _, err := cli.Run("core", "update-index")
+	require.NoError(t, err)
+
+	_ = cli.StartDaemon(false)
+	return env, cli
+}