.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Test2::Manual::Tooling::Plugin::TestExit 3pm"
.TH Test2::Manual::Tooling::Plugin::TestExit 3pm "2019-05-06" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::Manual::Tooling::Plugin::TestExit \- How to safely add pre\-exit
behaviors.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This describes the correct/safe way to add pre-exit behaviors to tests via a
custom plugin.
.PP
The naive way to attempt this would be to add an \f(CW\*(C`END { ... }\*(C'\fR block. That can
work, and may not cause problems.... On the other hand there are a lot of ways
that can bite you. Describing all the potential problems of an \s-1END\s0 block, and
how it might conflict with Test2 (Which has its own \s-1END\s0 block) is beyond the
scope of this document.
.SH "COMPLETE CODE UP FRONT"
.IX Header "COMPLETE CODE UP FRONT"
.Vb 1
\&    package Test2::Plugin::MyPlugin;
\&
\&    use Test2::API qw{test2_add_callback_exit};
\&
\&    sub import {
\&        my $class = shift;
\&
\&        test2_add_callback_exit(sub {
\&            my ($ctx, $orig_code, $new_exit_code_ref) = @_;
\&
\&            return if $orig_code == 42;
\&
\&            $$new_exit_code_ref = 42;
\&        });
\&    }
\&
\&    1;
.Ve
.SH "LINE BY LINE"
.IX Header "LINE BY LINE"
.IP "use Test2::API qw{test2_add_callback_exit};" 4
.IX Item "use Test2::API qw{test2_add_callback_exit};"
This imports the \f(CW\*(C`(test2_add_callback_exit)\*(C'\fR callback.
.IP "test2_add_callback_exit(sub { ... });" 4
.IX Item "test2_add_callback_exit(sub { ... });"
This adds our callback to be called before exiting.
.ie n .IP "my ($ctx, $orig_code, $new_exit_code_ref) = @_" 4
.el .IP "my ($ctx, \f(CW$orig_code\fR, \f(CW$new_exit_code_ref\fR) = \f(CW@_\fR" 4
.IX Item "my ($ctx, $orig_code, $new_exit_code_ref) = @_"
The callback gets 3 arguments. First is a context object you may use. The
second is the original exit code of the \f(CW\*(C`END\*(C'\fR block Test2 is using. The third
argument is a scalar reference which you may use to get the current exit code,
or set a new one.
.ie n .IP "return if $orig_code == 42" 4
.el .IP "return if \f(CW$orig_code\fR == 42" 4
.IX Item "return if $orig_code == 42"
This is a short-cut to do nothing if the original exit code was already 42.
.IP "$$new_exit_code_ref = 42" 4
.IX Item "$$new_exit_code_ref = 42"
This changes the exit code to 42.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test2::Manual \- Primary index of the manual.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2\-Manual can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR