Query support (#44)

* feat: testclient, Query support

* feat: WithQuery()

* feat: MustParseQuery()

* feat: httpbin, add /get

* tests: add tests

* feat: show type, if string is same

Author: podhmo

client.go

@@ -212,6 +212,13 @@ func WithBasePath(basePath string) func(*Config) {
 	}
 }
 
+// WithQuery :
+func WithQuery(query url.Values) func(*Config) {
+	return func(c *Config) {
+		c.ClientConfig.Query = query
+	}
+}
+
 // WithForm setup as send form-data request
 func WithForm(data url.Values) func(*Config) {
 	return func(c *Config) {

httpbin/handlers.go

@@ -1,6 +1,7 @@
 package httpbin
 
 import (
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"strconv"
@@ -15,6 +16,21 @@ func WriteError(w http.ResponseWriter, error string, code int) {
 	fmt.Fprintf(w, `{"message": %q}`, error)
 }
 
+// Get : /get
+func Get(w http.ResponseWriter, r *http.Request) {
+	w.Header().Set("Content-Type", "application/json; charset=utf-8")
+	encoder := json.NewEncoder(w)
+	d := map[string]interface{}{
+		"args":    r.URL.Query(),
+		"headers": r.Header,
+		"url":     r.URL.String(),
+	}
+
+	if err := encoder.Encode(d); err != nil {
+		panic(err)
+	}
+}
+
 // Status : /status/{status}
 func Status(w http.ResponseWriter, r *http.Request) {
 	nodes := strings.Split(strings.TrimSuffix(r.URL.Path, "/"), "/")

httpbin/httpbin.go

@@ -14,6 +14,7 @@ func Handler() http.Handler {
 // BindHandlers :
 func BindHandlers(mux *http.ServeMux) {
 	mux.HandleFunc("/status/", Status)
+	mux.HandleFunc("/get", Get)
 }
 
 func Run(port string, mux http.Handler) error {

httpbin/integration_test.go

@@ -1,6 +1,8 @@
 package httpbin_test
 
 import (
+	"fmt"
+	"net/url"
 	"testing"
 
 	webtest "github.com/podhmo/go-webtest"
@@ -108,4 +110,62 @@ func TestUnit(t *testing.T) {
 
 		// todo: assertion db check
 	})
+
+	t.Run("get", func(t *testing.T) {
+		client = client.Bind(
+			hook.ExpectCode(200),
+		)
+
+		cases := []struct {
+			path     string
+			query    url.Values
+			expected interface{}
+		}{
+			{
+				path:     "/get",
+				expected: map[string][]string{},
+			},
+			{
+				path:     "/get?xxx=111",
+				expected: map[string][]string{"xxx": []string{"111"}},
+			},
+			{
+				path:  "/get?xxx=111",
+				query: webtest.MustParseQuery("yyy=222"),
+				expected: map[string][]string{
+					"xxx": []string{"111"},
+					"yyy": []string{"222"},
+				},
+			},
+			{
+				path:  "/get?xxx=111",
+				query: webtest.MustParseQuery("yyy=222&xxx=333"),
+				expected: map[string][]string{
+					"xxx": []string{"333", "111"},
+					"yyy": []string{"222"},
+				},
+			},
+		}
+		for i, c := range cases {
+			c := c
+			t.Run(fmt.Sprintf("case%d", i), func(t *testing.T) {
+				var options []func(*webtest.Config)
+				if c.query != nil {
+					options = append(options, webtest.WithQuery(c.query))
+				}
+				got, _, teardown := client.Do(t, "GET", c.path, options...)
+				defer teardown()
+
+				var data map[string]interface{}
+				noerror.Must(t, got.ParseJSONData(&data))
+
+				noerror.Should(t,
+					jsonequal.ShouldBeSame(
+						jsonequal.From(data["args"]),
+						jsonequal.From(c.expected),
+					),
+				)
+			})
+		}
+	})
 }

jsonequal/jsonequal.go

@@ -139,7 +139,12 @@ func defaultFail(
 	lb []byte,
 	rb []byte,
 ) error {
+	ls, rs := string(lb), string(rb)
+	if ls == rs {
+		msg := "not equal json\nleft (%[1]T):\n	%[3]s\nright (%[2]T):\n	%[4]s"
+		return fmt.Errorf(msg, left, right, ls, rs)
+	}
 	// todo : more redable expression
-	msg := "not equal json\nleft:\n	%s\nright:\n	%s"
-	return fmt.Errorf(msg, string(lb), string(rb))
+	msg := "not equal json\nleft:\n	%[3]s\nright:\n	%[4]s"
+	return fmt.Errorf(msg, left, right, ls, rs)
 }

testclient/config.go

@@ -1,11 +1,15 @@
 package testclient
 
-import "io"
+import (
+	"io"
+	"net/url"
+)
 
 // Config :
 type Config struct {
 	BasePath string
 	Body     io.Reader
+	Query    url.Values
 
 	Decorator RoundTripperDecorator
 }

testclient/recorder_client.go

@@ -50,5 +50,16 @@ func (c *RecorderClient) NewRequest(
 	config *Config,
 ) (*http.Request, error) {
 	url := internal.URLJoin(config.BasePath, path)
-	return httptest.NewRequest(method, url, config.Body), nil
+	req := httptest.NewRequest(method, url, config.Body)
+
+	if config.Query != nil {
+		q := config.Query
+		for k, vs := range req.URL.Query() {
+			for _, v := range vs {
+				q.Add(k, v)
+			}
+		}
+		req.URL.RawQuery = q.Encode()
+	}
+	return req, nil
 }

testclient/server_client.go

@@ -48,5 +48,19 @@ func (c *ServerClient) NewRequest(
 	config *Config,
 ) (*http.Request, error) {
 	url := internal.URLJoin(c.Server.URL, internal.URLJoin(config.BasePath, path))
-	return http.NewRequest(method, url, config.Body)
+	req, err := http.NewRequest(method, url, config.Body)
+	if err != nil {
+		return req, err
+	}
+
+	if config.Query != nil {
+		q := config.Query
+		for k, vs := range req.URL.Query() {
+			for _, v := range vs {
+				q.Add(k, v)
+			}
+		}
+		req.URL.RawQuery = q.Encode()
+	}
+	return req, nil
 }

util.go

@@ -0,0 +1,12 @@
+package webtest
+
+import "net/url"
+
+// MustParseQuery :
+func MustParseQuery(query string) url.Values {
+	vals, err := url.ParseQuery(query)
+	if err != nil {
+		panic(err)
+	}
+	return vals
+}