Manual Reference Pages - TEST2::PLUGIN (3)
Test2::Plugin - Documentation for plugins
This is an experimental release. Using this right now is not recommended.
Plugins are packages that cause behavior changes, or other side effects for the
test file that loads them. They should not export any functions, or provide any
tools. Plugins should be distinct units of functionality.
If you wish to combine behavior changes with tools then you should write a
Plugin, a Tools module, and a bundle that loads them both.
Should I subclass Test2::Plugin?
No. Currently this class is empty. Eventually we may want to add behavior, in
which case we do not want anyone to already be subclassing it.
HOW DO I WRITE A PLUGIN?
Writing a plugin is not as simple as writing an Test2::Bundle, or writing
Test2::Tools. Plugins alter behavior, or cause desirable side-effects. To
accomplish this you typically need a custom import() method that calls one
or more functions provided by the Test2::API package.
If you want to write a plugin you should look at existing plugins, as well as
the Test2::API and Test2::Hub documentation. There is no formula for a
Plugin, they are generally unique, however consistent rules are that they
should not load other plugins, or export any functions.
The source code repository for Test2-Suite can be found at
Copyright 2015 Chad Granum <firstname.lastname@example.org>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
|perl v5.20.3 ||TEST2::PLUGIN (3) ||2016-03-20 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.