Increase test coverage to 97% (#108)

* OPT: added tests for middlewares

* OPT: added tests for models

* OPT: added tests for controllers

* OPT: encryption is now mocked during tests, significantly speeding up the test suite

* OPT: election metadata for unit tests is now loaded from a static zip rather than the local filesystem

* OPT: tests can now also run in a container

* NEW: added test workflow for pull requests

Author: oduludo

.github/workflows/test.yml

@@ -0,0 +1,10 @@
+name: Run tests
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: make test-docker-notty

Dockerfile

@@ -1,11 +1,20 @@
-FROM python:3.11-bookworm
+FROM python:3.11-bookworm AS base
 
 WORKDIR /app
 
-ADD . /app
-
+ADD requirements.txt /app
 RUN pip install -r requirements.txt
 
+ADD . /app
+
 USER 10017
 
-ENTRYPOINT ./entrypoint.sh
+ENTRYPOINT ["./entrypoint.sh"]
+
+FROM base AS test
+
+RUN mkdir /tmp/app
+RUN touch /tmp/app/test.db
+ENV DB_PATH=/tmp/app/test.db
+
+CMD ["./test-entrypoint.sh"]

Makefile

@@ -3,7 +3,7 @@ PIP:=venv/bin/pip
 PYTEST:=venv/bin/py.test
 COV:=venv/bin/coverage
 
-.PHONY: clean venv run test cov
+.PHONY: clean venv run test cov test-build test-docker
 clean:
 	rm -rf venv
 
@@ -21,3 +21,12 @@ cov:
 	$(COV) run -m pytest test || true
 	$(COV) html
 	open htmlcov/index.html
+
+test-build:
+	docker build . -t elekto-test --target test
+
+test-docker: test-build
+	docker run -it --rm --entrypoint=./test-entrypoint.sh elekto-test
+
+test-docker-notty: test-build
+	docker run --rm --entrypoint=./test-entrypoint.sh elekto-test

docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  db:
+    image: postgres
+    restart: always
+    environment:
+      POSTGRES_DB: elekto
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: root
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    ports:
+      - '5432:5432'
+
+volumes:
+  pgdata:

elekto/controllers/authentication.py

@@ -103,7 +103,12 @@ def oauth_github_redirect():
     if resp.status_code != 200:
         F.g.user = None
         F.g.auth = False
-        F.session.pop(constants.AUTH_STATE)
+
+        # If GitHub couldn't fetch the user (who just now granted Elekto access to their GitHub profile), try to flush
+        # the auth state from the session. Likely this isn't set, so a membership test is performed before doing the
+        # pop(...) call.
+        if constants.AUTH_STATE in F.session.keys():
+            F.session.pop(constants.AUTH_STATE)
     else:
         data = resp.json()
         expries = datetime.now() + timedelta(days=1)

elekto/controllers/elections.py

@@ -292,6 +292,8 @@ def elections_admin_review(eid, rid):
         .filter(Request.id == rid)
         .first()
     )
+    # TODO: Check if a Request was found to prevent rendering errors. If the `rid` does not lead to a Request for this
+    #  Election, send the user to another page (the exact location has to be discussed).
 
     if F.request.method == "POST":
         req.reviewed = False if req.reviewed else True

elekto/controllers/webhook.py

@@ -31,4 +31,5 @@ def webhook_sync():
         backend.clone()
     else:
         backend.pull()
+    # FIXME: sync(...) returns a string, not a response.
     return sync(SESSION, meta.Election.all())

elekto/middlewares/__init__.py

@@ -66,5 +66,3 @@ def decorated_function(*args, **kwargs):
                 return F.redirect(F.request.url)
         return f(*args, **kwargs)
     return decorated_function
-
-

elekto/middlewares/auth.py

@@ -136,6 +136,8 @@ def voters(self):
         return utils.parse_yaml(os.path.join(self.path, Election.VOT))
 
     def showfields(self):
+        # FIXME: show_candidate_fields could be None (as is the case in the name_the_app example meta), leading to an
+        #  error if showfields() is called. See: https://github.com/elekto-io/elekto/issues/98
         return dict.fromkeys(self.election['show_candidate_fields'], '')
 
     def candidates(self):