Integrated 'go.bug.st/testsuite'

It doesn't make much sense to keep it separate in a different library

Author: cmaglie

Diff for: go.mod

@@ -57,10 +57,7 @@ require (
 	gopkg.in/yaml.v2 v2.4.0
 )
 
-require (
-	go.bug.st/testifyjson v1.1.1
-	go.bug.st/testsuite v0.1.0
-)
+require go.bug.st/testifyjson v1.1.1
 
 require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.0 // indirect

Diff for: go.sum

@@ -376,8 +376,6 @@ go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45 h1:mACY1anK6HNCZtm/DK2Rf2
 go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45/go.mod h1:dRSl/CVCTf56CkXgJMDOdSwNfo2g1orOGE/gBGdvjZw=
 go.bug.st/testifyjson v1.1.1 h1:nHotIMK151LF3vYsU/b2RaoVaWCgrf2kvQeGNoZkGaA=
 go.bug.st/testifyjson v1.1.1/go.mod h1:nZyy2icFbv3OE3zW3mGVOnC/GhWgb93LRu+29n2tJlI=
-go.bug.st/testsuite v0.1.0 h1:oX4zdIB62+G5A0Kq4dja7Vy8tDiKqKVhhxkzhpMGgog=
-go.bug.st/testsuite v0.1.0/go.mod h1:xCIDf97kf9USoz960Foy3CoquwhQmfuFRNh9git70as=
 go.etcd.io/etcd/api/v3 v3.5.0/go.mod h1:cbVKeC6lCfl7j/8jBhAK6aIYO9XOjdptoxU/nLQcPvs=
 go.etcd.io/etcd/client/pkg/v3 v3.5.0/go.mod h1:IJHfcCEKxYu1Os13ZdwCwIUTUVGYTSAM3YSwc9/Ac1g=
 go.etcd.io/etcd/client/v2 v2.305.0/go.mod h1:h9puh54ZTgAKtEbut2oe9P4L/oqKCVB6xsXlzd7alYQ=

Diff for: internal/integrationtest/arduino-cli.go

@@ -33,14 +33,9 @@ import (
 	"github.com/arduino/go-paths-helper"
 	"github.com/fatih/color"
 	"github.com/stretchr/testify/require"
-	"go.bug.st/testsuite"
 	"google.golang.org/grpc"
 )
 
-func init() {
-	testsuite.ProjectName = "cli"
-}
-
 // FindRepositoryRootPath returns the repository root path
 func FindRepositoryRootPath(t *testing.T) *paths.Path {
 	repoRootPath, err := paths.Getwd()
@@ -54,8 +49,8 @@ func FindRepositoryRootPath(t *testing.T) *paths.Path {
 
 // CreateArduinoCLIWithEnvironment performs the minimum amount of actions
 // to build the default test environment.
-func CreateArduinoCLIWithEnvironment(t *testing.T) (*testsuite.Environment, *ArduinoCLI) {
-	env := testsuite.NewEnvironment(t)
+func CreateArduinoCLIWithEnvironment(t *testing.T) (*Environment, *ArduinoCLI) {
+	env := NewEnvironment(t)
 
 	cli := NewArduinoCliWithinEnvironment(env, &ArduinoCLIConfig{
 		ArduinoCLIPath:         FindRepositoryRootPath(t).Join("arduino-cli"),
@@ -89,7 +84,7 @@ type ArduinoCLIConfig struct {
 }
 
 // NewArduinoCliWithinEnvironment creates a new Arduino CLI client inside the given environment.
-func NewArduinoCliWithinEnvironment(env *testsuite.Environment, config *ArduinoCLIConfig) *ArduinoCLI {
+func NewArduinoCliWithinEnvironment(env *Environment, config *ArduinoCLIConfig) *ArduinoCLI {
 	color.NoColor = false
 	cli := &ArduinoCLI{
 		path:          config.ArduinoCLIPath,

Diff for: internal/integrationtest/daemon/daemon_test.go

@@ -20,14 +20,13 @@ import (
 
 	"github.com/arduino/arduino-cli/internal/integrationtest"
 	"github.com/stretchr/testify/require"
-	"go.bug.st/testsuite"
 )
 
 // createEnvForDaemon performs the minimum required operations to start the arduino-cli daemon.
 // It returns a testsuite.Environment and an ArduinoCLI client to perform the integration tests.
 // The Environment must be disposed by calling the CleanUp method via defer.
-func createEnvForDaemon(t *testing.T) (*testsuite.Environment, *integrationtest.ArduinoCLI) {
-	env := testsuite.NewEnvironment(t)
+func createEnvForDaemon(t *testing.T) (*integrationtest.Environment, *integrationtest.ArduinoCLI) {
+	env := integrationtest.NewEnvironment(t)
 
 	cli := integrationtest.NewArduinoCliWithinEnvironment(env, &integrationtest.ArduinoCLIConfig{
 		ArduinoCLIPath:         integrationtest.FindRepositoryRootPath(t).Join("arduino-cli"),

Diff for: internal/integrationtest/environment.go

@@ -0,0 +1,85 @@
+// 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 [email protected].
+
+package integrationtest
+
+import (
+	"testing"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/require"
+)
+
+// ProjectName is the prefix used in the test temp files
+var ProjectName = "cli"
+
+// Environment is a test environment for the test suite.
+type Environment struct {
+	rootDir      *paths.Path
+	downloadsDir *paths.Path
+	t            *testing.T
+	cleanUp      func()
+}
+
+// SharedDir returns the shared downloads directory.
+func SharedDir(t *testing.T, id string) *paths.Path {
+	downloadsDir := paths.TempDir().Join(ProjectName + "-" + id)
+	require.NoError(t, downloadsDir.MkdirAll())
+	return downloadsDir
+}
+
+// NewEnvironment creates a new test environment.
+func NewEnvironment(t *testing.T) *Environment {
+	downloadsDir := SharedDir(t, "downloads")
+	rootDir, err := paths.MkTempDir("", ProjectName)
+	require.NoError(t, err)
+	return &Environment{
+		rootDir:      rootDir,
+		downloadsDir: downloadsDir,
+		t:            t,
+		cleanUp: func() {
+			require.NoError(t, rootDir.RemoveAll())
+		},
+	}
+}
+
+// RegisterCleanUpCallback adds a clean up function to the clean up chain
+func (e *Environment) RegisterCleanUpCallback(newCleanUp func()) {
+	previousCleanUp := e.cleanUp
+	e.cleanUp = func() {
+		newCleanUp()
+		previousCleanUp()
+	}
+}
+
+// CleanUp removes the test environment.
+func (e *Environment) CleanUp() {
+	e.cleanUp()
+}
+
+// RootDir returns the root dir of the environment.
+func (e *Environment) RootDir() *paths.Path {
+	return e.rootDir
+}
+
+// SharedDownloadsDir return the shared directory for downloads
+func (e *Environment) SharedDownloadsDir() *paths.Path {
+	return e.downloadsDir
+}
+
+// T returns the testing environment
+func (e *Environment) T() *testing.T {
+	return e.t
+}

Diff for: internal/integrationtest/http_server.go

@@ -0,0 +1,53 @@
+// 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 [email protected].
+
+package integrationtest
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/require"
+)
+
+// HTTPServeFile spawn an http server that serve a single file. The server
+// is started on the given port. The URL to the file and a cleanup function are returned.
+func (env *Environment) HTTPServeFile(port uint16, path *paths.Path) *url.URL {
+	mux := http.NewServeMux()
+	mux.HandleFunc("/"+path.Base(), func(w http.ResponseWriter, r *http.Request) {
+		http.ServeFile(w, r, path.String())
+	})
+	server := &http.Server{
+		Addr:    fmt.Sprintf(":%d", port),
+		Handler: mux,
+	}
+
+	t := env.T()
+	fileURL, err := url.Parse(fmt.Sprintf("http://127.0.0.1:%d/%s", port, path.Base()))
+	require.NoError(t, err)
+
+	go func() {
+		err := server.ListenAndServe()
+		require.Equal(t, err, http.ErrServerClosed)
+	}()
+
+	env.RegisterCleanUpCallback(func() {
+		server.Close()
+	})
+
+	return fileURL
+}