From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

EXODIST / Test-Stream-1.302027 / lib / Test / Stream / Plugin / AuthorTest.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
—
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

              
package Test::Stream::Plugin::AuthorTest;
use strict;
use warnings;
use Test::Stream::Context qw/context/;
use Test::Stream::Plugin qw/import/;
sub load_ts_plugin {
    my $class = shift;
    my ($caller, $var) = @_;
    $var ||= 'AUTHOR_TESTING';
    return if $ENV{$var};
    my $ctx = context();
    $ctx->plan(0, SKIP => "Author test, set the $var environment variable to run it");
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Test::Stream::Plugin::AuthorTest - Only run a test when AUTHOR_TESTING is true.
=head1 DEPRECATED
B<This distribution is deprecated> in favor of L<Test2>, L<Test2::Suite>, and
L<Test2::Workflow>.
See L<Test::Stream::Manual::ToTest2> for a conversion guide.
=head1 DESCRIPTION
It is common practice to write tests that are only run when the AUTHOR_TESTING,
or similar environment variable is set. This module automates the (admitedly
trivial) work of creating such a test.
=head1 SYNOPSIS
    use Test::Stream qw/... AuthorTest/;
    ...
    done_testing;
Or directly:
    use Test::Stream::Plugin::AuthorTest;
You can also specify a variable name to use instead of AUTHOR_TESTING
    use Test::Stream AuthorTest => ['THE_VAR'];
or
    use Test::Stream::Plugin::AuthorTest qw/THE_VAR/;
=head1 MANUAL
L<Test::Stream::Manual> is a good place to start when searching for
documentation.
=head1 SOURCE
The source code repository for Test::Stream can be found at
F<http://github.com/Test-More/Test-Stream/>.
=head1 MAINTAINERS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 AUTHORS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 COPYRIGHT
Copyright 2015 Chad Granum E<lt>exodist7@gmail.comE<gt>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See F<http://dev.perl.org/licenses/>
=cut