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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
#include "OmptAliases.h"
#include "OmptAsserter.h"
#include <omp-tools.h>
#include <sstream>
#include "gtest/gtest.h"
using namespace omptest;
using OAE = omptest::OmptAssertEvent;
using OS = omptest::ObserveState;
/// SequencedAsserter test-fixture class to avoid code duplication among tests.
class OmptSequencedAsserterTest : public testing::Test {
protected:
OmptSequencedAsserterTest() {
// Construct default sequenced asserter
SeqAsserter = std::make_unique<omptest::OmptSequencedAsserter>();
// Silence all potential log prints
SeqAsserter->getLog()->setLoggingLevel(logging::Level::Critical);
}
std::unique_ptr<omptest::OmptSequencedAsserter> SeqAsserter;
};
TEST_F(OmptSequencedAsserterTest, DefaultState) {
// Assertion should neither start as 'deactivated' nor 'suspended'
ASSERT_EQ(SeqAsserter->isActive(), true);
ASSERT_EQ(SeqAsserter->AssertionSuspended, false);
// Assertion should begin with event ID zero
ASSERT_EQ(SeqAsserter->NextEvent, 0);
// Assertion should begin without previous notifications or assertions
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
// There should be no expected events
ASSERT_EQ(SeqAsserter->Events.empty(), true);
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 0);
// Default mode should be Strict
ASSERT_NE(SeqAsserter->getOperationMode(), AssertMode::Relaxed);
ASSERT_EQ(SeqAsserter->getOperationMode(), AssertMode::Strict);
// Default state should be passing
ASSERT_NE(SeqAsserter->getState(), AssertState::Fail);
ASSERT_EQ(SeqAsserter->getState(), AssertState::Pass);
ASSERT_NE(SeqAsserter->checkState(), AssertState::Fail);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, IgnoreNotificationsWhenEmpty) {
// ParallelBegin events are suppressed by default
auto SuppressedEvent = OAE::ParallelBegin(
/*Name=*/"ParBegin", /*Group=*/"", /*Expected=*/OS::Always,
/*NumThreads=*/3);
// DeviceFinalize events are not ignored by default
auto IgnoredEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
// Situation: There is nothing to assert.
// Result: All notifications are ignored.
// Hence, check that the perceived count of notifications remains unchanged
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
SeqAsserter->notify(std::move(SuppressedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
SeqAsserter->notify(std::move(IgnoredEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, IgnoreNotificationsWhileDeactivated) {
auto ExpectedEvent = OAE::DeviceUnload(
/*Name=*/"DevUnload", /*Group=*/"", /*Expected=*/OS::Always);
SeqAsserter->insert(std::move(ExpectedEvent));
ASSERT_EQ(SeqAsserter->Events.empty(), false);
// Deactivate asserter, effectively ignoring notifications
SeqAsserter->setActive(false);
ASSERT_EQ(SeqAsserter->isActive(), false);
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
// DeviceFinalize events are not ignored by default
auto IgnoredEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->notify(std::move(IgnoredEvent));
// Assertion was deactivated: No change
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
SeqAsserter->setActive(true);
ASSERT_EQ(SeqAsserter->isActive(), true);
auto ObservedEvent = OAE::DeviceUnload(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always);
SeqAsserter->notify(std::move(ObservedEvent));
// Assertion was activated, one notification expected
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 1);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, AddEvent) {
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 0);
auto ExpectedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->insert(std::move(ExpectedEvent));
// Sanity check: Notifications should not be triggered
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
// Adding an expected event must change the event count but not the state
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 1);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->getState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, AddEventIgnoreSuppressed) {
auto ExpectedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->insert(std::move(ExpectedEvent));
// ParallelBegin events are suppressed by default
auto SuppressedEvent = OAE::ParallelBegin(
/*Name=*/"ParBegin", /*Group=*/"", /*Expected=*/OS::Always,
/*NumThreads=*/3);
// Situation: There is one expected event and ParallelBegins are suppressed.
// Notification count remains unchanged for suppressed events
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
SeqAsserter->notify(std::move(SuppressedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->getState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, AddEventObservePass) {
auto ExpectedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->insert(std::move(ExpectedEvent));
// DeviceFinalize events are not ignored by default
auto ObservedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->notify(std::move(ObservedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 1);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, AddEventObserveFail) {
auto ExpectedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->insert(std::move(ExpectedEvent));
// DeviceFinalize events are not ignored by default
// Provide wrong DeviceNum
auto ObservedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/23);
SeqAsserter->notify(std::move(ObservedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
// Observed and expected event do not match: Fail
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Fail);
}
TEST_F(OmptSequencedAsserterTest, AddEventObserveDifferentType) {
auto ExpectedEvent = OAE::DeviceUnload(
/*Name=*/"DevUnload", /*Group=*/"", /*Expected=*/OS::Always);
SeqAsserter->insert(std::move(ExpectedEvent));
// DeviceFinalize events are not ignored by default
auto ObservedEvent = OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7);
SeqAsserter->notify(std::move(ObservedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
// Observed and expected event do not match: Fail
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Fail);
}
TEST_F(OmptSequencedAsserterTest, CheckTargetGroupNoEffect) {
// Situation: Groups are designed to be used as an indicator -WITHIN- target
// regions. Hence, comparing two target regions w.r.t. their groups has no
// effect on pass or fail.
auto ExpectedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN,
/*DeviceNum=*/7, /*TaskData=*/nullptr, /*TargetId=*/23,
/*CodeptrRA=*/nullptr);
SeqAsserter->insert(std::move(ExpectedEvent));
ASSERT_EQ(SeqAsserter->Events.empty(), false);
// Deactivate asserter, effectively ignoring notifications
SeqAsserter->setActive(false);
ASSERT_EQ(SeqAsserter->isActive(), false);
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
// Target events are not ignored by default
auto ObservedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN, /*DeviceNum=*/7,
/*TaskData=*/nullptr, /*TargetId=*/23, /*CodeptrRA=*/nullptr);
SeqAsserter->notify(std::move(ObservedEvent));
// Assertion was deactivated: No change
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 1);
// Re-activate asserter
SeqAsserter->setActive(true);
ASSERT_EQ(SeqAsserter->isActive(), true);
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
// Actually observe a target event from "AnotherGroup"
auto AnotherObservedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"AnotherGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN, /*DeviceNum=*/7,
/*TaskData=*/nullptr, /*TargetId=*/23, /*CodeptrRA=*/nullptr);
SeqAsserter->notify(std::move(AnotherObservedEvent));
// Observed all expected events; groups of target regions do not affect pass
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 1);
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 0);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
}
TEST_F(OmptSequencedAsserterTest, CheckSyncPoint) {
auto ExpectedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN,
/*DeviceNum=*/7, /*TaskData=*/nullptr, /*TargetId=*/23,
/*CodeptrRA=*/nullptr);
SeqAsserter->insert(std::move(ExpectedEvent));
ASSERT_EQ(SeqAsserter->Events.empty(), false);
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 1);
// Target events are not ignored by default
auto ObservedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN, /*DeviceNum=*/7,
/*TaskData=*/nullptr, /*TargetId=*/23, /*CodeptrRA=*/nullptr);
SeqAsserter->notify(std::move(ObservedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
SeqAsserter->notify(OAE::AssertionSyncPoint(
/*Name=*/"", /*Group=*/"", /*Expected=*/OS::Always,
/*SyncPointName=*/"SyncPoint 1"));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 2);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 1);
// All events processed: SyncPoint "passes"
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
auto AnotherExpectedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN,
/*DeviceNum=*/7, /*TaskData=*/nullptr, /*TargetId=*/23,
/*CodeptrRA=*/nullptr);
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 0);
SeqAsserter->insert(std::move(AnotherExpectedEvent));
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 1);
// Remaining events present: SyncPoint "fails"
SeqAsserter->notify(OAE::AssertionSyncPoint(
/*Name=*/"", /*Group=*/"", /*Expected=*/OS::Always,
/*SyncPointName=*/"SyncPoint 2"));
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Fail);
}
TEST_F(OmptSequencedAsserterTest, CheckExcessNotify) {
auto ExpectedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN,
/*DeviceNum=*/7, /*TaskData=*/nullptr, /*TargetId=*/23,
/*CodeptrRA=*/nullptr);
SeqAsserter->insert(std::move(ExpectedEvent));
ASSERT_EQ(SeqAsserter->Events.empty(), false);
ASSERT_EQ(SeqAsserter->getRemainingEventCount(), 1);
// Target events are not ignored by default
auto ObservedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN, /*DeviceNum=*/7,
/*TaskData=*/nullptr, /*TargetId=*/23, /*CodeptrRA=*/nullptr);
SeqAsserter->notify(std::move(ObservedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
// All events processed: pass
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
// Target events are not ignored by default
auto AnotherObservedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN, /*DeviceNum=*/7,
/*TaskData=*/nullptr, /*TargetId=*/23, /*CodeptrRA=*/nullptr);
// No more events expected: notify "fails"
SeqAsserter->notify(std::move(AnotherObservedEvent));
ASSERT_EQ(SeqAsserter->getNotificationCount(), 2);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Fail);
}
TEST_F(OmptSequencedAsserterTest, CheckSuspend) {
SeqAsserter->insert(OAE::AssertionSuspend(
/*Name=*/"", /*Group=*/"", /*Expected=*/OS::Never));
ASSERT_EQ(SeqAsserter->Events.empty(), false);
// Being notified while the next expected event is a "suspend" should change
// the asserter's state
ASSERT_EQ(SeqAsserter->getNotificationCount(), 0);
ASSERT_EQ(SeqAsserter->AssertionSuspended, false);
SeqAsserter->notify(OAE::DeviceFinalize(
/*Name=*/"DevFini", /*Group=*/"", /*Expected=*/OS::Always,
/*DeviceNum=*/7));
ASSERT_EQ(SeqAsserter->AssertionSuspended, true);
ASSERT_EQ(SeqAsserter->getNotificationCount(), 1);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 0);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
auto ExpectedEvent = OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN,
/*DeviceNum=*/7, /*TaskData=*/nullptr, /*TargetId=*/23,
/*CodeptrRA=*/nullptr);
SeqAsserter->insert(std::move(ExpectedEvent));
// Being notified with an observed event, which matches the next expected
// event, resumes assertion (suspended = false)
ASSERT_EQ(SeqAsserter->AssertionSuspended, true);
SeqAsserter->notify(OAE::Target(
/*Name=*/"Target", /*Group=*/"MyTargetGroup", /*Expected=*/OS::Always,
/*Kind=*/TARGET, /*Endpoint=*/BEGIN,
/*DeviceNum=*/7, /*TaskData=*/nullptr, /*TargetId=*/23,
/*CodeptrRA=*/nullptr));
ASSERT_EQ(SeqAsserter->AssertionSuspended, false);
ASSERT_EQ(SeqAsserter->getNotificationCount(), 2);
ASSERT_EQ(SeqAsserter->getSuccessfulAssertionCount(), 1);
ASSERT_EQ(SeqAsserter->checkState(), AssertState::Pass);
}
|
