AnonymousFox

//usr/local/share/man/man3/Test::Requires.3pm

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Test::Requires 3"
.TH Test::Requires 3 "2020-05-14" "perl v5.32.1" "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"
Test::Requires \- Checks to see if the module can be loaded
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    # in your Makefile.PL
\&    use inc::Module::Install;
\&    test_requires \*(AqTest::Requires\*(Aq;
\&
\&    # in your test
\&    use Test::More tests => 10;
\&    use Test::Requires {
\&        \*(AqHTTP::MobileAttribute\*(Aq => 0.01, # skip all if HTTP::MobileAttribute doesn\*(Aqt installed
\&    };
\&    isa_ok HTTP::MobileAttribute\->new, \*(AqHTTP::MobileAttribute::NonMobile\*(Aq;
\&
\&    # or
\&    use Test::More tests => 10;
\&    use Test::Requires qw( 
\&        HTTP::MobileAttribute
\&    );
\&    isa_ok HTTP::MobileAttribute\->new, \*(AqHTTP::MobileAttribute::NonMobile\*(Aq;
\&
\&    # or
\&    use Test::More tests => 10;
\&    use Test::Requires;
\&    test_requires \*(AqSome::Optional::Test::Required::Modules\*(Aq;
\&    isa_ok HTTP::MobileAttribute\->new, \*(AqHTTP::MobileAttribute::NonMobile\*(Aq;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Test::Requires checks to see if the module can be loaded.
.PP
If this fails rather than failing tests this \fBskips all tests\fR.
.PP
Test::Requires can also be used to require a minimum version of Perl:
.PP
.Vb 1
\&    use Test::Requires "5.010";  # quoting is necessary!!
\&    
\&    # or
\&    use Test::Requires "v5.10";
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Tokuhiro Matsuno <tokuhirom @*(#RJKLFHFSDLJF gmail.com>
.SH "THANKS TO"
.IX Header "THANKS TO"
.Vb 4
\&    kazuho++ # some tricky stuff
\&    miyagawa++ # original code from t/TestPlagger.pm
\&    tomyhero++ # reported issue related older test::builder
\&    tobyink++ # documented that Test::Requires "5.010" works
.Ve
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
If the \f(CW\*(C`RELEASE_TESTING\*(C'\fR environment variable is true, then instead
of skipping tests, Test::Requires bails out.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\*(L"TestPlagger.pm\*(R" in t
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.