DlfAnalyserTestCase(3pm)				  LogReport's Lire Documentation				  DlfAnalyserTestCase(3pm)

NAME

       Lire::Test::DlfAnalyserTestCase - Base class for writing DlfAnalyser unit tests

SYNOPSIS

	 use base qw/ Lire::Test::DlfAnalyserTestCase /;

	 use MyAnalyser;
	 use File::Basename;

	 sub create_analyser {
	   return new MyAnalyser();
	 }

	 sub schemasdir {
	   return dirname( __FILE__ ) .  "../..";
	 }

	 sub registration_file {
	   return dirname( __FILE__ ) .  "../../myanalyser_init";
	 }

DESCRIPTION

       This is a Test::Unit::TestCase subclass which can be used to easily write tests for DlfAnalyser. This class implements what is needed to
       provide the necessary fixture in the set_up() and tear_down().

       It provides two base tests: test_api() and test_registration_file().

       The test class needs to implement three methods to help complete the fixture.

FIXTURES

       These are the methods that subclasses will usually override to provide the necessary data so that the DlfAnalyser test fixtures be setup.

   registration_file()
       This should return the script that is responsible for registring the analyser with the Lire::PluginManager. This is used by the default
       test_registration_file().

   schemasdir()
       This method should returns the directory which hold the schemas used by the analyser. This will be added to the lr_schemas_path
       configuration variable.

   create_analyser()
       This should return an instance of the Lire::DlfAnalyser instance to test.

Mock Converter Process
   create_mock_process( [ $store ])
       This method will return a MockDlfAnalyserProcess which can be use to help test the DlfAnalyser. All values to write_dlf() and error(), are
       saved and can be queried through the dlf() and errors() methods. Note that the dlf() method returns an array reference of array reference.
       The first element in the inner arrays is the dlf and the other elements are the related DLF id, if any.

       The mock process analyser_instance() method which returns the DlfAnalyser created by create_analyser() and associated to its instance.

       The optional $store parameter should be a Lire::DlfStore instance that will be available through the dlf_store() method.

DEFAULT TESTS

   test_api()
       Make sure that all methods required by Lire::DlfAnalyser are implemented. It also tests that the src_schema() and dst_schema() are
       available.

       It checks that description() formats correctly as DocBook.

   test_registration_file()
       Checks that the registration script correctly registers the analyser with the PluginManager.

SEE ALSO

       Lire::Test::TestCase(3pm), Lire::DlfAnalyser(3pm)

AUTHOR

       Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: DlfAnalyserTestCase.pm,v 1.3 2006/07/23 13:16:31 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       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.

       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.

       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.

Lire 2.1.1							    2006-07-23						  DlfAnalyserTestCase(3pm)