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 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
require "test_helper"
require "json_schema"
describe JsonSchema::Parser do
after do
JsonSchema.configuration.reset!
end
it "parses the basic attributes of a schema" do
schema = parse
assert_nil schema.id
assert_equal "Example API", schema.title
assert_equal "An example API.", schema.description
assert_equal ["object"], schema.type
assert_equal "/", schema.uri
end
it "parses subschemas" do
schema = parse.definitions["app"]
assert_nil schema.reference
assert_equal "App", schema.title
assert_equal "An app.", schema.description
assert_equal "schemata/app", schema.id
assert_equal ["object"], schema.type
assert_equal "/schemata/app", schema.uri
refute_nil schema.parent
end
it "parses sub-subschemas" do
schema = parse.definitions["app"].definitions["name"]
assert_nil schema.reference
assert_equal "hello-world", schema.default
assert_equal "unique name of app", schema.description
assert_equal ["string"], schema.type
assert_equal "/schemata/app", schema.uri
refute_nil schema.parent
end
it "parses references" do
schema = parse.properties["app"]
refute_nil schema.reference
assert_nil schema.reference.uri
assert_equal "#/definitions/app", schema.reference.pointer
refute_nil schema.parent
end
it "parses enum validation" do
schema = parse.definitions["app"].definitions["visibility"]
assert_equal ["private", "public"], schema.enum
end
it "parses array validations" do
schema = parse.definitions["app"].definitions["flags"]
assert_equal(/^[a-z][a-z\-]*[a-z]$/, schema.items.pattern)
assert_equal 1, schema.min_items
assert_equal 10, schema.max_items
assert_equal true, schema.unique_items
end
it "parses array items tuple validation" do
pointer("#/definitions/app/definitions/flags").merge!(
"items" => [
{ "enum" => ["bamboo", "cedar"] },
{ "enum" => ["http", "https"] }
]
)
schema = parse.definitions["app"].definitions["flags"]
assert_equal ["bamboo", "cedar"], schema.items[0].enum
assert_equal ["http", "https"], schema.items[1].enum
end
it "parses array additionalItems object validation as boolean" do
pointer("#/definitions/app/definitions/flags").merge!(
"additionalItems" => false
)
schema = parse.definitions["app"].definitions["flags"]
assert_equal false, schema.additional_items
end
it "parses array additionalItems object validation as schema" do
pointer("#/definitions/app/definitions/flags").merge!(
"additionalItems" => {
"type" => "boolean"
}
)
schema = parse.definitions["app"].definitions["flags"].additional_items
assert_equal ["boolean"], schema.type
end
it "parses integer validations" do
schema = parse.definitions["app"].definitions["id"]
assert_equal 0, schema.min
assert_equal true, schema.min_exclusive
assert_equal 10000, schema.max
assert_equal false, schema.max_exclusive
assert_equal 1, schema.multiple_of
end
it "parses number validations" do
schema = parse.definitions["app"].definitions["cost"]
assert_equal 0.0, schema.min
assert_equal false, schema.min_exclusive
assert_equal 1000.0, schema.max
assert_equal true, schema.max_exclusive
assert_equal 0.01, schema.multiple_of
end
it "parses the basic set of object validations" do
schema = parse.definitions["app"]
assert_equal 10, schema.max_properties
assert_equal 1, schema.min_properties
assert_equal ["name"], schema.required
end
it "parses the additionalProperties object validation as boolean" do
pointer("#/definitions/app").merge!(
"additionalProperties" => false
)
schema = parse.definitions["app"]
assert_equal false, schema.additional_properties
end
it "parses the additionalProperties object validation as schema" do
pointer("#/definitions/app").merge!(
"additionalProperties" => {
"type" => "boolean"
}
)
schema = parse.definitions["app"].additional_properties
assert_equal ["boolean"], schema.type
end
it "parses the dependencies object validation" do
schema = parse.definitions["app"]
assert_equal ["ssl"], schema.dependencies["production"]
assert_equal 20.0, schema.dependencies["ssl"].properties["cost"].min
end
it "parses the patternProperties object validation" do
schema = parse.definitions["app"].definitions["config_vars"]
property = schema.pattern_properties.first
assert_equal(/^\w+$/, property[0])
assert_equal ["null", "string"], property[1].type
end
it "parses the strictProperties object validation" do
pointer("#/definitions/app").merge!(
"strictProperties" => true
)
schema = parse.definitions["app"]
assert_equal true, schema.strict_properties
end
# couldn't think of any non-contrived examples to work with here
it "parses the basic set of schema validations" do
schema = parse.definitions["app"].definitions["contrived"]
assert_equal 2, schema.all_of.count
assert_equal 2, schema.one_of.count
assert schema.not
end
it "parses the anyOf schema validation" do
schema = parse.definitions["app"].definitions["identity"]
assert_equal 2, schema.any_of.count
assert_equal "/schemata/app#/definitions/id", schema.any_of[0].reference.to_s
assert_equal "/schemata/app#/definitions/name", schema.any_of[1].reference.to_s
end
it "parses basic set of string validations" do
schema = parse.definitions["app"].definitions["name"]
assert_equal 30, schema.max_length
assert_equal 3, schema.min_length
assert_equal(/^[a-z][a-z0-9-]{3,30}$/, schema.pattern)
end
it "parses hypermedia links" do
pointer("#/definitions/app").merge!(
"links" => [
"description" => "Create a new app.",
"encType" => "application/x-www-form-urlencoded",
"href" => "/apps",
"method" => "POST",
"rel" => "create",
"mediaType" => "application/json",
"schema" => {
"properties" => {
"name" => {
"$ref" => "#/definitions/app/definitions/name"
},
}
},
"targetSchema" => {
"$ref" => "#/definitions/app"
}
]
)
schema = parse.definitions["app"]
link = schema.links[0]
assert_equal schema, link.parent
assert_equal "links/0", link.fragment
assert_equal "#/definitions/app/links/0", link.pointer
assert_equal "Create a new app.", link.description
assert_equal "application/x-www-form-urlencoded", link.enc_type
assert_equal "/apps", link.href
assert_equal :post, link.method
assert_equal "create", link.rel
assert_equal "application/json", link.media_type
assert_equal "#/definitions/app/definitions/name",
link.schema.properties["name"].reference.pointer
end
it "parses hypermedia media" do
pointer("#/definitions/app/media").merge!(
"binaryEncoding" => "base64",
"type" => "image/png"
)
schema = parse.definitions["app"]
assert_equal "base64", schema.media.binary_encoding
assert_equal "image/png", schema.media.type
end
it "parses hypermedia pathStart" do
pointer("#/definitions/app").merge!(
"pathStart" => "/v2"
)
schema = parse.definitions["app"]
assert_equal "/v2", schema.path_start
end
it "parses hypermedia readOnly" do
pointer("#/definitions/app").merge!(
"readOnly" => true
)
schema = parse.definitions["app"]
assert_equal true, schema.read_only
end
it "builds appropriate JSON Pointers" do
schema = parse.definitions["app"].definitions["name"]
assert_equal "#/definitions/app/definitions/name", schema.pointer
end
it "errors on non-string ids" do
schema_sample["id"] = 4
refute parse
assert_includes error_messages,
%{4 is not a valid "id", must be a string.}
assert_includes error_types, :invalid_type
end
it "errors on non-string titles" do
schema_sample["title"] = 4
refute parse
assert_includes error_messages,
%{4 is not a valid "title", must be a string.}
assert_includes error_types, :invalid_type
end
it "errors on non-string descriptions" do
schema_sample["description"] = 4
refute parse
assert_includes error_messages,
%{4 is not a valid "description", must be a string.}
assert_includes error_types, :invalid_type
end
it "errors on non-array and non-string types" do
schema_sample["type"] = 4
refute parse
assert_includes error_messages,
%{4 is not a valid "type", must be a array/string.}
assert_includes error_types, :invalid_type
end
it "errors on unknown types" do
schema_sample["type"] = ["float", "double"]
refute parse
assert_includes error_messages, %{Unknown types: double, float.}
assert_includes error_types, :unknown_type
end
it "errors on unknown formats" do
schema_sample["format"] = "obscure-thing"
refute parse
assert_includes error_messages, '"obscure-thing" is not a valid format, ' \
'must be one of date, date-time, email, ' \
'hostname, ipv4, ipv6, regex, uri, ' \
'uri-reference, uuid.'
assert_includes error_types, :unknown_format
end
it "passes for an invalid regex when not asked to check" do
schema_sample["pattern"] = "\\Ameow"
assert parse
end
#it "errors for an invalid regex when asked to check" do
# require 'ecma-re-validator'
# JsonSchema.configure do |c|
# c.validate_regex_with = :'ecma-re-validator'
# end
# schema_sample["pattern"] = "\\Ameow"
# refute parse
# assert_includes error_messages, '"\\\\Ameow" is not an ECMA-262 regular expression.'
# assert_includes error_types, :regex_failed
#end
it "parses custom formats" do
JsonSchema.configure do |c|
c.register_format 'the-answer', ->(data) { data.to_i == 42 }
end
schema_sample["format"] = "the-answer"
assert parse
end
it "rejects bad formats even when there are custom formats defined" do
JsonSchema.configure do |c|
c.register_format "the-answer", ->(data) { data.to_i == 42 }
end
schema_sample["format"] = "not-a-format"
refute parse
assert_includes error_messages, '"not-a-format" is not a valid format, ' \
'must be one of date, date-time, email, ' \
'hostname, ipv4, ipv6, regex, uri, ' \
'uri-reference, uuid, the-answer.'
assert_includes error_types, :unknown_format
end
it "raises an aggregate error with parse!" do
schema_sample["id"] = 4
parser = JsonSchema::Parser.new
# don't bother checking the particulars of the error here because we have
# other tests for that above
assert_raises JsonSchema::AggregateError do
parser.parse!(schema_sample)
end
end
def error_messages
@parser.errors.map { |e| e.message }
end
def error_types
@parser.errors.map { |e| e.type }
end
def parse
@parser = JsonSchema::Parser.new
@parser.parse(schema_sample)
end
def pointer(path)
JsonPointer.evaluate(schema_sample, path)
end
def schema_sample
@schema_sample ||= DataScaffold.schema_sample
end
end
|