Run the entire test suite using pytest (#109)

* move conftest

* cleanup tests
    load fixtures declaratively
    we don't need to call_command('loaddata') by hand
    remove unused imports

* test config

* fix user model
    Django's ORM internally expects this to be a method, not a property
    https://docs.djangoproject.com/en/3.0/ref/models/instances/#get-absolute-url

    Making it a property causes django to throw
    `TypeError: 'str' object is not callable`
    when creating a link to a user object

* run pytest in CI, remove standalone manage container
    - run pytest in CI
    - scrap the standalone manage container
    - run console commands against app container
    - update docs

Author: chris48s

.github/workflows/test.yml

@@ -17,18 +17,10 @@ jobs:
       - name: Run application
         run: docker-compose up -d web
 
-      - name: Test Resources
-        run: docker-compose run --rm manage test resources
-        if: always()
-
-      - name: Test Users
-        run: docker-compose run --rm manage test users
-        if: always()
-
-      - name: Test UserAuth
-        run: docker-compose run --rm manage test userauth
+      - name: Run test suite
+        run: docker-compose run -T --rm app pytest -v
         if: always()
 
       - name: Check Migrations are up-to-date
-        run: docker-compose run --rm manage makemigrations --check
+        run: docker-compose run -T --rm app ./manage.py makemigrations --check
         if: always()

README.md

@@ -59,7 +59,7 @@ To stop the application and remove all containers, run the following.
 docker-compose down
 ```
 
-5. Create a superuser so that you can log into http://localhost:8000/admin by running the following in your terminal: `$ docker-compose run --rm manage createsuperuser`
+5. Create a superuser so that you can log into http://localhost:8000/admin by running the following in your terminal: `$ docker-compose run --rm app ./manage.py createsuperuser`
 
 ## Editing Code
 
@@ -89,17 +89,22 @@ If you would like to tail the logs in the console then you remove the detach fla
 
 The following are examples of some common Django management commands that you may need to run.
 
-* Make Migrations: `docker-compose run --rm manage makemigrations`
-* Merge Migrations: `docker-compose run --rm manage makemigrations --merge`
-* Run Migrations: `docker-compose run --rm manage`
-* Test: `docker-compose run --rm manage test`
+* Make Migrations: `docker-compose run --rm app ./manage.py makemigrations`
+* Merge Migrations: `docker-compose run --rm app ./manage.py makemigrations --merge`
+* Run Migrations: `docker-compose run --rm app ./manage.py migrate`
 
 To see the full list of management commands use `help`.
 
 ```plain
-docker-compose run --rm manage help
+docker-compose run --rm app ./manage.py help
 ```
 
+### Automated Tests
+
+* We use [pytest](https://docs.pytest.org/en/latest/contents.html) with the [pytest-django](https://pytest-django.readthedocs.io/en/latest/) plugin for running tests.
+* Please add tests for your code when contributing.
+* Run the test suite using `docker-compose run --rm app pytest`
+
 ### Import Postman collection
 Postman is a free interactive tool for verifying the APIs of your project. You can download it at postman.com/downloads.
 

docker-compose.yaml

@@ -33,6 +33,7 @@ services:
       sh -c "python /opt/codebuddies/manage.py collectstatic --clear --no-input &&
              python /opt/codebuddies/manage.py migrate &&
              uwsgi --ini /opt/codebuddies/uwsgi.ini"
+    working_dir: /opt/codebuddies
     volumes:
       - ./project:/opt/codebuddies
     environment:
@@ -76,18 +77,3 @@ services:
     restart: on-failure
     ports:
       - 8025:8025
-
-  # Manager allows you to run Django management tasks on the application.
-  manage:
-    container_name: manage
-    restart: on-failure
-    build: ./project
-    command: shell
-    entrypoint: /usr/local/bin/python3 /opt/codebuddies/manage.py
-    volumes:
-      - ./project:/opt/codebuddies
-    environment:
-      - DATABASE_URL=postgres://babyyoda:mysecretpassword@db:5432/codebuddies
-      - EMAIL_HOST=mailhog
-    depends_on:
-      - db

project/config/settings/test.py

@@ -14,8 +14,6 @@
     "DJANGO_SECRET_KEY",
     default="AcnZMguCngDeMgbwXf6l9d2arow2lU9ZkDweNnoCZmZ2qH6pinB4tLhEYI4Fgf6Y",
 )
-# https://docs.djangoproject.com/en/dev/ref/settings/#test-runner
-TEST_RUNNER = "django.test.runner.DiscoverRunner"
 
 # CACHES
 # ------------------------------------------------------------------------------
@@ -27,11 +25,6 @@
     }
 }
 
-# PASSWORDS
-# ------------------------------------------------------------------------------
-# https://docs.djangoproject.com/en/dev/ref/settings/#password-hashers
-PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"]
-
 # TEMPLATES
 # ------------------------------------------------------------------------------
 TEMPLATES[0]["OPTIONS"]["loaders"] = [  # noqa F405

project/core/conftest.py renamed to project/conftest.py

@@ -140,19 +140,19 @@ <h2>Application urls</h2>
       <h2>docker-compose commands</h2>
       <ul>
         <li>
-          <code>docker-compose run --rm manage createsuperuser</code> - Command
+          <code>docker-compose run --rm app ./manage.py createsuperuser</code> - Command
           to create a superuser
         </li>
         <li>
-          <code>docker-compose run --rm manage tests</code>- Command to run
+          <code>docker-compose run --rm app pytest</code> - Command to run
           tests
         </li>
         <li>
-          <code>docker-compose run --rm makemigrations</code> - Command to make
+          <code>docker-compose run --rm app ./manage.py makemigrations</code> - Command to make
           migrations (necessary if you change the models)
         </li>
         <li>
-          <code>docker-compose run --rm migrate</code> - Command to migrate the
+          <code>docker-compose run --rm app ./manage.py migrate</code> - Command to migrate the
           migrations (necessary if you ran the previous makemigrations step)
         </li>
       </ul>

project/core/templates/base.html

@@ -0,0 +1,5 @@
+[pytest]
+python_files = tests.py test_*.py *_tests.py
+norecursedirs = staticfiles .git templates __pycache__
+DJANGO_SETTINGS_MODULE = config.settings.test
+FAIL_INVALID_TEMPLATE_VARS = 1

project/pytest.ini

@@ -1,19 +1,20 @@
-from rest_framework import status, serializers
+from rest_framework import status
 from rest_framework.test import APITestCase
 from rest_framework_jwt.settings import api_settings
-from django.core.management import call_command
 
 jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
 jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
 
 class ResourcesTests(APITestCase):
 
-    def setUp(self):
-        call_command('loaddata', 'users.json', verbosity=0)
-        call_command('loaddata', 'resources.json', verbosity=0)
-        call_command('loaddata', 'tagging.json', verbosity=0)
-        call_command('loaddata', 'taggeditems.json', verbosity=0)
+    fixtures = [
+        'users',
+        'resources',
+        'tagging',
+        'taggeditems'
+    ]
 
+    def setUp(self):
         url = '/auth/obtain_token/'
         #to do:  choose a user at random from loaded users.json
         data = {"username": "JuJu", "password": "codebuddies"}

project/resources/tests.py

@@ -1,9 +1,7 @@
-import unittest
 from unittest.mock import patch
 from rest_framework import status, serializers
 from rest_framework.test import APITestCase
 from rest_framework_jwt.settings import api_settings
-from django.core.management import call_command
 from django.contrib.auth import get_user_model
 
 
@@ -12,14 +10,16 @@
 
 class UserauthTests(APITestCase):
 
+    fixtures = ['users']
+
     def setUp(self):
-        """
-        Loads users.json fixture into test DB and directly creates a new user.
-        """
-        call_command('loaddata', 'users.json', verbosity=0)
+        # create a new user
         model = get_user_model()
-        self.person = model.objects.create_user(username='PetuniaPig', email='[email protected]',
-                                           password='codebuddies')
+        self.person = model.objects.create_user(
+            username='PetuniaPig',
+            email='[email protected]',
+            password='codebuddies'
+        )
 
 
     def test_jwt_not_authed(self):

project/userauth/tests.py

@@ -10,6 +10,5 @@ class User(AbstractUser):
     # around the globe.
     name = CharField(_("Name of User"), blank=True, max_length=255)
 
-    @property
     def get_absolute_url(self):
         return reverse("users:detail", kwargs={"username": self.username})