Created test for dashboard (#105)

Author: CheatCodeSam

.gitignore

@@ -22,3 +22,5 @@ build/
 
 test/*.db
 test/meta
+
+*.db

config.py

@@ -16,8 +16,8 @@
 
 import os
 
-from utils import env
-from distutils.util import strtobool
+from utils import env, strtobool
+
 
 # Application Name
 #
@@ -105,4 +105,4 @@
     'scope': 'user:login,name',
 }
 
-PASSCODE_LENGTH = env('MIN_PASSCODE_LENGTH', 6)
+PASSCODE_LENGTH = env('MIN_PASSCODE_LENGTH', 6)

console

@@ -71,7 +71,7 @@ if __name__ == "__main__":
         exit()
 
     if args.sync:
-        from config import META, DATABASE_URL
+        from config import DATABASE_URL, META
         from elekto.models import meta
         from elekto.models.sql import create_session
         from elekto.models.utils import sync

elekto/models/sql.py

@@ -17,8 +17,7 @@
 import uuid
 import sqlalchemy as S
 
-from sqlalchemy.orm import sessionmaker, scoped_session
-from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker, scoped_session, declarative_base
 from sqlalchemy.types import TypeDecorator, CHAR
 from sqlalchemy import event
 
@@ -88,10 +87,11 @@ def update_schema(engine, schema_version):
 
     if db_schema.has_table("election"):
         if db_schema.has_table("schema_version"):
-            db_version = engine.execute('select version from schema_version').scalar()
-            if db_version is None:
-                """ intialize the table, if necessary """
-                engine.execute('insert into schema_version ( version ) values ( 2 )')
+            with engine.connect() as connection:
+                db_version = connection.execute(S.text('select version from schema_version')).scalar()
+                if db_version is None:
+                    """ intialize the table, if necessary """
+                    connection.execute(S.text('insert into schema_version ( version ) values ( 2 )'))
     else:
         """ new, empty db """
         return schema_version
@@ -104,7 +104,7 @@ def update_schema(engine, schema_version):
             db_version = update_schema_2(engine)
             continue
 
-    return db_version;
+    return db_version
 
 
 def update_schema_2(engine):
@@ -131,6 +131,9 @@ def update_schema_2(engine):
 
     return 2
 
+def drop_all(url: str):
+    engine = S.create_engine(url)
+    BASE.metadata.drop_all(bind=engine)
 
 class UUID(TypeDecorator):
     """Platform-independent UUID type.
@@ -175,7 +178,7 @@ class Version(BASE):
 
 @event.listens_for(Version.__table__, 'after_create')
 def create_version(target, connection, **kwargs):
-    connection.execute(f"INSERT INTO schema_version ( version ) VALUES ( {schema_version} )")
+    connection.execute(S.text(f"INSERT INTO schema_version ( version ) VALUES ( {schema_version} )"))
 
 class User(BASE):
     """

requirements.txt

@@ -23,6 +23,7 @@ psycopg2==2.9.10
 pycparser==2.22
 pynacl==1.5.0
 pytest==8.3.4
+pytest-mock==3.14.0
 python-dateutil==2.9.0.post0
 python-dotenv==1.0.1
 pytz==2024.2

test/test_controllers_elections.py

@@ -0,0 +1,62 @@
+from datetime import datetime, timedelta
+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
+
+@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"
+    with APP.app_context():
+        SESSION.add(User(username="carson",
+                             name="Carson Weeks",
+                             token=token,
+                             token_expires_at=datetime.max))
+        SESSION.commit()
+    with client.session_transaction() as session:
+        session[constants.AUTH_STATE] = token
+    response = client.get("/app")
+    assert response.status_code == 200
+    assert b'Welcome! Carson Weeks' in response.data
+    assert b'Sit back and Relax, there is not to do yet.' in response.data
+
+def test_unauthenticated_dashboard(client: FlaskClient):
+    with client.session_transaction() as session:
+        session[constants.AUTH_STATE] = None
+    response = client.get("/app")
+    assert response.status_code == 302
+
+def test_elections_running_dashboard(client: FlaskClient, mocker: MockerFixture):
+    mocker.patch("elekto.meta.Election.where", return_value=[{"name": "Demo Election", 
+                                                              "organization": "kubernetes", 
+                                                              "start_datetime": datetime.min, 
+                                                              "end_datetime": datetime.max}])
+    token="token"
+    with APP.app_context():
+        SESSION.add(User(username="carson",
+                             name="Carson Weeks",
+                             token=token,
+                             token_expires_at=datetime.max))
+        SESSION.commit()
+    with client.session_transaction() as session:
+        session[constants.AUTH_STATE] = token
+    response = client.get("/app")
+    assert response.status_code == 200
+    assert b"Demo Election" in response.data 
+    assert not b"Sit back and Relax, there is not to do yet." in response.data

test/test_core_init.py

@@ -37,7 +37,6 @@ def test_schulze_d():
     }
 
     result = schulze_d(candidates, ballots)
-    print(result)
     assert result == expected_d
 
 def test_schulze_p():
@@ -67,7 +66,6 @@ def test_schulze_p():
     }
 
     result = schulze_p(candidates, d)
-    print(result)
     assert result == expected_p
 
 def test_schulze_rank_simple():

utils.py

@@ -18,9 +18,15 @@
 from dotenv import load_dotenv, set_key
 
 # Load the custom environment file into the program
-targetenv = '.env.testing' if os.getenv('TESTING') else '.env'
-load_dotenv(os.path.join(os.path.dirname(__file__), targetenv))
+isTesting = os.getenv('TESTING') or "PYTEST_VERSION" in os.environ
+targetenv = ".env.testing" if isTesting else ".env"
+load_dotenv(os.path.join(os.path.dirname(__file__), targetenv), override=True)
 
+def strtobool(value: str) -> bool:
+  value = value.lower()
+  if value in ("y", "yes", "on", "1", "true", "t"):
+    return True
+  return False
 
 def generate_app_key():
     key = os.urandom(32).hex()