diff --git a/.github/workflows/unit_tests.yaml b/.github/workflows/unit_tests.yaml index 04adff6..f0e1f1a 100644 --- a/.github/workflows/unit_tests.yaml +++ b/.github/workflows/unit_tests.yaml @@ -3,8 +3,13 @@ on: pull_request jobs: build: - - runs-on: ubuntu-latest + name: Unit Tests on python${{ matrix.python }} via ${{ matrix.os }} + runs-on: ${{ matrix.os }} + strategy: + matrix: + include: + - os: ubuntu-22.04 + python: "3.10" steps: - uses: actions/checkout@v4 - name: Setup Python diff --git a/.gitignore b/.gitignore index 3d98dbd..ee326a9 100644 --- a/.gitignore +++ b/.gitignore @@ -53,3 +53,6 @@ MANIFEST .conda*/ .python-version venv + +# Environment Variables +.env diff --git a/Dockerfile b/Dockerfile index 2548abf..66dc4a8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,6 @@ -FROM ubuntu:focal +FROM ubuntu:jammy ENV DEBIAN_FRONTEND=noninteractive +ENV VENV=${VENV:-"venv"} RUN apt-get update && \ apt-get install -y \ git \ @@ -21,7 +22,8 @@ RUN apt-get update && \ COPY .teuthology.yaml /root WORKDIR /teuthology_api COPY . /teuthology_api/ -RUN pip3 install -e . +RUN python3 -m venv ${VENV} +RUN /teuthology_api/${VENV}/bin/pip3 install -e . RUN mkdir /archive_dir/ -CMD sh /teuthology_api/start_container.sh +ENTRYPOINT /teuthology_api/start_container.sh diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..f705021 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,116 @@ +# 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>=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 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. + +# 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 = + + +[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 diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..18b3c06 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,78 @@ +from logging.config import fileConfig + +from src.teuthology_api.models import DATABASE_URL, Presets +from sqlalchemy import engine_from_config, pool +from sqlmodel import SQLModel + +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 +config.set_main_option("sqlalchemy.url", DATABASE_URL) + +# 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 = SQLModel.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() -> 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() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..6ce3351 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,27 @@ +"""${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 +import sqlmodel +${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"} diff --git a/migrations/versions/0ab13fa43349_add_presets_table.py b/migrations/versions/0ab13fa43349_add_presets_table.py new file mode 100644 index 0000000..0578246 --- /dev/null +++ b/migrations/versions/0ab13fa43349_add_presets_table.py @@ -0,0 +1,43 @@ +"""add presets table + +Revision ID: 0ab13fa43349 +Revises: +Create Date: 2024-06-06 12:28:44.726233 + +""" + +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +import sqlmodel + + +# revision identifiers, used by Alembic. +revision: str = "0ab13fa43349" +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( + "presets", + sa.Column("id", sa.Integer(), nullable=False), + sa.Column("username", sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.Column("name", sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.Column("suite", sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.Column("cmd", sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.PrimaryKeyConstraint("id"), + sa.UniqueConstraint("name"), + ) + op.create_index(op.f("ix_presets_username"), "presets", ["username"], unique=True) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f("ix_presets_username"), table_name="presets") + op.drop_table("presets") + # ### end Alembic commands ### diff --git a/setup.cfg b/setup.cfg index babeb07..a156db3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -57,6 +57,8 @@ install_requires = pydantic-settings python-dotenv teuthology @ git+https://github.com/ceph/teuthology#egg=teuthology[test] + sqlmodel + alembic [options.packages.find] diff --git a/src/teuthology_api/main.py b/src/teuthology_api/main.py index 93e0678..ac9a9aa 100644 --- a/src/teuthology_api/main.py +++ b/src/teuthology_api/main.py @@ -5,7 +5,7 @@ from starlette.middleware.sessions import SessionMiddleware from teuthology_api.config import settings -from teuthology_api.routes import suite, kill, login, logout +from teuthology_api.routes import suite, kill, login, logout, presets DEPLOYMENT = settings.deployment @@ -39,3 +39,4 @@ def read_root(request: Request): app.include_router(kill.router) app.include_router(login.router) app.include_router(logout.router) +app.include_router(presets.router) diff --git a/src/teuthology_api/models/__init__.py b/src/teuthology_api/models/__init__.py new file mode 100644 index 0000000..a32f701 --- /dev/null +++ b/src/teuthology_api/models/__init__.py @@ -0,0 +1,16 @@ +import os +from dotenv import load_dotenv +from sqlmodel import create_engine, Session + +from teuthology_api.models.presets import Presets + +load_dotenv() + +DATABASE_URL = os.getenv("TEUTHOLOGY_API_SQLITE_URI") + +engine = create_engine(DATABASE_URL) + + +def get_db(): + with Session(engine) as session: + yield session diff --git a/src/teuthology_api/models/presets.py b/src/teuthology_api/models/presets.py new file mode 100644 index 0000000..fe28b22 --- /dev/null +++ b/src/teuthology_api/models/presets.py @@ -0,0 +1,9 @@ +from sqlmodel import Field, SQLModel + + +class Presets(SQLModel, table=True): + id: int = Field(primary_key=True) + username: str = Field(index=True, unique=True) + name: str = Field(unique=True) + suite: str + cmd: str diff --git a/src/teuthology_api/routes/presets.py b/src/teuthology_api/routes/presets.py new file mode 100644 index 0000000..b6cb32e --- /dev/null +++ b/src/teuthology_api/routes/presets.py @@ -0,0 +1,96 @@ +import logging + +from fastapi import status, APIRouter, HTTPException, Depends +from sqlmodel import Session + +from teuthology_api.services.helpers import get_token +from teuthology_api.models import get_db, Presets +from teuthology_api.services.presets import PresetsDatabaseException, PresetsService + +logger = logging.getLogger(__name__) + +router = APIRouter(prefix="/presets", tags=["presets"]) + + +@router.get("/", status_code=status.HTTP_200_OK) +def read_preset(username: str, name: str, db: Session = Depends(get_db)): + db_preset = PresetsService(db).get_by_username_and_name(username, name) + if db_preset is None: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail=f"{name} preset does not exist.", + ) + return db_preset + + +@router.get("/list", status_code=status.HTTP_200_OK) +def read_all_presets(username: str, db: Session = Depends(get_db)): + db_presets = PresetsService(db).get_by_username(username) + if not db_presets: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="User has not presets saved.", + ) + return db_presets + + +@router.post("/add", status_code=status.HTTP_201_CREATED) +def add_preset( + preset: Presets, + db: Session = Depends(get_db), + access_token: str = Depends(get_token), +): + if not access_token: + raise HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="You need to be logged in", + headers={"WWW-Authenticate": "Bearer"}, + ) + db_preset_exists = PresetsService(db).get_by_username_and_name( + preset.username, preset.name + ) + if db_preset_exists: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail=f"Preset with name {preset.name} exists", + ) + return PresetsService(db).create(preset) + + +@router.put("/edit/{preset_id}", status_code=status.HTTP_200_OK) +def update_preset( + preset_id: int, + updated_preset: Presets, + db: Session = Depends(get_db), + access_token: str = Depends(get_token), +): + if not access_token: + raise HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="You need to be logged in", + headers={"WWW-Authenticate": "Bearer"}, + ) + try: + return PresetsService(db).update( + preset_id, updated_preset.model_dump(exclude_unset=True) + ) + except PresetsDatabaseException as exc: + raise HTTPException(status_code=exc.code, detail=str(exc)) + + +@router.delete("/delete/{preset_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_preset( + preset_id: int, + db: Session = Depends(get_db), + access_token: str = Depends(get_token), +): + if not access_token: + raise HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="You need to be logged in", + headers={"WWW-Authenticate": "Bearer"}, + ) + try: + PresetsService(db).delete(preset_id) + except PresetsDatabaseException as exc: + raise HTTPException(status_code=exc.code, detail=str(exc)) diff --git a/src/teuthology_api/services/presets.py b/src/teuthology_api/services/presets.py new file mode 100644 index 0000000..5136ea6 --- /dev/null +++ b/src/teuthology_api/services/presets.py @@ -0,0 +1,61 @@ +from typing import Union + +from sqlmodel import select, Session + +from teuthology_api.models.presets import Presets + + +class PresetsDatabaseException(Exception): + def __init__(self, message: str, code: int) -> None: + super().__init__(message) + self.code = code + + +class PresetsService: + def __init__(self, db: Session) -> None: + self.db = db + + def get_by_username(self, username: str): + statement = select(Presets).where(Presets.username == username) + db_presets = self.db.exec(statement).all() + return db_presets + + def get_by_username_and_name( + self, username: str, preset_name: str + ) -> Union[Presets, None]: + statement = select(Presets).where( + Presets.username == username, Presets.name == preset_name + ) + db_preset = self.db.exec(statement).first() + return db_preset + + def get_by_id(self, preset_id: int) -> Union[Presets, None]: + statement = select(Presets).where(Presets.id == preset_id) + db_preset = self.db.exec(statement).first() + return db_preset + + def create(self, preset: Presets) -> Presets: + self.db.add(preset) + self.db.commit() + self.db.refresh(preset) + return preset + + def update(self, preset_id: int, updated_data: dict) -> Presets: + db_preset = self.get_by_id(preset_id) + if db_preset is None: + raise PresetsDatabaseException( + "Preset does not exist, unable to update", 404 + ) + + db_preset.sqlmodel_update(updated_data) + return self.create(db_preset) + + def delete(self, preset_id: int) -> None: + db_preset = self.get_by_id(preset_id) + if db_preset is None: + raise PresetsDatabaseException( + "Preset does not exist, unable to delete", 404 + ) + + self.db.delete(db_preset) + self.db.commit() diff --git a/start_container.sh b/start_container.sh old mode 100644 new mode 100755 index c6559d6..da7d055 --- a/start_container.sh +++ b/start_container.sh @@ -1,10 +1,15 @@ -#!/usr/bin/env sh +#!/usr/bin/bash set -ex trap exit TERM HOST=${TEUTHOLOGY_API_SERVER_HOST:-"0.0.0.0"} PORT=${TEUTHOLOGY_API_SERVER_PORT:-"8082"} +VENV=${VENV:-"venv"} +alembic -x verbose=1 upgrade head + +source ${VENV}/bin/activate +alembic -x verbose=1 upgrade head cd /teuthology_api/src/