Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::API::InterceptResult::Event.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::API::InterceptResult::Event 3pm"
61 .TH Test2::API::InterceptResult::Event 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::API::InterceptResult::Event \- Representation of an event for use in
68 testing other test tools.
69 .SH DESCRIPTION
70 .IX Header "DESCRIPTION"
71 \&\f(CW\*(C`intercept { ... }\*(C'\fR from Test2::API returns an instance of
72 Test2::API::InterceptResult which is a blessed arrayref of
73 Test2::API::InterceptResult::Event objects.
74 .PP
75 This POD documents the methods of these events, which are mainly provided for
76 you to use when testing your test tools.
77 .SH SYNOPSIS
78 .IX Header "SYNOPSIS"
79 .Vb 2
80 \& use Test2::V0;
81 \& use Test2::API qw/intercept/;
82 \&
83 \& my $events = intercept {
84 \& ok(1, "A passing assertion");
85 \& plan(1);
86 \& };
87 \&
88 \& # This will convert all events into instances of
89 \& # Test2::API::InterceptResult::Event. Until we do this they are the
90 \& # original Test::Event::* instances
91 \& $events\->upgrade(in_place => 1);
92 \&
93 \& # Now we can get individual events in this form
94 \& my $assert = $events\->[0];
95 \& my $plan = $events\->[1];
96 \&
97 \& # Or we can operate on all events at once:
98 \& my $flattened = $events\->flatten;
99 \& is(
100 \& $flattened,
101 \& [
102 \& {
103 \& causes_failure => 0,
104 \&
105 \& name => \*(AqA passing assertion\*(Aq,
106 \& pass => 1,
107 \&
108 \& trace_file => \*(Aqxxx.t\*(Aq,
109 \& trace_line => 5,
110 \& },
111 \& {
112 \& causes_failure => 0,
113 \&
114 \& plan => 1,
115 \&
116 \& trace_file => \*(Aqxxx.t\*(Aq,
117 \& trace_line => 6,
118 \& },
119 \& ],
120 \& "Flattened both events and returned an arrayref of the results
121 \& );
122 .Ve
123 .SH METHODS
124 .IX Header "METHODS"
125 .SS "!!! IMPORTANT NOTES ON DESIGN !!!"
126 .IX Subsection "!!! IMPORTANT NOTES ON DESIGN !!!"
127 Please pay attention to what these return, many return a scalar when
128 applicable or an empty list when not (as opposed to undef). Many also always
129 return a list of 0 or more items. Some always return a scalar. Note that none
130 of the methods care about context, their behavior is consistent regardless of
131 scalar, list, or void context.
132 .PP
133 This was done because this class was specifically designed to be used in a list
134 and generate more lists in bulk operations. Sometimes in a map you want nothing
135 to show up for the event, and you do not want an undef in its place. In general
136 single event instances are not going to be used alone, though that is allowed.
137 .PP
138 As a general rule any method prefixed with \f(CW\*(C`the_\*(C'\fR implies the event should
139 have exactly 1 of the specified item, and and exception will be thrown if there
140 are 0, or more than 1 of the item.
141 .SS ATTRIBUTES
142 .IX Subsection "ATTRIBUTES"
143 .ie n .IP "$hashref = $event\->facet_data" 4
144 .el .IP "\f(CW$hashref\fR = \f(CW$event\fR\->facet_data" 4
145 .IX Item "$hashref = $event->facet_data"
146 This will return the facet data hashref, which is all Test2 cares about for any
147 given event.
148 .ie n .IP "$class = $event\->result_class" 4
149 .el .IP "\f(CW$class\fR = \f(CW$event\fR\->result_class" 4
150 .IX Item "$class = $event->result_class"
151 This is normally Test2::API::InterceptResult. This is set at construction so
152 that subtest results can be turned into instances of it on demand.
153 .SS DUPLICATION
154 .IX Subsection "DUPLICATION"
155 .ie n .IP "$copy = $event\->clone" 4
156 .el .IP "\f(CW$copy\fR = \f(CW$event\fR\->clone" 4
157 .IX Item "$copy = $event->clone"
158 Create a deep copy of the event. Modifying either event will not affect the
159 other.
160 .SS "CONDENSED MULTI\-FACET DATA"
161 .IX Subsection "CONDENSED MULTI-FACET DATA"
162 .ie n .IP "$bool = $event\->causes_failure" 4
163 .el .IP "\f(CW$bool\fR = \f(CW$event\fR\->causes_failure" 4
164 .IX Item "$bool = $event->causes_failure"
165 .PD 0
166 .ie n .IP "$bool = $event\->causes_fail" 4
167 .el .IP "\f(CW$bool\fR = \f(CW$event\fR\->causes_fail" 4
168 .IX Item "$bool = $event->causes_fail"
169 .PD
170 These are both aliases of the same functionality.
171 .Sp
172 This will always return either a true value, or a false value. This never
173 returns a list.
174 .Sp
175 This method may be relatively slow (still super fast) because it determines
176 pass or fail by creating an instance of Test2::Hub and asking it to process
177 the event, and then asks the hub for its pass/fail state. This is slower than
178 building in logic to do the check, but it is more reliable as it will always
179 tell you what the hub thinks, so the logic will never be out of date relative
180 to the Test2 logic that actually cares.
181 .ie n .IP "STRING_OR_EMPTY_LIST = $event\->brief" 4
182 .el .IP "STRING_OR_EMPTY_LIST = \f(CW$event\fR\->brief" 4
183 .IX Item "STRING_OR_EMPTY_LIST = $event->brief"
184 Not all events have a brief, some events are not rendered by the formatter,
185 others have no "brief" data worth seeing. When this is the case an empty list
186 is returned. This is done intentionally so it can be used in a map operation
187 without having \f(CW\*(C`undef\*(C'\fR being included in the result.
188 .Sp
189 When a brief can be generated it is always a single 1\-line string, and is
190 returned as\-is, not in a list.
191 .Sp
192 Possible briefs:
193 .Sp
194 .Vb 3
195 \& # From control facets
196 \& "BAILED OUT"
197 \& "BAILED OUT: $why"
198 \&
199 \& # From error facets
200 \& "ERROR"
201 \& "ERROR: $message"
202 \& "ERROR: $partial_message [...]"
203 \& "ERRORS: $first_error_message [...]"
204 \&
205 \& # From assert facets
206 \& "PASS"
207 \& "FAIL"
208 \& "PASS with amnesty"
209 \& "FAIL with amnesty"
210 \&
211 \& # From plan facets
212 \& "PLAN $count"
213 \& "NO PLAN"
214 \& "SKIP ALL"
215 \& "SKIP ALL: $why"
216 .Ve
217 .Sp
218 Note that only the first applicable brief is returned. This is essentially a
219 poor\-mans TAP that only includes facets that could (but not necessarily do)
220 cause a failure.
221 .ie n .IP "$hashref = $event\->flatten" 4
222 .el .IP "\f(CW$hashref\fR = \f(CW$event\fR\->flatten" 4
223 .IX Item "$hashref = $event->flatten"
224 .PD 0
225 .ie n .IP "$hashref = $event\->flatten(include_subevents => 1)" 4
226 .el .IP "\f(CW$hashref\fR = \f(CW$event\fR\->flatten(include_subevents => 1)" 4
227 .IX Item "$hashref = $event->flatten(include_subevents => 1)"
228 .PD
229 This ALWAYS returns a hashref. This puts all the most useful data for the most
230 interesting facets into a single hashref for easy validation.
231 .Sp
232 If there are no meaningful facets this will return an empty hashref.
233 .Sp
234 If given the \*(Aqinclude_subevents\*(Aq parameter it will also include subtest data:
235 .Sp
236 Here is a list of EVERY possible field. If a field is not applicable it will
237 not be present.
238 .RS 4
239 .IP "always present" 4
240 .IX Item "always present"
241 .Vb 1
242 \& causes_failure => 1, # Always present
243 .Ve
244 .IP "Present if the event has a trace facet" 4
245 .IX Item "Present if the event has a trace facet"
246 .Vb 3
247 \& trace_line => 42,
248 \& trace_file => \*(AqFoo/Bar.pm\*(Aq,
249 \& trace_details => \*(AqExtra trace details\*(Aq, # usually not present
250 .Ve
251 .IP "If an assertion is present" 4
252 .IX Item "If an assertion is present"
253 .Vb 2
254 \& pass => 0,
255 \& name => "1 + 1 = 2, so math works",
256 .Ve
257 .IP "If a plan is present:" 4
258 .IX Item "If a plan is present:"
259 .Vb 1
260 \& plan => $count_or_SKIP_ALL_or_NO_PLAN,
261 .Ve
262 .IP "If amnesty facets are present" 4
263 .IX Item "If amnesty facets are present"
264 You get an array for each type that is present.
265 .Sp
266 .Vb 4
267 \& todo => [ # Yes you could be under multiple todos, this will list them all.
268 \& "I will fix this later",
269 \& "I promise to fix these",
270 \& ],
271 \&
272 \& skip => ["This will format the main drive, do not run"],
273 \&
274 \& ... => ["Other amnesty"]
275 .Ve
276 .IP "If Info (note/diag) facets are present" 4
277 .IX Item "If Info (note/diag) facets are present"
278 You get an arrayref for any that are present, the key is not defined if they are not present.
279 .Sp
280 .Vb 4
281 \& diag => [
282 \& "Test failed at Foo/Bar.pm line 42",
283 \& "You forgot to tie your boots",
284 \& ],
285 \&
286 \& note => ["Your boots are red"],
287 \&
288 \& ... => ["Other info"],
289 .Ve
290 .IP "If error facets are present" 4
291 .IX Item "If error facets are present"
292 Always an arrayref
293 .Sp
294 .Vb 4
295 \& error => [
296 \& "non fatal error (does not cause test failure, just an FYI",
297 \& "FATAL: This is a fatal error (causes failure)",
298 \& ],
299 \&
300 \& # Errors can have alternative tags, but in practice are always \*(Aqerror\*(Aq,
301 \& # listing this for completeness.
302 \& ... => [ ... ]
303 .Ve
304 .IP "Present if the event is a subtest" 4
305 .IX Item "Present if the event is a subtest"
306 .Vb 5
307 \& subtest => {
308 \& count => 2, # Number of assertions made
309 \& failed => 1, # Number of test failures seen
310 \& is_passing => 0, # Boolean, true if the test would be passing
311 \& # after the events are processed.
312 \&
313 \& plan => 2, # Plan, either a number, undef, \*(AqSKIP\*(Aq, or \*(AqNO PLAN\*(Aq
314 \& follows_plan => 1, # True if there is a plan and it was followed.
315 \& # False if the plan and assertions did not
316 \& # match, undef if no plan was present in the
317 \& # event list.
318 \&
319 \& bailed_out => "foo", # if there was a bail\-out in the
320 \& # events in this will be a string explaining
321 \& # why there was a bailout, if no reason was
322 \& # given this will simply be set to true (1).
323 \&
324 \& skip_reason => "foo", # If there was a skip_all this will give the
325 \& # reason.
326 \& },
327 .Ve
328 .Sp
329 if \f(CW\*(C`(include_subtest => 1)\*(C'\fR was provided as a parameter then the following
330 will be included. This is the result of turning all subtest child events into
331 an Test2::API::InterceptResult instance and calling the \f(CW\*(C`flatten\*(C'\fR method on
332 it.
333 .Sp
334 .Vb 1
335 \& subevents => Test2::API::InterceptResult\->new(@child_events)\->flatten(...),
336 .Ve
337 .IP "If a bail\-out is being requested" 4
338 .IX Item "If a bail-out is being requested"
339 If no reason was given this will be set to 1.
340 .Sp
341 .Vb 1
342 \& bailed_out => "reason",
343 .Ve
344 .RE
345 .RS 4
346 .RE
347 .ie n .IP "$hashref = $event\->\fBsummary()\fR" 4
348 .el .IP "\f(CW$hashref\fR = \f(CW$event\fR\->\fBsummary()\fR" 4
349 .IX Item "$hashref = $event->summary()"
350 This returns a limited summary. See \f(CWflatten()\fR, which is usually a better
351 option.
352 .Sp
353 .Vb 2
354 \& {
355 \& brief => $event\->brief || \*(Aq\*(Aq,
356 \&
357 \& causes_failure => $event\->causes_failure,
358 \&
359 \& trace_line => $event\->trace_line,
360 \& trace_file => $event\->trace_file,
361 \& trace_tool => $event\->trace_subname,
362 \& trace_details => $event\->trace_details,
363 \&
364 \& facets => [ sort keys(%{$event\->{+FACET_DATA}}) ],
365 \& }
366 .Ve
367 .SS "DIRECT ARBITRARY FACET ACCESS"
368 .IX Subsection "DIRECT ARBITRARY FACET ACCESS"
369 .ie n .IP "@list_of_facets = $event\->facet($name)" 4
370 .el .IP "\f(CW@list_of_facets\fR = \f(CW$event\fR\->facet($name)" 4
371 .IX Item "@list_of_facets = $event->facet($name)"
372 This always returns a list of 0 or more items. This fetches the facet instances
373 from the event. For facets like \*(Aqassert\*(Aq this will always return 0 or 1
374 item. For events like \*(Aqinfo\*(Aq (diags, notes) this will return 0 or more
375 instances, once for each instance of the facet.
376 .Sp
377 These will be blessed into the proper Test2::EventFacet subclass. If no
378 subclass can be found it will be blessed as an
379 Test2::API::InterceptResult::Facet generic facet class.
380 .ie n .IP "$undef_or_facet = $event\->the_facet($name)" 4
381 .el .IP "\f(CW$undef_or_facet\fR = \f(CW$event\fR\->the_facet($name)" 4
382 .IX Item "$undef_or_facet = $event->the_facet($name)"
383 If you know you will have exactly 1 instance of a facet you can call this.
384 .Sp
385 If you are correct and there is exactly one instance of the facet it will
386 always return the hashref.
387 .Sp
388 If there are 0 instances of the facet this will return undef, not an empty
389 list.
390 .Sp
391 If there are more than 1 instance this will throw an exception because your
392 assumption was incorrect.
393 .SS "TRACE FACET"
394 .IX Subsection "TRACE FACET"
395 .ie n .IP "@list_of_facets = $event\->trace" 4
396 .el .IP "\f(CW@list_of_facets\fR = \f(CW$event\fR\->trace" 4
397 .IX Item "@list_of_facets = $event->trace"
398 TODO
399 .ie n .IP "$undef_or_hashref = $event\->the_trace" 4
400 .el .IP "\f(CW$undef_or_hashref\fR = \f(CW$event\fR\->the_trace" 4
401 .IX Item "$undef_or_hashref = $event->the_trace"
402 This returns the trace hashref, or undef if it is not present.
403 .ie n .IP "$undef_or_arrayref = $event\->frame" 4
404 .el .IP "\f(CW$undef_or_arrayref\fR = \f(CW$event\fR\->frame" 4
405 .IX Item "$undef_or_arrayref = $event->frame"
406 If a trace is present, and has a caller frame, this will be an arrayref:
407 .Sp
408 .Vb 1
409 \& [$package, $file, $line, $subname]
410 .Ve
411 .Sp
412 If the trace is not present, or has no caller frame this will return undef.
413 .ie n .IP "$undef_or_string = $event\->trace_details" 4
414 .el .IP "\f(CW$undef_or_string\fR = \f(CW$event\fR\->trace_details" 4
415 .IX Item "$undef_or_string = $event->trace_details"
416 This is usually undef, but occasionally has a string that overrides the
417 file/line number debugging a trace usually provides on test failure.
418 .ie n .IP "$undef_or_string = $event\->trace_package" 4
419 .el .IP "\f(CW$undef_or_string\fR = \f(CW$event\fR\->trace_package" 4
420 .IX Item "$undef_or_string = $event->trace_package"
421 Same as \f(CW\*(C`(caller())[0]\*(C'\fR, the first element of the trace frame.
422 .Sp
423 Will be undef if not present.
424 .ie n .IP "$undef_or_string = $event\->trace_file" 4
425 .el .IP "\f(CW$undef_or_string\fR = \f(CW$event\fR\->trace_file" 4
426 .IX Item "$undef_or_string = $event->trace_file"
427 Same as \f(CW\*(C`(caller())[1]\*(C'\fR, the second element of the trace frame.
428 .Sp
429 Will be undef if not present.
430 .ie n .IP "$undef_or_integer = $event\->trace_line" 4
431 .el .IP "\f(CW$undef_or_integer\fR = \f(CW$event\fR\->trace_line" 4
432 .IX Item "$undef_or_integer = $event->trace_line"
433 Same as \f(CW\*(C`(caller())[2]\*(C'\fR, the third element of the trace frame.
434 .Sp
435 Will be undef if not present.
436 .ie n .IP "$undef_or_string = $event\->trace_subname" 4
437 .el .IP "\f(CW$undef_or_string\fR = \f(CW$event\fR\->trace_subname" 4
438 .IX Item "$undef_or_string = $event->trace_subname"
439 .PD 0
440 .ie n .IP "$undef_or_string = $event\->trace_tool" 4
441 .el .IP "\f(CW$undef_or_string\fR = \f(CW$event\fR\->trace_tool" 4
442 .IX Item "$undef_or_string = $event->trace_tool"
443 .PD
444 Aliases for the same thing
445 .Sp
446 Same as \f(CW\*(C`(caller($level))[4]\*(C'\fR, the fourth element of the trace frame.
447 .Sp
448 Will be undef if not present.
449 .ie n .IP "$undef_or_string = $event\->trace_signature" 4
450 .el .IP "\f(CW$undef_or_string\fR = \f(CW$event\fR\->trace_signature" 4
451 .IX Item "$undef_or_string = $event->trace_signature"
452 A string that is a unique signature for the trace. If a single context
453 generates multiple events they will all have the same signature. This can be
454 used to tie assertions and diagnostics sent as separate events together after
455 the fact.
456 .SS "ASSERT FACET"
457 .IX Subsection "ASSERT FACET"
458 .ie n .IP "$bool = $event\->has_assert" 4
459 .el .IP "\f(CW$bool\fR = \f(CW$event\fR\->has_assert" 4
460 .IX Item "$bool = $event->has_assert"
461 Returns true if the event has an assert facet, false if it does not.
462 .ie n .IP "$undef_or_hashref = $event\->the_assert" 4
463 .el .IP "\f(CW$undef_or_hashref\fR = \f(CW$event\fR\->the_assert" 4
464 .IX Item "$undef_or_hashref = $event->the_assert"
465 Returns the assert facet if present, undef if it is not.
466 .ie n .IP "@list_of_facets = $event\->assert" 4
467 .el .IP "\f(CW@list_of_facets\fR = \f(CW$event\fR\->assert" 4
468 .IX Item "@list_of_facets = $event->assert"
469 TODO
470 .ie n .IP "EMPTY_LIST_OR_STRING = $event\->assert_brief" 4
471 .el .IP "EMPTY_LIST_OR_STRING = \f(CW$event\fR\->assert_brief" 4
472 .IX Item "EMPTY_LIST_OR_STRING = $event->assert_brief"
473 Returns a string giving a brief of the assertion if an assertion is present.
474 Returns an empty list if no assertion is present.
475 .SS "SUBTESTS (PARENT FACET)"
476 .IX Subsection "SUBTESTS (PARENT FACET)"
477 .ie n .IP "$bool = $event\->has_subtest" 4
478 .el .IP "\f(CW$bool\fR = \f(CW$event\fR\->has_subtest" 4
479 .IX Item "$bool = $event->has_subtest"
480 True if a subetest is present in this event.
481 .ie n .IP "$undef_or_hashref = $event\->the_subtest" 4
482 .el .IP "\f(CW$undef_or_hashref\fR = \f(CW$event\fR\->the_subtest" 4
483 .IX Item "$undef_or_hashref = $event->the_subtest"
484 Get the one subtest if present, otherwise undef.
485 .ie n .IP "@list_of_facets = $event\->subtest" 4
486 .el .IP "\f(CW@list_of_facets\fR = \f(CW$event\fR\->subtest" 4
487 .IX Item "@list_of_facets = $event->subtest"
488 TODO
489 .ie n .IP "EMPTY_LIST_OR_OBJECT = $event\->subtest_result" 4
490 .el .IP "EMPTY_LIST_OR_OBJECT = \f(CW$event\fR\->subtest_result" 4
491 .IX Item "EMPTY_LIST_OR_OBJECT = $event->subtest_result"
492 Returns an empty list if there is no subtest.
493 .Sp
494 Get an instance of Test2::API::InterceptResult representing the subtest.
495 .SS "CONTROL FACET (BAILOUT, ENCODING)"
496 .IX Subsection "CONTROL FACET (BAILOUT, ENCODING)"
497 .ie n .IP "$bool = $event\->has_bailout" 4
498 .el .IP "\f(CW$bool\fR = \f(CW$event\fR\->has_bailout" 4
499 .IX Item "$bool = $event->has_bailout"
500 True if there was a bailout
501 .ie n .IP "$undef_hashref = $event\->the_bailout" 4
502 .el .IP "\f(CW$undef_hashref\fR = \f(CW$event\fR\->the_bailout" 4
503 .IX Item "$undef_hashref = $event->the_bailout"
504 Return the control facet if it requested a bailout.
505 .ie n .IP "EMPTY_LIST_OR_HASHREF = $event\->bailout" 4
506 .el .IP "EMPTY_LIST_OR_HASHREF = \f(CW$event\fR\->bailout" 4
507 .IX Item "EMPTY_LIST_OR_HASHREF = $event->bailout"
508 Get a list of 0 or 1 hashrefs. The hashref will be the control facet if a
509 bail\-out was requested.
510 .ie n .IP "EMPTY_LIST_OR_STRING = $event\->bailout_brief" 4
511 .el .IP "EMPTY_LIST_OR_STRING = \f(CW$event\fR\->bailout_brief" 4
512 .IX Item "EMPTY_LIST_OR_STRING = $event->bailout_brief"
513 Get the brief of the bailout if present.
514 .ie n .IP "EMPTY_LIST_OR_STRING = $event\->bailout_reason" 4
515 .el .IP "EMPTY_LIST_OR_STRING = \f(CW$event\fR\->bailout_reason" 4
516 .IX Item "EMPTY_LIST_OR_STRING = $event->bailout_reason"
517 Get the reason for the bailout, an empty string if no reason was provided, or
518 an empty list if there was no bailout.
519 .SS "PLAN FACET"
520 .IX Subsection "PLAN FACET"
521 TODO
522 .ie n .IP "$bool = $event\->has_plan" 4
523 .el .IP "\f(CW$bool\fR = \f(CW$event\fR\->has_plan" 4
524 .IX Item "$bool = $event->has_plan"
525 .PD 0
526 .ie n .IP "$undef_or_hashref = $event\->the_plan" 4
527 .el .IP "\f(CW$undef_or_hashref\fR = \f(CW$event\fR\->the_plan" 4
528 .IX Item "$undef_or_hashref = $event->the_plan"
529 .ie n .IP "@list_if_hashrefs = $event\->plan" 4
530 .el .IP "\f(CW@list_if_hashrefs\fR = \f(CW$event\fR\->plan" 4
531 .IX Item "@list_if_hashrefs = $event->plan"
532 .ie n .IP "EMPTY_LIST_OR_STRING $event\->plan_brief" 4
533 .el .IP "EMPTY_LIST_OR_STRING \f(CW$event\fR\->plan_brief" 4
534 .IX Item "EMPTY_LIST_OR_STRING $event->plan_brief"
535 .PD
536 .SS "AMNESTY FACET (TODO AND SKIP)"
537 .IX Subsection "AMNESTY FACET (TODO AND SKIP)"
538 TODO
539 .ie n .IP $event\->has_amnesty 4
540 .el .IP \f(CW$event\fR\->has_amnesty 4
541 .IX Item "$event->has_amnesty"
542 .PD 0
543 .ie n .IP $event\->the_amnesty 4
544 .el .IP \f(CW$event\fR\->the_amnesty 4
545 .IX Item "$event->the_amnesty"
546 .ie n .IP $event\->amnesty 4
547 .el .IP \f(CW$event\fR\->amnesty 4
548 .IX Item "$event->amnesty"
549 .ie n .IP $event\->amnesty_reasons 4
550 .el .IP \f(CW$event\fR\->amnesty_reasons 4
551 .IX Item "$event->amnesty_reasons"
552 .ie n .IP $event\->has_todos 4
553 .el .IP \f(CW$event\fR\->has_todos 4
554 .IX Item "$event->has_todos"
555 .ie n .IP $event\->todos 4
556 .el .IP \f(CW$event\fR\->todos 4
557 .IX Item "$event->todos"
558 .ie n .IP $event\->todo_reasons 4
559 .el .IP \f(CW$event\fR\->todo_reasons 4
560 .IX Item "$event->todo_reasons"
561 .ie n .IP $event\->has_skips 4
562 .el .IP \f(CW$event\fR\->has_skips 4
563 .IX Item "$event->has_skips"
564 .ie n .IP $event\->skips 4
565 .el .IP \f(CW$event\fR\->skips 4
566 .IX Item "$event->skips"
567 .ie n .IP $event\->skip_reasons 4
568 .el .IP \f(CW$event\fR\->skip_reasons 4
569 .IX Item "$event->skip_reasons"
570 .ie n .IP $event\->has_other_amnesty 4
571 .el .IP \f(CW$event\fR\->has_other_amnesty 4
572 .IX Item "$event->has_other_amnesty"
573 .ie n .IP $event\->other_amnesty 4
574 .el .IP \f(CW$event\fR\->other_amnesty 4
575 .IX Item "$event->other_amnesty"
576 .ie n .IP $event\->other_amnesty_reasons 4
577 .el .IP \f(CW$event\fR\->other_amnesty_reasons 4
578 .IX Item "$event->other_amnesty_reasons"
579 .PD
580 .SS "ERROR FACET (CAPTURED EXCEPTIONS)"
581 .IX Subsection "ERROR FACET (CAPTURED EXCEPTIONS)"
582 TODO
583 .ie n .IP $event\->has_errors 4
584 .el .IP \f(CW$event\fR\->has_errors 4
585 .IX Item "$event->has_errors"
586 .PD 0
587 .ie n .IP $event\->the_errors 4
588 .el .IP \f(CW$event\fR\->the_errors 4
589 .IX Item "$event->the_errors"
590 .ie n .IP $event\->errors 4
591 .el .IP \f(CW$event\fR\->errors 4
592 .IX Item "$event->errors"
593 .ie n .IP $event\->error_messages 4
594 .el .IP \f(CW$event\fR\->error_messages 4
595 .IX Item "$event->error_messages"
596 .ie n .IP $event\->error_brief 4
597 .el .IP \f(CW$event\fR\->error_brief 4
598 .IX Item "$event->error_brief"
599 .PD
600 .SS "INFO FACET (DIAG, NOTE)"
601 .IX Subsection "INFO FACET (DIAG, NOTE)"
602 TODO
603 .ie n .IP $event\->has_info 4
604 .el .IP \f(CW$event\fR\->has_info 4
605 .IX Item "$event->has_info"
606 .PD 0
607 .ie n .IP $event\->the_info 4
608 .el .IP \f(CW$event\fR\->the_info 4
609 .IX Item "$event->the_info"
610 .ie n .IP $event\->info 4
611 .el .IP \f(CW$event\fR\->info 4
612 .IX Item "$event->info"
613 .ie n .IP $event\->info_messages 4
614 .el .IP \f(CW$event\fR\->info_messages 4
615 .IX Item "$event->info_messages"
616 .ie n .IP $event\->has_diags 4
617 .el .IP \f(CW$event\fR\->has_diags 4
618 .IX Item "$event->has_diags"
619 .ie n .IP $event\->diags 4
620 .el .IP \f(CW$event\fR\->diags 4
621 .IX Item "$event->diags"
622 .ie n .IP $event\->diag_messages 4
623 .el .IP \f(CW$event\fR\->diag_messages 4
624 .IX Item "$event->diag_messages"
625 .ie n .IP $event\->has_notes 4
626 .el .IP \f(CW$event\fR\->has_notes 4
627 .IX Item "$event->has_notes"
628 .ie n .IP $event\->notes 4
629 .el .IP \f(CW$event\fR\->notes 4
630 .IX Item "$event->notes"
631 .ie n .IP $event\->note_messages 4
632 .el .IP \f(CW$event\fR\->note_messages 4
633 .IX Item "$event->note_messages"
634 .ie n .IP $event\->has_other_info 4
635 .el .IP \f(CW$event\fR\->has_other_info 4
636 .IX Item "$event->has_other_info"
637 .ie n .IP $event\->other_info 4
638 .el .IP \f(CW$event\fR\->other_info 4
639 .IX Item "$event->other_info"
640 .ie n .IP $event\->other_info_messages 4
641 .el .IP \f(CW$event\fR\->other_info_messages 4
642 .IX Item "$event->other_info_messages"
643 .PD
644 .SH SOURCE
645 .IX Header "SOURCE"
646 The source code repository for Test2 can be found at
647 <https://github.com/Test\-More/test\-more/>.
648 .SH MAINTAINERS
649 .IX Header "MAINTAINERS"
650 .IP "Chad Granum <[email protected]>" 4
651 .IX Item "Chad Granum <[email protected]>"
652 .SH AUTHORS
653 .IX Header "AUTHORS"
654 .IP "Chad Granum <[email protected]>" 4
655 .IX Item "Chad Granum <[email protected]>"
656 .SH COPYRIGHT
657 .IX Header "COPYRIGHT"
658 Copyright Chad Granum <[email protected]>.
659 .PP
660 This program is free software; you can redistribute it and/or
661 modify it under the same terms as Perl itself.
662 .PP
663 See <https://dev.perl.org/licenses/>