openrw/tests/test_config.cpp

#include <GameConfig.hpp>

#include <boost/filesystem.hpp>
#include <boost/test/unit_test.hpp>

#include <fstream>
#include <map>

namespace fs = boost::filesystem;

typedef std::map<std::string, std::map<std::string, std::string>> simpleConfig_t;

simpleConfig_t getValidConfig() {
    simpleConfig_t result;
    // Don't change game.path and input.invert_y keys. Tests depend on them.
    result["game"]["path"] = "\t/dev/test  \t \r\n";
    result["game"]["\tlanguage\t "] = "      american ;american english french german italian spanish.";
    result["input"]["invert_y"] = "1 #values != 0 enable input inversion. Optional.";
    return result;
}

std::ostream &operator<<(std::ostream &os, const simpleConfig_t &config) {
    for (auto &section : config) {
        os << "[" << section.first << "]" << "\n";
        for (auto &keyValue : section.second) {
            os << keyValue.first << "=" << keyValue.second << "\n";
        }
    }
    return os;
}

class TempFile {
    // A TempFile file will be removed on destruction
public:
    TempFile() : m_path(getRandomFilePath()) {
    }
    ~TempFile() {
        this->remove();
    }
    void remove() {
        fs::remove(this->m_path);
    }
    void touch() {
        std::ofstream ofs(this->path());
        ofs.close();
    }
    bool exists() {
        return fs::exists(this->m_path);
    }
    std::string path() {
        return this->m_path.string();
    }
    std::string filename() {
        return this->m_path.filename().string();
    }
    std::string dirname() {
        return this->m_path.parent_path().string();
    }
    template<typename T>
    void write(T t) {
        std::ofstream ofs(this->path());
        ofs << t;
        ofs.close();
    }
private:
    static fs::path getRandomFilePath() {
        return fs::unique_path(fs::temp_directory_path() / "openrw_test_%%%%%%%%%%%%%%%%");
    }
    fs::path m_path;
};

BOOST_AUTO_TEST_SUITE(ConfigTests)

BOOST_AUTO_TEST_CASE(test_config_valid) {
    // Test reading a valid configuration file
    auto cfg = getValidConfig();

    TempFile tempFile;
    tempFile.write(cfg);

    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(config.isValid());

    BOOST_CHECK_EQUAL(config.getGameDataPath(), "/dev/test");
    BOOST_CHECK_EQUAL(config.getGameLanguage(), "american");
    BOOST_CHECK_EQUAL(config.getInputInvertY(), true);
}

BOOST_AUTO_TEST_CASE(test_config_valid_modified) {
    // Test reading a valid modified configuration file
    auto cfg = getValidConfig();
    cfg["game"]["path"] = "Liberty City";
    cfg["input"]["invert_y"] = "0";

    TempFile tempFile;
    tempFile.write(cfg);

    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(config.isValid());

    BOOST_CHECK_EQUAL(config.getInputInvertY(), false);
    BOOST_CHECK_EQUAL(config.getGameDataPath(), "Liberty City");
}

BOOST_AUTO_TEST_CASE(test_config_save) {
    // Test saving a configuration file
    auto cfg = getValidConfig();
    cfg["game"]["path"] = "Liberty City";

    TempFile tempFile;
    tempFile.write(cfg);

    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(config.isValid());
    
    tempFile.remove();
    BOOST_CHECK(!tempFile.exists());

    BOOST_CHECK(config.saveConfig());
    BOOST_CHECK(tempFile.exists());

    GameConfig config2(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK_EQUAL(config2.getGameDataPath(), "Liberty City");
}

BOOST_AUTO_TEST_CASE(test_config_valid_default) {
    // Test whether the default INI string is valid
    TempFile tempFile;
    BOOST_CHECK(!tempFile.exists());
    
    GameConfig config(tempFile.filename(), tempFile.dirname());
    BOOST_CHECK(!config.isValid());

    auto defaultINI = config.getDefaultINIString();
    tempFile.write(defaultINI);

    config = GameConfig(tempFile.filename(), tempFile.dirname());
    BOOST_CHECK(config.isValid());
}

BOOST_AUTO_TEST_CASE(test_config_invalid_duplicate) {
    // Test duplicate keys in invalid configuration file
    auto cfg = getValidConfig();
    cfg["input"]["invert_y    "] = "0";

    TempFile tempFile;
    tempFile.write(cfg);

    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(!config.isValid());
}

BOOST_AUTO_TEST_CASE(test_config_invalid_required_missing) {
    // Test missing required keys in invalid configuration file
    auto cfg = getValidConfig();
    cfg["game"].erase("path");

    TempFile tempFile;
    tempFile.write(cfg);

    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(!config.isValid());
}

BOOST_AUTO_TEST_CASE(test_config_invalid_empty) {
    // Test reading empty configuration file

    TempFile tempFile;
    tempFile.touch();
    BOOST_CHECK(tempFile.exists());

    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(!config.isValid());
}

BOOST_AUTO_TEST_CASE(test_config_invalid_nonexisting) {
    // Test reading non-existing configuration file
    TempFile tempFile;

    BOOST_CHECK(!tempFile.exists());
    GameConfig config(tempFile.filename(), tempFile.dirname());

    BOOST_CHECK(!config.isValid());
}

BOOST_AUTO_TEST_SUITE_END()