interfacing http operations to facilitate testing

Author: thejoeker12

httpclient/client.go

@@ -9,22 +9,37 @@ package httpclient
 
 import (
 	"fmt"
+	"io"
 	"net/http"
+	"net/url"
 	"time"
 
 	"github.com/deploymenttheory/go-api-http-client/concurrency"
 	"go.uber.org/zap"
 )
 
-const ()
-
-// TODO all struct comments
+type httpExecutor interface {
+	// Inherited
+	CloseIdleConnections()
+	Do(req *http.Request) (*http.Response, error)
+	Get(url string) (resp *http.Response, err error)
+	Head(url string) (resp *http.Response, err error)
+	Post(url string, contentType string, body io.Reader) (resp *http.Response, err error)
+	PostForm(url string, data url.Values) (resp *http.Response, err error)
+
+	// Additional
+	SetCookieJar(jar http.CookieJar)
+	SetCookies(url *url.URL, cookies []*http.Cookie)
+	SetCustomTimeout(time.Duration)
+	Cookies(*url.URL) []*http.Cookie
+	SetRedirectPolicy(*func(req *http.Request, via []*http.Request) error)
+}
 
 // Master struct/object
 type Client struct {
 	config      *ClientConfig
 	Integration *APIIntegration
-	http        *http.Client
+	http        httpExecutor
 	Sugar       *zap.SugaredLogger
 	Concurrency *concurrency.ConcurrencyHandler
 }
@@ -104,12 +119,10 @@ func (c *ClientConfig) Build() (*Client, error) {
 
 	c.Sugar.Debug("configuration valid")
 
-	httpClient := &http.Client{
-		Timeout: c.CustomTimeout,
-	}
+	httpClient := &prodClient{}
 
 	if c.CustomRedirectPolicy != nil {
-		httpClient.CheckRedirect = *c.CustomRedirectPolicy
+		httpClient.SetRedirectPolicy(c.CustomRedirectPolicy)
 	}
 
 	// TODO refactor concurrency

httpclient/cookies.go

@@ -14,20 +14,20 @@ func (c *Client) loadCustomCookies() error {
 		return err
 	}
 
-	c.http.Jar = cookieJar
+	c.http.SetCookieJar(cookieJar)
 
 	cookieUrl, err := url.Parse((*c.Integration).GetFQDN())
 	c.Sugar.Debug("cookie URL set globally to: %s", cookieUrl)
 	if err != nil {
 		return err
 	}
 
-	c.http.Jar.SetCookies(cookieUrl, c.config.CustomCookies)
+	c.http.SetCookies(cookieUrl, c.config.CustomCookies)
 
 	if c.config.HideSensitiveData {
 		c.Sugar.Debug("[REDACTED] cookies set successfully")
 	} else {
-		c.Sugar.Debug("custom cookies set: %v", c.http.Jar.Cookies(cookieUrl))
+		c.Sugar.Debug("custom cookies set: %v", c.http.Cookies(cookieUrl))
 	}
 
 	return nil

httpclient/http.go

@@ -0,0 +1,31 @@
+package httpclient
+
+import (
+	"net/http"
+	"net/url"
+	"time"
+)
+
+type prodClient struct {
+	*http.Client
+}
+
+func (c *prodClient) SetCookieJar(jar http.CookieJar) {
+	c.Jar = jar
+}
+
+func (c *prodClient) SetCookies(url *url.URL, cookies []*http.Cookie) {
+	c.Jar.SetCookies(url, cookies)
+}
+
+func (c *prodClient) SetCustomTimeout(timeout time.Duration) {
+	c.Timeout = timeout
+}
+
+func (c *prodClient) Cookies(url *url.URL) []*http.Cookie {
+	return c.Jar.Cookies(url)
+}
+
+func (c *prodClient) SetRedirectPolicy(policy *func(req *http.Request, via []*http.Request) error) {
+	c.CheckRedirect = *policy
+}

mock/main.go

@@ -0,0 +1 @@
+package mock