mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-10-26 19:01:39 -04:00
Tags can be created and deleted in UI. Adding tag_file using id to avoid session error. Using UTC in test. Matching tag_names style in test. Tag icon is displayed on file rows. Archives, Videos and Files can be filtered by their tags. Tags can be added and removed from UI. Tags are displayed in VideoPlayer. The tags of a file are returned in it's JSON. Video favorites are converted to Favorite tag on channel config import. Updating tests to match frontend usage. PDF creator and modification time are displayed. Reworking file search to use Video.__json__ for complex video relations. Archives can be viewed. Removing ebook.title. Reworking alembic migration to be an upgrade rather than a replace. Skipping test on circleci. Clearing out video caption index only if extract_subtitles if off. Channel tests pass. Some video tests pass. Missing videos can be found. A video can be downloaded. Orphaned files can be found. Videos can be tagged. Videos can be searched. Videos can be modeled. Converting some tests to use FileGroup.primary_path. Adding archive and domains to alembic migration. Testing cascading Archive titles. Archives now uses FileGroup. archive.lib tests pass. Archive is partially converted to FileGroup. Calculating FileGroup.primary file on refresh, rather than on select. wrolpi tests pass. Using FilesType to convert between str/pathlib.Path for FileGroup.files. Using list of files in FileGroup.files instead of dictionary. Storing files in dedicated FileGroup.files to avoid overwriting them. Adding comment explaining CASE. Not overwriting FileGroup.data on refresh if no change has been detected. Removing File model in favor of FileGroup.data. Adding typing to Files methods. Files are indexed using the primary mimetype of the FileGroup. files test_lib tests pass. Removing file_group_file in favor of simple one-to-many relationship. PDF files are indexed during refresh. Adding Tag and TagFile to tag files with specific tags. Only iterating when full_stem_ids has contents. Testing that FileGroups are related to their Files. Files and file_groups are created and linked. Bump webpack from 5.75.0 to 5.76.1 in /app (#160) Bumps [webpack](https://github.com/webpack/webpack) from 5.75.0 to 5.76.1. - [Release notes](https://github.com/webpack/webpack/releases) - [Commits](https://github.com/webpack/webpack/compare/v5.75.0...v5.76.1) --- updated-dependencies: - dependency-name: webpack dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
270 lines
9.9 KiB
Python
270 lines
9.9 KiB
Python
import json
|
|
import pathlib
|
|
import shutil
|
|
from http import HTTPStatus
|
|
from itertools import zip_longest
|
|
from typing import List
|
|
from uuid import uuid4
|
|
|
|
import mock
|
|
import pytest
|
|
from PIL import Image
|
|
|
|
from modules.videos.downloader import VideoDownloader, ChannelDownloader
|
|
from modules.videos.lib import set_test_channels_config, set_test_downloader_config
|
|
from modules.videos.models import Channel, Video
|
|
from wrolpi.downloader import DownloadFrequency, DownloadManager, Download
|
|
from wrolpi.files.models import FileGroup
|
|
from wrolpi.vars import PROJECT_DIR
|
|
|
|
|
|
@pytest.fixture
|
|
def simple_channel(test_session, test_directory) -> Channel:
|
|
"""Get a Channel with the minimum properties. This Channel has no download!"""
|
|
channel = Channel(
|
|
directory=test_directory,
|
|
name='Simple Channel',
|
|
url='https://example.com/channel1',
|
|
download_frequency=None, # noqa
|
|
)
|
|
test_session.add(channel)
|
|
test_session.commit()
|
|
return channel
|
|
|
|
|
|
@pytest.fixture
|
|
def channel_factory(test_session, test_directory):
|
|
"""Create a random Channel with a directory, but no frequency."""
|
|
|
|
def factory(source_id: str = None, download_frequency: DownloadFrequency = None, url: str = None, name: str = None):
|
|
name = name or str(uuid4())
|
|
directory = test_directory / name
|
|
directory.mkdir()
|
|
channel = Channel(
|
|
directory=directory, # noqa
|
|
name=name,
|
|
url=url or f'https://example.com/{name}',
|
|
download_frequency=download_frequency,
|
|
source_id=source_id,
|
|
)
|
|
test_session.add(channel)
|
|
test_session.commit()
|
|
return channel
|
|
|
|
return factory
|
|
|
|
|
|
@pytest.fixture
|
|
def download_channel(test_session, test_directory, video_download_manager) -> Channel:
|
|
"""Get a test Channel that has a download frequency."""
|
|
# Add a frequency to the test channel, then give it a download.
|
|
channel = Channel(
|
|
directory=test_directory,
|
|
name='Download Channel',
|
|
url='https://example.com/channel1',
|
|
download_frequency=DownloadFrequency.weekly,
|
|
)
|
|
download = Download(url=channel.url, downloader='video_channel', frequency=channel.download_frequency)
|
|
test_session.add_all([channel, download])
|
|
test_session.commit()
|
|
return channel
|
|
|
|
|
|
@pytest.fixture
|
|
def simple_video(test_session, test_directory, simple_channel, video_file) -> Video:
|
|
"""A Video with an empty video file whose channel is the Simple Channel."""
|
|
video_path = test_directory / 'simple_video.mp4'
|
|
video_file.rename(video_path)
|
|
video = Video.from_paths(test_session, video_path)
|
|
video.channel = simple_channel
|
|
test_session.commit()
|
|
video = test_session.query(Video).filter_by(id=video.id).one()
|
|
return video
|
|
|
|
|
|
@pytest.fixture
|
|
def video_factory(test_session, test_directory):
|
|
"""Creates Videos for testing."""
|
|
|
|
def factory(channel_id: int = None, title: str = None, upload_date=None, with_video_file=None,
|
|
with_info_json: dict = None, with_poster_ext: str = None, with_caption_file: bool = False,
|
|
source_id: str = None) -> Video:
|
|
title = title or str(uuid4())
|
|
|
|
if with_video_file and isinstance(with_video_file, (pathlib.Path, str)):
|
|
# Put the video exactly where specified for the test.
|
|
path = pathlib.Path(with_video_file) if not isinstance(with_video_file, pathlib.Path) else with_video_file
|
|
elif channel_id:
|
|
# Put the video in its Channel's directory.
|
|
channel = test_session.query(Channel).filter_by(id=channel_id).one()
|
|
path = (channel.directory or test_directory) / f'{title}.mp4'
|
|
else:
|
|
# Put any video not in a Channel and without a specified file in the NO CHANNEL directory.
|
|
(test_directory / 'videos/NO CHANNEL').mkdir(exist_ok=True, parents=True)
|
|
path = test_directory / f'videos/NO CHANNEL/{title}.mp4'
|
|
|
|
# Create a real video file for mimetype.
|
|
shutil.copy(PROJECT_DIR / 'test/big_buck_bunny_720p_1mb.mp4', path)
|
|
|
|
info_json_path = None
|
|
if with_info_json:
|
|
# Use the provided object as the json.
|
|
with_info_json = {'duration': 5} if with_info_json is True else with_info_json
|
|
info_json_path = path.with_suffix('.info.json')
|
|
info_json_path.write_text(json.dumps(with_info_json))
|
|
|
|
poster_path = None
|
|
if with_poster_ext:
|
|
poster_path = path.with_suffix(f'.{with_poster_ext.lstrip(".")}')
|
|
Image.new('RGB', (25, 25)).save(poster_path)
|
|
|
|
caption_path = None
|
|
if with_caption_file:
|
|
caption_path = path.with_suffix('.en.vtt')
|
|
shutil.copy(PROJECT_DIR / 'test/example1.en.vtt', caption_path)
|
|
|
|
paths = (path, info_json_path, poster_path, caption_path)
|
|
paths = list(filter(None, paths))
|
|
|
|
video = Video.from_paths(test_session, *paths)
|
|
video.channel_id = channel_id
|
|
video.source_id = source_id or title
|
|
video.upload_date = upload_date
|
|
video.validate()
|
|
return video
|
|
|
|
return factory
|
|
|
|
|
|
@pytest.fixture
|
|
def video_download_manager(test_download_manager) -> DownloadManager:
|
|
"""Get a DownloadManager ready to download Videos and Channels."""
|
|
channel_downloader = ChannelDownloader()
|
|
video_downloader = VideoDownloader(priority=40)
|
|
|
|
test_download_manager.register_downloader(channel_downloader)
|
|
test_download_manager.register_downloader(video_downloader)
|
|
|
|
with mock.patch('modules.videos.downloader.YDL.extract_info') as mock_extract_info: # prevent real downloads
|
|
mock_extract_info.side_effect = Exception('You must patch modules.videos.downloader.YDL.extract_info!')
|
|
yield test_download_manager
|
|
|
|
|
|
@pytest.fixture
|
|
def test_channels_config(test_directory):
|
|
(test_directory / 'config').mkdir(exist_ok=True)
|
|
config_path = test_directory / 'config/channels.yaml'
|
|
with set_test_channels_config():
|
|
yield config_path
|
|
|
|
|
|
@pytest.fixture
|
|
def test_downloader_config(test_directory):
|
|
(test_directory / 'config').mkdir(exist_ok=True)
|
|
config_path = test_directory / 'config/downloader.yaml'
|
|
set_test_downloader_config(True)
|
|
yield config_path
|
|
set_test_downloader_config(False)
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_video_extract_info():
|
|
with mock.patch('modules.videos.downloader.extract_info') as mock_extract_info:
|
|
yield mock_extract_info
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_video_prepare_filename():
|
|
with mock.patch('modules.videos.downloader.prepare_filename') as mock_prepare_filename:
|
|
yield mock_prepare_filename
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_video_process_runner():
|
|
with mock.patch('modules.videos.downloader.VideoDownloader.process_runner') as mock_process_runner:
|
|
mock_process_runner.return_value = (0, {'stdout': None, 'stderr': None})
|
|
yield mock_process_runner
|
|
|
|
|
|
@pytest.fixture
|
|
def assert_video_ids(test_session):
|
|
"""Check that only the expected Videos are in the DB."""
|
|
|
|
def checker(expected_video_ids: List[int]):
|
|
video_ids = [i.id for i in test_session.query(Video).order_by(Video.id)]
|
|
for id_, expected in zip_longest(video_ids, expected_video_ids):
|
|
assert id_ == expected, f'Video ids were not as expected: {expected_video_ids=} != {video_ids=}'
|
|
|
|
return checker
|
|
|
|
|
|
@pytest.fixture
|
|
def video_with_search_factory(test_session, test_directory, video_file_factory):
|
|
"""A factory that creates a Video record with an associated video File record."""
|
|
|
|
def video_with_search(path: str = None, title: str = None, b_text: str = None, c_text: str = None,
|
|
d_text: str = None, mimetype: str = 'video/mp4'):
|
|
video_file_group = FileGroup.from_paths(test_session, video_file_factory(path))
|
|
video_file_group.a_text = title
|
|
video_file_group.b_text = b_text
|
|
video_file_group.c_text = c_text
|
|
video_file_group.d_text = d_text
|
|
video_file_group.mimetype = mimetype
|
|
video_file_group.model = 'video'
|
|
video = Video(file_group=video_file_group)
|
|
test_session.add(video)
|
|
return video
|
|
|
|
return video_with_search
|
|
|
|
|
|
@pytest.fixture
|
|
def assert_video_search(test_client):
|
|
"""A fixture which performs a video search request against the API.
|
|
|
|
If assert_* params are passed, the response is checked."""
|
|
|
|
def search_videos(
|
|
assert_total: int = None,
|
|
assert_ids: List[int] = None,
|
|
assert_paths: List[str] = None,
|
|
search_str: str = None,
|
|
tag_names: List[str] = None,
|
|
offset: int = None,
|
|
limit: int = None,
|
|
order_by: str = None,
|
|
channel_id: int = None,
|
|
):
|
|
content = dict()
|
|
if search_str is not None:
|
|
content['search_str'] = search_str
|
|
if tag_names is not None:
|
|
content['tag_names'] = tag_names
|
|
if offset is not None:
|
|
content['offset'] = offset
|
|
if limit is not None:
|
|
content['limit'] = limit
|
|
if order_by is not None:
|
|
content['order_by'] = order_by
|
|
if channel_id is not None:
|
|
content['channel_id'] = channel_id
|
|
|
|
request, response = test_client.post('/api/videos/search', content=json.dumps(content))
|
|
|
|
assert response.json
|
|
assert response.status_code == HTTPStatus.OK
|
|
|
|
if assert_ids is not None:
|
|
assert 'file_groups' in response.json, 'No video file_groups in response'
|
|
assert [i['id'] for i in response.json['file_groups']] == assert_ids, 'Video IDs do not match'
|
|
|
|
if assert_paths is not None:
|
|
assert 'file_groups' in response.json, 'No video file_groups in response'
|
|
assert [i['primary_path'] for i in response.json['file_groups']] == assert_paths, 'Video paths do not match'
|
|
|
|
if assert_total and not (count := response.json['totals']['file_groups']) == int(assert_total):
|
|
raise AssertionError(f'Video count does not match: {count} != {assert_total}')
|
|
|
|
return request, response
|
|
|
|
return search_videos
|