GCC Code Coverage Report

Directory: ./
File: modules/util/include/util.hpp
Date: 2026-06-04 20:25:32
Exec Total Coverage
Lines: 40 40 100.0%
Functions: 864 872 99.1%
Branches: 44 75 58.7%
Line Branch Exec Source
1 #pragma once
2
3 #include <algorithm>
4 #include <array>
5 #include <atomic>
6 #include <cctype>
7 #include <cstdint>
8 #include <cstdlib>
9 #include <filesystem>
10 #include <memory>
11 #include <sstream>
12 #include <string>
13 #include <string_view>
14 #include <system_error>
15 #include <typeinfo>
16 #ifdef __GNUG__
17 # include <cxxabi.h>
18 #endif
19
20 #include "nlohmann/json_fwd.hpp"
21
22 #ifdef _MSC_VER
23 # pragma warning(push)
24 # pragma warning(disable : 4459)
25 #endif
26
27 #include <gtest/gtest.h>
28
29 #include <libenvpp/detail/environment.hpp>
30 #include <libenvpp/detail/get.hpp>
31 #include <nlohmann/json.hpp>
32
33 /// @brief JSON namespace used for settings and config parsing.
34 using NlohmannJsonParseError = nlohmann::json::parse_error;
35 /// @brief JSON namespace used for settings and config typing.
36 using NlohmannJsonTypeError = nlohmann::json::type_error;
37 #ifdef _MSC_VER
38 # pragma warning(pop)
39 #endif
40
41 namespace ppc::util {
42
43 /// @brief Utility class for tracking destructor failure across tests.
44 /// @details Provides thread-safe methods to set, unset, and check the failure flag.
45 class DestructorFailureFlag {
46 public:
47 /// @brief Marks that a destructor failure has occurred.
48 static void Set() {
49 failure_flag.store(true);
50 30 }
51
52 /// @brief Clears the destructor failure flag.
53 static void Unset() {
54 failure_flag.store(false);
55 }
56
57 /// @brief Checks if a destructor failure was recorded.
58 /// @return True if failure occurred, false otherwise.
59 static bool Get() {
60 return failure_flag.load();
61 }
62
63 private:
64 inline static std::atomic<bool> failure_flag{false};
65 };
66
67 enum class GTestParamIndex : uint8_t {
68 kTaskGetter,
69 kNameTest,
70 kTestParams,
71 };
72
73 std::string GetAbsoluteTaskPath(const std::string &id_path, const std::string &relative_path);
74 int GetNumThreads();
75 int GetNumProc();
76 double GetTaskMaxTime();
77 double GetPerfMaxTime();
78 void SynchronizeMpiRanks();
79
80 template <typename T>
81
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 192660 times.
 381790 std::string GetNamespace() {
82 381790 std::string name = typeid(T).name();
83 #ifdef __GNUC__
84
1/2
✓ Branch 1 taken 192680 times.
✗ Branch 2 not taken.
 381790 int status = 0;
85
1/2
✓ Branch 1 taken 192680 times.
✗ Branch 2 not taken.
 381790 std::unique_ptr<char, void (*)(void *)> demangled{abi::__cxa_demangle(name.c_str(), nullptr, nullptr, &status),
86 std::free};
87
4/8
✓ Branch 0 taken 192680 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 192680 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 192660 times.
✓ Branch 7 taken 20 times.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
 763580 name = (status == 0) ? demangled.get() : name;
88 #endif
89 #ifdef _MSC_VER
90 const std::string prefixes[] = {"class ", "struct ", "enum ", "union "};
91 for (const auto &prefix : prefixes) {
92 if (name.starts_with(prefix)) {
93 name = name.substr(prefix.size());
94 break;
95 }
96 }
97 name.erase(0, name.find_first_not_of(' '));
98 #endif
99 auto pos = name.rfind("::");
100
3/4
✓ Branch 0 taken 192660 times.
✓ Branch 1 taken 20 times.
✓ Branch 3 taken 192660 times.
✗ Branch 4 not taken.
 763580 return (pos != std::string::npos) ? name.substr(0, pos) : std::string{};
101 }
102
103 inline std::shared_ptr<nlohmann::json> InitJSONPtr() {
104
2/3
✓ Branch 1 taken 192640 times.
✓ Branch 2 taken 200 times.
✗ Branch 3 not taken.
 192900 return std::make_shared<nlohmann::json>();
105 }
106
107 bool IsUnderMpirun();
108
109 namespace test {
110
111 36104 [[nodiscard]] inline std::string SanitizeToken(std::string_view token_sv) {
112 36104 std::string token{token_sv};
113 4521660 auto is_allowed = [](char c) {
114
6/6
✓ Branch 0 taken 440026 times.
✓ Branch 1 taken 4081634 times.
✓ Branch 2 taken 331714 times.
✓ Branch 3 taken 108312 times.
✓ Branch 4 taken 36104 times.
✓ Branch 5 taken 72208 times.
 4521660 return std::isalnum(static_cast<unsigned char>(c)) || c == '_' || c == '-' || c == '.';
115 };
116 std::ranges::replace(token, ' ', '_');
117
2/2
✓ Branch 0 taken 4521660 times.
✓ Branch 1 taken 36104 times.
 4557764 for (char &ch : token) {
118
2/2
✓ Branch 0 taken 72208 times.
✓ Branch 1 taken 4449452 times.
 4521660 if (!is_allowed(ch)) {
119 72208 ch = '_';
120 }
121 }
122 36104 return token;
123 }
124
125 36104 class ScopedPerTestEnv {
126 public:
127 36104 explicit ScopedPerTestEnv(const std::string &token)
128
2/4
✓ Branch 2 taken 36104 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 36104 times.
✗ Branch 6 not taken.
 36104 : set_uid_("PPC_TEST_UID", token), set_tmp_("PPC_TEST_TMPDIR", CreateTmpDir(token)) {}
129
130 private:
131 36104 static std::string CreateTmpDir(const std::string &token) {
132 namespace fs = std::filesystem;
133 2820 auto make_rank_suffix = []() -> std::string {
134 // Derive rank from common MPI env vars without including MPI headers
135 2820 constexpr std::array<std::string_view, 5> kRankVars = {"OMPI_COMM_WORLD_RANK", "PMI_RANK", "PMIX_RANK",
136 "SLURM_PROCID", "MSMPI_RANK"};
137
1/2
✓ Branch 0 taken 2820 times.
✗ Branch 1 not taken.
 2820 for (auto name : kRankVars) {
138
2/4
✓ Branch 1 taken 2820 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2820 times.
✗ Branch 4 not taken.
 2820 if (auto r = env::get<int>(name); r.has_value() && r.value() >= 0) {
139
3/8
✓ Branch 2 taken 2820 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 2820 times.
✗ Branch 6 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 2820 times.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
 5640 return std::string("_rank_") + std::to_string(r.value());
140 }
141 }
142 return std::string{};
143 };
144
2/2
✓ Branch 1 taken 2820 times.
✓ Branch 2 taken 33284 times.
 36104 const std::string rank_suffix = IsUnderMpirun() ? make_rank_suffix() : std::string{};
145
5/10
✓ Branch 1 taken 36104 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 36104 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 36104 times.
✗ Branch 8 not taken.
✓ Branch 10 taken 36104 times.
✗ Branch 11 not taken.
✓ Branch 15 taken 36104 times.
✗ Branch 16 not taken.
 108312 const fs::path tmp = fs::temp_directory_path() / (std::string("ppc_test_") + token + rank_suffix);
146 std::error_code ec;
147
1/2
✓ Branch 1 taken 36104 times.
✗ Branch 2 not taken.
 36104 fs::create_directories(tmp, ec);
148 (void)ec;
149 36104 return tmp.string();
150 36104 }
151
152 env::detail::set_scoped_environment_variable set_uid_;
153 env::detail::set_scoped_environment_variable set_tmp_;
154 };
155
156 36104 [[nodiscard]] inline std::string MakeCurrentGTestToken(std::string_view fallback_name) {
157 36104 const auto *unit = ::testing::UnitTest::GetInstance();
158
1/2
✓ Branch 0 taken 36104 times.
✗ Branch 1 not taken.
 36104 const auto *info = (unit != nullptr) ? unit->current_test_info() : nullptr;
159 36104 std::ostringstream os;
160
1/2
✓ Branch 0 taken 36104 times.
✗ Branch 1 not taken.
 36104 if (info != nullptr) {
161
2/4
✓ Branch 1 taken 36104 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 36104 times.
✗ Branch 5 not taken.
 72208 os << info->test_suite_name() << "." << info->name();
162 } else {
163 os << fallback_name;
164 }
165
1/2
✓ Branch 1 taken 36104 times.
✗ Branch 2 not taken.
 72208 return SanitizeToken(os.str());
166 36104 }
167
168 36104 inline ScopedPerTestEnv MakePerTestEnvForCurrentGTest(std::string_view fallback_name) {
169
1/2
✓ Branch 2 taken 36104 times.
✗ Branch 3 not taken.
 72208 return ScopedPerTestEnv(MakeCurrentGTestToken(fallback_name));
170 }
171
172 } // namespace test
173
174 } // namespace ppc::util
175