The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Test::Builder2::Event::SetPlan - Set the plan for the current stream

DESCRIPTION

This is an Event indicating that the test plan for the current stream has been set.

It must come between a stream start and an stream end Event.

There should be only one plan per stream. An exception is that a no_plan can be followed by a more restrictive plan.

METHODS

Attributes

asserts_expected

The total number of asserts expected to be in this stream.

Must be a positive integer or 0.

Defaults to 0.

no_plan

If true, there is explicitly no plan for this stream. Any positive number of asserts is fine.

Defaults to false.

skip

If true, it indicates that the rest of the asserts in the stream will not be executed. Usually because they would not make sense in the current environment (Unix tests on Windows, for example).

No results should follow in this stream.

Defaults to false.

skip_reason

The reason the stream has been skipped.

Defaults to empty string.

plan

A hash ref containing any further information about the plan.

Defaults to an empty hash ref.

event_type

The event type is set plan.

SEE ALSO

Test::Builder2::Event

1;