Alternate home page

A tutorial introduction

A tutorial introduction for clojure.test users

Concept index

The core

• Facts: Midje's equivalent of a test.
• Predictions: Midje's equivalent of an assertion.
• Checkers: Prepackaged functions that perform common checks.
  • Checking sequential collections
  • Checking maps and records
  • Checking sets
  • Combining checkers
• Repl tools: A quick introduction.
• Using Midje at the command line

Bending Midje to your will

• Using metadata to filter facts
• Print levels: Control verbosity.
• Configuration files: Control everything.
• Colorizing: Highlight failing and future facts.
• Customizing reporting: Making Midje speak such that your continuous build server (for example) understands.
• Production mode: Preventing Midje code from being compiled into production code.

Beyond the basics

• Setup and teardown
• Writing your own checkers: It's simple.
• Chatty checkers: Checkers that explain more about a failure.
• Testing private functions and their use
• Mixing facts and source code

Top-down development

• The idea

• A video introduction

• Describing one prediction's prerequisites

  • Variant prerequisite arrows
  • Checkers within prerequisites: They're treated slightly differently than the normal case.
  • Prerequisites and protocols: Extra work is required to override protocol functions in facts.
  • Metaconstants as partial packets of values

• Establishing fact-wide prerequisites

Integration

• Midje-mode: Emacs mode for using Midje with a REPL.
• clojure-jump-to-file: Jump to a line of Clojure code from any Emacs buffer (usually a shell buffer)
• Cascalog functions

Videos

• An introduction to Midje for clojure.test users
• An example showing top-down testing using metaconstants (alternate download)
• An Emacs minor mode for Midje
• Emacs code to jump to a particular location in a Clojure file

Miscellany

• Why is it called "Midje"?
• Syntax errors that will not be fixed
• Collection checkers and strings
• AOT-compiling metaconstants: It should usually work, but here's what to do if it doesn't.
• Caching: Checking memoization and caching.
• Partial prerequisites: Undescribed function calls can go to the real function.

Reference

• Extended equality
• Fact syntax
  • Metadata syntax and semantics
• Prediction syntax
  • Prediction arrows
• Prerequisite syntax
  • Prerequisite arrows
• against-background
• Metaconstants
• Lein midje

---

---

Top-down development

• More about prerequisites
  • Folded prerequisites: Allowing prerequisites like (f (g 1)) => 2.
  • Streaming prerequisites: Each call to a prerequisite returns a different value.
  • Prerequisites that throw exceptions: The =throws=> arrow.
  • Specifying call counts: Saying the function-under-test calls another function N times.

Advanced topics

 * [[Negating arrows]]: A convenient way to describe what's *not* true. 
 * [[Future facts]]: "Commenting out" facts in a way that prevents you from forgetting about them.
 * [[Tabular facts]]: Shorthand for checking multiple sets of values
 * [[Macros]]: Checking macroexpansions.

Reference

• Command line tools: Checking facts from the command line: lein midje or lein test
• Checkers * A note on checkers and deeply nested collections.
• Working in the repl
  • Repl tools
  • The compendium: Working with loaded facts
  • Autotesting: Tracking file changes and reloading facts.