Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Test2::Plugin

Name Test2::Plugin
Version 0.000144
Located at /usr/local/share/perl5
File /usr/local/share/perl5/Test2/Plugin.pm
Is Core No
Search CPAN for this module Test2::Plugin
Documentation Test2::Plugin
Module Details Test2::Plugin


NAME

Test2::Plugin - Documentation for plugins


DESCRIPTION

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.


FAQ

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 the Test2::Bundle manpage, or writing the Test2::Tools manpage. 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 the Test2::API manpage package.

If you want to write a plugin you should look at existing plugins, as well as the the Test2::API manpage and the Test2::Hub manpage 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.


SOURCE

The source code repository for Test2-Suite can be found at https://github.com/Test-More/Test2-Suite/.


MAINTAINERS

Chad Granum


AUTHORS

Chad Granum <exodist@cpan.org>Chad Granum


COPYRIGHT

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/

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024