Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apriorit/gmock-global
Provides ability to mock global functions with gmock
https://github.com/apriorit/gmock-global
cpp gmock gtest header-only library mock mocking unittest
Last synced: about 5 hours ago
JSON representation
Provides ability to mock global functions with gmock
- Host: GitHub
- URL: https://github.com/apriorit/gmock-global
- Owner: apriorit
- License: mit
- Created: 2017-08-11T13:36:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T11:44:09.000Z (4 months ago)
- Last Synced: 2024-08-02T22:56:10.244Z (4 months ago)
- Topics: cpp, gmock, gtest, header-only, library, mock, mocking, unittest
- Language: C++
- Homepage:
- Size: 30.3 KB
- Stars: 70
- Watchers: 13
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gmock-global [](https://github.com/apriorit/gmock-global/actions/workflows/ci.yml)
This header-only library implements [gmock](https://github.com/google/googletest/blob/master/googlemock) functionality for global functions.
- [Introduction](#introduction)
- [Usage](#usage)
- [Step 1: Adding includes](#step-1-adding-includes)
- [Step 2: Declare mock global](#step-2-declare-mock-global)
- [Known issues](#known-issues)
- [Samples](#samples)
- [License](#license)
- [Version history](#version-history)
- [Version 1.0.2 (28 Aug 2019)](#version-102-28-aug-2019)
- [Version 1.0.1 (19 Apr 2019)](#version-101-19-apr-2019)
- [Version 1.0.0 (17 Oct 2017)](#version-100-17-oct-2017)
# Introduction
[Gmock](https://github.com/google/googletest/blob/master/googlemock) is a C++ framework for writing [mock classes](https://en.wikipedia.org/wiki/Mock_object). It is very convenient to create mock objects for mocking of methods. But [gmock](https://github.com/google/googletest/blob/master/googlemock) can not mock global functions. This problem is quite common but has no trivial solution. [Gmock FAQ](https://github.com/google/googlemock/blob/master/googlemock/docs/FrequentlyAskedQuestions.md#my-code-calls-a-staticglobal-function--can-i-mock-it) says you are doing something wrong if you need to mock static or global functions. However it is required in some cases and [gmock-global](https://github.com/apriorit/gmock-global) provides such functionality.
## Supported environment
- gmock version 1.8.1-1.15.2 (older versions may work too but they are not covered by CI)
- gcc/clang/msvc
# Usage
## Step 1: Adding includes
At first your project needs to know about [gmock-global](https://github.com/apriorit/gmock-global).
1. Add `gmock-global/include` to the project include paths.
2. Add `#include ` after [gmock](https://github.com/google/googletest/blob/master/googlemock) include.
## Step 2: Declare mock global
Syntax is most similar to [gmock](https://github.com/google/googletest/blob/master/googlemock). For example, to mock function `multiply` with two `double` arguments and `double` result you have to write declaration:
```cpp
MOCK_GLOBAL_FUNC2(multiply, double(double, double));
```
You can check call count of such function using `EXPECT_GLOBAL_CALL` macro, same as you used `EXPECT_CALL` macro for classes:
```cpp
EXPECT_GLOBAL_CALL(multiply, multiply(1, 2));
```
The `.Times(...)` and other methods will be work too.
In result mocking of global `double multiply(double, double)` looks like:
```cpp
MOCK_GLOBAL_FUNC2(multiply, double(double, double));
...
TEST(TestGlobal, CanMultiplyGlobal)
{
EXPECT_GLOBAL_CALL(multiply, multiply(1, 2)).Times(1);
multiply(1, 2);
}
```
Also you can use `ON_GLOBAL_CALL` to specify default behavior. `ON_GLOBAL_NICE_CALL` can be used to set default behavior with suppressed warning when this mock was actually called.
[gmock-global](https://github.com/apriorit/gmock-global) supports more than 10 arguments with [gtest version 1.8.1](https://github.com/google/googletest/releases/tag/release-1.8.1). But it requires [gmock-more-args version 1.0.1](https://github.com/apriorit/gmock-more-args/releases/tag/1.0.1) in case you use [gtest version 1.8.0](https://github.com/google/googletest/releases/tag/release-1.8.0)
# Known issues
The [after clause](https://github.com/google/googletest/blob/master/googlemock/docs/CheatSheet.md#the-after-clause) can't be using with [gmock-global](https://github.com/apriorit/gmock-global), use `Sequences` instead.
# Samples
Take a look at the test [sample](https://github.com/apriorit/gmock-global/tree/master/sample).
# License
[gmock-global](https://github.com/apriorit/gmock-global) is licensed under the MIT License. You can freely use it in your commercial or opensource software.
# Version history
## Version 1.0.2 (28 Aug 2019)
- Added ON_GLOBAL_CALL (#4)
- Segmentation fault when executing tests on a function that has been mocked in another test (#2)
## Version 1.0.1 (19 Apr 2019)
- Specified compatibility with gtest 1.8.1
- Fixed warnings
## Version 1.0.0 (17 Oct 2017)
- Initial public release