update comments

This commit is contained in:
Wlad Meixner 2019-02-12 01:26:50 +01:00
parent e66225b8e3
commit 1310fcfc0b

View File

@ -9,6 +9,7 @@ import (
"github.com/sergi/go-diff/diffmatchpatch"
)
// CompareJSONDecode decodes a JSON string into a provided interface and then back to a json string. If the output json string does not match the compact version of the input string a error is returned
func CompareJSONDecode(j string, v interface{}) error {
bytes, errCompact := CompactJSON(j)
if errCompact != nil {
@ -26,6 +27,7 @@ func CompareJSONDecode(j string, v interface{}) error {
return DiffStrings(old, new)
}
// CompareStructToJSON compares Marshaled interface to a JSON string and returns an error if they do not match
func CompareStructToJSON(v interface{}, j string) error {
// Remove all extra spaces from json string
bytes, errCompact := CompactJSON(j)
@ -43,6 +45,7 @@ func CompareStructToJSON(v interface{}, j string) error {
return DiffStrings(old, new)
}
// DiffStrings prints a nice compare between strings. Error is returned if strings are not equal
func DiffStrings(s1, s2 string) error {
if s1 != s2 {
fmt.Println("String do not match!")
@ -62,6 +65,7 @@ func DiffStrings(s1, s2 string) error {
return nil
}
// CompactJSON removes all whitespaces between json keys and values that is not required
func CompactJSON(j string) ([]byte, error) {
buffer := new(bytes.Buffer)
@ -74,3 +78,5 @@ func CompactJSON(j string) ([]byte, error) {
return bytes, nil
}
// BridgeFromEnv creates a bridge from the config data stored in env. This is primarily designed for automated tests