OpenRCT2/test/tests/IniWriterTest.cpp

#include <gtest/gtest.h>
#include <limits>
#include "openrct2/config/ConfigEnum.hpp"
#include "openrct2/config/IniWriter.hpp"
#include "openrct2/core/MemoryStream.h"
#include "openrct2/platform/platform.h"

class IniWriterTest : public testing::Test
{
};

static auto Enum_Currency = ConfigEnum<sint32>({
    ConfigEnumEntry<sint32>("GBP", 1),
});

TEST_F(IniWriterTest, create_empty)
{
    MemoryStream * ms = new MemoryStream(0);
    ASSERT_NE(ms, nullptr);
    ASSERT_EQ(ms->CanRead(), true);
    ASSERT_EQ(ms->CanWrite(), true);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_one_section)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteSection("OpenRCT2");
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 12);
    ASSERT_LE(ms->GetPosition(), 13); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini, "[OpenRCT2]" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_multiple_sections)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteSection("OpenRCT1");
    iw->WriteSection("OpenRCT2");
    iw->WriteSection("OpenRCT3");
    iw->WriteSection("OpenRCT4");
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 48);
    ASSERT_LE(ms->GetPosition(), 55); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini, "[OpenRCT1]" PLATFORM_NEWLINE PLATFORM_NEWLINE "[OpenRCT2]" PLATFORM_NEWLINE PLATFORM_NEWLINE
                      "[OpenRCT3]" PLATFORM_NEWLINE PLATFORM_NEWLINE "[OpenRCT4]" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_loose_bool_entry)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteBoolean("boolval", true);
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 16);
    ASSERT_LE(ms->GetPosition(), 17); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini, "boolval = true" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_loose_enum_entry)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteEnum("by_string", "stringval");
    iw->WriteEnum<sint32>("sint32", 0, Enum_Currency);
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 34);
    ASSERT_LE(ms->GetPosition(), 36); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini, "by_string = stringval" PLATFORM_NEWLINE "sint32 = 0" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_loose_float_entry)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteFloat("one", 1.);
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 16);
    ASSERT_LE(ms->GetPosition(), 17); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    // This will be non-fatal due to float.
    EXPECT_STREQ(ini, "one = 1.000000" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_loose_sint32_entry)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteSint32("one", 1);
    iw->WriteSint32("zero", 0);
    iw->WriteSint32("minusone", -1);
    iw->WriteSint32("intmin", (std::numeric_limits<sint32>::min)());
    iw->WriteSint32("intmax", (std::numeric_limits<sint32>::max)());
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 73);
    ASSERT_LE(ms->GetPosition(), 78); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini, "one = 1" PLATFORM_NEWLINE "zero = 0" PLATFORM_NEWLINE "minusone = -1" PLATFORM_NEWLINE
                      "intmin = -2147483648" PLATFORM_NEWLINE "intmax = 2147483647" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_loose_string_entry)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteString("path", u8"C:'\\some/dir\\here/神鷹暢遊");
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 43);
    ASSERT_LE(ms->GetPosition(), 44); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini, "path = \"C:'\\\\some/dir\\\\here/\xE7\xA5\x9E\xE9\xB7\xB9\xE6\x9A\xA2\xE9\x81\x8A\"" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}

TEST_F(IniWriterTest, create_multiple_section_with_values)
{
    MemoryStream * ms = new MemoryStream(1000);
    ASSERT_NE(ms, nullptr);
    IIniWriter * iw = CreateIniWriter(ms);
    ASSERT_NE(iw, nullptr);
    iw->WriteSection("bool");
    iw->WriteBoolean("boolval", true);
    iw->WriteSection("int");
    iw->WriteSint32("one", 1);
    iw->WriteSint32("zero", 0);
    iw->WriteSection("string");
    iw->WriteString("path", u8"C:'\\some/dir\\here/神鷹暢遊");
    int8_t null_terminator = 0;
    ms->Write(&null_terminator, 1);
    ASSERT_GE(ms->GetPosition(), 99);
    ASSERT_LE(ms->GetPosition(), 108); // Accomodate for varying-sized newline (Windows)
    ASSERT_EQ(ms->GetLength(), ms->GetPosition());
    ms->SetPosition(0);
    const char * ini = (const char *)ms->ReadString();
    ASSERT_STREQ(ini,
                 "[bool]" PLATFORM_NEWLINE "boolval = true" PLATFORM_NEWLINE PLATFORM_NEWLINE "[int]" PLATFORM_NEWLINE
                 "one = 1" PLATFORM_NEWLINE "zero = 0" PLATFORM_NEWLINE PLATFORM_NEWLINE "[string]" PLATFORM_NEWLINE "path = "
                 "\"C:'\\\\some/dir\\\\here/\xE7\xA5\x9E\xE9\xB7\xB9\xE6\x9A\xA2\xE9\x81\x8A\"" PLATFORM_NEWLINE);
    Memory::Free(ini);
    delete iw;
    delete ms;
}