Skip to main content

Hypothesis strategies for GraphQL schemas and queries

Project description

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 a few strategies for different use cases.

  1. Schema generation - hypothesis_graphql.strategies.schemas()

  2. Query - hypothesis_graphql.strategies.queries(schema).

  3. Mutation - hypothesis_graphql.strategies.mutations(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]
}

type Mutation {
  addBook(title: String!, author: String!): Book!
  addAuthor(name: String!): 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(gql_st.queries(SCHEMA))
def test_query(query):
    ...
    # This query might be generated:
    #
    # query {
    #   getBooks {
    #     title
    #   }
    # }


@given(gql_st.mutations(SCHEMA))
def test_mutation(mutation):
    ...
    # This mutation might be generated:
    #
    # mutation {
    #   addBook(title: "H4Z\u7869", author: "\u00d2"){
    #     title
    #   }
    # }

Customization

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

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

It is also possible to generate custom scalars. For example, Date:

from hypothesis import strategies as st, given
from hypothesis_graphql import strategies as gql_st, nodes

SCHEMA = """
scalar Date

type Query {
  getByDate(created: Date!): Int
}
"""


@given(
    gql_st.queries(
        SCHEMA,
        custom_scalars={
            # Standard scalars work out of the box, for custom ones you need
            # to pass custom strategies that generate proper AST nodes
            "Date": st.dates().map(nodes.String)
        },
    )
)
def test_query(query):
    # Example:
    #
    #  { getByDate(created: "2000-01-01") }
    #
    ...

The hypothesis_graphql.nodes module includes a few helpers to generate various node types:

  • String -> graphql.StringValueNode

  • Float -> graphql.FloatValueNode

  • Int -> graphql.IntValueNode

  • Object -> graphql.ObjectValueNode

  • List -> graphql.ListValueNode

  • Boolean -> graphql.BooleanValueNode

  • Enum -> graphql.EnumValueNode

  • Null -> graphql.NullValueNode (a constant, not a function)

They exist because classes like graphql.StringValueNode can’t be directly used in map calls due to kwarg-only arguments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hypothesis-graphql-0.8.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

hypothesis_graphql-0.8.1-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file hypothesis-graphql-0.8.1.tar.gz.

File metadata

  • Download URL: hypothesis-graphql-0.8.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for hypothesis-graphql-0.8.1.tar.gz
Algorithm Hash digest
SHA256 2cf996531268268c2e0f62dd9589344fd04ed936fd81e918ef655d2db8aa6737
MD5 aec77a3ea527e644f6d9c66981ead967
BLAKE2b-256 1c6f1a71657b5d44933e33e29aff9bc9f340450463b9185e87b2379c0216df31

See more details on using hashes here.

File details

Details for the file hypothesis_graphql-0.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for hypothesis_graphql-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3e35686bb9812743c68b0b476ee0988a211d09e4b35c48a8a0fe24a073e9fa6
MD5 c3b66e068c20081d272646f13d78fa7c
BLAKE2b-256 bfbadff1365bab99b138ec16257c5559efab1438e00f3e080db7654bfdb6764c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page