MuditaOS/module-db/tests/SettingsRecord_v2_tests.cpp

// Copyright (c) 2017-2020, Mudita Sp. z.o.o. All rights reserved.
// For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md

#include "vfs.hpp"

#include <catch2/catch.hpp>

#include "Database/Database.hpp"
#include "Databases/SettingsDB.hpp"
#include "Interface/SettingsRecord_v2.hpp"
#include "module-db/queries/settings/QuerySettingsAddOrIgnore_v2.hpp"
#include "module-db/queries/settings/QuerySettingsGet_v2.hpp"
#include "module-db/queries/settings/QuerySettingsUpdate_v2.hpp"

#include <algorithm>

#include <cstdint>
#include <cstdio>
#include <cstring>

TEST_CASE("Settings Record version 2 tests")
{
    Database::initialize();

    vfs.remove(SettingsDB::GetDBName());

    auto settingsDB = std::make_unique<SettingsDB>();
    REQUIRE(settingsDB->isInitialized());

    SECTION("Default Constructor")
    {
        SettingsRecord_v2 testRec;
        REQUIRE_FALSE(testRec.isValid());
        REQUIRE(testRec.ID == DB_ID_NONE);
        REQUIRE(testRec.getPath() == "");
        REQUIRE(testRec.getValue<std::string>() == "");
    }

    SECTION("Constructor from NotificationsTableRow")
    {
        SettingsTableRow_v2 tableRow{{.ID = 50}, .path = "test/test", .value = "test"};

        SettingsRecord_v2 testRec(tableRow);
        REQUIRE(testRec.isValid());
        REQUIRE(testRec.ID == 50);
        REQUIRE(testRec.getPath() == "test/test");
        REQUIRE(testRec.getValue<std::string>() == "test");
    }

    SettingsRecordInterface_v2 settingsRecordInterface(settingsDB.get());

    SECTION("Add entries")
    {
        const std::vector<SettingsTableRow_v2> rows = {{{.ID = 1}, .path = "test1/test", .value = "1"},
                                                       {{.ID = 2}, .path = "test2/test", .value = "2"}};

        for (const auto &row : rows) {
            REQUIRE(settingsRecordInterface.Add(SettingsRecord_v2(row)));
        }

        REQUIRE(settingsRecordInterface.GetCount() == rows.size());
    }

    SECTION("Get entry")
    {
        SettingsTableRow_v2 tableRow{{.ID = 1}, .path = "audio/RoutingSpeakerphone/volume", .value = "2"};
        REQUIRE(settingsRecordInterface.Add(SettingsRecord_v2(tableRow)));

        SECTION("Get by ID")
        {
            auto settingsEntry = settingsRecordInterface.GetByID(1);
            REQUIRE(settingsEntry.ID == 1);
            REQUIRE(settingsEntry.getPath() == "audio/RoutingSpeakerphone/volume");
            REQUIRE(settingsEntry.getValue<int>() == 2);
        }

        SECTION("Get by path")
        {
            auto settingsEntry = settingsRecordInterface.GetByPath("audio/RoutingSpeakerphone/volume");
            REQUIRE(settingsEntry.ID == 1);
            REQUIRE(settingsEntry.getPath() == "audio/RoutingSpeakerphone/volume");
            REQUIRE(settingsEntry.getValue<int>() == 2);
        }
    }

    SECTION("Get entry - invalid ID")
    {
        auto entry = settingsRecordInterface.GetByID(100);
        REQUIRE_FALSE(entry.isValid());
        REQUIRE(entry.ID == DB_ID_NONE);
        REQUIRE(entry.getPath() == "");
        REQUIRE(entry.getValue<std::string>() == "");
    }

    SECTION("Get entry - invalid path")
    {
        auto entry = settingsRecordInterface.GetByPath("abc");
        REQUIRE_FALSE(entry.isValid());
        REQUIRE(entry.ID == DB_ID_NONE);
        REQUIRE(entry.getPath() == "");
        REQUIRE(entry.getValue<std::string>() == "");
    }

    SECTION("Create, update, delete")
    {
        const std::vector<SettingsTableRow_v2> rows = {{{.ID = 1}, .path = "test1/test", .value = "1"},
                                                       {{.ID = 2}, .path = "test2/test", .value = "2"}};

        for (const auto &row : rows) {
            REQUIRE(settingsRecordInterface.Add(SettingsRecord_v2(row)));
        }

        REQUIRE(settingsRecordInterface.GetCount() == rows.size());

        SECTION("Update entry")
        {
            SettingsRecord_v2 entryToUpdate{{{.ID = 1}, .path = "pure/test", .value = "test"}};
            REQUIRE(settingsRecordInterface.Update(entryToUpdate));
            auto updatedEntry = settingsRecordInterface.GetByID(1);
            REQUIRE(updatedEntry.isValid());
            REQUIRE(updatedEntry.ID == entryToUpdate.ID);
            REQUIRE(updatedEntry.getPath() == entryToUpdate.getPath());
            REQUIRE(updatedEntry.getValue<std::string>() == entryToUpdate.getValue<std::string>());
        }

        SECTION("Clear table")
        {
            REQUIRE(settingsRecordInterface.RemoveByID(1));
            REQUIRE(settingsRecordInterface.RemoveByID(2));

            REQUIRE(settingsRecordInterface.GetCount() == 0);
        }
    }

    const auto addSettingsItem = [&](const std::string &path, const std::string &value) {
        auto query = std::make_shared<db::query::settings::AddOrIgnoreQuery>(
            SettingsRecord_v2{SettingsTableRow_v2{{.ID = DB_ID_NONE}, .path = path, .value = value}});
        auto ret    = settingsRecordInterface.runQuery(query);
        auto result = dynamic_cast<db::query::settings::AddOrIgnoreResult *>(ret.get());
        REQUIRE(result != nullptr);
        auto resultVal = result->getValue();
        REQUIRE(resultVal == true);
    };

    const auto getSettingsItem = [&](const std::string &path) {
        auto query  = std::make_shared<db::query::settings::SettingsQuery>(path);
        auto ret    = settingsRecordInterface.runQuery(query);
        auto result = dynamic_cast<db::query::settings::SettingsResult *>(ret.get());
        REQUIRE(result != nullptr);
        auto entry = result->getResult();
        REQUIRE(entry.isValid());
        REQUIRE(entry.getPath() == path);
        return entry;
    };

    const auto updateSettingsItem = [&](const std::string &dbPath, const std::string &volume) {
        auto query = std::make_shared<db::query::settings::UpdateQuery>(
            SettingsRecord_v2({{.ID = DB_ID_NONE}, .path = dbPath, .value = volume}));
        auto ret    = settingsRecordInterface.runQuery(query);
        auto result = dynamic_cast<db::query::settings::UpdateResult *>(ret.get());
        REQUIRE(result != nullptr);
        auto resultVal = result->getValue();
        REQUIRE(resultVal == true);
    };

    SECTION("Add, get, update via query")
    {
        // Add items
        REQUIRE(settingsRecordInterface.GetCount() == 0);
        addSettingsItem("pure/Test", "1");
        addSettingsItem("pure/Test/two", "123");
        REQUIRE(settingsRecordInterface.GetCount() == 2);

        SECTION("Get items via query")
        {
            auto entry = getSettingsItem("pure/Test");
            REQUIRE(entry.getValue<std::string>("") == "1");
            entry = getSettingsItem("pure/Test/two");
            REQUIRE(entry.getValue<std::string>("") == "123");
        }
        SECTION("Update and get items via query")
        {
            updateSettingsItem("pure/Test", "2");
            auto entry = getSettingsItem("pure/Test");
            REQUIRE(entry.getValue<std::string>("") == "2");
            updateSettingsItem("pure/Test/two", "test");
            entry = getSettingsItem("pure/Test/two");
            REQUIRE(entry.getValue<std::string>("") == "test");
        }
    }

    Database::deinitialize();
}