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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
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 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"`
Photo2 Bytes `json:"photo2,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"`
// Test for "extras" support
Baz string `jsonschema_extras:"foo=bar,hello=world,foo=bar1"`
// Tests for simple enum tags
Color string `json:"color" jsonschema:"enum=red,enum=green,enum=blue"`
Rank int `json:"rank,omitempty" jsonschema:"enum=1,enum=2,enum=3"`
Multiplier float64 `json:"mult,omitempty" jsonschema:"enum=1.0,enum=1.5,enum=2.0"`
}
type CustomTime time.Time
type CustomTypeField struct {
CreatedAt CustomTime
}
type RootOneOf struct {
Field1 string `json:"field1" jsonschema:"oneof_required=group1"`
Field2 string `json:"field2" jsonschema:"oneof_required=group2"`
Field3 interface{} `json:"field3" jsonschema:"oneof_type=string;array"`
Field4 string `json:"field4" jsonschema:"oneof_required=group1"`
Field5 ChildOneOf `json:"child"`
}
type ChildOneOf struct {
Child1 string `json:"child1" jsonschema:"oneof_required=group1"`
Child2 string `json:"child2" jsonschema:"oneof_required=group2"`
Child3 interface{} `json:"child3" jsonschema:"oneof_required=group2,oneof_type=string;array"`
Child4 string `json:"child4" jsonschema:"oneof_required=group1"`
}
type Outer struct {
Inner
}
type Inner struct {
Foo string `yaml:"foo"`
}
type Bytes []byte
type TestNullable struct {
Child1 string `json:"child1" jsonschema:"nullable"`
}
func TestSchemaGeneration(t *testing.T) {
tests := []struct {
typ interface{}
reflector *Reflector
fixture string
}{
{&RootOneOf{}, &Reflector{RequiredFromJSONSchemaTags: true}, "fixtures/oneof.json"},
{&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"},
{&TestUser{}, &Reflector{DoNotReference: true}, "fixtures/no_reference.json"},
{&TestUser{}, &Reflector{FullyQualifyTypeNames: true}, "fixtures/fully_qualified.json"},
{&TestUser{}, &Reflector{DoNotReference: true, FullyQualifyTypeNames: true}, "fixtures/no_ref_qual_types.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"},
{&TestUser{}, &Reflector{DoNotReference: true, FullyQualifyTypeNames: true}, "fixtures/no_ref_qual_types.json"},
{&Outer{}, &Reflector{ExpandedStruct: true, DoNotReference: true, YAMLEmbeddedStructs: true}, "fixtures/disable_inlining_embedded.json"},
{&TestNullable{}, &Reflector{}, "fixtures/nullable.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))
})
}
}
func TestBaselineUnmarshal(t *testing.T) {
expectedJSON, err := ioutil.ReadFile("fixtures/defaults.json")
require.NoError(t, err)
reflector := &Reflector{}
actualSchema := reflector.Reflect(&TestUser{})
actualJSON, _ := json.MarshalIndent(actualSchema, "", " ")
require.Equal(t, strings.Replace(string(expectedJSON), `\/`, "/", -1), string(actualJSON))
}
|
