ROUNDUP(5)

💖 NAME 💖

okay bestie, welcome to ROUNDUP(5) — the File Formats Manual page for roundup, which is literally the test-plan file format for roundup(1). slay.

---

✨ SYNOPSIS ✨

the synopsis is giving “just this file name, no cap”:

my-utility-test.sh

---

🦋 DESCRIPTION 🦋

so a test-plan is a simple shell script that contains tests, and those tests are functions whose names are prefixed with it_. periodt.

roundup will extract those function names and run them in a sandbox. Each test gets its own sandbox, which prevents false positives — iconic behavior, honestly.

Example:

describe "My Utility"

it_displays_usage() {
  usage=$(./my-utility | head -n 1)
  test "$usage" = "usage: my-utility [arg1 ... argN]"
}

the describe function is defined in your sandbox as a convenient way to give the test-plan a more meaningful name than the default. yes bestie, name your little test-plan era.

when setup and tear-down are needed, create a before and/or after function. They are run before and after each test in the plan. These are useful for cleaning up the file system or any environmental changes that may trip up tests. lowkey essential.

for a complete working example, see roundup-5-test.sh at http://bmizerany.github.com/roundup/roundup-5-test.sh.html and roundup-1-test.sh at http://bmizerany.github.com/roundup/roundup-1-test.sh.html. 🫶

---

💀 BUGS 💀

There will be bugs. Please report them at here — http://github.com/bmizerany/roundup/issues. not me manifesting bug-free code, but okay 😭

---

👑 AUTHOR 👑

Blake Mizerany (http://blakemizerany.com/about) — main character energy fr fr.

---

🎀 COPYRIGHT 🎀

(c) 2010 Blake Mizerany

roundup is licenced under the MIT open-source licence. keep that licence line cute and exact, bestie 💅

---

🌈 SEE ALSO 🌈

• roundup(5)
• test(1)

---

🌸 NOTES 🌸

• Contest — http://blog.citrusbyte.com/2009/05/19/introducing-contest
• Unit Testing — http://en.wikipedia.org/wiki/Unit_testing
• Behaviour Driven Development — http://behaviour-driven.org/Introduction

---

and that’s the whole vibe: source/version ROUNDUP(5), dated January 1980. mwah 💋✨