feat: support to validate the YAML file via schema

LinuxSuRen · LinuxSuRen · commit 66dc3a748104 · 2023-04-21T04:29:20.000+08:00
diff --git a/cmd/run_test.go b/cmd/run_test.go
@@ -27,7 +27,7 @@ func TestRunSuite(t *testing.T) {
 			gock.New(urlFoo).
 				Get("/bar").
 				Reply(http.StatusOK).
-				JSON("{}")
+				File("testdata/simple-suite.yaml")
 		},
 		hasError: false,
 	}, {
diff --git a/cmd/testdata/simple-suite.yaml b/cmd/testdata/simple-suite.yaml
@@ -3,3 +3,4 @@ api: http://foo/
 items:
 - request:
     api: /bar
+  name: bar
diff --git a/go.mod b/go.mod
@@ -13,13 +13,13 @@ require (
 	golang.org/x/sync v0.1.0
 	google.golang.org/grpc v1.54.0
 	google.golang.org/protobuf v1.30.0
-	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver/v3 v3.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/ghodss/yaml v1.0.0 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
@@ -44,5 +44,6 @@ require (
 	golang.org/x/sys v0.6.0 // indirect
 	golang.org/x/text v0.8.0 // indirect
 	google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect
+	gopkg.in/yaml.v2 v2.3.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
diff --git a/go.sum b/go.sum
@@ -438,6 +438,7 @@ github.com/envoyproxy/go-control-plane v0.10.3/go.mod h1:fJJn/j26vwOu972OllsvAgJ
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/envoyproxy/protoc-gen-validate v0.6.7/go.mod h1:dyJXwwfPK2VSqiB9Klm1J6romD608Ba7Hij42vrOBCo=
 github.com/envoyproxy/protoc-gen-validate v0.9.1/go.mod h1:OKNgG7TCp5pF4d6XftA0++PMirau2/yoOwVac3AbF2w=
+github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU=
 github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
@@ -1178,6 +1179,7 @@ gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
diff --git a/pkg/testing/case.go b/pkg/testing/case.go
@@ -35,7 +35,7 @@ type Request struct {
 
 // Response is the expected response
 type Response struct {
-	StatusCode       int                    `yaml:"statusCode" json:"bodyFromFile,omitempty"`
+	StatusCode       int                    `yaml:"statusCode" json:"statusCode,omitempty"`
 	Body             string                 `yaml:"body" json:"body,omitempty"`
 	Header           map[string]string      `yaml:"header" json:"header,omitempty"`
 	BodyFieldsExpect map[string]interface{} `yaml:"bodyFieldsExpect" json:"bodyFieldsExpect,omitempty"`
diff --git a/pkg/testing/parser.go b/pkg/testing/parser.go
@@ -10,9 +10,11 @@ import (
 	"os"
 	"strings"
 
+	"github.com/ghodss/yaml"
 	"github.com/linuxsuren/api-testing/pkg/render"
 	"github.com/linuxsuren/api-testing/pkg/util"
-	"gopkg.in/yaml.v2"
+	"github.com/linuxsuren/api-testing/sample"
+	"github.com/xeipuuv/gojsonschema"
 )
 
 // Parse parses a file and returns the test suite
@@ -21,6 +23,23 @@ func Parse(configFile string) (testSuite *TestSuite, err error) {
 	if data, err = os.ReadFile(configFile); err == nil {
 		testSuite, err = ParseFromData(data)
 	}
+
+	// schema validation
+	if err == nil {
+		// convert YAML to JSON
+		var jsonData []byte
+		if jsonData, err = yaml.YAMLToJSON(data); err == nil {
+			schemaLoader := gojsonschema.NewStringLoader(sample.Schema)
+			documentLoader := gojsonschema.NewBytesLoader(jsonData)
+
+			var result *gojsonschema.Result
+			if result, err = gojsonschema.Validate(schemaLoader, documentLoader); err == nil {
+				if !result.Valid() {
+					err = fmt.Errorf("%v", result.Errors())
+				}
+			}
+		}
+	}
 	return
 }
 
diff --git a/pkg/testing/parser_test.go b/pkg/testing/parser_test.go
@@ -30,6 +30,9 @@ func TestParse(t *testing.T) {
 			},
 		}, suite.Items[0])
 	}
+
+	_, err = Parse("testdata/invalid-testcase.yaml")
+	assert.NotNil(t, err)
 }
 
 func TestRequestRender(t *testing.T) {
diff --git a/pkg/testing/testdata/invalid-testcase.yaml b/pkg/testing/testdata/invalid-testcase.yaml
@@ -0,0 +1,5 @@
+name: projects
+request:
+  api: https://foo
+expect:
+  statuscode: 200
diff --git a/sample/constants.go b/sample/constants.go
@@ -4,3 +4,6 @@ import _ "embed"
 
 //go:embed testsuite-gitlab.yaml
 var TestSuiteGitLab string
+
+//go:embed api-testing-schema.json
+var Schema string

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,9 @@ func TestParse(t *testing.T) {`
`30`	`30`	`},`
`31`	`31`	`}, suite.Items[0])`
`32`	`32`	`}`
	`33`	`+`
	`34`	`+ _, err = Parse("testdata/invalid-testcase.yaml")`
	`35`	`+ assert.NotNil(t, err)`
`33`	`36`	`}`
`34`	`37`
`35`	`38`	`func TestRequestRender(t *testing.T) {`