From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

UXYZAB / DBD-Mock-Session-GenerateFixtures-0.08 / local / lib / perl5 / Test2 / Manual / Tooling / Plugin / ToolStarts.pm 

            

              
1
2
3
4
5
6
7
—
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

              
package Test2::Manual::Tooling::Plugin::ToolStarts;
our $VERSION = '1.302209';
1;
__END__
=head1 NAME
Test2::Manual::Tooling::Plugin::ToolStarts - How to add behaviors that occur
when a tool starts work.
=head1 DESCRIPTION
This tutorial will help you write plugins that have behavior when a tool
starts. All tools should start by acquiring a context object. This tutorial
shows you the hooks you can use to take advantage of the context acquisition.
=head1 COMPLETE CODE UP FRONT
    package Test2::Plugin::MyPlugin;
    use Test2::API qw{
        test2_add_callback_context_init
        test2_add_callback_context_acquire
    };
    sub import {
        my $class = shift;
        # Let us know every time a tool requests a context, and give us a
        # chance to modify the parameters before we find it.
        test2_add_callback_context_acquire(sub {
            my $params_ref = shift;
            print "A tool has requested the context\n";
        });
        # Callback every time a new context is created, not called if an
        # existing context is found.
        test2_add_callback_context_init(sub {
            my $ctx_ref = shift;
            print "A new context was created\n";
        });
    }
    1;
=head1 LINE BY LINE
=over 4
=item use Test2::API qw{test2_add_callback_context_init test2_add_callback_context_acquire};
This imports the C<test2_add_callback_context_init()> and
C<test2_add_callback_context_acquire()> callbacks.
=item test2_add_callback_context_acquire(sub { ... })
This is where we add our callback for context acquisition. Every time
C<Test2::API::context()> is called the callback will be run.
=item my $params_ref = shift
In the test2_add_callback_context_acquire() callbacks we get exactly 1
argument, a reference to the parameters that C<context()> will use to find the
context.
=item print "A tool has requested the context\n"
Print a notification whenever a tool asks for a context.
=item test2_add_callback_context_init(sub { ... })
Add our context init callback. These callbacks are triggered whenever a
completely new context is created. This is not called if an existing context is
found. In short this only fires off for the top level tool, not nested tools.
=item my $ctx_ref = shift
The coderefs for test2_add_callback_context_init() will receive exactly 1
argument, the newly created context.
=item print "A new context was created\n"
Print a notification whenever a new context is created.
=back
=head1 SEE ALSO
L<Test2::Manual> - Primary index of the manual.
=head1 SOURCE
The source code repository for Test2-Manual can be found at
F<https://github.com/Test-More/test-more/>.
=head1 MAINTAINERS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 AUTHORS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 COPYRIGHT
Copyright Chad Granum E<lt>exodist@cpan.orgE<gt>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See F<http://dev.perl.org/licenses/>
=cut