✨ Added alembic and info if quiz was imported from KAHOOT!

Dockerfile

@@ -1,6 +1,8 @@
 FROM python:3.10-slim
 COPY classquiz/ /app/classquiz/
 COPY import_to_meili.py /app/import_to_meili.py
+COPY alembic.ini /app/
+COPY migrations/ /app/migrations/
 COPY init_db.py /app/
 COPY *start.sh /app/
 COPY gunicorn_conf.py /app/

alembic.ini

@@ -0,0 +1,105 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

classquiz/db/models.py

@@ -74,6 +74,7 @@ class Quiz(ormar.Model):
     updated_at: datetime = ormar.DateTime(default=datetime.now())
     user_id: uuid.UUID = ormar.ForeignKey(User)
     questions: Json[list[QuizQuestion]] = ormar.JSON(nullable=False)
+    imported_from_kahoot: Optional[bool] = ormar.Boolean(default=False, nullable=True)
 
     class Meta:
         tablename = "quiz"

classquiz/kahoot_importer/import_quiz.py

@@ -60,6 +60,7 @@ async def import_quiz(quiz_id: str, user: User) -> Quiz | str:
         updated_at=datetime.now(),
         user_id=user.id,
         questions=json.dumps(quiz_questions),
+        imported_from_kahoot=True,
     )
     meilisearch.index(settings.meilisearch_index).add_documents([await get_meili_data(quiz_data)])
     return await quiz_data.save()

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

migrations/env.py

@@ -0,0 +1,76 @@
+from logging.config import fileConfig
+from classquiz.db.models import metadata
+from classquiz.config import settings
+from sqlalchemy import create_engine
+from sqlalchemy import pool
+
+from alembic import context
+
+settings = settings()
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = metadata
+url = settings.db_url
+
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = create_engine(url=url)
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/script.py.mako

@@ -0,0 +1,25 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import ormar
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

migrations/versions/17ea75679da8_init.py

@@ -0,0 +1,72 @@
+"""init
+
+Revision ID: 17ea75679da8
+Revises:
+Create Date: 2022-06-10 18:01:51.061536
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import ormar
+
+
+# revision identifiers, used by Alembic.
+revision = "17ea75679da8"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "users",
+        sa.Column("id", ormar.fields.sqlalchemy_uuid.CHAR(32), nullable=False),
+        sa.Column("email", sa.String(length=100), nullable=False),
+        sa.Column("username", sa.String(length=100), nullable=False),
+        sa.Column("password", sa.String(length=100), nullable=False),
+        sa.Column("verified", sa.Boolean(), nullable=True),
+        sa.Column("verify_key", sa.String(length=100), nullable=True),
+        sa.Column("created_at", sa.DateTime(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("email"),
+        sa.UniqueConstraint("password"),
+        sa.UniqueConstraint("username"),
+        sa.UniqueConstraint("verify_key"),
+    )
+    op.create_table(
+        "quiz",
+        sa.Column("id", ormar.fields.sqlalchemy_uuid.CHAR(32), nullable=False),
+        sa.Column("public", sa.Boolean(), nullable=True),
+        sa.Column("title", sa.String(length=100), nullable=False),
+        sa.Column("description", sa.String(length=300), nullable=True),
+        sa.Column("created_at", sa.DateTime(), nullable=True),
+        sa.Column("updated_at", sa.DateTime(), nullable=True),
+        sa.Column("user_id", ormar.fields.sqlalchemy_uuid.CHAR(32), nullable=True),
+        sa.Column("questions", sa.JSON(), nullable=False),
+        sa.ForeignKeyConstraint(["user_id"], ["users.id"], name="fk_quiz_users_id_user_id"),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("id"),
+    )
+    op.create_table(
+        "user_sessions",
+        sa.Column("id", ormar.fields.sqlalchemy_uuid.CHAR(32), nullable=False),
+        sa.Column("user", ormar.fields.sqlalchemy_uuid.CHAR(32), nullable=True),
+        sa.Column("session_key", sa.String(length=64), nullable=False),
+        sa.Column("created_at", sa.DateTime(), nullable=True),
+        sa.Column("ip_address", sa.String(length=100), nullable=True),
+        sa.Column("user_agent", sa.String(length=255), nullable=True),
+        sa.Column("last_seen", sa.DateTime(), nullable=True),
+        sa.ForeignKeyConstraint(["user"], ["users.id"], name="fk_user_sessions_users_id_user"),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("session_key"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("user_sessions")
+    op.drop_table("quiz")
+    op.drop_table("users")
+    # ### end Alembic commands ###

migrations/versions/6dc09ad6f6ef_imported_from_kahoot_field.py

@@ -0,0 +1,28 @@
+"""imported_from_kahoot field
+
+Revision ID: 6dc09ad6f6ef
+Revises: 17ea75679da8
+Create Date: 2022-06-10 18:06:39.912634
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "6dc09ad6f6ef"
+down_revision = "17ea75679da8"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("quiz", sa.Column("imported_from_kahoot", sa.Boolean(), nullable=True, default=False))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("quiz", "imported_from_kahoot")
+    # ### end Alembic commands ###

prestart.sh

@@ -1 +1 @@
-python3 init_db.py
+alembic upgrade head

run_tests.sh

@@ -11,7 +11,7 @@ init() {
   mkdir /tmp/storage
   docker run --rm -d -p 6379:6379 --name test_redis redis:alpine
   docker run -it --rm -d -p 7700:7700 --name test_meili getmeili/meilisearch:latest
-  pipenv run python3 init_db.py
+  pipenv run alembic upgrade head
 }
 
 case $1 in