Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/python-jsonschema/hypothesis-jsonschema

Tools to generate test data from JSON schemata with Hypothesis
https://github.com/python-jsonschema/hypothesis-jsonschema

hypothesis json-schema property-based-testing python

Last synced: about 1 month ago
JSON representation

Tools to generate test data from JSON schemata with Hypothesis

Awesome Lists containing this project

README 

        
# hypothesis-jsonschema



A [Hypothesis](https://hypothesis.readthedocs.io) strategy for generating data

that matches some [JSON schema](https://json-schema.org/).



[Here's the PyPI page.](https://pypi.org/project/hypothesis-jsonschema/)



## API



The public API consists of just one function: `hypothesis_jsonschema.from_schema`,

which takes a JSON schema and returns a strategy for allowed JSON objects.



```python

from hypothesis import given



from hypothesis_jsonschema import from_schema



@given(from_schema({"type": "integer", "minimum": 1, "exclusiveMaximum": 10}))

def test_integers(value):

    assert isinstance(value, int)

    assert 1 <= value < 10



@given(

    from_schema(

        {"type": "string", "format": "card"},

        # Standard formats work out of the box.  Custom formats are ignored

        # by default, but you can pass custom strategies for them - e.g.

        custom_formats={"card": st.sampled_from(EXAMPLE_CARD_NUMBERS)},

    )

)

def test_card_numbers(value):

    assert isinstance(value, str)

    assert re.match(r"^\d{4} \d{4} \d{4} \d{4}$", value)



@given(from_schema({}, allow_x00=False, codec="utf-8").map(json.dumps))

def test_card_numbers(payload):

    assert isinstance(payload, str)

    assert "\0" not in payload  # use allow_x00=False to exclude null characters

    # If you want to restrict generated strings characters which are valid in

    # a specific character encoding, you can do that with the `codec=` argument.

    payload.encode(codec="utf-8")

```



For more details on property-based testing and how to use or customise

strategies, [see the Hypothesis docs](https://hypothesis.readthedocs.io/).



JSONSchema drafts 04, 05, and 07 are fully tested and working.

As of version 0.11, this includes resolving non-recursive references!



## Supported versions



`hypothesis-jsonschema` requires Python 3.6 or later.

In general, 0.x versions will require very recent versions of all dependencies

because I don't want to deal with compatibility workarounds.



`hypothesis-jsonschema` may make backwards-incompatible changes at any time

before version 1.x - that's what semver means! - but I've kept the API surface

small enough that this should be avoidable.  The main source of breaks will be

if or when schema that never really worked turn into explicit errors instead

of generating values that don't quite match.



You can [sponsor me](https://github.com/sponsors/Zac-HD) to get priority

support, roadmap input, and prioritized feature development.



## Contributing to `hypothesis-jsonschema`



We love external contributions - and try to make them both easy and fun.

You can [read more details in our contributing guide](https://github.com/Zac-HD/hypothesis-jsonschema/blob/master/CONTRIBUTING.md),

and [see everyone who has contributed on GitHub](https://github.com/Zac-HD/hypothesis-jsonschema/graphs/contributors).

Thanks, everyone!



### Changelog



Patch notes [can be found in `CHANGELOG.md`](https://github.com/Zac-HD/hypothesis-jsonschema/blob/master/CHANGELOG.md).



### Security contact information

To report a security vulnerability, please use the

[Tidelift security contact](https://tidelift.com/security).

Tidelift will coordinate the fix and disclosure.