NAME

Test::Stream::Workflow::Meta - Meta-data for tests using workflows

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

When a test package uses workflows it needs a place to hold the primary unit. This meta-data holds the primary unit for test packages. It also takes care of ensuring they get run at the correct times.

METHODS

CLASS METHODS

$meta = $CLASS->build($pkg, $file, $start_line, $end_line)

Create a meta-instance for the specified package. If one already exists it will return the existing one instead, ignoring all arguments other than $pkg.

$meta = $CLASS->get($pkg)

Get the existing meta-instance for the specified package. This will return undef if none exists.

$meta = $CLASS->purge($pkg)

Delete the meta-instance for the specified package. The instance will be returned, but will no longer be tied to the package.

OBJECT METHODS

$unit = $meta->unit
$meta->set_unit($unit)

Get/Set the associated unit (Test::Stream::Workflow::Unit).

$runner = $meta->runner
$meta->set_runner($runner)

Get/Set the runner to use (Test::Stream::Workflow::Runner).

$ar = $meta->runner_args
$meta->set_runner_args([...])

Get/Set the args arrayref to be passed to the runner.

$bool = $meta->autorun
$meta->set_autorun($bool)

Defaults to true. Set this to 0 to turn off automatic running of the workflow.

$meta->run()

Run the workflow.

$meta->purge()

Remove the meta object from the package it was created for.

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