Moved some package in their appropriate place.

httpclient is now under arduino/httpclient.
Some configuration values have been moved under 'configuration' package,
and the related subroutines have been refactored.

Author: cmaglie

httpclient/httpclient_transport.go renamed to arduino/httpclient/httpclient.go

@@ -15,27 +15,47 @@
 
 package httpclient
 
-import "net/http"
+import (
+	"net/http"
+	"net/url"
 
-type httpClientRoundTripper struct {
-	transport http.RoundTripper
-	config    *Config
-}
+	"github.com/arduino/arduino-cli/configuration"
+)
 
-func newHTTPClientTransport(config *Config) http.RoundTripper {
-	proxy := http.ProxyURL(config.Proxy)
+// Config is the configuration of the http client
+type Config struct {
+	UserAgent string
+	Proxy     *url.URL
+}
 
-	transport := &http.Transport{
-		Proxy: proxy,
+// New returns a default http client for use in the arduino-cli
+func New() (*http.Client, error) {
+	userAgent := configuration.UserAgent(configuration.Settings)
+	proxy, err := configuration.NetworkProxy(configuration.Settings)
+	if err != nil {
+		return nil, err
 	}
+	return NewWithConfig(&Config{UserAgent: userAgent, Proxy: proxy}), nil
+}
 
-	return &httpClientRoundTripper{
-		transport: transport,
-		config:    config,
+// NewWithConfig creates a http client for use in the arduino-cli, with a given configuration
+func NewWithConfig(config *Config) *http.Client {
+	return &http.Client{
+		Transport: &httpClientRoundTripper{
+			transport: &http.Transport{
+				Proxy: http.ProxyURL(config.Proxy),
+			},
+			userAgent: config.UserAgent,
+		},
 	}
 }
 
+type httpClientRoundTripper struct {
+	transport http.RoundTripper
+	userAgent string
+}
+
 func (h *httpClientRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
-	req.Header.Add("User-Agent", h.config.UserAgent)
+	req.Header.Add("User-Agent", h.userAgent)
 	return h.transport.RoundTrip(req)
 }

httpclient/httpclient_test.go renamed to arduino/httpclient/httpclient_test.go

@@ -21,7 +21,7 @@ import (
 	"time"
 
 	"github.com/arduino/arduino-cli/arduino"
-	"github.com/arduino/arduino-cli/httpclient"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	paths "github.com/arduino/go-paths-helper"
 	"go.bug.st/downloader/v2"
 )

arduino/resources/download.go

@@ -22,7 +22,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/arduino/arduino-cli/httpclient"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
 	"go.bug.st/downloader/v2"

arduino/resources/helpers_test.go

@@ -20,10 +20,10 @@ import (
 	"strings"
 	"time"
 
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/configuration"
-	"github.com/arduino/arduino-cli/httpclient"
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/inventory"
 	"github.com/fatih/color"

cli/updater/updater.go

@@ -28,8 +28,8 @@ import (
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/discovery"
+	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/commands"
-	"github.com/arduino/arduino-cli/httpclient"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/pkg/errors"
 	"github.com/segmentio/stats/v4"

commands/board/list.go

@@ -13,47 +13,20 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package httpclient
+package configuration
 
 import (
 	"fmt"
 	"net/url"
 	"runtime"
 
 	"github.com/arduino/arduino-cli/cli/globals"
-	"github.com/arduino/arduino-cli/configuration"
+	"github.com/spf13/viper"
 )
 
-// Config is the configuration of the http client
-type Config struct {
-	UserAgent string
-	Proxy     *url.URL
-}
-
-// DefaultConfig returns the default http client config
-func DefaultConfig() (*Config, error) {
-	var proxy *url.URL
-	var err error
-	if configuration.Settings.IsSet("network.proxy") {
-		proxyConfig := configuration.Settings.GetString("network.proxy")
-		if proxyConfig == "" {
-			// empty configuration
-			// this workaround must be here until viper can UnSet properties:
-			// https://github.com/spf13/viper/pull/519
-		} else if proxy, err = url.Parse(proxyConfig); err != nil {
-			return nil, fmt.Errorf(tr("Invalid network.proxy '%[1]s': %[2]s"), proxyConfig, err)
-		}
-	}
-
-	return &Config{
-		UserAgent: UserAgent(),
-		Proxy:     proxy,
-	}, nil
-}
-
-// UserAgent returns the user agent for the cli http client
-func UserAgent() string {
-	subComponent := configuration.Settings.GetString("network.user_agent_ext")
+// UserAgent returns the user agent for the cli (mainly used by http clients)
+func UserAgent(settings *viper.Viper) string {
+	subComponent := settings.GetString("network.user_agent_ext")
 	if subComponent != "" {
 		subComponent = " " + subComponent
 	}
@@ -65,3 +38,20 @@ func UserAgent() string {
 		runtime.GOARCH, runtime.GOOS, runtime.Version(),
 		globals.VersionInfo.Commit)
 }
+
+// NetworkProxy returns the proxy configuration (mainly used by http clients)
+func NetworkProxy(settings *viper.Viper) (*url.URL, error) {
+	if !settings.IsSet("network.proxy") {
+		return nil, nil
+	}
+	if proxyConfig := settings.GetString("network.proxy"); proxyConfig == "" {
+		// empty configuration
+		// this workaround must be here until viper can UnSet properties:
+		// https://github.com/spf13/viper/pull/519
+		return nil, nil
+	} else if proxy, err := url.Parse(proxyConfig); err != nil {
+		return nil, fmt.Errorf(tr("Invalid network.proxy '%[1]s': %[2]s"), proxyConfig, err)
+	} else {
+		return proxy, nil
+	}
+}