diff --git a/api/alembic.ini b/api/alembic.ini new file mode 100644 index 0000000..2d4431e --- /dev/null +++ b/api/alembic.ini @@ -0,0 +1,100 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# template used to generate migration files +# file_template = %%(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" +# 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. Valid values are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # default: use os.pathsep + +# 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 diff --git a/api/api/__init__.py b/api/api/__init__.py index 21452f2..b38ce22 100644 --- a/api/api/__init__.py +++ b/api/api/__init__.py @@ -5,7 +5,7 @@ from flask_cors import CORS from flask_sqlalchemy import SQLAlchemy -from api.settings import app_settings +from api.settings import get_app_config_engine from api.util import CustomJSONEncoder # instantiate the extensions @@ -19,7 +19,7 @@ def create_app(script_info=None): app.json_encoder = CustomJSONEncoder # set config - config_engine = app_settings[os.getenv("APP_SETTINGS", "dev")]() + config_engine = get_app_config_engine() app.config.from_object(config_engine) # set up extensions diff --git a/api/api/settings.py b/api/api/settings.py index 4530b3c..4b298ea 100644 --- a/api/api/settings.py +++ b/api/api/settings.py @@ -1,14 +1,16 @@ import os # TODO Find an alternative to injection envvars into config. +# TODO convert to user logger instead if os.getenv("FLASK_ENV") == "development": try: import dotenv - - dotenv.load_dotenv() - except Exception: - print("Didn't load a .env file") - pass + # find the file relative to this settings module + current_dir = os.path.dirname(__file__) + dotenv.load_dotenv(os.path.join(current_dir, ".env")) + except Exception as err: + # TODO add logging here and stop raising error? + raise err # TODO Add postgres params option @@ -29,7 +31,7 @@ def build_postgres_uri(host, user, dbname, passwd=None, port="5432", sslmode=Non class BaseConfigEngine: """Base configuration engine""" - + # Allow atomic construction of database uri POSTGRES_HOST = os.getenv("POSTGRES_HOST", default="localhost") POSTGRES_USER = os.getenv("POSTGRES_USER", default="postgres") POSTGRES_APP_DATABASE = os.getenv("POSTGRES_APP_DATABASE", default="postgres") @@ -39,17 +41,22 @@ class BaseConfigEngine: POSTGRES_PARAMS = os.getenv("POSTGRES_PARAMS") SECRET_KEY = os.getenv("SECRET_KEY", "defaultsecretkey") SQLALCHEMY_TRACK_MODIFICATIONS = False + # Allow for direct declaration of database uri + _SQLALCHEMY_DATABASE_URI = os.getenv("SQLALCHEMY_DATABASE_URI") @property def SQLALCHEMY_DATABASE_URI(self): # Note: all caps - return build_postgres_uri( - self.POSTGRES_HOST, - self.POSTGRES_USER, - self.POSTGRES_APP_DATABASE, - self.POSTGRES_PASSWORD, - self.POSTGRES_PORT, - self.POSTGRES_SSL_MODE, - ) + if self._SQLALCHEMY_DATABASE_URI: + return self._SQLALCHEMY_DATABASE_URI + else: + return build_postgres_uri( + self.POSTGRES_HOST, + self.POSTGRES_USER, + self.POSTGRES_APP_DATABASE, + self.POSTGRES_PASSWORD, + self.POSTGRES_PORT, + self.POSTGRES_SSL_MODE, + ) class DevConfigEngine(BaseConfigEngine): @@ -73,3 +80,9 @@ app_settings = { "prod": ProductionConfigEngine, "production": ProductionConfigEngine, } + + +def get_app_config_engine(): + """Returns an instance of the Application Config Engine""" + config_engine = app_settings[os.getenv("APP_SETTINGS", "dev")]() + return config_engine diff --git a/api/migrations/README b/api/migrations/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/api/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/api/migrations/env.py b/api/migrations/env.py new file mode 100644 index 0000000..d830eb4 --- /dev/null +++ b/api/migrations/env.py @@ -0,0 +1,82 @@ +from logging.config import fileConfig + +from sqlalchemy import create_engine +from sqlalchemy import pool + +from alembic import context +from api.settings import get_app_config_engine + +# 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. +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 api import db +target_metadata = db.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. + + +# def run_migrations_offline(): +# """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(): + """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, + # ) + app_config_engine = get_app_config_engine() + connectable = create_engine(app_config_engine.SQLALCHEMY_DATABASE_URI, echo=True, future=True) + + 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() +run_migrations_online() \ No newline at end of file diff --git a/api/migrations/script.py.mako b/api/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/api/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${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(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/api/migrations/versions/6e7b97c9696c_added_first_table.py b/api/migrations/versions/6e7b97c9696c_added_first_table.py new file mode 100644 index 0000000..740ecb3 --- /dev/null +++ b/api/migrations/versions/6e7b97c9696c_added_first_table.py @@ -0,0 +1,40 @@ +"""Added first table + +Revision ID: 6e7b97c9696c +Revises: +Create Date: 2021-11-27 11:34:27.139781 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '6e7b97c9696c' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('cookies', + sa.Column('id', sa.BigInteger(), sa.Identity(always=False, start=100000), nullable=False), + sa.Column('created_date', sa.DateTime(timezone=True), server_default=sa.text("TIMEZONE('utc', CURRENT_TIMESTAMP)"), nullable=True), + sa.Column('modified_date', sa.DateTime(timezone=True), server_default=sa.text("TIMEZONE('utc', CURRENT_TIMESTAMP)"), nullable=True), + sa.Column('name', sa.String(length=50), nullable=True), + sa.Column('recipe_url', sa.String(length=255), nullable=True), + sa.Column('sku', sa.String(length=55), nullable=True), + sa.Column('qoh', sa.Integer(), nullable=True), + sa.Column('unit_cost', sa.Numeric(precision=12, scale=2), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_cookies_name'), 'cookies', ['name'], unique=False) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_cookies_name'), table_name='cookies') + op.drop_table('cookies') + # ### end Alembic commands ### diff --git a/api/requirements.in b/api/requirements.in index 2b544ea..7af3ac5 100644 --- a/api/requirements.in +++ b/api/requirements.in @@ -1,3 +1,4 @@ +alembic==1.7.5 python-dotenv==0.19.2 flask==2.0.2 psycopg2-binary==2.9.2 diff --git a/api/requirements.txt b/api/requirements.txt index d98a706..ec401bb 100644 --- a/api/requirements.txt +++ b/api/requirements.txt @@ -2,41 +2,56 @@ # This file is autogenerated by pip-compile with python 3.8 # To update, run: # -# pip-compile --output-file=./api/requirements.txt api/requirements.in +# pip-compile requirements.in # +alembic==1.7.5 + # via -r requirements.in click==8.0.3 # via flask flask==2.0.2 # via - # -r api/requirements.in + # -r requirements.in # flask-cors # flask-sqlalchemy flask-cors==3.0.10 - # via -r api/requirements.in + # via -r requirements.in flask_sqlalchemy==2.5.1 - # via -r api/requirements.in + # via -r requirements.in greenlet==1.1.2 # via sqlalchemy gunicorn==20.1.0 - # via -r api/requirements.in + # via -r requirements.in +importlib-metadata==4.8.2 + # via alembic +importlib-resources==5.4.0 + # via alembic itsdangerous==2.0.1 # via flask jinja2==3.0.3 # via flask +mako==1.1.6 + # via alembic markupsafe==2.0.1 - # via jinja2 + # via + # jinja2 + # mako psycopg2-binary==2.9.2 - # via -r api/requirements.in + # via -r requirements.in python-dotenv==0.19.2 - # via -r api/requirements.in + # via -r requirements.in six==1.16.0 # via flask-cors sqlalchemy==1.4.27 # via - # -r api/requirements.in + # -r requirements.in + # alembic # flask-sqlalchemy werkzeug==2.0.2 # via flask +zipp==3.6.0 + # via + # importlib-metadata + # importlib-resources # The following packages are considered to be unsafe in a requirements file: # setuptools