Refactor: models (#148)

data/server.csv

@@ -1,6 +1,7 @@
-A1234567;Garcia;['type1']
-B2345678;Hernandez;['type2']
-C3456789;Smith;[]
-D4567890;Jones;['type1', 'type2']
-a93ef111829829ea5038398ba6583dc2e1a2f2c309e24aee535f725dbe1f1250;2c3aaefea8267c66822f6edc0e42d9b7384695f9c0407eabda141770aab8901e;['type1']
-095feaba889222ee1bc97aaf3bb89c90c21238fb556fb48b5cc54760461ea18ce814d016e70b1929d05190edbec1032e07921228fcb61ad3417aaff0abd9d082;123c86e1f2ac255ba31f1ad742defe23d194269669d2aac0d2572e20e9378e395976f84db305caeba1f91e7996463031d4c49365a7a9f4c7dc404873ad330974;['type1']
+A1234567;Garcia;type1
+B2345678;Hernandez;type2
+C3456789;Smith;
+D4567890;Jones;type1
+D4567890;Jones;type2
+a93ef111829829ea5038398ba6583dc2e1a2f2c309e24aee535f725dbe1f1250;2c3aaefea8267c66822f6edc0e42d9b7384695f9c0407eabda141770aab8901e;type1
+095feaba889222ee1bc97aaf3bb89c90c21238fb556fb48b5cc54760461ea18ce814d016e70b1929d05190edbec1032e07921228fcb61ad3417aaff0abd9d082;123c86e1f2ac255ba31f1ad742defe23d194269669d2aac0d2572e20e9378e395976f84db305caeba1f91e7996463031d4c49365a7a9f4c7dc404873ad330974;type1

eligibility_server/db/models.py

@@ -1,11 +1,26 @@
 from eligibility_server.db import db
 
 
+user_eligibility = db.Table(
+    "user_eligibility",
+    db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
+    db.Column("eligibility_id", db.Integer, db.ForeignKey("eligibility.id"), primary_key=True),
+)
+
+
+class Eligibility(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String, unique=True, nullable=False)
+
+    def __repr__(self):
+        return f"<Eligibility {self.name}>"
+
+
 class User(db.Model):
     id = db.Column(db.Integer, primary_key=True)
     sub = db.Column(db.String, unique=True, nullable=False)
     name = db.Column(db.String, unique=True, nullable=False)
-    types = db.Column(db.String, unique=False, nullable=False)
+    types = db.relationship("Eligibility", secondary=user_eligibility, lazy="subquery", backref=db.backref("users", lazy=True))
 
     def __repr__(self):
-        return "<User %r>" % self.sub
+        return f"<User {self.sub}>"

eligibility_server/db/setup.py

@@ -6,7 +6,7 @@
 from flask_sqlalchemy import inspect
 
 from eligibility_server.db import db
-from eligibility_server.db.models import User
+from eligibility_server.db.models import User, Eligibility
 from eligibility_server.settings import Configuration
 
 
@@ -50,7 +50,7 @@ def import_users():
         with open(file_path) as file:
             data = json.load(file)["users"]
             for user in data:
-                save_users(user, data[user][0], str(data[user][1]))
+                save_users(user, data[user][0], data[user][1])
     elif file_format == "csv":
         with open(file_path, newline=config.csv_newline, encoding="utf-8") as file:
             data = csv.reader(
@@ -60,24 +60,32 @@ def import_users():
                 quotechar=config.csv_quotechar,
             )
             for user in data:
-                save_users(user[0], user[1], user[2])
+                # lists are expected to be a comma-separated value and quoted if the CSV delimiter is a comma
+                types = [type.replace(config.csv_quotechar, "") for type in user[2].split(",") if type]
+                save_users(user[0], user[1], types)
     else:
         click.echo(f"Warning: File format is not supported: {file_format}")
 
     click.echo(f"Users added: {User.query.count()}")
+    click.echo(f"Eligibility types added: {Eligibility.query.count()}")
 
 
-def save_users(sub: str, name: str, types: str):
+def save_users(sub: str, name: str, types):
     """
     Add users to the database User table
 
     @param sub - User's sub
     @param name - User's name
-    @param types - Types of eligibilities, in a stringified list
+    @param types - Types of eligibilities, in the form of a list of strings
     """
 
-    item = User(sub=sub, name=name, types=types)
-    db.session.add(item)
+    user = User.query.filter_by(sub=sub, name=name).first() or User(sub=sub, name=name)
+    eligibility_types = [Eligibility.query.filter_by(name=type).first() or Eligibility(name=type) for type in types]
+    user.types.extend(eligibility_types)
+
+    db.session.add(user)
+    db.session.add_all(eligibility_types)
+
     db.session.commit()
 
 
@@ -90,9 +98,14 @@ def drop_db_command():
             try:
                 click.echo(f"Users to be deleted: {User.query.count()}")
                 User.query.delete()
-                db.session.commit()
+
+                click.echo(f"Eligibility types to be deleted: {Eligibility.query.count()}")
+                Eligibility.query.delete()
+
             except Exception as e:
-                click.echo("Failed to query for Users", e)
+                click.echo(f"Failed to query models. Exception: {e}", err=True)
+
+            db.session.commit()
 
             db.drop_all()
             click.echo("Database dropped.")

eligibility_server/settings.py

@@ -41,7 +41,7 @@
 CSV_DELIMITER = ";"
 CSV_NEWLINE = ""
 CSV_QUOTING = 3
-CSV_QUOTECHAR = ""
+CSV_QUOTECHAR = '"'
 
 
 class Configuration:

eligibility_server/verify.py

@@ -2,7 +2,6 @@
 Eligibility Verification route
 """
 
-import ast
 import datetime
 import json
 import logging
@@ -140,7 +139,7 @@ def _check_user(self, sub, name, types):
 
         existing_user = User.query.filter_by(sub=sub, name=name).first()
         if existing_user:
-            existing_user_types = ast.literal_eval(existing_user.types)
+            existing_user_types = [type.name for type in existing_user.types]
         else:
             existing_user_types = []
 

tests/conftest.py

@@ -13,3 +13,8 @@ def flask():
 @pytest.fixture
 def client():
     return app.test_client()
+
+
+@pytest.fixture()
+def runner():
+    return app.test_cli_runner()

tests/db/test_setup.py

@@ -0,0 +1,42 @@
+import pytest
+
+from flask_sqlalchemy import inspect
+from eligibility_server.db import db
+from eligibility_server.db.models import Eligibility, User
+
+
+@pytest.mark.usefixtures("flask")
+def test_init_db_command(runner):
+    """Assumes that IMPORT_FILE_PATH is data/server.csv."""
+    runner.invoke(args="drop-db")
+
+    result = runner.invoke(args="init-db")
+
+    assert result.exit_code == 0
+
+    assert User.query.count() == 6
+    assert Eligibility.query.count() == 2
+
+    user_with_one_eligibility = User.query.filter_by(sub="A1234567", name="Garcia").first()
+    type1_eligibility = Eligibility.query.filter_by(name="type1").first()
+    assert user_with_one_eligibility.types == [type1_eligibility]
+
+    user_with_no_eligibility = User.query.filter_by(sub="C3456789", name="Smith").first()
+    assert user_with_no_eligibility.types == []
+
+    user_with_multiple_eligibilities = User.query.filter_by(sub="D4567890", name="Jones").first()
+    type2_eligibility = Eligibility.query.filter_by(name="type2").first()
+    assert user_with_multiple_eligibilities.types == [type1_eligibility, type2_eligibility]
+
+
+@pytest.mark.usefixtures("flask")
+def test_drop_db_command(runner):
+    result = runner.invoke(args="drop-db")
+
+    assert result.exit_code == 0
+
+    inspector = inspect(db.engine)
+    assert inspector.get_table_names() == []
+
+    # temp fix to ensure database tests are idempotent - later tests need the database to exist
+    runner.invoke(args="init-db")