diff options
| author | Leitwolf11 | 2026-11-06 02:55:57 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-11-06 02:55:57 +0300 |
| commit | ad3633ea59ec491c9694a10307beb7d7189db744 (patch) | |
| tree | 99c4d53afb06eb1f2479392bdf56d9bc95621166 | |
| parent | 89b4769c35986444a0297ad0806a584c7181c85c (diff) | |
| download | catch3-ad3633ea59ec491c9694a10307beb7d7189db744.tar.gz | |
Compare Windows variable names in UTF-8 and end an empty block twicefix/child-environment
EnvironmentBlock replaced every non-ASCII character of an inherited name
with '?' before asking whether to withhold it, so --pass-env=MY_?_TOKEN
kept an unrelated MY_é_TOKEN. Names are now converted with Narrow, as
everything else the runner compares.
A block whose variables were all withheld, with no additions, ended in one
terminator; CreateProcessW needs two for an empty block.
The amalgamated sources are regenerated for the runner changes.
| -rw-r--r-- | extras/catch_amalgamated.cpp | 108 | ||||
| -rw-r--r-- | src/Progmasoft/Runner/Process.cpp | 15 |
2 files changed, 113 insertions, 10 deletions
diff --git a/extras/catch_amalgamated.cpp b/extras/catch_amalgamated.cpp index 5be0c78b..737af11a 100644 --- a/extras/catch_amalgamated.cpp +++ b/extras/catch_amalgamated.cpp @@ -1081,6 +1081,8 @@ namespace Progmasoft::Catch3::Runner unsigned jobs = 0; bool inProcess = false; bool isolate = false; + /// Variables the tests keep although their names look like secrets. + std::vector<std::string> passedEnvironment; /// The per-test limit; zero disables it. std::chrono::milliseconds timeout{0}; bool timeoutGiven = false; @@ -1628,6 +1630,9 @@ namespace Progmasoft::Catch3::Runner std::vector<std::string> arguments; /// Variables added to, or replacing, those of this process. std::vector<std::pair<std::string, std::string>> environment; + /// Variables of this process the child keeps although their names + /// look like secrets; see `IsSecretVariable`. + std::vector<std::string> keptEnvironment; /// The working directory; empty keeps the current one. std::filesystem::path workingDirectory; bool searchPath = false; @@ -1737,6 +1742,12 @@ namespace Progmasoft::Catch3::Runner [[nodiscard]] unsigned HardwareThreads() noexcept; + /// Whether a variable of this name holds a secret that a child does not + /// inherit: its name contains, in any case, TOKEN, SECRET, PASSWORD, + /// PASSWD, CREDENTIAL, API_KEY, APIKEY, PRIVATE_KEY or ACCESS_KEY. + [[nodiscard]] bool + IsSecretVariable(std::string_view name); + /// The value of an environment variable; empty when it is not set. [[nodiscard]] std::string ReadEnvironment(const char *name); @@ -13388,6 +13399,17 @@ namespace Progmasoft::Catch3::Runner options.isolate = true; return Status::Ok(); }}, + {"pass-env", + '\0', + Takes::kValue, + "NAME", + "Running", + "give the tests the variable NAME, which they do not get " + "because its name looks like a secret (repeatable)", + [](Options &options, const std::optional<std::string> &value) { + options.passedEnvironment.push_back(*value); + return Status::Ok(); + }}, {"timeout", '\0', Takes::kValue, @@ -14862,9 +14884,12 @@ namespace Progmasoft::Catch3::Runner // Copyright (c) 2026 Progmasoft. // SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-2.0 #include <algorithm> +#include <cctype> #include <cstdio> #include <cstdlib> #include <cstring> +#include <iterator> +#include <string_view> #include <thread> @@ -14899,8 +14924,64 @@ extern char **environ; namespace Progmasoft::Catch3::Runner { + bool + IsSecretVariable(std::string_view name) + { + std::string upper; + upper.reserve(name.size()); + for (const char character : name) + { + upper.push_back(character >= 'a' && character <= 'z' + ? static_cast<char>(character - 'a' + 'A') + : character); + } + constexpr std::string_view kSecretWords[] = { + "TOKEN", "SECRET", "PASSWORD", "PASSWD", "CREDENTIAL", + "API_KEY", "APIKEY", "PRIVATE_KEY", "ACCESS_KEY", + }; + return std::any_of(std::begin(kSecretWords), + std::end(kSecretWords), + [&](std::string_view word) { + return upper.find(word) != std::string::npos; + }); + } + namespace { + /// Whether a variable of this process stays out of a child: a secret + /// that the options do not keep. Windows spells names in any case. + bool + Withheld(std::string_view name, const std::vector<std::string> &kept) + { + if (!IsSecretVariable(name)) + { + return false; + } + return std::none_of( + kept.begin(), + kept.end(), + [&](const std::string &keptName) { + if (keptName.size() != name.size()) + { + return false; + } +#if defined(_WIN32) + return std::equal( + keptName.begin(), + keptName.end(), + name.begin(), + [](char left, char right) { + return std::toupper( + static_cast<unsigned char>(left)) + == std::toupper( + static_cast<unsigned char>(right)); + }); +#else + return keptName == name; +#endif + }); + } + #if defined(_WIN32) HANDLE AsHandle(std::intptr_t value) noexcept @@ -15035,7 +15116,8 @@ namespace Progmasoft::Catch3::Runner std::wstring EnvironmentBlock( - const std::vector<std::pair<std::string, std::string>> &additions) + const std::vector<std::pair<std::string, std::string>> &additions, + const std::vector<std::string> &kept) { std::vector<std::wstring> entries; wchar_t *current = GetEnvironmentStringsW(); @@ -15044,6 +15126,13 @@ namespace Progmasoft::Catch3::Runner for (const wchar_t *entry = current; *entry != L'\0'; entry += wcslen(entry) + 1) { + // A leading '=' marks the hidden per-drive variables. + const std::wstring_view text{ entry }; + const auto equals = text.find(L'=', 1); + if (Withheld(Narrow(text.substr(0, equals)), kept)) + { + continue; + } entries.emplace_back(entry); } FreeEnvironmentStringsW(current); @@ -15075,6 +15164,12 @@ namespace Progmasoft::Catch3::Runner block += entry; block.push_back(L'\0'); } + // A block ends in an empty entry; one without variables is two + // terminators. + if (entries.empty()) + { + block.push_back(L'\0'); + } block.push_back(L'\0'); return block; } @@ -15494,7 +15589,8 @@ namespace Progmasoft::Catch3::Runner } AppendQuotedArgument(commandLine, Widen(options.arguments[index])); } - std::wstring environment = EnvironmentBlock(options.environment); + std::wstring environment + = EnvironmentBlock(options.environment, options.keptEnvironment); const std::wstring directory = options.workingDirectory.wstring(); PROCESS_INFORMATION information{}; @@ -15817,6 +15913,12 @@ namespace Progmasoft::Catch3::Runner entry != nullptr && *entry != nullptr; ++entry) { + const std::string_view text{ *entry }; + if (Withheld(text.substr(0, text.find('=')), + options.keptEnvironment)) + { + continue; + } environmentStorage.emplace_back(*entry); } for (const auto &[name, value] : options.environment) @@ -16224,6 +16326,7 @@ namespace Progmasoft::Catch3::Runner { "jobs", ValueKind::kCount }, { "in-process", ValueKind::kFlag }, { "isolate", ValueKind::kFlag }, + { "pass-env", ValueKind::kWords }, { "timeout", ValueKind::kNumber }, { "adaptive-timeout", ValueKind::kNegated, @@ -20604,6 +20707,7 @@ namespace Progmasoft::Catch3::Runner const std::size_t id = ++workersStarted_; child.environment.emplace_back("CATCH3_WORKER", std::to_string(id)); + child.keptEnvironment = options_.passedEnvironment; auto process = ChildProcess::Start(child); if (!process) { diff --git a/src/Progmasoft/Runner/Process.cpp b/src/Progmasoft/Runner/Process.cpp index b9463e94..85987210 100644 --- a/src/Progmasoft/Runner/Process.cpp +++ b/src/Progmasoft/Runner/Process.cpp @@ -247,14 +247,7 @@ namespace Progmasoft::Catch3::Runner // A leading '=' marks the hidden per-drive variables. const std::wstring_view text{ entry }; const auto equals = text.find(L'=', 1); - std::string name; - for (const wchar_t character : text.substr(0, equals)) - { - name.push_back(character < 0x80 - ? static_cast<char>(character) - : '?'); - } - if (Withheld(name, kept)) + if (Withheld(Narrow(text.substr(0, equals)), kept)) { continue; } @@ -289,6 +282,12 @@ namespace Progmasoft::Catch3::Runner block += entry; block.push_back(L'\0'); } + // A block ends in an empty entry; one without variables is two + // terminators. + if (entries.empty()) + { + block.push_back(L'\0'); + } block.push_back(L'\0'); return block; } |