Apache::TestUtil(3) User Contributed Perl Documentation Apache::TestUtil(3)
NAME
Apache::TestUtil - Utility functions for writing tests
SYNOPSIS
use Apache::Test;
use Apache::TestUtil;
ok tcmp("foo", "foo", "sanity check");
twritefile("filename", @content);
my $fh = topenfile($filename);
tmkdir("/foo/bar");
trmtree("/foo/bar");
tisequal($a, $b);
DESCRIPTION
"Apache::TestUtil" automatically exports a number of functions useful
in writing tests.
All the files and directories created using the functions from this
package will be automatically destroyed at the end of the program
execution (via END block). You should not use these functions other
than from within tests which should cleanup all the created directories
and files at the end of the test.
FFUUNNCCTTIIOONNSS
tcmp()
tcmp($received, $expected, $comment);
tcmp() prints the values of $comment, $expected and $received.
e.g.:
tcmp(1, 1, "1 == 1?");
prints:
# testing : 1 == 1?
# expected: 1
# received: 1
then it returns the result of comparison of the $expected and the
$received variables. Usually, the return value of this function is
fed directly to the ok() function, like this:
ok tcmp(1, 1, "1 == 1?");
the third argument ($comment) is optional, mostly useful for
telling what the comparison is trying to do.
It is valid to use "undef" as an expected value. Therefore:
my $foo;
tcmp(undef, $foo, "undef == undef?");
will return a true value.
You can compare any two data-structures with tcmp(). Just make
sure that if you pass non-scalars, you have to pass their
references. The datastructures can be deeply nested. For example
you can compare:
tcmp({1 => [2..3,{5..8}], 4 => [5..6]},
{1 => [2..3,{5..8}], 4 => [5..6]},
"hash of array of hashes");
You can also compare the second argument against the first as a
regex. Use the "qr//" function in the second argument. For example:
tcmp("abcd", qr/^abc/, "regex compare");
will do:
"abcd" =~ /^abc/;
This function is exported by default.
tfilepathcmp()
This function is used to compare two filepaths via tcmp(). For
non-Win32, it simply uses tcmp() for the comparison, but for
Win32, Win32::GetLongPathName() is invoked to convert the first two
arguments to their DOS long pathname. This is useful when there is
a possibility the two paths being compared are not both represented
by their long or short pathname.
This function is exported by default.
tdebug()
tdebug("testing feature foo");
tdebug("test", [1..3], 5, {a=>[1..5]});
tdebug() prints out any datastructure while prepending "#" at the
beginning of each line, to make the debug printouts comply with
"Test::Harness"'s requirements. This function should be always used
for debug prints, since if in the future the debug printing will
change (e.g. redirected into a file) your tests won't need to be
changed.
the special global variable $Apache::TestUtil::DEBUGOUTPUT can be
used to redirect the output from tdebug() and related calls such
as twritefile(). for example, from a server-side test you would
probably need to redirect it to STDERR:
sub handler {
plan $r, tests => 1;
local $Apache::TestUtil::DEBUGOUTPUT = \*STDERR;
twritefile('/tmp/foo', 'bar');
...
}
left to its own devices, tdebug() will collide with the standard
HTTP protocol during server-side tests, resulting in a situation
both confusing difficult to debug. but STDOUT is left as the
default, since you probably don't want debug output under normal
circumstances unless running under verbose mode.
This function is exported by default.
twritefile()
twritefile($filename, @lines);
twritefile() creates a new file at $filename or overwrites the
existing file with the content passed in @lines. If only the
$filename is passed, an empty file will be created.
If parent directories of $filename don't exist they will be
automagically created.
The generated file will be automatically deleted at the end of the
program's execution.
This function is exported by default.
tappendfile()
tappendfile($filename, @lines);
tappendfile() is similar to twritefile(), but it doesn't
clobber existing files and appends @lines to the end of the file.
If the file doesn't exist it will create it.
If parent directories of $filename don't exist they will be
automagically created.
The generated file will be registered to be automatically deleted
at the end of the program's execution, only if the file was created
by tappendfile().
This function is exported by default.
twriteshellscript()
Apache::TestUtil::twriteshellscript($filename, @lines);
Similar to twritefile() but creates a portable shell/batch
script. The created filename is constructed from $filename and an
appropriate extension automatically selected according to the
platform the code is running under.
It returns the extension of the created file.
twriteperlscript()
Apache::TestUtil::twriteperlscript($filename, @lines);
Similar to twritefile() but creates a executable Perl script with
correctly set shebang line.
topenfile()
my $fh = topenfile($filename);
topenfile() opens a file $filename for writing and returns the
file handle to the opened file.
If parent directories of $filename don't exist they will be
automagically created.
The generated file will be automatically deleted at the end of the
program's execution.
This function is exported by default.
tmkdir()
tmkdir($dirname);
tmkdir() creates a directory $dirname. The operation will fail if
the parent directory doesn't exist.
If parent directories of $dirname don't exist they will be
automagically created.
The generated directory will be automatically deleted at the end of
the program's execution.
This function is exported by default.
trmtree()
trmtree(@dirs);
trmtree() deletes the whole directories trees passed in @dirs.
This function is exported by default.
tchown()
Apache::TestUtil::tchown($file);
Change ownership of $file to the test's User/Group. This function
is noop on platforms where chown(2) is unsupported (e.g. Win32).
tisequal()
tisequal($a, $b);
tisequal() compares any two datastructures and returns 1 if they
are exactly the same, otherwise 0. The datastructures can be nested
hashes, arrays, scalars, undefs or a combination of any of these.
See tcmp() for an example.
If $b is a regex reference, the regex comparison "$a =~ $b" is
performed. For example:
tisequal($serverversion, qr{^Apache});
If comparing non-scalars make sure to pass the references to the
datastructures.
This function is exported by default.
tserverlogerrorisexpected()
If the handler's execution results in an error or a warning logged
to the errorlog file which is expected, it's a good idea to have a
disclaimer printed before the error itself, so one can tell real
problems with tests from expected errors. For example when testing
how the package behaves under error conditions the errorlog file
might be loaded with errors, most of which are expected.
For example if a handler is about to generate a run-time error,
this function can be used as:
use Apache::TestUtil;
...
sub handler {
my $r = shift;
...
tserverlogerrorisexpected();
die "failed because ...";
}
After running this handler the errorlog file will include:
*** The following error entry is expected and harmless ***
[Tue Apr 01 14:00:21 2003] [error] failed because ...
When more than one entry is expected, an optional numerical
argument, indicating how many entries to expect, can be passed. For
example:
tserverlogerrorisexpected(2);
will generate:
*** The following 2 error entries are expected and harmless ***
If the error is generated at compile time, the logging must be done
in the BEGIN block at the very beginning of the file:
BEGIN {
use Apache::TestUtil;
tserverlogerrorisexpected();
}
use DOESNOTexist;
After attempting to run this handler the errorlog file will
include:
*** The following error entry is expected and harmless ***
[Tue Apr 01 14:04:49 2003] [error] Can't locate "DOESNOTexist.pm"
in @INC (@INC contains: ...
Also see "tserverlogwarnisexpected()" which is similar but
used for warnings.
This function is exported by default.
tserverlogwarnisexpected()
"tserverlogwarnisexpected()" generates a disclaimer for
expected warnings.
See the explanation for "tserverlogerrorisexpected()" for more
details.
This function is exported by default.
tclientlogerrorisexpected()
"tclientlogerrorisexpected()" generates a disclaimer for
expected errors. But in contrast to
"tserverlogerrorisexpected()" called by the client side of the
script.
See the explanation for "tserverlogerrorisexpected()" for more
details.
For example the following client script fails to find the handler:
use Apache::Test;
use Apache::TestUtil;
use Apache::TestRequest qw(GET);
plan tests => 1;
tclientlogerrorisexpected();
my $url = "/errordocument/cannotbefound";
my $res = GET($url);
ok tcmp(404, $res->code, "test 404");
After running this test the errorlog file will include an entry
similar to the following snippet:
*** The following error entry is expected and harmless ***
[Tue Apr 01 14:02:55 2003] [error] [client 127.0.0.1]
File does not exist: /tmp/test/t/htdocs/error
When more than one entry is expected, an optional numerical
argument, indicating how many entries to expect, can be passed. For
example:
tclientlogerrorisexpected(2);
will generate:
*** The following 2 error entries are expected and harmless ***
This function is exported by default.
tclientlogwarnisexpected()
"tclientlogwarnisexpected()" generates a disclaimer for
expected warnings on the client side.
See the explanation for "tclientlogerrorisexpected()" for more
details.
This function is exported by default.
tcatfile('a', 'b', 'c')
This function is essentially "File::Spec->catfile", but on Win32
will use "Win32::GetLongpathName()" to convert the result to a long
path name (if the result is an absolute file). The function is not
exported by default.
tcatfileapache('a', 'b', 'c')
This function is essentially "File::Spec::Unix->catfile", but on
Win32 will use "Win32::GetLongpathName()" to convert the result to
a long path name (if the result is an absolute file). It is useful
when comparing something to that returned by Apache, which uses a
Unix-style specification with forward slashes for directory
separators. The function is not exported by default.
AUTHOR Stas Bekman
SEE ALSO
perl(1)
perl v5.8.8 2005-10-20 Apache::TestUtil(3)