wrolpi/wrolpi/sync/test/test_lib.py
lrnselfreliance 38885990f6
The old sync engine is removed (#998)
* The old sync engine is removed

Part 4 of replacing the sync.  Since the previous part a secondary copies its primary with rsync, run by the
Controller, so nothing used the HTTP engine any more:

- the manifest (/api/sync/manifest), the download of a FileGroup's files over HTTP, the copy and import of each
  synced config, the moving of a replaced file's links, the request, cancel and tick of the old sync;
- the API lock that answered 503 SYNCING while that engine ran, its Event, the sync_running flag, the old status
  record in /api/status and its schema, and the frontend's handling of 503 SYNCING;
- their tests.

What a primary says about itself (/api/sync/info), the secondary's settings (its primary, the folders it does not
copy, Test Connection, the folder chooser), taking the primary's library settings when the API starts, and the
daily window of the backup drive stay.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* The primary's sync info no longer reports the largest FileGroup id

Only the old engine read it.  Review also found a docstring that still spoke of a manifest.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* A sync is announced again

Since the Controller runs a sync, nothing sent its events: the old engine did, and the Controller cannot send the
API's events (the API is stopped for most of a sync).  The API's loop now reads the Controller's record of the last
sync and sends one event per finished sync: "Synced N files from the primary" (with the files moved to the trash,
or a warning) or "Sync from the primary failed".  As before, a sync that changed nothing is not announced (within
the window that is every 15 minutes), nor one that was stopped on purpose.  What was announced is kept in
config/.sync, which a sync never touches, so the restart every sync makes neither repeats nor loses one.

Found by review, and by the dead-code check, which saw the two event methods unused.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 15:37:44 -07:00

116 lines
4.7 KiB
Python

"""What is left of the API's side of a secondary's sync: its settings, and the primary's folders it may exclude.
The sync itself is the Controller's (controller/test/test_sync.py)."""
from collections import namedtuple
import pytest
from wrolpi.common import set_test_media_directory
from wrolpi.errors import InvalidConfig
from wrolpi.sync import lib
@pytest.mark.parametrize('path, allowed', [
('videos/channel/video.mp4', True),
('a.txt', True),
('../escape.txt', False),
('videos/../../escape.txt', False),
('/etc/passwd', False),
('videos/.hidden/video.mp4', False),
('.hidden.txt', False),
('config/wrolpi.db', False),
('config/tags.yaml', False),
('tags/one/video.mp4', False),
# A drive that ignores case (exFAT, NTFS, macOS) would write these into the real config and tags folders.
('Config/wrolpi.db', False),
('CONFIG/tags.yaml', False),
('Tags/one/video.mp4', False),
('videos\\video.mp4', False),
('', False),
])
def test_resolve_destination(test_directory, path, allowed):
destination = lib.resolve_destination(test_directory, path)
if allowed:
assert destination == test_directory / path
else:
assert destination is None
def test_resolve_destination_refuses_symlinks(test_directory):
"""A sync never writes through a symlink; it could point outside the media directory."""
outside = test_directory / 'outside'
outside.mkdir()
(test_directory / 'videos').symlink_to(outside)
assert lib.resolve_destination(test_directory, 'videos/video.mp4') is None
(test_directory / 'docs').mkdir()
(test_directory / 'docs/link.txt').symlink_to(outside / 'target.txt')
assert lib.resolve_destination(test_directory, 'docs/link.txt') is None
Primary = namedtuple('Primary', 'directory url state')
@pytest.fixture
def primary(test_directory, secondary_directory, primary_media_server) -> Primary:
"""A primary whose media is `test_directory`, served like Caddy."""
url, state = primary_media_server(test_directory)
return Primary(test_directory, url, state)
@pytest.mark.parametrize('values, expected', [
([], []),
(['Movies'], ['Movies']),
(['/Movies/', ' Movies ', 'Movies//'], ['Movies']),
(['videos/Movies', 'videos'], ['videos']),
(['Movies', 'Movies2', 'Movies/deep'], ['Movies', 'Movies2']),
(['a//b'], ['a/b']),
(['Movies [HD]'], ['Movies [HD]']),
])
def test_normalize_excluded_directories(values, expected):
assert lib.normalize_excluded_directories(values) == expected
@pytest.mark.parametrize('value', ['', '/', '..', 'a/../b', '../a', 'a/./b', '.hidden', 'a/.hidden', 'config',
'config/x', 'tags', 'Config', 'TAGS/x', 'a\\b', None])
def test_normalize_excluded_directories_rejects(value):
with pytest.raises(InvalidConfig):
lib.normalize_excluded_directories([value])
def test_is_excluded():
assert lib.is_excluded('Movies/a.mp4', {'Movies'})
assert lib.is_excluded('Movies', {'Movies'})
assert not lib.is_excluded('Movies2/a.mp4', {'Movies'})
assert not lib.is_excluded('docs/Movies/a.mp4', {'Movies'})
assert lib.is_excluded('docs/Movies/a.mp4', {'docs/Movies'})
def test_list_local_directories(test_directory):
for i in ('Movies', 'videos/channel', 'config', 'tags', '.hidden', 'zims', 'lost+found', 'Tags'):
try:
(test_directory / i).mkdir(parents=True)
except FileExistsError:
pass # 'Tags' is 'tags' on a filesystem that ignores case.
(test_directory / 'file.txt').write_text('a file')
(test_directory / 'link').symlink_to(test_directory / 'Movies')
assert lib.list_local_directories('') == [
dict(name='Movies', path='Movies'), dict(name='videos', path='videos'), dict(name='zims', path='zims')]
assert lib.list_local_directories('/videos/') == [dict(name='channel', path='videos/channel')]
for path in ('../', 'videos/../..', 'file.txt', 'missing', 'link'):
with pytest.raises(InvalidConfig):
lib.list_local_directories(path)
@pytest.mark.asyncio
async def test_list_primary_directories(primary, secondary_directory, make_secondary):
for i in ('Movies', 'videos/channel', 'config', 'tags', '.hidden', 'lost+found'):
(primary.directory / i).mkdir(parents=True)
(primary.directory / 'file.txt').write_text('a file')
set_test_media_directory(secondary_directory)
make_secondary(primary.url)
assert await lib.list_primary_directories('') == [
dict(name='Movies', path='Movies'), dict(name='videos', path='videos')]
assert await lib.list_primary_directories('videos') == [dict(name='channel', path='videos/channel')]
with pytest.raises(InvalidConfig):
await lib.list_primary_directories('../etc')