Improve test coverage (#107)

* OPT: restructured test directory in preparation of extra unit tests, added tests for encryption and decryption logic

* OPT: improved test coverage of elekto/core module

* NEW: added some tooling to bootstrap testing

* OPT: added unit test instructions to the README

Author: oduludo

.gitignore

@@ -1,5 +1,7 @@
 .vscode
+.idea
 .venv/
+venv/
 
 # Cache files and directories
 *.pyc

Makefile

@@ -0,0 +1,23 @@
+PYTHON:=venv/bin/python
+PIP:=venv/bin/pip
+PYTEST:=venv/bin/py.test
+COV:=venv/bin/coverage
+
+.PHONY: clean venv run test cov
+clean:
+	rm -rf venv
+
+venv: clean
+	python3.11 -m venv venv
+	$(PIP) install -r requirements.txt
+
+run:
+	$(PYTHON) console --run
+
+test:
+	$(PYTEST) test
+
+cov:
+	$(COV) run -m pytest test || true
+	$(COV) html
+	open htmlcov/index.html

README.md

@@ -102,6 +102,13 @@ python console --run
 python console --port 8080 --host 0.0.0.0 --run
 ```
 
+### Running tests
+Commands are available to run the test suite. This suite currently only consists of unit tests. A prerequisite for 
+running the test suite is that you have a virtualenv setup. This can be done by running `make venv`. To run the tests,
+do `make test`.
+
+Coverage is available. A report can be generated with `make cov`.
+
 ### Contact Us
 
 See the website at [Elekto.dev](https://elekto.dev).

elekto/core/election.py

@@ -14,12 +14,19 @@
 #
 # Author(s):         Manish Sahani <[email protected]>
 
-from typing import List
+from typing import TYPE_CHECKING, List
 from .types import BallotType
 from pandas import DataFrame
 from elekto.core import schulze_d, schulze_p, schulze_rank
 
+if TYPE_CHECKING:
+    from models.sql import Ballot
+
+
 class Election:
+    NO_OPINION = 'No opinion'
+    MAX_RANK = 100_000_000
+
     def __init__(self, candidates: List[str], ballots: BallotType, no_winners=1):
         self.candidates = candidates
         self.ballots = ballots
@@ -35,14 +42,14 @@ def schulze(self):
         return self
 
     @ staticmethod
-    def build(candidates, ballots):
+    def build(candidates: list[dict], ballots: list['Ballot']):
         candidates = [c['ID'] for c in candidates]
         pref = {}
 
         for b in ballots:
             if b.voter not in pref.keys():
                 pref[b.voter] = []
-            if b.rank == 100000000:
+            if b.rank == Election.MAX_RANK:
                 continue
             pref[b.voter].append((b.candidate, int(b.rank)))
 
@@ -56,7 +63,7 @@ def from_csv(df: DataFrame, no_winners: int):
         for v, row in df.iterrows():
             ballots[v] = []
             for c in candidates:
-                if row[c] == 'No opinion':
+                if row[c] == Election.NO_OPINION:
                     continue
                 ballots[v].append((c, int(row[c])))
 

requirements.txt

@@ -4,7 +4,9 @@ certifi==2024.12.14
 cffi==1.17.1
 charset-normalizer==3.4.1
 click==8.1.8
+coverage==7.8.0
 cryptography==44.0.0
+factory_boy==3.3.3
 flask==3.1.0
 flask-wtf==1.2.2
 greenlet==3.1.1

test/conftest.py

@@ -0,0 +1,39 @@
+import os
+
+import pytest
+
+from elekto import APP, SESSION
+from elekto.models.sql import drop_all, migrate
+
+from test.factories import ElectionFactory, BallotFactory
+
+
+@pytest.fixture(scope="module", autouse=True)
+def reset_db():
+    with APP.app_context():
+        drop_all(APP.config.get('DATABASE_URL'))
+
+
+@pytest.fixture()
+def client():
+    with APP.app_context():
+        migrate(APP.config.get('DATABASE_URL'))
+        yield APP.test_client()
+        SESSION.close()
+        drop_all(APP.config.get('DATABASE_URL'))
+
+
+@pytest.fixture()
+def salt() -> bytes:
+    return os.urandom(16)
+
+
+@pytest.fixture()
+def db_session():
+    return SESSION
+
+
+@pytest.fixture(autouse=True)
+def db_factories(db_session):
+    ElectionFactory._meta.sqlalchemy_session = db_session
+    BallotFactory._meta.sqlalchemy_session = db_session

test/controllers/__init__.py

@@ -1,25 +1,10 @@
-from datetime import datetime, timedelta
+from datetime import datetime
 from flask.testing import FlaskClient
-import pytest
 from pytest_mock import MockerFixture
 
 from elekto import APP, SESSION, constants
-from elekto.models import meta
-from elekto.models.sql import User, drop_all, migrate
+from elekto.models.sql import User
 
-@pytest.fixture(scope="module", autouse=True)
-def reset_db():
-    with APP.app_context():
-        drop_all(APP.config.get('DATABASE_URL'))
-
-
-@pytest.fixture()
-def client():
-    with APP.app_context():
-        migrate(APP.config.get('DATABASE_URL'))
-        yield APP.test_client()
-        SESSION.close() 
-        drop_all(APP.config.get('DATABASE_URL'))
 
 def test_dashboard(client: FlaskClient):
     token="token"