fix: cannot read the query (#317)

Co-authored-by: rick <[email protected]>

Author: LinuxSuRen

Makefile

@@ -117,6 +117,8 @@ test-all-backend: test test-collector test-store-orm test-store-s3 test-store-gi
 test-all: test-all-backend test-ui
 test-e2e:
 	cd e2e && ./start.sh && ./start.sh compose-k8s.yaml
+fuzz:
+	cd pkg/util && go test -fuzz FuzzZeroThenDefault -fuzztime 6s
 install-precheck:
 	cp .github/pre-commit .git/hooks/pre-commit
 

cmd/run.go

@@ -354,6 +354,15 @@ func (o *runOption) runSuite(loader testing.Loader, dataContext map[string]inter
 					return
 				}
 			}
+
+			reverseRunner := runner.NewReverseHTTPRunner(suiteRunner)
+			reverseRunner.WithTestReporter(runner.NewDiscardTestReporter())
+			if _, err = reverseRunner.RunTestCase(
+				&testCase, dataContext, ctxWithTimeout); err != nil {
+				err = fmt.Errorf("got error in reverse test: %w", err)
+				return
+			}
+			suiteRunner.WithTestReporter(o.reporter)
 		}
 		dataContext[testCase.Name] = output
 	}

e2e/test-suite-common.yaml

@@ -270,7 +270,9 @@ items:
 - name: downloadExtGit
   request:
     api: |
-      {{.param.server}}/get?name=atest-store-git
+      {{.param.server}}/get
+    query:
+      name: atest-store-git
   expect:
     header:
       Content-Type: application/octet-stream

pkg/generator/curl_generator.go

@@ -52,8 +52,7 @@ func (g *curlGenerator) Generate(testSuite *testing.TestSuite, testcase *testing
 
 	queryKeys := testcase.Request.Query.Keys()
 	for _, k := range queryKeys {
-		v := testcase.Request.Query[k]
-		testcase.Request.API += k + "=" + v + "&"
+		testcase.Request.API += k + "=" + testcase.Request.Query.GetValue(k) + "&"
 	}
 
 	testcase.Request.API = strings.TrimSuffix(testcase.Request.API, "&")

pkg/generator/curl_generator_test.go

@@ -50,7 +50,7 @@ func TestCurlGenerator(t *testing.T) {
 		testCase: atest.TestCase{
 			Request: atest.Request{
 				API: fooForTest,
-				Query: map[string]string{
+				Query: map[string]interface{}{
 					"page": "1",
 					"size": "10",
 				},

pkg/runner/http.go

@@ -148,6 +148,12 @@ func (r *simpleTestCaseRunner) RunTestCase(testcase *testing.TestCase, dataConte
 		return
 	}
 
+	q := request.URL.Query()
+	for k := range testcase.Request.Query {
+		q.Add(k, testcase.Request.Query.GetValue(k))
+	}
+	request.URL.RawQuery = q.Encode()
+
 	// set headers
 	for key, val := range testcase.Request.Header {
 		request.Header.Add(key, val)

pkg/runner/http_reverse.go

@@ -0,0 +1,157 @@
+/*
+MIT License
+
+Copyright (c) 2023 API Testing Authors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package runner
+
+import (
+	"bytes"
+	"context"
+	"encoding/gob"
+	"fmt"
+
+	"github.com/linuxsuren/api-testing/pkg/testing"
+	"github.com/linuxsuren/api-testing/pkg/util"
+)
+
+type Mutator interface {
+	Render(*testing.TestCase) *testing.TestCase
+	Message() string
+}
+
+type authHeaderMissingMutator struct{}
+
+func (m *authHeaderMissingMutator) Render(testcase *testing.TestCase) (result *testing.TestCase) {
+	result = &testing.TestCase{}
+	_ = DeepCopy(testcase, result)
+	delete(result.Request.Header, util.Authorization)
+	return
+}
+
+func (m *authHeaderMissingMutator) Message() string {
+	return "Missing Authorization in header"
+}
+
+type authHeaderRandomMutator struct{}
+
+func (m *authHeaderRandomMutator) Render(testcase *testing.TestCase) (result *testing.TestCase) {
+	result = &testing.TestCase{}
+	_ = DeepCopy(testcase, result)
+	if result.Request.Header == nil {
+		result.Request.Header = make(map[string]string)
+	}
+	result.Request.Header[util.Authorization] = util.String(6)
+	return
+}
+
+func (m *authHeaderRandomMutator) Message() string {
+	return "Random Authorization in header"
+}
+
+type requiredQueryMutator struct {
+	field string
+}
+
+func (m *requiredQueryMutator) Render(testcase *testing.TestCase) (result *testing.TestCase) {
+	result = &testing.TestCase{}
+	_ = DeepCopy(testcase, result)
+	delete(result.Request.Query, m.field)
+	return
+}
+
+func (m *requiredQueryMutator) Message() string {
+	return fmt.Sprintf("Missing required query field: %q", m.field)
+}
+
+type minLengthQueryMutator struct {
+	field  string
+	length int
+}
+
+func (m *minLengthQueryMutator) Render(testcase *testing.TestCase) (result *testing.TestCase) {
+	result = &testing.TestCase{}
+	_ = DeepCopy(testcase, result)
+	if result.Request.Query != nil && m.length > 1 {
+		result.Request.Query[m.field] = util.String(m.length - 1)
+	}
+	return
+}
+
+func (m *minLengthQueryMutator) Message() string {
+	return fmt.Sprintf("Min length query field: %q", m.field)
+}
+
+func DeepCopy(src, dist interface{}) (err error) {
+	buf := bytes.Buffer{}
+	if err = gob.NewEncoder(&buf).Encode(src); err != nil {
+		return
+	}
+	return gob.NewDecoder(&buf).Decode(dist)
+}
+
+type reverseHTTPRunner struct {
+	TestCaseRunner
+}
+
+func NewReverseHTTPRunner(normal TestCaseRunner) TestCaseRunner {
+	return &reverseHTTPRunner{
+		TestCaseRunner: normal,
+	}
+}
+
+func (r *reverseHTTPRunner) RunTestCase(testcase *testing.TestCase, dataContext interface{},
+	ctx context.Context) (output interface{}, err error) {
+	// find all the mutators
+
+	var mutators []Mutator
+	if _, ok := testcase.Request.Header[util.Authorization]; ok {
+		mutators = append(mutators, &authHeaderMissingMutator{}, &authHeaderRandomMutator{})
+	}
+
+	for k := range testcase.Request.Query {
+		verifier := testcase.Request.Query.GetVerifier(k)
+		if verifier == nil {
+			continue
+		}
+
+		if verifier.Required {
+			mutators = append(mutators, &requiredQueryMutator{field: k})
+		}
+		if verifier.MinLength > 0 {
+			mutators = append(mutators, &minLengthQueryMutator{
+				field:  k,
+				length: verifier.MinLength,
+			})
+		}
+	}
+
+	for _, mutator := range mutators {
+		mutationCase := mutator.Render(testcase)
+		_, reverseErr := r.TestCaseRunner.RunTestCase(mutationCase, dataContext, ctx)
+		if reverseErr == nil {
+			err = fmt.Errorf("failed when: %q", mutator.Message())
+			return
+		}
+	}
+	return
+}

pkg/runner/http_reverse_test.go

@@ -0,0 +1,48 @@
+/*
+MIT License
+
+Copyright (c) 2023 API Testing Authors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package runner
+
+import (
+	"testing"
+
+	atest "github.com/linuxsuren/api-testing/pkg/testing"
+	"github.com/linuxsuren/api-testing/pkg/util"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAuthHeaderMutator(t *testing.T) {
+	mutator := &authHeaderMissingMutator{}
+	testcase := &atest.TestCase{
+		Request: atest.Request{
+			Header: map[string]string{
+				util.Authorization: "Basic xxyy",
+			},
+		},
+	}
+	result := mutator.Render(testcase)
+	_, ok := result.Request.Header[util.Authorization]
+	assert.False(t, ok)
+	assert.NotEmpty(t, testcase.Request.Header[util.Authorization])
+}

pkg/runner/http_test.go

@@ -80,7 +80,10 @@ func TestTestCase(t *testing.T) {
 			Request: atest.Request{
 				API:    urlFoo,
 				Header: defaultForm,
-				Body:   `{"foo":"bar"}`,
+				Query: map[string]interface{}{
+					"name": "linuxsuren",
+				},
+				Body: `{"foo":"bar"}`,
 			},
 			Expect: atest.Response{
 				StatusCode: http.StatusOK,

pkg/server/convert.go

@@ -145,7 +145,7 @@ func ToGRPCTestCase(testCase testing.TestCase) (result *TestCase) {
 	req := &Request{
 		Api:    testCase.Request.API,
 		Method: testCase.Request.Method,
-		Query:  mapToPair(testCase.Request.Query),
+		// Query:  mapToPair(testCase.Request.Query),
 		Header: mapToPair(testCase.Request.Header),
 		Form:   mapToPair(testCase.Request.Form),
 		Body:   testCase.Request.Body,
@@ -181,7 +181,7 @@ func ToNormalTestCase(in *TestCase) (result testing.TestCase) {
 		result.Request.Body = req.Body
 		result.Request.Header = pairToMap(req.Header)
 		result.Request.Form = pairToMap(req.Form)
-		result.Request.Query = pairToMap(req.Query)
+		result.Request.Query = pairToInterMap(req.Query)
 	}
 
 	if resp != nil {

pkg/server/remote_server_test.go

@@ -409,7 +409,7 @@ func TestListTestCase(t *testing.T) {
 					Header: map[string]string{
 						"key": "value",
 					},
-					Query: map[string]string{},
+					Query: map[string]interface{}{},
 					Form:  map[string]string{},
 				},
 				Expect: atesting.Response{

pkg/testing/case.go

@@ -24,7 +24,11 @@ SOFTWARE.
 
 package testing
 
-import "sort"
+import (
+	"sort"
+
+	"gopkg.in/yaml.v3"
+)
 
 // TestSuite represents a set of test cases
 type TestSuite struct {
@@ -123,7 +127,7 @@ type ConditionalVerify struct {
 	Verify    []string `yaml:"verify,omitempty" json:"verify,omitempty"`
 }
 
-type SortedKeysStringMap map[string]string
+type SortedKeysStringMap map[string]interface{}
 
 func (m SortedKeysStringMap) Keys() (keys []string) {
 	for k := range m {
@@ -132,3 +136,48 @@ func (m SortedKeysStringMap) Keys() (keys []string) {
 	sort.Strings(keys)
 	return
 }
+
+func (m SortedKeysStringMap) GetValue(key string) string {
+	val := m[key]
+
+	switch o := any(val).(type) {
+	case string:
+		return val.(string)
+	case map[string]interface{}:
+		verifier := convertToVerifier(o)
+		return verifier.Value
+	}
+
+	return ""
+}
+
+func (m SortedKeysStringMap) GetVerifier(key string) (verifier *Verifier) {
+	val := m[key]
+
+	switch o := any(val).(type) {
+	case map[string]interface{}:
+		verifier = convertToVerifier(o)
+	}
+
+	return
+}
+
+func convertToVerifier(data map[string]interface{}) (verifier *Verifier) {
+	verifier = &Verifier{}
+
+	if data, err := yaml.Marshal(data); err == nil {
+		if err = yaml.Unmarshal(data, verifier); err != nil {
+			verifier = nil
+		}
+	}
+	return
+}
+
+type Verifier struct {
+	Value     string `yaml:"value,omitempty" json:"value,omitempty"`
+	Required  bool   `yaml:"required,omitempty" json:"required,omitempty"`
+	Max       int    `yaml:"max"`
+	Min       int    `yaml:"min"`
+	MaxLength int    `yaml:"maxLength"`
+	MinLength int    `yaml:"minLength"`
+}