GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TEST2::TOOLS::GRAB (3)

.ds Aq ’

NAME

Test2::Tools::Grab - Temporarily intercept all events without adding a scope level.

CONTENTS

DESCRIPTION

This package provides a function that returns an object that grabs all events. Once the object is destroyed events will once again be sent to the main hub.

SYNOPSIS



    use Test2::Tools::Grab;

    my $grab = grab();

    # Generate some events, they are intercepted.
    ok(1, "pass");
    ok(0, "fail");

    my $events_a = $grab->flush;

    # Generate some more events, they are intercepted.
    ok(1, "pass");
    ok(0, "fail");

    my $events_b = $grab->finish;



EXPORTS

$grab = grab() This lets you intercept all events for a section of code without adding anything to your call stack. This is useful for things that are sensitive to changes in the stack depth.



    my $grab = grab();
        ok(1, foo);
        ok(0, bar);

    my $events = $grab->finish;

    is(@$events, 2, "grabbed 2 events.");



If the $grab object is destroyed without calling finish(), it will automatically clean up after itself and restore the parent hub.



    {
        my $grab = grab();
        # Things are grabbed
    }
    # Things are back to normal



By default the hub used has no_ending set to true. This will prevent the hub from enforcing that you issued a plan and ran at least 1 test. You can turn enforcement back one like this:



    $grab->hub->set_no_ending(0);



With no_ending turned off, finish will run the post-test checks to enforce the plan and that tests were run. In many cases this will result in additional events in your events array.

SEE ALSO

Test2::Util::Grabber - The object constructed and returned by this tool.

SOURCE

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

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2015 Chad Granum <exodist7@gmail.com>.

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/

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TEST2::TOOLS::GRAB (3) 2016-03-20

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.