Merge pull request #102 from SimonBaeumer/add-json-assertion

Add json and xml assertion

Author: SimonBaeumer

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v1.3.0
+
+ - Added `xml` assertion to `stdout` and `stderr`
+ - Added `json` assertin to `stdout` and `stderr`
+
 # v1.2.2
 
  - Rename windows binary `commander-windows-386` to `commander-windows-386.exe`

README.md

@@ -97,6 +97,10 @@ tests:
             line-count: 1 # Assert amount of lines
             lines: # Assert specific lines
                 1: "/bin/sh: 1: invalid: not found"
+            json:
+                object.attr: hello # Make assertions on json objects
+            xml:
+                "//book//auhtor": Steven King # Make assertions on xml documents
         exit-code: 127
 
     it has configs:

cmd/commander/commander.go

@@ -65,6 +65,10 @@ func createTestCommand() cli.Command {
 			},
 		},
 		Action: func(c *cli.Context) error {
+			if c.Bool("verbose") {
+				log.SetOutput(os.Stdout)
+			}
+
 			return app.TestCommand(c.Args().First(), c.Args().Get(1), app.NewAddContextFromCli(c))
 		},
 	}

commander_unix.yaml

@@ -9,7 +9,10 @@ tests:
 
   it should execute tests:
     command: ./commander test ./integration/unix/commander_test.yaml
-    stdout: ✓ it should exit with error code
+    stdout:
+      contains:
+        - ✓ it should exit with error code
+      line-count: 15
     exit-code: 0
 
   it should assert that commander will fail:

go.mod

@@ -1,9 +1,13 @@
 module github.com/SimonBaeumer/commander
 
 require (
+	github.com/antchfx/xmlquery v1.1.0
+	github.com/antchfx/xpath v1.1.0 // indirect
 	github.com/logrusorgru/aurora v0.0.0-20181002194514-a7b3b318ed4e
 	github.com/pmezard/go-difflib v1.0.0
 	github.com/stretchr/testify v1.3.0
+	github.com/tidwall/gjson v1.3.2
 	github.com/urfave/cli v1.20.0
+	golang.org/x/net v0.0.0-20191014212845-da9a3fd4c582 // indirect
 	gopkg.in/yaml.v2 v2.2.2
 )

go.sum

@@ -1,3 +1,9 @@
+github.com/antchfx/jsonquery v1.0.0 h1:1Yhk496SrCoY6fJkFZqpXEqbwOw5sFtLns9la4NoK3I=
+github.com/antchfx/jsonquery v1.0.0/go.mod h1:h7950pvPrUZzJIflNqsELgDQovTpPNa0rAHf8NwjegY=
+github.com/antchfx/xmlquery v1.1.0 h1:vj0kZ1y3Q6my4AV+a9xbWrMYzubw+84zuiKgvfV8vb8=
+github.com/antchfx/xmlquery v1.1.0/go.mod h1:/+CnyD/DzHRnv2eRxrVbieRU/FIF6N0C+7oTtyUtCKk=
+github.com/antchfx/xpath v1.1.0 h1:mJTvYpiHvxNQRD4Lbfin/FodHVCHh2a5KrOFr4ZxMOI=
+github.com/antchfx/xpath v1.1.0/go.mod h1:Yee4kTMuNiPYJ7nSNorELQMr1J33uOpXDMByNYhvtNk=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/logrusorgru/aurora v0.0.0-20181002194514-a7b3b318ed4e h1:9MlwzLdW7QSDrhDjFlsEYmxpFyIoXmYRon3dt0io31k=
@@ -7,8 +13,20 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/tidwall/gjson v1.3.2 h1:+7p3qQFaH3fOMXAJSrdZwGKcOO/lYdGS0HqGhPqDdTI=
+github.com/tidwall/gjson v1.3.2/go.mod h1:P256ACg0Mn+j1RXIDXoss50DeIABTYK1PULOJHhxOls=
+github.com/tidwall/match v1.0.1 h1:PnKP62LPNxHKTwvHHZZzdOAOCtsJTjo6dZLCwpKm5xc=
+github.com/tidwall/match v1.0.1/go.mod h1:LujAq0jyVjBy028G1WhWfIzbpQfMO8bBZ6Tyb0+pL9E=
+github.com/tidwall/pretty v1.0.0 h1:HsD+QiTn7sK6flMKIvNmpqz1qrpP3Ps6jOKIKMooyg4=
+github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
 github.com/urfave/cli v1.20.0 h1:fDqGv3UG/4jbVl/QkFwEdddtEDjh/5Ov6X+0B/3bPaw=
 github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/net v0.0.0-20191014212845-da9a3fd4c582 h1:p9xBe/w/OzkeYVKm234g55gMdD1nSIooTir5kV11kfA=
+golang.org/x/net v0.0.0-20191014212845-da9a3fd4c582/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

integration/unix/_fixtures/book.json

@@ -0,0 +1,12 @@
+{
+  "books": [
+    {
+      "author": "J. R. R. Tolkien",
+      "title": "Lord of the Rings"
+    },
+    {
+      "author": "Joanne K. Rowling",
+      "title": "Harry Potter"
+    }
+  ]
+}

integration/unix/_fixtures/book.xml

@@ -0,0 +1,10 @@
+<books>
+    <book>
+        <author>J. R. R. Tolkien</author>
+        <title>Lord of the Rngs</title>
+    </book>
+    <book>
+        <author>Joanne K. Rowling</author>
+        <title>Harry Potter</title>
+    </book>
+</books>

integration/unix/commander_test.yaml

@@ -43,4 +43,18 @@ tests:
     command: echo lorem ipsum
     stdout:
       not-contains:
-        - not contains
+        - not contains
+
+  it should assert json:
+    command: cat ./integration/unix/_fixtures/book.json
+    stdout:
+      json:
+        books.0.author: J. R. R. Tolkien
+        books.1.author: Joanne K. Rowling
+
+  it should assert xml:
+    command: cat ./integration/unix/_fixtures/book.xml
+    stdout:
+      xml:
+        /books/0/author: J. R. R. Tokien
+        /books/1/author: Joanne K. Rowling

pkg/matcher/matcher.go

@@ -2,7 +2,10 @@ package matcher
 
 import (
 	"fmt"
+	"github.com/antchfx/xmlquery"
 	"github.com/pmezard/go-difflib/difflib"
+	"github.com/tidwall/gjson"
+	"log"
 	"strings"
 )
 
@@ -15,6 +18,8 @@ const (
 	Equal = "equal"
 	// Not contains matcher type
 	NotContains = "notcontains"
+	JSON        = "json"
+	XML         = "xml"
 )
 
 // NewMatcher creates a new matcher by type
@@ -28,6 +33,10 @@ func NewMatcher(matcher string) Matcher {
 		return EqualMatcher{}
 	case NotContains:
 		return NotContainsMatcher{}
+	case JSON:
+		return JSONMatcher{}
+	case XML:
+		return XMLMatcher{}
 	default:
 		panic(fmt.Sprintf("Validator '%s' does not exist!", matcher))
 	}
@@ -51,6 +60,7 @@ type TextMatcher struct {
 // Match matches both texts
 func (m TextMatcher) Match(got interface{}, expected interface{}) MatcherResult {
 	result := true
+
 	if got != expected {
 		result = false
 	}
@@ -150,3 +160,83 @@ to not contain
 		Diff:    diff,
 	}
 }
+
+type JSONMatcher struct {
+}
+
+func (m JSONMatcher) Match(got interface{}, expected interface{}) MatcherResult {
+	result := MatcherResult{
+		Success: true,
+		Diff:    "",
+	}
+
+	json := expected.(map[string]string)
+	for q, e := range json {
+		r := gjson.Get(got.(string), q)
+		if r.Value() == nil {
+			result.Success = false
+			result.Diff = fmt.Sprintf(`Query "%s" did not match a path`, q)
+			break
+		}
+
+		if fmt.Sprintf("%v", r.Value()) != e {
+			result.Success = false
+			result.Diff = fmt.Sprintf(`Expected json path "%s" with result
+
+%s
+
+to be equal to
+
+%s`, q, e, r.Value())
+			break
+		}
+	}
+
+	return result
+}
+
+type XMLMatcher struct {
+}
+
+func (m XMLMatcher) Match(got interface{}, expected interface{}) MatcherResult {
+	result := MatcherResult{
+		Success: true,
+		Diff:    "",
+	}
+
+	xml := expected.(map[string]string)
+	for q, e := range xml {
+		doc, err := xmlquery.Parse(strings.NewReader(got.(string)))
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		node, err := xmlquery.Query(doc, q)
+		if err != nil {
+		    return MatcherResult{
+		        Success: false,
+		        Diff: fmt.Sprintf("Error occured: %s", err),
+            }
+		}
+
+		if node == nil {
+            return MatcherResult{
+                Success: false,
+                Diff:    fmt.Sprintf(`Query "%s" did not match a path`, q),
+            }
+        }
+
+        if node.InnerText() != e {
+            result.Success = false
+            result.Diff = fmt.Sprintf(`Expected xml path "%s" with result
+
+%s
+
+to be equal to
+
+%s`, q, e, node.InnerText())
+        }
+    }
+
+	return result
+}