hypothesis-graphql

Hypothesis strategies for GraphQL schemas and queries


Keywords
hypothesis, graphql, testing
License
MIT
Install
pip install hypothesis-graphql==0.5.1

Documentation

hypothesis-graphql

Build codecov.io status for master branch Version Python versions Gitter License

Hypothesis strategies for GraphQL schemas, queries and data.

NOTE This package is experimental, some features are not supported yet.

Usage

There are two strategies for different use cases.

  1. Schema generation - hypothesis_graphql.strategies.schema()
  2. Query - hypothesis_graphql.strategies.query(schema).

Lets take this schema as an example:

type Book {
  title: String
  author: Author
}

type Author {
  name: String
  books: [Book]
}

type Query {
  getBooks: [Book]
  getAuthors: [Author]
}

Then strategies might be used in this way:

from hypothesis import given
from hypothesis_graphql import strategies as gql_st

SCHEMA = "..."  # the one above


@given(query=gql_st.query(SCHEMA))
def test_query(query):
    ...
    # This query might be generated:
    #
    # query {
    #   getBooks {
    #     title
    #   }
    # }

To restrict the set of fields in generated queries use the fields argument:

...


@given(query=gql_st.query(SCHEMA, fields=["getAuthors"]))
def test_query(query):
    # Only `getAuthors` will be generated
    ...