Merge pull request #45 from caravancoop/feature/unit-tests

Add unit tests for models #2

Author: merwok

.circleci/config.yml

@@ -6,19 +6,29 @@ workflows:
     jobs:
       - test-py37
       - test-py36
-      - test-py27
       - check
 
 jobs:
 
   test-py37:
     docker:
       - image: circleci/python:3.7
+      - image: circleci/postgres:9.6-alpine
+        environment:
+          POSTGRES_DB: circle_test
+          POSTGRES_USER: testapp
+          POSTGRES_PASSWORD: ""
     working_directory: ~/rest-auth-toolkit
+    environment:
+      DATABASE_URL: postgres://testapp@localhost/circle_test
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-py37-v2
+          keys:
+            - rest-auth-toolkit-py37-v5-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py37-v5-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py37-v5-{{ arch }}-{{ checksum "requirements-test.txt" }}
+            - rest-auth-toolkit-py37-v5-{{ arch }}-
       - run:
           name: Install CI tools
           command: |
@@ -27,20 +37,34 @@ jobs:
       - run:
           name: Test with Python 3.7
           command: venv/bin/tox -e py37
+      - run:
+          name: Check coverage with Python 3.7
+          command: venv/bin/tox -e coverage
       - save_cache:
-          key: rest-auth-toolkit-py37-v2
+          key: rest-auth-toolkit-py37-v5-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
           paths:
             - venv
             - .tox
 
   test-py36:
     docker:
       - image: circleci/python:3.6
+      - image: circleci/postgres:9.6-alpine
+        environment:
+          POSTGRES_DB: circle_test
+          POSTGRES_USER: testapp
+          POSTGRES_PASSWORD: ""
     working_directory: ~/rest-auth-toolkit
+    environment:
+      DATABASE_URL: postgres://testapp@localhost/circle_test
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-py36-v2
+          keys:
+            - rest-auth-toolkit-py36-v3-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py36-v2-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py36-v3-{{ arch }}-{{ checksum "requirements-test.txt" }}
+            - rest-auth-toolkit-py36-v3-{{ arch }}-
       - run:
           name: Install CI tools
           command: |
@@ -50,54 +74,29 @@ jobs:
           name: Test with Python 3.6
           command: venv/bin/tox -e py36
       - save_cache:
-          key: rest-auth-toolkit-py36-v2
-          paths:
-            - venv
-            - .tox
-
-  test-py27:
-    docker:
-      # This image contains Python 3.6 (to install flit) and 2.7 (to run tests)
-      - image: circleci/python:3.6
-    working_directory: ~/rest-auth-toolkit
-    steps:
-      - checkout
-      - restore_cache:
-          key: rest-auth-toolkit-py27-v2
-      - run:
-          name: Install CI tools
-          command: |
-            python3.6 -m venv venv
-            venv/bin/pip install tox
-      - run:
-          name: Test with Python 2.7
-          command: |
-            venv/bin/tox --sdistonly
-            venv/bin/tox -e py27
-      - save_cache:
-          key: rest-auth-toolkit-py27-v2
+          key: rest-auth-toolkit-py36-v3-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
           paths:
             - venv
             - .tox
 
   check:
     docker:
-      - image: circleci/python:3.6
+      - image: circleci/python:3.7
     working_directory: ~/rest-auth-toolkit
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-check-v3
+          key: rest-auth-toolkit-check-v5
       - run:
           name: Install CI tools
           command: |
-            python3.6 -m venv venv
+            python3.7 -m venv venv
             venv/bin/pip install tox
       - run:
           name: Check packaging and dependencies
           command: venv/bin/tox -e pkg
       - save_cache:
-          key: rest-auth-toolkit-check-v3
+          key: rest-auth-toolkit-check-v5
           paths:
             - venv
             - .tox

.gitignore

@@ -4,7 +4,8 @@ __pycache__
 /demo/.env
 
 # Test artifacts
-/.cache/
+/.pytest_cache/
+/.coverage
 /.tox/
 /venv/
 

demo/README.md

@@ -3,6 +3,9 @@
 This is a minimal Django project that shows how to use
 the package and helps checking if changes break usage.
 
+This app is also used by the automated tests.
+
+
 ## How to install
 
 Run this command once from the repository root:
@@ -26,7 +29,7 @@ Define the environment variables needed by the app:
 
 ```
 export DEMO_FACEBOOK_APP_ID="..."
-export DEMO_FACEBOOK_SECRET_KEY="..."
+export DEMO_FACEBOOK_APP_SECRET_KEY="..."
 ```
 
 (using a [virtualenvwrapper hook](https://virtualenvwrapper.readthedocs.io/en/latest/scripts.html#postactivate)

demo/demo/accounts/admin.py

@@ -18,7 +18,7 @@ class EmailConfirmationAdmin(admin.ModelAdmin):
 
 
 class APITokenAdmin(admin.ModelAdmin):
-    list_display = ('key', 'user', 'created')
+    list_display = ('__str__', 'created')
     ordering = ('user', '-created')
     date_hierarchy = 'created'
     readonly_fields = ('key', 'created')

demo/demo/settings.py

@@ -2,17 +2,32 @@
 
 import os
 
+from django.core.management.utils import get_random_secret_key
+
+import dj_database_url
+
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
 
+if os.getenv('RAT_TESTING'):
+    os.environ['DEMO_SECRET_KEY'] = get_random_secret_key()
+    os.environ['DEMO_FACEBOOK_APP_ID'] = 'fb app id'
+    os.environ['DEMO_FACEBOOK_APP_SECRET_KEY'] = 'fb app key'
+
+
 SECRET_KEY = os.getenv('DEMO_SECRET_KEY',
                        '1(9v73@)*ws6i(v_i5*_4ty^+ji0@7u($6onk7pt-_ncxkqs@@')
+
 DEBUG = True
 
 FACEBOOK_APP_ID = os.environ['DEMO_FACEBOOK_APP_ID']
-FACEBOOK_APP_SECRET_KEY = os.environ['DEMO_FACEBOOK_SECRET_KEY']
+FACEBOOK_APP_SECRET_KEY = os.environ['DEMO_FACEBOOK_APP_SECRET_KEY']
+
+DATABASES = {
+    'default': dj_database_url.parse(os.environ['DATABASE_URL']),
+}
 
 SITE_ID = 1
 ROOT_URLCONF = 'demo.urls'
@@ -49,14 +64,6 @@
 ]
 
 
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
-    }
-}
-
-
 EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
 
 

demo/requirements.in

@@ -3,6 +3,8 @@ pip-tools
 django == 2.0.*
 djangorestframework
 django-debug-toolbar
+dj-database-url
+psycopg2
 
 django-model-utils
 django-shortuuidfield

demo/requirements.txt

@@ -2,11 +2,12 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    pip-compile --output-file requirements.txt requirements.in
+#    pip-compile requirements.in
 #
 certifi==2018.8.24        # via requests
 chardet==3.0.4            # via requests
 click==6.7                # via pip-tools
+dj-database-url==0.5.0
 django-debug-toolbar==1.10.1
 django-model-utils==3.1.2
 django-shortuuidfield==0.1.3
@@ -17,6 +18,7 @@ first==2.0.1              # via pip-tools
 idna==2.7                 # via requests
 markdown==2.6.11
 pip-tools==2.0.2
+psycopg2==2.7.5
 pygments==2.2.0
 pytz==2018.5              # via django
 requests==2.19.1          # via facepy

pyproject.toml

@@ -13,7 +13,6 @@ classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 2.7",
     "Programming Language :: Python :: 3.5",
     "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: 3.7",

requirements-test.txt

@@ -0,0 +1,8 @@
+flake8
+
+pytest
+pytest-env
+pytest-django
+pytest-pythonpath
+
+coverage

rest_auth_toolkit/models.py

@@ -103,7 +103,7 @@ class Meta:
         abstract = True
 
     def __str__(self):
-        return self.key
+        return 'API token for {user}'.format(user=self.user)
 
     def save(self, *args, **kwargs):
         if not self.key:

tests/__init__.py

@@ -0,0 +1,27 @@
+import pytest
+
+from demo.accounts.models import User, APIToken
+
+
+@pytest.fixture
+def user0(db):
+    return User.objects.create_user(
+        email='[email protected]',
+        is_active=True,
+    )
+
+
+@pytest.fixture
+def user1(db):
+    return User.objects.create_user(
+        email='[email protected]',
+        password='unitpass123',
+        is_active=True,
+    )
+
+
+@pytest.fixture
+def token0(user0):
+    return APIToken.objects.create_token(
+        user=user0,
+    )