1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328 | // Copyright (C) 2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#include <config.h>
#include <alarm.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <dhcp/dhcp6.h>
#include <testutils/gtest_utils.h>
#include <gtest/gtest.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <sstream><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <unordered_set><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace isc;
using namespace isc::dhcp;
using namespace isc::perfmon;
using namespace boost::posix_time;
namespace {
// Verifies Alarm construction.
TEST(Alarm, validConstructors) {
AlarmPtr alarm;
auto start_time = PktEvent::now();
// Create valid v4 alarm, verify contents and label.
Duration low_water(milliseconds(50));
Duration high_water(milliseconds(250));
ASSERT_NO_THROW_LOG(alarm.reset(new Alarm(AF_INET, DHCPDISCOVER, DHCPOFFER,
"process_started", "process_completed",
SUBNET_ID_GLOBAL,
low_water, high_water)));
ASSERT_TRUE(alarm);
EXPECT_EQ(alarm->getFamily(), AF_INET);
EXPECT_EQ(alarm->getQueryType(), DHCPDISCOVER);
EXPECT_EQ(alarm->getResponseType(), DHCPOFFER);
EXPECT_EQ(alarm->getStartEventLabel(), "process_started");
EXPECT_EQ(alarm->getStopEventLabel(), "process_completed");
EXPECT_EQ(alarm->getSubnetId(), SUBNET_ID_GLOBAL);
EXPECT_EQ("DHCPDISCOVER-DHCPOFFER.process_started-process_completed.0", alarm->getLabel());
EXPECT_EQ(alarm->getSubnetId(), SUBNET_ID_GLOBAL);
EXPECT_EQ(alarm->getLowWater(), low_water);
EXPECT_EQ(alarm->getHighWater(), high_water);
EXPECT_EQ(alarm->getState(), Alarm::CLEAR);
EXPECT_GE(alarm->getStosTime(), start_time);
start_time = PktEvent::now();
// Create valid v6 key and use that to create an alarm. Verify contents and label.
DurationKeyPtr key;
ASSERT_NO_THROW_LOG(key.reset(new DurationKey(AF_INET6, DHCPV6_SOLICIT, DHCPV6_ADVERTISE,
"mt_queued", "process_started", 77)));
ASSERT_NO_THROW_LOG(alarm.reset(new Alarm(*key, low_water, high_water, false)));
ASSERT_TRUE(alarm);
EXPECT_EQ(alarm->getFamily(), AF_INET6);
EXPECT_EQ(alarm->getQueryType(), DHCPV6_SOLICIT);
EXPECT_EQ(alarm->getResponseType(), DHCPV6_ADVERTISE);
EXPECT_EQ(alarm->getStartEventLabel(), "mt_queued");
EXPECT_EQ(alarm->getStopEventLabel(), "process_started");
EXPECT_EQ(alarm->getSubnetId(), 77);
EXPECT_EQ("SOLICIT-ADVERTISE.mt_queued-process_started.77", alarm->getLabel());
EXPECT_EQ(alarm->getLowWater(), low_water);
EXPECT_EQ(alarm->getHighWater(), high_water);
EXPECT_EQ(alarm->getState(), Alarm::DISABLED);
EXPECT_GE(alarm->getStosTime(), start_time);
}
// Verifies Alarm invalid construction.
TEST(Alarm, invalidConstructors) {<--- syntax error
AlarmPtr alarm;
// Make sure we catch an invalid message pairing.
Duration low_water(milliseconds(50));
Duration high_water(milliseconds(250));
ASSERT_THROW_MSG(alarm.reset(new Alarm(AF_INET, DHCPDISCOVER, DHCPDISCOVER,
"process_started", "process_completed",
SUBNET_ID_GLOBAL, low_water, high_water)),
BadValue,
"Response type: DHCPDISCOVER not valid for query type: DHCPDISCOVER");
// Low water too high, should throw.
ASSERT_THROW_MSG(alarm.reset(new Alarm(AF_INET, DHCPDISCOVER, DHCPOFFER,
"process_started", "process_completed",
SUBNET_ID_GLOBAL, high_water, low_water)),
BadValue,
"low water: 00:00:00.250000, must be less than high water:"
" 00:00:00.050000");
// Create valid v6 key.
DurationKeyPtr key;
ASSERT_NO_THROW_LOG(key.reset(new DurationKey(AF_INET6, DHCPV6_SOLICIT, DHCPV6_ADVERTISE,
"mt_queued", "process_started", 77)));
// Low water too high, should throw.
ASSERT_THROW_MSG(alarm.reset(new Alarm(*key, high_water, low_water)),
BadValue,
"low water: 00:00:00.250000, must be less than high water:"
" 00:00:00.050000");
}
TEST(Alarm, lowWaterHighWaterSetters) {
// Create valid v4 alarm.
Duration low_water(milliseconds(50));
Duration high_water(milliseconds(250));
AlarmPtr alarm;
ASSERT_NO_THROW_LOG(alarm.reset(new Alarm(AF_INET, DHCPDISCOVER, DHCPOFFER,
"process_started", "process_completed",
SUBNET_ID_GLOBAL,
low_water, high_water)));
// Should be able to set thresholds to new, valid values.
low_water += milliseconds(50);
high_water -= milliseconds(100);
ASSERT_NO_THROW(alarm->setLowWater(low_water));
EXPECT_EQ(alarm->getLowWater(), low_water);
ASSERT_NO_THROW(alarm->setHighWater(high_water));
EXPECT_EQ(alarm->getHighWater(), high_water);
// Setting low too high should fail and leave Alarm intact.
ASSERT_THROW_MSG(alarm->setLowWater(high_water), BadValue,
"low water: 00:00:00.150000, must be less than high water: 00:00:00.150000");
EXPECT_EQ(alarm->getLowWater(), low_water);
// Setting high too low should fail and leave Alarm intact.
ASSERT_THROW_MSG(alarm->setHighWater(low_water), BadValue,
"high water: 00:00:00.100000, must be greater than low water: 00:00:00.100000");
EXPECT_EQ(alarm->getHighWater(), high_water);
}
TEST(Alarm, clearAndDisable) {
auto start_time = PktEvent::now();
AlarmPtr alarm;
ASSERT_NO_THROW_LOG(alarm.reset(new Alarm(AF_INET, DHCPDISCOVER, DHCPOFFER,
"process_started", "process_completed",
SUBNET_ID_GLOBAL, milliseconds(100), milliseconds(200))));
// Initial state should be CLEAR, stos_time_ should be close to now, no report time.
EXPECT_EQ(alarm->getState(), Alarm::CLEAR);
EXPECT_GE(alarm->getStosTime(), start_time);
EXPECT_EQ(alarm->getLastHighWaterReport(), PktEvent::EMPTY_TIME());
// Save stos then nap.
auto prev_time = alarm->getStosTime();
usleep(100);
// Change the state to DISABLED. Should have a later stos_time_.
ASSERT_NO_THROW(alarm->disable());
EXPECT_EQ(alarm->getState(), Alarm::DISABLED);
EXPECT_GE(alarm->getStosTime(), prev_time);
EXPECT_EQ(alarm->getLastHighWaterReport(), PktEvent::EMPTY_TIME());
// While we're disabled verify operations that are not allowed.
ASSERT_THROW_MSG(alarm->checkSample(milliseconds(75), seconds(60)), InvalidOperation,
"Alarm::checkSample() - should not be called when alarm is DISABLED");
// Save stos then nap.
prev_time = alarm->getStosTime();
usleep(100);
// Restore the alarm to CLEAR.
ASSERT_NO_THROW(alarm->clear());
EXPECT_EQ(alarm->getState(), Alarm::CLEAR);
EXPECT_GE(alarm->getStosTime(), prev_time);
EXPECT_EQ(alarm->getLastHighWaterReport(), PktEvent::EMPTY_TIME());
}
// Verifies the result of Alarm::checkSample() over the range of scenarios.
// The alarm is created in either the CLEAR or TRIGGERED state and then checkSample()
// is invoked. The scenarios tested are described by the table below:
//
// ```
// INPUT | OUTPUT
// Test sample relationship Input Report Int.|
// to the thresholds State Elapsed | Report State Stos Last Report
// -------------------------------------------------|----------------------------------
// sample < low_water C false | false C - -
// sample < low_water C true | false C - -
// sample < low_water T false | true C updated reset
// sample < low_water T true | true C updated reset
// |
// sample == low_water C false | false C - -
// sample == low_water C true | false C - -
// sample == low_water T false | false T - -
// sample == low_water T true | true T updated
// |
// low_water < sample < high_water C false | false C - -
// low_water < sample < high_water C true | false C - -
// low_water < sample < high_water T false | false T - -
// low_water < sample < high_water T true | true T - updated
// |
// sample == high water C false | false C - -
// sample == high water C true | false C - -
// sample == high water T false | false T - -
// sample == high water T true | true T - updated
// |
// sample > high water C false | true T updated set
// sample > high water C true | true T updated set
// sample > high water T false | false T - -
// sample > high water T true | true T - updated
// ```
TEST(Alarm, checkSample) {
// Create mnemonic constants.
Duration low_water(milliseconds(100));
Duration high_water(milliseconds(200));
Duration lt_low_water(milliseconds(50));
Duration eq_low_water = low_water;
Duration mid_range(milliseconds(150));
Duration eq_high_water = high_water;
Duration gt_high_water(milliseconds(250));
Duration report_interval(milliseconds(25));
bool report_elapsed = true;
bool should_report = true;
// Enumerates possible outcomes for last_high_water_report.
enum TimeChange {
none, // no change
set, // from empty time to time
updated, // updated to a more recent time
reset // reset to empty time
};
// Embodies a test scenario based on the table in the commentary. It does not
// include a column for stos_time_ changes as they are easily inferred.
struct Scenario {
Duration sample_; // duration to test the alarm with
Alarm::State input_state_; // Starting state of the Alarm (CLEAR or TRIGGERED)
bool report_interval_elapsed_; // True if report interval has elapsed
bool should_report_; // True if checkSample() should return true
Alarm::State output_state_; // Alarm state after calling checkSample()
TimeChange last_report_chg_; // Expected change to last_high_water_report_
};
// Scenarios as described in the commentary.
std::list<Scenario> scenarios = {
{ lt_low_water, Alarm::CLEAR, !report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ lt_low_water, Alarm::CLEAR, report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ lt_low_water, Alarm::TRIGGERED, !report_elapsed, should_report, Alarm::CLEAR, TimeChange::reset },
{ lt_low_water, Alarm::TRIGGERED, report_elapsed, should_report, Alarm::CLEAR, TimeChange::reset },
{ eq_low_water, Alarm::CLEAR, !report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ eq_low_water, Alarm::CLEAR, report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ eq_low_water, Alarm::TRIGGERED, !report_elapsed, !should_report, Alarm::TRIGGERED, TimeChange::none },
{ eq_low_water, Alarm::TRIGGERED, report_elapsed, should_report, Alarm::TRIGGERED, TimeChange::updated },
{ mid_range, Alarm::CLEAR, !report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ mid_range, Alarm::CLEAR, report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ mid_range, Alarm::TRIGGERED, !report_elapsed, !should_report, Alarm::TRIGGERED, TimeChange::none },
{ mid_range, Alarm::TRIGGERED, report_elapsed, should_report, Alarm::TRIGGERED, TimeChange::updated },
{ eq_high_water, Alarm::CLEAR, !report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ eq_high_water, Alarm::CLEAR, report_elapsed, !should_report, Alarm::CLEAR, TimeChange::none },
{ eq_high_water, Alarm::TRIGGERED, !report_elapsed, !should_report, Alarm::TRIGGERED, TimeChange::none },
{ eq_high_water, Alarm::TRIGGERED, report_elapsed, should_report, Alarm::TRIGGERED, TimeChange::updated },
{ gt_high_water, Alarm::CLEAR, !report_elapsed, should_report, Alarm::TRIGGERED, TimeChange::set },
{ gt_high_water, Alarm::CLEAR, report_elapsed, should_report, Alarm::TRIGGERED, TimeChange::set },
{ gt_high_water, Alarm::TRIGGERED, !report_elapsed, !should_report, Alarm::TRIGGERED, TimeChange::none },
{ gt_high_water, Alarm::TRIGGERED, report_elapsed, should_report, Alarm::TRIGGERED, TimeChange::updated },
};
AlarmPtr alarm;
DurationKey key(AF_INET, DHCPDISCOVER, DHCPOFFER,
"process_started", "process_completed", SUBNET_ID_GLOBAL);
size_t pass = 0;
for (auto const& scenario : scenarios) {
std::ostringstream oss;
oss << "scenario: " << pass++;
SCOPED_TRACE(oss.str());
auto start_time = PktEvent::now();
// Create an Alarm with the scenario starting characteristics.
ASSERT_NO_THROW_LOG(alarm.reset(new Alarm(key, low_water, high_water)));
if (scenario.input_state_ == Alarm::TRIGGERED) {
alarm->setState(Alarm::TRIGGERED);
alarm->setLastHighWaterReport(!scenario.report_interval_elapsed_ ?
PktEvent::now() : start_time - (report_interval * 2));
}
// Save the current timestamps.
auto prev_stos_time = alarm->getStosTime();
auto prev_report_time = alarm->getLastHighWaterReport();
// Take a little nap.
usleep(50);
// Invoke checkSample() with the scenario sample duration. It should not throw.
bool should_report;
ASSERT_NO_THROW_LOG(should_report = alarm->checkSample(scenario.sample_, report_interval));
// Verify that we returned the expected value for a reportable event (or not).
EXPECT_EQ(should_report, scenario.should_report_);
// Verify we ended up in the expected state.
ASSERT_EQ(alarm->getState(), scenario.output_state_);
// If the state changed, stos_time_ should have been updated.
if (scenario.input_state_ != scenario.output_state_) {
EXPECT_GT(alarm->getStosTime(), prev_stos_time);
} else {
EXPECT_EQ(alarm->getStosTime(), prev_stos_time);
}
// Verify the last_high_water_report_ outcome.
switch(scenario.last_report_chg_) {
case TimeChange::none:
EXPECT_EQ(alarm->getLastHighWaterReport(), prev_report_time);
break;
case TimeChange::set:
EXPECT_EQ(prev_report_time, PktEvent::EMPTY_TIME());
EXPECT_GE(alarm->getLastHighWaterReport(), alarm->getStosTime());
break;
case TimeChange::updated:
EXPECT_GT(alarm->getLastHighWaterReport(), prev_report_time);
break;
case TimeChange::reset:
EXPECT_EQ(alarm->getLastHighWaterReport(), PktEvent::EMPTY_TIME());
break;
}
}
}
} // end of anonymous namespace
|