HERMES-GIELIE/tests/test_auth_session_persistence.py

241 lines
11 KiB
Python
Raw Normal View History

"""Regression tests: auth sessions persist across process restarts.
_sessions is an in-memory dict. Without persistence, any restart (launchd,
systemd, container) invalidates all active browser sessions and floods clients
with 401s until they clear cookies. The HMAC signing key already persists to
STATE_DIR; this PR persists the session table using the same pattern.
"""
import importlib
import json
import os
import sys
import tempfile
import time
import unittest
from pathlib import Path
from unittest import mock
# Isolate state dir so tests never touch real sessions
_TEST_STATE = Path(tempfile.mkdtemp())
os.environ["HERMES_WEBUI_STATE_DIR"] = str(_TEST_STATE)
sys.path.insert(0, str(Path(__file__).parent.parent))
import api.auth as auth
class TestSessionPersistence(unittest.TestCase):
"""Sessions survive a simulated process restart (module reload)."""
def setUp(self) -> None:
# Bind api.auth's STATE_DIR-derived globals to THIS file's _TEST_STATE,
# regardless of import/reload order. pytest-shard distributes individual
# test items, so a shard may run a key/session test WITHOUT any of the
# _simulate_restart() tests that (as a reload side effect) rebind
# auth.STATE_DIR to _TEST_STATE. Without this, auth.STATE_DIR keeps
# conftest's TEST_STATE_DIR: _load_key() then reads the wrong dir (so the
# sentinel key is "missing", no OSError fires, and assertLogs sees no
# WARNING), and the warning's "STATE_DIR=..." never contains _TEST_STATE.
# Patching the actual bindings the code reads makes every test in this
# class self-contained. Saved values are restored in tearDown.
self._saved_state_dir = auth.STATE_DIR
self._saved_sessions_file = auth._SESSIONS_FILE
self._saved_login_attempts_file = auth._LOGIN_ATTEMPTS_FILE
auth.STATE_DIR = _TEST_STATE
auth._SESSIONS_FILE = _TEST_STATE / '.sessions.json'
auth._LOGIN_ATTEMPTS_FILE = _TEST_STATE / '.login_attempts.json'
auth._sessions.clear()
auth._PBKDF2_KEY_CACHE = None
auth._SIGNING_KEY_CACHE = None
for name in ('.sessions.json', '.signing_key', '.pbkdf2_key'):
path = _TEST_STATE / name
if path.exists():
path.unlink()
def tearDown(self) -> None:
auth.STATE_DIR = self._saved_state_dir
auth._SESSIONS_FILE = self._saved_sessions_file
auth._LOGIN_ATTEMPTS_FILE = self._saved_login_attempts_file
auth._sessions.clear()
auth._PBKDF2_KEY_CACHE = None
auth._SIGNING_KEY_CACHE = None
def _simulate_restart(self) -> None:
v0.50.211: compact timestamps, adaptive title refresh, settings picker fix (#1061) * Shorten session sidebar relative time labels * feat: adaptive session title refresh based on conversation evolution Addresses #869 — the 'Optional' part: adapt session names to current conversation context instead of only generating once from the first exchange. Backend (api/streaming.py): - Add _latest_exchange_snippets() to extract last user+assistant pair - Add _count_exchanges() to count user messages - Add _get_title_refresh_interval() to read the setting - Add _run_background_title_refresh() — refreshes title from latest exchange with LLM, skips if title is unchanged or user manually renamed - Add _maybe_schedule_title_refresh() — checks exchange count and schedules refresh after stream_end (non-blocking) Config (api/config.py): - Add auto_title_refresh_every setting (default '0' = off) - Enum validation: {'0', '5', '10', '20'} Frontend: - Settings UI dropdown (static/index.html) - Wire up load/save in panels.js - i18n keys for all 6 locales (en/ru/es/de/zh/zh-Hant) Default: off. Opt-in via Settings > Conversation > Adaptive title refresh. * test: add 37 tests for adaptive title refresh helpers Covers all five new functions introduced in this PR: _count_exchanges, _latest_exchange_snippets, _get_title_refresh_interval, _run_background_title_refresh, _maybe_schedule_title_refresh Co-authored-by: bergeouss <bergeouss@users.noreply.github.com> * fix(settings): show selected state on theme/skin/font-size picker cards The CSS rule `#mainSettings .theme-pick-btn { border-color: var(--border) !important }` was overriding the inline `style.borderColor = "var(--accent)"` set by `_syncThemePicker()` and siblings — `!important` beats inline styles. Active cards showed no visual highlight. Fix: move to `.active` CSS class with `border-color:var(--accent)!important` so the active rule wins over the base rule, and clear the stale inline borderColor/boxShadow from the sync functions. 5 regression tests added. Closes #1057 * fix: rename test file to match PR number, fix stale issue reference * docs: v0.50.211 release notes and version bump Compact sidebar timestamps, adaptive title refresh (opt-in), settings picker fix. * docs(changelog): correct settings tab for adaptive title refresh The v0.50.211 entry for #1058 said "Settings → Appearance" but the toggle is actually rendered inside settingsPanePreferences (the Preferences tab) per static/index.html:604+. The commit message also had the wrong tab ("Conversation"). Updated CHANGELOG to match the actual UI surface so users can find the toggle. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: create state dir before writing settings file save_settings() called SETTINGS_FILE.write_text() without ensuring the parent directory exists. In fresh environments (CI, first run without HERMES_WEBUI_STATE_DIR set) this raised FileNotFoundError. Add mkdir(parents=True, exist_ok=True) before the write. --------- Co-authored-by: Pavol Biely <biely@webtec.sk> Co-authored-by: bergeouss <bergeouss@users.noreply.github.com> Co-authored-by: nesquena-hermes <nesquena-hermes@users.noreply.github.com> Co-authored-by: Nathan Esquenazi <nesquena@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-26 00:50:58 +00:00
"""Reload auth module to simulate a fresh process start.
api.auth does `from api.config import STATE_DIR` at module level, so
`_SESSIONS_FILE` is computed from api.config.STATE_DIR at reload time.
We temporarily override api.config.STATE_DIR so the reload uses the
test state dir without reloading api.config itself, which would
invalidate imported references like STREAM_PARTIAL_TEXT in other tests.
v0.50.211: compact timestamps, adaptive title refresh, settings picker fix (#1061) * Shorten session sidebar relative time labels * feat: adaptive session title refresh based on conversation evolution Addresses #869 — the 'Optional' part: adapt session names to current conversation context instead of only generating once from the first exchange. Backend (api/streaming.py): - Add _latest_exchange_snippets() to extract last user+assistant pair - Add _count_exchanges() to count user messages - Add _get_title_refresh_interval() to read the setting - Add _run_background_title_refresh() — refreshes title from latest exchange with LLM, skips if title is unchanged or user manually renamed - Add _maybe_schedule_title_refresh() — checks exchange count and schedules refresh after stream_end (non-blocking) Config (api/config.py): - Add auto_title_refresh_every setting (default '0' = off) - Enum validation: {'0', '5', '10', '20'} Frontend: - Settings UI dropdown (static/index.html) - Wire up load/save in panels.js - i18n keys for all 6 locales (en/ru/es/de/zh/zh-Hant) Default: off. Opt-in via Settings > Conversation > Adaptive title refresh. * test: add 37 tests for adaptive title refresh helpers Covers all five new functions introduced in this PR: _count_exchanges, _latest_exchange_snippets, _get_title_refresh_interval, _run_background_title_refresh, _maybe_schedule_title_refresh Co-authored-by: bergeouss <bergeouss@users.noreply.github.com> * fix(settings): show selected state on theme/skin/font-size picker cards The CSS rule `#mainSettings .theme-pick-btn { border-color: var(--border) !important }` was overriding the inline `style.borderColor = "var(--accent)"` set by `_syncThemePicker()` and siblings — `!important` beats inline styles. Active cards showed no visual highlight. Fix: move to `.active` CSS class with `border-color:var(--accent)!important` so the active rule wins over the base rule, and clear the stale inline borderColor/boxShadow from the sync functions. 5 regression tests added. Closes #1057 * fix: rename test file to match PR number, fix stale issue reference * docs: v0.50.211 release notes and version bump Compact sidebar timestamps, adaptive title refresh (opt-in), settings picker fix. * docs(changelog): correct settings tab for adaptive title refresh The v0.50.211 entry for #1058 said "Settings → Appearance" but the toggle is actually rendered inside settingsPanePreferences (the Preferences tab) per static/index.html:604+. The commit message also had the wrong tab ("Conversation"). Updated CHANGELOG to match the actual UI surface so users can find the toggle. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: create state dir before writing settings file save_settings() called SETTINGS_FILE.write_text() without ensuring the parent directory exists. In fresh environments (CI, first run without HERMES_WEBUI_STATE_DIR set) this raised FileNotFoundError. Add mkdir(parents=True, exist_ok=True) before the write. --------- Co-authored-by: Pavol Biely <biely@webtec.sk> Co-authored-by: bergeouss <bergeouss@users.noreply.github.com> Co-authored-by: nesquena-hermes <nesquena-hermes@users.noreply.github.com> Co-authored-by: Nathan Esquenazi <nesquena@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-26 00:50:58 +00:00
"""
import api.config as _config
saved_state_dir = _config.STATE_DIR
v0.50.211: compact timestamps, adaptive title refresh, settings picker fix (#1061) * Shorten session sidebar relative time labels * feat: adaptive session title refresh based on conversation evolution Addresses #869 — the 'Optional' part: adapt session names to current conversation context instead of only generating once from the first exchange. Backend (api/streaming.py): - Add _latest_exchange_snippets() to extract last user+assistant pair - Add _count_exchanges() to count user messages - Add _get_title_refresh_interval() to read the setting - Add _run_background_title_refresh() — refreshes title from latest exchange with LLM, skips if title is unchanged or user manually renamed - Add _maybe_schedule_title_refresh() — checks exchange count and schedules refresh after stream_end (non-blocking) Config (api/config.py): - Add auto_title_refresh_every setting (default '0' = off) - Enum validation: {'0', '5', '10', '20'} Frontend: - Settings UI dropdown (static/index.html) - Wire up load/save in panels.js - i18n keys for all 6 locales (en/ru/es/de/zh/zh-Hant) Default: off. Opt-in via Settings > Conversation > Adaptive title refresh. * test: add 37 tests for adaptive title refresh helpers Covers all five new functions introduced in this PR: _count_exchanges, _latest_exchange_snippets, _get_title_refresh_interval, _run_background_title_refresh, _maybe_schedule_title_refresh Co-authored-by: bergeouss <bergeouss@users.noreply.github.com> * fix(settings): show selected state on theme/skin/font-size picker cards The CSS rule `#mainSettings .theme-pick-btn { border-color: var(--border) !important }` was overriding the inline `style.borderColor = "var(--accent)"` set by `_syncThemePicker()` and siblings — `!important` beats inline styles. Active cards showed no visual highlight. Fix: move to `.active` CSS class with `border-color:var(--accent)!important` so the active rule wins over the base rule, and clear the stale inline borderColor/boxShadow from the sync functions. 5 regression tests added. Closes #1057 * fix: rename test file to match PR number, fix stale issue reference * docs: v0.50.211 release notes and version bump Compact sidebar timestamps, adaptive title refresh (opt-in), settings picker fix. * docs(changelog): correct settings tab for adaptive title refresh The v0.50.211 entry for #1058 said "Settings → Appearance" but the toggle is actually rendered inside settingsPanePreferences (the Preferences tab) per static/index.html:604+. The commit message also had the wrong tab ("Conversation"). Updated CHANGELOG to match the actual UI surface so users can find the toggle. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix: create state dir before writing settings file save_settings() called SETTINGS_FILE.write_text() without ensuring the parent directory exists. In fresh environments (CI, first run without HERMES_WEBUI_STATE_DIR set) this raised FileNotFoundError. Add mkdir(parents=True, exist_ok=True) before the write. --------- Co-authored-by: Pavol Biely <biely@webtec.sk> Co-authored-by: bergeouss <bergeouss@users.noreply.github.com> Co-authored-by: nesquena-hermes <nesquena-hermes@users.noreply.github.com> Co-authored-by: Nathan Esquenazi <nesquena@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-26 00:50:58 +00:00
_config.STATE_DIR = _TEST_STATE
try:
importlib.reload(auth)
finally:
_config.STATE_DIR = saved_state_dir
def test_session_survives_restart(self) -> None:
"""A session created before restart should still verify after reload."""
cookie = auth.create_session()
self.assertTrue(auth.verify_session(cookie))
self._simulate_restart()
self.assertTrue(
auth.verify_session(cookie),
"Session must survive process restart via persisted .sessions.json",
)
def test_invalidated_session_does_not_survive_restart(self) -> None:
"""Invalidating a session must be reflected after reload."""
cookie = auth.create_session()
auth.invalidate_session(cookie)
self._simulate_restart()
self.assertFalse(
auth.verify_session(cookie),
"Invalidated session must not be reinstated after restart",
)
def test_expired_sessions_pruned_on_load(self) -> None:
"""Sessions that expire between restarts must not be loaded."""
sessions_file = _TEST_STATE / '.sessions.json'
now = time.time()
sessions_file.write_text(json.dumps({
"expired_token": now - 10,
"valid_token": now + 3600,
}))
self._simulate_restart()
self.assertNotIn("expired_token", auth._sessions)
self.assertIn("valid_token", auth._sessions)
def test_sessions_file_permissions(self) -> None:
"""Sessions file must stay strict on POSIX and still be created on Windows."""
auth.create_session()
ci: run test suite in 3 parallel shards + make suite shard-safe Completes the test-sharding half of #3197 (Docker-cache half shipped v0.51.177). Adds pytest-shard 3-way split to tests.yml (3 shards x 3 Python = 9 jobs, fail-fast: false). pytest-shard is 0-indexed so the matrix uses [0,1,2] — the original #3197 used [1,2,3] which would have crashed the out-of-range job and silently skipped shard 0's tests. Made the suite shard-safe by fixing 4 cross-test state-pollution bugs that passed sequentially but failed when sharded: - test_onboarding_mvp: reset onboarding_completed flag (settings.json) in the autouse fixture; the config-cleanup only cleared config.yaml/.env. - test_issue693_system_health_panel: invalidate the process-wide password-hash cache before/after so a prior test's "no password" cache doesn't defeat the auth-gate assertion. - test_auth_session_persistence: assert against auth._SESSIONS_FILE (where auth actually writes) instead of a local _TEST_STATE path that only matched under a lucky import order. - test_profile_env_isolation (root cause of the worst leak): stop deleting + re-importing api.profiles under a temp HERMES_BASE_HOME — that swapped the module object and poisoned the cached _DEFAULT_HERMES_HOME for every later test (broke test_title_aux_routing's load_config). Now points the cached path via monkeypatch.setattr (auto-restored, no module swap). - conftest: autouse fixture restores HERMES_HOME/HERMES_BASE_HOME after each test as defense-in-depth against future switch_profile leaks. Verified: all 3 shards green (6912 passed, 0 failed); full sequential run still green (6957 passed, 0 failed). Slowest shard ~70s vs ~180s sequential.
2026-05-30 21:09:25 +00:00
sessions_file = auth._SESSIONS_FILE
self.assertTrue(sessions_file.exists(), ".sessions.json was not created")
if os.name == "nt":
self.assertTrue(sessions_file.is_file(), ".sessions.json was not written as a file")
return
mode = oct(sessions_file.stat().st_mode & 0o777)
self.assertEqual(
mode,
oct(0o600),
f".sessions.json permissions {mode} - expected 0o600",
)
def test_malformed_sessions_file_starts_fresh(self) -> None:
"""A corrupt sessions file must not crash auth, start with an empty dict."""
sessions_file = _TEST_STATE / '.sessions.json'
sessions_file.write_text("not valid json {{{{")
with self.assertLogs('api.auth', level='WARNING') as captured:
self._simulate_restart()
self.assertEqual(
auth._sessions,
{},
"Corrupt sessions file must result in empty session dict",
)
warning = '\n'.join(captured.output)
self.assertIn('Ignoring malformed auth session store', warning)
self.assertIn(str(sessions_file), warning)
self.assertIn(str(_TEST_STATE), warning)
def test_session_read_failure_warns_with_state_dir_and_starts_fresh(self) -> None:
"""Unreadable sessions files must warn and start with an empty dict."""
sessions_file = _TEST_STATE / '.sessions.json'
sessions_file.write_text(json.dumps({"token": time.time() + 3600}))
with mock.patch.object(Path, 'read_text', side_effect=OSError('read failed')):
with self.assertLogs('api.auth', level='WARNING') as captured:
self._simulate_restart()
self.assertEqual(auth._sessions, {})
warning = '\n'.join(captured.output)
self.assertIn('Auth session store read failed', warning)
self.assertIn(str(sessions_file), warning)
self.assertIn(str(_TEST_STATE), warning)
def test_session_decode_failure_warns_with_state_dir_and_starts_fresh(self) -> None:
"""Invalid UTF-8 in the sessions file must warn and start with an empty dict."""
sessions_file = _TEST_STATE / '.sessions.json'
sessions_file.write_bytes(b'\xff')
with self.assertLogs('api.auth', level='WARNING') as captured:
self._simulate_restart()
self.assertEqual(auth._sessions, {})
warning = '\n'.join(captured.output)
self.assertIn('Ignoring malformed auth session store', warning)
self.assertIn(str(sessions_file), warning)
self.assertIn(str(_TEST_STATE), warning)
def test_session_recursion_failure_warns_with_state_dir_and_starts_fresh(self) -> None:
"""Deeply nested JSON must warn and fall back to an empty session table."""
sessions_file = _TEST_STATE / '.sessions.json'
depth = 50000
sessions_file.write_text('{"token":' * depth + '0' + '}' * depth)
with self.assertLogs('api.auth', level='WARNING') as captured:
self._simulate_restart()
self.assertEqual(auth._sessions, {})
warning = '\n'.join(captured.output)
self.assertIn('Ignoring malformed auth session store', warning)
self.assertIn('RecursionError', warning)
self.assertIn(str(sessions_file), warning)
self.assertIn(str(_TEST_STATE), warning)
def test_session_save_failure_warns_with_state_dir_and_keeps_in_process_session(self) -> None:
"""Write failures must warn but keep the live session usable in-process."""
sentinel_token = 'deadbeef' * 8
with mock.patch.object(auth.secrets, 'token_hex', return_value=sentinel_token):
with mock.patch.object(auth.os, 'replace', side_effect=OSError('replace failed')):
with self.assertLogs('api.auth', level='WARNING') as captured:
cookie = auth.create_session()
self.assertTrue(auth.verify_session(cookie))
warning = '\n'.join(captured.output)
self.assertIn('Auth session persistence failed', warning)
self.assertIn('.sessions.json', warning)
self.assertIn(str(_TEST_STATE), warning)
self.assertNotIn(sentinel_token, warning)
self.assertNotIn(cookie, warning)
def test_signing_key_read_failure_warns_with_state_dir(self) -> None:
"""Unreadable signing keys must warn and fall back to a fresh key."""
key_file = _TEST_STATE / '.signing_key'
sentinel_key = 'secret-key-material'
key_file.write_text(sentinel_key)
with mock.patch.object(Path, 'read_bytes', side_effect=OSError('read failed')):
with self.assertLogs('api.auth', level='WARNING') as captured:
key = auth._load_key('.signing_key')
self.assertIsInstance(key, bytes)
self.assertEqual(len(key), 32)
warning = '\n'.join(captured.output)
self.assertIn('Auth key read failed', warning)
self.assertIn('.signing_key', warning)
self.assertIn(str(_TEST_STATE), warning)
self.assertNotIn(sentinel_key, warning)
def test_signing_key_persist_failure_warns_with_state_dir(self) -> None:
"""Key write failures must warn and still return a generated key."""
with mock.patch.object(Path, 'write_bytes', side_effect=OSError('write failed')):
with self.assertLogs('api.auth', level='WARNING') as captured:
key = auth._load_key('.signing_key')
self.assertIsInstance(key, bytes)
self.assertEqual(len(key), 32)
warning = '\n'.join(captured.output)
self.assertIn('Auth key persistence failed', warning)
self.assertIn('.signing_key', warning)
self.assertIn(str(_TEST_STATE), warning)
def test_sessions_file_wrong_type_starts_fresh(self) -> None:
"""A sessions file containing a non-dict must be ignored."""
sessions_file = _TEST_STATE / '.sessions.json'
sessions_file.write_text(json.dumps(["list", "not", "dict"]))
with self.assertLogs('api.auth', level='WARNING') as captured:
self._simulate_restart()
self.assertEqual(auth._sessions, {})
warning = '\n'.join(captured.output)
self.assertIn('Ignoring malformed auth session store', warning)
self.assertIn(str(sessions_file), warning)
self.assertIn(str(_TEST_STATE), warning)
if __name__ == "__main__":
unittest.main()