refactor(v2): refactor client to have better code organization (#267)

* build(deps): bump golang.org/x/net

Bumps [golang.org/x/net](https://github.com/golang/net) from 0.0.0-20220111093109-d55c255bac03 to 0.7.0.
- [Release notes](https://github.com/golang/net/releases)
- [Commits](https://github.com/golang/net/commits/v0.7.0)

---
updated-dependencies:
- dependency-name: golang.org/x/net
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* refactor(v2): refactor v2 client to use Requester interface instead of RequestFunc

* refactor(v2): add sysdig client tests

* refactor(v2): add error from response tests

* refactor(v2): rename sysdigrequest receiver

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: filiptubic

go.mod

@@ -70,10 +70,10 @@ require (
 	github.com/vmihailenco/tagparser v0.1.1 // indirect
 	github.com/zclconf/go-cty v1.11.0 // indirect
 	golang.org/x/crypto v0.0.0-20220517005047-85d78b3ac167 // indirect
-	golang.org/x/net v0.0.0-20220111093109-d55c255bac03 // indirect
+	golang.org/x/net v0.7.0 // indirect
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
-	golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
-	golang.org/x/text v0.3.8 // indirect
+	golang.org/x/sys v0.5.0 // indirect
+	golang.org/x/text v0.7.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20220111164026-67b88f271998 // indirect
 	google.golang.org/grpc v1.48.0 // indirect

go.sum

@@ -1072,8 +1072,8 @@ golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qx
 golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.0.0-20211216030914-fe4d6282115f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20220111093109-d55c255bac03 h1:0FB83qp0AzVJm+0wcIlauAjJ+tNdh7jLuacRYCIVv7s=
-golang.org/x/net v0.0.0-20220111093109-d55c255bac03/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g=
+golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -1209,10 +1209,10 @@ golang.org/x/sys v0.0.0-20211124211545-fe61309f8881/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20211205182925-97ca703d548d/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f h1:v4INt8xihDGvnrfjMDVXGxw9wrfxYyCjk0KbXjhR55s=
-golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 h1:v+OssWQX+hTHEmOBgwxdZxK4zHq3yOs8F9J7mk0PY8E=
+golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
+golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.5.0 h1:n2a8QNdAb0sZNpU9R1ALUXBbY+w51fCQDN+7EdxNBsY=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -1222,8 +1222,8 @@ golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
-golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY=
-golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
+golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo=
+golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=

sysdig/internal/client/v2/client.go

@@ -6,7 +6,6 @@ import (
 	"crypto/tls"
 	"encoding/json"
 	"errors"
-	"fmt"
 	"github.com/hashicorp/go-retryablehttp"
 	"github.com/jmespath/go-jmespath"
 	"github.com/spf13/cast"
@@ -17,6 +16,12 @@ import (
 	"strings"
 )
 
+const (
+	AuthorizationHeader = "Authorization"
+	ContentTypeHeader   = "Content-Type"
+	ContentTypeJSON     = "application/json"
+)
+
 type Common interface {
 	TeamInterface
 }
@@ -29,80 +34,54 @@ type Secure interface {
 	Common
 }
 
-type RequestFunc func(ctx context.Context, method string, url string, payload io.Reader) (*http.Response, error)
-
-type Client struct {
-	config     *config
-	httpClient *http.Client
-	DoRequest  RequestFunc
-}
-
-type config struct {
-	url          string
-	token        string
-	insecure     bool
-	extraHeaders map[string]string
+type Requester interface {
+	Request(ctx context.Context, method string, url string, payload io.Reader) (*http.Response, error)
 }
 
-type ClientOption func(c *config)
-
-func WithURL(url string) ClientOption {
-	return func(c *config) {
-		c.url = url
-	}
+type Client struct {
+	config    *config
+	requester Requester
 }
 
-func WithToken(token string) ClientOption {
-	return func(c *config) {
-		c.token = token
+func (client *Client) ErrorFromResponse(response *http.Response) error {
+	var data interface{}
+	err := json.NewDecoder(response.Body).Decode(&data)
+	if err != nil {
+		return errors.New(response.Status)
 	}
-}
 
-func WithInsecure(insecure bool) ClientOption {
-	return func(c *config) {
-		c.insecure = insecure
+	search, err := jmespath.Search("[message, errors[].[reason, message]][][] | join(', ', @)", data)
+	if err != nil {
+		return errors.New(response.Status)
 	}
-}
 
-func WithExtraHeaders(headers map[string]string) ClientOption {
-	return func(c *config) {
-		c.extraHeaders = headers
+	if searchArray, ok := search.([]interface{}); ok {
+		return errors.New(strings.Join(cast.ToStringSlice(searchArray), ", "))
 	}
-}
-
-func NewMonitor(opts ...ClientOption) Monitor {
-	return newClient(opts...)
-}
 
-func NewSecure(opts ...ClientOption) Secure {
-	return newClient(opts...)
+	return errors.New(cast.ToString(search))
 }
 
-func newClient(opts ...ClientOption) *Client {
-	cfg := &config{}
-	for _, opt := range opts {
-		opt(cfg)
-	}
-
-	httpClient := retryablehttp.NewClient()
-	transport := http.DefaultTransport.(*http.Transport).Clone()
-	transport.TLSClientConfig = &tls.Config{InsecureSkipVerify: cfg.insecure}
-	httpClient.HTTPClient = &http.Client{Transport: transport}
+func Unmarshal[T any](data io.ReadCloser) (T, error) {
+	var result T
 
-	c := &Client{
-		config:     cfg,
-		httpClient: httpClient.StandardClient(),
+	body, err := io.ReadAll(data)
+	if err != nil {
+		return result, err
 	}
 
-	// default to sysdig request
-	c.DoRequest = c.doSysdigRequest
+	err = json.Unmarshal(body, &result)
+	return result, err
+}
 
-	return c
+func Marshal[T any](data T) (io.Reader, error) {
+	payload, err := json.Marshal(data)
+	return bytes.NewBuffer(payload), err
 }
 
-func (client *Client) request(request *http.Request) (*http.Response, error) {
-	if client.config.extraHeaders != nil {
-		for key, value := range client.config.extraHeaders {
+func request(httpClient *http.Client, cfg *config, request *http.Request) (*http.Response, error) {
+	if cfg.extraHeaders != nil {
+		for key, value := range cfg.extraHeaders {
 			request.Header.Set(key, value)
 		}
 	}
@@ -113,7 +92,7 @@ func (client *Client) request(request *http.Request) (*http.Response, error) {
 	}
 
 	log.Printf("[DEBUG] %s", string(out))
-	response, err := client.httpClient.Do(request)
+	response, err := httpClient.Do(request)
 	if err != nil {
 		log.Println(err.Error())
 		return response, err
@@ -127,45 +106,10 @@ func (client *Client) request(request *http.Request) (*http.Response, error) {
 	return response, err
 }
 
-func (client *Client) doSysdigRequest(ctx context.Context, method string, url string, payload io.Reader) (*http.Response, error) {
-	request, err := http.NewRequest(method, url, payload)
-	if err != nil {
-		return nil, err
-	}
-
-	request = request.WithContext(ctx)
-	request.Header.Set("Authorization", fmt.Sprintf("Bearer %s", client.config.token))
-	request.Header.Set("Content-Type", "application/json")
-
-	return client.request(request)
-}
-
-func (client *Client) ErrorFromResponse(response *http.Response) error {
-	var data interface{}
-	err := json.NewDecoder(response.Body).Decode(&data)
-	if err != nil {
-		return errors.New(response.Status)
-	}
-
-	search, err := jmespath.Search("[message, errors[].[reason, message]][][] | join(', ', @)", data)
-	if err != nil {
-		return errors.New(response.Status)
-	}
-
-	if searchArray, ok := search.([]interface{}); ok {
-		return errors.New(strings.Join(cast.ToStringSlice(searchArray), ", "))
-	}
-
-	return errors.New(cast.ToString(search))
-}
-
-func Unmarshal[T any](body []byte) (T, error) {
-	var result T
-	err := json.Unmarshal(body, &result)
-	return result, err
-}
-
-func Marshal[T any](data T) (io.Reader, error) {
-	payload, err := json.Marshal(data)
-	return bytes.NewBuffer(payload), err
+func newHTTPClient(cfg *config) *http.Client {
+	httpClient := retryablehttp.NewClient()
+	transport := http.DefaultTransport.(*http.Transport).Clone()
+	transport.TLSClientConfig = &tls.Config{InsecureSkipVerify: cfg.insecure}
+	httpClient.HTTPClient = &http.Client{Transport: transport}
+	return httpClient.StandardClient()
 }

sysdig/internal/client/v2/client_test.go

@@ -0,0 +1,91 @@
+package v2
+
+import (
+	"encoding/json"
+	"io"
+	"net/http"
+	"strings"
+	"testing"
+)
+
+func TestMarshal(t *testing.T) {
+	t.Parallel()
+	type foo struct {
+		Number int `json:"number"`
+	}
+
+	given := &foo{Number: 15}
+	expected := `{"number":15}`
+
+	data, err := Marshal(given)
+	if err != nil {
+		t.Errorf("failed to marshal %v", err)
+	}
+
+	buf := &strings.Builder{}
+	_, err = io.Copy(buf, data)
+	if err != nil {
+		t.Errorf("failed to populate buffer, err: %v", err)
+	}
+
+	marshaled := buf.String()
+	if marshaled != expected {
+		t.Errorf("expected %v, got %v", expected, marshaled)
+	}
+}
+
+func TestUnmarshal(t *testing.T) {
+	t.Parallel()
+	type foo struct {
+		Number int `json:"number"`
+	}
+	given := `{"number":15}`
+	expected := foo{Number: 15}
+
+	unmarshalled, err := Unmarshal[foo](io.NopCloser(strings.NewReader(given)))
+	if err != nil {
+		t.Errorf("got error while unmarshaling, err: %v", err)
+	}
+
+	if expected != unmarshalled {
+		t.Errorf("expected %v, got %v", expected, unmarshalled)
+	}
+}
+
+func TestClient_ErrorFromResponse(t *testing.T) {
+	type Error struct {
+		Reason  string `json:"reason"`
+		Message string `json:"message"`
+	}
+
+	type Errors struct {
+		Errors []Error `json:"errors"`
+	}
+
+	given := Errors{
+		Errors: []Error{
+			{
+				Reason:  "error1",
+				Message: "message1",
+			},
+			{
+				Reason:  "error2",
+				Message: "message2",
+			},
+		},
+	}
+	expected := "error1, message1, error2, message2"
+	c := Client{}
+	payload, err := json.Marshal(given)
+	if err != nil {
+		t.Errorf("failed to marshal errors, %v", err)
+	}
+
+	resp := &http.Response{
+		Body: io.NopCloser(strings.NewReader(string(payload))),
+	}
+	err = c.ErrorFromResponse(resp)
+	if err.Error() != expected {
+		t.Errorf("expected err %v, got %v", expected, err)
+	}
+}

sysdig/internal/client/v2/config.go

@@ -0,0 +1,42 @@
+package v2
+
+type config struct {
+	url          string
+	token        string
+	insecure     bool
+	extraHeaders map[string]string
+}
+
+type ClientOption func(c *config)
+
+func WithURL(url string) ClientOption {
+	return func(c *config) {
+		c.url = url
+	}
+}
+
+func WithToken(token string) ClientOption {
+	return func(c *config) {
+		c.token = token
+	}
+}
+
+func WithInsecure(insecure bool) ClientOption {
+	return func(c *config) {
+		c.insecure = insecure
+	}
+}
+
+func WithExtraHeaders(headers map[string]string) ClientOption {
+	return func(c *config) {
+		c.extraHeaders = headers
+	}
+}
+
+func configure(opts ...ClientOption) *config {
+	cfg := &config{}
+	for _, opt := range opts {
+		opt(cfg)
+	}
+	return cfg
+}