Test2::V1(3perl)

📦 version 5.44.0, in arch rolling

💖 NAME 💖

Test2::V1 — V1 edition of the Test2 recommended bundle. 🎀 (yes bestie, that's the Test2::V1(3perl) page you just opened, welcome)

✨ DESCRIPTION ✨

okay so. This is the first sequel to Test2::V0. And like, for new tests? This one is the recommended one over Test2::V0. Periodt. 🫶

🦋 Key differences from `Test2::V0`

Only 1 export by default: T2()
No pragmas by default
srand and utf8 are not enabled by default
Easy to still import everything
East to still enable pragmas

👑 NAMING, USING, DEPENDING 👑

This bundle should not change in a severely incompatible way. Some minor breaking changes, specially bugfixes, may be allowed. But if breaking changes are actually needed, then a new Test2::V#" module should be released instead. Like, ship a whole new letter, don't just jump-scare the existing one. 💅

Adding new optional exports, and new methods on the T2() handle, are not considered breaking changes, and are allowed without bumping the V# number. Adding new plugin shortcuts is also allowed, but they cannot be added to the -P or -plugins shortcuts without a bump in V# number. No sneaky additions to the shortcut list, iykyk. 🙈

As new V#" modules get released, old ones may be moved to different cpan distributions. So you should always use a specific bundle version and list that version in your distribution's testing requirements. You should never simply list Test2::Suite as your module's dep — instead list the specific bundle, or the tools and plugins you use directly, in your metadata. fr fr, pin your stuff. 🧚

See the "JUSTIFICATION" section for an explanation of why Test2::V1 was created.

🌸 SYNOPSIS 🌸

💅 RECOMMENDED

use Test2::V1 -utf8;

T2->ok(1, "pass");

T2->is({1 => 1}, {1 => 1}, "Structures Match");

# Note that prototypes do not work in method form:
my @foo = (1, 2, 3);
T2->is(scalar(@foo), 3, "Needed to force scalar context");

T2->done_testing;

🎀 WORK LIKE V0 DID

use Test2::V1 -ipP;

ok(1, "pass");

is({1 => 1}, {1 => 1}, "Structures Match");

my @foo = (1, 2, 3);
is(@foo, 3, "Prototype forces @foo into scalar context");

# You still have access to T2
T2->ok(1, "Another Pass");

done_testing;

The -ipP argument is short for -include, -pragmas, -plugins which together enable all pragmas, plugins, and import all symbols. It's giving "give me everything" energy and honestly? valid.

Note: The order in which i, p, and P appear is not important; -Ppi and -piP and any other order are all perfectly valid. 🌈

💜 IMPORT ARGUMENT GUIDE 💜

-P or -plugins — shortcut to include the following plugins: Test2::Plugin::UTF8, Test2::Plugin::SRand, Test2::Plugin::ExitSummary.
-p or -pragmas — shortcut to enable the following pragmas: strict, warnings.
-i or -import — shortcut to import all possible exports.
-x — shortcut to import any sub that has & in its prototype, things like dies { ... }, warns { ... }, etc.

While these can be used in method form — T2->dies(sub { ... }) — it is a little less convenient than having them imported. -x will import all of these, and any added in the future or included via an -include => ... import argument.

-ipP, -pPi, -pP, -Pix, etc.. — the i, p, P, and x short options may all be grouped in any order following a single dash. Mix and match, bestie. 🍓
@EXPORT_LIST — any arguments provided that are not prefixed with a - will be assumed to be export requests. If there is an exported sub by the given name it will be imported into your namespace. If there is no such sub, an exception will be thrown. 😭
!EXPORT_NAME — you can prefix an export name with ! to exclude it at import time. This is really only usedul when combined with -import or -i.
EXPORT_NAME => { -as => "ALT_NAME" }
EXPORT_NAME => { -prefix => "PREFIX_" }
EXPORT_NAME => { -postfix => "_POSTFIX" }

You may specify a hashref after an export name to rename it, or add a prefix/postfix to the name. Rename your faves, no cap. ✨

🫶 RENAMING IMPORTS 🫶

use Test2::V1 '-import', '!ok', ok => {-as => 'my_ok'};

Explanation:

-import — bring in ALL imports, no need to list them all by hand.
!ok — do not import ok() (remove it from the list added by -import)
ok => {-as => 'my_ok'} — actually, go ahead and import ok() but under the name my_ok().

If you did not add the '!ok' argument then you would have both ok() and my_ok(). Choices, choices. 💀

🌈 PRAGMAS AND PLUGINS 🌈

NO PRAGMAS ARE ENABLED BY DEFAULT ONLY THE EXIT SUMMARY PLUGIN IS STILL ENABLED BY DEFAULT

This is a significant departure from Test2::V0. bestie it really said "figure it out yourself" and honestly? iconic.

You can enable all of these with the -pP argument, which is short for -plugins, -pragmas. P is short for plugins, and p is short for pragmas. When using the single-letter form they may both be together following a single dash, and can be in any order. They may also be combined with i to bring in all imports. -p or -P ont heir own are also perfectly valid.

🍓 `strict`

You can enable this with any of these arguments: -strict, -p, -pragmas.

This enables strict for you.

🌸 `warnings`

You can enable this with any of these arguments: -warnings, -p, -pragmas.

This enables warnings for you.

⭐ `srand`

You can enable this in multiple ways:

use Test2::V1 -srand
use Test2::V1 -P
use Test2::V1 -plugins

See Test2::Plugin::SRand.

This will set the random seed to today's date. 📅

You can also set a random seed:

use Test2::V1 -srand => { seed => 'my seed' };

🦋 `utf8`

You can enable this in multiple ways:

use Test2::V1 -utf8
use Test2::V1 -P
use Test2::V1 -plugins

See Test2::Plugin::UTF8.

This will set the file, and all output handles (including formatter handles), to utf8. This will turn on the utf8 pragma for the current scope.

💖 `summary`

This is turned on by default.

You can avoid enabling it at import this way:

use Test2::V1 -summary => 0;

See Test2::Plugin::ExitSummary.

This plugin has no configuration. It just vibes. 🎀

🌱 ENVIRONMENT VARIABLES 🌱

See Test2::Env for a list of meaningful environment variables.

👑 API FUNCTIONS 👑

See Test2::API for these:

$ctx = T2->context()
$events = T2->intercept(sub { ... });

💅 THE T2() HANDLE 💅

The T2() subroutine imported into your namespace returns an instance of Test2::V1::Handle. This gives you a handle on all the tools included by default. It also creates a completely new namespace for use by your test that can have additional tools added to it. main character namespace energy, no cap. ✨

🎀 ADDING/OVERRIDING TOOLS IN YOUR T2 HANDLE 🎀

# Method 1
use Test2::V1 T2 => {
    include => [
        ['Test2::Tools::MyTool', 'my_tool', 'my_other_tool'],
        ['Data::Dumper', 'Dumper'],
    ],
};

# Method 2
use Test2::V1 T2 => {
    include => {
        'Test2::Tools::MyTool' => ['my_tool', 'my_other_tool'],
        'Data::Dumper'         => 'Dumper',
    },
};

# Method 3 (This also works with a hashref instead of an arrayref)
use Test2::V1 -include => [
    ['Test2::Tools::MyTool', 'my_tool', 'my_other_tool'],
    ['Data::Dumper', 'Dumper'],
];

# Method 4
T2->include('Test2::Tools::MyTool', 'my_tool', 'my_other_tool');
T2->include('Data::Dumper', 'Dumper');

# Using them:

T2->my_tool(...);

T2->Dumper({hi => 'there'});

Note that you MAY override original tools such as ok(), note(), etc. by importing different copies this way. The first time you do this there should be no warnings or errors. If you pull in multiple tools of the same name a redefinition warning is likely. 😬

This also effects exports:

use Test2::V1 -import, -include => ['Data::Dumper'];

print Dumper("Dumper can be imported from your include!");

🫶 OTHER HANDLE OPTIONS 🫶

use Test2::V1 T2 => {
    include   => $ARRAYREF_OR_HASHREF,
    namespace => $NAMESPACE,
    base      => $BASE_PACKAGE // 'Test2::V1::Base',
    stomp     => $BOOL,
};

include => $ARRAYREF_OR_HASHREF — see "ADDING TOOLS TO YOUR T2 HANDLE".
namespace => $NAMESPACE — normally a new namespace will be generated for you. You CANNOT rely on the package name being anything specific unless you provide your own.

The namespace here will be where any tools you include will be imported into. It will also have its base class set to the base class you specify, or the Test2::V1::Base module if you do not provide any.

If this namespace already has any symbols defined in it an exception will be thrown unless the stomp argument is set to true (not recommended).

stomp => $BOOL — used to allow the handle to stomp on an existing namespace (NOT RECOMMENDED). 💀
base => $BASE — set the base class from which functions should be inherited. Normally this is set to Test2::V1::Base.

Another interesting use case is to have multiple handles that use eachothers namespaces as base classes:

use Test2::V1;

use Test2::V1::Handle(
    'T3',
    base    => T2->HANDLE_NAMESPACE,
    include => {'Alt::Ok' => 'ok'};
);

T3->ok(1, "This uses ok() from Alt::Ok, but all other -> methods are the original");
T3->done_testing(); # Uses the original done_testing

🌈 EXAMPLE USE CASES 🌈

⭐ OVERRIDING INCLUDED TOOLS WITH ALTERNATES ⭐

Lets say you want to use the Test2::Warnings version of warning(), warnings() instead of the Test2::Tools::Warnings versions, and also wanted to import everything else Test2::Warnings provides.

use Test2::V1 -import, -include => ['Test2::Warnings'];

The -include => ['Test2::Warnings'] option means we want to import the default set of imports from Test2::Warnings into our T2() handle's private namespace. This will override any methods that were also previously defined by default. Swapping out the whole fit. 💅

The -import option means we want to import all subs into the current namespace. This includes anything we got from Test2::Warnings, and we will get the Test2::Warnings version of those subs.

like(
    warning { warn 'xxx' }, # This is the Test2::Warnings version of 'warning'
    qr/xxx/,
    "Got expected warning"
);

🧰 TOOLS

okay bestie, this is the motherlode 💅 every single tool Test2::V1 hands you lives right here, sorted into cute little bundles. Each bundle has a See ... line pointing at the module where that tool actually gets documented, so you can go deeper whenever you want 🌸

🎯 TARGET

added to Test::V1 in 1.302217 ✨

See Test2::Tools::Target.

You can point at a target class with the -target import argument. And heads up — if you don't give it a target, then $CLASS and CLASS() just won't get imported. No target, no class vars, that's the deal 🙈

use Test2::V1 -target => 'My::Class';

print $CLASS;  # My::Class
print CLASS(); # My::Class

Or you can hand it names instead 👑

use Test2::V1 -target => { pkg => 'Some::Package' };

pkg()->xxx; # Call 'xxx' on Some::Package
$pkg->xxx;  # Same

`$CLASS`

Package variable holding the target class name 💖

`$class = CLASS()`

Constant function that hands back the target class name 🎀

⏳ DEFER

See Test2::Tools::Defer.

`def $func => @args;`

added to Test::V1 in 1.302217 🦋

`do_def()`

also added to Test::V1 in 1.302217 🦋

✅ BASIC

See Test2::Tools::Basic.

`ok($bool, $name)` / `ok($bool, $name, @diag)`

added to Test::V1 in 1.302217 ✨

`pass($name)` / `pass($name, @diag)`

added to Test::V1 in 1.302217 ✨

`fail($name)` / `fail($name, @diag)`

added to Test::V1 in 1.302217 ✨

`diag($message)`

added to Test::V1 in 1.302217 💫

`note($message)`

added to Test::V1 in 1.302217 💫

`$todo = todo($reason)` / `todo $reason => sub { ... }`

added to Test::V1 in 1.302217 🎀

`skip($reason, $count)`

added to Test::V1 in 1.302217 🎀

`plan($count)`

added to Test::V1 in 1.302217 🌸

`skip_all($reason)`

added to Test::V1 in 1.302217 🌸

`done_testing()`

added to Test::V1 in 1.302217 🔥

`bail_out($reason)`

added to Test::V1 in 1.302217 🔥

🔍 COMPARE

See Test2::Tools::Compare.

ngl this is the biggest bundle and it's iconic — every single one of these landed in Test::V1 at 1.302217 👑

`is($got, $want, $name)`

added to Test::V1 in 1.302217 💖

`isnt($got, $do_not_want, $name)`

added to Test::V1 in 1.302217 💖

`like($got, qr/match/, $name)`

added to Test::V1 in 1.302217 💖

`unlike($got, qr/mismatch/, $name)`

added to Test::V1 in 1.302217 💖

`$check = match(qr/pattern/)`

added to Test::V1 in 1.302217 🦋

`$check = mismatch(qr/pattern/)`

added to Test::V1 in 1.302217 🦋

`$check = validator(sub { return $bool })`

added to Test::V1 in 1.302217 🦋

`$check = hash { ... }`

added to Test::V1 in 1.302217 🍓

`$check = array { ... }`

added to Test::V1 in 1.302217 🍓

`$check = bag { ... }`

added to Test::V1 in 1.302217 🍓

`$check = object { ... }`

added to Test::V1 in 1.302217 🍓

`$check = meta { ... }`

added to Test::V1 in 1.302217 🍓

`$check = number($num)`

added to Test::V1 in 1.302217 🌟

`$check = string($str)`

added to Test::V1 in 1.302217 🌟

`$check = bool($bool)`

added to Test::V1 in 1.302217 🌟

`$check = check_isa($class_name)`

added to Test::V1 in 1.302217 🌟

`$check = in_set(@things)`

added to Test::V1 in 1.302217 🌈

`$check = not_in_set(@things)`

added to Test::V1 in 1.302217 🌈

`$check = check_set(@things)`

added to Test::V1 in 1.302217 🌈

`$check = item($thing)`

added to Test::V1 in 1.302217 🎀

`$check = item($idx => $thing)`

added to Test::V1 in 1.302217 🎀

`$check = field($name => $val)`

added to Test::V1 in 1.302217 🎀

`$check = call($method => $expect)`

added to Test::V1 in 1.302217 💜

`$check = call_list($method => $expect)`

added to Test::V1 in 1.302217 💜

`$check = call_hash($method => $expect)`

added to Test::V1 in 1.302217 💜