ActiveTest: Examination, Introduction: A Mistake and How To Fix It

Mathew Abonyi — Sun, 31 Dec 2006 17:21:17 -0600

In trying to bring ActiveTest to a state resembling my original article about ActiveTest, I realised that … it’s a piece of crap. It just isn’t the kind of code which many but myself would find useful and now even I don’t find it that helpful anymore. A total cowpat of a project, sadly.

To help both myself and the community, I will be analysing my mistake in full and mercilessly revealing my thinking process, development and design along the way. Because it may get a little… lengthy, I’ll break it down into a number of articles. The last article will be dedicated entirely to making Active Test useful (which itself is three parts: salvaging useful ideas, redesigning weak areas, and changing purpose).

Obituary to Active Test 0.1.0 Beta

In its death-throes, the Active Test Plugin can still be useful: as an example of what not to do. Before I start laying into my sad miscarriage of an idea, I’ll outline useful ideas which came out of it:

Finding a way to extend Test::Unit which is safe and allows inheritance
Learning different ways of metaprogramming (especially ways to wrap define_method)
Extracting a more granular set of things to test in an application
Learning techniques for self-testing a test library

As with many mistakes, more than half of it is about learning rather than providing something useful. That’s kind of the point, I guess! I didn’t receive a single support e-mail or comment that it has helped anyone. Then I began to realise what I was doing was wrong and had managed to air my dirty laundry in the process.

An overview of the mistakes

With that small obituary to ActiveTest in its current incarnation, let’s look at the problems in the order in which I’ll be discussing them:

Removing test case transparency (an advantage of Test::Unit)
Extracting and abstracting without a real-world need or basis¹
Excessive metaprogramming, which introduces ambiguity into tests (the cardinal sin)
Code bloat, plain and simple

The Idea: the original test case

I first came up with ActiveTest when I looked at this test case (from an old revision of one of my projects):

  def test_should_index_items
     assert_get_success :index
  end

At first glance, this looks almost identical to what ActiveTest currently does. I have a case where I want to ensure that a typical GET request receives a HTTP 200 response. I extrapolated HTTP 200 to HTTP GET into a request-response ‘success’ condition. The method was given a parameter (an action to call) that was passed to get and assert_template. All perfectly fine, a little DRY, but not unreadable. However, this test case and a bunch of others exactly like it formed almost the entire basis of my initial version of Active Test.

Coming Up Next: My First Mistake…

Footnotes

¹ For a milder case of this, called premature extraction, see this article

Wood for the Trees: ActiveTest: Examination, Introduction: A Mistake and How To Fix It

ActiveTest: Examination, Introduction: A Mistake and How To Fix It

Obituary to Active Test 0.1.0 Beta

An overview of the mistakes

The Idea: the original test case

Footnotes