SHTK_UNITTEST_FAIL(3)

💅 SHTK_UNITTEST_FAIL(3) — bestie's guide to the "nope, we're done here" function

okay so you're in shtk land, in the Library Functions Manual section, and the vibe check of the day is failure. Specifically: shtk_unittest_fail. yes, it does exactly what it says on the tin, and honestly? iconic of it. 🌸

---

✨ NAME ✨

shtk_unittest_fail — fails the test case 💀 (that's the whole job, and it's very good at it)

📚 LIBRARY 📚

shtk_import unittest

like, that's the import you need, no cap. 🫶

🎀 SYNOPSIS 🎀

shtk_unittest_fail arg1 .. argN

literally just pass your args and go, bestie. ✨

💖 DESCRIPTION 💖

so here's the tea ☕: the shtk_unittest_fail function marks the currently running test case as failed and then aborts execution. yeah. it just straight up stops everything. main character energy, honestly. 👑

the message you give it in the arguments arg1 through argN gets printed right along with the failure, so future you (or your group chat) knows exactly what went down. 🍓

now this part is important, so listen up: if shtk_unittest_fail is used within a test case of a test fixture, the teardown method of the fixture will be executed, so that any necessary clean up operations can be performed. 🧹✨ like, it still lets you clean up before dipping out. respectful.

shtk_unittest_fail should be used to fail the test case when an erroneous condition is detected and that condition prevents the rest of the test case's code from running correctly. in general, this means that shtk_unittest_fail is appropriate to abort a test case when any setup operations — the ones not directly exercising the scenario under test — cause an error. 💅

lowkey the rule of thumb: if the setup broke (not the thing you're actually testing), that's your cue to call this and bail. don't let it limp along pretending everything's fine. 🙈

---

👀 SEE ALSO 👀

• shtk(3)
• shtk_unittest(3)

(go read those too, iykyk 📖)

🕰️ HISTORY 🕰️

shtk_unittest_fail first appeared in shtk 1.6. a true classic. ⭐

---

and that's the whole page, bestie! 🦋 this lil drop of wisdom comes to you straight from Debian, dated November 8, 2014 — yeah, it's been serving these docs for a minute. go forth and fail your tests on purpose. 🔥🎀💜