.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Apache::TestConfig 3pm"
.TH Apache::TestConfig 3pm 2024-01-10 "perl v5.38.2" "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
Apache::TestConfig \-\- Test Configuration setup module
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Apache::TestConfig;
\&
\&  my $cfg = Apache::TestConfig\->new(%args)
\&  my $fh = $cfg\->genfile($file);
\&  $cfg\->writefile($file, $content);
\&  $cfg\->gendir($dir);
\&  ...
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Apache::TestConfig\*(C'\fR is used in creating the \f(CW\*(C`Apache::Test\*(C'\fR
configuration files.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP \fBgenwarning()\fR 4
.IX Item "genwarning()"
.Vb 1
\&  my $warn = $cfg\->genwarning($filename)
.Ve
.Sp
\&\fBgenwarning()\fR returns a warning string as a comment, saying that the
file was autogenerated and that it's not a good idea to modify this
file. After the warning a perl trace of calls to this this function is
appended. This trace is useful for finding what code has created the
file.
.Sp
.Vb 1
\&  my $warn = $cfg\->genwarning($filename, $from_filename)
.Ve
.Sp
If \f(CW$from_filename\fR is specified it'll be used in the warning to tell
which file it was generated from.
.Sp
\&\fBgenwarning()\fR automatically recognizes the comment type based on the
file extension. If the extension is not recognized, the default \f(CW\*(C`#\*(C'\fR
style is used.
.Sp
Currently it support \f(CW\*(C`<!\-\- \-\->\*(C'\fR, \f(CW\*(C`/* ... */\*(C'\fR and \f(CW\*(C`#\*(C'\fR
styles.
.IP \fBgenfile()\fR 4
.IX Item "genfile()"
.Vb 1
\&  my $fh = $cfg\->genfile($file);
.Ve
.Sp
\&\fBgenfile()\fR creates a new file \f(CW$file\fR for writing and returns a file
handle.
.Sp
If parent directories of \f(CW$file\fR don't exist they will be
automagically created.
.Sp
The file \f(CW$file\fR and any created parent directories (if found empty)
will be automatically removed on cleanup.
.Sp
A comment with a warning and calls trace is added to the top of this
file. See \fBgenwarning()\fR for more info about this comment.
.Sp
.Vb 1
\&  my $fh = $cfg\->genfile($file, $from_file);
.Ve
.Sp
If \f(CW$from_filename\fR is specified it'll be used in the warning to tell
which file it was generated from.
.Sp
.Vb 1
\&  my $fh = $cfg\->genfile($file, $from_file, $nowarning);
.Ve
.Sp
If \f(CW$nowarning\fR is true, the warning won't be added. If using this
optional argument and there is no \f(CW$from_file\fR you must pass undef as
in:
.Sp
.Vb 1
\&  my $fh = $cfg\->genfile($file, undef, $nowarning);
.Ve
.IP \fBwritefile()\fR 4
.IX Item "writefile()"
.Vb 1
\&  $cfg\->writefile($file, $content, [$nowarning]);
.Ve
.Sp
\&\fBwritefile()\fR creates a new file \f(CW$file\fR with the content of
\&\f(CW$content\fR.
.Sp
A comment with a warning and calls trace is added to the top of this
file unless \f(CW$nowarnings\fR is passed and set to a true value. See
\&\fBgenwarning()\fR for more info about this comment.
.Sp
If parent directories of \f(CW$file\fR don't exist they will be
automagically created.
.Sp
The file \f(CW$file\fR and any created parent directories (if found empty)
will be automatically removed on cleanup.
.IP \fBwrite_perlscript()\fR 4
.IX Item "write_perlscript()"
.Vb 1
\&  $cfg\->write_perlscript($filename, @lines);
.Ve
.Sp
Similar to \fBwritefile()\fR but creates an executable Perl script with
correctly set shebang line.
.IP \fBgendir()\fR 4
.IX Item "gendir()"
.Vb 1
\&  $cfg\->gendir($dir);
.Ve
.Sp
\&\fBgendir()\fR creates a new directory \f(CW$dir\fR.
.Sp
If parent directories of \f(CW$dir\fR don't exist they will be
automagically created.
.Sp
The directory \f(CW$dir\fR and any created parent directories will be
automatically removed on cleanup if found empty.
.SH "Environment Variables"
.IX Header "Environment Variables"
The following environment variables affect the configuration and the
run-time of the \f(CW\*(C`Apache::Test\*(C'\fR framework:
.SS APACHE_TEST_COLOR
.IX Subsection "APACHE_TEST_COLOR"
To aid visual control over the configuration process and the run-time
phase, \f(CW\*(C`Apache::Test\*(C'\fR uses coloured fonts when the environment
variable \f(CW\*(C`APACHE_TEST_COLOR\*(C'\fR is set to a true value.
.SS APACHE_TEST_LIVE_DEV
.IX Subsection "APACHE_TEST_LIVE_DEV"
When using \f(CW\*(C`Apache::Test\*(C'\fR during the project development phase, it's
often convenient to have the \fIproject/lib\fR (live) directory appearing
first in \f(CW@INC\fR so any changes to the Perl modules, residing in it,
immediately affect the server, without a need to rerun \f(CW\*(C`make\*(C'\fR to
update \fIblib/lib\fR. When the environment variable
\&\f(CW\*(C`APACHE_TEST_LIVE_DEV\*(C'\fR is set to a true value during the
configuration phase (\f(CW\*(C`t/TEST \-config\*(C'\fR, \f(CW\*(C`Apache::Test\*(C'\fR will
automatically unshift the \fIproject/lib\fR directory into \f(CW@INC\fR, via
the autogenerated \fIt/conf/modperl_inc.pl\fR file.
.SH "Special Placeholders"
.IX Header "Special Placeholders"
When generating configuration files from the \fI*.in\fR templates,
special placeholder variables get substituted. To embed a placeholder
use the \f(CW\*(C`@foo@\*(C'\fR syntax. For example in \fIextra.conf.in\fR you can
write:
.PP
.Vb 1
\&  Include @ServerRoot@/conf/myconfig.conf
.Ve
.PP
When \fIextra.conf\fR is generated, \f(CW\*(C`@ServerRoot@\*(C'\fR will get replaced
with the location of the server root.
.PP
Placeholders are case-insensitive.
.PP
Available placeholders:
.SS "Configuration Options"
.IX Subsection "Configuration Options"
All configuration variables that can be passed to \f(CW\*(C`t/TEST\*(C'\fR, such as
\&\f(CW\*(C`MaxClients\*(C'\fR, \f(CW\*(C`DocumentRoot\*(C'\fR, \f(CW\*(C`ServerRoot\*(C'\fR, etc. To see the
complete list run:
.PP
.Vb 1
\&  % t/TEST \-\-help
.Ve
.PP
and you will find them in the \f(CW\*(C`configuration options\*(C'\fR sections.
.SS NextAvailablePort
.IX Subsection "NextAvailablePort"
Every time this placeholder is encountered it'll be replaced with the
next available port. This is very useful if you need to allocate a
special port, but not hardcode it. Later when running:
.PP
.Vb 1
\&  % t/TEST \-port=select
.Ve
.PP
it's possible to run several concurrent test suites on the same
machine, w/o having port collisions.
.SH AUTHOR
.IX Header "AUTHOR"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), \fBApache::Test\fR\|(3)