Faster TDD with Stakeout.rb

  • Posted by Mike Naberezny in PHP,Ruby,Testing

    I’m a big fan of Autotest and it runs almost constantly on my machine. Autotest automatically reruns your tests whenever your files change. Instead of constantly flipping to another shell to rerun your tests, just let Autotest cheerfully do it for you in the background. It’s highly addictive.

    The only problem with Autotest is that it is specific to Ruby. At work, I do a mix of different kinds of programming including Ruby, PHP, Python, and C. I’d like my TDD to be accelerated for all of these languages.

    Thanks to Geoffrey Grossenbach, last week I came across stakeout.rb from Mike Clark. This is a tiny, dead simple Ruby script that runs an arbitrary command when certain files change. This is a stripped-down Autotest for everybody else. I’m sure it has all kinds of other uses as well.

    To get started testing with stakeout.rb, you’ll need Ruby installed. Any recent version is fine and you might already have it installed. Next, grab the stakeout.rb script and add the shebang line to the top (Unix-like OS assumed):

    #!/usr/bin/env ruby -w
 
if ARGV.size < 2
  puts "Usage: stakeout.rb <command> [files to watch]+"
...

    Make the file executable and put it somewhere in your PATH. You can test it out by typing stakeout.rb from an arbitrary directory and you should see the help message.

    Next, change over to a project directory where you have some test files. Most of the projects that I am involved with tend to use some directory structure similar to this:

    /project_name
  /lib
  /test
  ...

    To test such a project, run stakeout.rb from the /project_name directory. Most PHP projects using PHPUnit tend to have an AllTests.php file or equivalent to run all the tests, so we’ll assume this for the example:

    project_name$ stakeout.rb "php test/AllTests.php" **/*

    The first argument is what command to run when the tests change. The second argument, and any subsequent arguments, are the files to watch for changes. These can use a Ruby globbing pattern. The pattern **/* will watch all files under project_name recursively, which includes lib/ and test/.

    Once stakeout.rb is run, it will show no output but will sit and wait for changes. As soon as you change a watched file, stakeout.rb will automatically rerun you tests and will continue to do so until you exit with Control-C.

This entry was posted on Tuesday, September 4th, 2007 at 8:45 am and is filed under PHP, Ruby, Testing. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.

6 comments

  • comment by Ryan Davis 5 Sep 07

    now that’s just sad… Geoffrey didn’t have THAT in mind!

  • comment by Mike Naberezny 5 Sep 07

    :-)

    I’d like to see everyone do more testing, regardless of whatever language they happen to be stuck using.

  • comment by René Leonhardt 1 Feb 08 

    #!/usr/bin/env python
# -*- coding: iso-8859-15 -*-
 
import os, subprocess, sys, time
 
if len(sys.argv) &lt; 3:
  print "Usage: stakeout.py  [files to watch]+"
  sys.exit(1)
 
command = sys.argv[1]
files = {}
 
for arg in sys.argv[2:]:
  if os.path.isfile(arg):
    files[arg] = os.path.getmtime(arg)
last_changed = max(files.values())
 
try:
  while True:
 
    time.sleep(1)
 
    for file in files.iterkeys():
      file_mtime = os.path.getmtime(file)
      if file_mtime > last_changed:
        files[file] = last_changed = file_mtime
 
        print "=> %s changed, running %s" % (file, command)
        try:
          retcode = subprocess.call(command, shell=True)
          print "=> done"
        except OSError, e:
          print >>sys.stderr, "Execution failed:", e
except KeyboardInterrupt:
    pass

  • comment by Joaquin Lippincott 24 Sep 09

    Here’s a post on using stakeout.rb with Drupal:

    http://www.metaltoad.com/blog/fun-stakeoutrb

  • comment by Josh Ribakoff 18 Nov 09

    I ported it to PHP, and started breaking up the code into objects and sub-routines. http://pastebin.org/54979

    - override runTests() with the command you want to run
    - override doDelay() to check more/less often
    - pass the path to files in the contstructor

    Invoke like this:
    C:/wamp/bin/php/php5.3.0/php E:\dev\path\phpautotest.php E:\dev\path\to\monitor

  • pingback by PHP Auto Test – Automatically monitor your project for changes and run your unit tests « Web Application Development, E-commerce, Sales & Marketing 18 Nov 09

    [...] read about stakeout.rb but read that it might not work on windows. Rather then waste time even trying I just ported it to [...]

Post a comment


Thanks for commenting. Please remember to be nice to others and keep your comment relevant to the discussion. I reserve the right to remove comments that don't meet these simple guidelines.