Merge branch 'add-tests'

Author: PeterJCLaw

.circleci/config.yml

@@ -1,36 +1,79 @@
 version: 2.1
 
-jobs:
-  build:
+references:
+  install-poetry: &install-poetry
+    run:
+      name: Install Poetry
+      command: |
+        curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+  restore-dependencies-cache: &restore-dependencies-cache
+    restore_cache:
+      keys:
+        - deps-py<< parameters.python-version >>-django<< parameters.django-version >>-{{ checksum "poetry.lock" }}
+  install-dependencies: &install-dependencies
+    run:
+      name: Install Dependencies
+      command: |
+        source $HOME/.poetry/env
+        poetry install
+        poetry run pip install "django~=<< parameters.django-version >>.0"
+  save-dependencies-cache: &save-dependencies-cache
+    save_cache:
+      key: deps-py<< parameters.python-version >>-django<< parameters.django-version >>-{{ checksum "poetry.lock" }}
+      paths:
+        - /home/circleci/.cache/pypoetry/virtualenvs
+  parametrised-python-executor: &parametrised-python-executor
+    parameters:
+      python-version:
+        type: string
+      django-version:
+        type: string
+    executor:
+      name: python
+      version: << parameters.python-version >>
+  version-matrix: &version-matrix
+    matrix:
+      parameters:
+        python-version: ["3.5.5", "3.6", "3.7", "3.8", "3.9", "3.10"]
+        django-version: ["2.2", "3.0", "3.1", "3.2"]
+      exclude:
+        - python-version: "3.5.5"
+          django-version: "3.0"
+        - python-version: "3.5.5"
+          django-version: "3.1"
+        - python-version: "3.5.5"
+          django-version: "3.2"
+
+executors:
+  python:
+    parameters:
+      version:
+        type: string
     docker:
-      - image: circleci/python:3.5.5
+      - image: circleci/python:<< parameters.version >>
+
+jobs:
+  build-test:
+    <<: *parametrised-python-executor
+
     steps:
       - checkout
-      - run:
-          name: Install Poetry
-          command: |
-            curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
-      - restore_cache:
-          keys:
-            - deps-{{ checksum "poetry.lock" }}
-      - run:
-          name: Install Dependencies
-          command: |
-            source $HOME/.poetry/env
-            poetry install
-      - save_cache:
-          key: deps-{{ checksum "poetry.lock" }}
-          paths:
-            - /home/circleci/.cache/pypoetry/virtualenvs
+
+      - *install-poetry
+      - *restore-dependencies-cache
+      - *install-dependencies
+      - *save-dependencies-cache
 
       - run:
-          name: Build
+          name: Run Tests
           command: |
             source $HOME/.poetry/env
-            poetry build
+            poetry run ./runtests
+
   deploy:
-    docker:
-      - image: circleci/python:3.5.5
+    executor:
+      name: python
+      version: "3.7"
     steps:
       - checkout
       - run:
@@ -43,16 +86,21 @@ jobs:
               --username "${PYPI_USERNAME}" \
               --password "${PYPI_PASSWORD}" \
               --no-interaction
+
 workflows:
   version: 2.1
 
-  build:
+  build-test:
     jobs:
-      - build
+      - build-test:
+          name: build-test-py<< matrix.python-version >>-Django<< matrix.django-version >>
+          <<: *version-matrix
 
-  build-deploy:
+  build-test-deploy:
     jobs:
-      - build:
+      - build-test:
+          name: build-test-py<< matrix.python-version >>-Django<< matrix.django-version >>
+          <<: *version-matrix
           filters:
             tags:
               only: /v[0-9]+(\.[0-9]+)*/
@@ -62,7 +110,7 @@ workflows:
       - deploy:
           context: thread-pypi
           requires:
-            - build
+            - build-test
           filters:
               tags:
                 only: /v[0-9]+(\.[0-9]+)*/

poetry.lock

@@ -11,6 +11,8 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.5"
+Django = "<4"
+django-debug-toolbar = "<4"
 
 [tool.poetry.dev-dependencies]
 

pyproject.toml

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+
+import os
+import sys
+import django
+
+from django.conf import settings
+from django.test.utils import get_runner
+
+if __name__ == '__main__':
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings'
+    django.setup()
+    failures = get_runner(settings)().run_tests(sys.argv[1:])
+    sys.exit(bool(failures))

runtests

@@ -0,0 +1,41 @@
+SECRET_KEY = 'very-secret-value'
+
+INSTALLED_APPS = [
+    'django.contrib.auth',
+    'django.contrib.contenttypes', # needed by django.auth
+    'django.contrib.sessions',
+    'debug_toolbar',
+    'debug_toolbar_user_switcher',
+]
+
+DATABASES={
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+    }
+}
+
+ROOT_URLCONF = 'tests.urls'
+
+MIDDLEWARE = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'debug_toolbar.middleware.DebugToolbarMiddleware',
+)
+
+TEMPLATES = (
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'APP_DIRS': True,
+        'DIRS': (),
+        'OPTIONS': {
+            'debug': True,
+            'builtins': [],
+        },
+    },
+)
+
+DEBUG_TOOLBAR_PANELS = (
+    'debug_toolbar_user_switcher.panels.UserPanel',
+)
+
+DEBUG_TOOLBAR_USER_DEBUG = True

tests/__init__.py

@@ -0,0 +1,61 @@
+from typing import Union
+
+from django.contrib.auth import get_user
+from django.contrib.auth.models import AnonymousUser, User
+from django.http import HttpRequest
+from django.test import TestCase
+from django.urls import reverse
+
+
+class UserPanelTests(TestCase):
+    def assertCurrentUser(self, expected_user: Union[User, AnonymousUser]) -> None:
+        request = HttpRequest()
+        request.session = self.client.session
+        user = get_user(request)
+        self.assertEqual(expected_user, user, "Wrong user on session")
+
+    @classmethod
+    def setUpTestData(cls) -> None:
+        cls.user = User.objects.create(
+            email='[email protected]',
+            username='demo-example',
+        )
+        User.objects.create(
+            email='[email protected]',
+            username='other-example',
+        )
+
+    def test_login_form_view(self) -> None:
+        response = self.client.post(
+            reverse('djdt:debug-userpanel-login-form'),
+            data={'val': self.user.email},
+        )
+        self.assertRedirects(
+            response,
+            '/',
+            fetch_redirect_response=False,
+        )
+        self.assertCurrentUser(self.user)
+
+    def test_login_id_view(self) -> None:
+        response = self.client.post(
+            reverse('djdt:debug-userpanel-login', args=(self.user.pk,)),
+        )
+        self.assertRedirects(
+            response,
+            '/',
+            fetch_redirect_response=False,
+        )
+        self.assertCurrentUser(self.user)
+
+    def test_logout_view(self) -> None:
+        self.client.force_login(self.user)
+        response = self.client.post(
+            reverse('djdt:debug-userpanel-logout'),
+        )
+        self.assertRedirects(
+            response,
+            '/',
+            fetch_redirect_response=False,
+        )
+        self.assertCurrentUser(AnonymousUser())

tests/settings.py

@@ -0,0 +1,8 @@
+import debug_toolbar
+from django.urls import include, path
+
+app_name = 'test'
+
+urlpatterns = (
+    path('__debug__', include(debug_toolbar.urls)),
+)