A language agnostic test suite for the JSON Schema specifications
Clone or download

README.md

JSON Schema Test Suite Build Status

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.

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

Drafts 03, 04, 06, and 07 should have full coverage, with drafts 06 and 07 being considered current and actively supported. Bug fixes will be made as needed for draft-04 as it is still the most widely used, while draft-03 is long since deprecated.

If you see anything missing from the current supported drafts, or incorrect on any draft still accepting bug fixes, please file an issue or submit a PR.

Who Uses the Test Suite

This suite is being used by:

Coffeescript

C++

Dart

Elixir

Erlang

Go

Haskell

Java

JavaScript

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

PHP

Python

Ruby

Rust

Swift

Clojure

PostgreSQL

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 && npm test or tox && npm test. They will be run automatically by Travis CI as well.