[feature] add presets

README.md

@@ -28,14 +28,34 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
             TEUTHOLOGY_API_SERVER_HOST: 0.0.0.0
             TEUTHOLOGY_API_SERVER_PORT: 8080
             PADDLES_URL: http://localhost:8080
+            TEUTHOLOGY_API_SQLALCHEMY_URL: postgresql+psycopg2://admin:password@tapi_db:5432/tapi_db
         depends_on:
             - teuthology
             - paddles
+            - tapi_db
         links:
             - teuthology
             - paddles
+             - tapi_db
         healthcheck:
           test: [ "CMD", "curl", "-f", "http://0.0.0.0:8082" ]
+    tapi_db:
+        image: postgres:14
+        healthcheck:
+            test: [ "CMD", "pg_isready", "-q", "-d", "tapi_db", "-U", "admin" ]
+            timeout: 5s
+            interval: 10s
+            retries: 2
+        environment:
+            - POSTGRES_USER=root
+            - POSTGRES_PASSWORD=password
+            - APP_DB_USER=admin
+            - APP_DB_PASS=password
+            - APP_DB_NAME=tapi_db
+        volumes:
+            - ./db:/docker-entrypoint-initdb.d/
+        ports:
+            - 5433:5432
     ```
     [optional] For developement use:
     Add following things in `teuthology_api` container:

alembic.ini

@@ -0,0 +1,115 @@
+# 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
+
+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

alembic/README

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

alembic/env.py

@@ -0,0 +1,79 @@
+from logging.config import fileConfig
+import os
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+from alembic import context
+
+from src.teuthology_api import models
+
+# 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", models.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
+target_metadata = models.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.
+
+
+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/0684e3c62926_add_presets_table.py

@@ -0,0 +1,40 @@
+"""Add presets table
+
+Revision ID: 0684e3c62926
+Revises: 
+Create Date: 2023-09-07 12:56:56.526870
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = '0684e3c62926'
+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', sa.String(), nullable=True),
+    sa.Column('name', sa.String(), nullable=True),
+    sa.Column('suite', sa.String(), nullable=True),
+    sa.Column('cmd', sa.String(), nullable=True),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('username', 'name')
+    )
+    op.create_index(op.f('ix_presets_username'), 'presets', ['username'], unique=False)
+    # ### 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 ###

gh-actions/start.sh

@@ -11,14 +11,34 @@ if [ ! -d "$folder" ] ; then
         environment: 
             TEUTHOLOGY_API_SERVER_HOST: 0.0.0.0
             TEUTHOLOGY_API_SERVER_PORT: 8080
+            TEUTHOLOGY_API_SQLALCHEMY_URL: postgresql+psycopg2://admin:password@tapi_db:5432/tapi_db
         depends_on:
             - teuthology
             - paddles
+            - tapi_db
         links:
             - teuthology
             - paddles
+            - tapi_db
         healthcheck:
           test: [ "CMD", "curl", "-f", "http://0.0.0.0:8082" ]
+  tapi_db:
+        image: postgres:14
+        healthcheck:
+            test: [ "CMD", "pg_isready", "-q", "-d", "tapi_db", "-U", "admin" ]
+            timeout: 5s
+            interval: 10s
+            retries: 2
+        environment:
+            - POSTGRES_USER=root
+            - POSTGRES_PASSWORD=password
+            - APP_DB_USER=admin
+            - APP_DB_PASS=password
+            - APP_DB_NAME=tapi_db
+        volumes:
+            - ./db:/docker-entrypoint-initdb.d/
+        ports:
+            - 5433:5432
     " >> teuthology/docs/docker-compose/docker-compose.yml
 fi
 cd teuthology/docs/docker-compose

setup.cfg

@@ -58,6 +58,9 @@ install_requires =
     # Temporarily, using teuthology without monkey patching the thread
     teuthology @ git+https://github.com/ceph/teuthology@teuth-api#egg=teuthology[test]"
     # Original: git+https://github.com/ceph/teuthology#egg=teuthology[test]
+    fastapi-sqlalchemy
+    alembic
+    psycopg2-binary
 
 
 [options.packages.find]

src/teuthology_api/main.py

@@ -5,7 +5,7 @@
 from starlette.middleware.sessions import SessionMiddleware
 from dotenv import load_dotenv
 
-from teuthology_api.routes import suite, kill, login, logout
+from teuthology_api.routes import suite, kill, login, logout, presets
 
 load_dotenv()
 
@@ -40,3 +40,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)

src/teuthology_api/models/__init__.py

@@ -0,0 +1,21 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker, Session
+import os
+
+DATABASE_URL = os.getenv("TEUTHOLOGY_API_SQLALCHEMY_URL")
+engine = create_engine(DATABASE_URL)
+
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+Base = declarative_base()
+
+
+def get_db() -> Session:
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+
+
+from .presets import Presets

src/teuthology_api/models/presets.py

@@ -0,0 +1,14 @@
+from sqlalchemy import Column, Integer, String, UniqueConstraint
+from . import Base
+from teuthology_api.schemas.presets import PresetSchema
+
+
+class Presets(Base):
+    __tablename__ = "presets"
+    id = Column(Integer, primary_key=True)
+    username = Column(String, index=True)
+    name = Column(String)
+    suite = Column(String)
+    cmd = Column(String)
+
+    __table_args__ = (UniqueConstraint("username", "name"),)