CEFEA-9 / Postgres Repository

ckanext/__init__.py

@@ -1,9 +1,9 @@
-# encoding: utf-8
-
 # this is a namespace package
 try:
     import pkg_resources
+
     pkg_resources.declare_namespace(__name__)
 except ImportError:
     import pkgutil
+
     __path__ = pkgutil.extend_path(__path__, __name__)

ckanext/event_audit/config.py

@@ -1,6 +1,5 @@
 import ckan.plugins.toolkit as tk
 
-
 CONF_ACTIVE_REPO = "ckanext.event_audit.active_repo"
 
 

ckanext/event_audit/migration/event_audit/README

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

ckanext/event_audit/migration/event_audit/alembic.ini

@@ -0,0 +1,74 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = %(here)s
+
+# 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 /home/berry/projects/master/ckanext-event-audit/ckanext/event_audit/migration/event_audit/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat /home/berry/projects/master/ckanext-event-audit/ckanext/event_audit/migration/event_audit/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
+
+
+# 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

ckanext/event_audit/migration/event_audit/env.py

@@ -0,0 +1,89 @@
+import os
+from logging.config import fileConfig
+
+from alembic import context
+from ckan.model.meta import metadata
+from sqlalchemy import engine_from_config, pool
+
+# 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 = 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.
+
+name = os.path.basename(os.path.dirname(__file__))
+
+
+def include_object(object, object_name, type_, reflected, compare_to):
+    if type_ == "table":
+        return object_name.startswith(name)
+    return True
+
+
+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")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        version_table=f"{name}_alembic_version",
+        include_object=include_object,
+    )
+
+    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.
+
+    """
+    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,
+            version_table=f"{name}_alembic_version",
+            include_object=include_object,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

ckanext/event_audit/migration/event_audit/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"}

ckanext/event_audit/migration/event_audit/versions/9256fa265b84_create_event_table.py

@@ -0,0 +1,43 @@
+"""Create Event table
+
+Revision ID: 9256fa265b84
+Revises:
+Create Date: 2024-10-23 12:03:33.876737
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "9256fa265b84"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "event_audit_event",
+        sa.Column("id", sa.String(), primary_key=True),
+        sa.Column("category", sa.String(), nullable=False),
+        sa.Column("action", sa.String(), nullable=False),
+        sa.Column("actor", sa.String()),
+        sa.Column("action_object", sa.String()),
+        sa.Column("action_object_id", sa.String()),
+        sa.Column("target_type", sa.String()),
+        sa.Column("target_id", sa.String()),
+        sa.Column("timestamp", sa.TIMESTAMP(timezone=True), nullable=False),
+        sa.Column("result", sa.JSON(), default={}),
+        sa.Column("payload", sa.JSON(), default={}),
+    )
+
+    op.create_index("ix_event_category", "event_audit_event", ["category"])
+    op.create_index("ix_event_action", "event_audit_event", ["action"])
+    op.create_index("ix_event_actor", "event_audit_event", ["actor"])
+    op.create_index("ix_event_action_object", "event_audit_event", ["action_object"])
+    op.create_index("ix_event_timestamp", "event_audit_event", ["timestamp"])
+    op.create_index("ix_event_actor_action", "event_audit_event", ["actor", "action"])
+
+
+def downgrade():
+    op.drop_table("event_audit_event")

ckanext/event_audit/model.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from sqlalchemy import TIMESTAMP, Column, Index, String
+from sqlalchemy.dialects.postgresql import JSONB
+from sqlalchemy.ext.mutable import MutableDict
+
+import ckan.plugins.toolkit as tk
+from ckan import model
+
+
+class EventModel(tk.BaseModel):
+    __tablename__ = "event_audit_event"
+
+    id = Column(String, primary_key=True)
+    category = Column(String, nullable=False, index=True)
+    action = Column(String, nullable=False, index=True)
+    actor = Column(String, index=True)
+    action_object = Column(String, index=True)
+    action_object_id = Column(String, index=True)
+    target_type = Column(String, index=True)
+    target_id = Column(String, index=True)
+    timestamp = Column(TIMESTAMP(timezone=True), nullable=False, index=True)
+    result = Column(MutableDict.as_mutable(JSONB), default="{}")
+    payload = Column(MutableDict.as_mutable(JSONB), default="{}")
+
+    __table_args__ = (Index("ix_event_actor_action", "actor", "action"),)
+
+    def save(self) -> None:
+        model.Session.add(self)
+        model.Session.commit()

ckanext/event_audit/plugin.py

@@ -1,18 +1,19 @@
 from __future__ import annotations
 
 import os
+
 import yaml
 
-import ckan.plugins as plugins
 import ckan.plugins.toolkit as tk
+from ckan import plugins as p
 from ckan.config.declaration import Declaration, Key
 from ckan.logic import clear_validators_cache
 
 
 @tk.blanket.config_declarations
 @tk.blanket.validators
-class EventAuditPlugin(plugins.SingletonPlugin):
-    plugins.implements(plugins.IConfigDeclaration)
+class EventAuditPlugin(p.SingletonPlugin):
+    p.implements(p.IConfigDeclaration)
 
     # IConfigDeclaration
 

ckanext/event_audit/repositories/__init__.py

@@ -1,4 +1,5 @@
-from .redis import RedisRepository
 from .base import AbstractRepository
+from .postgres import PostgresRepository
+from .redis import RedisRepository
 
-__all__ = ["RedisRepository", "AbstractRepository"]
+__all__ = ["RedisRepository", "AbstractRepository", "PostgresRepository"]

ckanext/event_audit/repositories/base.py

@@ -11,20 +11,23 @@ class AbstractRepository(ABC):
     @classmethod
     @abstractmethod
     def get_name(cls) -> str:
-        """Return the name of the repository"""
+        """Return the name of the repository."""
 
     @abstractmethod
     def write_event(self, event: types.Event) -> types.WriteStatus:
-        """Write an event to the repository. This method accepts an Event object
-        and writes it to the repository. The Event object validates the input."""
+        """Write an event to the repository.
+
+        This method accepts an Event object and writes it to the repository.
+        The Event object validates the input.
+        """
 
     def build_event(self, event_data: types.EventData) -> types.Event:
         return types.Event(**event_data)
 
     @abstractmethod
     def get_event(self, event_id: str) -> types.Event | None:
-        """Get a single event by its ID"""
+        """Get a single event by its ID."""
 
     @abstractmethod
     def filter_events(self, filters: types.Filters) -> list[types.Event]:
-        """Filter events based on the provided kwargs"""
+        """Filter events based on the provided kwargs."""