Merge pull request #138 from rpkilby/perf-tests

Add performance tests

Author: Ryan P Kilby

.travis.yml

@@ -8,23 +8,23 @@ python:
   - "3.4"
   - "3.5"
 env:
-  - DJANGO="django>=1.10.0,<1.11.0" REST_FRAMEWORK="djangorestframework>=3.4,<3.5"
-  - DJANGO="django>=1.9.0,<1.10.0" REST_FRAMEWORK="djangorestframework>=3.4,<3.5"
+  - DJANGO="django>=1.10.0,<1.11.0" REST_FRAMEWORK="djangorestframework>=3.5,<3.6"
+  - DJANGO="django>=1.9.0,<1.10.0" REST_FRAMEWORK="djangorestframework>=3.5,<3.6"
+  - DJANGO="django>=1.8.0,<1.9.0" REST_FRAMEWORK="djangorestframework>=3.5,<3.6"
   - DJANGO="django>=1.8.0,<1.9.0" REST_FRAMEWORK="djangorestframework>=3.4,<3.5"
-  - DJANGO="django>=1.8.0,<1.9.0" REST_FRAMEWORK="djangorestframework>=3.3,<3.4"
 install:
-  - travis_retry pip install -q $DJANGO $REST_FRAMEWORK "coverage==3.7.1"
+  - travis_retry pip install -q $DJANGO $REST_FRAMEWORK coverage
   - pip install .
 script:
-  - coverage run manage.py test
+  - coverage run manage.py test -v 2
   - coverage report
 after_success:
   - bash <(curl -s https://codecov.io/bash)
 
 matrix:
   exclude:
     - python: "3.3"
-      env: DJANGO="django>=1.10.0,<1.11.0" REST_FRAMEWORK="djangorestframework>=3.4,<3.5"
+      env: DJANGO="django>=1.10.0,<1.11.0" REST_FRAMEWORK="djangorestframework>=3.5,<3.6"
     - python: "3.3"
-      env: DJANGO="django>=1.9.0,<1.10.0" REST_FRAMEWORK="djangorestframework>=3.4,<3.5"
+      env: DJANGO="django>=1.9.0,<1.10.0" REST_FRAMEWORK="djangorestframework>=3.5,<3.6"
   fast_finish: true

tests/perf/__init__.py

@@ -0,0 +1,31 @@
+
+from django_filters import FilterSet as DFFilterSet
+from rest_framework_filters import filters
+from rest_framework_filters.filterset import FilterSet as DRFFilterSet
+
+from ..testapp.models import User, Note
+
+
+# df-filters
+class NoteFilterWithExplicitRelated(DFFilterSet):
+    class Meta:
+        model = Note
+        fields = {
+            'author__username': ['exact'],
+        }
+
+
+# drf-filters
+class UserFilterWithAll(DRFFilterSet):
+    username = filters.AllLookupsFilter()
+
+    class Meta:
+        model = User
+
+
+class NoteFilterWithRelatedAll(DRFFilterSet):
+    title = filters.AllLookupsFilter()
+    author = filters.RelatedFilter(UserFilterWithAll)
+
+    class Meta:
+        model = Note

tests/perf/filters.py

@@ -0,0 +1,10 @@
+
+from rest_framework import serializers
+
+from ..testapp.models import Note
+
+
+class NoteSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Note
+        fields = ('pk', 'title', 'content', 'author', )

tests/perf/serializers.py

@@ -0,0 +1,15 @@
+
+from django.conf.urls import include, url
+from rest_framework import routers
+
+from . import views
+
+
+router = routers.DefaultRouter()
+router.register(r'df-notes', views.DFNoteViewSet, base_name='df-notes')
+router.register(r'drf-notes', views.DRFFNoteViewSet, base_name='drf-notes')
+
+
+urlpatterns = [
+    url(r'^', include(router.urls)),
+]

tests/perf/urls.py

@@ -0,0 +1,22 @@
+
+from rest_framework import viewsets
+from rest_framework import filters as df_backends
+from rest_framework_filters import backends
+
+from ..testapp.models import Note
+from .serializers import NoteSerializer
+from .filters import NoteFilterWithExplicitRelated, NoteFilterWithRelatedAll
+
+
+class DFNoteViewSet(viewsets.ModelViewSet):
+    queryset = Note.objects.all()
+    serializer_class = NoteSerializer
+    filter_backends = (df_backends.DjangoFilterBackend, )
+    filter_class = NoteFilterWithExplicitRelated
+
+
+class DRFFNoteViewSet(viewsets.ModelViewSet):
+    queryset = Note.objects.all()
+    serializer_class = NoteSerializer
+    filter_backends = (backends.DjangoFilterBackend, )
+    filter_class = NoteFilterWithRelatedAll

tests/perf/views.py

@@ -0,0 +1,54 @@
+import argparse
+import time
+
+from django.test import TestCase, Client, override_settings
+from django.core.urlresolvers import reverse
+
+
+parser = argparse.ArgumentParser()
+parser.add_argument(
+    '-v', '--verbosity', action='store', dest='verbosity', default=1,
+    type=int, choices=[0, 1, 2, 3],
+)
+args, _ = parser.parse_known_args()
+
+
+@override_settings(ROOT_URLCONF='tests.perf.urls')
+class PerformanceTests(TestCase):
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.client = Client()
+        cls.iterations = range(1000)
+        cls.threshold = 1.2
+
+    def test_sanity(self):
+        # sanity check to ensure our request are behaving as expected
+        response = self.client.get(reverse('df-notes-list'), {'author__username': 'bob'})
+        self.assertEqual(response.status_code, 200)
+
+        response = self.client.get(reverse('drf-notes-list'), {'author__username': 'bob'})
+        self.assertEqual(response.status_code, 200)
+
+    def test_response_time(self):
+
+        start = time.time()
+        for i in self.iterations:
+            self.client.get(reverse('df-notes-list'), {'author__username': 'bob'})
+        stop = time.time()
+        df_time = stop - start
+
+        start = time.time()
+        for i in self.iterations:
+            self.client.get(reverse('drf-notes-list'), {'author__username': 'bob'})
+        stop = time.time()
+        drf_time = stop - start
+
+        if args.verbosity >= 2:
+            print('\n' + '-' * 32)
+            print('Response time performance')
+            print('django-filter time:\t%.4fs' % df_time)
+            print('drf-filters time:\t%.4fs' % drf_time)
+            print('-' * 32)
+
+        self.assertTrue(drf_time < (df_time * self.threshold))