Mirrors/openrw
1
0
Fork 0
mirror of https://github.com/rwengine/openrw.git synced 2024-09-15 06:52:34 +02:00
Code Issues Projects Releases Activity

config: added default INI string test + simplified tests + removed WTF

Browse Source
This commit is contained in:
Anonymous Maarten 2017-02-17 14:00:02 +01:00 committed by Daniel Evans
parent 8f5664498c
commit 66b09a64a5
2 changed files with 94 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
rwgame/GameConfig.cpp
View File

@ -117,26 +117,16 @@ bool GameConfig::parseConfig(
{ {
pt::ptree srcTree; pt::ptree srcTree;
if ((srcType == ParseType::STRING) || (srcType == ParseType::FILE)) { try {
try { if (srcType == ParseType::STRING) {
switch (srcType) { pt::read_ini(source, srcTree);
case ParseType::STRING: } else if (srcType == ParseType::FILE) {
pt::read_ini(source, srcTree); std::ifstream ifs(source);
break; pt::read_ini(ifs, srcTree);
case ParseType::FILE:
{
std::ifstream ifs(source);
pt::read_ini(ifs, srcTree);
break;
}
default:
//Cannot reach here
return false;
}
} catch (pt::ini_parser_error &e) {
RW_MESSAGE(e.what());
return false;
} }
} catch (pt::ini_parser_error &e) {
RW_MESSAGE(e.what());
return false;
} }
bool success = true; bool success = true;

138
tests/test_config.cpp
View File

@ -9,10 +9,6 @@
namespace fs = boost::filesystem; namespace fs = boost::filesystem;
typedef std::map<std::string, std::map<std::string, std::string>> simpleConfig_t; typedef std::map<std::string, std::map<std::string, std::string>> simpleConfig_t;
fs::path getRandomFilePath() {
return fs::unique_path(fs::temp_directory_path() /= "openrw_test_%%%%%%%%%%%%%%%%");
}
simpleConfig_t getValidConfig() { simpleConfig_t getValidConfig() {
simpleConfig_t result; simpleConfig_t result;
@ -23,7 +19,7 @@ simpleConfig_t getValidConfig() {
return result; return result;
} }
std::ostream &writeConfig(std::ostream &os, const simpleConfig_t &config) { std::ostream &operator<<(std::ostream &os, const simpleConfig_t &config) {
for (auto &section : config) { for (auto &section : config) {
os << "[" << section.first << "]" << "\n"; os << "[" << section.first << "]" << "\n";
for (auto &keyValue : section.second) { for (auto &keyValue : section.second) {
@ -33,19 +29,56 @@ std::ostream &writeConfig(std::ostream &os, const simpleConfig_t &config) {
return os; 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_SUITE(ConfigTests)
BOOST_AUTO_TEST_CASE(test_config_valid) { BOOST_AUTO_TEST_CASE(test_config_valid) {
// Test reading a valid configuration file // Test reading a valid configuration file
auto cfg = getValidConfig(); auto cfg = getValidConfig();
auto configPath = getRandomFilePath();
std::ofstream ofs(configPath.string()); TempFile tempFile;
writeConfig(ofs, cfg); tempFile.write(cfg);
ofs.close();
GameConfig config(configPath.filename().string(), GameConfig config(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK(config.isValid()); BOOST_CHECK(config.isValid());
@ -59,14 +92,11 @@ BOOST_AUTO_TEST_CASE(test_config_valid_modified) {
auto cfg = getValidConfig(); auto cfg = getValidConfig();
cfg["game"]["path"] = "Liberty City"; cfg["game"]["path"] = "Liberty City";
cfg["input"]["invert_y"] = "0"; cfg["input"]["invert_y"] = "0";
auto configPath = getRandomFilePath();
std::ofstream ofs(configPath.string()); TempFile tempFile;
writeConfig(ofs, cfg); tempFile.write(cfg);
ofs.close();
GameConfig config(configPath.filename().string(), GameConfig config(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK(config.isValid()); BOOST_CHECK(config.isValid());
@ -78,41 +108,49 @@ BOOST_AUTO_TEST_CASE(test_config_save) {
// Test saving a configuration file // Test saving a configuration file
auto cfg = getValidConfig(); auto cfg = getValidConfig();
cfg["game"]["path"] = "Liberty City"; cfg["game"]["path"] = "Liberty City";
auto configPath = getRandomFilePath();
std::ofstream ofs(configPath.string()); TempFile tempFile;
writeConfig(ofs, cfg); tempFile.write(cfg);
ofs.close();
GameConfig config(configPath.filename().string(), GameConfig config(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK(config.isValid()); BOOST_CHECK(config.isValid());
fs::remove(configPath); tempFile.remove();
BOOST_CHECK(!tempFile.exists());
BOOST_CHECK(!fs::exists(configPath));
BOOST_CHECK(config.saveConfig()); BOOST_CHECK(config.saveConfig());
BOOST_CHECK(fs::exists(configPath)); BOOST_CHECK(tempFile.exists());
GameConfig config2(configPath.filename().string(), GameConfig config2(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK_EQUAL(config2.getGameDataPath(), "Liberty City"); 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) { BOOST_AUTO_TEST_CASE(test_config_invalid_duplicate) {
// Test duplicate keys in invalid configuration file // Test duplicate keys in invalid configuration file
auto cfg = getValidConfig(); auto cfg = getValidConfig();
cfg["input"]["invert_y "] = "0"; cfg["input"]["invert_y "] = "0";
auto configPath = getRandomFilePath();
std::ofstream ofs(configPath.string()); TempFile tempFile;
writeConfig(ofs, cfg); tempFile.write(cfg);
ofs.close();
GameConfig config(configPath.filename().string(), GameConfig config(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK(!config.isValid()); BOOST_CHECK(!config.isValid());
} }
@ -121,39 +159,33 @@ BOOST_AUTO_TEST_CASE(test_config_invalid_required_missing) {
// Test missing required keys in invalid configuration file // Test missing required keys in invalid configuration file
auto cfg = getValidConfig(); auto cfg = getValidConfig();
cfg["game"].erase("path"); cfg["game"].erase("path");
auto configPath = getRandomFilePath();
std::ofstream ofs(configPath.string()); TempFile tempFile;
writeConfig(ofs, cfg); tempFile.write(cfg);
ofs.close();
GameConfig config(configPath.filename().string(), GameConfig config(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK(!config.isValid()); BOOST_CHECK(!config.isValid());
} }
BOOST_AUTO_TEST_CASE(test_config_invalid_empty) { BOOST_AUTO_TEST_CASE(test_config_invalid_empty) {
// Test reading empty configuration file // Test reading empty configuration file
simpleConfig_t cfg;
auto configPath = getRandomFilePath();
std::ofstream ofs(configPath.string()); TempFile tempFile;
writeConfig(ofs, cfg); tempFile.touch();
ofs.close(); BOOST_CHECK(tempFile.exists());
GameConfig config(configPath.filename().string(), GameConfig config(tempFile.filename(), tempFile.dirname());
configPath.parent_path().string());
BOOST_CHECK(!config.isValid()); BOOST_CHECK(!config.isValid());
} }
BOOST_AUTO_TEST_CASE(test_config_invalid_nonexisting) { BOOST_AUTO_TEST_CASE(test_config_invalid_nonexisting) {
// Test reading non-existing configuration file // Test reading non-existing configuration file
auto configPath = getRandomFilePath(); TempFile tempFile;
GameConfig config(configPath.filename().string(), BOOST_CHECK(!tempFile.exists());
configPath.parent_path().string()); GameConfig config(tempFile.filename(), tempFile.dirname());
BOOST_CHECK(!config.isValid()); BOOST_CHECK(!config.isValid());
} }