feat: Added a database

Author: kojicmarko

.github/workflows/pipeline.yaml

@@ -14,6 +14,8 @@ jobs:
           cache: 'poetry'
       - name: Install dependencies
         run: poetry install --no-interaction --no-ansi
+      - name: Build and run Docker test container
+        run: make docker-test-up
       - name: Lint
         run: make lint-ci
       - name: Test

.gitignore

@@ -3,4 +3,5 @@
 __pycache__/
 *.py[cod]
 *$py.class
-.coverage
+.coverage
+.env

Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.10.6-alpine AS builder
 WORKDIR /code
 COPY poetry.lock pyproject.toml /code/
 
-RUN apk add build-base libffi-dev curl
+RUN apk add --no-cache build-base libffi-dev curl netcat-openbsd
 ENV POETRY_NO_INTERACTION=1 \
     POETRY_VIRTUALENVS_IN_PROJECT=1 \
     POETRY_VIRTUALENVS_CREATE=1 \
@@ -19,9 +19,12 @@ WORKDIR /code
 
 COPY --from=builder /code /code
 COPY ./src /code/src
+COPY ./alembic.ini /code/alembic.ini
+COPY ./alembic /code/alembic
+COPY ./docker_start.sh /code/docker_start.sh
 
 RUN addgroup --gid 1000 pyweb
 RUN adduser pyweb -h /code -u 1000 -G pyweb -DH
 USER 1000
 
-CMD ["/code/.venv/bin/uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "80"]
+CMD ["/bin/sh", "/code/docker_start.sh"]

Makefile

@@ -1,9 +1,11 @@
+# TODO: Commands could be cleaned up
+
 install:
 	poetry install
 build:
-	docker build -t pyweb-image .
+	docker-compose build -t pyweb-image .
 run:
-	docker-compose up -d
+	poetry run uvicorn src.main:app --port 80
 stop:
 	docker-compose down --volumes
 lint:
@@ -16,12 +18,13 @@ lint-ci:
 	poetry run mypy src tests
 test:
 	poetry run pytest --cov=src tests/
-run-docker:
-	docker run -d --name epam-pyweb -p 80:80 pyweb-image
-stop-docker:
-	docker stop epam-pyweb
-	docker rm epam-pyweb
-clean-docker:
-	docker stop epam-pyweb
-	docker rm epam-pyweb
-	docker rmi pyweb-image
+docker-run:
+	docker-compose up -d
+docker-stop:
+	docker-compose down
+docker-stop-v:
+	docker-compose down --volumes
+docker-test-up:
+	docker-compose -f docker-compose.test.yaml up -d --build
+docker-test-down:
+	docker-compose -f docker-compose.test.yaml down --volumes

alembic.ini

@@ -0,0 +1,117 @@
+# 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_%%(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>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# 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
+
+# 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
+
+# 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,77 @@
+import os
+from logging.config import fileConfig
+
+from dotenv import load_dotenv
+from sqlalchemy import create_engine
+
+from alembic import context
+from src.database import Base
+
+load_dotenv()
+
+# 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
+
+target_metadata = 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", os.environ["DATABASE_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.
+
+    """
+    url = os.environ["DATABASE_URL"]
+    connectable = create_engine(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()

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/2024-02-21_added_projects_table.py

@@ -0,0 +1,36 @@
+"""Added projects table
+
+Revision ID: 667fd2bcc9fd
+Revises:
+Create Date: 2024-02-21 20:06:22.908882
+
+"""
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "667fd2bcc9fd"
+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(
+        "projects",
+        sa.Column("id", sa.UUID(), nullable=False),
+        sa.Column("name", sa.String(length=40), nullable=False),
+        sa.Column("description", sa.Text(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("projects")
+    # ### end Alembic commands ###

docker-compose.test.yaml

@@ -0,0 +1,21 @@
+version: "3.8"
+
+services:
+  app:
+    build: .
+    container_name: pyweb_test
+    ports:
+      - "8080:80"
+    depends_on:
+      - test_db
+    environment:
+      - DATABASE_URL=postgresql+psycopg://postgres:postgres@test_db:5432/test
+  test_db:
+    image: postgres:15
+    container_name: test_db
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_DB=test
+    ports:
+      - "3254:5432"

docker-compose.yaml

@@ -4,8 +4,24 @@ services:
   app:
     build: .
     container_name: pyweb
-    command: /code/.venv/bin/uvicorn src.main:app --host 0.0.0.0 --port 80 --reload
     ports:
       - "80:80"
     volumes:
       - ./src:/code/src
+    depends_on:
+      - db
+    environment:
+      - DATABASE_URL=postgresql+psycopg://postgres:postgres@db:5432/pyweb
+      - RELOAD=true
+  db:
+    image: postgres:15
+    container_name: db
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_DB=pyweb
+    volumes:
+      - db_data:/var/lib/postgresql/data/
+
+volumes:
+  db_data: