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
|
# Shared code for Net::Remctl tests.
#
# This is a small helper library intended only for use internally by the
# Net::Remctl test suite that contains functions useful in more than one
# test.
#
# This code uses the PerlIO feature of opening a file descriptor to a scalar.
# This may not work with versions of Perl built without PerlIO, which was more
# common prior to 5.8.
#
# SPDX-License-Identifier: MIT
package Test::Remctl;
use 5.010;
use strict;
use warnings;
use base qw(Exporter);
# Declare variables that should be set in BEGIN for robustness.
our (@EXPORT_OK, $VERSION);
# Set $VERSION and everything export-related in a BEGIN block for robustness
# against circular module loading (not that we load any modules, but
# consistency is good).
BEGIN {
@EXPORT_OK = qw(run_wrapper);
# This version is somewhat arbitrary and doesn't track the broader remctl
# version. I update it when code in this module changes.
$VERSION = '1.02';
}
# Run the backend and capture its output and return status.
#
# $backend - The Net::Remctl::Backend object
# @args - Arguments to treat like command-line arguments to the backend
#
# Returns: List of the stdout output, the stderr output, and the return status
sub run_wrapper {
my ($backend, @args) = @_;
my $output = q{};
my $error = q{};
# Save STDOUT and STDERR and redirect to scalars.
open(my $oldout, '>&', \*STDOUT) or BAIL_OUT("Cannot save STDOUT: $!");
open(my $olderr, '>&', \*STDERR) or BAIL_OUT("Cannot save STDERR: $!");
close(STDOUT) or BAIL_OUT("Cannot close STDOUT: $!");
close(STDERR) or BAIL_OUT("Cannot close STDERR: $!");
open(STDOUT, '>', \$output) or BAIL_OUT("Cannot redirect STDOUT: $!");
open(STDERR, '>', \$error) or BAIL_OUT("Cannot redirect STDERR: $!");
# Run the backend.
my $status = eval { $backend->run(@args) };
if ($@) {
print {*STDERR} $@ or BAIL_OUT("Cannot write to STDERR: $!");
$status = 255;
}
# Restore STDOUT and STDERR.
open(STDOUT, '>&', $oldout) or BAIL_OUT("Cannot restore STDOUT: $!");
open(STDERR, '>&', $olderr) or BAIL_OUT("Cannot restore STDERR: $!");
close($oldout) or BAIL_OUT("Cannot close duplicate STDOUT: $!");
close($olderr) or BAIL_OUT("Cannot close duplicate STDERR: $!");
# Return the results.
return ($output, $error, $status);
}
1;
__END__
=for stopwords
Allbery ARG MERCHANTABILITY NONINFRINGEMENT sublicense
=head1 NAME
Test::Remctl - Helper functions for Net::Remctl tests
=head1 SYNOPSIS
use Test::Remctl qw(run_wrapper);
# Some existing Net::Remctl::Backend object.
my $backend;
# Call run() while capturing stdout, stderr, and exceptions.
my ($output, $error, $status) = run_wrapper($backend, 'foo');
=head1 DESCRIPTION
This module accumulates various helper functions for Net::Remctl tests.
It is not expected to be used outside of the Net::Remctl test suite.
=head1 FUNCTIONS
=over 4
=item run_wrapper(BACKEND, COMMAND[, ARG ...])
Calls Net::Remctl::Backend::run() but captures standard output, standard
error, and any exceptions. Returns the standard output, the standard
error, and the return status as a list. Any exceptions are caught and
the exception is added to standard error. If run() exited with an
exception, the exit status will always be set to 255.
=back
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
Copyright 2020, 2022 Russ Allbery <eagle@eyrie.org>
Copyright 2012-2013 The Board of Trustees of the Leland Stanford Junior
University
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
=cut
# Local Variables:
# copyright-at-end-flag: t
# End:
|
