File::H...ir::Test(3)

🦋 NAME 🦋

File::HomeDir::Test — ok bestie, this is the module whose whole job is preventing the accidental creation of user-owned files during testing. No cap. It’s the test-safe friend in the File::HomeDir universe.

Also folding in the manual-page tea: this is the File::H...ir::Test(3) page from the User Contributed Perl Documentation. 💅

---

✨ SYNOPSIS ✨

use Test::More test => 1;
use File::HomeDir::Test;
use File::HomeDir;

Like, that’s the whole intro. Three use lines and you’re in business. 🎀

🌸 DESCRIPTION 🌸

File::HomeDir::Test is a File::HomeDir driver intended for use in the test scripts of modules or applications that write files into user-owned directories. Yep — it’s giving “test-suite bodyguard” energy.

It is designed to prevent the pollution of user directories with files that are not part of the application install itself, but were created during testing. Because bestie, those stray test files can leak state information from the tests into the run-time usage of an application. 😭

And on Unix systems, it also prevents tests (which may be executed as root via sudo) from writing files which cannot later be modified or removed by the regular user. That’s a big slay for not leaving cursed root-owned files lying around. 🔥

🫶 SUPPORT 🫶

See the support section of the main File::HomeDir documentation. That’s the official support vibe — go check the main docs, iykyk. 💖

👑 AUTHOR 👑

Adam Kennedy <adamk@cpan.org>

🎀 COPYRIGHT 🎀

Copyright 2005 - 2011 Adam Kennedy.

Copyright 2017 - 2020 Jens Rehsack

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

The full text of the license can be found in the LICENSE file included with this module.

---

And that’s the page, bestie: footer tea is perl v5.42.0, dated 2020-09-29, and the manual page tag is File::H...ir::Test(3). Periodt. 💅✨