-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathschema_test.go
252 lines (207 loc) · 9.93 KB
/
schema_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
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
// This file is part of Arduino Lint.
//
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of Arduino Lint.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.
package schema
import (
"regexp"
"testing"
"github.com/arduino/arduino-lint/internal/project/general"
"github.com/arduino/arduino-lint/internal/rule/schema/testdata"
"github.com/arduino/go-properties-orderedmap"
"github.com/ory/jsonschema/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
var validMap = map[string]string{
"property1": "foo",
"property2": "bar",
"property3": "baz",
"dependentProperty": "asdf",
"dependencyProperty": "zxcv",
}
var validPropertiesMap = properties.NewFromHashmap(validMap)
var validSchemaWithReferences Schema
func init() {
validSchemaWithReferences = Compile(
"valid-schema-with-references.json",
[]string{
"referenced-schema-1.json",
"referenced-schema-2.json",
},
testdata.Asset,
)
}
func TestCompile(t *testing.T) {
assert.Panics(t, func() {
Compile("valid-schema-with-references.json", []string{"nonexistent.json"}, testdata.Asset)
})
assert.Panics(t, func() {
Compile("valid-schema-with-references.json", []string{"schema-without-id.json"}, testdata.Asset)
})
assert.Panics(t, func() {
Compile("invalid-schema.json", []string{}, testdata.Asset)
})
assert.Panics(t, func() {
Compile("valid-schema-with-references.json", []string{}, testdata.Asset)
})
assert.NotPanics(t, func() {
Compile("valid-schema.json", []string{}, testdata.Asset)
})
assert.NotPanics(t, func() {
Compile(
"valid-schema-with-references.json",
[]string{
"referenced-schema-1.json",
"referenced-schema-2.json",
},
testdata.Asset,
)
})
}
func TestValidate(t *testing.T) {
schemaObject := Compile("valid-schema.json", []string{}, testdata.Asset)
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), schemaObject)
assert.Nil(t, validationResult.Result)
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.Nil(t, validationResult.Result)
propertiesMap.Set("property1", "a")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), schemaObject)
assert.Equal(t, "#/property1", validationResult.Result.InstancePtr)
assert.Equal(t, "#/properties/property1/minLength", validationResult.Result.SchemaPtr)
}
func TestRequiredPropertyMissing(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, RequiredPropertyMissing("property1", validationResult))
propertiesMap.Remove("property1")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, RequiredPropertyMissing("property1", validationResult))
}
func TestPropertyPatternMismatch(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, PropertyPatternMismatch("property2", validationResult))
propertiesMap.Set("property2", "fOo")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, PropertyPatternMismatch("property2", validationResult))
assert.False(t, PropertyPatternMismatch("property1", validationResult))
}
func TestPropertyLessThanMinLength(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, PropertyLessThanMinLength("property1", validationResult))
propertiesMap.Set("property1", "a")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, PropertyLessThanMinLength("property1", validationResult))
}
func TestPropertyGreaterThanMaxLength(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, PropertyGreaterThanMaxLength("property1", validationResult))
propertiesMap.Set("property1", "12345")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, PropertyGreaterThanMaxLength("property1", validationResult))
}
func TestPropertyEnumMismatch(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, PropertyEnumMismatch("property3", validationResult))
propertiesMap.Set("property3", "invalid")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, PropertyEnumMismatch("property3", validationResult))
}
func TestPropertyDependenciesMissing(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, PropertyDependenciesMissing("dependentProperty", validationResult))
propertiesMap.Remove("dependencyProperty")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, PropertyDependenciesMissing("dependentProperty", validationResult))
}
func TestMisspelledOptionalPropertyFound(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, MisspelledOptionalPropertyFound(validationResult))
propertiesMap.Set("porperties", "foo")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, MisspelledOptionalPropertyFound(validationResult))
}
func TestValidationErrorMatch(t *testing.T) {
propertiesMap := properties.NewFromHashmap(validMap)
validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, ValidationErrorMatch("", "", "", "", validationResult))
propertiesMap.Set("property2", "fOo")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, ValidationErrorMatch("nomatch", "nomatch", "nomatch", "nomatch", validationResult))
assert.False(t, ValidationErrorMatch("^#/property2$", "nomatch", "nomatch", "nomatch", validationResult))
assert.False(t, ValidationErrorMatch("^#/property2$", "/pattern$", "nomatch", "nomatch", validationResult))
assert.False(t, ValidationErrorMatch("^#/property2$", "/pattern$", `^\^\[a-z\]\+\$$`, "nomatch", validationResult))
assert.True(t, ValidationErrorMatch("^#/property2$", "/pattern$", `^"\^\[a-z\]\+\$"$`, "", validationResult))
assert.True(t, ValidationErrorMatch("", "", "", "", validationResult))
propertiesMap.Set("property3", "bAz")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.True(t, ValidationErrorMatch("^#/property3$", "/pattern$", "", "", validationResult), "Match pointer below logic inversion keyword")
propertiesMap = properties.NewFromHashmap(validMap)
propertiesMap.Remove("property1")
validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
assert.False(t, ValidationErrorMatch("nomatch", "nomatch", "nomatch", "nomatch", validationResult))
assert.True(t, ValidationErrorMatch("", "", "", "^#/property1$", validationResult))
}
func Test_loadReferencedSchema(t *testing.T) {
compiler := jsonschema.NewCompiler()
assert.Panics(
t,
func() {
loadReferencedSchema(compiler, "nonexistent.json", testdata.Asset)
},
)
assert.Error(t, loadReferencedSchema(compiler, "schema-without-id.json", testdata.Asset))
assert.Nil(t, loadReferencedSchema(compiler, "referenced-schema-2.json", testdata.Asset))
}
func Test_schemaID(t *testing.T) {
_, err := schemaID("schema-without-id.json", testdata.Asset)
assert.NotNil(t, err)
id, err := schemaID("valid-schema.json", testdata.Asset)
require.Nil(t, err)
assert.Equal(t, "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/rule/schema/testdata/input/valid-schema.json", id)
}
func Test_validationErrorSchemaPointerValue(t *testing.T) {
validationError := ValidationResult{
Result: &jsonschema.ValidationError{
SchemaURL: "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/rule/schema/testdata/referenced-schema-1.json",
SchemaPtr: "#/definitions/patternObject/pattern",
},
dataLoader: testdata.Asset,
}
schemaPointerValueInterface := validationErrorSchemaPointerValue(validationError)
schemaPointerValue, ok := schemaPointerValueInterface.(string)
assert.True(t, ok)
assert.Equal(t, "^[a-z]+$", schemaPointerValue)
}
func Test_validationErrorContextMatch(t *testing.T) {
validationError := jsonschema.ValidationError{
Context: nil,
}
assert.True(t, validationErrorContextMatch(regexp.MustCompile(".*"), &validationError))
assert.False(t, validationErrorContextMatch(regexp.MustCompile("foo"), &validationError))
validationError.Context = &jsonschema.ValidationErrorContextRequired{
Missing: []string{
"#/foo",
"#/bar",
},
}
assert.True(t, validationErrorContextMatch(regexp.MustCompile("^#/bar$"), &validationError))
assert.False(t, validationErrorContextMatch(regexp.MustCompile("nomatch"), &validationError))
}