akashi-esquizolandia/tests/unittest_config_manager/tst_unittest_config_manager.cpp

#include <QString>
#include <QTest>

#include "config_manager.h"

namespace tests {
namespace unittests {

class tst_ConfigManager : public QObject
{

    Q_OBJECT

    typedef QMap<QString, QPair<QString, int>> MusicList;

  private slots:

    /**
     * @brief Tests if the config folder is complete. Fails when a config file is missing.
     */
    void verifyServerConfig();

    /**
     * @brief Retrieves the IPs the servers binds to in string format
     */
    void bindIP();

    void charlist();

    void backgrounds();

    void musiclist();

    void ordered_songs();

    /**
     * @brief Tests the loading routine for the musiclist.
     *
     * @details Handles regression testing for a bug fixed in PR#314 in which a
     * musiclist would be loaded twice and the old root instance was not cleared,
     * causing each reload to append the musiclist to the old list.
     */
    void regression_pr_314();

    void CommandInfo();

    void iprangeBans();

    void maxPlayers();

    void serverPort();

    void serverDescription();

    void serverName();

    void motd();

    void webaoEnabled();

    void authType();

    void modpass();

    void logBuffer();

    void loggingType();

    void maxStatements();

    void multiClientLimit();

    void maxCharacters();

    void messageFloodguard();

    void globalMessageFloodguard();

    void assetUrl();

    void diceMaxValue();

    void diceMaxDice();

    void passwordRequirements();

    void passwordMinLength();

    void passwordMaxLength();

    void passwordRequireMixCase();

    void passwordRequireNumbers();

    void passwordRequireSpecialCharacters();

    void passwordCanContainUsername();

    void magic8BallAnswers();

    void praiseList();

    void reprimandsList();

    void gimpList();

    void cdnList();

    void publishServerEnabled();

    void advertiserDebug();

    void serverlistURL();

    void serverDomainName();

    void advertiseWSProxy();
};

void tst_ConfigManager::verifyServerConfig()
{
    // If the sample folder is not renamed or a file is missing, we fail the test.
    QCOMPARE(ConfigManager::verifyServerConfig(), true);

    // We remove a config file and test again. This should now fail as cdns.txt is missing.
    QCOMPARE(QFile("config/text/cdns.txt").remove(), true);
    QCOMPARE(ConfigManager::verifyServerConfig(), false);
}

void tst_ConfigManager::bindIP()
{
    QCOMPARE(ConfigManager::bindIP(), "all");
}

void tst_ConfigManager::charlist()
{
    // We check that the list is unsorted and exactly as defined in the text file.
    QStringList l_characters = ConfigManager::charlist();
    QCOMPARE(l_characters.at(0), "Zak");
    QCOMPARE(l_characters.at(1), "Adrian");
    QCOMPARE(l_characters.at(2), "Armstrong");
    QCOMPARE(l_characters.at(3), "Butz");
    QCOMPARE(l_characters.at(4), "Diego");
}

void tst_ConfigManager::backgrounds()
{
    // We check that the list is unsorted and exactly as defined in the text file.
    QStringList l_backgrounds = ConfigManager::backgrounds();

    QCOMPARE(l_backgrounds.at(0), "Anime");
    QCOMPARE(l_backgrounds.at(1), "Zetta");
    QCOMPARE(l_backgrounds.at(2), "default");
    QCOMPARE(l_backgrounds.at(3), "birthday");
    QCOMPARE(l_backgrounds.at(4), "Christmas");
}

void tst_ConfigManager::musiclist()
{
    MusicList l_musiclist = ConfigManager::musiclist();
    qDebug() << l_musiclist;
    QPair<QString, int> l_contents;
    // The musiclist is structured as {DisplayName , {Songname, Duration}}.

    // Categories have no duration and their alias is always the category name.
    l_contents = l_musiclist.value("==Samplelist==");
    QCOMPARE(l_contents.first, "==Samplelist==");
    QCOMPARE(l_contents.second, 0);

    // The displayname is shown in the musiclist. The realname is what is send to the client when it wants to play the song.
    l_contents = l_musiclist.value("Announce The Truth (JFA).opus");
    QCOMPARE(l_contents.first, "https://localhost/Announce The Truth (JFA).opus");
    QCOMPARE(l_contents.second, 98);
}

void tst_ConfigManager::ordered_songs()
{
    QStringList l_ordered_musiclist = ConfigManager::ordered_songs();
    QCOMPARE(l_ordered_musiclist.at(0), "==Samplelist==");
    QCOMPARE(l_ordered_musiclist.at(1), "Announce The Truth (AA).opus");
    QCOMPARE(l_ordered_musiclist.at(2), "Announce The Truth (AJ).opus");
    QCOMPARE(l_ordered_musiclist.at(3), "Announce The Truth (JFA).opus");
}

void tst_ConfigManager::regression_pr_314()
{
    // Populate songlist.
    Q_UNUSED(ConfigManager::musiclist());

    // Tests for regression where a reload of the songlist would cause the list to duplicate.
    QStringList l_list = ConfigManager::ordered_songs();

    // We have a populated ordered list and it has a valid size.
    QCOMPARE(l_list.isEmpty(), false);
    QCOMPARE(l_list.size(), 4);

    // We are reloading the songlist. The size should be the same and the list has not changed.
    Q_UNUSED(ConfigManager::musiclist());
    QCOMPARE(l_list.size(), ConfigManager::ordered_songs().size());
    QCOMPARE(l_list, ConfigManager::ordered_songs());
}

void tst_ConfigManager::CommandInfo()
{
    // Prepare command help cache.
    ConfigManager::loadCommandHelp();
    ConfigManager::help l_help;

    // Load the sample command information.
    l_help = ConfigManager::commandHelp("foo");
    QCOMPARE(l_help.text, "A sample explanation.");
    QCOMPARE(l_help.usage, "/foo <bar> [baz|qux]");

    l_help = ConfigManager::commandHelp("login");
    QCOMPARE(l_help.text, "Activates the login dialogue to enter your credentials. This command takes no arguments.");
    QCOMPARE(l_help.usage, "/login");
}

void tst_ConfigManager::iprangeBans()
{
    QStringList l_ipranges = ConfigManager::iprangeBans();
    QCOMPARE(l_ipranges.at(0), "192.0.2.0/24");
    QCOMPARE(l_ipranges.at(1), "198.51.100.0/24");
}

void tst_ConfigManager::maxPlayers()
{
}

void tst_ConfigManager::serverPort()
{
}

void tst_ConfigManager::serverDescription()
{
}

void tst_ConfigManager::serverName()
{
}

void tst_ConfigManager::motd()
{
}

void tst_ConfigManager::webaoEnabled()
{
}

void tst_ConfigManager::authType()
{
}

void tst_ConfigManager::modpass()
{
}

void tst_ConfigManager::logBuffer()
{
}

void tst_ConfigManager::loggingType()
{
}

void tst_ConfigManager::maxStatements()
{
}

void tst_ConfigManager::multiClientLimit()
{
}

void tst_ConfigManager::maxCharacters()
{
}

void tst_ConfigManager::messageFloodguard()
{
}

void tst_ConfigManager::globalMessageFloodguard()
{
}

void tst_ConfigManager::assetUrl()
{
}

void tst_ConfigManager::diceMaxValue()
{
}

void tst_ConfigManager::diceMaxDice()
{
}

void tst_ConfigManager::passwordRequirements()
{
}

void tst_ConfigManager::passwordMinLength()
{
}

void tst_ConfigManager::passwordMaxLength()
{
}

void tst_ConfigManager::passwordRequireMixCase()
{
}

void tst_ConfigManager::passwordRequireNumbers()
{
}

void tst_ConfigManager::passwordRequireSpecialCharacters()
{
}

void tst_ConfigManager::passwordCanContainUsername()
{
}

void tst_ConfigManager::magic8BallAnswers()
{
}

void tst_ConfigManager::praiseList()
{
}

void tst_ConfigManager::reprimandsList()
{
}

void tst_ConfigManager::gimpList()
{
}

void tst_ConfigManager::cdnList()
{
}

void tst_ConfigManager::publishServerEnabled()
{
}

void tst_ConfigManager::advertiserDebug()
{
}

void tst_ConfigManager::serverlistURL()
{
}

void tst_ConfigManager::serverDomainName()
{
}

void tst_ConfigManager::advertiseWSProxy()
{
}

}
}

QTEST_APPLESS_MAIN(tests::unittests::tst_ConfigManager)

#include "tst_unittest_config_manager.moc"