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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
use strict;
use warnings;
package App::Cmd::Tester;
our $VERSION = 0.307;
=head1 NAME
App::Cmd::Tester - for capturing the result of running an app
=head1 SYNOPSIS
use Test::More tests => 4;
use App::Cmd::Tester;
use YourApp;
my $result = test_app(YourApp => [ qw(command --opt value) ]);
like($result->stdout, qr/expected output/, 'printed what we expected');
is($result->stderr, '', 'nothing sent to sderr');
is($result->error, undef, 'threw no exceptions');
my $result = test_app(YourApp => [ qw(command --opt value --quiet) ]);
is($result->output, '', 'absolutely no output with --quiet');
=head1 DESCRIPTION
One of the reasons that user-executed programs are so often poorly tested is
that they are hard to test. App::Cmd::Tester is one of the tools App-Cmd
provides to help make it easy to test App::Cmd-based programs.
It provides one routine: test_app.
=head1 METHODS
=head2 test_app
B<Note>: while C<test_app> is a method, it is by default exported as a
subroutine into the namespace that uses App::Cmd::Tester. In other words: you
probably don't need to think about this as a method unless you want to subclass
App::Cmd::Tester.
my $result = test_app($app_class => \@argv_contents);
This will locally set C<@ARGV> to simulate command line arguments, and will
then call the C<run> method on the given application class (or application).
Output to the standard output and standard error filehandles will be captured.
C<$result> is an App::Cmd::Tester::Result object, which has methods to access
the following data:
stdout - the output sent to stdout
stderr - the output sent to stderr
output - the combined output of stdout and stderr
error - the exception thrown by running the application, or undef
run_rv - the return value of the run method (generally irrelevant)
exit_code - the numeric exit code that would've been issued (0 is 'okay')
=cut
use Sub::Exporter::Util qw(curry_method);
use Sub::Exporter -setup => {
exports => { test_app => curry_method },
groups => { default => [ qw(test_app) ] },
};
our $TEST_IN_PROGRESS;
BEGIN {
*CORE::GLOBAL::exit = sub {
return CORE::exit(@_) unless $TEST_IN_PROGRESS;
App::Cmd::Tester::Exited->throw($_[0]);
};
}
sub result_class { 'App::Cmd::Tester::Result' }
sub test_app {
my ($class, $app, $argv) = @_;
require IO::TieCombine;
my $hub = IO::TieCombine->new;
my $stdout = tie local *STDOUT, $hub, 'stdout';
my $stderr = tie local *STDERR, $hub, 'stderr';
my $run_rv;
$app = $app->new unless ref($app) or $app->isa('App::Cmd::Simple');
my $ok = eval {
local $TEST_IN_PROGRESS = 1;
local @ARGV = @$argv;
$run_rv = $app->run;
1;
};
my $error = $ok ? undef : $@;
my $exit_code = defined $error ? ((0+$!)||-1) : 0;
if ($error and eval { $error->isa('App::Cmd::Tester::Exited') }) {
$exit_code = $$error;
}
$class->result_class->new({
app => $app,
stdout => $hub->slot_contents('stdout'),
stderr => $hub->slot_contents('stderr'),
output => $hub->combined_contents,
error => $error,
run_rv => $run_rv,
exit_code => $exit_code
});
}
{
package App::Cmd::Tester::Result;
sub new {
my ($class, $arg) = @_;
bless $arg => $class;
}
for my $attr (qw(app stdout stderr output error run_rv exit_code)) {
Sub::Install::install_sub({
code => sub { $_[0]->{$attr} },
as => $attr,
});
}
}
{
package App::Cmd::Tester::Exited;
sub throw {
my ($class, $code) = @_;
my $self = (bless \$code => $class);
die $self;
}
}
=head1 AUTHOR AND COPYRIGHT
Copyright 2008, (code (simply)). All rights reserved; App::Cmd and bundled
code are free software, released under the same terms as perl itself.
=cut
1;
|
