.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perlbal::Test 3pm"
.TH Perlbal::Test 3pm "2022-06-28" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Perlbal::Test \- Test harness for perlbal server
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
#  my \f(CW$msock\fR = \fBPerlbal::Test::start_server()\fR;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Perlbal::Test provides access to a perlbal server running on the
local host, for testing purposes.
.PP
The server can be an already-existing server, a child process, or
the current process.
.PP
Various functions are provided to interact with the server.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SH "\fI\fP\f(BImgmt_port()\fP\fI\fP"
.IX Header "mgmt_port()"
Return the current management port number.
.SH "\fIdump_res($http_response)\fP"
.IX Header "dump_res($http_response)"
Return a readable string formatted from an HTTP::Response object.
Only the first 80 characters of returned content are returned.
.SH "\fI\fP\f(BItempdir()\fP\fI\fP"
.IX Header "tempdir()"
Return a newly created temporary directory. The directory will be
removed automatically upon program exit.
.SH "\fI\fP\f(BInew_port()\fP\fI\fP"
.IX Header "new_port()"
Return the next free port number in the series. Port numbers are assigned
starting at 60000.
.SH "\fI\fP\f(BItest_port()\fP\fI\fP"
.IX Header "test_port()"
Return 1 if the port is free to use for listening on \f(CW$free_port\fR else return 0.
.SH "\fIfilecontent($file\fP>"
.IX Header "filecontent($file>"
Return a string containing the contents of the file \f(CW$file\fR. If \f(CW$file\fR
cannot be opened, then return undef.
.SH "\fIforeach_aio($callback)\fP"
.IX Header "foreach_aio($callback)"
Set the server into each \s-1AIO\s0 mode (none, ioaio) and call the specified
callback function with the mode name as argument.
.SH "\fImanage($cmd, \fP\f(CI%opts\fP\fI)\fP"
.IX Header "manage($cmd, %opts)"
Send a command \f(CW$cmd\fR to the server, and return the response line from
the server.
.PP
Optional arguments are:
.PP
.Vb 1
\&  quiet_failure => 1
.Ve
.PP
Output a warning if the response indicated an error,
unless \f(CW$opts\fR{quiet_failure} is true, or the command
was 'shutdown' (which doesn't return a response).
.SH "\fImanage_multi($cmd)\fP"
.IX Header "manage_multi($cmd)"
Send a command \f(CW$cmd\fR to the server, and return a multi-line
response. Return the number zero if there was an error or
no response.
.SH "\fIstart_server($conf)\fP"
.IX Header "start_server($conf)"
Optionally start a perlbal server and return a socket connected to its
management port.
.PP
The argument \f(CW$conf\fR is a string specifying initial configuration
commands.
.PP
If the environment variable \s-1TEST_PERLBAL_FOREGROUND\s0 is set to a true
value then a server will be started in the foreground, in which case
this function does not return. When the server function finishes,
\&\fBexit()\fR will be called to terminate the process.
.PP
If the environment variable \s-1TEST_PERLBAL_USE_EXISTING\s0 is set to a true
value then a socket will be returned which is connected to an existing
server's management port.
.PP
Otherwise, a child process is forked and a socket is returned which is
connected to the child's management port.
.PP
The management port is assigned automatically, a new port number each
time this function is called. The starting port number is 60000.
.SH "\fI\fP\f(BImsock()\fP\fI\fP"
.IX Header "msock()"
Return a reference to the socket connected to the server's management
port.
.SH "\fI\fP\f(BIua()\fP\fI\fP"
.IX Header "ua()"
Return a new instance of LWP::UserAgent.
.SH "\fIwait_on_child($pid, \fP\f(CI$port\fP\fI)\fP"
.IX Header "wait_on_child($pid, $port)"
Return a socket which is connected to a child process.
.PP
\&\f(CW$pid\fR specifies the child process id, and \f(CW$port\fR is the port number on
which the child is listening.
.PP
Several attempts are made; if the child dies or a connection cannot
be made within 5 seconds then this function dies with an error message.
.SH "\fIresp_from_sock($sock)\fP"
.IX Header "resp_from_sock($sock)"
Read an \s-1HTTP\s0 response from a socket and return it
as an HTTP::Response object
.PP
In scalar mode, return only the \f(CW$http_response\fR object.
.PP
In array mode, return an array of ($http_response, \f(CW$firstline\fR) where
\&\f(CW$firstline\fR is the first line read from the socket, for example:
.PP
\&\*(L"\s-1HTTP/1.1 200 OK\*(R"\s0