wrolpi/modules/zim/test/test_restart_kiwix.py
lrnselfreliance e0fdb762fc
Some checks are pending
CodeQL / Analyze (push) Waiting to run
Controller Tests / controller-tests (push) Waiting to run
Jest Tests / jest-tests (push) Waiting to run
zim: recompute the outdated-Zims flag after startup and on Delete (#706)
* zim: recompute the outdated-Zims flag after startup and on Delete

The Dashboard shows the "Outdated Zim Files" banner from the persisted
`outdated_zims` flag, but the modal lists files from a live scan.  The two
disagreed: the flag was restored from the DB on startup and never
recomputed once the outdated file had been removed, so the banner showed
with nothing to delete, and the modal displayed an endless placeholder.

- The startup recompute now runs after the DB is up and configs are
  imported, so it overrides the value `init_flags` restored from the DB.
  Previously it ran before the DB was up, and the restored value won.
- DELETE /api/zim/outdated always recomputes the flag, even when nothing
  was deleted, so clicking Delete clears a stale banner.
- The modal re-scans when opened and says when nothing was found instead
  of showing a placeholder.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* zim: enforce restore-then-scan ordering; no Kiwix restart on empty delete

- Startup calls flags.init_flags() then flag_outdated_zim_files() right
  after db_up, before the DB config import, so the disk scan always
  overwrites the DB-restored value in one local sequence.
- DELETE /api/zim/outdated recomputes the flag in a finally.
- remove_outdated_zim_files skips refresh and the Kiwix restart when no
  file was deleted.
- Trim narrative comments to the constraint they enforce.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-12 15:19:36 -06:00

147 lines
5.8 KiB
Python

"""Tests for the restart_kiwix switch handler triggered by model_zim()."""
from unittest import mock
import pytest
from modules.zim import lib
from modules.zim.models import Zim
from wrolpi.api_utils import api_app
from wrolpi.files.models import FileGroup
@pytest.mark.asyncio
async def test_restart_kiwix_systemctl_command_shape():
"""restart_kiwix() must call systemctl with `restart` and the unit name as
separate argv entries. Adjacent-string-literal typos (missing comma in
a Python tuple) silently produce 'restartwrolpi-kiwix.service' as a single
argument, which systemctl rejects."""
captured = {}
async def fake_run_command(cmd):
captured['cmd'] = cmd
return mock.MagicMock(return_code=0, stderr=b'')
with mock.patch.object(lib, 'PYTEST', False), \
mock.patch.object(lib, 'DOCKERIZED', False), \
mock.patch.object(lib, 'run_command', side_effect=fake_run_command):
await lib.restart_kiwix()
cmd = captured['cmd']
assert 'restart' in cmd
assert 'wrolpi-kiwix.service' in cmd
# 'restart' and the unit must NOT be concatenated into one argv entry.
assert 'restartwrolpi-kiwix.service' not in cmd
@pytest.mark.asyncio
async def test_model_zim_activates_restart_switch(async_client, test_session, zim_path_factory):
"""model_zim() should activate the restart_kiwix switch when creating a new Zim."""
# Create a zim file and its FileGroup
zim_path = zim_path_factory('test_restart.zim')
file_group = FileGroup.from_paths(test_session, zim_path)
test_session.commit()
# Verify no switches are pending
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' not in switches
# Call model_zim which should activate the switch
lib.model_zim(file_group, test_session)
test_session.commit()
# Verify the switch was activated
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' in switches
@pytest.mark.asyncio
async def test_existing_zim_does_not_trigger_restart(async_client, test_session, zim_factory, await_switches):
"""model_zim() should NOT activate restart switch for existing Zims."""
# Create a zim using the factory (this calls model_zim internally via Zim.from_paths)
zim = zim_factory('existing.zim')
test_session.commit()
# Clear any pending switches
await await_switches()
# Verify no switches are pending
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' not in switches
# Call model_zim again on the same FileGroup - should NOT trigger restart
lib.model_zim(zim.file_group, test_session)
test_session.commit()
# Verify the switch was NOT activated (Zim already exists)
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' not in switches
@pytest.mark.asyncio
async def test_multiple_zims_trigger_single_restart(async_client, test_session, zim_path_factory):
"""Multiple new Zims should result in only one restart (debouncing via switch)."""
# Create multiple zim files
paths = [zim_path_factory(f'test_debounce_{i}.zim') for i in range(3)]
# Create FileGroups and model each one
for path in paths:
file_group = FileGroup.from_paths(test_session, path)
test_session.commit()
lib.model_zim(file_group, test_session)
test_session.commit()
# Verify switch was activated (only once, due to debouncing)
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' in switches
# The switch dict contains only one entry for restart_kiwix, proving debouncing works
assert list(switches.keys()).count('restart_kiwix') == 1
@pytest.mark.asyncio
async def test_remove_outdated_zim_files_triggers_restart(async_client, test_session, test_directory, zim_path_factory,
await_switches):
"""remove_outdated_zim_files() should trigger the restart_kiwix switch."""
# Create outdated and current zim files
zim_dir = test_directory / 'zims'
zim_dir.mkdir(exist_ok=True)
# Create an "outdated" zim and a "current" zim (based on date in filename)
outdated_path = zim_dir / 'wikipedia_en_all_maxi_2020-01.zim'
current_path = zim_dir / 'wikipedia_en_all_maxi_2020-02.zim'
# Copy test zim bytes to both paths
test_zim_bytes = zim_path_factory().read_bytes()
outdated_path.write_bytes(test_zim_bytes)
current_path.write_bytes(test_zim_bytes)
# Clear any pending switches first
await await_switches()
# Call remove_outdated_zim_files
deleted_count = await lib.remove_outdated_zim_files(zim_dir)
# Verify the outdated file was deleted
assert deleted_count == 1
assert not outdated_path.exists()
assert current_path.exists()
# Verify the switch was activated
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' in switches
@pytest.mark.asyncio
async def test_remove_outdated_zim_files_no_restart_when_nothing_deleted(async_client, test_session, test_directory,
zim_path_factory, await_switches):
"""Clearing a stale flag must not restart Kiwix when no file was deleted."""
zim_dir = test_directory / 'zims'
zim_dir.mkdir(exist_ok=True)
(zim_dir / 'wikipedia_en_all_maxi_2020-02.zim').write_bytes(zim_path_factory().read_bytes())
await await_switches()
deleted_count = await lib.remove_outdated_zim_files(zim_dir)
assert deleted_count == 0
switches = dict(api_app.shared_ctx.switches) if api_app.shared_ctx.switches else {}
assert 'restart_kiwix' not in switches