An Apex mocking framework for true unit testing in Salesforce, with Stub API support
Clone or download

README.md

FinancialForce ApexMocks Framework

Build Status

ApexMocks is a mocking framework for the Force.com Apex language.

It derives it's inspiration from the well known Java mocking framework Mockito

Deploy to Salesforce

Setup

  • Clone this repo
  • Copy the build.properties.template file into build.properties file and add your salesforce username and password.
  • Do ant deploy to get the classes in your dev org.

Using ApexMocks on Force.com

ApexMocks allows you to write tests to both verify behaviour and stub dependencies.

An assumption is made that you are using some form of Dependency Injection - for example passing dependencies via a constructor:

public MyClass(ClassA.IClassA dependencyA, ClassB.IClassB dependencyB)

This allows you to pass mock implementations of dependencies A and B when you want to unit test MyClass.

Lets assume we've written our own list interface fflib_MyList.IList that we want to either verify or stub:

public class fflib_MyList implements IList
{
	public interface IList
	{
		void add(String value);
		String get(Integer index);
		void clear();
		Boolean isEmpty();
	}
}

verify() behaviour verification

	// Given
	fflib_ApexMocks mocks = new fflib_ApexMocks();
	fflib_MyList.IList mockList = (fflib_MyList.IList)mocks.mock(fflib_MyList.class);

	// When
	mockList.add('bob');

	// Then
	((fflib_MyList.IList) mocks.verify(mockList)).add('bob');
	((fflib_MyList.IList) mocks.verify(mockList, fflib_ApexMocks.NEVER)).clear();

when() dependency stubbing

	fflib_ApexMocks mocks = new fflib_ApexMocks();
	fflib_MyList.IList mockList = (fflib_MyList.IList)mocks.mock(fflib_MyList.class);

	mocks.startStubbing();
	mocks.when(mockList.get(0)).thenReturn('bob');
	mocks.when(mockList.get(1)).thenReturn('fred');
	mocks.stopStubbing();

Stub API

ApexMocks now implements the Stub API!

Previously, stub objects had to be generated using the ApexMocks generator at compile time. Now, stub objects can be generated dynamically at run time.

fflib_ApexMocks mocks = new fflib_ApexMocks();
fflib_MyList mockList = (fflib_MyList)mocks.mock(fflib_MyList.class);

You can continue to use the ApexMocks generator, if you wish, but this is no longer a prerequisite to using ApexMocks.

Generating Mock files

Run the apex mocks generator from the command line.

	java -jar apex-mocks-generator-4.0.0.jar
		<Filepath to source files>
		<Filepath to interface properties file>
		<Name of generated mocks class>
		<Filepath to target files - can be the same as filepath to source files>
		<API version of generated mocks class - optional argument, 30.0 by default>

	//E.g. the command used to generate the current version of fflib_Mocks.
	java -jar apex-mocks-generator-4.0.0.jar "/Users/jbloggs/Dev/fflib-apex-mocks/src/classes" "/Users/jbloggs/Dev/fflib-apex-mocks/interfacemocks.properties" "fflib_Mocks" "/Users/jbloggs/Dev/fflib-apex-mocks/src/classes" "30.0"

Instantiate the generated classes as follows:

	fflib_ApexMocks mocks = new fflib_ApexMocks();
	fflib_MyList.IList mockList = new MockMyList(mocks);

Documentation