Lidarr/src/NzbDrone.Core.Test/MediaFiles/TrackImport/Identification/AlbumDistanceFixture.cs

using NUnit.Framework;
using NzbDrone.Core.MediaFiles.TrackImport.Identification;
using FluentAssertions;
using NzbDrone.Core.Test.Framework;
using FizzWare.NBuilder;
using NzbDrone.Core.Parser.Model;
using NzbDrone.Core.Music;
using System.Collections.Generic;
using System.Linq;
using System;
using NzbDrone.Core.Parser;

namespace NzbDrone.Core.Test.MediaFiles.TrackImport.Identification
{
    [TestFixture]
    public class AlbumDistanceFixture : CoreTest<IdentificationService>
    {

        private ArtistMetadata artist;

        [SetUp]
        public void Setup()
        {
            artist = Builder<ArtistMetadata>
                .CreateNew()
                .With(x => x.Name = "artist")
                .Build();
        }
        
        private List<Track> GivenTracks(int count)
        {
             return Builder<Track>
                .CreateListOfSize(count)
                .All()
                .With(x => x.ArtistMetadata = artist)
                .With(x => x.MediumNumber = 1)
                .Build()
                .ToList();
        }

        private LocalTrack GivenLocalTrack(Track track, AlbumRelease release)
        {
            var fileInfo = Builder<ParsedTrackInfo>
                .CreateNew()
                .With(x => x.Title = track.Title)
                .With(x => x.CleanTitle = track.Title.CleanTrackTitle())
                .With(x => x.AlbumTitle = release.Title)
                .With(x => x.Disambiguation = release.Disambiguation)
                .With(x => x.ReleaseMBId = release.ForeignReleaseId)
                .With(x => x.ArtistTitle = track.ArtistMetadata.Value.Name)
                .With(x => x.TrackNumbers = new[] { track.AbsoluteTrackNumber })
                .With(x => x.DiscCount = release.Media.Count)
                .With(x => x.DiscNumber = track.MediumNumber)
                .With(x => x.RecordingMBId = track.ForeignRecordingId)
                .With(x => x.Country = IsoCountries.Find("US"))
                .With(x => x.Label = release.Label.First())
                .With(x => x.Year = (uint)release.Album.Value.ReleaseDate.Value.Year)
                .Build();
            
            var localTrack = Builder<LocalTrack>
                .CreateNew()
                .With(x => x.FileTrackInfo = fileInfo)
                .Build();

            return localTrack;
        }

        private List<LocalTrack> GivenLocalTracks(List<Track> tracks, AlbumRelease release)
        {
            var output = new List<LocalTrack>();
            foreach (var track in tracks)
            {
                output.Add(GivenLocalTrack(track, release));
            }
            return output;
        }

        private AlbumRelease GivenAlbumRelease(string title, List<Track> tracks)
        {
            var album = Builder<Album>
                .CreateNew()
                .With(x => x.Title = title)
                .With(x => x.ArtistMetadata = artist)
                .Build();

            var media = Builder<Medium>
                .CreateListOfSize(tracks.Max(x => x.MediumNumber))
                .Build()
                .ToList();

            return Builder<AlbumRelease>
                .CreateNew()
                .With(x => x.Tracks = tracks)
                .With(x => x.Title = title)
                .With(x => x.Album = album)
                .With(x => x.Media = media)
                .With(x => x.Country = new List<string> { "United States" })
                .With(x => x.Label = new List<string> { "label" })
                .Build();
        }

        private TrackMapping GivenMapping(List<LocalTrack> local, List<Track> remote)
        {
            var mapping = new TrackMapping();
            var distances = local.Zip(remote, (l, r) => Tuple.Create(r, Subject.TrackDistance(l, r, Subject.GetTotalTrackNumber(r, remote))));
            mapping.Mapping = local.Zip(distances, (l, r) => new { l, r }).ToDictionary(x => x.l, x => x.r);
            mapping.LocalExtra = local.Except(mapping.Mapping.Keys).ToList();
            mapping.MBExtra = remote.Except(mapping.Mapping.Values.Select(x => x.Item1)).ToList();

            return mapping;
        }
        
        [Test]
        public void test_identical_albums()
        {
            var tracks = GivenTracks(3);
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            var mapping = GivenMapping(localTracks, tracks);

            Subject.AlbumReleaseDistance(localTracks, release, mapping).NormalizedDistance().Should().Be(0.0);
        }

        [Test]
        public void test_incomplete_album()
        {
            var tracks = GivenTracks(3);
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            localTracks.RemoveAt(1);
            var mapping = GivenMapping(localTracks, tracks);

            var dist = Subject.AlbumReleaseDistance(localTracks, release, mapping);
            dist.NormalizedDistance().Should().NotBe(0.0);
            dist.NormalizedDistance().Should().BeLessThan(0.2);
        }

        [Test]
        public void test_global_artists_differ()
        {
            var tracks = GivenTracks(3);
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            var mapping = GivenMapping(localTracks, tracks);
            
            release.Album.Value.ArtistMetadata = Builder<ArtistMetadata>
                .CreateNew()
                .With(x => x.Name = "different artist")
                .Build();

            Subject.AlbumReleaseDistance(localTracks, release, mapping).NormalizedDistance().Should().NotBe(0.0);
        }

        [Test]
        public void test_comp_track_artists_match()
        {
            var tracks = GivenTracks(3);
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            var mapping = GivenMapping(localTracks, tracks);

            release.Album.Value.ArtistMetadata = Builder<ArtistMetadata>
                .CreateNew()
                .With(x => x.Name = "Various Artists")
                .With(x => x.ForeignArtistId = "89ad4ac3-39f7-470e-963a-56509c546377")
                .Build();
            
            Subject.AlbumReleaseDistance(localTracks, release, mapping).NormalizedDistance().Should().Be(0.0);
        }

        // TODO: there are a couple more VA tests in beets but we don't support VA yet anyway

        [Test]
        public void test_tracks_out_of_order()
        {
            var tracks = GivenTracks(3);
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            localTracks = new [] {1, 3, 2}.Select(x => localTracks[x-1]).ToList();
            var mapping = GivenMapping(localTracks, tracks);

            var dist = Subject.AlbumReleaseDistance(localTracks, release, mapping);
            dist.NormalizedDistance().Should().NotBe(0.0);
            dist.NormalizedDistance().Should().BeLessThan(0.2);
        }

        [Test]
        public void test_two_medium_release()
        {
            var tracks = GivenTracks(3);
            tracks[2].AbsoluteTrackNumber = 1;
            tracks[2].MediumNumber = 2;
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            var mapping = GivenMapping(localTracks, tracks);

            Subject.AlbumReleaseDistance(localTracks, release, mapping).NormalizedDistance().Should().Be(0.0);
        }

        [Test]
        public void test_absolute_track_numbering()
        {
            var tracks = GivenTracks(3);
            tracks[2].AbsoluteTrackNumber = 1;
            tracks[2].MediumNumber = 2;
            var release = GivenAlbumRelease("album", tracks);
            var localTracks = GivenLocalTracks(tracks, release);
            localTracks[2].FileTrackInfo.DiscNumber = 2;
            localTracks[2].FileTrackInfo.TrackNumbers = new[] { 3 };

            var mapping = GivenMapping(localTracks, tracks);

            Subject.AlbumReleaseDistance(localTracks, release, mapping).NormalizedDistance().Should().Be(0.0);
        }
    }
}