add unit tests

LinuxSuRen · LinuxSuRen · commit a53c59323176 · 2023-03-05T11:22:05.000+08:00
diff --git a/.github/workflows/coverage-report.yaml b/.github/workflows/coverage-report.yaml
@@ -0,0 +1,23 @@
+name: Coverage Report
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  TestAndReport:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.18.x
+      - uses: actions/checkout@v3.0.0
+      - name: Test
+        run: |
+          go test ./... -coverprofile coverage.out
+      - name: Report
+        env:
+          CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        run: |
+          bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r coverage.out --force-coverage-parser go
diff --git a/Makefile b/Makefile
@@ -4,3 +4,5 @@ build:
 
 copy: build
 	cp bin/atest /usr/local/bin/
+test:
+	go test ./...
diff --git a/README.md b/README.md
@@ -1,15 +1,19 @@
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3f16717cd6f841118006f12c346e9341)](https://www.codacy.com/gh/LinuxSuRen/api-testing/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=LinuxSuRen/api-testing&amp;utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/5022a74d146f487581821fd1c3435437)](https://www.codacy.com/gh/LinuxSuRen/api-testing/dashboard?utm_source=github.com&utm_medium=referral&utm_content=LinuxSuRen/api-testing&utm_campaign=Badge_Coverage)
+![GitHub All Releases](https://img.shields.io/github/downloads/linuxsuren/api-testing/total)
+
 This is a API testing tool.
 
 ## Feature
-* Response Body fields equation check
-* Response Body [eval](https://expr.medv.io/)
-* Output reference between TestCase
+*  Response Body fields equation check
+*  Response Body [eval](https://expr.medv.io/)
+*  Output reference between TestCase
 
 ## Template
 The following fields are templated with [sprig](http://masterminds.github.io/sprig/):
 
-* API
-* Request Body
+*  API
+*  Request Body
 
 ## Limit
-* Only support to parse the response body when it's a map
+*  Only support to parse the response body when it's a map
diff --git a/cmd/init.go b/cmd/init.go
@@ -11,6 +11,7 @@ type initOption struct {
 	waitResource  string
 }
 
+// CreateInitCommand returns the init command
 func CreateInitCommand() (cmd *cobra.Command) {
 	opt := &initOption{}
 	cmd = &cobra.Command{
diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -38,3 +38,11 @@ func Test_setRelativeDir(t *testing.T) {
 		})
 	}
 }
+
+func TestCreateRunCommand(t *testing.T) {
+	cmd := CreateRunCommand()
+	assert.Equal(t, "run", cmd.Use)
+
+	init := CreateInitCommand()
+	assert.Equal(t, "init", init.Use)
+}
diff --git a/cmd/run.go b/cmd/run.go
@@ -13,6 +13,7 @@ type runOption struct {
 	pattern string
 }
 
+// CreateRunCommand returns the run command
 func CreateRunCommand() (cmd *cobra.Command) {
 	opt := &runOption{}
 	cmd = &cobra.Command{
diff --git a/go.mod b/go.mod
@@ -16,6 +16,8 @@ require (
 	github.com/antonmedv/expr v1.12.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/uuid v1.1.1 // indirect
+	github.com/h2non/gock v1.2.0 // indirect
+	github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
 	github.com/huandu/xstrings v1.3.3 // indirect
 	github.com/imdario/mergo v0.3.11 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
diff --git a/go.sum b/go.sum
@@ -14,6 +14,10 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/h2non/gock v1.2.0 h1:K6ol8rfrRkUOefooBC8elXoaNGYkpp7y2qcxGG6BzUE=
+github.com/h2non/gock v1.2.0/go.mod h1:tNhoxHYW2W42cYkYb1WqzdbYIieALC99kpYr7rH/BQk=
+github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
+github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
 github.com/huandu/xstrings v1.3.3 h1:/Gcsuc1x8JVbJ9/rlye4xZnVAbEkGauT8lbebqcQws4=
 github.com/huandu/xstrings v1.3.3/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
 github.com/imdario/mergo v0.3.11 h1:3tnifQM4i+fbajXKBHXWEH+KvNHqojZ778UH75j3bGA=
@@ -31,6 +35,7 @@ github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMK
 github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
 github.com/mitchellh/reflectwalk v1.0.0 h1:9D+8oIskB4VJBN5SFlmc27fSlIBZaov1Wpk/IfikLNY=
 github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
+github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
diff --git a/pkg/runner/doc.go b/pkg/runner/doc.go
@@ -0,0 +1,2 @@
+// Package runner responsible for excute the test case
+package runner
diff --git a/pkg/runner/simple.go b/pkg/runner/simple.go
@@ -19,6 +19,7 @@ import (
 	unstructured "github.com/linuxsuren/unstructured/pkg"
 )
 
+// RunTestCase runs the test case
 func RunTestCase(testcase *testing.TestCase, ctx interface{}) (output interface{}, err error) {
 	fmt.Printf("start to run: '%s'\n", testcase.Name)
 	if err = doPrepare(testcase); err != nil {
@@ -140,7 +141,7 @@ func RunTestCase(testcase *testing.TestCase, ctx interface{}) (output interface{
 		}
 
 		if !result.(bool) {
-			err = fmt.Errorf("faild to verify")
+			err = fmt.Errorf("faild to verify: %s", verify)
 			break
 		}
 	}
diff --git a/pkg/runner/simple_test.go b/pkg/runner/simple_test.go
@@ -0,0 +1,63 @@
+package runner
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/h2non/gock"
+	atest "github.com/linuxsuren/api-testing/pkg/testing"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestTestCase(t *testing.T) {
+	tests := []struct {
+		name     string
+		testCase *atest.TestCase
+		ctx      interface{}
+		prepare  func()
+		verify   func(t *testing.T, output interface{}, err error)
+	}{{
+		name: "normal",
+		testCase: &atest.TestCase{
+			Request: atest.Request{
+				API: "http://localhost/foo",
+				Header: map[string]string{
+					"key": "value",
+				},
+				Body: `{"foo":"bar"}`,
+			},
+			Expect: atest.Response{
+				StatusCode: http.StatusOK,
+				BodyFieldsExpect: map[string]string{
+					"name": "linuxsuren",
+				},
+				Header: map[string]string{
+					"type": "generic",
+				},
+				Verify: []string{
+					`name == "linuxsuren"`,
+				},
+			},
+		},
+		prepare: func() {
+			gock.New("http://localhost").
+				Get("/foo").
+				MatchHeader("key", "value").
+				Reply(http.StatusOK).
+				SetHeader("type", "generic").
+				File("testdata/generic_response.json")
+		},
+		verify: func(t *testing.T, output interface{}, err error) {
+			assert.Nil(t, err)
+			assert.Equal(t, map[string]interface{}{"name": "linuxsuren"}, output)
+		},
+	}}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			defer gock.Clean()
+			tt.prepare()
+			output, err := RunTestCase(tt.testCase, tt.ctx)
+			tt.verify(t, output, err)
+		})
+	}
+}
diff --git a/pkg/runner/testdata/generic_response.json b/pkg/runner/testdata/generic_response.json
@@ -0,0 +1,3 @@
+{
+    "name": "linuxsuren"
+}
diff --git a/pkg/testing/case.go b/pkg/testing/case.go
@@ -1,10 +1,12 @@
 package testing
 
+// TestSuite represents a set of test cases
 type TestSuite struct {
 	Name  string     `yaml:"name"`
 	Items []TestCase `yaml:"items"`
 }
 
+// TestCase represents a test case
 type TestCase struct {
 	Name    string
 	Group   string
@@ -14,10 +16,12 @@ type TestCase struct {
 	Clean   Clean    `yaml:"clean"`
 }
 
+// Prepare does the prepare work
 type Prepare struct {
 	Kubernetes []string `yaml:"kubernetes"`
 }
 
+// Request represents a HTTP request
 type Request struct {
 	API          string            `yaml:"api"`
 	Method       string            `yaml:"method"`
@@ -27,6 +31,7 @@ type Request struct {
 	BodyFromFile string            `yaml:"bodyFromFile"`
 }
 
+// Response is the expected response
 type Response struct {
 	StatusCode       int               `yaml:"statusCode"`
 	Body             string            `yaml:"body"`
@@ -35,6 +40,7 @@ type Response struct {
 	Verify           []string          `yaml:"verify"`
 }
 
+// Clean represents the clean work after testing
 type Clean struct {
 	CleanPrepare bool `yaml:"cleanPrepare"`
 }
diff --git a/pkg/testing/doc.go b/pkg/testing/doc.go
@@ -0,0 +1,2 @@
+// Package testing provide the test case functions
+package testing
diff --git a/pkg/testing/parser.go b/pkg/testing/parser.go
@@ -3,65 +3,28 @@ package testing
 import (
 	"bytes"
 	"html/template"
-	"io/ioutil"
 	"os"
+	"strings"
 
 	"github.com/Masterminds/sprig/v3"
 	"gopkg.in/yaml.v2"
 )
 
+// Parse parses a file and returns the test suite
 func Parse(configFile string) (testSuite *TestSuite, err error) {
 	var data []byte
-	if data, err = ioutil.ReadFile(configFile); err != nil {
-		return
-	}
-
-	testSuite = &TestSuite{}
-	if err = yaml.Unmarshal(data, testSuite); err != nil {
-		return
+	if data, err = os.ReadFile(configFile); err == nil {
+		testSuite = &TestSuite{}
+		err = yaml.Unmarshal(data, testSuite)
 	}
-
-	// for i, testCase := range testSuite.Items {
-	// 	// template the API
-	// 	var tpl *template.Template
-	// 	if tpl, err = template.New("base").Funcs(sprig.FuncMap()).Parse(testCase.Request.API); err != nil {
-	// 		return
-	// 	}
-	// 	buf := new(bytes.Buffer)
-	// 	if err = tpl.Execute(buf, os.Environ()); err != nil {
-	// 		return
-	// 	} else {
-	// 		testCase.Request.API = buf.String()
-	// 	}
-
-	// 	// read body from file
-	// 	if testCase.Request.BodyFromFile != "" {
-	// 		if data, err = os.ReadFile(testCase.Request.BodyFromFile); err != nil {
-	// 			return
-	// 		}
-	// 		testCase.Request.Body = string(data)
-	// 	}
-
-	// 	// template the body
-	// 	if tpl, err = template.New("base").Funcs(sprig.FuncMap()).Parse(testCase.Request.Body); err != nil {
-	// 		return
-	// 	}
-	// 	buf = new(bytes.Buffer)
-	// 	if err = tpl.Execute(buf, os.Environ()); err != nil {
-	// 		return
-	// 	} else {
-	// 		testCase.Request.Body = buf.String()
-	// 	}
-
-	// 	testSuite.Items[i] = testCase
-	// }
 	return
 }
 
+// Render injects the template based context
 func (r *Request) Render(ctx interface{}) (err error) {
 	// template the API
 	var tpl *template.Template
-	if tpl, err = template.New("base").Funcs(sprig.FuncMap()).Parse(r.API); err != nil {
+	if tpl, err = template.New("api").Funcs(sprig.FuncMap()).Parse(r.API); err != nil {
 		return
 	}
 	buf := new(bytes.Buffer)
@@ -77,18 +40,15 @@ func (r *Request) Render(ctx interface{}) (err error) {
 		if data, err = os.ReadFile(r.BodyFromFile); err != nil {
 			return
 		}
-		r.Body = string(data)
+		r.Body = strings.TrimSpace(string(data))
 	}
 
 	// template the body
-	if tpl, err = template.New("base").Funcs(sprig.FuncMap()).Parse(r.Body); err != nil {
-		return
-	}
-	buf = new(bytes.Buffer)
-	if err = tpl.Execute(buf, ctx); err != nil {
-		return
-	} else {
-		r.Body = buf.String()
+	if tpl, err = template.New("body").Funcs(sprig.FuncMap()).Parse(r.Body); err == nil {
+		buf = new(bytes.Buffer)
+		if err = tpl.Execute(buf, ctx); err == nil {
+			r.Body = buf.String()
+		}
 	}
 	return
 }
diff --git a/pkg/testing/parser_test.go b/pkg/testing/parser_test.go
diff --git a/pkg/testing/testdata/generic_body.json b/pkg/testing/testdata/generic_body.json
diff --git a/sample/testsuite-gitlab.yaml b/sample/testsuite-gitlab.yaml

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ type initOption struct {`
`11`	`11`	`waitResource string`
`12`	`12`	`}`
`13`	`13`
	`14`	`+// CreateInitCommand returns the init command`
`14`	`15`	`func CreateInitCommand() (cmd *cobra.Command) {`
`15`	`16`	`opt := &initOption{}`
`16`	`17`	`cmd = &cobra.Command{`
Original file line number	Diff line number	Diff line change
`@@ -38,3 +38,11 @@ func Test_setRelativeDir(t *testing.T) {`
`38`	`38`	`})`
`39`	`39`	`}`
`40`	`40`	`}`
	`41`	`+`
	`42`	`+func TestCreateRunCommand(t *testing.T) {`
	`43`	`+ cmd := CreateRunCommand()`
	`44`	`+ assert.Equal(t, "run", cmd.Use)`
	`45`	`+`
	`46`	`+ init := CreateInitCommand()`
	`47`	`+ assert.Equal(t, "init", init.Use)`
	`48`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ type runOption struct {`
`13`	`13`	`pattern string`
`14`	`14`	`}`
`15`	`15`
	`16`	`+// CreateRunCommand returns the run command`
`16`	`17`	`func CreateRunCommand() (cmd *cobra.Command) {`
`17`	`18`	`opt := &runOption{}`
`18`	`19`	`cmd = &cobra.Command{`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package runner responsible for excute the test case`
	`2`	`+package runner`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ import (`
`19`	`19`	`unstructured "github.com/linuxsuren/unstructured/pkg"`
`20`	`20`	`)`
`21`	`21`
	`22`	`+// RunTestCase runs the test case`
`22`	`23`	`func RunTestCase(testcase *testing.TestCase, ctx interface{}) (output interface{}, err error) {`
`23`	`24`	`fmt.Printf("start to run: '%s'\n", testcase.Name)`
`24`	`25`	`if err = doPrepare(testcase); err != nil {`
`@@ -140,7 +141,7 @@ func RunTestCase(testcase *testing.TestCase, ctx interface{}) (output interface{`
`140`	`141`	`}`
`141`	`142`
`142`	`143`	`if !result.(bool) {`
`143`		`- err = fmt.Errorf("faild to verify")`
	`144`	`+ err = fmt.Errorf("faild to verify: %s", verify)`
`144`	`145`	`break`
`145`	`146`	`}`
`146`	`147`	`}`