File Manager

Editing File: /usr/local/share/man/man3/Test2::Tools::Tiny.3pm

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test2::Tools::Tiny 3"
.TH Test2::Tools::Tiny 3 "2019-04-27" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::Tools::Tiny \- Tiny set of tools for unfortunate souls who cannot use
Test2::Suite.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
You should really look at Test2::Suite. This package is some very basic
essential tools implemented using Test2. This exists only so that Test2
and other tools required by Test2::Suite can be tested. This is the package
Test2 uses to test itself.
.SH "USE Test2::Suite INSTEAD"
.IX Header "USE Test2::Suite INSTEAD"
Use Test2::Suite if at all possible.
.SH "EXPORTS"
.IX Header "EXPORTS"
.ie n .IP "ok($bool, $name)" 4
.el .IP "ok($bool, \f(CW$name\fR)" 4
.IX Item "ok($bool, $name)"
.PD 0
.ie n .IP "ok($bool, $name, @diag)" 4
.el .IP "ok($bool, \f(CW$name\fR, \f(CW@diag\fR)" 4
.IX Item "ok($bool, $name, @diag)"
.PD
Run a simple assertion.
.ie n .IP "is($got, $want, $name)" 4
.el .IP "is($got, \f(CW$want\fR, \f(CW$name\fR)" 4
.IX Item "is($got, $want, $name)"
.PD 0
.ie n .IP "is($got, $want, $name, @diag)" 4
.el .IP "is($got, \f(CW$want\fR, \f(CW$name\fR, \f(CW@diag\fR)" 4
.IX Item "is($got, $want, $name, @diag)"
.PD
Assert that 2 strings are the same.
.ie n .IP "isnt($got, $do_not_want, $name)" 4
.el .IP "isnt($got, \f(CW$do_not_want\fR, \f(CW$name\fR)" 4
.IX Item "isnt($got, $do_not_want, $name)"
.PD 0
.ie n .IP "isnt($got, $do_not_want, $name, @diag)" 4
.el .IP "isnt($got, \f(CW$do_not_want\fR, \f(CW$name\fR, \f(CW@diag\fR)" 4
.IX Item "isnt($got, $do_not_want, $name, @diag)"
.PD
Assert that 2 strings are not the same.
.ie n .IP "like($got, $regex, $name)" 4
.el .IP "like($got, \f(CW$regex\fR, \f(CW$name\fR)" 4
.IX Item "like($got, $regex, $name)"
.PD 0
.ie n .IP "like($got, $regex, $name, @diag)" 4
.el .IP "like($got, \f(CW$regex\fR, \f(CW$name\fR, \f(CW@diag\fR)" 4
.IX Item "like($got, $regex, $name, @diag)"
.PD
Check that the input string matches the regex.
.ie n .IP "unlike($got, $regex, $name)" 4
.el .IP "unlike($got, \f(CW$regex\fR, \f(CW$name\fR)" 4
.IX Item "unlike($got, $regex, $name)"
.PD 0
.ie n .IP "unlike($got, $regex, $name, @diag)" 4
.el .IP "unlike($got, \f(CW$regex\fR, \f(CW$name\fR, \f(CW@diag\fR)" 4
.IX Item "unlike($got, $regex, $name, @diag)"
.PD
Check that the input string does not match the regex.
.ie n .IP "is_deeply($got, $want, $name)" 4
.el .IP "is_deeply($got, \f(CW$want\fR, \f(CW$name\fR)" 4
.IX Item "is_deeply($got, $want, $name)"
.PD 0
.ie n .IP "is_deeply($got, $want, $name, @diag)" 4
.el .IP "is_deeply($got, \f(CW$want\fR, \f(CW$name\fR, \f(CW@diag\fR)" 4
.IX Item "is_deeply($got, $want, $name, @diag)"
.PD
Check 2 data structures. Please note that this is a \fI\s-1DUMB\s0\fR implementation that
compares the output of Data::Dumper against both structures.
.IP "diag($msg)" 4
.IX Item "diag($msg)"
Issue a diagnostics message to \s-1STDERR.\s0
.IP "note($msg)" 4
.IX Item "note($msg)"
Issue a diagnostics message to \s-1STDOUT.\s0
.IP "skip_all($reason)" 4
.IX Item "skip_all($reason)"
Skip all tests.
.ie n .IP "todo $reason => sub { ... }" 4
.el .IP "todo \f(CW$reason\fR => sub { ... }" 4
.IX Item "todo $reason => sub { ... }"
Run a block in \s-1TODO\s0 mode.
.IP "plan($count)" 4
.IX Item "plan($count)"
Set the plan.
.IP "\fIdone_testing()\fR" 4
.IX Item "done_testing()"
Set the plan to the current test count.
.ie n .IP "$warnings = warnings { ... }" 4
.el .IP "\f(CW$warnings\fR = warnings { ... }" 4
.IX Item "$warnings = warnings { ... }"
Capture an arrayref of warnings from the block.
.ie n .IP "$exception = exception { ... }" 4
.el .IP "\f(CW$exception\fR = exception { ... }" 4
.IX Item "$exception = exception { ... }"
Capture an exception.
.ie n .IP "tests $name => sub { ... }" 4
.el .IP "tests \f(CW$name\fR => sub { ... }" 4
.IX Item "tests $name => sub { ... }"
Run a subtest.
.ie n .IP "$output = capture { ... }" 4
.el .IP "\f(CW$output\fR = capture { ... }" 4
.IX Item "$output = capture { ... }"
Capture \s-1STDOUT\s0 and \s-1STDERR\s0 output.
.Sp
Result looks like this:
.Sp
.Vb 4
\&    {
\&        STDOUT => "...",
\&        STDERR => "...",
\&    }
.Ve
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2019 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR

Back to Directory File Manager