Object Mentor Blog: TDD in Clojure

TDD in Clojure

Uncle Bob — Thu, 03 Jun 2010 12:33:00 -0500

OO is a tell-don’t-ask paradigm. Yes, I know people don’t always use it that way, but one of Kay’s original concepts was that objects were like cells in a living creature. The cells in a living creature do not ask any questions. They simply tell each other what to do. Neurons are tellers, not askers. Hormones are tellers not askers. In biological systems, (and in Kay’s original concept for OO) communication was half-duplex.

Clojure is a functional language. Functional languages are ask-dont-tell. Indeed, the whole notion of “tell” is to change the state of the system. In a functional program there is no state to change. So “telling” makes little sense.

When we use TDD to develop a tell-don’t-ask system, we start at the high level and write tests using mocks to make sure we are issuing the correct “tells”. We proceed from the top of the system to the bottom of the system. The last tests we write are for the utilities at the very bottom.

In an ask-don’t-tell system, data starts at the bottom and flows upwards. The operation of each function depends on the data fed to it by the lower level functions. There is no mocking framework. So we write tests that start at the bottom, and we work our way up the the top.

Therein lies the rub.

In a tell-don’t-ask system, the tells at the high level are relatively complex. They branch out into lower subsystems getting simpler, but more numerous as they descend. Testing these tells using mocks is not particularly difficult because we don’t need to depend on the lower level functions being there. The mocks make them irrelevant.

In an ask-don’t-tell system the asks at the low level are simple, but as the data moves upwards it gets grouped and composed into lists, maps, sets, and other complex data structures. At the top the data is in it’s most complex form. Writing tests against that complex data is difficult at best. And there is currently no way to mock out the lower levels¹ so all tests written at the high level depend on all the functions below.

The perception of writing tests from the bottom to the top can be horrific at first. Consider, for example, the Orbit program I just wrote. This program simulates N-body gravitation. Imagine that I am writing tests at the top level. I have three bodies at position Pa, Pb, and Pc. They have masses Ma, Mb, and Mc. They have velocity vectors of Va, Vb, Vc. The test I want to write needs to make sure that new positions Pa’, Pb’, Pc’, and new Velocity vectors Va’, Vb’, and Vc’ are computed correctly. How do I do that?

Should I write a test that looks like this?

test-update {
  Pa = (1,1)
  Ma = 2
  Va = (0,0)

  Pb = (1,2)
  Mb = 3
  Vb = (0,0)

  Pc = (4,5)
  Mc = 4
  Vc = (0,0)

  update-all

  Pa should == (1.096, 4.128)
  Va should == (0.096, 3.128)

  Pb should == (1.1571348402636772, 0.1571348402636774)
  Vb should == (0.15713484026367727, -1.8428651597363226)

  Pc should == (3.834148869802242, 4.818148869802242)
  Vc should == (-0.16585113019775796, -0.18185113019775795)
}

A test like this is awful. It’s loaded with magic numbers, and secret information. It tells me nothing about how the update-all function is working. It only tells me that it generated certain numbers. Are those numbers correct? How would I know?

But wait! I’m working in a functional language. That means that every function I call with certain inputs will always return the same value; no matter how many times I call it. Functions don’t change state! And that means that I can write my tests quite differently.

How does update-all work? Simple, given a list of objects it performs the following operations (written statefully):

  update-all(objects) {
    for each object in objects {
      accumulate-forces(object, objects)
    }
    for each object in objects {
      accelerate(object)
      reposition(object)
    }
  }

This is written in stateful form to make is easier for our non-functional friends to follow. First we accumulate the force of gravity between all the objects. This amounts to evaluating Newton’s F=Gm1m1/r^2 formula for each pair of objects, and adding up the force vectors.

Then, for each object we accelerate that object by applying the force vector to it’s mass, and adding the resultant delta-v vector to it’s velocity vector.

Then, for each object we reposition that object by applying the velocity vector to it’s current position.

Here’s the clojure code for update-all

(defn update-all [os]
  (reposition-all (accelerate-all (calculate-forces-on-all os))))

In this code you can clearly see the bottom-to-top flow of the application. First we calculate forces, then we accelerate, and finally we reposition.

Now, what do these -all functions look like? Here they are:

(defn calculate-forces-on-all [os]
  (map #(accumulate-forces % os) os))

(defn accelerate-all [os]
  (map accelerate os))

(defn reposition-all [os]
  (map reposition os))

If you don’t read clojure, don’t worry. the map function simply creates a new list from an old list by applying a function to each element of the old list. So in the case of reposition-all it simply calls reposition on the list of objects (os) producing a new list of objects that have been repositioned.

From this we can determine that the function of update-all is to call the three functions (accumulate-forces, accelerate, and reposition) on each element of the input list, producing a new list.

Notice how similar that is to a statement we might make about a high level method in an OO program. (It’s got to call these three functions on each element of the list). In an OO language we would mock out the three functions and just make sure they’d been called for each element. The calculations would be bypassed as irrelevant.

Oddly, we can make the same statement in clojure. Here’s the test for update-all

(testing "update-all" 
  (let [
    o1 (make-object ...)
    o2 (make-object ...)
    o3 (make-object ...)
    os [o1 o2 o3]
    us (update-all os)
    ]
    (is (= (nth us 0) (reposition (accelerate (accumulate-forces os o1)
    (is (= (nth us 1) (reposition (accelerate (accumulate-forces os o2)
    (is (= (nth us 2) (reposition (accelerate (accumulate-forces os o3)
    )
  )

If you don’t read clojure don’t worry. All this is saying is that we test the update-all function by calling the appropriate functions for each input object, and then see if the elements in the output list match them.

In an OO program we’d find this dangerous because of side-effects. We couldn’t be sure that the functions could safely be called without changing the state of some object in the system. But in a functional language it doesn’t matter how many times you call a function. So long as you pass in the same data, you will get the same result.

So this test simply checks that the appropriate three functions are getting called on each element of the list. This is exactly the same thing an OO programmer would do with a mock object!

Is TDD necessary in Clojure?

If you follow the code in the Orbit example, you’ll note that I wrote tests for all the computations, but did not write tests for the Swing-Gui. This is typical of the way that I work. I try to test all business rules, but I “fiddle” with the GUI until I like it.

If you look carefully you’ll find that amidst the GUI functions there are some “presentation” functions that could have been tested, but that I neglected to write with TDD[2]. These functions were the worst to get working. I continuously encountered NPEs and Illegal Cast exceptions while trying to get them to work.

My conclusion is that Clojure without TDD is just as much a nightmare as Java or Ruby without TDD.

Summary

In OO we tend to TDD our way from the top to the bottom by using Mocks. In Clojure we tend to TDD our way from the bottom to the top. In either case we can compose our tests in terms of the functions they should call on the lower level objects. In the case of OO we use mocks to tell us if the functions have been called properly. This protects us from side-effects and allows us to decouple our tests from the whole system. In clojure we can rely on the fact that the language is functional, and that no matter how many times you call a function it will return the same value.

¹ Brian Marick is working on something that looks a lot like a mocking framework for clojure. If his ideas pan out, we may be able to TDD from the top to the bottom in Clojure.

² This is an unconscious game we all play with ourselves. When we have a segment of code that we consider to be immune to TDD (like GUI) then we unconsciously move lots of otherwise testable code into that segment. Yes, I heard my green band complain every time I did it; but I ignored it because I was in the GUI. Whoops.

"TDD in Clojure" by UGG Bottes

Wed, 08 Sep 2010 02:14:12 -0500

Tout d’accord sur votre opinion. Et moi, aussi le fan de bottes uggs, surtout sur sa doublure en laine. La marque ugg bottes. venait de trouver sa signature. En ce moment, vous pouvez pré-commander les UGG Pas Cher!

"TDD in Clojure" by coachoutlet

Tue, 07 Sep 2010 02:54:50 -0500

Today, Coach has developed into a global brand, offers a variety of decorative assembly line of men and women.Our coach outlet include handbags, shoes, watches, outdoor clothing, scarves, sunglasses, jewelry and perfume series coach bags.Welcome to see coach brooke collection .

http://www.coachoutletnew.com

"TDD in Clojure" by supplynflshop

Tue, 31 Aug 2010 22:05:18 -0500

Originally, the word emblem meant “inlaid ornamental work,” that is Wholesale NFL Jerseys, a

symbol of something else – in this case, that of wealth, because of the time and skill required to do it . Badge probably became

synonymous with emblem in the 15th century Cheap NFL Jerseys. Decal, an abbreviated version of

“decalcomania,”a French word that came into use in the early 20th century referred to the English practice of “transfer printing”

invented in the 18th century. This process transferred the ink from a design or drawing to the glass or porcelain when it was fired in the

kiln NFL Jerseys.

"TDD in Clojure" by alice

Fri, 20 Aug 2010 04:34:04 -0500

Thanks for sharing the information.I have bookmarked your post and reply you soon with some new comments/information. http://surfaceid.com

"TDD in Clojure" by discount tiffany earrings

Thu, 19 Aug 2010 20:07:55 -0500

This is really useful information. Will do it in the future. Yeah, the system is as corrupt as the politician…lol :D

Cool, thanks for the information on this matter.

"TDD in Clojure" by cosplay

Tue, 10 Aug 2010 21:26:12 -0500

I have joined many yahoo groups and i think there is lot of information available.

"TDD in Clojure" by liveyou

Wed, 04 Aug 2010 22:11:03 -0500

Guide on how to copy dvd to ipad, how can I copy files onto an ipad, how to copy a dvd movie to ipad, how to copy files from computer to ipad.

"TDD in Clojure" by lady dress

Tue, 20 Jul 2010 03:27:19 -0500

Wholesale clothing,fashion dress,lady dress,lady garment,lady fashion

"TDD in Clojure" by www.needjerseys.com

Mon, 19 Jul 2010 22:46:33 -0500

I have great interest in Wholesale jerseys such as NBA jerseys, soccer jerseys and NFL jerseys.

"TDD in Clojure" by Chemise dress

Tue, 13 Jul 2010 01:56:21 -0500

In this summer, the romantic and small, is confronted dragon-boat festival holiday for a picnic superexcellent period. Romantic, melting snow spins dress is today season vogue girls wear build up the important sheet is tasted,

"TDD in Clojure" by Olivea Copper

Thu, 08 Jul 2010 06:00:21 -0500

A four year old little boy was at the doctor’s office with his mother in the waiting room when he spotted a pregnant lady on the other side of the room. Having nothing better to do, he walks over to her and inquisitively asks “Why is your stomach so big?”

"TDD in Clojure" by P90x

Thu, 08 Jul 2010 03:23:16 -0500

Hello,I love reading through your blog, I wanted to leave a little comment to support

you and wish you a good continuation. Wishing you the best of luck for all your

blogging efforts.

"TDD in Clojure" by http://www.laviesolar.com

Tue, 06 Jul 2010 03:32:52 -0500

Hello and many greets from China ! Nice design.Looks so comfortable. Many thanks for the wonderful site and the opportunity to say hello.

"TDD in Clojure" by http://www.laviesolar.com

Tue, 06 Jul 2010 03:21:15 -0500

his site is amazing. Very well developed with great information. Thanks for a wonderful experience.

"TDD in Clojure" by Hot Wallpapers

Mon, 05 Jul 2010 01:18:47 -0500

Nice blog. Will bookmark for future updates.

"TDD in Clojure" by movies

Thu, 01 Jul 2010 13:03:06 -0500

Nice one. :)

"TDD in Clojure" by r9 irons

Tue, 29 Jun 2010 04:11:49 -0500

The noblest search is the search for excellence

"TDD in Clojure" by r9 irons

Tue, 29 Jun 2010 04:11:40 -0500

The noblest search is the search for excellence

"TDD in Clojure" by MBT Chapa

Tue, 29 Jun 2010 03:58:14 -0500

interesting i am definatley going to look further into this.

"TDD in Clojure" by MBT Chapa

Tue, 29 Jun 2010 03:57:55 -0500

interesting i am definatley going to look further into this.

"TDD in Clojure" by pump shoes

Tue, 29 Jun 2010 03:54:59 -0500

It seems that you have set many work in to your article and We require more of

those about the net presently. I truly got a drag out of one’s article. We do not

actually possess a lot in order to communicate reacting, I just wished to comment

in order to respond incredible perform

"TDD in Clojure" by pump shoes

Tue, 29 Jun 2010 03:54:49 -0500

It seems that you have set many work in to your article and We require more of

those about the net presently. I truly got a drag out of one’s article. We do not

actually possess a lot in order to communicate reacting, I just wished to comment

in order to respond incredible perform

"TDD in Clojure" by cell phone headset

Tue, 29 Jun 2010 03:34:12 -0500

Nice one. I have stumbled and twittered this for my friends. Hope others find it as interesting as I did.

"TDD in Clojure" by cell phone headset

Tue, 29 Jun 2010 03:33:46 -0500

Nice one. I have stumbled and twittered this for my friends. Hope others find it as interesting as I did.

"TDD in Clojure" by p90x workout

Mon, 14 Jun 2010 21:05:27 -0500

P90X is a working out system includs P90X workout and Insanity DVD which belong to P90X fitness program.