.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "TestCase 3pm"
.TH TestCase 3pm 2025-09-28 "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::TestCase \- Common base for Lire test cases.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use base qw/Lire::Test::TestCase/;
\&
\& sub set_up {
\&     my $self = shift\->SUPER::set_up();
\&
\&     $self\->{\*(Aqcfg\*(Aq}{\*(Aqlr_schemas_path\*(Aq} = [ $self\->{\*(Aqtmpdir\*(Aq} ];
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This package can be used to write test cases for Lire instead of
inheriting directly from Test::Unit::TestCase.
.PP
The default set_up method will create a Lire::Test::HashConfig object
and set it up in the configuration framework. This makes it easy to
set configuration variables to arbitrary values in the \fBset_up()\fR
method.
.PP
It also sets the LC_MESSAGES locale category to \*(AqC\*(Aq.
.PP
If you override \fBset_up()\fR and \fBtear_down()\fR be sure to call the SUPER::
implementation.
.PP
This subclass also defined a new kind of assertion which make sure
that a snippet of code died with a proper error message.
.ie n .SS "assert_died( $test, $regex, [ $msg ] )"
.el .SS "assert_died( \f(CW$test\fP, \f(CW$regex\fP, [ \f(CW$msg\fP ] )"
.IX Subsection "assert_died( $test, $regex, [ $msg ] )"
Execute \f(CW$test\fR and fail unless it dies with a message matching \f(CW$regex\fR.
\&\f(CW$test\fR should be a reference to CODE. \f(CW$regex\fR should be a Regexp ref.
.ie n .SS "assert_dies( $regex, $test, [ $msg ] )"
.el .SS "assert_dies( \f(CW$regex\fP, \f(CW$test\fP, [ \f(CW$msg\fP ] )"
.IX Subsection "assert_dies( $regex, $test, [ $msg ] )"
Like \fBassert_died()\fR but with a signature closer to the one defined in
Test::Unit::Assert.
.ie n .SS "assert_isa( $class, $instance, [ $msg ] )"
.el .SS "assert_isa( \f(CW$class\fP, \f(CW$instance\fP, [ \f(CW$msg\fP ] )"
.IX Subsection "assert_isa( $class, $instance, [ $msg ] )"
Fails unless \f(CW$instance\fR is an instance of \f(CW$class\fR.
.SH "FIXTURE RELATED METHOD"
.IX Header "FIXTURE RELATED METHOD"
.SS \fBlire_default_config_spec()\fP
.IX Subsection "lire_default_config_spec()"
Returns a Lire::Config::ConfigSpec object initialized from the
default Lire configuration specification.
.ie n .SS "set_up_tz( $tz )"
.el .SS "set_up_tz( \f(CW$tz\fP )"
.IX Subsection "set_up_tz( $tz )"
When you tests uses \fBtimelocal()\fR or \fBlocaltime()\fR, you should
use that method to specify the TZ under which it should run.
.PP
The TZ will be reset to its previous value during \fBtear_down()\fR.
.SS \fBset_up_plugin_mgr()\fP
.IX Subsection "set_up_plugin_mgr()"
This will make the global PluginManager an instance that will only
live for the current test. The old PluginManager will be reinstated
during \fBtear_down()\fR. This way, you do not need to track calls to
\&\fBregister_plugin()\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBTest::Unit::TestCase\fR\|(3pm)
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR TestCase.pm,v 1.17 2006/07/23 13:16:32 vanbaal Exp $
.SH AUTHORS
.IX Header "AUTHORS"
Francis J. Lacoste <flacoste@logreport.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003, 2004 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 GNU 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 WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.