Test2::Suite - Distribution with a rich set of tools built upon the Test2
framework.
Rich set of tools, plugins, bundles, etc built upon the Test2 testing
library. If you are interested in writing tests, this is the distribution for
you.
- TOOLS
-
Tools are packages that export functions for use in test files. These functions
typically generate events. Tools SHOULD NEVER alter behavior of other tools,
or the system in general.
- PLUGINS
-
Plugins are packages that produce effects, or alter behavior of tools. An
example would be a plugin that causes the test to bail out after the first
failure. Plugins SHOULD NOT export anything.
- BUNDLES
-
Bundles are collections of tools and plugins. A bundle should load and
re-export functions from Tool packages. A bundle may also load and configure
any number of plugins.
If you want to write something that both exports new functions, and effects
behavior, you should write both a Tools distribution, and a Plugin distribution,
then a Bundle that loads them both. This is important as it helps avoid the
problem where a package exports much-desired tools, but
also produces undesirable side effects.
- Test2::V#
-
These do not live in the bundle namespace as they are the primary ways to use
Test2::Suite.
The current latest is the Test2::V0 manpage.
use Test2::V0;
# strict and warnings are on for you now.
ok(...);
# Note: is does deep checking, unlike the 'is' from Test::More.
is(...);
...
done_testing;
This bundle includes every tool listed in the INCLUDED TOOLS section below,
except for the Test2::Tools::ClassicCompare manpage. This bundle provides most of what
anyone writing tests could need. This is also the preferred bundle/toolset of
the Test2 author.
See the Test2::V0 manpage for complete documentation.
- Extended
-
** Deprecated ** See the Test2::V0 manpage
use Test2::Bundle::Extended;
# strict and warnings are on for you now.
ok(...);
# Note: is does deep checking, unlike the 'is' from Test::More.
is(...);
...
done_testing;
This bundle includes every tool listed in the INCLUDED TOOLS section below,
except for the Test2::Tools::ClassicCompare manpage. This bundle provides most of what
anyone writing tests could need. This is also the preferred bundle/toolset of
the Test2 author.
See the Test2::Bundle::Extended manpage for complete documentation.
- More
-
use Test2::Bundle::More;
use strict;
use warnings;
plan 3; # Or you can use done_testing at the end
ok(...);
is(...); # Note: String compare
is_deeply(...);
...
done_testing; # Use instead of plan
This bundle is meant to be a mostly drop-in replacement for the Test::More manpage.
There are some notable differences to be aware of however. Some exports are
missing: eq_array, eq_hash, eq_set, $TODO, explain, use_ok,
require_ok. As well it is no longer possible to set the plan at import:
use .. tests => 5. $TODO has been replaced by the todo()
function. Planning is done using plan, skip_all, or done_testing.
See the Test2::Bundle::More manpage for complete documentation.
- Simple
-
use Test2::Bundle::Simple;
use strict;
use warnings;
plan 1;
ok(...);
This bundle is meant to be a mostly drop-in replacement for the Test::Simple manpage.
See the Test2::Bundle::Simple manpage for complete documentation.
- Basic
-
Basic provides most of the essential tools previously found in the Test::More manpage.
However it does not export any tools used for comparison. The basic
pass,
fail, ok functions are present, as are functions for planning.
See the Test2::Tools::Basic manpage for complete documentation.
- Compare
-
This provides
is, like, isnt, unlike, and several additional
helpers. Note: These are all deep comparison tools and work like a
combination of the Test::More manpage's is and is_deeply.
See the Test2::Tools::Compare manpage for complete documentation.
- ClassicCompare
-
This provides the Test::More manpage flavored
is, like, isnt, unlike, and
is_deeply. It also provides cmp_ok.
See the Test2::Tools::ClassicCompare manpage for complete documentation.
- Class
-
This provides functions for testing objects and classes, things like
isa_ok.
See the Test2::Tools::Class manpage for complete documentation.
- Defer
-
This provides functions for writing test functions in one place, but running
them later. This is useful for testing things that run in an altered state.
See the Test2::Tools::Defer manpage for complete documentation.
- Encoding
-
This exports a single function that can be used to change the encoding of all
your test output.
See the Test2::Tools::Encoding manpage for complete documentation.
- Exports
-
This provides tools for verifying exports. You can verify that functions have
been imported, or that they have not been imported.
See the Test2::Tools::Exports manpage for complete documentation.
- Mock
-
This provides tools for mocking objects and classes. This is based largely on
the Mock::Quick manpage, but several interface improvements have been added that cannot
be added to Mock::Quick itself without breaking backwards compatibility.
See the Test2::Tools::Mock manpage for complete documentation.
- Ref
-
This exports tools for validating and comparing references.
See the Test2::Tools::Ref manpage for complete documentation.
- Spec
-
This is an RSPEC implementation with concurrency support.
See the Test2::Tools::Spec manpage for more details.
- Subtest
-
This exports tools for running subtests.
See the Test2::Tools::Subtest manpage for complete documentation.
- Target
-
This lets you load the
package(s) you intend to test, and alias them into
constants/package variables.
See the Test2::Tools::Target manpage for complete documentation.
- BailOnFail
-
The much requested ``bail-out on first failure'' plugin. When this plugin is
loaded, any failure will cause the test to bail out immediately.
See the Test2::Plugin::BailOnFail manpage for complete documentation.
- DieOnFail
-
The much requested ``die on first failure'' plugin. When this plugin is
loaded, any failure will cause the test to die immediately.
See the Test2::Plugin::DieOnFail manpage for complete documentation.
- ExitSummary
-
This plugin gives you statistics and diagnostics at the end of your test in the
event of a failure.
See the Test2::Plugin::ExitSummary manpage for complete documentation.
- SRand
-
Use this to set the random seed to a specific seed, or to the current date.
See the Test2::Plugin::SRand manpage for complete documentation.
- UTF8
-
Turn on utf8 for your testing. This sets the current file to be utf8, it also
sets STDERR, STDOUT, and your formatter to all output utf8.
See the Test2::Plugin::UTF8 manpage for complete documentation.
- AuthorTesting
-
Using this package will cause the test file to be skipped unless the
AUTHOR_TESTING environment variable is set.
See the Test2::Require::AuthorTesting manpage for complete documentation.
- EnvVar
-
Using this package will cause the test file to be skipped unless a custom
environment variable is set.
See the Test2::Require::EnvVar manpage for complete documentation.
- Fork
-
Using this package will cause the test file to be skipped unless the system is
capable of forking (including emulated forking).
See the Test2::Require::Fork manpage for complete documentation.
- RealFork
-
Using this package will cause the test file to be skipped unless the system is
capable of true forking.
See the Test2::Require::RealFork manpage for complete documentation.
- Module
-
Using this package will cause the test file to be skipped unless the specified
module is installed (and optionally at a minimum version).
See the Test2::Require::Module manpage for complete documentation.
- Perl
-
Using this package will cause the test file to be skipped unless the specified
minimum perl version is met.
See the Test2::Require::Perl manpage for complete documentation.
- Threads
-
Using this package will cause the test file to be skipped unless the system has
threading enabled.
Note: This will not turn threading on for you.
See the Test2::Require::Threads manpage for complete documentation.
See the Test2 documentation for a namespace map. Everything in this
distribution uses Test2.
the Test2::Manual manpage is the Test2 Manual.
Many Test2 developers and users lurk on irc://irc.perl.org/#perl. We also
have a slack team that can be joined by anyone with an @cpan.org email
address https://perl-test2.slack.com/ If you do not have an @cpan.org
email you can ask for a slack invite by emailing Chad Granum
<exodist@cpan.org>.
The source code repository for Test2-Suite can be found at
https://github.com/Test-More/Test2-Suite/.
- Chad Granum
-
- Chad Granum <exodist@cpan.org>Chad Granum
-
Copyright 2018 Chad Granum <exodist@cpan.org>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See http://dev.perl.org/licenses/
|