Skip to content
This repository

Midje provides a migration path from clojure.test to a more flexible, readable, abstract, and gracious style of testing

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

About Midje

Midje is (will be) a full-featured mocking package for Clojure that supports three levels of syntactic sugar:

  • Unprocessed None at all. You work with maps. For the person who hates my style of sugaring and wants to write her own.

  • Semi-sweet Here's a simple Midje test:

     (expect (numerical-reverser 103) => 301)
    

    I use the arrows because I think of tests as examples. When people show snippets of code as examples, they often use an arrow to separate what you type from what you should expect to see. The Midje line above says "After numerical-reverser is given 103, the test should see it return 301."

    In that form, Midje does the same thing as clojure.test. (Indeed, it uses clojure.test's reporting mechanism.) If, however, you want numerical-reverser to use a function that hasn't been coded yet, you can fake out that function like this:

    (expect (numerical-reverser 103) => 301
       (fake (string-reverser "103") => "301"))
    

    In the second line, the arrow signifies that when string-reverser is given "103", we know its caller will get back "301"

    The semi-sweet style does nothing more than add the expect and fake macros, which are ways of generating the maps the unprocessed style expects while themselves not being too hard to generate from more ambitious macros.

  • Sweet The style I like to use. A "little language" for top-down test-driven development, which repaints Freeman and Pryce's Growing Object-Oriented Software, Guided by Tests to the functional landscape.

For the impatient

You can easily see Midje in action and fiddle with some tests. You don't even need Clojure installed. Here's how:

  • Click here.
  • In a shell, go to the directory your browser unpacked the example into. It should be named semi-sweet-examples.
  • Type "./run". (Windows users, see README.html)
  • To change the tests, edit semi-sweet-examples/test/semi_sweet_simple/core_test.clj.

Documentation

  • The sweet style isn't implemented yet. It will look something like this workthrough.

  • A separate page contains complete descriptions of the semi-sweet style in the form of executable examples.

  • In the unprocessed style, both calls with their expected results and expectations for calls of faked functions are defined by maps. You can find the format by looking at the definitions of fake and call-being-tested in midje/semi_sweet.clj. The function that does the actual work is expect*. Its first argument is the map in the call-being-tested format, followed by zero or more maps in the fake format.

Something went wrong with that request. Please try again.