@atomiq/json-schema-test-suite

JSON Schema Test Suite

** This is the node branch of JSON Schema Test Suite.**

Node-specific support is maintained on GitHub on the node branch. See NODE-README.md for more information on using this package.

This repository contains a set of JSON objects that implementors of JSON Schema validation libraries can use to test their validators.

It is meant to be language agnostic and should require only a JSON parser.

The conversion of the JSON objects into tests within your test framework of choice is still the job of the validator implementor.

Structure of a Test

If you're going to use this suite, you need to know how tests are laid out. The tests are contained in the tests directory at the root of this repository.

Inside that directory is a subdirectory for each draft or version of the schema. We'll use draft3 as an example.

If you look inside the draft directory, there are a number of .json files, which logically group a set of test cases together. Often the grouping is by property under test, but not always, especially within optional test files (discussed below).

Inside each .json file is a single array containing objects. It's easiest to illustrate the structure of these with an example:

    {
        "description": "the description of the test case",
        "schema": {"the schema that should" : "be validated against"},
        "tests": [
            {
                "description": "a specific test of a valid instance",
                "data": "the instance",
                "valid": true
            },
            {
                "description": "another specific test this time, invalid",
                "data": 15,
                "valid": false
            }
        ]
    }

So a description, a schema, and some tests, where tests is an array containing one or more objects with descriptions, data, and a boolean indicating whether they should be valid or invalid.

Coverage

Draft 3 and 4 should have full coverage. If you see anything missing or think there is a useful test missing, please send a pull request or open an issue.

Who Uses the Test Suite

This suite is being used by:

Coffeescript

• jsck

Dart

• json_schema

Erlang

• jesse

Go

• gojsonschema
• validate-json

Haskell

• aeson-schema
• hjsonschema

Java

• json-schema-validator

JavaScript

• json-schema-benchmark
• direct-schema
• is-my-json-valid
• jassi
• JaySchema
• json-schema-valid
• Jsonary
• jsonschema
• request-validator
• skeemas
• tv4
• z-schema
• jsen
• ajv

Node.js

The JSON Schema Test Suite is also available as an npm package. Node-specific support is maintained on the node branch. See NODE-README.md for more information.

.NET

• Newtonsoft.Json.Schema

PHP

• json-schema

Python

• jsonschema

Ruby

• json-schema

Rust

• valico

Swift

• JSONSchema

If you use it as well, please fork and send a pull request adding yourself to the list :).

Contributing

If you see something missing or incorrect, a pull request is most welcome!

There are some sanity checks in place for testing the test suite. You can run them with bin/jsonschema_suite check. They will be run automatically by Travis CI as well.