#jsonschema

json_schema_test_suite

Procedural Macro Attribute to run all the test cases described in JSON-Schema-Test-Suite

2 unstable releases

✓ Uses Rust 2018 edition

0.3.0 Jun 29, 2020
0.2.0 Jun 22, 2020
0.1.0 Jun 22, 2020

#44 in Procedural macros

Download history 157/week @ 2020-06-20 167/week @ 2020-06-27

75 downloads per month

MIT license

115KB
142 lines

json_schema_test_suite

ci codecov Crates.io docs.rs

The crate provides a procedural macro attribute that allow to generate all the test cases described by JSON-Schema-Test-Suite.

The main objective is to ensure that for each test a mock server is started and will be able to capture all the requests, ensuring that tests can be ran only interacting with cargo test

In order to ude the procedural macro attribute there are few assumptions that are made:

  • lazy_static dependency is added into your [dev-dependencies] section of the Cargo.toml file
  • mockito dependency is added into your [dev-dependencies] section of the Cargo.toml file
  • serde-json dependency is added into your [dev-dependencies] section of the Cargo.toml file
  • the annotated method signature should be: fn (&str, json_schema_test_suite::TestCase) -> ()

How to use

Cargo.toml

# Ensure that the following lines are present into your Cargo.toml file
[dev-dependencies]
json_schema_test_suite = "0"
# Be careful with dependencies version (using `*` version is never recommended).
# The proc-macro uses nothing fancy with the dependencies, so any version should work well :)
lazy_static = "*"
mockito = "*"
serde_json = "*"

Rust test file example

use json_schema_test_suite::{json_schema_test_suite, TestCase};

// If no tests should be ignored
#[json_schema_test_suite(
    // path separator is assumed to be `/` (regardless of the run platform)
    "path/to/JSON-Schema-Test-Suite/repository",
    // test directory (in <JSON-Schema-Test-Suite>/tests/<test_directory>)
    "draft7"
)]
// If some tests needs to be ignored, just defined them into `{ ... }` as follow
#[json_schema_test_suite(
    // path separator is assumed to be `/` (regardless of the run platform)
    "path/to/JSON-Schema-Test-Suite/repository",
    // test directory (in <JSON-Schema-Test-Suite>/tests/<test_directory>)
    "draft6",
    {   // Names, as generated by the macro, of the tests to ignore
        // NOTE: They can be regular expression as well.
        "name of the tests to ignore",
    }
)]
fn my_simple_test(
    // address of the HTTP server providing the remote files of JSON-Schema-Test-Suite.
    // The format will be: `hostname:port`.
    // This parameter is passed because by starting a mock server we might not start it
    // into `localhost:1234` as expected by JSON-Schema-Test-Suite
    server_address: &str,
    // Representation of the test case
    test_case: TestCase,
) {
    // TODO: Add here your testing logic
}

License: MIT

Dependencies

~2–2.9MB
~74K SLoC