Mock object

In object-oriented programming, mock objects are simulated objects that mimic the behavior of real objects in controlled ways. A computer programmer typically creates a mock object to test the behavior of some other object, in much the same way that a car designer uses a crash test dummy to test the behavior of a car during an accident.

Reasons for use

In a unit test, mock objects can simulate the behavior of complex, real (non-mock) objects and are therefore useful when a real object is difficult or impossible to incorporate into a unit test. If an object has any of the following characteristics, it may be useful to use a mock object in its place:

• supplies non-deterministic results (e.g. the current time or the current temperature);
• has states that are difficult to create or reproduce (e.g. a network error);
• is slow (e.g. a complete database, which would have to be initialized before the test);
• does not yet exist or may change behavior;
• would have to include information and methods exclusively for testing purposes (and not for its actual task).

For example, an alarm clock program which causes a bell to ring at a certain time might get the current time from the outside world. To test this, the test must wait until the alarm time to know whether it has run the bell correctly. If a mock object is used in place of the real object, it can be programmed to provide the bell-ringing time (whether it is actually that time or not) so that the alarm clock program can be tested in isolation.

Technical details

Mock objects have the same interface as the real objects they mimic, allowing a client object to remain unaware of whether it is using a real object or a mock object. Many available mock object frameworks allow the programmer to specify which, and in what order, methods will be invoked on a mock object and what parameters will be passed to them, as well as what values will be returned. Thus, the behavior of a complex object such as a network socket can be mimicked by a mock object, allowing the programmer to discover whether the object being tested responds appropriately to the wide variety of states such objects may be in.

Mocks and fakes

Some authors draw a distinction between fake and mock objects. Fakes are the simpler of the two, simply implementing the same interface as the object that they represent and returning pre-arranged responses. Mock objects in this sense do a little more: their method implementations contain assertions of their own. This means that a true mock, in this sense, will examine the context of each call—perhaps checking the order in which its methods are called, perhaps performing tests on the data passed into the method calls as arguments.

Setting expectations

Consider an example where an authorization sub-system has been mocked. The mock object implements an isUserAllowed(task : Task) : boolean method to match that in the real authorization class. Many advantages follow if it also exposes an isAllowed : boolean property which is not present in the real class. This allows test code easily to set the expectation that a user will, or will not, be granted permission in the next call and therefore readily to test the behaviour of the rest of the system in either case.

Writing log strings

A mock database object's save(person : Person) method may contain not much if any implementation code. It might or might not check the existence and perhaps the validity of the Person object passed in for saving (see fake vs. mock discussion above), but beyond that there might be no other implementation.

This would be to miss an opportunity. The mock method could add an entry to a public log string. The entry need be no more than "Person saved\n", or it may include some details from the person object instance, such as a name or ID. If the test code also checks the final contents of the log string after various series of operations involving the mock database then it is possible to verify that in each case exactly the expected number of database saves have been performed. This can find otherwise invisible performance-sapping bugs, for example, where a developer, nervous of losing data, has coded repeated calls to save() where just one would have sufficed.

Use in test-driven development

Programmers working with the test-driven development (TDD) methodology make use of mock objects when writing software. Mock objects meet the interface requirements of, and stand in for, more complex real ones; thus they allow programmers to write and unit-test functionality in one area without actually calling complex underlying or collaborating classes.

Apart from complexity issues and the benefits gained from this separation of concerns, there are practical speed issues involved. Developing a realistic piece of software using TDD may easily involve several hundred unit tests. If many of these induce communication with databases, web services and other out-of-process or networked systems, then the suite of unit tests will quickly become too slow to be run regularly. This in turn leads to bad habits and a reluctance by the developer to maintain the basic tenets of TDD.

When mock objects are replaced by real ones then the end-to-end functionality will need further testing. These will be integration tests rather than unit tests.

See also

• Method stub
• Virtual mock

External links

• Mock object module for Perl: Test::MockObject
• Mock object library for Delphi, Kylix, FreePascal: Pascal Mock
• Mock object library for Python: pMock
• Mock object frameworks for Java: JMock, EasyMock, rMock, MockCreator, MockLib
• Mock object frameworks for C#: NMockLib, Rhino Mocks, NMock and NMock 2, Attach, TypeMock.NET
• Mock object frameworks for Ruby: Mocha, RSpec, FlexMock
• Mock object framework for ActionScript 2.0: As2lib Mock Object
• Mock object framework for JavaScript: JSMock, Mock4JS
• Mock object library for C++ mockpp
• Mock object framework for Dolphin Smalltalk SMock
• Doubler a test double code generator for .NET.

• Test Doubles: a section of a book on unit testing patterns.
• All about mock objects! Portal concerning mock objects
• Mock Roles, not Objects, a paper on the technique that was presented at OOPSLA 2004.
• Using mock objects for complex unit tests IBM developerWorks
• Unit testing with mock objects IBM developerWorks
• Mocks Aren't Stubs (Martin Fowler) Article about developing tests with Mock objects. Touches on points about the impact on design and maintenance.
• Mocking the Embedded World is an article about adapting the mocking principle for the embedded software development world with a case study.