gaard-api 0.2.1__tar.gz → 0.2.3__tar.gz

{gaard_api-0.2.1/src/gaard_api.egg-info → gaard_api-0.2.3}/PKG-INFO

@@ -1,18 +1,32 @@
 Metadata-Version: 2.4
 Name: gaard-api
-Version: 0.2.1
+Version: 0.2.3
 Summary: GAARD backend web services providing admin interface
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
-Requires-Dist: gaard-core==0.2.1
-Requires-Dist: gaard-connectors==0.2.1
-Requires-Dist: gaard-llm==0.2.1
-Requires-Dist: gaard-plugin-api<0.3.0,>=0.2.0
+Requires-Dist: gaard-core==0.2.2
+Requires-Dist: gaard-connectors==0.2.2
+Requires-Dist: gaard-llm==0.2.2
+Requires-Dist: gaard-plugin-api<0.3.0,>=0.2.2
 Requires-Dist: fastapi>=0.111.0
 Requires-Dist: uvicorn[standard]>=0.30.0
 Requires-Dist: pydantic>=2.7.0
 Requires-Dist: sqlalchemy>=2.0.0
-Requires-Dist: httpx>=0.27.0
+Requires-Dist: httpx2>=2.5.0
+Requires-Dist: certifi>=2024.8.30
+Provides-Extra: oracle
+Requires-Dist: oracledb>=2.0.0; extra == "oracle"
+Provides-Extra: mssql
+Requires-Dist: pyodbc>=5.0.0; extra == "mssql"
+Provides-Extra: ibm-db2
+Requires-Dist: ibm-db-sa>=0.4.4; extra == "ibm-db2"
+Provides-Extra: teradata
+Requires-Dist: teradatasqlalchemy>=20.0.0.9; extra == "teradata"
+Provides-Extra: all-datasources
+Requires-Dist: oracledb>=2.0.0; extra == "all-datasources"
+Requires-Dist: pyodbc>=5.0.0; extra == "all-datasources"
+Requires-Dist: ibm-db-sa>=0.4.4; extra == "all-datasources"
+Requires-Dist: teradatasqlalchemy>=20.0.0.9; extra == "all-datasources"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0.0; extra == "dev"
 Requires-Dist: ruff>=0.5.0; extra == "dev"

{gaard_api-0.2.1 → gaard_api-0.2.3}/pyproject.toml

@@ -4,24 +4,35 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gaard-api"
-version = "0.2.1"
+version = "0.2.3"
 description = "GAARD backend web services providing admin interface"
 readme = "README.md"
 requires-python = ">=3.11"
 
 dependencies = [
-    "gaard-core==0.2.1",
-    "gaard-connectors==0.2.1",
-    "gaard-llm==0.2.1",
-    "gaard-plugin-api>=0.2.0,<0.3.0",
+    "gaard-core==0.2.2",
+    "gaard-connectors==0.2.2",
+    "gaard-llm==0.2.2",
+    "gaard-plugin-api>=0.2.2,<0.3.0",
     "fastapi>=0.111.0",
     "uvicorn[standard]>=0.30.0",
     "pydantic>=2.7.0",
     "sqlalchemy>=2.0.0",
-    "httpx>=0.27.0"
+    "httpx2>=2.5.0",
+    "certifi>=2024.8.30"
 ]
 
 [project.optional-dependencies]
+oracle = ["oracledb>=2.0.0"]
+mssql = ["pyodbc>=5.0.0"]
+ibm_db2 = ["ibm-db-sa>=0.4.4"]
+teradata = ["teradatasqlalchemy>=20.0.0.9"]
+all-datasources = [
+    "oracledb>=2.0.0",
+    "pyodbc>=5.0.0",
+    "ibm-db-sa>=0.4.4",
+    "teradatasqlalchemy>=20.0.0.9",
+]
 dev = [
     "pytest>=8.0.0",
     "ruff>=0.5.0",

{gaard_api-0.2.1 → gaard_api-0.2.3}/src/gaard_api/admin/database.py

@@ -1,9 +1,10 @@
 from collections.abc import Iterator
 import json
+import threading
 
 from sqlalchemy import create_engine, delete, select
 from sqlalchemy.engine import Engine
-from sqlalchemy import inspect, text
+from sqlalchemy import inspect, text, Table
 from sqlalchemy.orm import Session, sessionmaker
 
 from gaard_api.admin.defaults import DEFAULT_GOVERNANCE_POLICY_CONFIG, DEFAULT_PROMPTS
@@ -20,10 +21,13 @@ from gaard_api.admin.models import (
 from gaard_api.admin.security import hash_password
 from gaard_api.core.settings import settings
 
+from typing import cast
+
 
 _engine: Engine | None = None
 _session_factory: sessionmaker[Session] | None = None
 _engine_url: str | None = None
+_init_lock = threading.RLock()
 LEGACY_PROMPT_KEYS = {"investigation_readiness"}
 
 
@@ -66,23 +70,24 @@ def create_session() -> Session:
 
 
 def init_metadata_store() -> None:
-    engine = get_engine()
-    Base.metadata.create_all(engine)
-    ensure_data_query_audit_schema(engine)
-    ensure_overview_widget_schema(engine)
-
-    if _session_factory is None:
-        raise RuntimeError("Admin metadata session factory is not initialized.")
-
-    with _session_factory() as session:
-        seed_admin_user(session)
-        seed_settings(session)
-        apply_runtime_settings(session)
-        seed_prompts(session)
-        seed_datasource_connectors(session)
-        seed_overview_widgets(session)
-        backfill_data_query_audit_types(session)
-        session.commit()
+    with _init_lock:
+        engine = get_engine()
+        Base.metadata.create_all(engine)
+        ensure_data_query_audit_schema(engine)
+        ensure_overview_widget_schema(engine)
+
+        if _session_factory is None:
+            raise RuntimeError("Admin metadata session factory is not initialized.")
+
+        with _session_factory() as session:
+            seed_admin_user(session)
+            seed_settings(session)
+            apply_runtime_settings(session)
+            seed_prompts(session)
+            seed_datasource_connectors(session)
+            seed_overview_widgets(session)
+            backfill_data_query_audit_types(session)
+            session.commit()
 
 
 def seed_admin_user(session: Session) -> None:
@@ -129,7 +134,6 @@ def seed_settings(session: Session) -> None:
         ),
         "data_query_audit_retention_days": str(settings.gaard_audit_retention_days),
         "schema_cache_ttl_seconds": str(settings.gaard_schema_cache_ttl_seconds),
-        "license_edition": "community",
     }
 
     for key, value in defaults.items():
@@ -139,6 +143,9 @@ def seed_settings(session: Session) -> None:
         elif setting.updated_by == "system" and setting.value != value:
             setting.value = value
 
+    if session.get(AdminSetting, "license_edition") is None:
+        session.add(AdminSetting(key="license_edition", value="community"))
+
 
 def apply_runtime_settings(session: Session) -> None:
     schema_cache_ttl = session.get(AdminSetting, "schema_cache_ttl_seconds")
@@ -374,8 +381,8 @@ def seed_overview_widgets(session: Session) -> None:
             existing.active = False
 
         if existing is not None and existing.updated_by == "system":
-            existing.position = int(item["position"])
-            existing.grid_width = int(item["grid_width"])
+            existing.position = int(cast(int,item["position"])) 
+            existing.grid_width = int(cast(int,item["grid_width"]))
             existing.result_mode = str(item["result_mode"])
 
 
@@ -416,7 +423,10 @@ def ensure_data_query_audit_schema(engine: Engine) -> None:
             )
 
     with engine.begin() as connection:
-        for index in DataQueryAuditLog.__table__.indexes:
+
+        audit_log_table = cast(Table, DataQueryAuditLog.__table__)
+
+        for index in audit_log_table.indexes:
             index.create(bind=connection, checkfirst=True)
 
 

{gaard_api-0.2.1 → gaard_api-0.2.3}/src/gaard_api/admin/services.py

@@ -3,7 +3,7 @@ import re
 from dataclasses import dataclass
 from datetime import UTC, datetime, timedelta
 from pathlib import Path
-from typing import Any
+from typing import Any, cast
 
 from sqlalchemy.engine import URL
 from sqlalchemy import delete, desc, select
@@ -139,6 +139,36 @@ def build_sqlalchemy_url_from_connection_config(
             query_keys=("charset",),
         )
 
+    if database_type == "oracle":
+        return build_server_database_url(
+            drivername="oracle+oracledb",
+            connection_config=connection_config,
+            default_port=1521,
+            query_keys=("service_name",),
+            database_required=False,
+            required_query_keys=("service_name",),
+            required_query_key_labels={"service_name": "service name"},
+        )
+
+    if database_type == "mssql":
+        return build_server_database_url(
+            drivername="mssql+pyodbc",
+            connection_config=connection_config,
+            default_port=1433,
+            query_keys=("driver", "Encrypt", "TrustServerCertificate"),
+        )
+
+    if database_type == "ibm_db2":
+        return build_server_database_url(
+            drivername="db2+ibm_db",
+            connection_config=connection_config,
+            default_port=50000,
+            query_keys=(),
+        )
+
+    if database_type == "teradata":
+        return build_teradata_database_url(connection_config)
+
     raise ValueError(f"Datasource type {database_type!r} does not support generated URLs.")
 
 
@@ -147,6 +177,9 @@ def build_server_database_url(
     connection_config: dict[str, Any],
     default_port: int,
     query_keys: tuple[str, ...],
+    database_required: bool = True,
+    required_query_keys: tuple[str, ...] = (),
+    required_query_key_labels: dict[str, str] | None = None,
 ) -> str:
     host = str(connection_config.get("host") or "").strip()
     database = str(connection_config.get("database") or "").strip()
@@ -156,7 +189,7 @@ def build_server_database_url(
 
     if not host:
         raise ValueError("Datasource host is required.")
-    if not database:
+    if database_required and not database:
         raise ValueError("Datasource database name is required.")
     if not username:
         raise ValueError("Datasource username is required.")
@@ -166,6 +199,12 @@ def build_server_database_url(
     except (TypeError, ValueError) as exc:
         raise ValueError("Datasource port must be a number.") from exc
 
+    labels = required_query_key_labels or {}
+    for key in required_query_keys:
+        if not str(connection_config.get(key) or "").strip():
+            label = labels.get(key, key.replace("_", " "))
+            raise ValueError(f"Datasource {label} is required.")
+
     query = {
         key: str(connection_config.get(key)).strip()
         for key in query_keys
@@ -179,7 +218,40 @@ def build_server_database_url(
             password=password or None,
             host=host,
             port=port,
-            database=database,
+            database=database or None,
+            query=query,
+        )
+        .render_as_string(hide_password=False)
+    )
+
+
+def build_teradata_database_url(connection_config: dict[str, Any]) -> str:
+    host = str(connection_config.get("host") or "").strip()
+    username = str(connection_config.get("username") or "").strip()
+    password = str(connection_config.get("password") or "")
+    dbs_port_value = connection_config.get("dbs_port") or 1025
+
+    if not host:
+        raise ValueError("Datasource host is required.")
+    if not username:
+        raise ValueError("Datasource username is required.")
+
+    try:
+        dbs_port = int(dbs_port_value)
+    except (TypeError, ValueError) as exc:
+        raise ValueError("Datasource port must be a number.") from exc
+
+    query = {"dbs_port": str(dbs_port)}
+    for key in ("database", "tmode"):
+        if connection_config.get(key) not in (None, ""):
+            query[key] = str(connection_config.get(key)).strip()
+
+    return (
+        URL.create(
+            drivername="teradatasql",
+            username=username,
+            password=password or None,
+            host=host,
             query=query,
         )
         .render_as_string(hide_password=False)
@@ -487,7 +559,7 @@ def set_setting(session: Session, key: str, value: str, actor: str) -> AdminSett
 
 
 def default_governance_policy_config() -> dict[str, Any]:
-    return json.loads(json_dumps(DEFAULT_GOVERNANCE_POLICY_CONFIG))
+    return cast(dict[str, Any], json.loads(json_dumps(DEFAULT_GOVERNANCE_POLICY_CONFIG)))
 
 
 def normalize_bool_setting(value: Any, field_name: str) -> bool:
@@ -2014,17 +2086,9 @@ def set_active_datasource_connector(
     connector: DatasourceConnector,
     actor: str,
 ) -> None:
-    if is_system_datasource_connector(connector):
-        connector.active = False
-        return
-
-    if connector.connector_key != "default":
-        for item in list_datasource_connectors(session):
-            if item.connector_key == "default":
-                item.active = False
+    from gaard_api.extensions import get_query_hook_registry
 
-    connector.active = True
-    connector.updated_by = actor
+    get_query_hook_registry().set_active_datasource_connector(session, connector, actor)
 
 
 def test_datasource_connection(connector: DatasourceConnector) -> None:

gaard_api-0.2.3/src/gaard_api/admin-web/assets/getgaard.svg

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   version="1.1"
+   id="svg1"
+   width="1672"
+   height="1672"
+   viewBox="0 0 1672 1672"
+   sodipodi:docname="getgaard.svg"
+   inkscape:version="1.4 (e7c3feb1, 2024-10-09)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <defs
+     id="defs1" />
+  <sodipodi:namedview
+     id="namedview1"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:zoom="0.17088526"
+     inkscape:cx="2182.7512"
+     inkscape:cy="111.18572"
+     inkscape:window-width="1560"
+     inkscape:window-height="771"
+     inkscape:window-x="0"
+     inkscape:window-y="25"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="g1" />
+  <g
+     inkscape:groupmode="layer"
+     inkscape:label="Image"
+     id="g1">
+    <g
+       id="g6"
+       transform="matrix(1.0610508,0,0,1.0610508,-2611.1446,1006.5308)">
+      <rect
+         style="fill:#111e2f;fill-opacity:1;stroke-width:1.09542"
+         id="rect2"
+         width="1437.7893"
+         height="1437.7893"
+         x="2529.908"
+         y="-879.6134"
+         ry="320.62204" />
+      <path
+         id="rect1"
+         style="fill:#ffffff;stroke-width:1.09542"
+         d="m 3234.3408,-626.0861 c -13.6106,0.3309 -25.9368,1.0895 -34.8867,2.3418 -84.1236,11.7709 -151.8696,39.6365 -216.4922,89.0508 -88.4727,67.6513 -151.6819,174.0139 -171.4746,288.5391 -8.8934,51.4587 -8.6698,114.0636 0.5859,163.333996 8.6422,46.004504 21.2085,84.4823042 40.9121,125.273404 23.7832,49.237 50.781,87.8784 88.418,126.5547 91.8576,94.394 218.5332,143.6113 347.0449,134.8359 127.7123,-8.7209 240.4621,-72.1949 316.1836,-177.998 45.9159,-64.1567 74.5299,-138.5546 84.8711,-220.666004 2.9258,-23.231196 4.2525,-75.228896 1.9883,-77.957096 -1.5107,-1.8203 -25.8188,-2.0429 -222.8203,-2.0429 -217.2534,0 -221.1459,0.044 -222.502,2.5781 -0.885,1.6537 -1.3808,21.59 -1.3808,55.5625 0,47.4299 0.2317,53.2391 2.207,55.4218 2.1138,2.3358 8.7633,2.4375 158,2.4376 129.1634,0 155.793,0.305 155.793,1.7832 0,3.2418 -7.4812,26.672 -12.6289,39.5507 -17.8663,44.6984 -41.4198,80.6843 -74.6856,114.1075 -26.441,26.566 -51.6323,44.8176 -82.6855,59.9082 -124.9554,60.7235 -275.5308,28.7986 -373.086,-79.1016 -92.4325,-102.2344 -119.9458,-248.8362 -70.1562,-373.8106 17.3657,-43.5887 43.6592,-83.5871 76.4023,-116.2246 38.482,-38.3578 81.0392,-64.5511 132.1739,-81.3515 48.2572,-15.855 102.913,-19.5453 159.332,-10.7598 6.9666,1.0848 13.6858,2.2858 14.9316,2.6699 1.272,0.392 3.4643,-0.5013 5,-2.0371 2.6697,-2.6697 2.7364,-4.0526 2.7364,-58.0371 v -55.3027 l -3,-1.9356 c -7.5481,-4.8687 -59.9495,-7.7173 -100.7813,-6.7246 z"
+         sodipodi:nodetypes="ssssssssssssssssssssssssssscsss" />
+      <g
+         id="g5"
+         transform="translate(2457.7895,-1000.6715)"
+         style="fill:#0cc6a6;fill-opacity:1">
+        <rect
+           style="opacity:1;fill:#0cc6a6;fill-opacity:1;stroke-width:0.938067"
+           id="rect3"
+           width="72.260895"
+           height="134.18539"
+           x="936.10278"
+           y="636.39392"
+           ry="15.974472" />
+        <rect
+           style="opacity:1;fill:#0cc6a6;fill-opacity:1;stroke-width:1.20121"
+           id="rect4"
+           width="72.260895"
+           height="220.02458"
+           x="1046.6084"
+           y="550.55475"
+           ry="19.286819" />
+        <rect
+           style="opacity:1;fill:#0cc6a6;fill-opacity:1;stroke-width:1.50056"
+           id="rect5"
+           width="72.260895"
+           height="343.35675"
+           x="1159.0873"
+           y="427.22256"
+           ry="10.289478" />
+      </g>
+    </g>
+  </g>
+</svg>