test_ui_event_logger.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/test_ui_event_logger.py
 
"""
Regression Tests — ui_event_logger
=====================================
 
Purpose
-------
Verify that ``ui_event_logger`` imports cleanly, exposes the required public
API surface, and registers callbacks correctly with custom event properties.
 
Responsibilities
----------------
- Confirm the module imports without error and exposes ``register_callbacks()``.
- Confirm ``REQUIRED_STORE_ID`` has the expected constant value.
- Confirm ``register_callbacks()`` accepts a custom ``UI_EVENT_PROPERTIES``
  tuple with fewer properties than the default five.
 
Diagnostics
-----------
Domain: TEST
Levels:
    L2 — lifecycle
    L3 — semantic details
    L4 — deep tracing
 
Contracts
---------
- All tests are skipped automatically when Dash is not installed.
- Must not permanently modify oc_diagnostics global state.
- Must restore all patched globals in finally blocks.
- Must not start servers or require network access.
- Must run deterministically across repeated invocations.
"""
 
import os
import sys
 
# ---------------------------------------------------------------------------
# Ensure oc_diagnostics is importable when run from the project root or the
# tests/ subdirectory.
# ---------------------------------------------------------------------------
_REPO_ROOT = os.path.normpath(os.path.join(os.path.dirname(__file__), ".."))
if _REPO_ROOT not in sys.path:
    sys.path.insert(0, _REPO_ROOT)
 
import pytest
 
# Skip the entire module when Dash is not installed
pytest.importorskip("dash", reason="Dash not installed")
 
from dash import Dash, dcc, html
import oc_diagnostics.unified_debug as _ud
import oc_diagnostics.ui_event_logger as _uelog
from oc_diagnostics.ui_event_logger import register_callbacks, REQUIRED_STORE_ID
 
 
# ============================================================
# IMPORT AND PUBLIC API
# ============================================================
 
def test_ui_event_logger_import():
    """ui_event_logger module imports cleanly and exposes register_callbacks()."""
    assert hasattr(_uelog, "register_callbacks"), (
        "ui_event_logger must expose register_callbacks()"
    )
 
 
# ============================================================
# REQUIRED_STORE_ID CONSTANT
# ============================================================
 
def test_required_store_id_constant():
    """REQUIRED_STORE_ID has the expected constant value."""
    assert REQUIRED_STORE_ID == "debug-settings-data-store", (
        f"Expected 'debug-settings-data-store', got {REQUIRED_STORE_ID!r}"
    )
 
 
# ============================================================
# CUSTOM UI_EVENT_PROPERTIES (OI-28)
# ============================================================
 
def test_ui_logger_custom_props():
    """register_callbacks() accepts UI_EVENT_PROPERTIES with a reduced property set."""
    old_props = _ud.UI_EVENT_PROPERTIES
    try:
        _ud.UI_EVENT_PROPERTIES = ("n_clicks", "value")  # 2 props instead of default 5
        app = Dash(__name__)
        app.layout = html.Div([
            dcc.Store(id="debug-settings-data-store", storage_type="memory"),
        ])
        register_callbacks(app)  # must not raise TypeError
        assert len(app.callback_map) >= 1, (
            "Expected at least one registered callback with 2-prop UI_EVENT_PROPERTIES"
        )
    finally:
        _ud.UI_EVENT_PROPERTIES = old_props