-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
These changes modify the strategy used to store a checkpoint file. Previously the storage operation consisted of (a) moving the current checkpoint file to a backup, and then (b) storing the contents of the checkpoint file. If the server was terminated during (b), the result would be a corrupt checkpoint file. The new strategy consists of (a) storing the contents of the checkpoint file in a temporary file; (b) moving the current checkpoint to backup; and, finally, (c) promoting the temporary checkpoint file to the current by simply renaming the file. In this case, even if the storage operation is interrupted, the current checkpoint file will never lack integrity. Re ECFLOW-1925
- Loading branch information
1 parent
3fca261
commit 9e44c54
Showing
4 changed files
with
184 additions
and
21 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Copyright 2023- ECMWF. | ||
| * | ||
| * This software is licensed under the terms of the Apache Licence version 2.0 | ||
| * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. | ||
| * In applying this licence, ECMWF does not waive the privileges and immunities | ||
| * granted to it by virtue of its status as an intergovernmental organisation | ||
| * nor does it submit to any jurisdiction. | ||
| */ | ||
|
|
||
| #include <fstream> | ||
| #include <iostream> | ||
|
|
||
| #include <boost/test/unit_test.hpp> | ||
|
|
||
| #include "CheckPtSaver.hpp" | ||
|
|
||
| // TODO: Move the following trace_*_function to a common test module/library | ||
| static void trace_test() { | ||
| std::cout << "..." << boost::unit_test::framework::current_test_case().full_name() << "\n"; | ||
| } | ||
|
|
||
| /** | ||
| * A self cleaning test file, useful to automate test data storage/cleanup, with automatic generation of file names. | ||
| */ | ||
| class TestFile { | ||
| public: | ||
| /** | ||
| * Create a handle for a 'non-existent' data file | ||
| */ | ||
| explicit TestFile(const std::string& basename) : absolute_path_(TestFile::unique_absolute_path(basename)) {} | ||
|
|
||
| /** | ||
| * Create a handle for a data file, with the given content | ||
| */ | ||
| TestFile(const std::string& basename, const std::string& content) | ||
| : absolute_path_(TestFile::unique_absolute_path(basename)) { | ||
| f_store(absolute_path_.string(), content); | ||
| } | ||
| ~TestFile() { fs::remove(absolute_path_); } | ||
|
|
||
| [[nodiscard]] const fs::path& path() const { return absolute_path_; } | ||
| [[nodiscard]] std::string load() const { return f_load(absolute_path_); } | ||
|
|
||
| static fs::path unique_absolute_path(const std::string& basename) { | ||
| return fs::absolute(fs::unique_path(basename)); | ||
| } | ||
|
|
||
| private: | ||
| static void f_store(const fs::path& outfile, const std::string& data) { | ||
| std::ofstream ofs(outfile.string()); | ||
| ofs << data; | ||
| } | ||
|
|
||
| static std::string f_load(const fs::path& infile) { | ||
| std::ifstream ifs(infile.string()); | ||
| std::string buffer((std::istreambuf_iterator<char>(ifs)), std::istreambuf_iterator<char>()); | ||
| return buffer; | ||
| } | ||
|
|
||
| private: | ||
| fs::path absolute_path_; | ||
| }; | ||
|
|
||
| void handle_store(const fs::path& temporary) { | ||
| std::ofstream ofs(temporary.string()); | ||
| ofs << "2"; | ||
| }; | ||
|
|
||
| BOOST_AUTO_TEST_SUITE(TestServer) | ||
|
|
||
| BOOST_AUTO_TEST_CASE(test_checkpt_store_successful_case0) { | ||
| trace_test(); | ||
|
|
||
| // Case 0: neither current and backup exist | ||
|
|
||
| TestFile current("current_%%%%-%%%%-%%%%"); // Important: no actual file is created | ||
| TestFile backup("backup_%%%%-%%%%-%%%%"); // Important: no actual file is created | ||
|
|
||
| CheckPtSaver::storeWithBackup(current.path(), backup.path(), handle_store); | ||
|
|
||
| BOOST_CHECK_EQUAL(current.load(), "2"); | ||
| BOOST_CHECK(!fs::exists(backup.path())); | ||
| } | ||
|
|
||
| BOOST_AUTO_TEST_CASE(test_checkpt_store_successful_case1) { | ||
| trace_test(); | ||
|
|
||
| // Case 1: current and backup both exist and are non-empty | ||
|
|
||
| TestFile current("current_%%%%-%%%%-%%%%", "1"); | ||
| TestFile backup("backup_%%%%-%%%%-%%%%", "X"); | ||
|
|
||
| CheckPtSaver::storeWithBackup(current.path(), backup.path(), handle_store); | ||
|
|
||
| BOOST_CHECK_EQUAL(current.load(), "2"); | ||
| BOOST_CHECK_EQUAL(backup.load(), "1"); | ||
| } | ||
|
|
||
| BOOST_AUTO_TEST_CASE(test_checkpt_store_successful_case2) { | ||
| trace_test(); | ||
|
|
||
| // Case 2: current and backup both exist, and current is empty | ||
|
|
||
| TestFile current("current_%%%%-%%%%-%%%%", ""); // Important: file is created empty | ||
| TestFile backup("backup_%%%%-%%%%-%%%%", "X"); | ||
|
|
||
| CheckPtSaver::storeWithBackup(current.path(), backup.path(), handle_store); | ||
|
|
||
| BOOST_CHECK_EQUAL(current.load(), "2"); | ||
| BOOST_CHECK_EQUAL(backup.load(), "X"); | ||
| } | ||
|
|
||
| BOOST_AUTO_TEST_CASE(test_checkpt_store_successful_case3) { | ||
| trace_test(); | ||
|
|
||
| // Case 3: current exists, but no backup is available | ||
|
|
||
| TestFile current("current_%%%%-%%%%-%%%%", "1"); | ||
| TestFile backup("backup_%%%%-%%%%-%%%%"); // Important: no actual file is created | ||
|
|
||
| CheckPtSaver::storeWithBackup(current.path(), backup.path(), handle_store); | ||
|
|
||
| BOOST_CHECK_EQUAL(current.load(), "2"); | ||
| BOOST_CHECK_EQUAL(backup.load(), "1"); | ||
| } | ||
|
|
||
| BOOST_AUTO_TEST_SUITE_END() |