results attribute instead of data in response.data when testing

[przemekciacka]

When running tests the response.data doesn't contain data key. Instead the results key is available.

Example code:

class AdvertsTestCase(APITestCase):
    def test_get_adverts_list(self):
        advert1 = f.AdvertFactory.create()
        advert2 = f.AdvertFactory.create()
        advert3 = f.AdvertFactory.create()

        url = reverse('advert-list')
        response = self.client.get(url)

        print(response.data)

        self.assertEqual(response.status_code, status.HTTP_200_OK)

The result from print(response.data)

{'results': [ ... ], 'meta': { ... }, 'links': { ... }}

But when access the response.content there is data attribute in the raw response's data:

b'{"links":{ ... },"data":[ ... ],"meta":{ ... }'

When accessing API via Postman or web-browser, the data key in the response is available. Seems like tests doesn't use renderers correctly - it's my assumption.

requirements.txt

Django==2.0.4
psycopg2-binary==2.7.4
djangorestframework==3.7.7
django-cors-headers==2.2.0
boto3==1.6.15
django-storages==1.6.5
environs==2.1.0
django-dirtyfields==1.3.1
django-filter==1.1.0
drf_yasg==1.7.0
djangorestframework-jsonapi==2.4.0

[sliverc]

You need to configure a test renderer.

See http://www.django-rest-framework.org/api-guide/testing/#setting-the-available-formats or PR #396 how this is done.

Does this solves your issue?

[przemekciacka]

Unfortunatelly not. My configuration looks like the following

REST_FRAMEWORK = {
    'DATETIME_FORMAT': '%Y-%m-%dT%H:%M:%S%z',
    'PAGE_SIZE': 10,
    'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler',
    'DEFAULT_PAGINATION_CLASS': 'rest_framework_json_api.pagination.PageNumberPagination',
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework.parsers.JSONParser',
        'rest_framework.parsers.FormParser',
        'rest_framework.parsers.MultiPartParser'
    ),
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework_json_api.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),
    'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',

    'TEST_REQUEST_RENDERER_CLASSES': (
        'rest_framework_json_api.renderers.JSONRenderer',
    ),
    'TEST_REQUEST_DEFAULT_FORMAT': 'vnd.api+json'
}

but response.data still contains results not data.

[sliverc]

Just checked in the django-json-api tests.

To get the rendererd json response you need to call response.json() in the tests. response.data is the unrendered response.

Works that for you?

[przemekciacka]

Aye Aye Captain! It works! Thank you :)