Test2::Manual::Tooling::Plugin::ToolStarts(3) User Contributed Perl Documentation Test2::Manual::Tooling::Plugin::ToolStarts(3)

# [NAME](#NAME)

Test2::Manual::Tooling::Plugin::ToolStarts - How to add behaviors that occur when a tool starts work.

# [DESCRIPTION](#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.

# [COMPLETE CODE UP FRONT](#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;
```

# [LINE BY LINE](#LINE_BY_LINE)

[use Test2::API qw{test2\_add\_callback\_context\_init test2\_add\_callback\_context\_acquire};](#use)

This imports the test2\_add\_callback\_context\_init() and test2\_add\_callback\_context\_acquire() callbacks.

[test2\_add\_callback\_context\_acquire(sub { ... })](#test2_add_callback_context_acquire%28sub)

This is where we add our callback for context acquisition. Every time Test2::API::context() is called the callback will be run.

[my $params\_ref = shift](#my)

In the **test2\_add\_callback\_context\_acquire()** callbacks we get exactly 1 argument, a reference to the parameters that context() will use to find the context.

[print "A tool has requested the context\\n"](#print)

Print a notification whenever a tool asks for a context.

[test2\_add\_callback\_context\_init(sub { ... })](#test2_add_callback_context_init%28sub)

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.

[my $ctx\_ref = shift](#my~2)

The coderefs for **test2\_add\_callback\_context\_init()** will receive exactly 1 argument, the newly created context.

[print "A new context was created\\n"](#print~2)

Print a notification whenever a new context is created.

# [SEE ALSO](#SEE_ALSO)

Test2::Manual - Primary index of the manual.

# [SOURCE](#SOURCE)

The source code repository for Test2-Manual can be found at *https://github.com/Test-More/test-more/*.

# [MAINTAINERS](#MAINTAINERS)

[Chad Granum <exodist@cpan.org>](#Chad)

# [AUTHORS](#AUTHORS)

[Chad Granum <exodist@cpan.org>](#Chad~2)

# [COPYRIGHT](#COPYRIGHT)

Copyright 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/*

2026-10-19 perl v5.44.0

---

Document: Test2::Manual::Tooling::Plugin::ToolStarts(3pm) from perl-test-simple 1.302226-r0 (Chainguard OS)
Source: https://github.com/Test-More/test-more