Fudge Documentation

Fudge is a Python module for using fake objects (mocks, stubs, etc) to test real ones.

This module is designed for two specific situations:

• Replace an object
  • Temporarily return a canned value for a method or allow a method to be called without affect.
• Ensure an object is used correctly
  • Declare expectations about what methods should be called and what arguments should be sent.

Fudge was inspired by Mocha which is a simpler version of jMock. But unlike Mocha, Fudge does not automatically hijack real objects; you explicitly patch them in your test setup. And unlike jMock, Fudge is only as strict about expectations as you want it to be. If you just want to expect a method call without worrying about its arguments or the type of the arguments then you can.

Download / Install

Just type:

$ sudo easy_install fudge

If you don’t have easy_install for Python you can get it like this:

$ wget http://peak.telecommunity.com/dist/ez_setup.py
$ sudo python ez_setup.py

Fudge requires Python 2.4 or higher and is developed primarily against 2.5 and 2.6.

Source

The Fudge source can be downloaded as a tar.gz file from http://pypi.python.org/pypi/fudge

To checkout the Fudge source, install Mercurial and type:

$ hg clone http://bitbucket.org/kumar303/fudge/

You can get updates with:

$ hg pull --update

Contents

• Using Fudge
  • Fudging Email
  • A Simple Test Case
  • A unittest.TestCase
  • Failed Expectations
  • Clearing Expectations
  • A Complete Test Module
  • Stubs Without Expectations
  • Replacing A Method
  • Fudging A Callable
  • Cascading Objects
  • Multiple Return Values
  • Expecting A Specific Call Order
  • Working with Arguments
• Fudge For JavaScript
  • Install
  • Usage
• Why Another Mock Framework?

API Reference

• fudge
• fudge.inspector
• fudge.patcher

Contributing

Please submit bugs and patches, preferably with tests. All contributors will be acknowledged. Thanks!

Credits

Fudge was created by Kumar McMillan and contains contributions by Cristian Esquivias and Michael Williamson.

Changelog

• 0.9.3
  • Added with_args() to JavaScript Fudge.
  • Fixed bug where argument values that overloaded __eq__ might cause declared expectations to fail (patch from Michael Williamson, Issue 9)
  • Fixed bug where fudge.Fake.raises() obscured fudge.Fake.with_args() (Issue 6)
  • Fixed returns_fake() in JavaScript Fudge.
• 0.9.2
  • Changed: values in failed comparisons are no longer shortened when too long.
  • Changed: fudge.Fake.calls() no longer trumps expectations (i.e. fudge.Fake.with_args())
  • Changed: fudge.Fake.with_args() is more strict. You will now see an error when arguments are not expected yet keyword arguments were expected and vice versa. This was technically a bug but is listed under changes in case you need to update your code. Note that you can work with arguments more expressively using the new fudge.inspector functions.
  • Added fudge.inspector for Working with Arguments.
  • Added fudge.Fake.remember_order() so that order of expected calls can be verified.
  • Added fudge.Fake.raises() for simulating exceptions
  • Added keyword fudge.Fake.next_call(for_method="other_call") so that arbitrary methods can be modified (not just the last one).
  • Fixed: error is raised if you declare multiple fudge.Fake.provides() for the same Fake. This also applies to fudge.Fake.expects()
  • Fixed bug where fudge.Fake.returns() did not work if you had replaced a call with fudge.Fake.calls()
  • Fixed bug in fudge.Fake.next_call() so that this now works: Fake(callable=True).next_call().returns(...)
  • Fixed: Improved Python 2.4 compatibility.
  • Fixed bug where from fudge import * did not import proper objects.
• 0.9.1
  • DEPRECATED fudge.start() in favor of fudge.clear_calls()
  • DEPRECATED fudge.stop() in favor of fudge.verify()
  • Added context manager fudge.patcher.patched_context() so the with statement can be used for patching (contributed by Cristian Esquivias)
  • Added fudge.Fake.times_called() to expect a certain call count (contributed by Cristian Esquivias)
  • Added Fake(expect_call=True) to indicate an expected callable. Unlike Fake(callable=True) the former will raise an error if not called.
• 0.9.0
  • first release