Lire::Test::DlfConverterTestCase(3pm)

Lire::Test::DlfConverterTestCase3pm

Base class for writing dlfconverter unit tests

Usage

  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";
  }

Overview

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 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 DlfConverter test fixtures be setup.

registration_file()

This should return the script that is responsible for registring the converter 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 converter. This will be added to the lr_schemas_path configuration variable if set_up_path() is called.

create_converter()

This should return an instance of the Lire::DlfConverter instance to test.

set_up_path()

This will add the schemasdir to the 'lr_schemas_path'.

Mock Converter Process

create_mock_process()

This method will return a MockDlfConverterProcess which can be use to help test the DlfConverter. All values to write_dlf(), error(), ignore_log_line() and save_log_line() are saved and can be queried through the dlf( 'schema' ), errors(), ignored() and saved() methods.

The mock process also has a converter() method which returns the DlfConverter created by create_converter() and associated to its instance.

Default tests

test_api()

Make sure that all methods required by Lire::DlfConverter are implemented. It also tests that the schemas returned by schemas() are available.

It checks that description() formats correctly as DocBook.

test_registration_file()

Checks that the registration script correctly registers the converter with the PluginManager.

Version

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

Releases

6 releases since Debian 3.1 (Sarge); the text changed 5 times.

  1. 3.1
  2. 4.0
  3. 5.0
  4. 6.0
  5. 7
  6. Arch

Author

Francis J. Lacoste <[email protected]>

From lire 2.1.1-8 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.