Merge pull request #5 from cweidner3/refactor

Refactor

Author: cweidner3

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length=100

.gitignore

@@ -1,23 +1,5 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+__pycache__/
+*.pyc
 
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# production
-/build
-
-# misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+/secrets/
+/.prod*.yml

Makefile

@@ -0,0 +1,46 @@
+.PHONY: default
+default: up
+
+.PHONY: up
+up:
+	docker-compose up --build -d
+
+.PHONY: down
+down:
+	docker-compose down $(ARGS)
+
+.PHONY: build
+build:
+	docker-compose build
+
+.PHONY: logs
+logs:
+	docker-compose logs -f $(CONT)
+
+.PHONY: status
+status:
+	docker-compose ps
+
+.PHONY: stat
+stat: status
+
+.PHONY: localup
+localup: .prod-local.yml
+	docker-compose -f $< up --build -d
+
+.PHONY: localdown
+localdown: .prod-local.yml
+	docker-compose -f $< down $(ARGS)
+
+.PHONY: locallogs
+locallogs: .prod-local.yml
+	docker-compose -f $< logs -f $(CONT)
+
+################################################################################
+
+.PHONY: clean
+clean:
+	rm -rf .prod-local.yml
+
+.prod-local.yml: docker-compose.yml prod-local.yml
+	@python ./utils/dc_merge.py $@ $^

api/.gitignore

@@ -0,0 +1,2 @@
+/.coverage
+/htmlcov/

api/Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.11
+
+RUN apt update -y && apt install -y \
+    gcc openssl \
+    mariadb-common libmariadb3 libmariadb-dev \
+    libpq5 libpq-dev postgresql-common
+
+RUN python -m venv /venv
+
+COPY requirements.txt /requirements.txt
+RUN /venv/bin/pip install -r /requirements.txt
+
+COPY ./entrypoint.sh /entrypoint
+
+WORKDIR /app
+
+COPY ./src ./src
+
+EXPOSE 5000
+
+ENTRYPOINT ["/entrypoint"]
+CMD ["/venv/bin/python", "-m", "flask", "--app", "src.main", "--debug", "run", "--host", "0.0.0.0"]

api/Dockerfile.prod

@@ -0,0 +1,25 @@
+FROM --platform=$BUILDPLATFORM python:3.11
+
+RUN apt update -y && apt install -y \
+    gcc openssl \
+    mariadb-common libmariadb3 libmariadb-dev \
+    libpq5 libpq-dev postgresql-common
+
+RUN python -m venv /venv
+
+RUN groupadd -g 1000 worker \
+    && useradd -u 1000 -g 1000 worker \
+    && mkdir -p /app \
+    && chown 1000:1000 /app
+
+COPY requirements.txt /requirements.txt
+RUN /venv/bin/pip install -r /requirements.txt gunicorn
+
+USER worker
+WORKDIR /app
+
+COPY ./src ./src
+
+EXPOSE 5000
+
+CMD ["/venv/bin/python", "-m", "gunicorn", "-b", "0.0.0.0:5000", "src.main:app"]

api/Makefile

@@ -0,0 +1,53 @@
+REV = head
+
+SRCS = alembic.ini
+SRCS += $(shell find src -iname '*.py')
+SRCS += $(shell find tests -iname '*.py')
+
+.PHONY: default
+default: test
+
+.PHONY: help
+help:
+	@echo "ACTIONS"
+	@echo "  test               [default] Run unittests."
+	@echo "  upgrade   [REV=]   Migrate database upwards to REV [default head]"
+	@echo "  downgrade [REV=]   Migrate database downwards to REV."
+	@echo "  testhike           Upload test data for viewing the hike page."
+	@echo "  cov                Show report of test coverage of the app."
+	@echo "  html               Show report of test coverage of the app in html."
+
+.PHONY: test
+test:
+	python -m unittest -v $(TESTS)
+
+.PHONY: upgrade
+upgrade:
+	alembic upgrade $(REV)
+
+.PHONY: downgrade
+downgrade:
+	alembic downgrade $(REV)
+
+.PHONY: testhike
+testhike:
+	python -m tests.scripts.upload_test_hike $(REPLACE)
+
+.PHONY: cov
+cov: .coverage
+	python -m coverage report
+
+.PHONY: html
+html: htmlcov
+
+################################################################################
+
+.PHONY: clean
+clean:
+	rm -rf .coverage htmlcov
+
+htmlcov: .coverage
+	python -m coverage html
+
+.coverage: $(SRCS) Makefile
+	python -m coverage run --source=src -m unittest -v

api/alembic.ini

@@ -0,0 +1,107 @@
+# 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
+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_locations = %(here)s/src/migrations
+
+# 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
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = postgresql://postgres:secret@localhost:5432/db
+
+
+[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

api/alembic/README

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

api/alembic/env.py

@@ -0,0 +1,78 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# 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 = None
+
+# 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.
+
+    """
+    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()