mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
517 lines
19 KiB
Python
517 lines
19 KiB
Python
# This file is part of beets.
|
|
# Copyright 2016, Adrian Sampson.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""Tests for discogs plugin."""
|
|
|
|
from unittest.mock import Mock, patch
|
|
|
|
import pytest
|
|
|
|
from beets import config
|
|
from beets.test._common import Bag
|
|
from beets.test.helper import BeetsTestCase, capture_log
|
|
from beetsplug.discogs import DiscogsPlugin
|
|
|
|
|
|
@patch("beetsplug.discogs.DiscogsPlugin.setup", Mock())
|
|
class DGAlbumInfoTest(BeetsTestCase):
|
|
def _make_release(self, tracks=None):
|
|
"""Returns a Bag that mimics a discogs_client.Release. The list
|
|
of elements on the returned Bag is incomplete, including just
|
|
those required for the tests on this class."""
|
|
data = {
|
|
"id": "ALBUM ID",
|
|
"uri": "https://www.discogs.com/release/release/13633721",
|
|
"title": "ALBUM TITLE",
|
|
"year": "3001",
|
|
"artists": [
|
|
{"name": "ARTIST NAME", "id": "ARTIST ID", "join": ","}
|
|
],
|
|
"formats": [
|
|
{
|
|
"descriptions": ["FORMAT DESC 1", "FORMAT DESC 2"],
|
|
"name": "FORMAT",
|
|
"qty": 1,
|
|
}
|
|
],
|
|
"styles": ["STYLE1", "STYLE2"],
|
|
"genres": ["GENRE1", "GENRE2"],
|
|
"labels": [
|
|
{
|
|
"name": "LABEL NAME",
|
|
"catno": "CATALOG NUMBER",
|
|
}
|
|
],
|
|
"tracklist": [],
|
|
}
|
|
|
|
if tracks:
|
|
for recording in tracks:
|
|
data["tracklist"].append(recording)
|
|
|
|
return Bag(
|
|
data=data,
|
|
# Make some fields available as properties, as they are
|
|
# accessed by DiscogsPlugin methods.
|
|
title=data["title"],
|
|
artists=[Bag(data=d) for d in data["artists"]],
|
|
)
|
|
|
|
def _make_track(self, title, position="", duration="", type_=None):
|
|
track = {"title": title, "position": position, "duration": duration}
|
|
if type_ is not None:
|
|
# Test samples on discogs_client do not have a 'type_' field, but
|
|
# the API seems to return it. Values: 'track' for regular tracks,
|
|
# 'heading' for descriptive texts (ie. not real tracks - 12.13.2).
|
|
track["type_"] = type_
|
|
|
|
return track
|
|
|
|
def _make_release_from_positions(self, positions):
|
|
"""Return a Bag that mimics a discogs_client.Release with a
|
|
tracklist where tracks have the specified `positions`."""
|
|
tracks = [
|
|
self._make_track(f"TITLE{i}", position)
|
|
for (i, position) in enumerate(positions, start=1)
|
|
]
|
|
return self._make_release(tracks)
|
|
|
|
def test_parse_media_for_tracks(self):
|
|
tracks = [
|
|
self._make_track("TITLE ONE", "1", "01:01"),
|
|
self._make_track("TITLE TWO", "2", "02:02"),
|
|
]
|
|
release = self._make_release(tracks=tracks)
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
t = d.tracks
|
|
assert d.media == "FORMAT"
|
|
assert t[0].media == d.media
|
|
assert t[1].media == d.media
|
|
|
|
def test_parse_medium_numbers_single_medium(self):
|
|
release = self._make_release_from_positions(["1", "2"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
t = d.tracks
|
|
|
|
assert d.mediums == 1
|
|
assert t[0].medium == 1
|
|
assert t[0].medium_total == 2
|
|
assert t[1].medium == 1
|
|
assert t[0].medium_total == 2
|
|
|
|
def test_parse_medium_numbers_two_mediums(self):
|
|
release = self._make_release_from_positions(["1-1", "2-1"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
t = d.tracks
|
|
|
|
assert d.mediums == 2
|
|
assert t[0].medium == 1
|
|
assert t[0].medium_total == 1
|
|
assert t[1].medium == 2
|
|
assert t[1].medium_total == 1
|
|
|
|
def test_parse_medium_numbers_two_mediums_two_sided(self):
|
|
release = self._make_release_from_positions(["A1", "B1", "C1"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
t = d.tracks
|
|
|
|
assert d.mediums == 2
|
|
assert t[0].medium == 1
|
|
assert t[0].medium_total == 2
|
|
assert t[0].medium_index == 1
|
|
assert t[1].medium == 1
|
|
assert t[1].medium_total == 2
|
|
assert t[1].medium_index == 2
|
|
assert t[2].medium == 2
|
|
assert t[2].medium_total == 1
|
|
assert t[2].medium_index == 1
|
|
|
|
def test_parse_track_indices(self):
|
|
release = self._make_release_from_positions(["1", "2"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
t = d.tracks
|
|
|
|
assert t[0].medium_index == 1
|
|
assert t[0].index == 1
|
|
assert t[0].medium_total == 2
|
|
assert t[1].medium_index == 2
|
|
assert t[1].index == 2
|
|
assert t[1].medium_total == 2
|
|
|
|
def test_parse_track_indices_several_media(self):
|
|
release = self._make_release_from_positions(
|
|
["1-1", "1-2", "2-1", "3-1"]
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
t = d.tracks
|
|
|
|
assert d.mediums == 3
|
|
assert t[0].medium_index == 1
|
|
assert t[0].index == 1
|
|
assert t[0].medium_total == 2
|
|
assert t[1].medium_index == 2
|
|
assert t[1].index == 2
|
|
assert t[1].medium_total == 2
|
|
assert t[2].medium_index == 1
|
|
assert t[2].index == 3
|
|
assert t[2].medium_total == 1
|
|
assert t[3].medium_index == 1
|
|
assert t[3].index == 4
|
|
assert t[3].medium_total == 1
|
|
|
|
def test_parse_tracklist_without_sides(self):
|
|
"""Test standard Discogs position 12.2.9#1: "without sides"."""
|
|
release = self._make_release_from_positions(["1", "2", "3"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 3
|
|
|
|
def test_parse_tracklist_with_sides(self):
|
|
"""Test standard Discogs position 12.2.9#2: "with sides"."""
|
|
release = self._make_release_from_positions(["A1", "A2", "B1", "B2"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1 # 2 sides = 1 LP
|
|
assert len(d.tracks) == 4
|
|
|
|
def test_parse_tracklist_multiple_lp(self):
|
|
"""Test standard Discogs position 12.2.9#3: "multiple LP"."""
|
|
release = self._make_release_from_positions(["A1", "A2", "B1", "C1"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 2 # 3 sides = 1 LP + 1 LP
|
|
assert len(d.tracks) == 4
|
|
|
|
def test_parse_tracklist_multiple_cd(self):
|
|
"""Test standard Discogs position 12.2.9#4: "multiple CDs"."""
|
|
release = self._make_release_from_positions(
|
|
["1-1", "1-2", "2-1", "3-1"]
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 3
|
|
assert len(d.tracks) == 4
|
|
|
|
def test_parse_tracklist_non_standard(self):
|
|
"""Test non standard Discogs position."""
|
|
release = self._make_release_from_positions(["I", "II", "III", "IV"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 4
|
|
|
|
def test_parse_tracklist_subtracks_dot(self):
|
|
"""Test standard Discogs position 12.2.9#5: "sub tracks, dots"."""
|
|
release = self._make_release_from_positions(["1", "2.1", "2.2", "3"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 3
|
|
|
|
release = self._make_release_from_positions(
|
|
["A1", "A2.1", "A2.2", "A3"]
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 3
|
|
|
|
def test_parse_tracklist_subtracks_letter(self):
|
|
"""Test standard Discogs position 12.2.9#5: "sub tracks, letter"."""
|
|
release = self._make_release_from_positions(["A1", "A2a", "A2b", "A3"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 3
|
|
|
|
release = self._make_release_from_positions(
|
|
["A1", "A2.a", "A2.b", "A3"]
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 3
|
|
|
|
def test_parse_tracklist_subtracks_extra_material(self):
|
|
"""Test standard Discogs position 12.2.9#6: "extra material"."""
|
|
release = self._make_release_from_positions(["1", "2", "Video 1"])
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d.mediums == 2
|
|
assert len(d.tracks) == 3
|
|
|
|
def test_parse_tracklist_subtracks_indices(self):
|
|
"""Test parsing of subtracks that include index tracks."""
|
|
release = self._make_release_from_positions(["", "", "1.1", "1.2"])
|
|
# Track 1: Index track with medium title
|
|
release.data["tracklist"][0]["title"] = "MEDIUM TITLE"
|
|
# Track 2: Index track with track group title
|
|
release.data["tracklist"][1]["title"] = "TRACK GROUP TITLE"
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.mediums == 1
|
|
assert d.tracks[0].disctitle == "MEDIUM TITLE"
|
|
assert len(d.tracks) == 1
|
|
assert d.tracks[0].title == "TRACK GROUP TITLE"
|
|
|
|
def test_parse_tracklist_subtracks_nested_logical(self):
|
|
"""Test parsing of subtracks defined inside a index track that are
|
|
logical subtracks (ie. should be grouped together into a single track).
|
|
"""
|
|
release = self._make_release_from_positions(["1", "", "3"])
|
|
# Track 2: Index track with track group title, and sub_tracks
|
|
release.data["tracklist"][1]["title"] = "TRACK GROUP TITLE"
|
|
release.data["tracklist"][1]["sub_tracks"] = [
|
|
self._make_track("TITLE ONE", "2.1", "01:01"),
|
|
self._make_track("TITLE TWO", "2.2", "02:02"),
|
|
]
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 3
|
|
assert d.tracks[1].title == "TRACK GROUP TITLE"
|
|
|
|
def test_parse_tracklist_subtracks_nested_physical(self):
|
|
"""Test parsing of subtracks defined inside a index track that are
|
|
physical subtracks (ie. should not be grouped together).
|
|
"""
|
|
release = self._make_release_from_positions(["1", "", "4"])
|
|
# Track 2: Index track with track group title, and sub_tracks
|
|
release.data["tracklist"][1]["title"] = "TRACK GROUP TITLE"
|
|
release.data["tracklist"][1]["sub_tracks"] = [
|
|
self._make_track("TITLE ONE", "2", "01:01"),
|
|
self._make_track("TITLE TWO", "3", "02:02"),
|
|
]
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.mediums == 1
|
|
assert len(d.tracks) == 4
|
|
assert d.tracks[1].title == "TITLE ONE"
|
|
assert d.tracks[2].title == "TITLE TWO"
|
|
|
|
def test_parse_tracklist_disctitles(self):
|
|
"""Test parsing of index tracks that act as disc titles."""
|
|
release = self._make_release_from_positions(
|
|
["", "1-1", "1-2", "", "2-1"]
|
|
)
|
|
# Track 1: Index track with medium title (Cd1)
|
|
release.data["tracklist"][0]["title"] = "MEDIUM TITLE CD1"
|
|
# Track 4: Index track with medium title (Cd2)
|
|
release.data["tracklist"][3]["title"] = "MEDIUM TITLE CD2"
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.mediums == 2
|
|
assert d.tracks[0].disctitle == "MEDIUM TITLE CD1"
|
|
assert d.tracks[1].disctitle == "MEDIUM TITLE CD1"
|
|
assert d.tracks[2].disctitle == "MEDIUM TITLE CD2"
|
|
assert len(d.tracks) == 3
|
|
|
|
def test_parse_minimal_release(self):
|
|
"""Test parsing of a release with the minimal amount of information."""
|
|
data = {
|
|
"id": 123,
|
|
"uri": "https://www.discogs.com/release/123456-something",
|
|
"tracklist": [self._make_track("A", "1", "01:01")],
|
|
"artists": [{"name": "ARTIST NAME", "id": 321, "join": ""}],
|
|
"title": "TITLE",
|
|
}
|
|
release = Bag(
|
|
data=data,
|
|
title=data["title"],
|
|
artists=[Bag(data=d) for d in data["artists"]],
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.artist == "ARTIST NAME"
|
|
assert d.album == "TITLE"
|
|
assert len(d.tracks) == 1
|
|
|
|
def test_parse_release_without_required_fields(self):
|
|
"""Test parsing of a release that does not have the required fields."""
|
|
release = Bag(data={}, refresh=lambda *args: None)
|
|
with capture_log() as logs:
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
|
|
assert d is None
|
|
assert "Release does not contain the required fields" in logs[0]
|
|
|
|
def test_default_genre_style_settings(self):
|
|
"""Test genre default settings, genres to genre, styles to style"""
|
|
release = self._make_release_from_positions(["1", "2"])
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.genre == "GENRE1, GENRE2"
|
|
assert d.style == "STYLE1, STYLE2"
|
|
|
|
def test_append_style_to_genre(self):
|
|
"""Test appending style to genre if config enabled"""
|
|
config["discogs"]["append_style_genre"] = True
|
|
release = self._make_release_from_positions(["1", "2"])
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.genre == "GENRE1, GENRE2, STYLE1, STYLE2"
|
|
assert d.style == "STYLE1, STYLE2"
|
|
|
|
def test_append_style_to_genre_no_style(self):
|
|
"""Test nothing appended to genre if style is empty"""
|
|
config["discogs"]["append_style_genre"] = True
|
|
release = self._make_release_from_positions(["1", "2"])
|
|
release.data["styles"] = []
|
|
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.genre == "GENRE1, GENRE2"
|
|
assert d.style is None
|
|
|
|
def test_strip_disambiguation_label_artist(self):
|
|
"""Test removing discogs disambiguation from artist and label"""
|
|
data = {
|
|
"id": 123,
|
|
"uri": "https://www.discogs.com/release/123456-something",
|
|
"tracklist": [self._make_track("A", "1", "01:01")],
|
|
"artists": [{"name": "ARTIST NAME (2)", "id": 321, "join": ""}],
|
|
"title": "TITLE",
|
|
"labels": [
|
|
{
|
|
"name": "LABEL NAME (5)",
|
|
"catno": "CATALOG NUMBER",
|
|
}
|
|
],
|
|
}
|
|
release = Bag(
|
|
data=data,
|
|
title=data["title"],
|
|
artists=[Bag(data=d) for d in data["artists"]],
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.artist == "ARTIST NAME"
|
|
assert d.label == "LABEL NAME"
|
|
|
|
def test_strip_disambiguation_off_label_artist(self):
|
|
"""Test not removing discogs disambiguation from artist and label"""
|
|
config["discogs"]["strip_disambiguation"] = False
|
|
data = {
|
|
"id": 123,
|
|
"uri": "https://www.discogs.com/release/123456-something",
|
|
"tracklist": [self._make_track("a", "1", "01:01")],
|
|
"artists": [{"name": "ARTIST NAME (2)", "id": 321, "join": ""}],
|
|
"title": "title",
|
|
"labels": [
|
|
{
|
|
"name": "LABEL NAME (5)",
|
|
"catno": "catalog number",
|
|
}
|
|
],
|
|
}
|
|
release = Bag(
|
|
data=data,
|
|
title=data["title"],
|
|
artists=[Bag(data=d) for d in data["artists"]],
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.artist == "ARTIST NAME (2)"
|
|
assert d.label == "LABEL NAME (5)"
|
|
|
|
def test_strip_disambiguation_multiple_artists(self):
|
|
"""Test removing disambiguation if there are multiple artists on the release"""
|
|
data = {
|
|
"id": 123,
|
|
"uri": "https://www.discogs.com/release/123456-something",
|
|
"tracklist": [self._make_track("a", "1", "01:01")],
|
|
"artists": [
|
|
{"name": "ARTIST NAME (2)", "id": 321, "join": "&"},
|
|
{"name": "OTHER ARTIST (5)", "id": 321, "join": ""},
|
|
],
|
|
"title": "title",
|
|
}
|
|
release = Bag(
|
|
data=data,
|
|
title=data["title"],
|
|
artists=[Bag(data=d) for d in data["artists"]],
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.artist == "ARTIST NAME & OTHER ARTIST"
|
|
|
|
def test_strip_disambiguation_artist_tracks(self):
|
|
data = {
|
|
"id": 123,
|
|
"uri": "https://www.discogs.com/release/123456-something",
|
|
"tracklist": [
|
|
{
|
|
"title": "track",
|
|
"position": "A",
|
|
"type_": "track",
|
|
"duration": "5:44",
|
|
"artists": [
|
|
{
|
|
"name": "TEST ARTIST (5)",
|
|
"tracks": "",
|
|
"id": 11146,
|
|
}
|
|
],
|
|
}
|
|
],
|
|
"artists": [{"name": "OTHER ARTIST (5)", "id": 321, "join": ""}],
|
|
"title": "title",
|
|
}
|
|
release = Bag(
|
|
data=data,
|
|
title=data["title"],
|
|
artists=[Bag(data=d) for d in data["artists"]],
|
|
)
|
|
d = DiscogsPlugin().get_album_info(release)
|
|
assert d.tracks[0].artist == "TEST ARTIST"
|
|
assert d.artist == "OTHER ARTIST"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"formats, expected_media, expected_albumtype",
|
|
[
|
|
(None, None, None),
|
|
(
|
|
[
|
|
{
|
|
"descriptions": ['7"', "Single", "45 RPM"],
|
|
"name": "Vinyl",
|
|
"qty": 1,
|
|
}
|
|
],
|
|
"Vinyl",
|
|
'7", Single, 45 RPM',
|
|
),
|
|
],
|
|
)
|
|
def test_get_media_and_albumtype(formats, expected_media, expected_albumtype):
|
|
result = DiscogsPlugin.get_media_and_albumtype(formats)
|
|
|
|
assert result == (expected_media, expected_albumtype)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"position, medium, index, subindex",
|
|
[
|
|
("1", None, "1", None),
|
|
("A12", "A", "12", None),
|
|
("12-34", "12-", "34", None),
|
|
("CD1-1", "CD1-", "1", None),
|
|
("1.12", None, "1", "12"),
|
|
("12.a", None, "12", "A"),
|
|
("12.34", None, "12", "34"),
|
|
("1ab", None, "1", "AB"),
|
|
# Non-standard
|
|
("IV", "IV", None, None),
|
|
],
|
|
)
|
|
def test_get_track_index(position, medium, index, subindex):
|
|
assert DiscogsPlugin.get_track_index(position) == (medium, index, subindex)
|