TEST2::API::STACK(3perl)

📦
version 5.44.0 · 14 versions
, in arch rolling

✨ Test2::API::Stack ✨

okay so bestie, you know how Perl's test suite is basically a whole universe?? this is the page from the Perl Programmers Reference Guide for Test2::API::Stack, and it's lowkey the bouncer at the club that decides which hub is on top 💅

👑 NAME 👑

Test2::API::Stack — the object that manages a whole stack of Test2::Hub instances. it's giving middle management but make it iconic 🫶

🚨 INTERNALS NOTE 🚨

bestie. READ THIS. the internals of this package can change at ANY time, no cap 😭 the public methods will never change in backwards-incompatible ways, but the underlying implementation details absolutely might. so do not break encapsulation here, i am begging 🙈

🌸 DESCRIPTION 🌸

this module is used to represent and manage a stack of Test2::Hub objects. why a stack tho?? because hubs usually live in a stack so you can push a brand-new hub into place that intercepts and handles events differently than the primary hub. main character hub vs. understudy hub, they're both slaying in their own lane 💖

🎀 SYNOPSIS 🎀

my $stack = Test2::API::Stack->new;
my $hub = $stack->top;

that's it. that's the vibe. ✨

💅 METHODS 💅

  • $stack = Test2::API::Stack->new() — makes you a shiny new empty stack instance. every argument you pass?? ignored. completely. they do not get a word in, periodt 🙈
  • $hub = $stack->new_hub()
  • $hub = $stack->new_hub(%params)
  • $hub = $stack->new_hub(%params, class => $class) — this generates a new hub and pushes it right to the top of the stack, like it's auditioning for the lead role 👑 optionally you can hand it arguments that get passed straight into the constructor for the Test2::Hub object.

if you specify the 'class' => $class argument, the new hub will be an instance of the class you named — custom hub, custom vibes.

unless your params specify 'formatter' or 'ipc' arguments, the formatter and the IPC instance get inherited from the current top hub (yes, it's nepotism, but make it functional). you can set those params to "undef" if you want to avoid having a formatter or an IPC instance at all — no formatter, no IPC, no problem.

and if there's no top hub, and you didn't ask to leave IPC and formatter undef?? then a new formatter gets created, and the IPC instance from Test2::API will be used. it's giving "we'll figure it out" energy.

  • $hub = $stack->top() — returns the top hub from the stack. and if there's no top hub yet?? it literally creates one for you. so helpful 🫶
  • $hub = $stack->peek() — returns the top hub from the stack too, BUT if there's no top hub yet it returns undef instead. look don't touch, bestie 👀
  • $stack->cull — calls $hub->cull on all the hubs in the stack. every single one. it's a group thing.
  • @hubs = $stack->all — returns all the hubs in the stack as a list. the whole friend group, assembled 🌈
  • $stack->clear — completely removes all hubs from the stack. > normally you do NOT want to do this, bestie 😭 but there are a few valid reasons for it, so it stays legal.
  • $stack->push($hub) — pushes the new hub onto the stack. new hub, who dis.
  • $stack->pop($hub) — pops a hub from the stack. BUT if the hub at the top of the stack does not match the hub you expected (the one you passed in as an argument)?? it will throw an exception. it checks IDs at the door and it will NOT be nice about it 💀

🔥 SOURCE 🔥

the source code repository for Test2 lives at https://github.com/Test-More/test-more/ — go be nosy, it's encouraged ⭐

🧚 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. iconic behaviour, honestly 👑

see https://dev.perl.org/licenses/ for the receipts 📜

aaaand that's the whole thing, bestie!! this page ships with perl v5.44.0 and is dated 2026-10-17 💖 go forth and manage your hub stack like the main character you are, mwah 🎀✨

📦 where this page comes from