NAME

Test::Stream::Workflow::Task - Compiled form of a unit.

EXPERIMENTAL CODE WARNING

This is an experimental release! Test-Stream, and all its components are still in an experimental phase. This dist has been released to cpan in order to allow testers and early adopters the chance to write experimental new tools with it, or to add experimental support for it into old tools.

PLEASE DO NOT COMPLETELY CONVERT OLD TOOLS YET. This experimental release is very likely to see a lot of code churn. API's may break at any time. Test-Stream should NOT be depended on by any toolchain level tools until the experimental phase is over.

DESCRIPTION

This object is a temporary object created by a runner to process Test::Stream::Workflow::Unit objects.

SYNOPSIS

You rarely encounter a task object, they are mainyl used under the hood. When you do get one you usually just want to call iterate() on it. This can be done by treating it as a coderef.

    $task->();

Or direcectly:

    $task->iterate();

METHODS

$task->run()

Run the task, this should only every be done by a runner.

$task->iterate()

Sometimes tasks are recursive. This method is how they resume running in a recursive structure.

$task->reset()

Reset the task. This is rarely needed.

$ar = $task->args()

Get the args that will be passed to the primary actions.

$bool = $task->finished()

Check if the task has finished running.

$bool = $task->no_final()

True if the task is not required to generate events.

$bool = $task->should_run()

True if there is still work to be done.

$bool = $task->subtest()

True if the task should produce a subtest.

$int = $task->events()

Number of events produced by the primary actions.

$int = $task->failed()

Number of failures produced inside the primary actions.

$int = $task->pending()

How many pending iterations remain.

$int = $task->stage()

What stage the task is in.

$msg = $task->exception()

If an exception has occured the message will be stored here.

$unit = $task->unit()

Get the unit the task wraps.

$runner = $task->runner()

Get the runner instance and/or class.

SOURCE

The source code repository for Test::Stream can be found at http://github.com/Test-More/Test-Stream/.

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2015 Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html