Test2::Manual::Testing::Todo - Tutorial for marking tests as TODO.
This tutorial covers the process of marking tests as TODO. It also describes
how TODO works under the hood.
use Test2::Tools::Basic qw/todo/;
This form is low-magic. All tests inside the block are marked as todo, tests
outside the block are not todo. You do not need to do any variable management.
The flaw with this form is that it adds a couple levels to the stack, which can
break some high-magic tests.
Overall this is the preferred form unless you have a special case that requires
the variable form.
todo "Reason for the todo" => sub {
ok(0, "fail but todo");
...
};
This form maintains the todo scope for the life of the variable. This is useful
for tests that are sensitive to scope changes. This closely emulates the
the Test::More manpage style which localized the $TODO package variable. Once the
variable is destroyed (set it to undef, scope end, etc) the TODO state ends.
my $todo = todo "Reason for the todo";
ok(0, "fail but todo");
...
$todo = undef;
use Test2::API qw/context/;
sub todo_ok {
my ($bool, $name, $todo) = @_;
my $ctx = context();
$ctx->send_event('Ok', pass => $bool, effective_pass => 1, todo => $todo);
$ctx->release;
return $bool;
}
The the Test2::Event::Ok manpage event has a todo field which should have the todo
reason. The event also has the pass and effective_pass fields. The
pass field is the actual pass/fail value. The effective_pass is used to
determine if the event is an actual failure (should always be set tot true with
todo).
The the Test2::Todo manpage library gets the current the Test2::Hub manpage instance and adds a
filter. The filter that is added will set the todo and effective pass fields on
any the Test2::Event::Ok manpage events that pass through the hub. The filter also
converts the Test2::Event::Diag manpage events into the Test2::Event::Note manpage events.
the Test2::Manual manpage - Primary index of the manual.
The source code repository for Test2-Manual can be found at
https://github.com/Test-More/Test2-Suite/.
- Chad Granum
-
- Chad Granum <exodist@cpan.org>Chad Granum
-
Copyright 2018 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 http://dev.perl.org/licenses/
|