.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "FunctionalTestCase 3pm"
.TH FunctionalTestCase 3pm "2006-07-23" "Lire 2.1.1" "LogReport's Lire 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"
Lire::Test::FunctionalTestCase \- Base class for writing functional unit tests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/ Lire::Test::FunctionalTestCase/;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Test::Unit::TestCase subclass which can be used to make it
easier to write functional tests.
.SS "\s-1WHAT\s0 \s-1ARE\s0 \s-1FUNCTIONAL\s0 \s-1TESTS\s0"
.IX Subsection "WHAT ARE FUNCTIONAL TESTS"
Unlike unit tests that test the semantics of the \s-1API\s0 and document the
internals assumptions, functional tests are tests that tests the
\&'functionality' of the overall software. They kind of document the
expected functionality of the software.
.SS "Lire::Test::FunctionalTestCase"
.IX Subsection "Lire::Test::FunctionalTestCase"
In Lire, the \*(L"expected functionality\*(R" is exercised by running
commands, so this module provides convenient methods to run Lire
commands and tests their expected output.
.PP
It also setup a mock sendmail which can be used to analyze the email
that the Lire system should send.
.PP
Some of Lire functionality cannot be tested anymore simply by running
command (for example the Curses::UI based user interface cannot be
tested that way but throught the use of Lire::Test::CursesUIDriver).
For these kind of tests, this base class will set up a new
Lire::Config and Lire::PluginManager instance in the set_up
method. Tests that requires these functionality can simply call
Lire::Config\->\fIinit()\fR and
Lire::PluginManager\->\fIinstance()\fR\->\fIregister_default_converters()\fR
without fear of messing the test environement.
.SS "\fIhomedir()\fP"
.IX Subsection "homedir()"
Returns the directory which will be assigned to ENV{'\s-1HOME\s0'} when commands
are run. This directory is cleaned up after every test.
.SS "\fIrundir()\fP"
.IX Subsection "rundir()"
Returns the directory which will be the working directory when the
commands are run. This directory is cleaned up after every test.
.SS "\fIconfig_spec()\fP"
.IX Subsection "config_spec()"
Returns the Lire::Config::TypeSpec object which will be used at runtime by
the functional tests. It can be used to setup configuration files for
the test.
.SS "locale( [new_locale] )"
.IX Subsection "locale( [new_locale] )"
Changes the locale under which the functional test is going to be run. By
default, all tests are run under the 'C' locale ignoring all user's
environment variables.
.PP
Returns the previous locale set.
.ie n .SS "lire_run( $shell_cmd )"
.el .SS "lire_run( \f(CW$shell_cmd\fP )"
.IX Subsection "lire_run( $shell_cmd )"
This method runs the command \f(CW$shell_cmd\fR through the shell and returns
a Lire::Test::CommandResult object which can be used to run tests on
this command. The Lire environment will be set up before invoking the
shell.
.SS "\fIsent_mail()\fP"
.IX Subsection "sent_mail()"
Returns in an array reference the message that were sent out during
the test. The element of this array are hash reference containing two
keys:
.IP "recipients" 4
.IX Item "recipients"
An array reference containing the recipients as passed on the command
line to sendmail.
.IP "message" 4
.IX Item "message"
The email which was sent. This is the complete text of the email. This
is what was passed to sendmail via \s-1STDIN\s0.
.ie n .SS "create_test_file( $filename, [$content] )"
.el .SS "create_test_file( \f(CW$filename\fP, [$content] )"
.IX Subsection "create_test_file( $filename, [$content] )"
Create a file \f(CW$filename\fR with the content \f(CW$content\fR. This file will be
removed after the test is run during the \fItear_down()\fR method. An empty
file will be created if the \f(CW$content\fR parameter is omitted.
.ie n .SS "install_xml_spec( $spec_type, $superservice, $file )"
.el .SS "install_xml_spec( \f(CW$spec_type\fP, \f(CW$superservice\fP, \f(CW$file\fP )"
.IX Subsection "install_xml_spec( $spec_type, $superservice, $file )"
Install the \s-1XML\s0 specification in \f(CW$file\fR of base schema \f(CW$superservice\fR.
The \f(CW$spec_type\fR parameter specify where the file will be installed:
.IP "site_filter" 4
.IX Item "site_filter"
The file will be installed as a filter specification in the system
directory.
.IP "site_report" 4
.IX Item "site_report"
The file will be installed as a report specification in the system
directory.
.IP "site_schema" 4
.IX Item "site_schema"
The file will be installed as a schema specification in the system
directory.
.IP "filter" 4
.IX Item "filter"
The file will be installed as a filter specification in the \s-1HOME\s0
directory.
.IP "report" 4
.IX Item "report"
The file will be installed as a report specification in the \s-1HOME\s0
directory.
.IP "schema" 4
.IX Item "schema"
The file will be installed as a schema specification in the \s-1HOME\s0
directory.
.PP
These files will be removed after the test.
.ie n .SS "create_test_cfg_file( $name )"
.el .SS "create_test_cfg_file( \f(CW$name\fP )"
.IX Subsection "create_test_cfg_file( $name )"
Returns a Lire::Config::ConfigFile object initialized with the
appropriate config specification. This configuration file will be
created under \f(CW$HOME\fR/.lire/config/$name.xml when \fIlire_run()\fR will be
used. It can be use to set config option which will be used when the
command is run:
.PP
.Vb 2
\&  my $cfg = $self\->create_test_cfg_file( "test" );
\&  $cfg\->global\->get( "lr_from" )\->set( "flacoste\e@logreport.org" );
.Ve
.PP
If a configuration file \f(CW$name\fR was already created, it returns the
associated ConfigFile object.
.PP
Note that if you want these configurations variable to have effect
when running test in-process ( not via \fIlire_run()\fR ), you have to call
\&\fIsave()\fR on the object before calling Lire::Config\->\fIinit()\fR. Otherwise,
you better set the configuration option directly using the
Lire::Config \s-1API\s0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fITest::Unit::TestCase\fR\|(3pm)
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR FunctionalTestCase.pm,v 1.27 2006/07/23 13:16:31 vanbaal Exp $
.SH "AUTHOR"
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.