Moved DownloadFile from 'resources' package into 'httpclient'

Author: cmaglie

arduino/cores/packagemanager/download.go

@@ -19,7 +19,7 @@ import (
 	"fmt"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
-	"github.com/arduino/arduino-cli/arduino/resources"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"go.bug.st/downloader/v2"
 	semver "go.bug.st/relaxed-semver"
 )
@@ -118,7 +118,7 @@ func (pm *PackageManager) FindPlatformReleaseDependencies(item *PlatformReferenc
 
 // DownloadToolRelease downloads a ToolRelease. If the tool is already downloaded a nil Downloader
 // is returned.
-func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *downloader.Config, label string, progressCB resources.DownloadProgressCB) error {
+func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *downloader.Config, label string, progressCB httpclient.DownloadProgressCB) error {
 	resource := tool.GetCompatibleFlavour()
 	if resource == nil {
 		return fmt.Errorf(tr("tool not available for your OS"))
@@ -128,6 +128,6 @@ func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *d
 
 // DownloadPlatformRelease downloads a PlatformRelease. If the platform is already downloaded a
 // nil Downloader is returned.
-func (pm *PackageManager) DownloadPlatformRelease(platform *cores.PlatformRelease, config *downloader.Config, label string, progressCB resources.DownloadProgressCB) error {
+func (pm *PackageManager) DownloadPlatformRelease(platform *cores.PlatformRelease, config *downloader.Config, label string, progressCB httpclient.DownloadProgressCB) error {
 	return platform.Resource.Download(pm.DownloadDir, config, label, progressCB)
 }

arduino/httpclient/httpclient.go

@@ -18,10 +18,54 @@ package httpclient
 import (
 	"net/http"
 	"net/url"
+	"time"
 
+	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/configuration"
+	"github.com/arduino/arduino-cli/i18n"
+	"github.com/arduino/go-paths-helper"
+	"go.bug.st/downloader/v2"
 )
 
+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 DownloadProgressCB, config *downloader.Config, options ...downloader.DownloadOptions) error {
+	if config == nil {
+		c, err := GetDownloaderConfig()
+		if err != nil {
+			return err
+		}
+		config = c
+	}
+
+	d, err := downloader.DownloadWithConfig(path.String(), URL, *config, options...)
+	if err != nil {
+		return err
+	}
+	downloadCB(&DownloadProgress{
+		File:      label,
+		URL:       d.URL,
+		TotalSize: d.Size(),
+	})
+
+	err = d.RunAndPoll(func(downloaded int64) {
+		downloadCB(&DownloadProgress{Downloaded: downloaded})
+	}, 250*time.Millisecond)
+	if err != nil {
+		return err
+	}
+
+	// The URL is not reachable for some reason
+	if d.Resp.StatusCode >= 400 && d.Resp.StatusCode <= 599 {
+		return &arduino.FailedDownloadError{Message: tr("Server responded with: %s", d.Resp.Status)}
+	}
+
+	downloadCB(&DownloadProgress{Completed: true})
+	return nil
+}
+
 // Config is the configuration of the http client
 type Config struct {
 	UserAgent string
@@ -50,6 +94,35 @@ func NewWithConfig(config *Config) *http.Client {
 	}
 }
 
+// DownloadProgress is a report of the download progress, not all fields may be
+// filled and multiple reports may be sent during a download.
+type DownloadProgress struct {
+	// URL of the download.
+	URL string
+	// The file being downloaded.
+	File string
+	// TotalSize is the total size of the file being downloaded.
+	TotalSize int64
+	// Downloaded is the size of the downloaded portion of the file.
+	Downloaded int64
+	// Completed reports whether the download is complete.
+	Completed bool
+}
+
+// DownloadProgressCB is a callback function to report download progress
+type DownloadProgressCB func(progress *DownloadProgress)
+
+// GetDownloaderConfig returns the downloader configuration based on current settings.
+func GetDownloaderConfig() (*downloader.Config, error) {
+	httpClient, err := New()
+	if err != nil {
+		return nil, &arduino.InvalidArgumentError{Message: tr("Could not connect via HTTP"), Cause: err}
+	}
+	return &downloader.Config{
+		HttpClient: *httpClient,
+	}, nil
+}
+
 type httpClientRoundTripper struct {
 	transport http.RoundTripper
 	userAgent string

arduino/resources/download.go

@@ -18,17 +18,15 @@ package resources
 import (
 	"fmt"
 	"os"
-	"time"
 
-	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/httpclient"
 	paths "github.com/arduino/go-paths-helper"
 	"go.bug.st/downloader/v2"
 )
 
 // Download performs a download loop using the provided downloader.Downloader.
 // Messages are passed back to the DownloadProgressCB using label as text for the File field.
-func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.Config, label string, downloadCB DownloadProgressCB) error {
+func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.Config, label string, downloadCB httpclient.DownloadProgressCB) error {
 	path, err := r.ArchivePath(downloadDir)
 	if err != nil {
 		return fmt.Errorf(tr("getting archive path: %s"), err)
@@ -47,7 +45,7 @@ func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.
 			// File is cached, nothing to do here
 
 			// This signal means that the file is already downloaded
-			downloadCB(&DownloadProgress{
+			downloadCB(&httpclient.DownloadProgress{
 				File:      label,
 				Completed: true,
 			})
@@ -56,71 +54,5 @@ func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.
 	} else {
 		return fmt.Errorf(tr("getting archive file info: %s"), err)
 	}
-	return DownloadFile(path, r.URL, label, downloadCB, config)
+	return httpclient.DownloadFile(path, r.URL, label, downloadCB, config)
 }
-
-// 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 DownloadProgressCB, config *downloader.Config, options ...downloader.DownloadOptions) error {
-	if config == nil {
-		c, err := GetDownloaderConfig()
-		if err != nil {
-			return err
-		}
-		config = c
-	}
-
-	d, err := downloader.DownloadWithConfig(path.String(), URL, *config, options...)
-	if err != nil {
-		return err
-	}
-	downloadCB(&DownloadProgress{
-		File:      label,
-		URL:       d.URL,
-		TotalSize: d.Size(),
-	})
-
-	err = d.RunAndPoll(func(downloaded int64) {
-		downloadCB(&DownloadProgress{Downloaded: downloaded})
-	}, 250*time.Millisecond)
-	if err != nil {
-		return err
-	}
-
-	// The URL is not reachable for some reason
-	if d.Resp.StatusCode >= 400 && d.Resp.StatusCode <= 599 {
-		return &arduino.FailedDownloadError{Message: tr("Server responded with: %s", d.Resp.Status)}
-	}
-
-	downloadCB(&DownloadProgress{Completed: true})
-	return nil
-}
-
-// GetDownloaderConfig returns the downloader configuration based on current settings.
-func GetDownloaderConfig() (*downloader.Config, error) {
-	httpClient, err := httpclient.New()
-	if err != nil {
-		return nil, &arduino.InvalidArgumentError{Message: tr("Could not connect via HTTP"), Cause: err}
-	}
-	return &downloader.Config{
-		HttpClient: *httpClient,
-	}, nil
-}
-
-// DownloadProgress is a report of the download progress, not all fields may be
-// filled and multiple reports may be sent during a download.
-type DownloadProgress struct {
-	// URL of the download.
-	URL string
-	// The file being downloaded.
-	File string
-	// TotalSize is the total size of the file being downloaded.
-	TotalSize int64
-	// Downloaded is the size of the downloaded portion of the file.
-	Downloaded int64
-	// Completed reports whether the download is complete.
-	Completed bool
-}
-
-// DownloadProgressCB is a callback function to report download progress
-type DownloadProgressCB func(progress *DownloadProgress)

arduino/resources/helpers_test.go

@@ -55,7 +55,7 @@ func TestDownloadApplyUserAgentHeaderUsingConfig(t *testing.T) {
 
 	httpClient := httpclient.NewWithConfig(&httpclient.Config{UserAgent: goldUserAgentValue})
 
-	err = r.Download(tmp, &downloader.Config{HttpClient: *httpClient}, "", func(progress *DownloadProgress) {})
+	err = r.Download(tmp, &downloader.Config{HttpClient: *httpClient}, "", func(progress *httpclient.DownloadProgress) {})
 	require.NoError(t, err)
 
 	// leverage the download helper to download the echo for the request made by the downloader itself

arduino/resources/index.go

@@ -21,6 +21,7 @@ import (
 	"strings"
 
 	"github.com/arduino/arduino-cli/arduino"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/arduino/security"
 	"github.com/arduino/go-paths-helper"
 	"go.bug.st/downloader/v2"
@@ -34,7 +35,7 @@ type IndexResource struct {
 
 // Download will download the index and possibly check the signature using the Arduino's public key.
 // If the file is in .gz format it will be unpacked first.
-func (res *IndexResource) Download(destDir *paths.Path, downloadCB DownloadProgressCB) error {
+func (res *IndexResource) Download(destDir *paths.Path, downloadCB httpclient.DownloadProgressCB) error {
 	// Create destination directory
 	if err := destDir.MkdirAll(); err != nil {
 		return &arduino.PermissionDeniedError{Message: tr("Can't create data directory %s", destDir), Cause: err}
@@ -50,7 +51,7 @@ func (res *IndexResource) Download(destDir *paths.Path, downloadCB DownloadProgr
 	// Download index file
 	indexFileName := path.Base(res.URL.Path) // == pakcage_index.json[.gz]
 	tmpIndexPath := tmp.Join(indexFileName)
-	if err := DownloadFile(tmpIndexPath, res.URL.String(), tr("Downloading index: %s", indexFileName), downloadCB, nil, downloader.NoResume); err != nil {
+	if err := httpclient.DownloadFile(tmpIndexPath, res.URL.String(), tr("Downloading index: %s", indexFileName), downloadCB, nil, downloader.NoResume); err != nil {
 		return &arduino.FailedDownloadError{Message: tr("Error downloading index '%s'", res.URL), Cause: err}
 	}
 
@@ -73,7 +74,7 @@ func (res *IndexResource) Download(destDir *paths.Path, downloadCB DownloadProgr
 		// Download signature
 		signaturePath = destDir.Join(signatureFileName)
 		tmpSignaturePath = tmp.Join(signatureFileName)
-		if err := DownloadFile(tmpSignaturePath, res.SignatureURL.String(), tr("Downloading index signature: %s", signatureFileName), downloadCB, nil, downloader.NoResume); err != nil {
+		if err := httpclient.DownloadFile(tmpSignaturePath, res.SignatureURL.String(), tr("Downloading index signature: %s", signatureFileName), downloadCB, nil, downloader.NoResume); err != nil {
 			return &arduino.FailedDownloadError{Message: tr("Error downloading index signature '%s'", res.SignatureURL), Cause: err}
 		}
 

arduino/resources/resources_test.go

@@ -20,6 +20,7 @@ import (
 	"encoding/hex"
 	"testing"
 
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
 	"go.bug.st/downloader/v2"
@@ -44,7 +45,7 @@ func TestDownloadAndChecksums(t *testing.T) {
 	require.NoError(t, err)
 
 	downloadAndTestChecksum := func() {
-		err := r.Download(tmp, &downloader.Config{}, "", func(*DownloadProgress) {})
+		err := r.Download(tmp, &downloader.Config{}, "", func(*httpclient.DownloadProgress) {})
 		require.NoError(t, err)
 
 		data, err := testFile.ReadFile()
@@ -58,7 +59,7 @@ func TestDownloadAndChecksums(t *testing.T) {
 	downloadAndTestChecksum()
 
 	// Download with cached file
-	err = r.Download(tmp, &downloader.Config{}, "", func(*DownloadProgress) {})
+	err = r.Download(tmp, &downloader.Config{}, "", func(*httpclient.DownloadProgress) {})
 	require.NoError(t, err)
 
 	// Download if cached file has data in excess (redownload)

commands/bundled_tools.go

@@ -19,13 +19,13 @@ import (
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
-	"github.com/arduino/arduino-cli/arduino/resources"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
 // DownloadToolRelease downloads a ToolRelease
 func DownloadToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, downloadCB DownloadProgressCB) error {
-	config, err := resources.GetDownloaderConfig()
+	config, err := httpclient.GetDownloaderConfig()
 	if err != nil {
 		return err
 	}

commands/core/download.go

@@ -22,7 +22,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
-	"github.com/arduino/arduino-cli/arduino/resources"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -67,7 +67,7 @@ func PlatformDownload(ctx context.Context, req *rpc.PlatformDownloadRequest, dow
 
 func downloadPlatform(pm *packagemanager.PackageManager, platformRelease *cores.PlatformRelease, downloadCB commands.DownloadProgressCB) error {
 	// Download platform
-	config, err := resources.GetDownloaderConfig()
+	config, err := httpclient.GetDownloaderConfig()
 	if err != nil {
 		return &arduino.FailedDownloadError{Message: tr("Error downloading platform %s", platformRelease), Cause: err}
 	}

commands/instances.go

@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packageindex"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
@@ -580,7 +581,7 @@ func getOutputRelease(lib *librariesindex.Release) *rpc.LibraryRelease {
 
 // Upgrade downloads and installs outdated Cores and Libraries
 func Upgrade(ctx context.Context, req *rpc.UpgradeRequest, downloadCB DownloadProgressCB, taskCB TaskProgressCB) error {
-	downloaderConfig, err := resources.GetDownloaderConfig()
+	downloaderConfig, err := httpclient.GetDownloaderConfig()
 	if err != nil {
 		return err
 	}

commands/lib/download.go

@@ -19,9 +19,9 @@ import (
 	"context"
 
 	"github.com/arduino/arduino-cli/arduino"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
-	"github.com/arduino/arduino-cli/arduino/resources"
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -57,7 +57,7 @@ func downloadLibrary(lm *librariesmanager.LibrariesManager, libRelease *librarie
 	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB) error {
 
 	taskCB(&rpc.TaskProgress{Name: tr("Downloading %s", libRelease)})
-	config, err := resources.GetDownloaderConfig()
+	config, err := httpclient.GetDownloaderConfig()
 	if err != nil {
 		return &arduino.FailedDownloadError{Message: tr("Can't download library"), Cause: err}
 	}

commands/progress.go

@@ -16,16 +16,16 @@
 package commands
 
 import (
-	"github.com/arduino/arduino-cli/arduino/resources"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
 // DownloadProgressCB is a callback to get updates on download progress
 type DownloadProgressCB func(curr *rpc.DownloadProgress)
 
 // FromRPC converts the gRPC DownloadProgessCB in a resources.DownloadProgressCB
-func (rpcCB DownloadProgressCB) FromRPC() resources.DownloadProgressCB {
-	return func(cb *resources.DownloadProgress) {
+func (rpcCB DownloadProgressCB) FromRPC() httpclient.DownloadProgressCB {
+	return func(cb *httpclient.DownloadProgress) {
 		rpcCB(&rpc.DownloadProgress{
 			Url:        cb.URL,
 			File:       cb.File,