feat: provide the query parameter via swagger (#339)

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

Author: LinuxSuRen

.gitpod.yml

@@ -1,7 +1,7 @@
 
 tasks:
   - init: make init-env install-precheck
-    before: IMG_TOOL=docker GOPROXY= make build-ext copy-ext build-image
+    before: IMG_TOOL=docker GOPROXY= make build-image
     command: cd console/atest-ui/ && npm i
 
 ports:

pkg/apispec/fake.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package apispec
 
 type fakeAPISpec struct {

pkg/apispec/fake_test.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package apispec_test
 
 import (

pkg/apispec/swagger.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package apispec
 
 import (
@@ -9,14 +25,30 @@ import (
 )
 
 type Swagger struct {
-	Swagger string                           `json:"swagger"`
-	Paths   map[string]map[string]SwaggerAPI `json:"paths"`
-	Info    SwaggerInfo                      `json:"info"`
+	Swagger string `json:"swagger"`
+	// Paths includes all the API requests.
+	// The keys is the HTTP request method which as lower-case, for example: get, post.
+	Paths map[string]map[string]SwaggerAPI `json:"paths"`
+	Info  SwaggerInfo                      `json:"info"`
 }
 
 type SwaggerAPI struct {
-	OperationId string `json:"operationId"`
-	Summary     string `json:"summary"`
+	OperationId string      `json:"operationId"`
+	Parameters  []Parameter `json:"parameters"`
+	Summary     string      `json:"summary"`
+}
+
+type Parameter struct {
+	Name string `json:"name"`
+	// In represents the parameter type, supported values: query, path
+	In       string `json:"in"`
+	Required bool   `json:"required"`
+	Schema   Schema `json:"schema"`
+}
+
+type Schema struct {
+	Type   string `json:"type"`
+	Format string `json:"format"`
 }
 
 type SwaggerInfo struct {

pkg/apispec/swagger_test.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package apispec_test
 
 import (

pkg/runner/http.go

@@ -228,13 +228,23 @@ func (r *simpleTestCaseRunner) GetSuggestedAPIs(suite *testing.TestSuite, api st
 		result = []*testing.TestCase{}
 		for api, item := range swaggerAPI.Paths {
 			for method, oper := range item {
-				result = append(result, &testing.TestCase{
+				testcase := &testing.TestCase{
 					Name: oper.OperationId,
 					Request: testing.Request{
 						API:    api,
 						Method: strings.ToUpper(method),
+						Query:  make(testing.SortedKeysStringMap),
 					},
-				})
+				}
+
+				for _, param := range oper.Parameters {
+					switch param.In {
+					case "query":
+						// TODO should have a better way to provide the initial value
+						testcase.Request.Query[param.Name] = "todo"
+					}
+				}
+				result = append(result, testcase)
 			}
 		}
 	}

pkg/runner/testdata/swagger.json

@@ -9,7 +9,26 @@
         "/api/v1/users": {
             "get": {
                 "summary": "summary",
-                "operationId": "getUsers"
+                "operationId": "getUsers",
+                "parameters": [
+                    {
+                        "name": "text",
+                        "in": "query",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    {
+                        "name": "count",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int32"
+                        }
+                    }
+                ]
             },
             "post": {
                 "summary": "summary",