1package Test2::EventFacet::Assert;
2use strict;
3use warnings;
4
5our $VERSION = '1.302190';
6
7BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
8use Test2::Util::HashBase qw{ -pass -no_debug -number };
9
101;
11
12__END__
13
14=pod
15
16=encoding UTF-8
17
18=head1 NAME
19
20Test2::EventFacet::Assert - Facet representing an assertion.
21
22=head1 DESCRIPTION
23
24The assertion facet is provided by any event representing an assertion that was
25made.
26
27=head1 FIELDS
28
29=over 4
30
31=item $string = $assert->{details}
32
33=item $string = $assert->details()
34
35Human readable description of the assertion.
36
37=item $bool = $assert->{pass}
38
39=item $bool = $assert->pass()
40
41True if the assertion passed.
42
43=item $bool = $assert->{no_debug}
44
45=item $bool = $assert->no_debug()
46
47Set this to true if you have provided custom diagnostics and do not want the
48defaults to be displayed.
49
50=item $int = $assert->{number}
51
52=item $int = $assert->number()
53
54(Optional) assertion number. This may be omitted or ignored. This is usually
55only useful when parsing/processing TAP.
56
57B<Note>: This is not set by the Test2 system, assertion number is not known
58until AFTER the assertion has been processed. This attribute is part of the
59spec only for harnesses.
60
61=back
62
63=head1 SOURCE
64
65The source code repository for Test2 can be found at
66F<http://github.com/Test-More/test-more/>.
67
68=head1 MAINTAINERS
69
70=over 4
71
72=item Chad Granum E<lt>exodist@cpan.orgE<gt>
73
74=back
75
76=head1 AUTHORS
77
78=over 4
79
80=item Chad Granum E<lt>exodist@cpan.orgE<gt>
81
82=back
83
84=head1 COPYRIGHT
85
86Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
87
88This program is free software; you can redistribute it and/or
89modify it under the same terms as Perl itself.
90
91See F<http://dev.perl.org/licenses/>
92
93=cut
94