-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for Type matcher (#64)
* exploring support for type matcher * fix: add unit tests and docs * misc
- Loading branch information
1 parent
a2cf7ae
commit a3fd6aa
Showing
8 changed files
with
257 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
package match | ||
|
||
import ( | ||
"errors" | ||
"fmt" | ||
|
||
"github.com/tidwall/gjson" | ||
"github.com/tidwall/sjson" | ||
) | ||
|
||
type typeMatcher[ExpectedType any] struct { | ||
paths []string | ||
errOnMissingPath bool | ||
name string | ||
expectedType interface{} | ||
} | ||
|
||
/* | ||
Type matcher evaluates types that are passed in a snapshot | ||
It replaces any targeted path with placeholder in the form of `<Type:ExpectedType>` | ||
match.Type[string]("user.info") | ||
// or with multiple paths | ||
match.Type[float64]("user.age", "data.items") | ||
*/ | ||
func Type[ExpectedType any](paths ...string) *typeMatcher[ExpectedType] { | ||
return &typeMatcher[ExpectedType]{ | ||
paths: paths, | ||
errOnMissingPath: true, | ||
name: "Type", | ||
expectedType: *new(ExpectedType), | ||
} | ||
} | ||
|
||
// ErrOnMissingPath determines if matcher will fail in case of trying to access a json path | ||
// that doesn't exist | ||
func (t *typeMatcher[T]) ErrOnMissingPath(e bool) *typeMatcher[T] { | ||
t.errOnMissingPath = e | ||
return t | ||
} | ||
|
||
func (t typeMatcher[ExpectedType]) JSON(s []byte) ([]byte, []MatcherError) { | ||
var errs []MatcherError | ||
json := s | ||
|
||
for _, path := range t.paths { | ||
r := gjson.GetBytes(json, path) | ||
if !r.Exists() { | ||
if t.errOnMissingPath { | ||
errs = append(errs, MatcherError{ | ||
Reason: errors.New("path does not exist"), | ||
Matcher: t.name, | ||
Path: path, | ||
}) | ||
} | ||
continue | ||
} | ||
|
||
if _, ok := r.Value().(ExpectedType); !ok { | ||
errs = append(errs, MatcherError{ | ||
Reason: fmt.Errorf("expected type %T, received %T", *new(ExpectedType), r.Value()), | ||
Matcher: t.name, | ||
Path: path, | ||
}) | ||
|
||
continue | ||
} | ||
|
||
j, err := sjson.SetBytesOptions( | ||
json, | ||
path, | ||
fmt.Sprintf("<Type:%T>", r.Value()), | ||
&sjson.Options{ | ||
Optimistic: true, | ||
ReplaceInPlace: true, | ||
}, | ||
) | ||
if err != nil { | ||
errs = append(errs, MatcherError{ | ||
Reason: err, | ||
Matcher: t.name, | ||
Path: path, | ||
}) | ||
|
||
continue | ||
} | ||
|
||
json = j | ||
} | ||
|
||
return json, errs | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
package match | ||
|
||
import ( | ||
"reflect" | ||
"testing" | ||
|
||
"github.com/gkampitakis/go-snaps/internal/test" | ||
) | ||
|
||
func TestTypeMatcher(t *testing.T) { | ||
t.Run("should create a type matcher", func(t *testing.T) { | ||
p := []string{"test.1", "test.2"} | ||
tm := Type[string](p...) | ||
|
||
test.True(t, tm.errOnMissingPath) | ||
test.Equal(t, "Type", tm.name) | ||
test.Equal(t, p, tm.paths) | ||
test.Equal(t, reflect.TypeOf("").String(), reflect.TypeOf(tm.expectedType).String()) | ||
}) | ||
|
||
t.Run("should allow overriding values", func(t *testing.T) { | ||
p := []string{"test.1", "test.2"} | ||
tm := Type[string](p...) | ||
|
||
tm.ErrOnMissingPath(false) | ||
|
||
test.False(t, tm.errOnMissingPath) | ||
test.Equal(t, "Type", tm.name) | ||
test.Equal(t, p, tm.paths) | ||
test.Equal(t, reflect.TypeOf("").String(), reflect.TypeOf(tm.expectedType).String()) | ||
}) | ||
|
||
t.Run("JSON", func(t *testing.T) { | ||
j := []byte(`{ | ||
"user": { | ||
"name": "mock-user", | ||
"email": "mock-email", | ||
"age": 29 | ||
}, | ||
"date": "16/10/2022" | ||
}`) | ||
|
||
t.Run("should return error in case of missing path", func(t *testing.T) { | ||
tm := Type[string]("user.2") | ||
res, errs := tm.JSON(j) | ||
|
||
test.Equal(t, j, res) | ||
test.Equal(t, 1, len(errs)) | ||
|
||
err := errs[0] | ||
|
||
test.Equal(t, "path does not exist", err.Reason.Error()) | ||
test.Equal(t, "Type", err.Matcher) | ||
test.Equal(t, "user.2", err.Path) | ||
}) | ||
|
||
t.Run("should aggregate errors", func(t *testing.T) { | ||
tm := Type[string]("user.2", "user.3") | ||
res, errs := tm.JSON(j) | ||
|
||
test.Equal(t, j, res) | ||
test.Equal(t, 2, len(errs)) | ||
}) | ||
|
||
t.Run("should evaluate passed type and replace json", func(t *testing.T) { | ||
tm := Type[string]("user.name", "date") | ||
res, errs := tm.JSON(j) | ||
|
||
expected := `{ | ||
"user": { | ||
"name": "<Type:string>", | ||
"email": "mock-email", | ||
"age": 29 | ||
}, | ||
"date": "<Type:string>" | ||
}` | ||
|
||
test.Nil(t, errs) | ||
test.Equal(t, expected, string(res)) | ||
}) | ||
|
||
t.Run("should return error with type mismatch", func(t *testing.T) { | ||
tm := Type[int]("user.name", "user.age") | ||
_, errs := tm.JSON(j) | ||
|
||
test.Equal(t, 2, len(errs)) | ||
test.Equal(t, "expected type int, received string", errs[0].Reason.Error()) | ||
test.Equal(t, "expected type int, received float64", errs[1].Reason.Error()) | ||
}) | ||
}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters