Django test VS pytest

joe picture joe · Jun 15, 2017 · Viewed 8.2k times · Source


I am new to django unittest and pytest. However, I started to feel that pytest test case is more compact and clearer.

Here is my test cases:

class OrderEndpointTest(TestCase):
    def setUp(self):
        user = User.objects.create_superuser(username='admin', password='password', email='[email protected]')
        mommy.make(CarData, _quantity=1)
        mommy.make(UserProfile, _quantity=1, user=user)

    def test_get_order(self):
        mommy.make(Shop, _quantity=1)
        mommy.make(Staff, _quantity=1, shop=Shop.objects.first())
        mommy.make(Order, _quantity=1, car_info={"color": "Black"}, customer={"name": "Lord Elcolie"},
                   staff=Staff.objects.first(), shop=Shop.objects.first())

        factory = APIRequestFactory()
        user = User.objects.get(username='admin')
        view = OrderViewSet.as_view({'get': 'list'})

        request = factory.get('/api/orders/')
        force_authenticate(request, user=user)
        response = view(request)
        assert 200 == response.status_code
        assert 1 == len(response.data.get('results'))

And here is the pytest version

def test_get_order(car_data, admin_user, orders):
    factory = APIRequestFactory()
    user = User.objects.get(username='admin')
    view = OrderViewSet.as_view({'get': 'list'})

    request = factory.get('/api/orders/')
    force_authenticate(request, user=user)
    response = view(request)
    assert 200 == response.status_code
    assert 1 == len(response.data.get('results'))

The benefit from pytest is fixture in another file. It makes my test case compact by let them be my input parameters.

Are they any benefit of using Django unittest than pytest?

Update: 1July2017
Update: 5July2017
Update: 1Sep2017
Update: 29Sep2017
Update: 26Dec2017

  1. Pytest reduces your problem when fixtures got mutated over the test. I got testcases that run individually passed, but fail when run thoroughly.
  2. Pytest will show you the assertion output if the error occur. Django unittest does not. I have to put the breakpoint on my own and investigate the error.
  3. Pytest allow you to use real database with simple decorator. Django test does not. You have to create your own customized command for your job
  4. Pytest is generic. Being an generic it means you feel comfortable to work with project outside the Django. For example when you have to build micro-service such as Flask + 3rd parties like APScheduler, PyRad, ... etc. I mention this because my backend life uses Django 50% The rest of the is Python and infra
  5. Pytest is not using multiple inheritance to create my fixtures
  6. Unittest takes advantage on gitlab-ci over Pytest when used with Docker as a runner by smoothly execute without any extra configurations. problem

Answer

Luan Fonseca picture Luan Fonseca · Apr 19, 2018

i've used Django test for my entire life and now i am using Py.test. I agree that pytest is much cleaner than django itself.

The benefit from pytest is fixture in another file. It makes my test case compact by let them be my input parameters.

In Django unittest you can still use fixtures in other file by using the attribute fixtures = ['appname/fixtures/my_fixture.json']

Pytest will show you the assertion output if the error occur. Django unittest does not. I have to put the breakpoint on my own and investigate the error.

Did you tried to change the --verbose param on python manage.py tests?

A few tips:

  1. There is a package called pytest-django that will help you integrate and using django with pytest.

  2. I think that if you use classes will you not need to use the factory = APIRequestFactory(), the test methods itself they have a parameter called client that is a interface to the python requests module to access your views.

    import pytest
    
    from model_mommy import mommy
    
    @pytest.fixture()
    def user(db):
        return mommy.make(User)
    
    class SiteAPIViewTestSuite:
        def test_create_view(self, client, user):
            assert Site.objects.count() == 0
    
            post_data = {
                'name': 'Stackoverflow'
                'url': 'http://stackoverflow.com',
                'user_id': user.id,
            }
            response = client.post(
                reverse('sites:create'),
                json.dumps(post_data),
                content_type='application/json',
            )
    
            data = response.json()
            assert response.status_code == 201
            assert Site.objects.count() == 1
            assert data == {
                'count': 1,
                'next': None,
                'previous': None
                'results': [{
                    'pk': 1,
                    'name': 'Stackoverflow',
                    'url': 'http://stackoverflow.com',
                    'user_id': user.id
                }]
            }