MuditaOS/module-db/tests/NotificationsTable_tests.cpp

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

#include <catch2/catch.hpp>
#include "Helpers.hpp"

#include "Database/Database.hpp"
#include "module-db/databases/NotificationsDB.hpp"
#include "Interface/NotificationsRecord.hpp"
#include "Tables/NotificationsTable.hpp"

#include <stdint.h>
#include <string>
#include <algorithm>
#include <iostream>
#include <filesystem>

TEST_CASE("Notifications Table tests")
{
    db::tests::DatabaseUnderTest<NotificationsDB> notificationDb{"notifications.db",
                                                                 db::tests::getPurePhoneScriptsPath()};

    auto &notificationsTbl        = notificationDb.get().notifications;
    const auto notificationsCount = notificationsTbl.count() + 1;
    // clear notifications table
    for (std::size_t id = 1; id <= notificationsCount; id++) {
        REQUIRE(notificationsTbl.removeById(id));
    }
    REQUIRE(notificationsTbl.count() == 0);

    NotificationsTableRow callsRow{
        Record(DB_ID_NONE), .key = static_cast<uint32_t>(NotificationsRecord::Key::Calls), .value = 0};
    REQUIRE(notificationsTbl.add(callsRow));

    NotificationsTableRow smsRow{
        Record(DB_ID_NONE), .key = static_cast<uint32_t>(NotificationsRecord::Key::Sms), .value = 0};
    REQUIRE(notificationsTbl.add(smsRow));

    REQUIRE(notificationsTbl.count() == 2); // it already got some entries Calls(1) and Sms(2)

    SECTION("Default Constructor")
    {
        NotificationsTableRow testRow;
        REQUIRE(testRow.ID == DB_ID_NONE);
        REQUIRE(testRow.key == 0);
        REQUIRE(testRow.value == 0);
        REQUIRE(testRow.contactID == DB_ID_NONE);
        REQUIRE_FALSE(testRow.isValid());
    }

    REQUIRE(notificationsTbl.add({Record(0), .key = 3, .value = 8}));
    REQUIRE(notificationsTbl.add({Record(0), .key = 4, .value = 16, .contactID = 100}));

    REQUIRE(notificationsTbl.count() == 4);

    SECTION("Get entry by ID")
    {
        auto entry = notificationsTbl.getById(4);
        REQUIRE(entry.ID == 4);
        REQUIRE(entry.key == 4);
        REQUIRE(entry.value == 16);
        REQUIRE(entry.contactID == 100);
        REQUIRE(entry.isValid());
    }

    SECTION("Get by key")
    {
        auto entry = notificationsTbl.getById(3);
        REQUIRE(entry.ID == 3);
        REQUIRE(entry.key == 3);
        REQUIRE(entry.value == 8);
        REQUIRE(entry.contactID == DB_ID_NONE);
        REQUIRE(entry.isValid());
    }

    SECTION("Get table rows")
    {
        auto retOffsetLimitSmaller = notificationsTbl.getLimitOffset(0, 2);
        REQUIRE(retOffsetLimitSmaller.size() == 2);

        auto retOffsetLimit = notificationsTbl.getLimitOffset(0, 4);
        REQUIRE(retOffsetLimit.size() == 4);

        auto retOffsetLimitBigger = notificationsTbl.getLimitOffset(0, 100);
        REQUIRE(retOffsetLimitBigger.size() == 4);

        auto retOffsetLimitFailed = notificationsTbl.getLimitOffset(5, 4);
        REQUIRE(retOffsetLimitFailed.size() == 0);
    }

    SECTION("Entry update")
    {
        REQUIRE(notificationsTbl.update({Record(3), .key = 100, .value = 200, .contactID = 300}));
        auto entry = notificationsTbl.getById(3);
        REQUIRE(entry.ID == 3);
        REQUIRE(entry.key == 100);
        REQUIRE(entry.value == 200);
        REQUIRE(entry.contactID == 300);
    }

    SECTION("Get entry - invalid ID")
    {
        auto entry = notificationsTbl.getById(100);
        REQUIRE_FALSE(entry.isValid());
        REQUIRE(entry.ID == DB_ID_NONE);
        REQUIRE(entry.key == 0);
        REQUIRE(entry.value == 0);
        REQUIRE(entry.ID == DB_ID_NONE);
    }

    SECTION("Get by invalid key")
    {
        auto entry = notificationsTbl.getByKey(100);
        REQUIRE(entry.ID == DB_ID_NONE);
        REQUIRE(entry.key == 0);
        REQUIRE(entry.value == 0);
        REQUIRE(entry.ID == DB_ID_NONE);
        REQUIRE_FALSE(entry.isValid());
    }

    SECTION("Remove entries")
    {
        REQUIRE(notificationsTbl.removeById(2));
        REQUIRE(notificationsTbl.count() == 3);

        // Remove non exist
        REQUIRE(notificationsTbl.removeById(100));

        // Remove all elements from table
        REQUIRE(notificationsTbl.removeById(1));
        REQUIRE(notificationsTbl.removeById(3));
        REQUIRE(notificationsTbl.removeById(4));

        // Table should be empty now
        REQUIRE(notificationsTbl.count() == 0);
    }

    SECTION("Remove entries by field")
    {
        REQUIRE(notificationsTbl.removeByField(NotificationsTableFields::key, "2"));
        REQUIRE(notificationsTbl.count() == 3);

        REQUIRE(notificationsTbl.removeByField(NotificationsTableFields::key, "1"));
        REQUIRE(notificationsTbl.count() == 2);

        REQUIRE(notificationsTbl.removeByField(NotificationsTableFields::key, "1"));
        REQUIRE(notificationsTbl.count() == 2); // no change

        REQUIRE(notificationsTbl.removeByField(NotificationsTableFields::key, "100"));
        REQUIRE(notificationsTbl.count() == 2); // no change

        REQUIRE(notificationsTbl.removeByField(NotificationsTableFields::key, "3"));
        REQUIRE(notificationsTbl.count() == 1);

        REQUIRE(notificationsTbl.removeByField(NotificationsTableFields::key, "4"));
        REQUIRE(notificationsTbl.count() == 0);
    }

    SECTION("Check uniqueness")
    {
        REQUIRE(notificationsTbl.add({Record(0), .key = 3, .value = 100, .contactID = 200}));
        REQUIRE(notificationsTbl.count() == 4);
        auto entry = notificationsTbl.getByKey(3);
        REQUIRE(entry.isValid());
        REQUIRE(entry.ID == 3);
        REQUIRE(entry.key == 3);
        REQUIRE(entry.value == 8);
        REQUIRE(entry.contactID == DB_ID_NONE);
    }
}