Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Decreased the flakiness of guarddog tests running with real time system. #12659

Merged
merged 1 commit into from
Aug 14, 2020
Merged

Decreased the flakiness of guarddog tests running with real time system. #12659

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 60 additions & 64 deletions test/server/guarddog_impl_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#include "envoy/common/time.h"
#include "envoy/server/guarddog_config.h"
#include "envoy/server/watchdog.h"
#include "envoy/thread/thread.h"

#include "common/api/api_impl.h"
#include "common/common/macros.h"
Expand Down Expand Up @@ -183,7 +184,7 @@ class GuardDogAlmostDeadTest : public GuardDogDeathTest {};

INSTANTIATE_TEST_SUITE_P(
TimeSystemType, GuardDogAlmostDeadTest,
testing::ValuesIn({// TODO(#6464): TimeSystemType::Real -- fails in this suite 30/1000 times.
testing::ValuesIn({// TODO(#6465): TimeSystemType::Real -- fails in this suite 30/1000 times.
TimeSystemType::Simulated}));

TEST_P(GuardDogDeathTest, KillDeathTest) {
Expand Down Expand Up @@ -320,7 +321,7 @@ TEST_P(GuardDogMissTest, MissTest) {
}

TEST_P(GuardDogMissTest, MegaMissTest) {
// TODO(#6464): This test fails in real-time 1/1000 times, but passes in simulated time.
// TODO(#6465): This test fails in real-time 1/1000 times, but passes in simulated time.
if (GetParam() == TimeSystemType::Real) {
return;
}
Expand All @@ -345,7 +346,7 @@ TEST_P(GuardDogMissTest, MegaMissTest) {
}

TEST_P(GuardDogMissTest, MissCountTest) {
// TODO(#6464): This test fails in real-time 9/1000 times, but passes in simulated time.
// TODO(#6465): This test fails in real-time 9/1000 times, but passes in simulated time.
if (GetParam() == TimeSystemType::Real) {
return;
}
Expand Down Expand Up @@ -578,9 +579,9 @@ class GuardDogActionsTest : public GuardDogTestBase {
)EOF"};
}

void setupFirstDog(const NiceMock<Configuration::MockMain>& config) {
void setupFirstDog(const NiceMock<Configuration::MockMain>& config, Thread::ThreadId tid) {
initGuardDog(fake_stats_, config);
first_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
first_dog_ = guard_dog_->createWatchDog(tid, "test_thread");
guard_dog_->forceCheckForTest();
}

Expand All @@ -601,120 +602,124 @@ INSTANTIATE_TEST_SUITE_P(TimeSystemType, GuardDogActionsTest,
TEST_P(GuardDogActionsTest, MissShouldOnlyReportRelevantThreads) {
const NiceMock<Configuration::MockMain> config(100, DISABLE_MEGAMISS, DISABLE_KILL,
DISABLE_MULTIKILL, 0, getActionsConfig());
setupFirstDog(config);
second_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
time_system_->advanceTimeWait(std::chrono::milliseconds(99));
setupFirstDog(config, Thread::ThreadId(10));
second_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");
time_system_->advanceTimeWait(std::chrono::milliseconds(50));
second_dog_->touch();

time_system_->advanceTimeWait(std::chrono::milliseconds(2));
// This will reset the loop interval timer, and should help us
// synchronize with the guard dog.
guard_dog_->forceCheckForTest();

time_system_->advanceTimeWait(std::chrono::milliseconds(51));
guard_dog_->forceCheckForTest();

EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MISS : 10"));
}

TEST_P(GuardDogActionsTest, MissShouldBeAbleToReportMultipleThreads) {
const NiceMock<Configuration::MockMain> config(100, DISABLE_MEGAMISS, DISABLE_KILL,
DISABLE_MULTIKILL, 0, getActionsConfig());
initGuardDog(fake_stats_, config);
first_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
second_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
first_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(10), "test_thread");
second_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");

first_dog_->touch();
second_dog_->touch();
// This should ensure that when the next call to step() occurs, both of the
// dogs will be over last touch time threshold and be reported in the event.
// The next call to step() will either be triggered by the timer or after
// advanceTimeWait() below, but only one of them will append to events_
// because of saturation.
guard_dog_->forceCheckForTest();

time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MISS : ", api_->threadFactory().currentThreadId().debugString(), ",",
api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MISS : 10,11"));
}

TEST_P(GuardDogActionsTest, MissShouldSaturateOnMissEvent) {
const NiceMock<Configuration::MockMain> config(100, DISABLE_MISS, DISABLE_KILL, DISABLE_MULTIKILL,
0, getActionsConfig());
setupFirstDog(config);
setupFirstDog(config, Thread::ThreadId(10));

time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MISS : 10"));

// Should saturate and not add an additional "event_"
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MISS : 10"));

// Touch the watchdog, which should allow the event to trigger again.
first_dog_->touch();

time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(
events_,
ElementsAre(absl::StrCat("MISS : ", api_->threadFactory().currentThreadId().debugString()),
absl::StrCat("MISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MISS : 10", "MISS : 10"));
}

TEST_P(GuardDogActionsTest, MegaMissShouldOnlyReportRelevantThreads) {
const NiceMock<Configuration::MockMain> config(DISABLE_MISS, 100, DISABLE_KILL, DISABLE_MULTIKILL,
0, getActionsConfig());
setupFirstDog(config);
second_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
time_system_->advanceTimeWait(std::chrono::milliseconds(99));
setupFirstDog(config, Thread::ThreadId(10));
second_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");
time_system_->advanceTimeWait(std::chrono::milliseconds(50));
second_dog_->touch();

time_system_->advanceTimeWait(std::chrono::milliseconds(2));
// This will reset the loop interval timer, and should help us
// synchronize with the guard dog.
guard_dog_->forceCheckForTest();

time_system_->advanceTimeWait(std::chrono::milliseconds(51));
guard_dog_->forceCheckForTest();

EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MEGAMISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MEGAMISS : 10"));
}

TEST_P(GuardDogActionsTest, MegaMissShouldBeAbleToReportMultipleThreads) {
const NiceMock<Configuration::MockMain> config(DISABLE_MISS, 100, DISABLE_KILL, DISABLE_MULTIKILL,
0, getActionsConfig());
initGuardDog(fake_stats_, config);
first_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
second_dog_ = guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
first_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(10), "test_thread");
second_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");

first_dog_->touch();
second_dog_->touch();

// This should ensure that when the next call to step() occurs, both of the
// dogs will be over last touch time threshold and be reported in the event.
// The next call to step() will either be triggered by the timer or after
// advanceTimeWait() below, but only one of them will append to events_
// because of saturation.
guard_dog_->forceCheckForTest();
time_system_->advanceTimeWait(std::chrono::milliseconds(101));

guard_dog_->forceCheckForTest();
EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MEGAMISS : ", api_->threadFactory().currentThreadId().debugString(),
",", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MEGAMISS : 10,11"));
}

TEST_P(GuardDogActionsTest, MegaMissShouldSaturateOnMegaMissEvent) {
const NiceMock<Configuration::MockMain> config(DISABLE_MISS, 100, DISABLE_KILL, DISABLE_MULTIKILL,
0, getActionsConfig());
setupFirstDog(config);
setupFirstDog(config, Thread::ThreadId(10));

time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MEGAMISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MEGAMISS : 10"));

// Should saturate and not add an additional "event_"
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(events_, ElementsAre(absl::StrCat(
"MEGAMISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MEGAMISS : 10"));

// Touch the watchdog, which should allow the event to trigger again.
first_dog_->touch();

time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(
events_,
ElementsAre(
absl::StrCat("MEGAMISS : ", api_->threadFactory().currentThreadId().debugString()),
absl::StrCat("MEGAMISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MEGAMISS : 10", "MEGAMISS : 10"));
}

TEST_P(GuardDogActionsTest, ShouldRespectEventPriority) {
Expand All @@ -724,10 +729,8 @@ TEST_P(GuardDogActionsTest, ShouldRespectEventPriority) {
auto kill_function = [&]() -> void {
const NiceMock<Configuration::MockMain> config(100, 100, 100, 100, 0, getActionsConfig());
initGuardDog(fake_stats_, config);
auto first_dog =
guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
auto second_dog =
guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
auto first_dog = guard_dog_->createWatchDog(Thread::ThreadId(10), "test_thread");
auto second_dog = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
};
Expand All @@ -740,10 +743,8 @@ TEST_P(GuardDogActionsTest, ShouldRespectEventPriority) {
const NiceMock<Configuration::MockMain> config(100, 100, DISABLE_KILL, 100, 0,
getActionsConfig());
initGuardDog(fake_stats_, config);
auto first_dog =
guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
auto second_dog =
guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
auto first_dog = guard_dog_->createWatchDog(Thread::ThreadId(10), "test_thread");
auto second_dog = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
};
Expand All @@ -753,21 +754,17 @@ TEST_P(GuardDogActionsTest, ShouldRespectEventPriority) {
// We expect megamiss to fire before miss
const NiceMock<Configuration::MockMain> config(100, 100, DISABLE_KILL, DISABLE_MULTIKILL, 0,
getActionsConfig());
setupFirstDog(config);
setupFirstDog(config, Thread::ThreadId(10));
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
EXPECT_THAT(
events_,
ElementsAre(
absl::StrCat("MEGAMISS : ", api_->threadFactory().currentThreadId().debugString()),
absl::StrCat("MISS : ", api_->threadFactory().currentThreadId().debugString())));
EXPECT_THAT(events_, ElementsAre("MEGAMISS : 10", "MISS : 10"));
}

TEST_P(GuardDogActionsTest, KillShouldTriggerGuardDogActions) {
auto die_function = [&]() -> void {
const NiceMock<Configuration::MockMain> config(DISABLE_MISS, DISABLE_MEGAMISS, 100, 0, 0,
getActionsConfig());
setupFirstDog(config);
setupFirstDog(config, Thread::ThreadId(10));
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
};
Expand All @@ -779,9 +776,8 @@ TEST_P(GuardDogActionsTest, MultikillShouldTriggerGuardDogActions) {
auto die_function = [&]() -> void {
const NiceMock<Configuration::MockMain> config(DISABLE_MISS, DISABLE_MEGAMISS, DISABLE_KILL,
100, 0, getActionsConfig());
setupFirstDog(config);
second_dog_ =
guard_dog_->createWatchDog(api_->threadFactory().currentThreadId(), "test_thread");
setupFirstDog(config, Thread::ThreadId(10));
second_dog_ = guard_dog_->createWatchDog(Thread::ThreadId(11), "test_thread");
guard_dog_->forceCheckForTest();
time_system_->advanceTimeWait(std::chrono::milliseconds(101));
guard_dog_->forceCheckForTest();
Expand Down