13535848071

Committed 26 Feb 2025 03:22AM UTC coverage: 91.695% (-0.001%) from 91.696%

Build # 13535848071

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #4718 from randombit/jack/split-cpuid

Make cpuid module optional

Run Details

95832 of 104512 relevant lines covered (91.69%)

11266034.88 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.76

/src/tests/runner/test_runner.cpp

/*
* (C) 2017 Jack Lloyd
* (C) 2022 René Meusel, Rohde & Schwarz Cybersecurity
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include "../tests.h"

#include "test_runner.h"
#include "test_stdout_reporter.h"
#include "test_xml_reporter.h"

#include <botan/version.h>
#include <botan/internal/loadstor.h>

#if defined(BOTAN_HAS_CPUID)
   #include <botan/internal/cpuid.h>
#endif

#if defined(BOTAN_HAS_THREAD_UTILS)
   #include <botan/internal/rwlock.h>
   #include <botan/internal/thread_pool.h>
#endif

#include <shared_mutex>

namespace Botan_Tests {

Test_Runner::Test_Runner(std::ostream& out) : m_output(out) {}

Test_Runner::~Test_Runner() = default;

bool Test_Runner::run(const Test_Options& opts) {
   if(!opts.no_stdout()) {
      m_reporters.emplace_back(std::make_unique<StdoutReporter>(opts, output()));
   }
   if(!opts.xml_results_dir().empty()) {
#if defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
      m_reporters.emplace_back(std::make_unique<XmlReporter>(opts, opts.xml_results_dir()));
#else
      output() << "Generating test report files is not supported on this platform\n";
#endif
   }

   auto req = Botan_Tests::Test::filter_registered_tests(opts.requested_tests(), opts.skip_tests());

   // TODO: Test runner should not be aware of certain test's environmental requirements.
   if(opts.pkcs11_lib().empty()) {
      // do not run pkcs11 tests by default unless pkcs11-lib set
      for(auto iter = req.begin(); iter != req.end();) {
         if((*iter).find("pkcs11") != std::string::npos) {
            iter = req.erase(iter);
         } else {
            ++iter;
         }
      }
   }

   if(req.empty()) {
      throw Test_Error("No tests to run");
   }

   std::vector<uint8_t> seed = Botan::hex_decode(opts.drbg_seed());
   if(seed.empty()) {
      const uint64_t ts = Botan_Tests::Test::timestamp();
      seed.resize(8);
      Botan::store_be(ts, seed.data());
   }

   for(auto& reporter : m_reporters) {
#if defined(BOTAN_HAS_CPUID)
      const std::string cpuid = Botan::CPUID::to_string();
      if(!cpuid.empty()) {
         reporter->set_property("CPU flags", cpuid);
      }
#endif

      if(!opts.pkcs11_lib().empty()) {
         reporter->set_property("pkcs11 library", opts.pkcs11_lib());
      }

      if(!opts.provider().empty()) {
         reporter->set_property("provider", opts.provider());
      }

      reporter->set_property("drbg_seed", Botan::hex_encode(seed));
   }

   Botan_Tests::Test::set_test_options(opts);

   for(size_t i = 0; i != opts.test_runs(); ++i) {
      Botan_Tests::Test::set_test_rng_seed(seed, i);

      for(const auto& reporter : m_reporters) {
         reporter->next_test_run();
      }

      const bool passed =
         (opts.test_threads() == 1) ? run_tests(req) : run_tests_multithreaded(req, opts.test_threads());

      for(const auto& reporter : m_reporters) {
         reporter->render();
      }

      if(!passed) {
         return false;
      }
   }

   return true;
}

namespace {

std::vector<Test::Result> run_a_test(const std::string& test_name) {
   std::vector<Test::Result> results;

   try {
#if defined(BOTAN_HAS_CPUID)
      if(test_name == "simd_32" && Botan::CPUID::has_simd_32() == false) {
         results.push_back(Test::Result::Note(test_name, "SIMD not available on this platform"));
         return results;
      }
#endif

      if(std::unique_ptr<Test> test = Test::get_test(test_name)) {
         std::vector<Test::Result> test_results = test->run();
         for(auto& result : test_results) {
            if(!result.code_location() && test->registration_location()) {
               // If a test result has no specific code location associated to it,
               // we fall back to the test case's registration location.
               result.set_code_location(test->registration_location().value());
            }
         }
         results.insert(results.end(), test_results.begin(), test_results.end());
      } else {
         results.push_back(Test::Result::Note(test_name, "Test missing or unavailable"));
      }
   } catch(std::exception& e) {
      results.push_back(Test::Result::Failure(test_name, e.what()));
   } catch(...) {
      results.push_back(Test::Result::Failure(test_name, "unknown exception"));
   }

   return results;
}

bool all_passed(const std::vector<Test::Result>& results) {
   return std::all_of(results.begin(), results.end(), [](const auto& r) { return r.tests_failed() == 0; });
}

}  // namespace

bool Test_Runner::run_tests_multithreaded(const std::vector<std::string>& tests_to_run, size_t test_threads) {
   // If 0 then we let thread pool select the count
   BOTAN_ASSERT_NOMSG(test_threads != 1);

#if !defined(BOTAN_HAS_THREAD_UTILS)
   output() << "Running tests in multiple threads not enabled in this build\n";
   return run_tests(tests_to_run);

#else
   Botan::Thread_Pool pool(test_threads);
   Botan::RWLock rwlock;

   std::vector<std::future<std::vector<Test::Result>>> m_fut_results;

   auto run_test_exclusive = [&](const std::string& test_name) {
      std::unique_lock lk(rwlock);
      return run_a_test(test_name);
   };

   auto run_test_shared = [&](const std::string& test_name) {
      std::shared_lock lk(rwlock);
      return run_a_test(test_name);
   };

   for(const auto& test_name : tests_to_run) {
      if(Test::test_needs_serialization(test_name)) {
         m_fut_results.push_back(pool.run(run_test_exclusive, test_name));
      } else {
         m_fut_results.push_back(pool.run(run_test_shared, test_name));
      }
   }

   bool passed = true;
   for(size_t i = 0; i != m_fut_results.size(); ++i) {
      const auto results = m_fut_results[i].get();
      for(auto& reporter : m_reporters) {
         reporter->record(tests_to_run[i], results);
      }
      passed &= all_passed(results);
   }

   pool.shutdown();

   return passed;
#endif
}

bool Test_Runner::run_tests(const std::vector<std::string>& tests_to_run) {
   bool passed = true;
   for(const auto& test_name : tests_to_run) {
      const auto results = run_a_test(test_name);

      for(auto& reporter : m_reporters) {
         reporter->record(test_name, results);
      }
      passed &= all_passed(results);
   }

   return passed;
}

}  // namespace Botan_Tests

1	/*
2	* (C) 2017 Jack Lloyd
3	* (C) 2022 René Meusel, Rohde & Schwarz Cybersecurity
4	*
5	* Botan is released under the Simplified BSD License (see license.txt)
6	*/
7
8	#include "../tests.h"
9
10	#include "test_runner.h"
11	#include "test_stdout_reporter.h"
12	#include "test_xml_reporter.h"
13
14	#include <botan/version.h>
15	#include <botan/internal/loadstor.h>
16
17	#if defined(BOTAN_HAS_CPUID)
18	#include <botan/internal/cpuid.h>
19	#endif
20
21	#if defined(BOTAN_HAS_THREAD_UTILS)
22	#include <botan/internal/rwlock.h>
23	#include <botan/internal/thread_pool.h>
24	#endif
25
26	#include <shared_mutex>
27
28	namespace Botan_Tests {
29
30	Test_Runner::Test_Runner(std::ostream& out) : m_output(out) {}	1✔
31
32	Test_Runner::~Test_Runner() = default;	1✔
33
34	bool Test_Runner::run(const Test_Options& opts) {	1✔
35	if(!opts.no_stdout()) {	1✔
36	m_reporters.emplace_back(std::make_unique<StdoutReporter>(opts, output()));	2✔
37	}
38	if(!opts.xml_results_dir().empty()) {	1✔
39	#if defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
40	m_reporters.emplace_back(std::make_unique<XmlReporter>(opts, opts.xml_results_dir()));	2✔
41	#else
42	output() << "Generating test report files is not supported on this platform\n";
43	#endif
44	}
45
46	auto req = Botan_Tests::Test::filter_registered_tests(opts.requested_tests(), opts.skip_tests());	1✔
47
48	// TODO: Test runner should not be aware of certain test's environmental requirements.
49	if(opts.pkcs11_lib().empty()) {	1✔
50	// do not run pkcs11 tests by default unless pkcs11-lib set
51	for(auto iter = req.begin(); iter != req.end();) {	×
52	if((*iter).find("pkcs11") != std::string::npos) {	×
53	iter = req.erase(iter);	×
54	} else {
55	++iter;	×
56	}
57	}
58	}
59
60	if(req.empty()) {	1✔
61	throw Test_Error("No tests to run");	×
62	}
63
64	std::vector<uint8_t> seed = Botan::hex_decode(opts.drbg_seed());	1✔
65	if(seed.empty()) {	1✔
66	const uint64_t ts = Botan_Tests::Test::timestamp();	1✔
67	seed.resize(8);	1✔
68	Botan::store_be(ts, seed.data());	1✔
69	}
70
71	for(auto& reporter : m_reporters) {	3✔
72	#if defined(BOTAN_HAS_CPUID)
73	const std::string cpuid = Botan::CPUID::to_string();	2✔
74	if(!cpuid.empty()) {	2✔
75	reporter->set_property("CPU flags", cpuid);	4✔
76	}
77	#endif
78
79	if(!opts.pkcs11_lib().empty()) {	2✔
80	reporter->set_property("pkcs11 library", opts.pkcs11_lib());	4✔
81	}
82
83	if(!opts.provider().empty()) {	2✔
84	reporter->set_property("provider", opts.provider());	×
85	}
86
87	reporter->set_property("drbg_seed", Botan::hex_encode(seed));	4✔
88	}	2✔
89
90	Botan_Tests::Test::set_test_options(opts);	1✔
91
92	for(size_t i = 0; i != opts.test_runs(); ++i) {	2✔
93	Botan_Tests::Test::set_test_rng_seed(seed, i);	1✔
94
95	for(const auto& reporter : m_reporters) {	3✔
96	reporter->next_test_run();	2✔
97	}
98
99	const bool passed =	1✔
100	(opts.test_threads() == 1) ? run_tests(req) : run_tests_multithreaded(req, opts.test_threads());	1✔
101
102	for(const auto& reporter : m_reporters) {	3✔
103	reporter->render();	2✔
104	}
105
106	if(!passed) {	1✔
107	return false;
108	}
109	}
110
111	return true;
112	}	1✔
113
114	namespace {
115
116	std::vector<Test::Result> run_a_test(const std::string& test_name) {	400✔
117	std::vector<Test::Result> results;	400✔
118
119	try {	400✔
120	#if defined(BOTAN_HAS_CPUID)
121	if(test_name == "simd_32" && Botan::CPUID::has_simd_32() == false) {	401✔
122	results.push_back(Test::Result::Note(test_name, "SIMD not available on this platform"));	×
123	return results;	×
124	}
125	#endif
126
127	if(std::unique_ptr<Test> test = Test::get_test(test_name)) {	400✔
128	std::vector<Test::Result> test_results = test->run();	400✔
129	for(auto& result : test_results) {	50,301✔
130	if(!result.code_location() && test->registration_location()) {	49,901✔
131	// If a test result has no specific code location associated to it,
132	// we fall back to the test case's registration location.
133	result.set_code_location(test->registration_location().value());	49,901✔
134	}
135	}
136	results.insert(results.end(), test_results.begin(), test_results.end());	400✔
137	} else {	400✔
138	results.push_back(Test::Result::Note(test_name, "Test missing or unavailable"));	×
139	}	400✔
140	} catch(std::exception& e) {	×
141	results.push_back(Test::Result::Failure(test_name, e.what()));	×
142	} catch(...) {	×
143	results.push_back(Test::Result::Failure(test_name, "unknown exception"));	×
144	}	×
145
146	return results;
147	}	×
148
149	bool all_passed(const std::vector<Test::Result>& results) {	400✔
150	return std::all_of(results.begin(), results.end(), [](const auto& r) { return r.tests_failed() == 0; });	12,866✔
151	}
152
153	} // namespace
154
155	bool Test_Runner::run_tests_multithreaded(const std::vector<std::string>& tests_to_run, size_t test_threads) {	1✔
156	// If 0 then we let thread pool select the count
157	BOTAN_ASSERT_NOMSG(test_threads != 1);	1✔
158
159	#if !defined(BOTAN_HAS_THREAD_UTILS)
160	output() << "Running tests in multiple threads not enabled in this build\n";
161	return run_tests(tests_to_run);
162
163	#else
164	Botan::Thread_Pool pool(test_threads);	1✔
165	Botan::RWLock rwlock;	1✔
166
167	std::vector<std::future<std::vector<Test::Result>>> m_fut_results;	1✔
168
169	auto run_test_exclusive = [&](const std::string& test_name) {	22✔
170	std::unique_lock lk(rwlock);	21✔
171	return run_a_test(test_name);	21✔
172	};	21✔
173
174	auto run_test_shared = [&](const std::string& test_name) {	380✔
175	std::shared_lock lk(rwlock);	379✔
176	return run_a_test(test_name);	379✔
177	};	379✔
178
179	for(const auto& test_name : tests_to_run) {	401✔
180	if(Test::test_needs_serialization(test_name)) {	400✔
181	m_fut_results.push_back(pool.run(run_test_exclusive, test_name));	42✔
182	} else {
183	m_fut_results.push_back(pool.run(run_test_shared, test_name));	758✔
184	}
185	}
186
187	bool passed = true;
188	for(size_t i = 0; i != m_fut_results.size(); ++i) {	401✔
189	const auto results = m_fut_results[i].get();	400✔
190	for(auto& reporter : m_reporters) {	1,200✔
191	reporter->record(tests_to_run[i], results);	800✔
192	}
193	passed &= all_passed(results);	400✔
194	}	400✔
195
196	pool.shutdown();	1✔
197
198	return passed;	1✔
199	#endif
200	}	2✔
201
202	bool Test_Runner::run_tests(const std::vector<std::string>& tests_to_run) {	×
203	bool passed = true;	×
204	for(const auto& test_name : tests_to_run) {	×
205	const auto results = run_a_test(test_name);	×
206
207	for(auto& reporter : m_reporters) {	×
208	reporter->record(test_name, results);	×
209	}
210	passed &= all_passed(results);	×
211	}	×
212
213	return passed;	×
214	}
215
216	} // namespace Botan_Tests

randombit / botan / 13535848071

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous