xref: /openbsd-src/gnu/usr.bin/perl/cpan/Test-Simple/lib/Test2/EventFacet/Assert.pm (revision 5486feefcc8cb79b19e014ab332cc5dfd05b3b33)
15759b3d2Safresh1package Test2::EventFacet::Assert;
25759b3d2Safresh1use strict;
35759b3d2Safresh1use warnings;
45759b3d2Safresh1
5*5486feefSafresh1our $VERSION = '1.302199';
65759b3d2Safresh1
75759b3d2Safresh1BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
85759b3d2Safresh1use Test2::Util::HashBase qw{ -pass -no_debug -number };
95759b3d2Safresh1
105759b3d2Safresh11;
115759b3d2Safresh1
125759b3d2Safresh1__END__
135759b3d2Safresh1
145759b3d2Safresh1=pod
155759b3d2Safresh1
165759b3d2Safresh1=encoding UTF-8
175759b3d2Safresh1
185759b3d2Safresh1=head1 NAME
195759b3d2Safresh1
205759b3d2Safresh1Test2::EventFacet::Assert - Facet representing an assertion.
215759b3d2Safresh1
225759b3d2Safresh1=head1 DESCRIPTION
235759b3d2Safresh1
245759b3d2Safresh1The assertion facet is provided by any event representing an assertion that was
255759b3d2Safresh1made.
265759b3d2Safresh1
275759b3d2Safresh1=head1 FIELDS
285759b3d2Safresh1
295759b3d2Safresh1=over 4
305759b3d2Safresh1
315759b3d2Safresh1=item $string = $assert->{details}
325759b3d2Safresh1
335759b3d2Safresh1=item $string = $assert->details()
345759b3d2Safresh1
355759b3d2Safresh1Human readable description of the assertion.
365759b3d2Safresh1
375759b3d2Safresh1=item $bool = $assert->{pass}
385759b3d2Safresh1
395759b3d2Safresh1=item $bool = $assert->pass()
405759b3d2Safresh1
415759b3d2Safresh1True if the assertion passed.
425759b3d2Safresh1
435759b3d2Safresh1=item $bool = $assert->{no_debug}
445759b3d2Safresh1
455759b3d2Safresh1=item $bool = $assert->no_debug()
465759b3d2Safresh1
475759b3d2Safresh1Set this to true if you have provided custom diagnostics and do not want the
485759b3d2Safresh1defaults to be displayed.
495759b3d2Safresh1
505759b3d2Safresh1=item $int = $assert->{number}
515759b3d2Safresh1
525759b3d2Safresh1=item $int = $assert->number()
535759b3d2Safresh1
545759b3d2Safresh1(Optional) assertion number. This may be omitted or ignored. This is usually
555759b3d2Safresh1only useful when parsing/processing TAP.
565759b3d2Safresh1
575759b3d2Safresh1B<Note>: This is not set by the Test2 system, assertion number is not known
585759b3d2Safresh1until AFTER the assertion has been processed. This attribute is part of the
595759b3d2Safresh1spec only for harnesses.
605759b3d2Safresh1
615759b3d2Safresh1=back
625759b3d2Safresh1
635759b3d2Safresh1=head1 SOURCE
645759b3d2Safresh1
655759b3d2Safresh1The source code repository for Test2 can be found at
66*5486feefSafresh1L<https://github.com/Test-More/test-more/>.
675759b3d2Safresh1
685759b3d2Safresh1=head1 MAINTAINERS
695759b3d2Safresh1
705759b3d2Safresh1=over 4
715759b3d2Safresh1
725759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt>
735759b3d2Safresh1
745759b3d2Safresh1=back
755759b3d2Safresh1
765759b3d2Safresh1=head1 AUTHORS
775759b3d2Safresh1
785759b3d2Safresh1=over 4
795759b3d2Safresh1
805759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt>
815759b3d2Safresh1
825759b3d2Safresh1=back
835759b3d2Safresh1
845759b3d2Safresh1=head1 COPYRIGHT
855759b3d2Safresh1
86256a93a4Safresh1Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
875759b3d2Safresh1
885759b3d2Safresh1This program is free software; you can redistribute it and/or
895759b3d2Safresh1modify it under the same terms as Perl itself.
905759b3d2Safresh1
91*5486feefSafresh1See L<https://dev.perl.org/licenses/>
925759b3d2Safresh1
935759b3d2Safresh1=cut
94