Setup Tests with Coverage

Author: Emmanouil Konstantinidis

.gitignore

@@ -1,3 +1,6 @@
+.coverage
+covhtml/
+
 *.pyc
 __pycache__/
 

requirements.txt

@@ -1,3 +1,4 @@
 Django==1.8.7
 djangorestframework==3.3.2
+coverage==4.0.3
 flake8==2.5.1

rest_framework_docs/templates/rest_framework_docs/home.html

@@ -6,7 +6,7 @@
   <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Jump To <span class="caret"></span></a>
   <ul class="dropdown-menu">
     {% for group in endpoints_grouped %}
-      <li><a href="#{{ group.grouper|lower }}-nav">{{ group.grouper }}</a></li>
+      <li><a href="#{{ group.grouper|lower }}-group">{{ group.grouper }}</a></li>
     {% endfor %}
   </ul>
 </li>
@@ -20,7 +20,7 @@
   {% if endpoints_grouped %}
   {% for group in endpoints_grouped %}
 
-    <h1 id="{{ group.grouper|lower }}-nav">{{group.grouper}}</h1>
+    <h1 id="{{ group.grouper|lower }}-group">{{group.grouper}}</h1>
 
     <div class="panel-group" role="tablist">
 

runtests.py

@@ -3,6 +3,7 @@
 import sys
 import subprocess
 import django
+from coverage import coverage
 from django.conf import settings
 from django.test.utils import get_runner
 
@@ -22,15 +23,28 @@ def flake8_main(args):
     return command
 
 
-def django_tests_main():
+def run_tests_coverage():
     if __name__ == "__main__":
         os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings'
         django.setup()
         TestRunner = get_runner(settings)
         test_runner = TestRunner()
+
+        # Setup Coverage
+        cov = coverage(source=["rest_framework_docs"], omit=["__init__.py"])
+        cov.start()
+
         failures = test_runner.run_tests(["tests"])
-        sys.exit(bool(failures))
 
-exit_on_failure(flake8_main(FLAKE8_ARGS))
+        if bool(failures):
+            cov.erase()
+            sys.exit("Tests Failed. Coverage Cancelled.")
 
-django_tests_main()
+        # If success show coverage results
+        cov.stop()
+        cov.save()
+        cov.report()
+        # cov.html_report(directory='covhtml')
+
+exit_on_failure(flake8_main(FLAKE8_ARGS))
+exit_on_failure(run_tests_coverage())

tests/serializers.py

@@ -15,5 +15,17 @@
 }
 
 INSTALLED_APPS = [
+    # Django Apps
+    'django.contrib.staticfiles',
+
+    # External Packages
     "rest_framework",
+    "rest_framework_docs",
 ]
+
+ROOT_URLCONF = 'tests.urls'
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.8/howto/static-files/
+
+STATIC_URL = '/static/'

tests/settings.py

@@ -1,7 +1,33 @@
+from django.core.urlresolvers import reverse
 from django.test import TestCase
 
 
 class SimpleTest(TestCase):
 
     def test_details(self):
         self.assertEqual(1, 1)
+
+
+class DRFDocsViewTests(TestCase):
+    def setUp(self):
+        super(DRFDocsViewTests, self).setUp()
+
+    def test_index_view_with_no_questions(self):
+        """
+        Should load the drf focs view
+        """
+        response = self.client.get(reverse('drfdocs'))
+
+        # print()
+        # print()
+        # print(response)
+        # print(response["context"])
+        # print(response.context)
+        # print(dir(response))
+        # print()
+        # print()
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.context["endpoints"], [])
+        # self.assertContains(response, "No polls are available.")
+        # self.assertQuerysetEqual(response.context['latest_question_list'], [])

tests/tests.py

@@ -0,0 +1,11 @@
+from django.conf.urls import include, url
+from django.contrib import admin
+
+urlpatterns = [
+    url(r'^admin/', include(admin.site.urls)),
+    url(r'^docs/', include('rest_framework_docs.urls')),
+
+    # API
+    # url(r'^accounts/', view=include('project.accounts.urls', namespace='accounts')),
+    # url(r'^organisations/', view=include('project.organisations.urls', namespace='organisations')),
+]