Initial pbench user model implementation

Author: npalaska

lib/pbench/cli/server/shell.py

@@ -15,6 +15,7 @@ def app():
     except (ConfigFileNotSpecified, BadConfig) as e:
         print(e)
         sys.exit(1)
+
     return create_app(server_config)
 
 

lib/pbench/server/api/__init__.py

@@ -17,41 +17,61 @@
 from pbench.common.logger import get_pbench_logger
 from pbench.server.api.resources.query_apis.elasticsearch_api import Elasticsearch
 from pbench.server.api.resources.query_apis.query_controllers import QueryControllers
+from pbench.server.api.resources.database import Database
 from pbench.server.api.resources.query_apis.query_month_indices import QueryMonthIndices
 
+from pbench.server.api.resources.pbench_users import (
+    RegisterUser,
+    LoginAPI,
+    UserAPI,
+)
+
 
 def register_endpoints(api, app, config):
     """Register flask endpoints with the corresponding resource classes
     to make the APIs active."""
 
     base_uri = config.rest_uri
-    app.logger.info("Registering service endpoints with base URI {}", base_uri)
+    logger = app.logger
+
+    logger.info("Registering service endpoints with base URI {}", base_uri)
 
     api.add_resource(
         Upload,
         f"{base_uri}/upload/ctrl/<string:controller>",
-        resource_class_args=(config, app.logger),
+        resource_class_args=(config, logger),
     )
     api.add_resource(
-        HostInfo, f"{base_uri}/host_info", resource_class_args=(config, app.logger),
+        HostInfo, f"{base_uri}/host_info", resource_class_args=(config, logger),
     )
     api.add_resource(
         Elasticsearch,
         f"{base_uri}/elasticsearch",
-        resource_class_args=(config, app.logger),
+        resource_class_args=(config, logger),
     )
     api.add_resource(
-        GraphQL, f"{base_uri}/graphql", resource_class_args=(config, app.logger),
+        GraphQL, f"{base_uri}/graphql", resource_class_args=(config, logger),
     )
     api.add_resource(
         QueryControllers,
         f"{base_uri}/controllers/list",
-        resource_class_args=(config, app.logger),
+        resource_class_args=(config, logger),
     )
     api.add_resource(
         QueryMonthIndices,
         f"{base_uri}/controllers/months",
-        resource_class_args=(config, app.logger),
+        resource_class_args=(config, logger),
+    )
+
+    api.add_resource(
+        RegisterUser, f"{base_uri}/user", resource_class_args=(config, logger),
+    )
+    api.add_resource(
+        LoginAPI, f"{base_uri}/session", resource_class_args=(config, logger),
+    )
+
+    api.add_resource(
+        UserAPI, f"{base_uri}/user/<string:username>", resource_class_args=(logger,),
     )
 
 
@@ -74,14 +94,21 @@ def create_app(server_config):
     """Create Flask app with defined resource endpoints."""
 
     app = Flask("api-server")
-    api = Api(app)
     CORS(app, resources={r"/api/*": {"origins": "*"}})
 
     app.logger = get_pbench_logger(__name__, server_config)
 
     app.config["DEBUG"] = False
     app.config["TESTING"] = False
 
+    api = Api(app)
+
     register_endpoints(api, app, server_config)
 
+    Database.init_db(server_config=server_config, logger=app.logger)
+
+    @app.teardown_appcontext
+    def shutdown_session(exception=None):
+        Database.db_session.remove()
+
     return app

lib/pbench/server/api/resources/alembic.ini

@@ -0,0 +1,85 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# 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
+# version_locations = %(here)s/bar %(here)s/bat alembic/versions
+
+# 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
+
+# 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

lib/pbench/server/api/resources/alembic/README

@@ -0,0 +1,20 @@
+Generic single-database configuration.
+
+Some useful commands to run migrations:
+
+Migration commit files are stored in alembic/versions folder.
+
+To create a db migration file
+# alembic revision — autogenerate -m “First commit”
+
+Using the above command alembic generate our first migration commit file in versions folder.
+file names are usually stored as revision_id_<commit_message>.py
+
+Once this file generates we are ready for database migration.
+# alembic upgrade head
+
+To upgrade to specific migration
+# alembic upgrade <revision_id_>
+
+To downgrade to specific migration
+# alembic downgrade <revision_id_>

lib/pbench/server/api/resources/alembic/env.py

@@ -0,0 +1,104 @@
+"""
+This file is auto generated when we run `alembic init alembic` but modified according to our needs.
+This Python script runs whenever the alembic migration tool is invoked.
+It contains instructions to configure and generate a SQLAlchemy engine,
+procure a connection from that engine along with a transaction, and then
+invoke the migration engine, using the connection as a source of database connectivity.
+"""
+import sys
+from logging.config import fileConfig
+
+
+from alembic import context
+
+from pbench.common.exceptions import BadConfig, ConfigFileNotSpecified
+from pbench.server.api.resources.database import Database
+from pbench.common.logger import get_pbench_logger
+from pbench.server.api import get_server_config
+
+# 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.
+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 = [Database.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():
+    """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")
+    try:
+        server_config = get_server_config()
+        logger = get_pbench_logger(__name__, server_config)
+    except (ConfigFileNotSpecified, BadConfig) as e:
+        print(e)
+        sys.exit(1)
+    url = Database.get_engine_uri(server_config, logger)
+
+    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():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    try:
+        server_config = get_server_config()
+        logger = get_pbench_logger(__name__, server_config)
+    except (ConfigFileNotSpecified, BadConfig) as e:
+        print(e)
+        sys.exit(1)
+
+    connectable = Database.init_engine(server_config, logger)
+    # 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():
+    print("running migration offline")
+    run_migrations_offline()
+else:
+    run_migrations_online()
+    print("running migration online")

lib/pbench/server/api/resources/alembic/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}