How can I test binary file uploading with django-rest-framework’s test client?

by

When testing file uploads, you should pass the stream object into the request, not the data.

This was pointed out in the comments by @arocks

Pass { ‘image’: file} instead

But that didn’t full explain why it was needed (and also didn’t match the question). For this specific question, you should be doing

from PIL import Image

class TestFileUpload(APITestCase):

    def test_file_is_accepted(self):
        self.client.force_authenticate(self.user)

        image = Image.new('RGB', (100, 100))

        tmp_file = tempfile.NamedTemporaryFile(suffix='.jpg')
        image.save(tmp_file)
        tmp_file.seek(0)

        response = self.client.post('my_url', {'image': tmp_file}, format="multipart")

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

This will match a standard Django request, where the file is passed in as a stream object, and Django REST Framework handles it. When you just pass in the file data, Django and Django REST Framework interpret it as a string, which causes issues because it is expecting a stream.

And for those coming here looking to another common error, why file uploads just won’t work but normal form data will: make sure to set format="multipart" when creating the request.

This also gives a similar issue, and was pointed out by @RobinElvin in the comments

It was because I was missing format=”multipart”

More Related Contents:

  1. Django Rest Framework remove csrf
  2. Django rest framework, use different serializers in the same ModelViewSet
  3. How do I create multiple model instances with Django Rest Framework?
  4. Django rest framework nested self-referential objects
  5. Custom error messages in Django Rest Framework serializer
  6. Django REST Framework: adding additional field to ModelSerializer
  7. How to change field name in Django REST Framework
  8. How do you use the django-filter package with a list of parameters?
  9. Django Rest Framework: Dynamically return subset of fields
  10. Django Rest Framework with ChoiceField
  11. SocketException: OS Error: Connection refused, errno = 111 in flutter using django backend
  12. How to set current user to user field in Django Rest Framework?
  13. 405 POST method not allowed
  14. “Post Image data using POSTMAN”
  15. CSRF Failed: CSRF token missing or incorrect
  16. How to register users in Django REST framework?
  17. AngularJS + Django Rest Framework + CORS ( CSRF Cookie not showing up in client )
  18. How do you filter a nested serializer in Django Rest Framework?
  19. How to get Request.User in Django-Rest-Framework serializer?
  20. Pass request context to serializer from Viewset in Django Rest Framework
  21. Django Rest Framework: Disable field update after object is created
  22. Adding root element to json response (django-rest-framework)
  23. Token Authentication for RESTful API: should the token be periodically changed?
  24. Authorization Credentials Stripped — django, elastic beanstalk, oauth
  25. How to programmatically call a Django Rest Framework view within another view?
  26. Django REST Framework image upload
  27. Django/DRF – 405 Method not allowed on DELETE operation
  28. How to pass extra context to Django Rest Framework serializers
  29. Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?
  30. context in nested serializers django rest framework

Leave a Comment