.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
.\"
.\" 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 "DlfConverterTestCase 3pm"
.TH DlfConverterTestCase 3pm "2020-07-07" "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::DlfConverterTestCase \- Base class for writing DLfConverter unit tests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/ Lire::Test::DlfConverterTestCase /;
\&
\&  use MyConverter;
\&  use File::Basename;
\&
\&  sub create_converter {
\&    return new MyConverter();
\&  }
\&
\&  sub schemasdir {
\&    return dirname( _\|_FILE_\|_ ) .  "../..";
\&  }
\&
\&  sub registration_file {
\&    return dirname( _\|_FILE_\|_ ) .  "../../myconverter_init";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Test::Unit::TestCase subclass which can be used to easily
write tests for DlfConverter. This class implements what is needed to
provide the necessary fixture in the \fBset_up()\fR and \fBtear_down()\fR.
.PP
It provides two base tests: \fBtest_api()\fR and \fBtest_registration_file()\fR.
.PP
The test class needs to implement three methods to help complete the
fixture.
.SH "FIXTURES"
.IX Header "FIXTURES"
These are the methods that subclasses will usually override to provide
the necessary data so that the DlfConverter test fixtures be setup.
.SS "\fBregistration_file()\fP"
.IX Subsection "registration_file()"
This should return the script that is responsible for registring the
converter with the Lire::PluginManager. This is used by the default
\&\fBtest_registration_file()\fR.
.SS "\fBschemasdir()\fP"
.IX Subsection "schemasdir()"
This method should returns the directory which hold the schemas used
by the converter. This will be added to the lr_schemas_path
configuration variable if \fBset_up_path()\fR is called.
.SS "\fBcreate_converter()\fP"
.IX Subsection "create_converter()"
This should return an instance of the Lire::DlfConverter instance to
test.
.SS "\fBset_up_path()\fP"
.IX Subsection "set_up_path()"
This will add the schemasdir to the 'lr_schemas_path'.
.SH "Mock Converter Process"
.IX Header "Mock Converter Process"
.SS "\fBcreate_mock_process()\fP"
.IX Subsection "create_mock_process()"
This method will return a MockDlfConverterProcess which can be use to
help test the DlfConverter. All values to \fBwrite_dlf()\fR, \fBerror()\fR,
\&\fBignore_log_line()\fR and \fBsave_log_line()\fR are saved and can be queried
through the dlf( 'schema' ), \fBerrors()\fR, \fBignored()\fR and \fBsaved()\fR methods.
.PP
The mock process also has a \fBconverter()\fR method which returns the
DlfConverter created by \fBcreate_converter()\fR and associated to its
instance.
.SH "DEFAULT TESTS"
.IX Header "DEFAULT TESTS"
.SS "\fBtest_api()\fP"
.IX Subsection "test_api()"
Make sure that all methods required by Lire::DlfConverter are
implemented. It also tests that the schemas returned by \fBschemas()\fR are
available.
.PP
It checks that \fBdescription()\fR formats correctly as DocBook.
.SS "\fBtest_registration_file()\fP"
.IX Subsection "test_registration_file()"
Checks that the registration script correctly registers the
converter with the PluginManager.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::Test::TestCase\fR\|(3pm), \fBLire::DlfConverter\fR\|(3pm)
.SH "AUTHOR"
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR DlfConverterTestCase.pm,v 1.20 2006/07/23 13:16:31 vanbaal Exp $
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 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 \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 ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\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.