.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Test::Is 3pm"
.TH Test::Is 3pm "2016-03-17" "perl v5.22.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::Is \- Skip test in a declarative way, following the Lancaster Consensus
.SH "VERSION"
.IX Header "VERSION"
version 20140823.1
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
I want that this runs only on interactive environments:
.PP
.Vb 1
\&    use Test::Is \*(Aqinteractive\*(Aq;
.Ve
.PP
This test is an extended test: it takes much time to run or may have special
running conditions that may inconvenience a user that just want to install the
module:
.PP
.Vb 1
\&    use Test::Is \*(Aqextended\*(Aq;
.Ve
.PP
Both:
.PP
.Vb 1
\&    use Test::Is \*(Aqinteractive\*(Aq, \*(Aqextended\*(Aq;
.Ve
.PP
This test is only for perl 5.10+:
.PP
.Vb 3
\&    use Test::Is \*(Aqperl v5.10\*(Aq;
\&    use feature \*(Aqsay\*(Aq;
\&    ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a simple way of following the
specifications of the environment <https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/lancaster-consensus.md#environment-variables-for-testing-contexts>
variables available for Perl tests as defined as one of the
"Lancaster Consensus <https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/lancaster-consensus.md>"
at Perl \s-1QA\s0 Hackathon 2013. Those variables
(\f(CW\*(C`NONINTERACTIVE_TESTING\*(C'\fR, \f(CW\*(C`EXTENDED_TESTING\*(C'\fR) define which tests should be
skipped.
.PP
If the environment does not match what the author of the test expected, the
complete test is skipped (in the same way as \f(CW\*(C`use Test::More skip_all =>
\&...\*(C'\fR).
.PP
As an author, you can also expect that you will automatically benefit of later
evolutions of this specification just by upgrading the module.
.PP
As a \s-1CPAN\s0 toolchain author (\s-1CPAN\s0 client, smoker...) you may want to ensure at
runtime that the installed version of this module matches the environment
you set yourself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Environment variables for testing contexts <https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/lancaster-consensus.md#environment-variables-for-testing-contexts>:
the specification of the Lancaster Consensus.
.IP "\(bu" 4
Test::DescribeMe by \s-1WOLFSAGE,\s0 also created at Perl \s-1QA\s0 Hackathon 2013.
.SH "AUTHOR"
.IX Header "AUTHOR"
Olivier Mengué, <mailto:dolmen@cpan.org>
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright © 2013 Olivier Mengué.
.PP
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl 5 itself.