Test2::Event::V2(3)

πŸ“¦ version 1.302214, in opensuse-leap 16.0

✨ NAME ✨

okay so real talk, bestie: this is the Test2::Event::V2(3) page from the User Contributed Perl Documentation, and it's literally about the second generation event. πŸ’…

Test2::Event::V2 β€” Second generation event. periodt. πŸ‘‘


🌸 DESCRIPTION 🌸

This is the event type you should be using instead of Test2::Event or its legacy subclasses. Like, it's the glow-up event class. no cap. ✨


πŸ¦‹ SYNOPSIS πŸ¦‹

πŸ’– USING A CONTEXT πŸ’–

use Test2::API qw/context/;

sub my_tool {
    my $ctx = context();

    my $event = $ctx->send_ev2(info => [{tag => 'NOTE', details => "This is a note"}]);

    $ctx->release;

    return $event;
}

πŸŽ€ USING THE CONSTRUCTOR πŸŽ€

use Test2::Event::V2;

my $e = Test2::Event::V2->new(
    trace => {frame => [$PKG, $FILE, $LINE, $SUBNAME]},
    info  => [{tag => 'NOTE', details => "This is a note"}],
);

πŸ’… METHODS πŸ’…

This class inherits from Test2::Event, iykyk.

  • $fd = $e->facet_data() β€” this returns a hashref of facet data. Each facet hash is a shallow copy of the original. 🫢
  • $about = $e->about() β€” this returns the 'about' facet hashref.
NOTE: this returns the internal hashref, not a copy. πŸ™ˆ
  • $trace = $e->trace() β€” this returns the 'trace' facet, normally blessed (but this is not enforced when the trace is set using set_trace()).
NOTE: this returns the internal trace, not a copy. πŸ’€

🧚 MUTATION 🧚

  • $e->add_amnesty({...}) β€” inherited from Test2::Event. This can be used to add 'amnesty' facets to an existing event. Each new item is added to the END of the list. πŸ“
NOTE: items ARE blessed when added. πŸ’–
  • $e->add_hub({...}) β€” inherited from Test2::Event. This is used by hubs to stamp events as they pass through. New items are added to the START of the list. ✨
NOTE: items ARE NOT blessed when added. 😭
  • $e->set_uuid($UUID) β€” inherited from Test2::Event, overridden to also vivify/mutate the 'about' facet. πŸ¦‹
  • $e->set_trace($trace) β€” inherited from Test2::Event which allows you to change the trace.
Note: this method does not bless/clone the trace for you. Many things will expect the trace to be blessed, so you should probably do that. πŸ’…

🌈 LEGACY SUPPORT METHODS 🌈

These are all imported from Test2::Util::Facets2Legacy, see that module or Test2::Event for documentation on what they do. πŸ‘‘

  • causes_fail
  • diagnostics
  • global
  • increments_count
  • no_display
  • sets_plan
  • subtest_id
  • summary
  • terminate

⭐ THIRD PARTY META-DATA ⭐

This object consumes Test2::Util::ExternalMeta which provides a consistent way for you to attach meta-data to instances of this class. This is useful for tools, plugins, and other extensions. 🫢


πŸ”₯ SOURCE πŸ”₯

The source code repository for Test2 can be found at <https://github.com/Test-More/test-more/>. πŸŽ€


πŸ‘‘ MAINTAINERS πŸ‘‘

Chad Granum <exodist@cpan.org> πŸ’œ


🌸 AUTHORS 🌸

Chad Granum <exodist@cpan.org> πŸ’–


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 <https://dev.perl.org/licenses/>. 🌈


okay bestie that's the whole iconique page πŸ’… it's perl v5.42.0, dated 2025-07-28, and the manual page is Test2::Event::V2(3). mwah, slay, bye! πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from