Merge pull request #30 from x1unix/dev

Refactor and cover Go Playground client

Author: x1unix

pkg/goplay/client.go

@@ -5,14 +5,16 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"net"
 	"net/http"
 	"net/url"
 	"strings"
+	"time"
 )
 
 const (
-	userAgent = "goplay.x1unix.com/1.0 (http://goplay.x1unix.com/)"
-	goPlayURL = "https://play.golang.org"
+	defaultUserAgent = "goplay.tools/1.0 (http://goplay.tools/)"
+	playgroundUrl    = "https://play.golang.org"
 
 	// maxSnippetSize value taken from
 	// https://github.com/golang/playground/blob/master/app/goplay/share.go
@@ -22,33 +24,61 @@ const (
 // ErrSnippetTooLarge is snippet max size limit error
 var ErrSnippetTooLarge = fmt.Errorf("code snippet too large (max %d bytes)", maxSnippetSize)
 
-func newRequest(ctx context.Context, method, queryPath string, body io.Reader) (*http.Request, error) {
-	uri := goPlayURL + "/" + queryPath
+type Client struct {
+	client    http.Client
+	baseUrl   string
+	userAgent string
+}
+
+// NewClient returns new Go playground client
+func NewClient(baseUrl, userAgent string, timeout time.Duration) *Client {
+	return &Client{
+		baseUrl:   baseUrl,
+		userAgent: userAgent,
+		client: http.Client{
+			Timeout: timeout,
+			Transport: &http.Transport{
+				DialContext: (&net.Dialer{
+					Timeout: timeout,
+				}).DialContext,
+				TLSHandshakeTimeout: timeout,
+			},
+		},
+	}
+}
+
+// NewDefaultClient returns Go Playground client with defaults
+func NewDefaultClient() *Client {
+	return NewClient(playgroundUrl, defaultUserAgent, 15*time.Second)
+}
+
+func (c *Client) newRequest(ctx context.Context, method, queryPath string, body io.Reader) (*http.Request, error) {
+	uri := c.baseUrl + "/" + queryPath
 	req, err := http.NewRequestWithContext(ctx, method, uri, body)
 	if err != nil {
 		return nil, err
 	}
 
-	req.Header.Add("User-Agent", userAgent)
+	req.Header.Add("User-Agent", c.userAgent)
 	return req, nil
 }
 
-func getRequest(ctx context.Context, queryPath string) (*http.Response, error) {
-	req, err := newRequest(ctx, http.MethodGet, queryPath, nil)
+func (c *Client) getRequest(ctx context.Context, queryPath string) (*http.Response, error) {
+	req, err := c.newRequest(ctx, http.MethodGet, queryPath, nil)
 	if err != nil {
 		return nil, nil
 	}
 
-	return http.DefaultClient.Do(req)
+	return c.client.Do(req)
 }
 
-func doRequest(ctx context.Context, method, url, contentType string, body io.Reader) ([]byte, error) {
-	req, err := newRequest(ctx, method, url, body)
+func (c *Client) doRequest(ctx context.Context, method, url, contentType string, body io.Reader) ([]byte, error) {
+	req, err := c.newRequest(ctx, method, url, body)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Add("Content-Type", contentType)
-	response, err := http.DefaultClient.Do(req)
+	response, err := c.client.Do(req)
 	if err != nil {
 		return nil, err
 	}
@@ -66,8 +96,8 @@ func doRequest(ctx context.Context, method, url, contentType string, body io.Rea
 	return bodyBytes.Bytes(), nil
 }
 
-func postForm(ctx context.Context, url string, data url.Values) ([]byte, error) {
-	return doRequest(
+func (c *Client) postForm(ctx context.Context, url string, data url.Values) ([]byte, error) {
+	return c.doRequest(
 		ctx, "POST", url,
 		"application/x-www-form-urlencoded", strings.NewReader(data.Encode()),
 	)

pkg/goplay/client_test.go

@@ -0,0 +1,13 @@
+package goplay
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewDefaultClient(t *testing.T) {
+	c := NewDefaultClient()
+	require.Equal(t, c.baseUrl, playgroundUrl)
+	require.Equal(t, c.userAgent, defaultUserAgent)
+}

pkg/goplay/errors_test.go

@@ -0,0 +1,39 @@
+package goplay
+
+import (
+	"errors"
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestCompileFailedError_Error(t *testing.T) {
+	msg := "test"
+	err := CompileFailedError{msg: msg}
+	require.Equal(t, msg, err.Error())
+}
+
+func TestIsCompileError(t *testing.T) {
+	errs := []struct {
+		err  error
+		want bool
+	}{
+		{
+			err:  CompileFailedError{},
+			want: true,
+		},
+		{
+			err: errors.New("test"),
+		},
+		{
+			err: ErrSnippetNotFound,
+		},
+	}
+
+	for _, c := range errs {
+		t.Run(fmt.Sprintf("%T", c.err), func(t *testing.T) {
+			require.Equal(t, c.want, IsCompileError(c.err))
+		})
+	}
+}

pkg/goplay/methods.go

@@ -17,14 +17,13 @@ func ValidateContentLength(itemLen int) error {
 	if itemLen > maxSnippetSize {
 		return ErrSnippetTooLarge
 	}
-
 	return nil
 }
 
 // GetSnippet returns snippet from Go playground
-func GetSnippet(ctx context.Context, snippetID string) (*Snippet, error) {
+func (c *Client) GetSnippet(ctx context.Context, snippetID string) (*Snippet, error) {
 	fileName := snippetID + ".go"
-	resp, err := getRequest(ctx, "p/"+fileName)
+	resp, err := c.getRequest(ctx, "p/"+fileName)
 	if err != nil {
 		return nil, err
 	}
@@ -49,8 +48,8 @@ func GetSnippet(ctx context.Context, snippetID string) (*Snippet, error) {
 }
 
 // Share shares snippet to go playground
-func Share(ctx context.Context, src io.Reader) (string, error) {
-	resp, err := doRequest(ctx, http.MethodPost, "share", "text/plain", src)
+func (c *Client) Share(ctx context.Context, src io.Reader) (string, error) {
+	resp, err := c.doRequest(ctx, http.MethodPost, "share", "text/plain", src)
 	if err != nil {
 		return "", err
 	}
@@ -60,12 +59,12 @@ func Share(ctx context.Context, src io.Reader) (string, error) {
 }
 
 // GoImports performs Goimports
-func GoImports(ctx context.Context, src []byte) (*FmtResponse, error) {
+func (c *Client) GoImports(ctx context.Context, src []byte) (*FmtResponse, error) {
 	form := url.Values{}
 	form.Add("imports", "true")
 	form.Add("body", string(src))
 
-	resp, err := postForm(ctx, "fmt", form)
+	resp, err := c.postForm(ctx, "fmt", form)
 	if err != nil {
 		return nil, fmt.Errorf("failed to contact Go Playground - %s", err)
 	}
@@ -83,20 +82,20 @@ func GoImports(ctx context.Context, src []byte) (*FmtResponse, error) {
 }
 
 // Compile runs code in goplayground and returns response
-func Compile(ctx context.Context, src []byte) (*CompileResponse, error) {
+func (c *Client) Compile(ctx context.Context, src []byte) (*CompileResponse, error) {
 	form := url.Values{}
 	form.Add("body", string(src))
 	form.Add("version", "2")
 
-	resp, err := postForm(ctx, "compile", form)
+	resp, err := c.postForm(ctx, "compile", form)
 	if err != nil {
 		return nil, err
 	}
 
 	dest := &CompileResponse{}
 	if err := json.Unmarshal(resp, dest); err != nil {
 		// return response text as errors
-		return nil, fmt.Errorf("error from %q: %s", goPlayURL, string(resp))
+		return nil, fmt.Errorf("error from %q: %s", c.baseUrl, string(resp))
 	}
 
 	return dest, err