Added match query string and url/path regex (#9)

* Added MatchQuery

* Added match url and path with regex

Author: royhq

match.go

@@ -8,6 +8,7 @@ import (
 	"net/http"
 	"net/url"
 	"reflect"
+	"regexp"
 	"strings"
 )
 
@@ -29,6 +30,18 @@ func Path(path string) URLMatcher {
 	}
 }
 
+// URLRegex will match http request when the regex pattern specified match to the request URL.
+func URLRegex(pattern string) URLMatcher {
+	regex := regexp.MustCompile(pattern)
+	return func(url *url.URL) bool { return regex.MatchString(url.String()) }
+}
+
+// PathRegex will match http request when the regex pattern specified match to the request URL path part.
+func PathRegex(pattern string) URLMatcher {
+	regex := regexp.MustCompile(pattern)
+	return func(url *url.URL) bool { return regex.MatchString(url.Path) }
+}
+
 func defaultMatchers(method string, url URLMatcher) []requestMatcherFunc {
 	return []requestMatcherFunc{
 		methodMatcher(method),
@@ -61,6 +74,15 @@ func MatchHeader(key, value string) StubMatcherRule {
 	return MatchRequest(matcher)
 }
 
+// MatchQuery sets a rule to match the http request with the given query string value.
+func MatchQuery(key, value string) StubMatcherRule {
+	matcher := RequestMatcherFunc(func(r *http.Request) bool {
+		return r.URL.Query().Get(key) == value
+	})
+
+	return MatchRequest(matcher)
+}
+
 // MatchNoBody sets a rule to match the http request with empty body.
 func MatchNoBody() StubMatcherRule {
 	matcher := RequestMatcherFunc(func(r *http.Request) bool {

match_test.go

@@ -87,6 +87,49 @@ func TestPath(t *testing.T) {
 	}
 }
 
+func TestURLRegex(t *testing.T) {
+	t.Parallel()
+
+	reqURL := "/api/users?page=1&size=20"
+	httpReq := httptest.NewRequest(http.MethodGet, reqURL, http.NoBody)
+
+	regexValues := []string{
+		`\/api\/users\?page=1\&size=20`,
+		`^\/api\/users\?page=1\&size=20$`,
+		`^\/api\/users\?page=\d+\&size=\d+$`,
+		`^\/api\/[a-zA-Z]+\?page=\d+\&size=\d+$`,
+	}
+
+	for _, r := range regexValues {
+		t.Run(r, func(t *testing.T) {
+			t.Parallel()
+			matcher := mockaso.URLRegex(r)
+			assert.True(t, matcher(httpReq.URL))
+		})
+	}
+}
+
+func TestPathRegex(t *testing.T) {
+	t.Parallel()
+
+	reqURL := "/api/users?page=1&size=20"
+	httpReq := httptest.NewRequest(http.MethodGet, reqURL, http.NoBody)
+
+	regexValues := []string{
+		`\/api\/users`,
+		`^\/api\/users$`,
+		`^\/api\/[a-zA-Z]+`,
+	}
+
+	for _, r := range regexValues {
+		t.Run(r, func(t *testing.T) {
+			t.Parallel()
+			matcher := mockaso.PathRegex(r)
+			assert.True(t, matcher(httpReq.URL))
+		})
+	}
+}
+
 func TestMatchRequest(t *testing.T) {
 	t.Parallel()
 
@@ -173,6 +216,40 @@ func TestMatchHeader(t *testing.T) {
 	})
 }
 
+func TestMatchQuery(t *testing.T) {
+	t.Parallel()
+
+	server := mockaso.MustStartNewServer(mockaso.WithLogger(t))
+	t.Cleanup(server.MustShutdown)
+
+	const path = "/test/match-query"
+
+	server.Stub(http.MethodGet, mockaso.Path(path)).
+		Match(mockaso.MatchQuery("name", "john")).
+		Respond(matchedRequestRules()...)
+
+	t.Run("should return the specified stub when query match", func(t *testing.T) {
+		t.Parallel()
+
+		httpReq, _ := http.NewRequest(http.MethodGet, path+"?name=john", http.NoBody)
+		httpResp, err := server.Client().Do(httpReq)
+		require.NoError(t, err)
+
+		assert.Equal(t, http.StatusOK, httpResp.StatusCode)
+		assertBodyString(t, "matched request", httpResp)
+	})
+
+	t.Run("should return no match response when query does not match", func(t *testing.T) {
+		t.Parallel()
+
+		httpReq, _ := http.NewRequest(http.MethodGet, path+"?name=rick", http.NoBody)
+		httpResp, err := server.Client().Do(httpReq)
+		require.NoError(t, err)
+
+		assertNotMatchedResponse(t, httpReq, httpResp)
+	})
+}
+
 func TestMatchNoBody(t *testing.T) {
 	t.Parallel()