Test::Dir(3pm)

📦
version 1.16 · 5 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Test::Dir — the vibe

okay bestie, so this is Test::Dir, a perl module (manual page Test::Dir(3pm) — User Contributed Perl Documentation, if you were wondering where it lives on the shelf) and it's literally just here to test directory attributes with you. no cap. 🎀

✨ NAME ✨

Test::Dir — test directory attributes 🦋

✨ SYNOPSIS ✨

  use Test::More ...;
  use Test::Dir;

that's it. that's the whole setup. team up with Test::More and go off. 💅

✨ DESCRIPTION ✨

soooo this module is a whole collection of test utilities for directory attributes. use it in combination with Test::More in your test programs. that's the assignment, that's the plot, she's giving quality-assurance main character energy. 🔥

✨ FUNCTIONS ✨

here's the roster. every single one takes the same shape — note that TESTNAME is optional, it's in the brackets for a reason bestie, don't skip the brackets. 👑

🌸 dir_exists_ok(DIRNAME [, TESTNAME] )

ok if the directory exists, and not ok otherwise. the classic. the blueprint. ✨

🌸 dir_not_exists_ok(DIRNAME [, TESTNAME] )

ok if the directory does not exist, and not ok otherwise. the inverse queen. 💅

🌸 dir_empty_ok(DIRNAME [, TESTNAME] )

ok if the directory is empty (contains no files or subdirectories, we are being very specific here), and not ok otherwise. ∅ vibes. 🕳️

🌸 dir_not_empty_ok(DIRNAME [, TESTNAME] )

ok if the directory is not empty, and not ok otherwise. she has things in her. 🍓

🌸 dir_readable_ok(DIRNAME [, TESTNAME] )

ok if the directory is readable, and not ok otherwise. can we read her? 📖

🌸 dir_not_readable_ok(DIRNAME [, TESTNAME] )

ok if the directory is not readable, and not ok otherwise. mysterious. elusive. 🙈

🌸 dir_writable_ok(DIRNAME [, TESTNAME] )

ok if the directory is writable, and not ok otherwise. permission to make a mess granted. ✍️

🌸 dir_not_writable_ok(DIRNAME [, TESTNAME] )

ok if the directory is not writable, and not ok otherwise. hands off, she's protected. 🚫

🌸 dir_executable_ok(DIRNAME [, TESTNAME] )

ok if the directory is executable, and not ok otherwise. she can move. 💃

🌸 dir_not_executable_ok(DIRNAME [, TESTNAME] )

ok if the directory is not executable, and not ok otherwise. no walking. sitting only. 🪑

🎀 TO DO 🎀

ngl, the author is fully aware there are a lot more directory attributes that can be tested. if you need them, please ask (or better yet, contribute code!) — that's not me being pushy, that's a direct quote of the mission statement bestie. open source is a group project. 🫶

👑 AUTHOR 👑

Martin 'Kingpin' Thurn, "mthurn at cpan.org", <http://tinyurl.com/nn67z>. give him his flowers. 🌸

💀 BUGS 💀

please report any bugs or feature requests to "bug-test-dir at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Dir>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. the full loop. the circle of dev life. 🔁

🌈 SUPPORT 🌈

you can find documentation for this module with the perldoc command.

  perldoc Test::Dir

you can also look for information at:

🧚 ACKNOWLEDGEMENTS 🧚

(crickets. beautiful, respectful crickets. nothing listed here fr fr — the section exists, that's all she wrote.) 🦋

Copyright (C) 2007-2008 Martin 'Kingpin' Thurn

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!! 🌟 this one's perl v5.36.0, dated 2022-10-13, so if you're reading this from the future, hi, hope the directory attributes are still testing correctly. mwah. 💖🎀✨

📦 where this page comes from