LIRE::TEST::DLFCONVERTERTESTCASE(3pm)

📦 version 2.1.1, in arch rolling

🌸 NAME 🌸

Hey bestie! This is the manual page for Lire::Test::DlfConverterTestCase(3pm) from LogReport's Lire documentation. It's the base class for writing DLfConverter unit tests, and it's here to make your test-writing life way easier. 💖

✨ SYNOPSIS ✨

Okay so here's the starter pack, literally:

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

💅 DESCRIPTION 💅

This is a Test::Unit::TestCase subclass, and it can be used to easily write tests for DlfConverter. No cap, it implements what's needed to provide the necessary fixture in the set_up() and tear_down().

It gives you two base tests: test_api() and test_registration_file(). The test class needs to implement three methods to help complete the fixture. Periodt. 💅

🧚 FIXTURES 🧚

These are the methods that subclasses will usually override to provide the necessary data so that the DlfConverter test fixtures get set up. Main character energy, honestly.

🎀 registration_file() 🎀

This should return the script that is responsible for registring the converter with 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. iykyk. ✨

🦋 create_converter() 🦋

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

🎀 set_up_path() 🎀

This will add the schemasdir to the 'lr_schemas_path'. Lowkey essential. 💜

🧪 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. Obsessed with the organization, fr fr.

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. Iconic behavior. 🌈

🎀 test_registration_file() 🎀

Checks that the registration script correctly registers the converter with the PluginManager. Vibe check passed, bestie. ✅

🔥 SEE ALSO 🔥

Go look at these too, bestie:

💖 AUTHOR 💖

This page was authored by Francis J. Lacoste <flacoste@logreport.org>. 🫶

🌈 VERSION 🌈

Version check, bestie — here's the exact $Id line:

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

Okay, legal moment, but make it cute. Here's the whole copyright and license sitch, no cap:

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.

That's a wrap, bestie! This page came from Lire 2.1.1, dated 2025-09-28. Stay iconic. 💅🎀✨

📦 where this page comes from