TEST2::EVENTFACET::PLAN(3perl)

📦
version 5.44.0 · 14 versions
, in arch rolling

💖 Test2::EventFacet::Plan — the plan facet, bestie 💖

okay so this is the manual page for Test2::EventFacet::Plan, from the 3perl section, and it's genuinely one of the shorter ones so we can vibe through it together no problem 🫶

✨ NAME ✨

Test2::EventFacet::Plan — it's the facet for setting the plan. that's it. that's the whole name. iconic of it honestly 💅

🌸 DESCRIPTION 🌸

so like… events use this facet when they need to set the plan. that's the tea. when something's gotta declare the plan, this is the lil facet that carries it 🎀

👑 FIELDS 👑

here's where it gets juicy. four fields. let's go bestie:

  • $string = $plan->{details} $string = $plan->details() — this is the human readable explanation for why the plan is being set. key word: human readable. and ngl, most formatters just straight up do NOT render this one — the only time it shows up is when the skip field is also set. so like, it's shy, it only comes out for the skip moment 🙈
  • $positive_int = $plan->{count} $positive_int = $plan->count() — this sets the number of expected assertions. note that it's a positive int. and when skip or none are also set, this should usually be set to 0. like, zero. nada. periodt ✨
  • $bool = $plan->{skip} $bool = $plan->skip() — when this is true, the ENTIRE test should be skipped. the whole thing. all of it 💀 and it's usually paired up with an explanation living in the details field, plus a control facet that has terminate set to 0. they're a little trio, they roll together 🦋
  • $bool = $plan->{none} $bool = $plan->none() — okay so this one is mainly used by legacy Test::Builder tests, the ones that set the plan to "no plan" — a whole construct that predates the much better done_testing(). so like, it's giving vintage, but not in a cute way 😭

and listen, the manpage has a very strong opinion here: if you are using this in non-legacy code, you may need to reconsider the course of your life, and maybe a hermitage would suite you? 💀 not me being read to filth by a Perl manpage. anyway, that's a direct quote of the energy, bestie, take it up with the docs 🧚

🌈 SOURCE 🌈

the source code repository for Test2 can be found at:

<https://github.com/Test-More/test-more/>

go look, it's right there, no cap 👑

💜 MAINTAINERS 💜

  • Chad Granum <exodist@cpan.org>

⭐ AUTHORS ⭐

  • Chad Granum <exodist@cpan.org>

(yes bestie, same person, they're carrying this whole thing, we love a main character 🫶)

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 that's the whole page!! and for the cute sign-off: this was perl v5.44.0, dated 2026-10-17, and we were reading Test2::...t::Plan(3perl) the whole time 🌸💖 slay, go set your plans correctly, ily ✨

📦 where this page comes from