lms/src/libs/database/test/ArtistInfo.cpp

/*
 * Copyright (C) 2024 Emeric Poupon
 *
 * This file is part of LMS.
 *
 * LMS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * LMS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with LMS.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "Common.hpp"

#include "database/objects/Artist.hpp"
#include "database/objects/ArtistInfo.hpp"
#include "database/objects/Directory.hpp"

namespace lms::db::tests
{
    using ScopedArtistInfo = ScopedEntity<db::ArtistInfo>;
    using ScopedDirectory = ScopedEntity<db::Directory>;

    TEST_F(DatabaseFixture, ArtistInfo)
    {
        {
            auto transaction{ session.createReadTransaction() };
            EXPECT_EQ(ArtistInfo::getCount(session), 0);
        }

        ScopedArtistInfo artistInfo{ session };

        {
            auto transaction{ session.createReadTransaction() };
            EXPECT_EQ(ArtistInfo::getCount(session), 1);
        }

        {
            auto transaction{ session.createReadTransaction() };

            const ArtistInfo::pointer dbArtistInfo{ ArtistInfo::find(session, artistInfo.getId()) };

            EXPECT_EQ(dbArtistInfo->getAbsoluteFilePath(), "");
            EXPECT_EQ(dbArtistInfo->getLastWriteTime(), Wt::WDateTime{});

            EXPECT_EQ(dbArtistInfo->getArtist(), Artist::pointer{});
            EXPECT_EQ(dbArtistInfo->getDirectory(), Directory::pointer{});
            EXPECT_EQ(dbArtistInfo->getType(), "");
            EXPECT_EQ(dbArtistInfo->getGender(), "");
            EXPECT_EQ(dbArtistInfo->getDisambiguation(), "");
            EXPECT_EQ(dbArtistInfo->getBiography(), "");
        }

        ScopedArtist artist{ session, "MyArtist" };
        ScopedDirectory directory{ session, "/tmp" };

        const Wt::WDateTime dateTime{ Wt::WDate{ 2024, 30, 1 }, Wt::WTime{ 12, 58, 29 } };

        // Now change some values
        {
            auto transaction{ session.createWriteTransaction() };
            ArtistInfo::pointer dbArtistInfo{ ArtistInfo::find(session, artistInfo.getId()) };

            dbArtistInfo.modify()->setAbsoluteFilePath("/tmp/artist.nfo");
            dbArtistInfo.modify()->setLastWriteTime(dateTime);

            dbArtistInfo.modify()->setArtist(artist.get());
            dbArtistInfo.modify()->setDirectory(directory.get());
            dbArtistInfo.modify()->setType("MyType");
            dbArtistInfo.modify()->setGender("MyGender");
            dbArtistInfo.modify()->setDisambiguation("MyDisambiguation");
            dbArtistInfo.modify()->setBiography("MyBiography");
        }

        // Check values are reflected
        {
            auto transaction{ session.createReadTransaction() };

            const ArtistInfo::pointer dbArtistInfo{ ArtistInfo::find(session, artistInfo.getId()) };

            EXPECT_EQ(dbArtistInfo->getAbsoluteFilePath(), "/tmp/artist.nfo");
            EXPECT_EQ(dbArtistInfo->getLastWriteTime(), dateTime);

            EXPECT_EQ(dbArtistInfo->getArtist(), artist.get());
            EXPECT_EQ(dbArtistInfo->getDirectory(), directory.get());
            EXPECT_EQ(dbArtistInfo->getDirectoryId(), directory.getId());
            EXPECT_EQ(dbArtistInfo->getType(), "MyType");
            EXPECT_EQ(dbArtistInfo->getGender(), "MyGender");
            EXPECT_EQ(dbArtistInfo->getDisambiguation(), "MyDisambiguation");
            EXPECT_EQ(dbArtistInfo->getBiography(), "MyBiography");
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::find(session, artist.getId(), [&](const ArtistInfo::pointer& dbArtistInfo) {
                ASSERT_NE(dbArtistInfo, ArtistInfo::pointer{});
                EXPECT_EQ(dbArtistInfo->getId(), artistInfo.getId());
                visited = true;
            });
            EXPECT_TRUE(visited);
        }
    }

    TEST_F(DatabaseFixture, ArtistInfo_findArtistNameNoLongerMatch)
    {
        ScopedArtistInfo artistInfo{ session };
        ScopedArtist artist{ session, "MyArtist" };

        {
            auto transaction{ session.createWriteTransaction() };
            artistInfo.get().modify()->setArtist(artist.get());
            artistInfo.get().modify()->setName("MyArtist");
            artistInfo.get().modify()->setMBIDMatched(false);
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::findArtistNameNoLongerMatch(session, std::nullopt, [&](const ArtistInfo::pointer&) {
                visited = true;
            });
            ASSERT_FALSE(visited);
        }

        {
            auto transaction{ session.createWriteTransaction() };
            artist.get().modify()->setName("MyArtist2");
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::findArtistNameNoLongerMatch(session, std::nullopt, [&](const ArtistInfo::pointer&) {
                visited = true;
            });
            ASSERT_TRUE(visited);
        }
    }

    TEST_F(DatabaseFixture, ArtistInfo_findWithArtistNameAmbiguity_split)
    {
        ScopedArtistInfo artistInfo1{ session };
        ScopedArtist artist1{ session, "MyArtist", core::UUID::fromString("b227426f-98b8-4b39-b3a7-ff25e7711e9b") };

        {
            auto transaction{ session.createWriteTransaction() };
            artistInfo1.get().modify()->setArtist(artist1.get());
            artistInfo1.get().modify()->setName("MyArtist");
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::findWithArtistNameAmbiguity(session, std::nullopt, true /*allow fallback*/, [&](const ArtistInfo::pointer&) {
                visited = true;
            });
            ASSERT_FALSE(visited);
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::findWithArtistNameAmbiguity(session, std::nullopt, false /*allow fallback*/, [&](const ArtistInfo::pointer&) {
                visited = true;
            });
            ASSERT_TRUE(visited);
        }

        ScopedArtist artist2{ session, "MyArtist", core::UUID::fromString("97d1fb6f-db09-4760-b0b3-816559bcb632") };
        ScopedArtistInfo artistInfo2{ session };

        {
            auto transaction{ session.createWriteTransaction() };
            artistInfo2.get().modify()->setArtist(artist2.get());
            artistInfo2.get().modify()->setName("MyArtist");
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::findWithArtistNameAmbiguity(session, std::nullopt, true /*allow fallback*/, [&](const ArtistInfo::pointer&) {
                visited = true;
            });
            ASSERT_TRUE(visited);
        }

        {
            auto transaction{ session.createReadTransaction() };

            bool visited{};
            ArtistInfo::findWithArtistNameAmbiguity(session, std::nullopt, false /*allow fallback*/, [&](const ArtistInfo::pointer&) {
                visited = true;
            });
            ASSERT_TRUE(visited);
        }
    }

    TEST_F(DatabaseFixture, ArtistInfo_findAbsoluteFilePath)
    {
        ScopedArtistInfo artistInfo{ session };

        const std::filesystem::path absoluteFilePath{ "/path/to/artist.nfo" };
        {
            auto transaction{ session.createWriteTransaction() };
            artistInfo.get().modify()->setAbsoluteFilePath(absoluteFilePath);
        }

        {
            auto transaction{ session.createReadTransaction() };

            ArtistInfoId lastRetrievedId;

            std::filesystem::path retrievedFilePath;
            ArtistInfo::findAbsoluteFilePath(session, lastRetrievedId, 1, [&](ArtistInfoId artistInfoId, const std::filesystem::path& filePath) {
                EXPECT_EQ(artistInfoId, artistInfo.getId());
                retrievedFilePath = filePath;
            });

            EXPECT_EQ(retrievedFilePath, absoluteFilePath);
        }
    }
} // namespace lms::db::tests