Test-Simple/lib/Test2.pm

1 package Test2;
18 Test2 - Framework for writing test tools that all work together.
22 Test2 is a new testing framework produced by forking L<Test::Builder>,
31 From the beginning Test2 was built with introspection capabilities. With
33 verification. Test2 Makes it easy with C<Test2::API::intercept()>.
37 Test2 uses an L<Test2::API::Context> object to track filename, line number, and
43 Test2 based tools produce events which get passed through a processing system
50 Test2 took inventory of everything people were doing with Test::Builder that
51 required hacking it up. Test2 made public API functions for nearly all the
56 Test::Builder assumed everything would end up as TAP. Test2 makes no such
57 assumption. Test2 provides ways for you to specify alternative and custom
62 The Test::Builder implementation of subtests was certifiably insane. Test2 uses
67 Test2 support for forking and threading can be turned on using L<Test2::IPC>.
76 L<Test2::Suite>. L<Test2::Suite> is a separate cpan distribution that contains
77 many tools implemented on Test2.
80 L<Test2::API> first.
84 This describes the namespace layout for the Test2 ecosystem. Not all the
85 namespaces listed here are part of the Test2 distribution, some are implemented
86 in L<Test2::Suite>.
88 =head2 Test2::Tools::
91 tools like C<ok()> and C<is()>. Most things written for Test2 should go here.
93 L</Test2::Bundle::> namespace if you want to do that.
95 =head2 Test2::Plugin::
98 behavior of Test2. An example of a plugin is a module that sets the encoding to
102 =head2 Test2::Bundle::
109 =head2 Test2::Require::
115 =head2 Test2::Formatter::
117 Formatters live under this namespace. L<Test2::Formatter::TAP> is the only
121 =head2 Test2::Event::
126 =head2 Test2::Hub::
132 =head2 Test2::IPC::
137 =head3 Test2::IPC::Driver::
142 =head2 Test2::Util::
147 =head2 Test2::API::
149 This is for Test2 API and related packages.
151 =head2 Test2::
153 The Test2:: namespace is intended for extensions and frameworks. Tools,
158 script it should probably NOT go directly into C<Test2::XXX>.
162 L<Test2::API> - Primary API functions.
164 L<Test2::API::Context> - Detailed documentation of the context object.
166 L<Test2::IPC> - The IPC system used for threading/fork support.
168 L<Test2::Formatter> - Formatters such as TAP live here.
170 L<Test2::Event> - Events live in this namespace.
172 L<Test2::Hub> - All events eventually funnel through a hub. Custom hubs are how
177 Many Test2 developers and users lurk on L<irc://irc.perl.org/#perl-qa> and
185 The source code repository for Test2 can be found at