mirror of
https://github.com/graphql-python/graphene-django.git
synced 2024-11-13 05:07:02 +03:00
5cee41407c
* Added GraphQLTransactionTestCase - Adds support for testing code that is executed within a transaction Reference: https://docs.djangoproject.com/en/3.1/topics/testing/tools/#django.test.TransactionTestCase ``` For instance, you cannot test that a block of code is executing within a transaction, as is required when using select_for_update(). In those cases, you should use TransactionTestCase. ``` * Update testing.py * Update testing.py * Fixed formatting. * Updated docs. * Updated test. * Update testing.rst
155 lines
4.2 KiB
ReStructuredText
155 lines
4.2 KiB
ReStructuredText
Testing API calls with django
|
|
=============================
|
|
|
|
Using unittest
|
|
--------------
|
|
|
|
If you want to unittest your API calls derive your test case from the class `GraphQLTestCase`.
|
|
|
|
Your endpoint is set through the `GRAPHQL_URL` attribute on `GraphQLTestCase`. The default endpoint is `GRAPHQL_URL = "/graphql/"`.
|
|
|
|
Usage:
|
|
|
|
.. code:: python
|
|
|
|
import json
|
|
|
|
from graphene_django.utils.testing import GraphQLTestCase
|
|
|
|
class MyFancyTestCase(GraphQLTestCase):
|
|
def test_some_query(self):
|
|
response = self.query(
|
|
'''
|
|
query {
|
|
myModel {
|
|
id
|
|
name
|
|
}
|
|
}
|
|
''',
|
|
op_name='myModel'
|
|
)
|
|
|
|
content = json.loads(response.content)
|
|
|
|
# This validates the status code and if you get errors
|
|
self.assertResponseNoErrors(response)
|
|
|
|
# Add some more asserts if you like
|
|
...
|
|
|
|
def test_query_with_variables(self):
|
|
response = self.query(
|
|
'''
|
|
query myModel($id: Int!){
|
|
myModel(id: $id) {
|
|
id
|
|
name
|
|
}
|
|
}
|
|
''',
|
|
op_name='myModel',
|
|
variables={'id': 1}
|
|
)
|
|
|
|
content = json.loads(response.content)
|
|
|
|
# This validates the status code and if you get errors
|
|
self.assertResponseNoErrors(response)
|
|
|
|
# Add some more asserts if you like
|
|
...
|
|
|
|
def test_some_mutation(self):
|
|
response = self.query(
|
|
'''
|
|
mutation myMutation($input: MyMutationInput!) {
|
|
myMutation(input: $input) {
|
|
my-model {
|
|
id
|
|
name
|
|
}
|
|
}
|
|
}
|
|
''',
|
|
op_name='myMutation',
|
|
input_data={'my_field': 'foo', 'other_field': 'bar'}
|
|
)
|
|
|
|
# This validates the status code and if you get errors
|
|
self.assertResponseNoErrors(response)
|
|
|
|
# Add some more asserts if you like
|
|
...
|
|
|
|
|
|
For testing mutations that are executed within a transaction you should subclass `GraphQLTransactionTestCase`
|
|
|
|
Usage:
|
|
|
|
.. code:: python
|
|
|
|
import json
|
|
|
|
from graphene_django.utils.testing import GraphQLTransactionTestCase
|
|
|
|
class MyFancyTransactionTestCase(GraphQLTransactionTestCase):
|
|
|
|
def test_some_mutation_that_executes_within_a_transaction(self):
|
|
response = self.query(
|
|
'''
|
|
mutation myMutation($input: MyMutationInput!) {
|
|
myMutation(input: $input) {
|
|
my-model {
|
|
id
|
|
name
|
|
}
|
|
}
|
|
}
|
|
''',
|
|
op_name='myMutation',
|
|
input_data={'my_field': 'foo', 'other_field': 'bar'}
|
|
)
|
|
|
|
# This validates the status code and if you get errors
|
|
self.assertResponseNoErrors(response)
|
|
|
|
# Add some more asserts if you like
|
|
...
|
|
|
|
Using pytest
|
|
------------
|
|
|
|
To use pytest define a simple fixture using the query helper below
|
|
|
|
.. code:: python
|
|
|
|
# Create a fixture using the graphql_query helper and `client` fixture from `pytest-django`.
|
|
import json
|
|
import pytest
|
|
from graphene_django.utils.testing import graphql_query
|
|
|
|
@pytest.fixture
|
|
def client_query(client):
|
|
def func(*args, **kwargs):
|
|
return graphql_query(*args, **kwargs, client=client)
|
|
|
|
return func
|
|
|
|
# Test you query using the client_query fixture
|
|
def test_some_query(client_query):
|
|
response = client_query(
|
|
'''
|
|
query {
|
|
myModel {
|
|
id
|
|
name
|
|
}
|
|
}
|
|
''',
|
|
op_name='myModel'
|
|
)
|
|
|
|
content = json.loads(response.content)
|
|
assert 'errors' not in content
|