feat: add SoundRepository and SoundScannerService for audio file management
- Implemented SoundRepository for database operations related to sounds, including methods for retrieving, creating, updating, and deleting sound records. - Developed SoundScannerService to scan directories for audio files, calculate their metadata, and synchronize with the database. - Added support for various audio file formats and integrated ffmpeg for audio duration extraction. - Created comprehensive tests for sound API endpoints and sound scanner service to ensure functionality and error handling. - Updated dependencies to include ffmpeg-python for audio processing.
This commit is contained in:
JSC
298
tests/services/test_sound_scanner.py
Normal file
298
tests/services/test_sound_scanner.py
Normal file
@@ -0,0 +1,298 @@
|
||||
"""Tests for sound scanner service."""
|
||||
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from unittest.mock import AsyncMock, Mock, patch
|
||||
|
||||
import pytest
|
||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
||||
|
||||
from app.models.sound import Sound
|
||||
from app.services.sound_scanner import SoundScannerService
|
||||
|
||||
|
||||
class TestSoundScannerService:
|
||||
"""Test sound scanner service."""
|
||||
|
||||
@pytest.fixture
|
||||
def mock_session(self):
|
||||
"""Create a mock session."""
|
||||
return Mock(spec=AsyncSession)
|
||||
|
||||
@pytest.fixture
|
||||
def scanner_service(self, mock_session):
|
||||
"""Create a scanner service with mock session."""
|
||||
return SoundScannerService(mock_session)
|
||||
|
||||
def test_init(self, scanner_service):
|
||||
"""Test scanner service initialization."""
|
||||
assert scanner_service.session is not None
|
||||
assert scanner_service.sound_repo is not None
|
||||
assert len(scanner_service.supported_extensions) > 0
|
||||
assert ".mp3" in scanner_service.supported_extensions
|
||||
assert ".wav" in scanner_service.supported_extensions
|
||||
|
||||
def test_get_file_hash(self, scanner_service):
|
||||
"""Test file hash calculation."""
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
|
||||
f.write("test content")
|
||||
temp_path = Path(f.name)
|
||||
|
||||
try:
|
||||
hash_value = scanner_service.get_file_hash(temp_path)
|
||||
assert len(hash_value) == 32 # MD5 hash length
|
||||
assert isinstance(hash_value, str)
|
||||
finally:
|
||||
temp_path.unlink()
|
||||
|
||||
def test_get_file_size(self, scanner_service):
|
||||
"""Test file size calculation."""
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
|
||||
f.write("test content for size calculation")
|
||||
temp_path = Path(f.name)
|
||||
|
||||
try:
|
||||
size = scanner_service.get_file_size(temp_path)
|
||||
assert size > 0
|
||||
assert isinstance(size, int)
|
||||
finally:
|
||||
temp_path.unlink()
|
||||
|
||||
def test_extract_name_from_filename(self, scanner_service):
|
||||
"""Test name extraction from filename."""
|
||||
test_cases = [
|
||||
("hello_world.mp3", "Hello World"),
|
||||
("my-awesome-sound.wav", "My Awesome Sound"),
|
||||
("TEST_FILE_NAME.opus", "Test File Name"),
|
||||
("single.mp3", "Single"),
|
||||
("multiple_words_here.flac", "Multiple Words Here"),
|
||||
]
|
||||
|
||||
for filename, expected_name in test_cases:
|
||||
result = scanner_service.extract_name_from_filename(filename)
|
||||
assert result == expected_name
|
||||
|
||||
@patch("app.services.sound_scanner.ffmpeg.probe")
|
||||
def test_get_audio_duration_success(self, mock_probe, scanner_service):
|
||||
"""Test successful audio duration extraction."""
|
||||
mock_probe.return_value = {
|
||||
"format": {"duration": "123.456"}
|
||||
}
|
||||
|
||||
temp_path = Path("/fake/path/test.mp3")
|
||||
duration = scanner_service.get_audio_duration(temp_path)
|
||||
|
||||
assert duration == 123456 # 123.456 seconds * 1000 = 123456 ms
|
||||
mock_probe.assert_called_once_with(str(temp_path))
|
||||
|
||||
@patch("app.services.sound_scanner.ffmpeg.probe")
|
||||
def test_get_audio_duration_failure(self, mock_probe, scanner_service):
|
||||
"""Test audio duration extraction failure."""
|
||||
mock_probe.side_effect = Exception("FFmpeg error")
|
||||
|
||||
temp_path = Path("/fake/path/test.mp3")
|
||||
duration = scanner_service.get_audio_duration(temp_path)
|
||||
|
||||
assert duration == 0
|
||||
mock_probe.assert_called_once_with(str(temp_path))
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_scan_directory_nonexistent(self, scanner_service):
|
||||
"""Test scanning a non-existent directory."""
|
||||
with pytest.raises(ValueError, match="Directory does not exist"):
|
||||
await scanner_service.scan_directory("/non/existent/path")
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_scan_directory_not_directory(self, scanner_service):
|
||||
"""Test scanning a path that is not a directory."""
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile() as f:
|
||||
with pytest.raises(ValueError, match="Path is not a directory"):
|
||||
await scanner_service.scan_directory(f.name)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_audio_file_unchanged(self, scanner_service):
|
||||
"""Test syncing file that is unchanged."""
|
||||
# Existing sound with same hash as file
|
||||
existing_sound = Sound(
|
||||
id=1,
|
||||
type="SDB",
|
||||
name="Test Sound",
|
||||
filename="test.mp3",
|
||||
duration=120000, # 120 seconds = 120000 ms
|
||||
size=1024,
|
||||
hash="same_hash",
|
||||
)
|
||||
|
||||
# Mock file operations to return same hash
|
||||
scanner_service.get_file_hash = Mock(return_value="same_hash")
|
||||
scanner_service.get_audio_duration = Mock(return_value=120000)
|
||||
scanner_service.get_file_size = Mock(return_value=1024)
|
||||
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(suffix=".mp3", delete=False) as f:
|
||||
temp_path = Path(f.name)
|
||||
|
||||
try:
|
||||
results = {
|
||||
"scanned": 0, "added": 0, "updated": 0, "deleted": 0,
|
||||
"skipped": 0, "errors": 0, "files": []
|
||||
}
|
||||
await scanner_service._sync_audio_file(
|
||||
temp_path, "SDB", existing_sound, results
|
||||
)
|
||||
|
||||
assert results["skipped"] == 1
|
||||
assert results["added"] == 0
|
||||
assert results["updated"] == 0
|
||||
assert len(results["files"]) == 1
|
||||
assert results["files"][0]["status"] == "skipped"
|
||||
assert results["files"][0]["reason"] == "file unchanged"
|
||||
finally:
|
||||
temp_path.unlink()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_audio_file_new(self, scanner_service):
|
||||
"""Test syncing a new audio file."""
|
||||
created_sound = Sound(
|
||||
id=1,
|
||||
type="SDB",
|
||||
name="Test Sound",
|
||||
filename="test.mp3",
|
||||
duration=120000, # 120 seconds = 120000 ms
|
||||
size=1024,
|
||||
hash="test_hash",
|
||||
)
|
||||
scanner_service.sound_repo.create = AsyncMock(return_value=created_sound)
|
||||
|
||||
# Mock file operations
|
||||
scanner_service.get_file_hash = Mock(return_value="test_hash")
|
||||
scanner_service.get_audio_duration = Mock(return_value=120000) # Duration in ms
|
||||
scanner_service.get_file_size = Mock(return_value=1024)
|
||||
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(suffix=".mp3", delete=False) as f:
|
||||
temp_path = Path(f.name)
|
||||
|
||||
try:
|
||||
results = {
|
||||
"scanned": 0, "added": 0, "updated": 0, "deleted": 0,
|
||||
"skipped": 0, "errors": 0, "files": []
|
||||
}
|
||||
await scanner_service._sync_audio_file(temp_path, "SDB", None, results)
|
||||
|
||||
assert results["added"] == 1
|
||||
assert results["skipped"] == 0
|
||||
assert results["updated"] == 0
|
||||
assert len(results["files"]) == 1
|
||||
assert results["files"][0]["status"] == "added"
|
||||
|
||||
# Verify sound_repo.create was called with correct data
|
||||
call_args = scanner_service.sound_repo.create.call_args[0][0]
|
||||
assert call_args["type"] == "SDB"
|
||||
assert call_args["filename"] == temp_path.name
|
||||
assert call_args["duration"] == 120000 # Duration in ms
|
||||
assert call_args["size"] == 1024
|
||||
assert call_args["hash"] == "test_hash"
|
||||
assert call_args["is_deletable"] is False # SDB sounds are not deletable
|
||||
finally:
|
||||
temp_path.unlink()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_audio_file_updated(self, scanner_service):
|
||||
"""Test syncing a file that was modified (different hash)."""
|
||||
# Existing sound with different hash than file
|
||||
existing_sound = Sound(
|
||||
id=1,
|
||||
type="SDB",
|
||||
name="Old Sound",
|
||||
filename="test.mp3",
|
||||
duration=60000, # Old duration
|
||||
size=512, # Old size
|
||||
hash="old_hash", # Old hash
|
||||
)
|
||||
|
||||
scanner_service.sound_repo.update = AsyncMock(return_value=existing_sound)
|
||||
|
||||
# Mock file operations to return new values
|
||||
scanner_service.get_file_hash = Mock(return_value="new_hash")
|
||||
scanner_service.get_audio_duration = Mock(return_value=120000) # New duration
|
||||
scanner_service.get_file_size = Mock(return_value=1024) # New size
|
||||
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(suffix=".mp3", delete=False) as f:
|
||||
temp_path = Path(f.name)
|
||||
|
||||
try:
|
||||
results = {
|
||||
"scanned": 0, "added": 0, "updated": 0, "deleted": 0,
|
||||
"skipped": 0, "errors": 0, "files": []
|
||||
}
|
||||
await scanner_service._sync_audio_file(
|
||||
temp_path, "SDB", existing_sound, results
|
||||
)
|
||||
|
||||
assert results["updated"] == 1
|
||||
assert results["added"] == 0
|
||||
assert results["skipped"] == 0
|
||||
assert len(results["files"]) == 1
|
||||
assert results["files"][0]["status"] == "updated"
|
||||
assert results["files"][0]["reason"] == "file was modified"
|
||||
|
||||
# Verify sound_repo.update was called with correct data
|
||||
call_args = scanner_service.sound_repo.update.call_args[0][1] # update_data
|
||||
assert call_args["duration"] == 120000
|
||||
assert call_args["size"] == 1024
|
||||
assert call_args["hash"] == "new_hash"
|
||||
# Name is extracted from temp filename, should be capitalized
|
||||
assert call_args["name"].endswith("mp3") is False # Should be cleaned
|
||||
finally:
|
||||
temp_path.unlink()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_audio_file_custom_type(self, scanner_service):
|
||||
"""Test syncing file with custom type."""
|
||||
created_sound = Sound(
|
||||
id=1,
|
||||
type="CUSTOM",
|
||||
name="Test Sound",
|
||||
filename="test.mp3",
|
||||
duration=60000, # 60 seconds = 60000 ms
|
||||
size=2048,
|
||||
hash="custom_hash",
|
||||
)
|
||||
scanner_service.sound_repo.create = AsyncMock(return_value=created_sound)
|
||||
|
||||
# Mock file operations
|
||||
scanner_service.get_file_hash = Mock(return_value="custom_hash")
|
||||
scanner_service.get_audio_duration = Mock(return_value=60000) # Duration in ms
|
||||
scanner_service.get_file_size = Mock(return_value=2048)
|
||||
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(suffix=".wav", delete=False) as f:
|
||||
temp_path = Path(f.name)
|
||||
|
||||
try:
|
||||
results = {
|
||||
"scanned": 0, "added": 0, "updated": 0, "deleted": 0,
|
||||
"skipped": 0, "errors": 0, "files": []
|
||||
}
|
||||
await scanner_service._sync_audio_file(temp_path, "CUSTOM", None, results)
|
||||
|
||||
assert results["added"] == 1
|
||||
assert results["skipped"] == 0
|
||||
assert len(results["files"]) == 1
|
||||
assert results["files"][0]["status"] == "added"
|
||||
|
||||
# Verify sound_repo.create was called with correct data for custom type
|
||||
call_args = scanner_service.sound_repo.create.call_args[0][0]
|
||||
assert call_args["type"] == "CUSTOM"
|
||||
assert call_args["filename"] == temp_path.name
|
||||
assert call_args["duration"] == 60000 # Duration in ms
|
||||
assert call_args["size"] == 2048
|
||||
assert call_args["hash"] == "custom_hash"
|
||||
assert call_args["is_deletable"] is False # All sounds are set to not deletable
|
||||
finally:
|
||||
temp_path.unlink()
|
||||
Reference in New Issue
Block a user