test: Pin and document TEST_DIR_PATH_ELEMENT

This commit is contained in:
MarcoFalke 2024-08-29 10:00:45 +02:00
parent 2222f7a874
commit fa84f9decd
No known key found for this signature in database
2 changed files with 8 additions and 9 deletions

View file

@ -63,7 +63,7 @@ build/src/test/test_bitcoin --run_test=getarg_tests/doubledash
``` ```
`test_bitcoin` creates a temporary working (data) directory with a randomly `test_bitcoin` creates a temporary working (data) directory with a randomly
generated pathname within `test_common_Bitcoin Core/`, which in turn is within generated pathname within `test_common bitcoin/`, which in turn is within
the system's temporary directory (see the system's temporary directory (see
[`temp_directory_path`](https://en.cppreference.com/w/cpp/filesystem/temp_directory_path)). [`temp_directory_path`](https://en.cppreference.com/w/cpp/filesystem/temp_directory_path)).
This data directory looks like a simplified form of the standard `bitcoind` data This data directory looks like a simplified form of the standard `bitcoind` data
@ -73,7 +73,7 @@ have a `debug.log` file, for example.
The location of the temporary data directory can be specified with the The location of the temporary data directory can be specified with the
`-testdatadir` option. This can make debugging easier. The directory `-testdatadir` option. This can make debugging easier. The directory
path used is the argument path appended with path used is the argument path appended with
`/test_common_Bitcoin Core/<test-name>/datadir`. `/test_common bitcoin/<test-name>/datadir`.
The directory path is created if necessary. The directory path is created if necessary.
Specifying this argument also causes the data directory Specifying this argument also causes the data directory
not to be removed after the last test. This is useful for looking at not to be removed after the last test. This is useful for looking at
@ -83,11 +83,11 @@ so no leftover state is used.)
```bash ```bash
$ build/src/test/test_bitcoin --run_test=getarg_tests/doubledash -- -testdatadir=/somewhere/mydatadir $ build/src/test/test_bitcoin --run_test=getarg_tests/doubledash -- -testdatadir=/somewhere/mydatadir
Test directory (will not be deleted): "/somewhere/mydatadir/test_common_Bitcoin Core/getarg_tests/doubledash/datadir" Test directory (will not be deleted): "/somewhere/mydatadir/test_common bitcoin/getarg_tests/doubledash/datadir"
Running 1 test case... Running 1 test case...
*** No errors detected *** No errors detected
$ ls -l '/somewhere/mydatadir/test_common_Bitcoin Core/getarg_tests/doubledash/datadir' $ ls -l '/somewhere/mydatadir/test_common bitcoin/getarg_tests/doubledash/datadir'
total 8 total 8
drwxrwxr-x 2 admin admin 4096 Nov 27 22:45 blocks drwxrwxr-x 2 admin admin 4096 Nov 27 22:45 blocks
-rw-rw-r-- 1 admin admin 1003 Nov 27 22:45 debug.log -rw-rw-r-- 1 admin admin 1003 Nov 27 22:45 debug.log

View file

@ -2,8 +2,6 @@
// Distributed under the MIT software license, see the accompanying // Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php. // file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <config/bitcoin-config.h> // IWYU pragma: keep
#include <test/util/setup_common.h> #include <test/util/setup_common.h>
#include <addrman.h> #include <addrman.h>
@ -75,6 +73,7 @@ using node::VerifyLoadedChainstate;
const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr; const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr;
constexpr inline auto TEST_DIR_PATH_ELEMENT{"test_common bitcoin"}; // Includes a space to catch possible path escape issues.
/** Random context to get unique temp data dirs. Separate from m_rng, which can be seeded from a const env var */ /** Random context to get unique temp data dirs. Separate from m_rng, which can be seeded from a const env var */
static FastRandomContext g_rng_temp_path; static FastRandomContext g_rng_temp_path;
@ -108,7 +107,7 @@ static NetworkSetup g_networksetup_instance;
/** Register test-only arguments */ /** Register test-only arguments */
static void SetupUnitTestArgs(ArgsManager& argsman) static void SetupUnitTestArgs(ArgsManager& argsman)
{ {
argsman.AddArg("-testdatadir", strprintf("Custom data directory (default: %s<random_string>)", fs::PathToString(fs::temp_directory_path() / "test_common_" PACKAGE_NAME / "")), argsman.AddArg("-testdatadir", strprintf("Custom data directory (default: %s<random_string>)", fs::PathToString(fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / "")),
ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST); ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
} }
@ -159,7 +158,7 @@ BasicTestingSetup::BasicTestingSetup(const ChainType chainType, TestOpts opts)
if (!m_node.args->IsArgSet("-testdatadir")) { if (!m_node.args->IsArgSet("-testdatadir")) {
// By default, the data directory has a random name // By default, the data directory has a random name
const auto rand_str{g_rng_temp_path.rand256().ToString()}; const auto rand_str{g_rng_temp_path.rand256().ToString()};
m_path_root = fs::temp_directory_path() / "test_common_" PACKAGE_NAME / rand_str; m_path_root = fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / rand_str;
TryCreateDirectories(m_path_root); TryCreateDirectories(m_path_root);
} else { } else {
// Custom data directory // Custom data directory
@ -169,7 +168,7 @@ BasicTestingSetup::BasicTestingSetup(const ChainType chainType, TestOpts opts)
root_dir = fs::absolute(root_dir); root_dir = fs::absolute(root_dir);
const std::string test_path{G_TEST_GET_FULL_NAME ? G_TEST_GET_FULL_NAME() : ""}; const std::string test_path{G_TEST_GET_FULL_NAME ? G_TEST_GET_FULL_NAME() : ""};
m_path_lock = root_dir / "test_common_" PACKAGE_NAME / fs::PathFromString(test_path); m_path_lock = root_dir / TEST_DIR_PATH_ELEMENT / fs::PathFromString(test_path);
m_path_root = m_path_lock / "datadir"; m_path_root = m_path_lock / "datadir";
// Try to obtain the lock; if unsuccessful don't disturb the existing test. // Try to obtain the lock; if unsuccessful don't disturb the existing test.