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`
 
 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