feat: add database seed commands (#11)

* feat: add faker dependency
* feat: seed admin user
* feat: seed database quotes

Author: miguel-osuna

Pipfile

@@ -18,6 +18,7 @@ bpython = "==0.22.1"
 ipdb = "==0.13.9"
 ptvsd = "==4.3.2"
 debugpy = "==1.6.0"
+faker = "==13.14.0"
 
 [packages]
 flask = "==2.1.2"

Pipfile.lock

@@ -14,7 +14,7 @@ def register_cli_commands(app):
         if file.startswith("flask_") and file.endswith(".py"):
             # Get the file name
             file_name = file[:-3]
-            command_name = file[4:-3]
+            command_name = file[6:-3]
 
             # Import the cli command module
             module = importlib.import_module(f"cli.{file_name}")

cli/__init__.py

@@ -0,0 +1,189 @@
+from random import randrange
+from passlib.context import CryptContext
+
+import click
+from faker import Faker
+from flask import current_app
+from flask.cli import with_appcontext
+
+from quotes_api.extensions import odm as database_ext
+from quotes_api.api.models import Quote
+from quotes_api.auth.models import User
+
+fake = Faker()
+
+
+@click.group()
+def database():
+    """Run database related tasks."""
+
+
+@database.command()
+@with_appcontext
+def init():
+    """
+    Initialize the database
+
+    :return: None
+    """
+    app_config = current_app.config
+
+    # Check if databases exist.
+
+    # Drop existing databases if they exist. Create them if they don't.
+
+    # Create the database collections for Quote, User and TokenBlacklist
+
+
+@database.command()
+@with_appcontext
+def seed():
+    """
+    Seed the database with initial values.
+    :return: None
+    """
+    app_config = current_app.config
+    pwd_hasher = CryptContext(schemes=["sha256_crypt"])
+
+    seed_admin(app_config, User, pwd_hasher)
+    seed_quotes(Quote, 100)
+
+
+def seed_admin(config, model, pwd_hasher):
+    """
+    Seed initial admin user.
+
+    :param config: Flask application config
+    :param model: Mongoengine document model
+    :param pwd_hasher: Crytographic hasher
+    :return: None
+    """
+
+    admin = None
+    admin_username = config["SEED_ADMIN_USERNAME"]
+    admin_email = config["SEED_ADMIN_EMAIL"]
+    admin_password = pwd_hasher.hash(config["SEED_ADMIN_PASSWORD"])
+
+    click.secho("Seeding admin user...", bg="magenta", fg="white", bold=True)
+    try:
+        admin = model.objects.get(username=admin_username)
+
+        if admin:
+            click.secho("Admin user already exists", bg="green", fg="white", bold=True)
+            click.secho(f"\nAdmin User:\n {admin}", bg="black", fg="white", bold=True)
+
+            return None
+
+    except Exception:
+        click.secho("Admin user does not exist.", bg="blue", fg="white", bold=True)
+
+    try:
+        if admin is None:
+            admin_user_data = {
+                "username": admin_username,
+                "email": admin_email,
+                "password": admin_password,
+                "active": True,
+                "roles": ["admin"],
+            }
+            click.secho("Creating admin user...", bg="blue", fg="white", bold=True)
+
+            admin = model(**admin_user_data)
+            admin.save()
+
+            click.secho("Admin user created.", bg="green", fg="white", bold=True)
+            click.secho(f"\nAdmin User: {admin}", bg="black", fg="white", bold=True)
+
+    except Exception:
+        click.secho(
+            "Could not create admin user.", err=True, bg="red", fg="white", bold=True
+        )
+
+
+def seed_quotes(model, quotes_number):
+    """
+    Seed fake quotes.
+
+    :param config: Flask application config
+    :param model: Mongoengine document model
+    :return: None
+    """
+    # Create all the quote models
+    quote_instances = []
+
+    for _ in range(0, quotes_number):
+        quote = fake.text()
+        author = fake.name()
+        image = fake.image_url()
+        tags = []
+        for _ in range(randrange(1, 10)):
+            tag = fake.word().lower()
+            tags.append(tag)
+
+        quote_data = {
+            "quote_text": quote,
+            "author_name": author,
+            "author_image": image,
+            "tags": tags,
+        }
+        quote = model(**quote_data)
+        quote_instances.append(quote)
+
+    click.secho("\nSeeding quotes...", bg="magenta", fg="white", bold=True)
+    _bulk_insert(model, quote_instances, "Quote documents")
+
+
+def _bulk_insert(model, data, label):
+    """
+    Bulk insert data to a specific model and log it. This is more
+    efficient than adding 1 row at a time in a loop.
+
+    :param model: Model being affected
+    :type model: Mongoengine Document
+    :param data: Document fields to be saved
+    :type data: list
+    :param label: Label for the output
+    :type label: str
+    :return: None
+    """
+    # Delete the current data
+    try:
+        click.secho(
+            f"Deleting existing {label} documents...",
+            bg="blue",
+            fg="white",
+            bold=True,
+        )
+        model.objects().delete()
+        click.secho("Documents deleted", bg="green", fg="white", bold=True)
+
+    except Exception:
+        click.secho(
+            f"Could not delete previous documents for {label} collection.",
+            bg="red",
+            fg="white",
+            bold=True,
+            err=True,
+        )
+        return None
+
+    # Bulk insert documents
+    try:
+        click.secho(
+            f"Creating {len(data)} documents for {label} collection...",
+            bg="blue",
+            fg="white",
+            bold=True,
+        )
+        model.objects.insert(data, load_bulk=False)
+        click.secho(f"Created {len(data)} {label}", bg="green", fg="white", bold=True)
+
+    except Exception:
+        click.secho(
+            f"Could not bulk insert documents for {label} collection.",
+            bg="red",
+            fg="white",
+            bold=True,
+            err=True,
+        )
+        return None

cli/flask_database.py

@@ -1,6 +1,14 @@
+# Flask
 FLASK_ENV=development
 FLASK_APP=wsgi
 APP_CONFIGURATION=development
 SERVER=YOUR_LOCAL_SERVER
 SECRET_KEY=YOUR_SECRET_KEY
-JWT_SECRET_KEY=YOUR_JWT_SECRET_KEY
+
+# Flask JWT Extended
+JWT_SECRET_KEY=YOUR_JWT_SECRET_KEY
+
+# Database Seed
+SEED_ADMIN_USERNAME=YOUR_ADMIN_USERNAME
+SEED_ADMIN_EMAIL=YOUR_ADMIN_EMAIL
+SEED_ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD

envs.example/local.example/application

@@ -1,6 +1,9 @@
+# Flask
 FLASK_ENV=production
 FLASK_APP=wsgi
 APP_CONFIGURATION=production
 SERVER=YOUR_SERVER_URL
 SECRET_KEY=YOUR_SECRET_KEY
-JWT_SECRET_KEY=YOUR_JWT_SECRET_KEY
+
+# Flask JWT Extended
+JWT_SECRET_KEY=YOUR_JWT_SECRET_KEY

envs.example/production.example/application

@@ -43,6 +43,10 @@ class DevelopmentConfig(Config):
     MONGODB_DB = os.getenv("MONGODB_DB")
     MONGODB_HOST = os.getenv("MONGODB_HOST")
 
+    SEED_ADMIN_USERNAME = os.getenv("SEED_ADMIN_USERNAME")
+    SEED_ADMIN_EMAIL = os.getenv("SEED_ADMIN_EMAIL")
+    SEED_ADMIN_PASSWORD = os.getenv("SEED_ADMIN_PASSWORD")
+
 
 class TestingConfig(Config):
     """Testing environment configuration class."""