Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DAPHNE-#867] Change ConfigParser::fileExists() behavior to not throw #867

Closed
wants to merge 1 commit into from
+23 −8
Closed

[DAPHNE-#867] Change ConfigParser::fileExists() behavior to not throw #867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/parser/config/ConfigParser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ int readLogLevel(const std::string &level) {
bool ConfigParser::fileExists(const std::string &filename) {
// Open the given config file.
std::ifstream ifs(filename, std::ios::in);
if (!ifs.good())
throw std::runtime_error("could not open file '" + filename + "' for reading user config");
if (!ifs.good()) {
spdlog::warn("could not open file {} for reading user config", filename);
return false;
}
return true;
}

Expand Down
25 changes: 19 additions & 6 deletions test/parser/config/ConfigParserTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,78 +14,90 @@
* limitations under the License.
*/

#include <tags.h>

#include <catch.hpp>
#include "run_tests.h"

#include <parser/config/ConfigParser.h>

#include <iostream>

const std::string dirPath = "test/parser/config/configFiles/";

TEST_CASE("Proper config file from daphne root directory") {
auto dctx = setupContextAndLogger();
const std::string configFile = "UserConfig.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_NOTHROW(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("Missing config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = "-";
REQUIRE_THROWS(ConfigParser::fileExists(configFile));

auto throwLambda = [configFile]() {
if (!ConfigParser::fileExists(configFile))
throw std::runtime_error("could not open file '" + configFile + "' for reading user config");
};

REQUIRE_THROWS(throwLambda());
}

TEST_CASE("Empty config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig1.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_NOTHROW(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("Wrong JSON format in the config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig2.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_THROWS(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("Wrong format of config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig3.txt";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_THROWS(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("Config file that contains only some keys", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig4.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_NOTHROW(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("Unknown key in the config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig5.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_THROWS(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("The unknown value of param in the config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig6.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_THROWS(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("An adequate enum value set in the config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig7.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
REQUIRE_NOTHROW(ConfigParser::readUserConfig(configFile, userConfig));
}

TEST_CASE("An unknown enum value set in the config file", TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig8.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
Expand All @@ -95,6 +107,7 @@ TEST_CASE("An unknown enum value set in the config file", TAG_PARSER) {
TEST_CASE("Integer set as enum value instead of the name of the enum value in "
"string format in the config file",
TAG_PARSER) {
auto dctx = setupContextAndLogger();
const std::string configFile = dirPath + "UserConfig9.json";
DaphneUserConfig userConfig{};
REQUIRE(ConfigParser::fileExists(configFile));
Expand Down