[WIP] Gherkin feature suite

.behaverc

@@ -0,0 +1,27 @@
+[behave]
+; We are not using the default path to leave room for unit tests ; also, apps.
+paths = tests/acceptance
+
+# What is going on?  Does this change anything for you? --format=plain works
+;format = plain
+
+; Perhaps we want some of those?
+;logging_clear_handlers = yes
+;logging_filter = -suds
+
+; Show all print() statements even if tests pass. (bugs! bugs!)
+stderr_capture = False
+stdout_capture = False
+log_capture = False
+
+
+show_timings = False
+show_source = False
+show_multiline = True
+show_skipped = False
+show_snippets = False
+summary = True
+
+[behave.formatters]
+# We override the buggy "pretty" formatter
+pretty = tests.acceptance.formatter:BeautifulFormatter

.github/ISSUE_TEMPLATE.md

@@ -3,8 +3,8 @@
 
 ### Version
 
-#### Expected
+### Expected
 
-#### Actual
+### Actual
 
 ### Additional Details

.gitignore

@@ -3,8 +3,6 @@
 *.mo
 .#*
 
-backup
-
 # Python
 __pycache__/
 .mypy_cache
@@ -14,9 +12,15 @@ __pycache__/
 # Local (secret) configuration
 /.env.local
 
+# Backup
+backup
+
 # Databases (dumps?)
 test.db
 main.db
 
+# Operating System
+.directory
+
 # IDE
 /.idea/

INSTALL.md

@@ -0,0 +1,69 @@
+# Install
+
+## Install using Docker
+
+> see root README
+
+---
+
+## Install using virtualenv
+
+> It's usually less painful to install using Docker instead.
+
+
+### Install the required packages
+
+
+#### Ubuntu & Debian
+
+
+    sudo apt install python3 python3-dev virtualenv
+    sudo apt install postgresql-server-dev-all
+
+
+### Set up a virtualenv
+
+    virtualenv .venv --python=python3
+    source .venv/bin/activate
+
+
+### Install Python dependencies
+
+    pip install -r requirements.txt
+
+
+### Configure your instance
+
+    cp .env .env.local
+    nano .env.local
+    …
+    source .env.local
+
+
+### Bootstrap PostgreSQL Database
+
+    sudo -u postgres psql
+    postgres=# ALTER USER postgres PASSWORD 'MyNotSoSecretPassword';
+    postgres=# CREATE DATABASE mvapi;
+    python manage.py migrate
+
+
+### Create an Admin user
+
+    python manage.py createsuperuser
+
+
+### Develop 
+
+To run each time you're setting up your shell.
+
+    source .venv/bin/activate
+    source env.local
+    python manage.py runserver
+
+Visit http://localhost:8000/admin
+
+
+### Test
+
+    python manage.py behave

README.md

@@ -33,6 +33,10 @@ You certainly want to apply the database migrations with:
     ./docker/test.sh
 
 
+## Create databases migrations
+
+    sudo ./docker/makemigrations.sh
+
 
 ## Local development
 

app/crud.py

@@ -227,7 +227,7 @@ def _check_if_ref_exists(db: Session, ref: str):
 
 
 def create_election(
-    db: Session, election: schemas.ElectionCreate
+    db: Session, election: schemas.ElectionCreate,
 ) -> schemas.ElectionGet:
     # We create first the election
     # without candidates and grades
@@ -236,7 +236,7 @@ def create_election(
         raise errors.InconsistentDatabaseError("Can not create election")
     election_ref = str(db_election.ref)
 
-    # Then, we add separatly candidates and grades
+    # Then, we add separately candidates and grades
     for candidate in election.candidates:
         params = candidate.model_dump()
         candidate = schemas.CandidateCreate(**params)

app/database.py

@@ -1,7 +1,9 @@
 from __future__ import annotations
+
+from contextvars import ContextVar
 from urllib.parse import quote
 from sqlalchemy import create_engine
-from sqlalchemy.orm import sessionmaker, declarative_base
+from sqlalchemy.orm import sessionmaker, declarative_base, Session
 from .settings import settings
 
 
@@ -19,7 +21,7 @@
     engine = create_engine(database_url)
 
 SessionLocal: sessionmaker = sessionmaker(  # type: ignore
-    autocommit=False, autoflush=False, bind=engine
+    autocommit=False, autoflush=False, bind=engine,
 )
 
 Base = declarative_base()
@@ -31,3 +33,5 @@ def get_db():
         yield db
     finally:
         db.close()
+
+db_session: ContextVar[Session] = ContextVar('db_session')

app/main.py

@@ -77,7 +77,7 @@ async def inconsistent_database_exception_handler(
     return JSONResponse(
         status_code=500,
         content={
-            "message": f"A serious error has occured with {exc.name}. {exc.details or ''}"
+            "message": f"A serious error has occurred with {exc.name}. {exc.details or ''}"
         },
     )
 

app/settings.py

@@ -3,7 +3,10 @@
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 class Settings(BaseSettings):
-    model_config = SettingsConfigDict(env_file=".env", extra="ignore")	
+    model_config = SettingsConfigDict(
+        env_file=".env.local",
+        extra="ignore",
+    )
 
     sqlite: bool = False
 

requirements-dev.txt

@@ -6,4 +6,23 @@ alembic==1.8.1
 types-python-jose==3.3.4
 types-python-dateutil==2.8.2
 mypy==1.15.0
-httpx>=0.22.0
+httpx>=0.22.0
+
+# Test Runners
+#nose==1.3.7
+behave==1.2.6
+#django-nose==1.4.6
+#behave-django==1.3.0
+
+# Assertion library
+pyhamcrest==2.0.2
+#git+git://github.com/domi41/PyHamcrest@hack-i18n#egg=pyhamcrest
+
+# Test Metrics
+coverage>=4.5.1
+
+# Natural Language Processor for numbers
+text2num>=2.2.0
+
+# Markup language for humans
+#PyYAML==5.3.1

requirements.txt

@@ -4,6 +4,6 @@ sqlalchemy==2.0.40
 pydantic==2.11.3
 psycopg2==2.9.5
 git+https://github.com/MieuxVoter/majority-judgment-library-python
-python-jose==3.3.0
+python-jose==3.4.0
 python-dateutil==2.8.2
-pydantic-settings==2.9.1
+pydantic-settings==2.9.1

tests/acceptance/README.md

@@ -0,0 +1,4 @@
+
+Run all scenarios except the ones tagged with `@wip`:
+
+    python manage.py behave --no-skipped --tags=~@wip

tests/acceptance/environment.py

@@ -0,0 +1,66 @@
+"""
+Environment module for acceptance testing of the scenaristic constitution.
+https://behave.readthedocs.io/en/latest/api.html#environment-file-functions
+"""
+
+from behave.runner import Context
+from locale import setlocale, LC_TIME
+
+from steps.context_main import reset_context as reset_main_context
+from steps.tools_i18n import guess_locale
+
+
+# Since we expect most of our step defs to require the flexibility of regular
+# expressions (I18N, epicene) we make regular expressions the default.
+# This is at the expense of automatic type casting of step variables.
+from behave import use_step_matcher
+use_step_matcher("re")
+# You can still override this right before your step def if you want,
+# by calling use_step_matcher() with one of the following:
+# "parse" (factory default), "cfparse"
+# and calling it again with "re" after your step def.  (it uses a `global`)
+
+
+def before_all(context: Context):
+    """
+    Ran before the whole shooting match.
+    """
+    pass
+
+
+def before_feature(context, feature):
+    """
+    Ran before _each_ feature file is exercised.
+    """
+    context_locale = guess_locale(context)
+    setlocale(LC_TIME, "%s.UTF-8" % context_locale)
+    # REQUIRES CUSTOM FORK OF HAMCREST
+    # from hamcrest import set_locale as set_hamcrest_locale
+    # set_hamcrest_locale(context_locale)
+    ##################################
+
+
+def before_scenario(context, scenario):
+    """
+    Ran before _each_ scenario is run.
+    """
+    reset_main_context(context)
+    pass
+
+
+def after_scenario(context, scenario):
+    """
+    Ran after _each_ scenario is run.
+    """
+    pass
+
+
+def after_step(context, step):
+    """
+    Ran after _each_ step is run.
+    """
+    pass
+
+
+def django_ready(context):
+    context.django = True