[feature] Add presets

.env.dev

@@ -17,3 +17,5 @@ SESSION_SECRET_KEY=my-secret-key
 # Path where all logs for teuthology-suite or teuthology-kill would be collected
 ARCHIVE_DIR=/archive_dir/
 TEUTHOLOGY_PATH=/teuthology
+
+TEUTHOLOGY_API_SQLITE_URI=

.github/workflows/unit_tests.yaml

@@ -3,6 +3,8 @@ on: pull_request
 
 jobs:
   build:
+    env:
+      TEUTHOLOGY_API_SQLITE_URI: ${{ secrets.TEUTHOLOGY_API_SQLITE_URI }}
     name: Unit Tests on python${{ matrix.python }} via ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:

.gitignore

@@ -53,3 +53,6 @@ MANIFEST
 .conda*/
 .python-version
 venv
+
+# Environment Variables
+.env

README.md

@@ -16,6 +16,8 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
 
    3.3. Save `CLIENT_ID` and `CLIENT_SECRET` from your Github OAuth App to your local `.env` file as `GH_CLIENT_ID` and `GH_CLIENT_SECRET`.
 
+   3.4. Add `TEUTHOLOGY_API_SQLITE_URI` using the format `sqlite:////<db_path>`
+
 4. Add the following to [teuthology's docker-compose](https://github.com/ceph/teuthology/blob/main/docs/docker-compose/docker-compose.yml) services.
 
     ```
@@ -65,7 +67,9 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
 
 6. Build the project: `pip install -e .`
 
-7. Start the server: `gunicorn -c gunicorn_config.py teuthology_api.main:app`
+7. Run `alembic upgrade head` command to run database migrations
+
+8. Start the server: `gunicorn -c gunicorn_config.py teuthology_api.main:app`
 
 ## Documentation
 
@@ -108,6 +112,4 @@ Example
         "--owner": "example"
      }'
 
-Note: "--owner" in data body should be same as your github username (case sensitive). Otherwise, you wouldn't have permission to kill jobs/run.
-
-xxx
+> Note: `"--owner"` in data body should be same as your github username (case sensitive). Otherwise, you wouldn't have permission to kill jobs/run.

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

gh-actions/start.sh

@@ -8,9 +8,10 @@ if [ ! -d "$folder" ] ; then
           context: ../../../../
         ports:
             - 8082:8080
-        environment: 
+        environment:
             TEUTHOLOGY_API_SERVER_HOST: 0.0.0.0
             TEUTHOLOGY_API_SERVER_PORT: 8080
+            TEUTHOLOGY_API_SQLITE_URI: sqlite:////teuthology_api/teuthology.db
         depends_on:
             - teuthology
             - paddles

migrations/README

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

migrations/env.py

@@ -0,0 +1,83 @@
+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"},
+        render_as_batch=True,
+    )
+
+    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,
+            render_as_batch=True,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

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"}

migrations/versions/db0c0dc793f4_add_presets_table.py

@@ -0,0 +1,43 @@
+"""Add presets table
+
+Revision ID: db0c0dc793f4
+Revises:
+Create Date: 2024-06-17 21:44:58.730544
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel
+
+
+# revision identifiers, used by Alembic.
+revision: str = "db0c0dc793f4"
+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", sa.JSON(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("username", "name"),
+    )
+    op.create_index(op.f("ix_presets_username"), "presets", ["username"])
+    # ### 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 ###

setup.cfg

@@ -56,6 +56,8 @@ install_requires =
     itsdangerous
     python-dotenv
     teuthology @ git+https://github.com/ceph/teuthology#egg=teuthology[test]
+    sqlmodel
+    alembic
 
 
 [options.packages.find]

src/teuthology_api/main.py

@@ -5,7 +5,7 @@
 from dotenv import load_dotenv
 from starlette.middleware.sessions import SessionMiddleware
 
-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,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

src/teuthology_api/models/presets.py

@@ -0,0 +1,14 @@
+from pydantic import ConfigDict
+from sqlmodel import Column, Field, JSON, SQLModel, UniqueConstraint
+
+
+class Presets(SQLModel, table=True):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    id: int = Field(primary_key=True)
+    username: str = Field(index=True)
+    name: str
+    suite: str
+    cmd: JSON = Field(sa_column=Column(JSON))
+
+    __table_args__ = (UniqueConstraint("username", "name"),)