Tests

Author: Emmanouil Konstantinidis

.travis.yml

@@ -27,6 +27,10 @@ cache:
 
 install:
   - pip install tox
+  - pip install codecov
 
 script:
   - tox -e $TOX_ENV
+
+after_success:
+  - codecov

README.md

@@ -22,6 +22,26 @@ Add 'rest_framework_api_key' to your `INSTALLED_APPS` setting:
         'rest_framework_api_key',
     )
 
+Finally set the django-rest-framework permissions under your django settings:
+
+    REST_FRAMEWORK = {
+        'DEFAULT_PERMISSION_CLASSES': (
+            'rest_framework_api_key.permissions.HasAPIAccess',
+        )
+    }
+
+
+### Example Request
+
+```python
+response = requests.get(
+    url="http://uhs-api.ctf.sh:8080/catalogue/categories/",
+    headers={
+        "Api-Key": "fd8b4a98c8f53035aeab410258430e2d86079c93",
+    },
+)
+```
+
 
 [travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key.svg?branch=master
 [travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key

codecov.yml

@@ -0,0 +1,11 @@
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project: false
+    patch: false
+    changes: false
+
+comment: off

runtests.py

@@ -5,7 +5,7 @@
 
 
 FLAKE8_ARGS = ['rest_framework_api_key', 'tests/', '--ignore=E501']
-PYTEST_ARGS = ['tests', '--cov=rest_framework_api_key', '--tb=short']
+PYTEST_ARGS = ['tests', '--cov=rest_framework_api_key', '--tb=short', '-rw']
 
 
 def exit_on_failure(command, message=None):

tests/settings.py

@@ -16,6 +16,7 @@
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
+    'django.contrib.sessions',
     'django.contrib.staticfiles',
 
     # External Packages
@@ -26,4 +27,33 @@
     "tests"
 ]
 
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django.middleware.security.SecurityMiddleware',
+)
+
 ROOT_URLCONF = 'tests.urls'
+
+STATIC_URL = '/static/'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]

tests/test_admin.py

@@ -0,0 +1,58 @@
+from django.contrib.auth.models import User
+from django.core.urlresolvers import reverse
+from django.test import TestCase
+from rest_framework_api_key.models import APIKey
+from rest_framework_api_key.helpers import generate_key
+
+
+class LoggedInAdminTestCase(TestCase):
+
+    USERNAME = "martymcfly"
+    EMAIL = "[email protected]"
+    PASSWORD = "password"
+
+    def setUp(self):
+        super(LoggedInAdminTestCase, self).setUp()
+
+        self.user = User.objects.create_superuser(self.USERNAME, self.EMAIL, self.PASSWORD)
+        self.assertTrue(self.user.is_active)
+        self.assertTrue(self.user.is_superuser)
+        self.client.login(username=self.USERNAME, password=self.PASSWORD)
+
+
+class APIAuthenticatedTestCase(TestCase):
+
+    APP_NAME = 'Project Tests'
+
+    def setUp(self):
+        self.app_key = APIKey.objects.create(name=self.APP_NAME, key=generate_key())
+        self.header = {'HTTP_API_KEY': self.app_key.key}
+
+
+class AdminTestCase(LoggedInAdminTestCase, APIAuthenticatedTestCase):
+    def setUp(self):
+        super(AdminTestCase, self).setUp()
+        self.add_app_url = reverse('admin:rest_framework_api_key_apikey_add')
+
+    def test_admin_create_app_access(self):
+        response = self.client.get(self.add_app_url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_admin_create_app(self):
+        self.assertEqual(APIKey.objects.all().count(), 1)
+
+        response = self.client.post(self.add_app_url, data={"name": "Hello"}, follow=True)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Please note it since you will not be able to see it again.")
+        self.assertContains(response, "was added successfully.")
+
+        self.assertEqual(APIKey.objects.all().count(), 2)
+
+    def test_admin_change_app(self):
+        self.change_app_url = reverse('admin:rest_framework_api_key_apikey_change', args=(self.app_key.id,))
+
+        response = self.client.get(self.change_app_url,)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Hidden")

tests/test_models.py

@@ -2,10 +2,10 @@
 from rest_framework_api_key.models import APIKey
 
 
-class APIKeyAdminTestCase(TestCase):
+class ModelTestCase(TestCase):
 
     def setUp(self):
-        super(APIKeyAdminTestCase, self).setUp()
+        super(ModelTestCase, self).setUp()
 
     def test_admin_create_object(self):
         self.assertEqual(APIKey.objects.all().count(), 0)

tests/urls.py

@@ -0,0 +1,11 @@
+from django.conf.urls import include, url
+from django.contrib import admin
+from tests.views import TestView
+
+
+urlpatterns = [
+
+    url(r'^admin/', include(admin.site.urls)),
+    url(r'^test/$', TestView.as_view(), name="test-view"),
+
+]

tests/views.py

@@ -0,0 +1,12 @@
+from rest_framework import status
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+
+class TestView(APIView):
+    """
+    A dummy view used only for testing.
+    """
+
+    def get(self, request):
+        return Response({"msg": "Hello World!"}, status=status.HTTP_200_OK)