Refactored integration tests

Author: cmaglie

arduino/httpclient/httpclient.go

@@ -32,7 +32,7 @@ var tr = i18n.Tr
 
 // DownloadFile downloads a file from a URL into the specified path. An optional config and options may be passed (or nil to use the defaults).
 // A DownloadProgressCB callback function must be passed to monitor download progress.
-func DownloadFile(path *paths.Path, URL string, label string, downloadCB rpc.DownloadProgressCB, config *downloader.Config, options ...downloader.DownloadOptions) (downloadError error) {
+func DownloadFile(path *paths.Path, URL string, label string, downloadCB rpc.DownloadProgressCB, config *downloader.Config, options ...downloader.DownloadOptions) error {
 	if config == nil {
 		c, err := GetDownloaderConfig()
 		if err != nil {

internal/integrationtest/daemon/daemon_core_test.go

@@ -21,6 +21,7 @@ import (
 	"io"
 	"testing"
 
+	"github.com/arduino/arduino-cli/internal/integrationtest"
 	"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/stretchr/testify/require"
 )
@@ -41,57 +42,33 @@ func TestDaemonCoreUpdateIndex(t *testing.T) {
 			` "http://downloads.arduino.cc/package_inexistent_index.json"]`)
 	require.NoError(t, err)
 
+	analyzeUpdateIndexClient := func(cl commands.ArduinoCoreService_UpdateIndexClient) map[string]*commands.DownloadProgressEnd {
+		analyzer := integrationtest.NewDownloadProgressAnalyzer(t)
+		for {
+			msg, err := cl.Recv()
+			if err == io.EOF {
+				break
+			}
+			require.NoError(t, err)
+			analyzer.Process(msg.GetDownloadProgress())
+		}
+		return analyzer.Results
+	}
+
 	{
 		cl, err := grpcInst.UpdateIndex(context.Background(), true)
 		require.NoError(t, err)
-		res, err := analyzeUpdateIndexStream(t, cl)
-		require.NoError(t, err)
+		res := analyzeUpdateIndexClient(cl)
 		require.Len(t, res, 1)
 		require.True(t, res["https://downloads.arduino.cc/packages/package_index.tar.bz2"].Success)
 	}
 	{
 		cl, err := grpcInst.UpdateIndex(context.Background(), false)
 		require.NoError(t, err)
-		res, err := analyzeUpdateIndexStream(t, cl)
-		require.Error(t, err)
+		res := analyzeUpdateIndexClient(cl)
 		require.Len(t, res, 3)
 		require.True(t, res["https://downloads.arduino.cc/packages/package_index.tar.bz2"].Success)
 		require.True(t, res["http://arduino.esp8266.com/stable/package_esp8266com_index.json"].Success)
 		require.False(t, res["http://downloads.arduino.cc/package_inexistent_index.json"].Success)
 	}
 }
-
-// analyzeUpdateIndexStream runs an update index checking if the sequence of DownloadProgress and
-// DownloadResult messages is correct. It returns a map reporting all the DownloadResults messages
-// received (it maps urls to DownloadResults).
-func analyzeUpdateIndexStream(t *testing.T, cl commands.ArduinoCoreService_UpdateIndexClient) (map[string]*commands.DownloadProgressEnd, error) {
-	ongoingDownload := ""
-	results := map[string]*commands.DownloadProgressEnd{}
-	for {
-		msg, err := cl.Recv()
-		if err == io.EOF {
-			return results, nil
-		}
-		if err != nil {
-			return results, err
-		}
-		require.NoError(t, err)
-		fmt.Printf("UPDATE> %+v\n", msg)
-		if progress := msg.GetDownloadProgress(); progress != nil {
-			if start := progress.GetStart(); start != nil {
-				require.Empty(t, ongoingDownload, "DownloadProgressStart: started a download without 'completing' the previous one")
-				ongoingDownload = start.Url
-			} else if update := progress.GetUpdate(); update != nil {
-				require.NotEmpty(t, ongoingDownload, "DownloadProgressUpdate: received update, but the download is not yet started...")
-			} else if end := progress.GetEnd(); end != nil {
-				require.NotEmpty(t, ongoingDownload, "DownloadProgress: received a 'completed' notification but never initiated a download")
-				results[ongoingDownload] = end
-				ongoingDownload = ""
-			} else {
-				require.FailNow(t, "DownloadProgress: received an empty DownloadProgress (without Start, Update or End)")
-			}
-		} else {
-			require.FailNow(t, "DownloadProgress: received an empty message (without a DownloadProgress)")
-		}
-	}
-}

internal/integrationtest/download_progress.go

@@ -0,0 +1,58 @@
+// 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 (
+	"testing"
+
+	"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/stretchr/testify/require"
+)
+
+// DownloadProgressAnalyzer analyzes DownloadProgress messages for consistency
+type DownloadProgressAnalyzer struct {
+	t               *testing.T
+	ongoingDownload string
+	Results         map[string]*commands.DownloadProgressEnd
+}
+
+// NewDownloadProgressAnalyzer creates a new DownloadProgressAnalyzer
+func NewDownloadProgressAnalyzer(t *testing.T) *DownloadProgressAnalyzer {
+	return &DownloadProgressAnalyzer{
+		t:       t,
+		Results: map[string]*commands.DownloadProgressEnd{},
+	}
+}
+
+// Process the given DownloadProgress message. If inconsistencies are detected the
+// test will fail.
+func (a *DownloadProgressAnalyzer) Process(progress *commands.DownloadProgress) {
+	if progress == nil {
+		return
+	}
+	if start := progress.GetStart(); start != nil {
+		require.Empty(a.t, a.ongoingDownload, "DownloadProgressStart: started a download without 'completing' the previous one")
+		a.ongoingDownload = start.Url
+	} else if update := progress.GetUpdate(); update != nil {
+		require.NotEmpty(a.t, a.ongoingDownload, "DownloadProgressUpdate: received update, but the download is not yet started...")
+	} else if end := progress.GetEnd(); end != nil {
+		require.NotEmpty(a.t, a.ongoingDownload, "DownloadProgress: received a 'completed' notification but never initiated a download")
+		a.Results[a.ongoingDownload] = end
+		a.ongoingDownload = ""
+	} else {
+		require.FailNow(a.t, "DownloadProgress: received an empty DownloadProgress (without Start, Update or End)")
+	}
+}