Support additional (extra) keywords beyond those specified in the `Schema` type. The current behavior is additional keywords are dropped. To follow up: - There are similar util functions in `mcp/util.go` which don't seem to be used. Maybe we should move it to `internal/util` instead of `jsonchema/util.go` package? - The method `[Un]MarshalJSON` is only on `pointer receiver`, is this intended? (that means it will only work if we [un]marshal pointer to the `Schema` instance) - The fix is using the [un]marshalStructWithMap from `mcp/util.go` and there are requirements for the function to work properly but these are not strictly checked e.g. need `json:"-"` tag for the Extra field. Fixes #69.
186 lines
4 KiB
Go
186 lines
4 KiB
Go
// Copyright 2025 The Go MCP SDK Authors. All rights reserved.
|
|
// Use of this source code is governed by an MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package jsonschema
|
|
|
|
import (
|
|
"encoding/json"
|
|
"hash/maphash"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
)
|
|
|
|
func TestEqual(t *testing.T) {
|
|
for _, tt := range []struct {
|
|
x1, x2 any
|
|
want bool
|
|
}{
|
|
{0, 1, false},
|
|
{1, 1.0, true},
|
|
{nil, 0, false},
|
|
{"0", 0, false},
|
|
{2.5, 2.5, true},
|
|
{[]int{1, 2}, []float64{1.0, 2.0}, true},
|
|
{[]int(nil), []int{}, false},
|
|
{[]map[string]any(nil), []map[string]any{}, false},
|
|
{
|
|
map[string]any{"a": 1, "b": 2.0},
|
|
map[string]any{"a": 1.0, "b": 2},
|
|
true,
|
|
},
|
|
} {
|
|
check := func(x1, x2 any, want bool) {
|
|
t.Helper()
|
|
if got := Equal(x1, x2); got != want {
|
|
t.Errorf("jsonEqual(%#v, %#v) = %t, want %t", x1, x2, got, want)
|
|
}
|
|
}
|
|
check(tt.x1, tt.x1, true)
|
|
check(tt.x2, tt.x2, true)
|
|
check(tt.x1, tt.x2, tt.want)
|
|
check(tt.x2, tt.x1, tt.want)
|
|
}
|
|
}
|
|
|
|
func TestJSONType(t *testing.T) {
|
|
for _, tt := range []struct {
|
|
val string
|
|
want string
|
|
}{
|
|
{`null`, "null"},
|
|
{`0`, "integer"},
|
|
{`0.0`, "integer"},
|
|
{`1e2`, "integer"},
|
|
{`0.1`, "number"},
|
|
{`""`, "string"},
|
|
{`true`, "boolean"},
|
|
{`[]`, "array"},
|
|
{`{}`, "object"},
|
|
} {
|
|
var val any
|
|
if err := json.Unmarshal([]byte(tt.val), &val); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
got, ok := jsonType(reflect.ValueOf(val))
|
|
if !ok {
|
|
t.Fatalf("jsonType failed on %q", tt.val)
|
|
}
|
|
if got != tt.want {
|
|
t.Errorf("%s: got %q, want %q", tt.val, got, tt.want)
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
func TestHash(t *testing.T) {
|
|
x := map[string]any{
|
|
"s": []any{1, "foo", nil, true},
|
|
"f": 2.5,
|
|
"m": map[string]any{
|
|
"n": json.Number("123.456"),
|
|
"schema": &Schema{Type: "integer", UniqueItems: true},
|
|
},
|
|
"c": 1.2 + 3.4i,
|
|
"n": nil,
|
|
}
|
|
|
|
seed := maphash.MakeSeed()
|
|
|
|
hash := func(x any) uint64 {
|
|
var h maphash.Hash
|
|
h.SetSeed(seed)
|
|
hashValue(&h, reflect.ValueOf(x))
|
|
return h.Sum64()
|
|
}
|
|
|
|
want := hash(x)
|
|
// Run several times to verify consistency.
|
|
for range 10 {
|
|
if got := hash(x); got != want {
|
|
t.Errorf("hash values differ: %d vs. %d", got, want)
|
|
}
|
|
}
|
|
|
|
// Check mathematically equal values.
|
|
nums := []any{
|
|
5,
|
|
uint(5),
|
|
5.0,
|
|
json.Number("5"),
|
|
json.Number("5.00"),
|
|
}
|
|
for i, n := range nums {
|
|
if i == 0 {
|
|
want = hash(n)
|
|
} else if got := hash(n); got != want {
|
|
t.Errorf("hashes differ between %v (%[1]T) and %v (%[2]T)", nums[0], n)
|
|
}
|
|
}
|
|
|
|
// Check that a bare JSON `null` is OK.
|
|
var null any
|
|
if err := json.Unmarshal([]byte(`null`), &null); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
_ = hash(null)
|
|
}
|
|
|
|
func TestMarshalStructWithMap(t *testing.T) {
|
|
type S struct {
|
|
A int
|
|
B string `json:"b,omitempty"`
|
|
u bool
|
|
M map[string]any `json:"-"`
|
|
}
|
|
t.Run("basic", func(t *testing.T) {
|
|
s := S{A: 1, B: "two", M: map[string]any{"!@#": true}}
|
|
got, err := marshalStructWithMap(&s, "M")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
want := `{"A":1,"b":"two","!@#":true}`
|
|
if g := string(got); g != want {
|
|
t.Errorf("\ngot %s\nwant %s", g, want)
|
|
}
|
|
|
|
var un S
|
|
if err := unmarshalStructWithMap(got, &un, "M"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if diff := cmp.Diff(s, un, cmpopts.IgnoreUnexported(S{})); diff != "" {
|
|
t.Errorf("mismatch (-want, +got):\n%s", diff)
|
|
}
|
|
})
|
|
t.Run("duplicate", func(t *testing.T) {
|
|
s := S{A: 1, B: "two", M: map[string]any{"b": "dup"}}
|
|
_, err := marshalStructWithMap(&s, "M")
|
|
if err == nil || !strings.Contains(err.Error(), "duplicate") {
|
|
t.Errorf("got %v, want error with 'duplicate'", err)
|
|
}
|
|
})
|
|
t.Run("embedded", func(t *testing.T) {
|
|
type Embedded struct {
|
|
A int
|
|
B int
|
|
Extra map[string]any `json:"-"`
|
|
}
|
|
type S struct {
|
|
C int
|
|
Embedded
|
|
}
|
|
s := S{C: 1, Embedded: Embedded{A: 2, B: 3, Extra: map[string]any{"d": 4, "e": 5}}}
|
|
got, err := marshalStructWithMap(&s, "Extra")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
want := `{"C":1,"A":2,"B":3,"d":4,"e":5}`
|
|
if g := string(got); g != want {
|
|
t.Errorf("got %v, want %v", g, want)
|
|
}
|
|
})
|
|
}
|