setting up initial db integration

README.md

@@ -12,6 +12,7 @@ Make sure you have the following installed if you intend to build the project lo
 ### Development Setup
 To set up your environment, run the following commands (or the equivalent
 commands if not using a bash-like terminal):
+
 ```shell
 # Clone the project
 git clone https://github.com/GSA-TTS/identity-idva-gdrive
@@ -25,10 +26,32 @@ source .venv/bin/activate
 # Install dependencies and pre-commit hooks
 python -m pip install -r requirements-dev.txt
 pre-commit install
+```
+### Database Setup & Usage
 
-The project can be ran locally with:
+- Install Postgres
+```sql
+create schema if not exists idva;
+alter role postgres set search_path = idva;
+```
+Once the above SQL has been run on postgres, alembic can be used to build the DDL Dependencies.
+
+Alembic uses the same connection string as the gdrive module, loading the 
+value from `settings.DB_URI`. In case a different URI is needed, the URI alembic 
+uses can be configured manually in `alembic.ini`.
+```ini
+# Update Alembic connection string in Alembic.ini
+sqlalchemy.url = postgresql://postgres:{PASSWORD}@{URL}:{PORT}
+```
+Use alembic to build database entities, and app is ready.
 ```shell
-uvicorn gdrive.main:app
+# This step may be nessessary if doing a rebuild of the whole schema, 
+# clean install does not need to worry about this step. 
+$ alembic downgrade base
+# Updates the empty db schema with all of the DDL app dependencies
+$ alembic upgrade head
+#The project can be ran locally with:
+$ uvicorn gdrive.main:app
 ```
 
 ### Running the application

alembic.ini

@@ -0,0 +1,114 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# 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 alembic/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:alembic/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.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+
+[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
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix 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

alembic/README

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

alembic/env.py

@@ -0,0 +1,89 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+from gdrive.database.models import Base
+from gdrive import 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
+# from myapp.mymodel1 import Model1Base
+# from myapp.mymodel2 import Model2Base
+#   target_metadata = [Model1Base.metadata, Model2Base.metadata]
+target_metadata = Base.metadata
+
+# 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.
+
+if not settings.DB_URI:
+    print("Database has not been configured.")
+    exit()
+
+config.set_main_option("sqlalchemy.url", settings.DB_URI)
+
+
+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.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    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 = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    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()

alembic/script.py.mako

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

alembic/versions/323012e80841_create_gdrive_table.py

@@ -0,0 +1,34 @@
+"""
+Initial revision, Clean DB. DB Model should only have an auto-incrememnting ID field
+Revision ID: 323012e80841
+Revises: 
+Create Date: 2023-10-25 22:19:12.231204
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "323012e80841"
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table("participant")
+    op.add_column(
+        "participant", sa.Column("id", sa.Integer, primary_key=True, index=True)
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("participant", "id")
+    op.drop_table("participant")
+    # ### end Alembic commands ###

alembic/versions/b5c8e1cfcb42_create_participant_table.py

@@ -0,0 +1,52 @@
+"""Add all participant columns to the participant table
+
+Revision ID: b5c8e1cfcb42
+Revises: 323012e80841
+Create Date: 2023-10-25 22:22:37.857141
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "b5c8e1cfcb42"
+down_revision: Union[str, None] = "323012e80841"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("participant", sa.Column("survey_id", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("response_id", sa.String(), nullable=True))
+    op.add_column(
+        "participant", sa.Column("rules_consent_id", sa.String(), nullable=True)
+    )
+    op.add_column("participant", sa.Column("time", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("date", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("ethnicity", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("race", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("gender", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("age", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("income", sa.String(), nullable=True))
+    op.add_column("participant", sa.Column("skin_tone", sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("participant", "skin_tone")
+    op.drop_column("participant", "income")
+    op.drop_column("participant", "age")
+    op.drop_column("participant", "gender")
+    op.drop_column("participant", "race")
+    op.drop_column("participant", "ethnicity")
+    op.drop_column("participant", "date")
+    op.drop_column("participant", "time")
+    op.drop_column("participant", "rules_consent_id")
+    op.drop_column("participant", "response_id")
+    op.drop_column("participant", "survey_id")
+    # ### end Alembic commands ###

gdrive/database/crud.py

@@ -0,0 +1,13 @@
+import sqlalchemy
+from sqlalchemy import orm
+
+from gdrive.database import database, models
+
+
+def create_participant(db_item: models.ParticipantModel):
+    session = database.SessionLocal()
+    session.add(db_item)
+    session.commit()
+    session.refresh(db_item)
+    session.close()
+    return db_item