-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tidy: split TestRunner to cc (#8500)
Description: - Exclude `modernize-use-trailing-return-type` which is against style guide and noisy even as warning. - Split test_runner to cc and h, anonymous namespace in header results clang-tidy complains non-used function. Risk Level: Low (test only) Testing: CI Docs Changes: N/A Release Notes: N/A Signed-off-by: Lizan Zhou <[email protected]>
- Loading branch information
Showing
4 changed files
with
129 additions
and
118 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| #include "test/test_runner.h" | ||
|
|
||
| #include <regex> | ||
|
|
||
| #include "common/common/logger.h" | ||
| #include "common/common/logger_delegates.h" | ||
| #include "common/common/thread.h" | ||
| #include "common/event/libevent.h" | ||
| #include "common/http/http2/codec_impl.h" | ||
| #include "common/runtime/runtime_features.h" | ||
|
|
||
| #include "exe/process_wide.h" | ||
|
|
||
| #include "test/common/runtime/utility.h" | ||
| #include "test/mocks/access_log/mocks.h" | ||
| #include "test/test_common/environment.h" | ||
| #include "test/test_listener.h" | ||
|
|
||
| #include "gmock/gmock.h" | ||
|
|
||
| namespace Envoy { | ||
|
|
||
| namespace { | ||
|
|
||
| std::string findAndRemove(const std::regex& pattern, int& argc, char**& argv) { | ||
| std::smatch matched; | ||
| std::string return_value; | ||
| for (int i = 0; i < argc; ++i) { | ||
| if (return_value.empty()) { | ||
| std::string argument = std::string(argv[i]); | ||
| if (regex_search(argument, matched, pattern)) { | ||
| return_value = matched[1]; | ||
| argc--; | ||
| } | ||
| } | ||
| if (!return_value.empty() && i < argc) { | ||
| argv[i] = argv[i + 1]; | ||
| } | ||
| } | ||
| return return_value; | ||
| } | ||
|
|
||
| // This class is created iff a test is run with the special runtime override flag. | ||
| class RuntimeManagingListener : public ::testing::EmptyTestEventListener { | ||
| public: | ||
| RuntimeManagingListener(std::string& runtime_override) : runtime_override_(runtime_override) {} | ||
|
|
||
| // On each test start, edit RuntimeFeaturesDefaults with our custom runtime defaults. | ||
| void OnTestStart(const ::testing::TestInfo&) override { | ||
| if (!runtime_override_.empty()) { | ||
| if (!Runtime::RuntimeFeaturesPeer::addFeature(runtime_override_)) { | ||
| // If the entry was already in the hash map, don't remove it OnTestEnd. | ||
| runtime_override_.clear(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // As each test ends, clean up the RuntimeFeaturesDefaults state. | ||
| void OnTestEnd(const ::testing::TestInfo&) override { | ||
| if (!runtime_override_.empty()) { | ||
| Runtime::RuntimeFeaturesPeer::removeFeature(runtime_override_); | ||
| } | ||
| } | ||
| std::string runtime_override_; | ||
| }; | ||
|
|
||
| } // namespace | ||
|
|
||
| int TestRunner::RunTests(int argc, char** argv) { | ||
| ::testing::InitGoogleMock(&argc, argv); | ||
| // We hold on to process_wide to provide RAII cleanup of process-wide | ||
| // state. | ||
| ProcessWide process_wide; | ||
| // Add a test-listener so we can call a hook where we can do a quiescence | ||
| // check after each method. See | ||
| // https://github.com/google/googletest/blob/master/googletest/docs/advanced.md | ||
| // for details. | ||
| ::testing::TestEventListeners& listeners = ::testing::UnitTest::GetInstance()->listeners(); | ||
| listeners.Append(new TestListener); | ||
|
|
||
| // Use the recommended, but not default, "threadsafe" style for the Death Tests. | ||
| // See: https://github.com/google/googletest/commit/84ec2e0365d791e4ebc7ec249f09078fb5ab6caa | ||
| ::testing::FLAGS_gtest_death_test_style = "threadsafe"; | ||
|
|
||
| // Set gtest properties | ||
| // (https://github.com/google/googletest/blob/master/googletest/docs/advanced.md#logging-additional-information), | ||
| // they are available in the test XML. | ||
| // TODO(htuch): Log these as well? | ||
| testing::Test::RecordProperty("TemporaryDirectory", TestEnvironment::temporaryDirectory()); | ||
| testing::Test::RecordProperty("RunfilesDirectory", TestEnvironment::runfilesDirectory()); | ||
|
|
||
| TestEnvironment::setEnvVar("TEST_UDSDIR", TestEnvironment::unixDomainSocketDirectory(), 1); | ||
|
|
||
| // Before letting TestEnvironment latch argv and argc, remove any runtime override flag. | ||
| // This allows doing test overrides of Envoy runtime features without adding | ||
| // test flags to the Envoy production command line. | ||
| const std::regex PATTERN{"--runtime-feature-override-for-tests=(.*)", std::regex::optimize}; | ||
| std::string runtime_override = findAndRemove(PATTERN, argc, argv); | ||
| if (!runtime_override.empty()) { | ||
| ENVOY_LOG_TO_LOGGER(Logger::Registry::getLog(Logger::Id::testing), info, | ||
| "Running with runtime feature override {}", runtime_override); | ||
| // Set up a listener which will create a global runtime and set the feature | ||
| // to true for the duration of each test instance. | ||
| ::testing::TestEventListeners& listeners = ::testing::UnitTest::GetInstance()->listeners(); | ||
| listeners.Append(new RuntimeManagingListener(runtime_override)); | ||
| } | ||
|
|
||
| TestEnvironment::initializeOptions(argc, argv); | ||
| Thread::MutexBasicLockable lock; | ||
| Logger::Context logging_state(TestEnvironment::getOptions().logLevel(), | ||
| TestEnvironment::getOptions().logFormat(), lock); | ||
|
|
||
| // Allocate fake log access manager. | ||
| testing::NiceMock<AccessLog::MockAccessLogManager> access_log_manager; | ||
| std::unique_ptr<Logger::FileSinkDelegate> file_logger; | ||
|
|
||
| // Redirect all logs to fake file when --log-path arg is specified in command line. | ||
| if (!TestEnvironment::getOptions().logPath().empty()) { | ||
| file_logger = std::make_unique<Logger::FileSinkDelegate>( | ||
| TestEnvironment::getOptions().logPath(), access_log_manager, Logger::Registry::getSink()); | ||
| } | ||
| return RUN_ALL_TESTS(); | ||
| } | ||
|
|
||
| } // namespace Envoy |
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 |
|---|---|---|
| @@ -1,126 +1,10 @@ | ||
| #pragma once | ||
|
|
||
| #include <regex> | ||
|
|
||
| #include "common/common/logger.h" | ||
| #include "common/common/logger_delegates.h" | ||
| #include "common/common/thread.h" | ||
| #include "common/event/libevent.h" | ||
| #include "common/http/http2/codec_impl.h" | ||
| #include "common/runtime/runtime_features.h" | ||
|
|
||
| #include "exe/process_wide.h" | ||
|
|
||
| #include "test/common/runtime/utility.h" | ||
| #include "test/mocks/access_log/mocks.h" | ||
| #include "test/test_common/environment.h" | ||
| #include "test/test_listener.h" | ||
|
|
||
| #include "gmock/gmock.h" | ||
|
|
||
| namespace Envoy { | ||
| namespace { | ||
|
|
||
| std::string findAndRemove(const std::regex& pattern, int& argc, char**& argv) { | ||
| std::smatch matched; | ||
| std::string return_value; | ||
| for (int i = 0; i < argc; ++i) { | ||
| if (return_value.empty()) { | ||
| std::string argument = std::string(argv[i]); | ||
| if (regex_search(argument, matched, pattern)) { | ||
| return_value = matched[1]; | ||
| argc--; | ||
| } | ||
| } | ||
| if (!return_value.empty() && i < argc) { | ||
| argv[i] = argv[i + 1]; | ||
| } | ||
| } | ||
| return return_value; | ||
| } | ||
|
|
||
| // This class is created iff a test is run with the special runtime override flag. | ||
| class RuntimeManagingListener : public ::testing::EmptyTestEventListener { | ||
| public: | ||
| RuntimeManagingListener(std::string& runtime_override) : runtime_override_(runtime_override) {} | ||
|
|
||
| // On each test start, edit RuntimeFeaturesDefaults with our custom runtime defaults. | ||
| void OnTestStart(const ::testing::TestInfo&) override { | ||
| if (!runtime_override_.empty()) { | ||
| if (!Runtime::RuntimeFeaturesPeer::addFeature(runtime_override_)) { | ||
| // If the entry was already in the hash map, don't remove it OnTestEnd. | ||
| runtime_override_.clear(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // As each test ends, clean up the RuntimeFeaturesDefaults state. | ||
| void OnTestEnd(const ::testing::TestInfo&) override { | ||
| if (!runtime_override_.empty()) { | ||
| Runtime::RuntimeFeaturesPeer::removeFeature(runtime_override_); | ||
| } | ||
| } | ||
| std::string runtime_override_; | ||
| }; | ||
|
|
||
| } // namespace | ||
|
|
||
| class TestRunner { | ||
| public: | ||
| static int RunTests(int argc, char** argv) { | ||
| ::testing::InitGoogleMock(&argc, argv); | ||
| // We hold on to process_wide to provide RAII cleanup of process-wide | ||
| // state. | ||
| ProcessWide process_wide; | ||
| // Add a test-listener so we can call a hook where we can do a quiescence | ||
| // check after each method. See | ||
| // https://github.com/google/googletest/blob/master/googletest/docs/advanced.md | ||
| // for details. | ||
| ::testing::TestEventListeners& listeners = ::testing::UnitTest::GetInstance()->listeners(); | ||
| listeners.Append(new TestListener); | ||
|
|
||
| // Use the recommended, but not default, "threadsafe" style for the Death Tests. | ||
| // See: https://github.com/google/googletest/commit/84ec2e0365d791e4ebc7ec249f09078fb5ab6caa | ||
| ::testing::FLAGS_gtest_death_test_style = "threadsafe"; | ||
|
|
||
| // Set gtest properties | ||
| // (https://github.com/google/googletest/blob/master/googletest/docs/advanced.md#logging-additional-information), | ||
| // they are available in the test XML. | ||
| // TODO(htuch): Log these as well? | ||
| testing::Test::RecordProperty("TemporaryDirectory", TestEnvironment::temporaryDirectory()); | ||
| testing::Test::RecordProperty("RunfilesDirectory", TestEnvironment::runfilesDirectory()); | ||
|
|
||
| TestEnvironment::setEnvVar("TEST_UDSDIR", TestEnvironment::unixDomainSocketDirectory(), 1); | ||
|
|
||
| // Before letting TestEnvironment latch argv and argc, remove any runtime override flag. | ||
| // This allows doing test overrides of Envoy runtime features without adding | ||
| // test flags to the Envoy production command line. | ||
| const std::regex PATTERN{"--runtime-feature-override-for-tests=(.*)", std::regex::optimize}; | ||
| std::string runtime_override = findAndRemove(PATTERN, argc, argv); | ||
| if (!runtime_override.empty()) { | ||
| ENVOY_LOG_TO_LOGGER(Logger::Registry::getLog(Logger::Id::testing), info, | ||
| "Running with runtime feature override {}", runtime_override); | ||
| // Set up a listener which will create a global runtime and set the feature | ||
| // to true for the duration of each test instance. | ||
| ::testing::TestEventListeners& listeners = ::testing::UnitTest::GetInstance()->listeners(); | ||
| listeners.Append(new RuntimeManagingListener(runtime_override)); | ||
| } | ||
|
|
||
| TestEnvironment::initializeOptions(argc, argv); | ||
| Thread::MutexBasicLockable lock; | ||
| Logger::Context logging_state(TestEnvironment::getOptions().logLevel(), | ||
| TestEnvironment::getOptions().logFormat(), lock); | ||
|
|
||
| // Allocate fake log access manager. | ||
| testing::NiceMock<AccessLog::MockAccessLogManager> access_log_manager; | ||
| std::unique_ptr<Logger::FileSinkDelegate> file_logger; | ||
|
|
||
| // Redirect all logs to fake file when --log-path arg is specified in command line. | ||
| if (!TestEnvironment::getOptions().logPath().empty()) { | ||
| file_logger = std::make_unique<Logger::FileSinkDelegate>( | ||
| TestEnvironment::getOptions().logPath(), access_log_manager, Logger::Registry::getSink()); | ||
| } | ||
| return RUN_ALL_TESTS(); | ||
| } | ||
| static int RunTests(int argc, char** argv); | ||
| }; | ||
|
|
||
| } // namespace Envoy |