-
Notifications
You must be signed in to change notification settings - Fork 110
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace old GENERAL_OBSERVATION error message
Replaced to dynamically report keywords for which files cannot be located, topped off with an extensive unit-test. The method conf_instance_has_path_error() is neither used not defined anywhere so declaration is removed from conf.hpp
- Loading branch information
1 parent
1fa5533
commit a5794d6
Showing
5 changed files
with
231 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| #include <stdlib.h> | ||
| #include <string> | ||
| #include <fstream> | ||
|
|
||
| #include <catch2/catch.hpp> | ||
|
|
||
| #include <ert/enkf/enkf_obs.hpp> | ||
| #include "../tmpdir.hpp" | ||
|
|
||
| /* | ||
| * Write conf-file with given keywords, then parse it. | ||
| * Returns pointer to the parsed configuration | ||
| */ | ||
| conf_instance_type *write_conf(std::vector<std::string> keyword_lines) { | ||
| std::string buf("GENERAL_OBSERVATION WPR_DIFF_1 {\n"); | ||
| buf += " DATA = SNAKE_OIL_WPR_DIFF;\n"; | ||
| buf += " INDEX_LIST = 400,800,1200,1800;\n"; | ||
| buf += " RESTART = 199;\n"; | ||
| for (auto s : keyword_lines) | ||
| buf += s + "\n"; | ||
| buf += "};\n"; | ||
|
|
||
| std::ofstream stream("obs_path/conf.txt", std::ostream::out); | ||
| stream.write(buf.data(), buf.size()); | ||
| stream.close(); // close before reading in next step! | ||
|
|
||
| conf_class_type *enkf_conf_class = enkf_obs_get_obs_conf_class(); | ||
| return conf_instance_alloc_from_file(enkf_conf_class, "enkf_conf", | ||
| "obs_path/conf.txt"); | ||
| } | ||
|
|
||
| /* | ||
| * Just a convenient wrapper from char* to std::string | ||
| */ | ||
| std::string get_path_error(conf_instance_type *enkf_conf) { | ||
| char *errors = conf_instance_get_path_error(enkf_conf); | ||
| if (errors) { | ||
| std::string s(errors); | ||
| free(errors); | ||
| return s; | ||
| } else | ||
| return std::string(""); | ||
| } | ||
|
|
||
| /* | ||
| * Syntactic sugar for checking if a string contains another string | ||
| * The memmber-function ::contains() is introduced in C++23 | ||
| */ | ||
| bool contains(std::string errors, std::string kw) { | ||
| return errors.find(kw) != std::string::npos; | ||
| } | ||
|
|
||
| /** | ||
| * Syntactic sugar for making sure a file exists ("touching" it) | ||
| * | ||
| * Note that std::ofstream is a proper RAII object which means | ||
| * neither flush nor close is required. | ||
| */ | ||
| void touch_file(std::string name) { | ||
| std::ofstream stream(name.data(), std::ostream::out); | ||
| } | ||
|
|
||
| TEST_CASE("Test parsing keywords in configuration", "[unittest]") { | ||
| GIVEN("A workearea") { | ||
| WITH_TMPDIR; | ||
| std::filesystem::create_directory("obs_path"); | ||
|
|
||
| GIVEN("A conf file with no relevant keywords") { | ||
| conf_instance_type *enkf_conf = write_conf({}); | ||
| THEN("There are no errors") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(!contains(errors, "OBS_FILE")); | ||
| REQUIRE(!contains(errors, "ERROR_COVAR")); | ||
| REQUIRE(!contains(errors, "INDEX_FILE")); | ||
| } | ||
| conf_instance_free(enkf_conf); | ||
| } | ||
|
|
||
| GIVEN("A conf file with OBS_FILE keyword in it") { | ||
| conf_instance_type *enkf_conf = | ||
| write_conf({"OBS_FILE = obs.txt;"}); | ||
| WHEN("There is no OBS_FILE present") { | ||
| THEN("Error refers to missing file") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(contains( | ||
| errors, "OBS_FILE=>" + | ||
| std::filesystem::current_path().native() + | ||
| "/obs_path/obs.txt")); | ||
| REQUIRE(!contains(errors, "ERROR_COVAR")); | ||
| REQUIRE(!contains(errors, "INDEX_FILE")); | ||
| } | ||
| } | ||
| WHEN("The obs file is present") { | ||
| touch_file("obs_path/obs.txt"); | ||
| THEN("There are no errors") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(!contains(errors, "OBS_FILE")); | ||
| REQUIRE(!contains(errors, "ERROR_COVAR")); | ||
| REQUIRE(!contains(errors, "INDEX_FILE")); | ||
| } | ||
| } | ||
| conf_instance_free(enkf_conf); | ||
| } | ||
|
|
||
| GIVEN("A conf file with OBS_FILE in subdir obs_path") { | ||
| conf_instance_type *enkf_conf = | ||
| write_conf({"OBS_FILE = obs_path/obs.txt;"}); | ||
|
|
||
| WHEN("The OBS_FILE is in the wrong location") { | ||
| touch_file("obs_path/obs.txt"); | ||
| THEN("Error refers to missing file") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(contains( | ||
| errors, "OBS_FILE=>" + | ||
| std::filesystem::current_path().native() + | ||
| "/obs_path/obs_path/obs.txt")); | ||
| REQUIRE(!contains(errors, "ERROR_COVAR")); | ||
| REQUIRE(!contains(errors, "INDEX_FILE")); | ||
| } | ||
| } | ||
| WHEN("The OBS_FILE is in the subdirectory") { | ||
| util_make_path("obs_path/obs_path"); | ||
| touch_file("obs_path/obs_path/obs.txt"); | ||
| THEN("There are no errors") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(!contains(errors, "OBS_FILE")); | ||
| REQUIRE(!contains(errors, "ERROR_COVAR")); | ||
| REQUIRE(!contains(errors, "INDEX_FILE")); | ||
| } | ||
| } | ||
| conf_instance_free(enkf_conf); | ||
| } | ||
|
|
||
| GIVEN( | ||
| "A conf file with OBS_FILE, ERROR_COVAR and INDEX_FILE keywords") { | ||
| conf_instance_type *enkf_conf = | ||
| write_conf({"OBS_FILE = obs.txt;" | ||
| "ERROR_COVAR = covar.txt;" | ||
| "INDEX_FILE = index.txt;"}); | ||
|
|
||
| WHEN("Only OBS_FILE exists") { | ||
| touch_file("obs_path/obs.txt"); | ||
| THEN("Error refer to missing covar and index file") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(!contains(errors, "OBS_FILE")); | ||
| REQUIRE(contains( | ||
| errors, "ERROR_COVAR=>" + | ||
| std::filesystem::current_path().native() + | ||
| "/obs_path/covar.txt")); | ||
| REQUIRE(contains( | ||
| errors, "INDEX_FILE=>" + | ||
| std::filesystem::current_path().native() + | ||
| "/obs_path/index.txt")); | ||
| } | ||
| } | ||
| WHEN("covar, obs, and index files exist") { | ||
| touch_file("obs_path/obs.txt"); | ||
| touch_file("obs_path/covar.txt"); | ||
| touch_file("obs_path/index.txt"); | ||
| THEN("There are no errors") { | ||
| std::string errors = get_path_error(enkf_conf); | ||
| REQUIRE(!contains(errors, "OBS_FILE")); | ||
| REQUIRE(!contains(errors, "ERROR_COVAR")); | ||
| REQUIRE(!contains(errors, "INDEX_FILE")); | ||
| } | ||
| } | ||
| conf_instance_free(enkf_conf); | ||
| } | ||
| } | ||
| } |