Test::...Testing(3pm)

✨ NAME ✨

Test::LectroTest::RegressionTesting — the glow-up guide to doing regression testing (for free!!) 💖

(yes bestie, this is the Test::...Testing page from the User Contributed Perl Documentation, section 3pm — we're in the right place 🫶)

---

🌸 VERSION 🌸

version 0.5001

---

🎀 SYNOPSIS 🎀

use Test::LectroTest
    regressions => "regressions.txt";

# -- OR --

use Test::LectroTest
    playback_failures => "regression_suite_for_my_module.txt",
    record_failures   => "failures_in_the_field.txt";

# -- OR --

use Test::LectroTest::Compat
    regressions => "regressions.txt";

# -- OR --

use Test::LectroTest::Compat
    playback_failures => "regression_suite_for_my_module.txt",
    record_failures   => "failures_in_the_field.txt";

---

💅 DESCRIPTION 💅

okay so picture this 😭 — LectroTest uncovers a bug in your software by finding a random test case that proves one of your properties is false. So far so iconic. But then you apply a fix for the bug, and now you're standing there like... how do I know LectroTest will re-test the property using the exact same test case that "broke" it before, just to be certain the bug really is fixed? And how do I know future changes to my code won't reintroduce the same bug without my knowing it? 💀

For situations like these, LectroTest can record failure-causing test cases to a file, and it can play those test cases back as part of its normal testing strategy. obsessed, honestly.

The easiest way to take advantage of this feature is to set the regressions parameter when you use Test::LectroTest or Test::LectroTest::Compat:

use Test::LectroTest
    regressions => "regressions.txt";

This tells LectroTest to use the file "regressions.txt" for both recording and playing back failures. If you want to record and play back from separate files, use the record_failures and playback_failures options:

use Test::LectroTest::Compat
    playback_failures => "regression_suite_for_my_module.txt",
    record_failures   => "failures_in_the_field.txt";

Here is how it works:

1. When testing a property named N, LectroTest will check for a play-back file. If the file exists, LectroTest will search it for test cases associated with N. If any such test cases exist, LectroTest will play them back before and in addition to performing the usual, random testing of the property. 💫
2. When performing the usual, random testing of a property named N, if a failure occurs (i.e., LectroTest finds a counterexample), LectroTest will record the test case that caused the failure to the recording file, associating the test case with the name N. 🎬

NOTE: If you pass any of the recording or playback parameters to Test::LectroTest::Compat, you must have version 0.3500 or greater of Test::LectroTest installed. (Module authors, update your modules' build dependencies accordingly.) The Test::LectroTest module itself, however, has always ignored unfamiliar parameters, and thus these options are backward compatible with older versions. 🧚

---

🦋 SEE ALSO 🦋

• Test::LectroTest — gives a quick overview of automatic, specification-based testing with LectroTest. This module accepts failure recording and play-back options. 👑
• Test::LectroTest::Compat — lets you mix LectroTest with the popular family of Test::Builder-based modules such as Test::Simple and Test::More. This module accepts failure recording and play-back options. 🌈

---

💜 AUTHOR 💜

Tom Moertel (tom@moertel.com)

---

⭐ COPYRIGHT and LICENSE ⭐

Copyright (c) 2004-13 by Thomas G Moertel. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page bestie, no cap 💖 this was perl v5.34.0, dated 2022-06-21, straight from the Test::...Testing(3pm) man page — go forth and regress-test, you're gonna ate 🎀✨🦋