package Test2::Suite; use strict; use warnings; our $VERSION = '1.302204'; 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Suite - Distribution with a rich set of tools built upon the Test2 framework. =head1 DESCRIPTION Rich set of tools, plugins, bundles, etc built upon the L testing library. If you are interested in writing tests, this is the distribution for you. =head2 WHAT ARE TOOLS, PLUGINS, AND BUNDLES? =over 4 =item TOOLS Tools are packages that export functions for use in test files. These functions typically generate events. Tools B alter behavior of other tools, or the system in general. =item 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 B export anything. =item 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. =back 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. =head1 INCLUDED BUNDLES =over 4 =item Test2::V# These do not live in the bundle namespace as they are the primary ways to use Test2::Suite. The current latest is L. 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 L section below, except for L. This bundle provides most of what anyone writing tests could need. This is also the preferred bundle/toolset of the L author. See L for complete documentation. =item Extended B<** Deprecated **> See L 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 L section below, except for L. This bundle provides most of what anyone writing tests could need. This is also the preferred bundle/toolset of the L author. See L for complete documentation. =item 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 I drop-in replacement for L. There are some notable differences to be aware of however. Some exports are missing: C, C, C, C<$TODO>, C, C, C. As well it is no longer possible to set the plan at import: C<< use .. tests => 5 >>. C<$TODO> has been replaced by the C function. Planning is done using C, C, or C. See L for complete documentation. =item Simple use Test2::Bundle::Simple; use strict; use warnings; plan 1; ok(...); This bundle is meant to be a I drop-in replacement for L. See L for complete documentation. =back =head1 INCLUDED TOOLS =over 4 =item Basic Basic provides most of the essential tools previously found in L. However it does not export any tools used for comparison. The basic C, C, C functions are present, as are functions for planning. See L for complete documentation. =item Compare This provides C, C, C, C, and several additional helpers. B These are all I comparison tools and work like a combination of L's C and C. See L for complete documentation. =item ClassicCompare This provides L flavored C, C, C, C, and C. It also provides C. See L for complete documentation. =item Class This provides functions for testing objects and classes, things like C. See L for complete documentation. =item 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 L for complete documentation. =item Encoding This exports a single function that can be used to change the encoding of all your test output. See L for complete documentation. =item Exports This provides tools for verifying exports. You can verify that functions have been imported, or that they have not been imported. See L for complete documentation. =item Mock This provides tools for mocking objects and classes. This is based largely on L, but several interface improvements have been added that cannot be added to Mock::Quick itself without breaking backwards compatibility. See L for complete documentation. =item Ref This exports tools for validating and comparing references. See L for complete documentation. =item Spec This is an RSPEC implementation with concurrency support. See L for more details. =item Subtest This exports tools for running subtests. See L for complete documentation. =item Target This lets you load the package(s) you intend to test, and alias them into constants/package variables. See L for complete documentation. =back =head1 INCLUDED PLUGINS =over 4 =item 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 L for complete documentation. =item DieOnFail The much requested "die on first failure" plugin. When this plugin is loaded, any failure will cause the test to die immediately. See L for complete documentation. =item ExitSummary This plugin gives you statistics and diagnostics at the end of your test in the event of a failure. See L for complete documentation. =item SRand Use this to set the random seed to a specific seed, or to the current date. See L for complete documentation. =item 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 L for complete documentation. =back =head1 INCLUDED REQUIREMENT CHECKERS =over 4 =item AuthorTesting Using this package will cause the test file to be skipped unless the AUTHOR_TESTING environment variable is set. See L for complete documentation. =item EnvVar Using this package will cause the test file to be skipped unless a custom environment variable is set. See L for complete documentation. =item Fork Using this package will cause the test file to be skipped unless the system is capable of forking (including emulated forking). See L for complete documentation. =item RealFork Using this package will cause the test file to be skipped unless the system is capable of true forking. See L for complete documentation. =item 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 L for complete documentation. =item Perl Using this package will cause the test file to be skipped unless the specified minimum perl version is met. See L for complete documentation. =item Threads Using this package will cause the test file to be skipped unless the system has threading enabled. B This will not turn threading on for you. See L for complete documentation. =back =head1 SEE ALSO See the L documentation for a namespace map. Everything in this distribution uses L. L is the Test2 Manual. =head1 CONTACTING US Many Test2 developers and users lurk on L. We also have a slack team that can be joined by anyone with an C<@cpan.org> email address L If you do not have an C<@cpan.org> email you can ask for a slack invite by emailing Chad Granum Eexodist@cpan.orgE. =head1 SOURCE The source code repository for Test2-Suite can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright Chad Granum Eexodist@cpan.orgE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut