forked from alecthomas/jsonschema
-
Notifications
You must be signed in to change notification settings - Fork 0
/
reflect_test.go
143 lines (115 loc) · 4.31 KB
/
reflect_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
package jsonschema
import (
"encoding/json"
"io/ioutil"
"net"
"net/url"
"path/filepath"
"reflect"
"strings"
"testing"
"time"
"github.com/stretchr/testify/require"
)
type GrandfatherType struct {
FamilyName string `json:"family_name" jsonschema:"required"`
}
type SomeBaseType struct {
SomeBaseProperty int `json:"some_base_property"`
SomeBasePropertyYaml int `yaml:"some_base_property_yaml"`
// The jsonschema required tag is nonsensical for private and ignored properties.
// Their presence here tests that the fields *will not* be required in the output
// schema, even if they are tagged required.
somePrivateBaseProperty string `json:"i_am_private" jsonschema:"required"`
SomeIgnoredBaseProperty string `json:"-" jsonschema:"required"`
SomeSchemaIgnoredProperty string `jsonschema:"-,required"`
Grandfather GrandfatherType `json:"grand"`
SomeUntaggedBaseProperty bool `jsonschema:"required"`
someUnexportedUntaggedBaseProperty bool
}
type MapType map[string]interface{}
type nonExported struct {
PublicNonExported int
privateNonExported int
}
type ProtoEnum int32
func (ProtoEnum) EnumDescriptor() ([]byte, []int) { return []byte(nil), []int{0} }
const (
Unset ProtoEnum = iota
Great
)
type ABCEnumVal string
func (ABCEnumVal) JSONSchemaEnums() []interface{} {
return []interface{}{"a", "b", "c"}
}
type DEFEnumPtr string
func (*DEFEnumPtr) JSONSchemaEnums() []interface{} {
return []interface{}{"d", "e", "f"}
}
type TestUser struct {
SomeBaseType
nonExported
MapType
ID int `json:"id" jsonschema:"required"`
Name string `json:"name" jsonschema:"required,minLength=1,maxLength=20,pattern=.*,description=this is a property,title=the name,example=joe,example=lucy,default=alex"`
Friends []int `json:"friends,omitempty" jsonschema_description:"list of IDs, omitted when empty"`
Tags map[string]interface{} `json:"tags,omitempty"`
TestFlag bool
IgnoredCounter int `json:"-"`
// Tests for RFC draft-wright-json-schema-validation-00, section 7.3
BirthDate time.Time `json:"birth_date,omitempty"`
Website url.URL `json:"website,omitempty"`
IPAddress net.IP `json:"network_address,omitempty"`
// Tests for RFC draft-wright-json-schema-hyperschema-00, section 4
Photo []byte `json:"photo,omitempty" jsonschema:"required"`
// Tests for jsonpb enum support
Feeling ProtoEnum `json:"feeling,omitempty"`
Age int `json:"age" jsonschema:"minimum=18,maximum=120,exclusiveMaximum=true,exclusiveMinimum=true"`
Email string `json:"email" jsonschema:"format=email"`
TestEnumVal ABCEnumVal `json:"test_enum_val,omitempty"`
TestEnumValPtr *ABCEnumVal `json:"test_enum_val_ptr,omitempty"`
TestEnumPtr DEFEnumPtr `json:"test_enum_ptr,omitempty"`
TestEnumPtrPtr *DEFEnumPtr `json:"test_enum_ptr_ptr,omitempty"`
}
type CustomTime time.Time
type CustomTypeField struct {
CreatedAt CustomTime
}
func TestSchemaGeneration(t *testing.T) {
tests := []struct {
typ interface{}
reflector *Reflector
fixture string
}{
{&TestUser{}, &Reflector{}, "fixtures/defaults.json"},
{&TestUser{}, &Reflector{AllowAdditionalProperties: true}, "fixtures/allow_additional_props.json"},
{&TestUser{}, &Reflector{RequiredFromJSONSchemaTags: true}, "fixtures/required_from_jsontags.json"},
{&TestUser{}, &Reflector{ExpandedStruct: true}, "fixtures/defaults_expanded_toplevel.json"},
{&TestUser{}, &Reflector{IgnoredTypes: []interface{}{GrandfatherType{}}}, "fixtures/ignore_type.json"},
{&CustomTypeField{}, &Reflector{
TypeMapper: func(i reflect.Type) *Type {
if i == reflect.TypeOf(CustomTime{}) {
return &Type{
Type: "string",
Format: "date-time",
}
}
return nil
},
}, "fixtures/custom_type.json"},
}
for _, tt := range tests {
name := strings.TrimSuffix(filepath.Base(tt.fixture), ".json")
t.Run(name, func(t *testing.T) {
f, err := ioutil.ReadFile(tt.fixture)
require.NoError(t, err)
actualSchema := tt.reflector.Reflect(tt.typ)
expectedSchema := &Schema{}
err = json.Unmarshal(f, expectedSchema)
require.NoError(t, err)
expectedJSON, _ := json.MarshalIndent(expectedSchema, "", " ")
actualJSON, _ := json.MarshalIndent(actualSchema, "", " ")
require.Equal(t, string(expectedJSON), string(actualJSON))
})
}
}