The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

EXODIST / Test-Stream-1.302027 / lib / Test / Stream / Plugin / Capture.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

              
package Test::Stream::Plugin::Capture;
use strict;
use warnings;
use Test::Stream::Util qw/try/;
use Carp qw/croak/;
use Test::Stream::Exporter qw/import default_exports/;
default_exports qw/capture/;
no Test::Stream::Exporter;
sub capture(&) {
    my $code = shift;
    my ($err, $out) = ("", "");
    my ($ok, $e);
    {
        local *STDOUT;
        local *STDERR;
        ($ok, $e) = try {
            open(STDOUT, '>', \$out) or die "Failed to open a temporary STDOUT: $!";
            open(STDERR, '>', \$err) or die "Failed to open a temporary STDERR: $!";
            $code->();
        };
    }
    die $e unless $ok;
    return {
        STDOUT => $out,
        STDERR => $err,
    };
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Test::Stream::Plugin::Capture - Plugin for capturing STDERR and STDOUT.
=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
This plugin provides the C<capture { ... }> function which can be used to
capture all STDERR and STDOUT output from the code in the provided codeblock.
This will not intercept TAP output from Test::Stream itself, so it is safe to
run tests within the block.
=head1 SYNOPSIS
    is(
        capture {
            print STDERR "First STDERR\n";
            print STDOUT "First STDOUT\n";
            print STDERR "Second STDERR\n";
            print STDOUT "Second STDOUT\n";
        },
        {
            STDOUT => "First STDOUT\nSecond STDOUT\n",
            STDERR => "First STDERR\nSecond STDERR\n",
        },
        "Captured stdout and stderr"
    );
=head1 EXPORTS
=over 4
=item $out = capture { ... }
Captures all STDERR and STDOUT output within the codeblock. C<$out> will be a
hashref with STDERR and STDOUT as keys. All output is combined into a single
string per handle.
=back
=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