2 # Copyright (c) 2009, 2010 Zmanda, Inc. All Rights Reserved.
4 # This program is free software; you can redistribute it and/or modify it
5 # under the terms of the GNU General Public License version 2 as published
6 # by the Free Software Foundation.
8 # This program is distributed in the hope that it will be useful, but
9 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
10 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 # You should have received a copy of the GNU General Public License along
14 # with this program; if not, write to the Free Software Foundation, Inc.,
15 # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 # Contact information: Zmanda Inc, 465 S. Mathilda Ave., Suite 300
18 # Sunnyvale, CA 94086, USA, or: http://www.zmanda.com
26 Installcheck - utilities for installchecks (not installed)
32 my $testdir = "$Installcheck::TMP/mystuff/";
35 Amanda::Debug::dbopen("installcheck");
36 Installcheck::log_test_output();
40 Miscellaneous utilities for installchecks. No symbols are exported by default.
46 The temporary directory for installcheck data. This directory is created for you.
48 =item C<log_test_output()>
50 Calling this function causes status meesages from tests (e.g. "ok 1 - some test")
51 to be recorded in the debug logs. It should be called exactly once.
53 =item C<get_unused_port()>
55 Find a local TCP port that is currently unused and not listed in
56 C</etc/services>. This can still fail, if the port in question is bound by
57 another process between the call to C<get_unused_port()> and the port's
69 our @ISA = qw(Exporter);
70 our @EXPORT = qw( $srcdir );
74 our $TMP = "$AMANDA_TMPDIR/installchecks";
76 # the Makefile provides srcdir to us in most cases; if not, assume it's "."
77 our $srcdir = $ENV{'srcdir'} || '.';
79 # run this just before the script actually executes
80 # (not during syntax checks)
82 Amanda::Util::set_pname("$0");
88 my ($base, $count) = (10000, 10000);
90 my $tcp = getprotobyname('tcp');
92 # select ports randomly until we find one that is usable or have tried 1000
94 for ($i = 0; $i < 1000; $i++) {
95 my $port = int(rand($count)) + $base;
97 # have we already used it?
98 next if (grep { $_ == $port } @used_ports);
100 # is it listed in /etc/services?
101 next if (getservbyport($port, $tcp));
103 # can we bind() to it? (using REUSADDR so that the kernel doesn't reserve
104 # the port after we close it)
105 next unless socket(SOCK, PF_INET, SOCK_STREAM, $tcp);
106 next unless setsockopt(SOCK, SOL_SOCKET, SO_REUSEADDR, pack("l", 1));
107 next unless bind(SOCK, sockaddr_in($port, INADDR_ANY));
110 # it passed the gauntlet of tests, so the port is good
111 push @used_ports, $port;
115 die("could not find unused port");
118 sub log_test_output {
119 my $builder = Test::More->builder();
121 # not supported on perl-5.6
122 return if !$^V or $^V lt v5.8.0;
124 # wrap each filehandle used for output
125 foreach my $out (qw(output failure_output todo_output)) {
126 $builder->$out(Installcheck::TestFD->new($builder->$out));
130 package Installcheck::TestFD;
132 use base qw(Tie::Handle IO::Handle);
135 use Amanda::Debug qw(debug);
141 my ($class, $fh) = @_;
142 # save the underlying filehandle
143 my $o = {'fh' => $fh};
144 # must bless before tie()
146 # note that gensym is needed so we have something to tie()
148 tie(*$new_fh, $class, $o);
149 # note that the anonymous glob reference must be returned, so
150 # when 'print $fh "some string"' is used it works
155 my ($class, $o) = @_;
159 # other methods of IO::Handle or Tie::Handle may be called in theory,
160 # but in practice this seems to be all we need
164 reutrn $self->PRINT(@args);
168 my ($self, @msgs) = @_;
169 # log each line separately
170 foreach my $m (split("\n", join($, , @msgs))) {
173 # now call print on the wrapped filehandle
174 return $self->{'fh'}->print(@msgs);