def test_feed_extra_audio_file(
self,
mocked_dakara_server_class,
mocked_list_directory,
mocked_metadata_parse,
mocked_subtitle_parse,
):
"""Test to feed
"""
# create the mocks
mocked_dakara_server_class.return_value.get_songs.return_value = []
mocked_list_directory.return_value = [
SongPaths(
Path("music_1.mp4"),
audio=Path("music_1.flac"),
subtitle=Path("music_1.ass"),
)
]
mocked_metadata_parse.return_value.get_duration.return_value = timedelta(
seconds=1)
mocked_metadata_parse.return_value.get_audio_tracks_count.return_value = 1
mocked_subtitle_parse.return_value.get_lyrics.return_value = "lyri lyri"
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config, progress=False)
# call the method
with self.assertLogs("dakara_feeder.dakara_feeder", "DEBUG"):
with self.assertLogs("dakara_base.progress_bar"):
feeder.feed()
# assert the mocked calls
mocked_dakara_server_class.return_value.get_songs.assert_called_with()
mocked_list_directory.assert_called_with("basepath")
mocked_dakara_server_class.return_value.post_song.assert_called_with([{
"title":
"music_1",
"filename":
"music_1.mp4",
"directory":
"",
"duration":
1,
"has_instrumental":
True,
"artists": [],
"works": [],
"tags": [],
"version":
"",
"detail":
"",
"detail_video":
"",
"lyrics":
"lyri lyri",
}])
def test_load_no_song_class(
self,
mocked_check_version,
mocked_get_custom_song,
mocked_check_kara_folder_path,
mocked_dakara_server_class,
):
"""Test to run side-effect tasks
"""
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config, progress=False)
# pre assert
self.assertIs(feeder.song_class, BaseSong)
# call the method
feeder.load()
# post assert
self.assertIs(feeder.song_class, BaseSong)
# assert the call
mocked_check_version.assert_called_with()
mocked_get_custom_song.assert_not_called()
mocked_check_kara_folder_path.assert_called_with()
mocked_dakara_server_class.return_value.authenticate.assert_called_with(
)
def test_feed_custom_song_class(self, mocked_dakara_server_class,
mocked_list_directory,
mocked_metadata_parse):
"""Test to feed using a custom song class
"""
# create the mocks
mocked_dakara_server_class.return_value.get_songs.return_value = []
mocked_list_directory.return_value = [
SongPaths(Path("directory_0") / "song_0.mp4")
]
mocked_metadata_parse.return_value.get_duration.return_value = timedelta(
seconds=1)
mocked_metadata_parse.return_value.get_audio_tracks_count.return_value = 2
class Song(BaseSong):
def get_artists(self):
return ["artist1", "artist2"]
# create the config
config = {
"server": {},
"custom_song_class": "custom_song_module",
"kara_folder": "basepath",
}
# create the object
feeder = DakaraFeeder(config, progress=False)
feeder.song_class = Song
# call the method
with self.assertLogs("dakara_feeder.dakara_feeder", "DEBUG"):
with self.assertLogs("dakara_base.progress_bar"):
feeder.feed()
# assert the mocked calls
mocked_dakara_server_class.return_value.post_song.assert_called_with([{
"title":
"song_0",
"filename":
"song_0.mp4",
"directory":
"directory_0",
"duration":
1,
"has_instrumental":
True,
"artists": ["artist1", "artist2"],
"works": [],
"tags": [],
"version":
"",
"detail":
"",
"detail_video":
"",
"lyrics":
"",
}])
def test_check_kara_folder_path_exists(self, mocked_isdir,
mocked_dakara_server_class):
"""Test to check when the kara folder exists
"""
# setup the mock
mocked_isdir.return_value = True
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config)
# call the method
feeder.check_kara_folder_path()
# assert the call
mocked_isdir.assert_called_with()
def test_check_kara_folder_path_not_exists(self, mocked_isdir,
mocked_dakara_server_class):
"""Test to check when the kara folder does not exists
"""
# setup the mock
mocked_isdir.return_value = False
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config)
# call the method
with self.assertRaisesRegex(
KaraFolderNotFound,
"Karaoke folder 'basepath' does not exist"):
feeder.check_kara_folder_path()
def test_feed(self, mocked_dakara_server_class):
"""Test to feed
"""
# create the mocks
mocked_dakara_server_class.return_value.get_songs.return_value = []
# create the object
with TempDir() as temp:
# copy required files
with path("tests.resources.media", "dummy.ass") as file:
Path(file).copy(temp)
with path("tests.resources.media", "dummy.mkv") as file:
Path(file).copy(temp)
config = {"server": {}, "kara_folder": str(temp)}
feeder = DakaraFeeder(config, progress=False)
# call the method
with self.assertLogs("dakara_feeder.dakara_feeder", "DEBUG"):
with self.assertLogs("dakara_base.progress_bar"):
feeder.feed()
# assert the mocked calls
mocked_dakara_server_class.return_value.get_songs.assert_called_with()
mocked_dakara_server_class.return_value.post_song.assert_called_with(
[
{
"title": "dummy",
"filename": "dummy.mkv",
"directory": "",
"duration": 2.023,
"has_instrumental": True,
"artists": [],
"works": [],
"tags": [],
"version": "",
"detail": "",
"detail_video": "",
"lyrics": "Piyo!",
}
]
)
def test_load_with_song_class(
self,
mocked_check_version,
mocked_get_custom_song,
mocked_check_kara_folder_path,
mocked_dakara_server_class,
):
"""Test to run side-effect tasks
"""
class MySong(BaseSong):
pass
# prepare mocks
mocked_get_custom_song.return_value = MySong
# create the config
config = {
"server": {},
"kara_folder": "basepath",
"custom_song_class": "module.MySong",
}
# create the object
feeder = DakaraFeeder(config, progress=False)
# pre assert
self.assertIs(feeder.song_class, BaseSong)
# call the method
feeder.load()
# post assert
self.assertIs(feeder.song_class, MySong)
# assert the call
mocked_get_custom_song.assert_called_with("module.MySong")
def test_create_two_songs(
self,
mocked_dakara_server_class,
mocked_list_directory,
mocked_metadata_parse,
mocked_subtitle_parse,
):
"""Test to create two songs
"""
# create the mocks
mocked_dakara_server_class.return_value.get_songs.return_value = []
mocked_list_directory.return_value = [
SongPaths(Path("directory_0") / "song_0.mp4"),
SongPaths(Path("directory_1") / "song_1.mp4"),
]
mocked_metadata_parse.return_value.get_duration.return_value = timedelta(
seconds=1)
mocked_metadata_parse.return_value.get_audio_tracks_count.return_value = 1
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config, progress=False)
# call the method
with self.assertLogs("dakara_feeder.dakara_feeder", "DEBUG") as logger:
with self.assertLogs("dakara_base.progress_bar"):
feeder.feed()
# assert the mocked calls
mocked_dakara_server_class.return_value.get_songs.assert_called_with()
mocked_list_directory.assert_called_with("basepath")
songs = [
{
"title": "song_0",
"filename": "song_0.mp4",
"directory": "directory_0",
"duration": 1,
"has_instrumental": False,
"artists": [],
"works": [],
"tags": [],
"version": "",
"detail": "",
"detail_video": "",
"lyrics": "",
},
{
"title": "song_1",
"filename": "song_1.mp4",
"directory": "directory_1",
"duration": 1,
"has_instrumental": False,
"artists": [],
"works": [],
"tags": [],
"version": "",
"detail": "",
"detail_video": "",
"lyrics": "",
},
]
post_calls = mocked_dakara_server_class.return_value.post_song.mock_calls
# check called once
self.assertEqual(len(post_calls), 1)
# check one positional argument
_, args, kwargs, = post_calls[0]
self.assertEqual(len(args), 1)
self.assertEqual(len(kwargs), 0)
# check first arguement is the list of the two expected songs
self.assertCountEqual(args[0], songs)
mocked_dakara_server_class.return_value.delete_song.assert_not_called()
self.assertListEqual(
logger.output,
[
"INFO:dakara_feeder.dakara_feeder:Found 0 songs in server",
"INFO:dakara_feeder.dakara_feeder:Found 2 songs in local directory",
"INFO:dakara_feeder.dakara_feeder:Found 2 songs to add",
"INFO:dakara_feeder.dakara_feeder:Found 0 songs to delete",
"INFO:dakara_feeder.dakara_feeder:Found 0 songs to update",
],
)
def test_feed_with_force_update(
self,
mocked_dakara_server_class,
mocked_list_directory,
mocked_metadata_parse,
mocked_subtitle_parse,
):
"""Test to feed
"""
# create the mocks
mocked_dakara_server_class.return_value.get_songs.return_value = [{
"id":
1,
"path":
Path("music_1.mp4")
}]
mocked_list_directory.return_value = [
SongPaths(Path("music_1.mp4"), subtitle=Path("music_1.ass"))
]
mocked_metadata_parse.return_value.get_duration.return_value = timedelta(
seconds=1)
mocked_metadata_parse.return_value.get_audio_tracks_count.return_value = 1
mocked_subtitle_parse.return_value.get_lyrics.return_value = "lyri lyri"
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config, force_update=True, progress=False)
# call the method
with self.assertLogs("dakara_feeder.dakara_feeder", "DEBUG") as logger:
with self.assertLogs("dakara_base.progress_bar"):
feeder.feed()
# assert the mocked calls
mocked_dakara_server_class.return_value.get_songs.assert_called_with()
mocked_list_directory.assert_called_with("basepath")
mocked_dakara_server_class.return_value.put_song.assert_called_with(
1,
{
"title": "music_1",
"filename": "music_1.mp4",
"directory": "",
"duration": 1,
"has_instrumental": False,
"artists": [],
"works": [],
"tags": [],
"version": "",
"detail": "",
"detail_video": "",
"lyrics": "lyri lyri",
},
)
self.assertListEqual(
logger.output,
[
"INFO:dakara_feeder.dakara_feeder:Found 1 songs in server",
"INFO:dakara_feeder.dakara_feeder:Found 1 songs in local directory",
"INFO:dakara_feeder.dakara_feeder:Found 0 songs to add",
"INFO:dakara_feeder.dakara_feeder:Found 0 songs to delete",
"INFO:dakara_feeder.dakara_feeder:Found 1 songs to update",
],
)
def test_renamed_file(self, mocked_dakara_server_class,
mocked_list_directory, mocked_metadata_parse):
"""Test feed when a file has been renamed
"""
# mock content of server (old files)
mocked_dakara_server_class.return_value.get_songs.return_value = [
{
"id": 0,
"path": Path("directory_0") / "song.mp4"
},
{
"id": 1,
"path": Path("directory_1") / "music.mp4"
},
]
# mock content of file system (new files)
# Simulate file music.mp4 renamed to musics.mp4
mocked_list_directory.return_value = [
SongPaths(Path("directory_0") / "song.mp4"),
SongPaths(Path("directory_1") / "musics.mp4"),
]
mocked_metadata_parse.return_value.get_duration.return_value = timedelta(
seconds=1)
mocked_metadata_parse.return_value.get_audio_tracks_count.return_value = 1
# create the config
config = {"server": {}, "kara_folder": "basepath"}
# create the object
feeder = DakaraFeeder(config, progress=False)
# call the method
with self.assertLogs("dakara_feeder.dakara_feeder", "DEBUG") as logger:
with self.assertLogs("dakara_base.progress_bar"):
feeder.feed()
# assert the mocked calls
mocked_dakara_server_class.return_value.get_songs.assert_called_with()
mocked_list_directory.assert_called_with("basepath")
mocked_dakara_server_class.return_value.put_song.assert_called_with(
1,
{
"title": "musics",
"filename": "musics.mp4",
"directory": "directory_1",
"duration": 1,
"has_instrumental": False,
"artists": [],
"works": [],
"tags": [],
"version": "",
"detail": "",
"detail_video": "",
"lyrics": "",
},
)
self.assertListEqual(
logger.output,
[
"INFO:dakara_feeder.dakara_feeder:Found 2 songs in server",
"INFO:dakara_feeder.dakara_feeder:Found 2 songs in local directory",
"INFO:dakara_feeder.dakara_feeder:Found 0 songs to add",
"INFO:dakara_feeder.dakara_feeder:Found 0 songs to delete",
"INFO:dakara_feeder.dakara_feeder:Found 1 songs to update",
],
)