eunit(3erl)

📦
version 25.3.2.8 · 4 versions
, in ubuntu noble

🌸 NAME 🌸

okay so eunit is literally the main EUnit user interface, bestie. That’s the module. This is the eunit(3erl) manual page — Erlang Module Definition — and yes, it’s giving “short but iconic” 💅.

🦋 DESCRIPTION 🦋

eunit is the main EUnit user interface. No extra lore, no side quests — that’s the description, periodt. ✨

🎀 EXPORTS 🎀

💖 start() -> term() 💖

Starts the EUnit server. Normally you don’t need to call this function at all — it gets started automatically, so you can just vibe. 🫶

💖 stop() -> term() 💖

Stops the EUnit server. Normally you don’t need to call this function either, no cap. 😌

💖 test(Tests) -> term() 💖

Equivalent to test(Tests, []). That’s it, that’s the whole function, bestie. 🎀

💖 test(Tests::term(), Options::[term()]) -> ok | {error, term()} 💖

Runs a set of tests. The format of Tests is described in the EUnit test representation section of the overview, iykyk. 🦋

Example:

eunit:test(fred)

That runs all tests in the module fred and also any tests in the module fred_tests, if that module exists. Yes, it really does both — main character energy. 👑

Options:

  • verbose — displays more details about the running tests. More tea, more info, slay. 🔥
  • print_depth — maximum depth to which terms are printed in case of error. Basically how deep the error printout goes, fr fr. 🌸
  • exact_execution — if this boolean flag is set to true, the framework will not automatically execute tests found in the related module suffixed with "_tests". This behaviour might be unwanted if execution of modules found in a folder is ordered while it contains both source and test modules. So yeah, it’s a “don’t auto-run the _tests module” switch, and it can be a whole vibe check for folder ordering. 💀

Options in the environment variable EUNIT are also included last in the option list, i.e., have lower precedence than those in Options. So Options wins the argument, periodt. 🫶

See also: test/1.

👑 AUTHORS 👑

  • Mickaël Rémond <mickael.remond@process-one.net>
  • Richard Carlsson <carlsson.richard@gmail.com>

xoxo, your eunit bestie 💖 — from the eunit 2.8.2 manual page, eunit(3erl) ✨ (no date listed on this one, so no cap 🌈)

📦 where this page comes from