Skip to content

binshuohu/FakeIt

 
 

Repository files navigation

FakeIt

GCC: Build Status GCC Coverage Status

MSC: Build status MSC

FakeIt is a simple mocking framework for C++. It supports GCC, Clang and MS Visual C++.

FakeIt is written in C++11 and can be used for testing both C++11 and C++ projects.

struct SomeInterface {
	virtual int foo(int) = 0;
	virtual int bar(string) = 0;
};
// Instantiate a mock object.
Mock<SomeInterface> mock;

// Setup mock behavior.
When(Method(mock,foo)).Return(1); // Method mock.foo will return 1 once.

// Fetch the mock instance.
SomeInterface &i = mock.get();

// Will print "1". 
cout << i.foo(0);

Verify method invocation

Mock<SomeInterface> mock;
		
When(Method(mock,foo)).Return(0);

SomeInterface &i = mock.get();

// Production code
i.foo(1);

// Verify method mock.foo was invoked.
Verify(Method(mock,foo));

// Verify method mock.foo was invoked with specific arguments.
Verify(Method(mock,foo).Using(1));

Checkout the Quickstart for many more examples!

Download the Latest Release and start using FakeIt now!

Features

  • Very simple API based on the expressiveness of C++11.
  • Supports all major compilers: GCC, Clang and MSC++.
  • Easily integrated with GTest, MS Test and Boost Test.
  • Expressive Arrange-Act-Assert syntax.
  • Create mock classes or spy existing objects instantly in one simple line.
  • No limitation on number of method arguments.
  • Supports dynamic casting.

Installation

FakeIt is a template library. It does not require any installation. All you need to do is to download the source files and add the "include" folder and the configuration folder of your choice to the include path of your project. For example:

  • To use fakeit with Google Test add the "include" folder and the "config/gtest" folder to the include path of your test project:
-I"<fakeit_folder>/include" -I"<fakeit_folder>/config/gtest"
  • To use fakeit with MS Test add the "include" folder and the "config/mstest" folder to the include path of your test project:
-I"<fakeit_folder>/include" -I"<fakeit_folder>/config/mstest"
  • To use fakeit with Boost Test add the "include" folder and the "config/boost" folder to the include path of your test project:
-I"<fakeit_folder>/include" -I"<fakeit_folder>/config/boost"
  • To use fakeit with tpunit add the "include" folder and the "config/tpunit" folder to the include path of your test project:
-I"<fakeit_folder>/include" -I"<fakeit_folder>/config/tpunit"
  • To use fakeit without any testing framework integration (standalone) add the "include" folder and the "config/standalone" folder to the include path of your test project:
-I"<fakeit_folder>/include" -I"<fakeit_folder>/config/standalone"

It is recommended to build and run the unit tests to make sure FakeIt fits your environment.

Building and Running the Unit Tests with GCC

cd build
make all

run the tests by typing

./fakit_tests.exe

Building and Running the Unit Tests with Visual Studio

Open the tests/all_tests.vcxproj project file with Visual Studio 2013. Build and run the project and check the test results.

Limitations

  • Currently only GCC, Clang and MSC++ are supported.
  • Can't mock classes with multiple inheritance.
  • Can't mock classes with virtual inheritance.
  • Currently mocks are not thread safe.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 95.5%
  • Python 3.8%
  • Makefile 0.7%