README.md 13.3 KB
Newer Older
1
2
Google C++ Mocking Framework
============================
3

Billy Donahue's avatar
Billy Donahue committed
4
<http://github.com/google/googlemock/>
5
6
7

Overview
--------
8
9
10
11
12
13

Google's framework for writing and using C++ mock classes on a variety
of platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc).
Inspired by jMock, EasyMock, and Hamcrest, and designed with C++'s
specifics in mind, it can help you derive better designs of your
system and write better tests.
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

Google Mock:

- provides a declarative syntax for defining mocks,
- can easily define partial (hybrid) mocks, which are a cross of real
  and mock objects,
- handles functions of arbitrary types and overloaded functions,
- comes with a rich set of matchers for validating function arguments,
- uses an intuitive syntax for controlling the behavior of a mock,
- does automatic verification of expectations (no record-and-replay
  needed),
- allows arbitrary (partial) ordering constraints on
  function calls to be expressed,
- lets a user extend it by defining new matchers and actions.
- does not use exceptions, and
- is easy to learn and use.

31
32
33
34
Please see the project page above for more information as well as the
mailing list for questions, discussions, and development.  There is
also an IRC channel on OFTC (irc.oftc.net) #gtest available.  Please
join us!
35

Billy Donahue's avatar
Billy Donahue committed
36
37
Please note that code under scripts/generator/ is from the [cppclean
project](http://code.google.com/p/cppclean/) and under the Apache
shiqian's avatar
shiqian committed
38
License, which is different from Google Mock's license.
39

40
41
42
Requirements for End Users
--------------------------

Billy Donahue's avatar
Billy Donahue committed
43
44
45
Google Mock is implemented on top of the [Google Test C++ testing
framework](http://github.com/google/googletest/), and depends on it.
You must use the bundled version of Google Test when using Google Mock, or
46
you may get compiler/linker errors.
47

48
49
50
You can also easily configure Google Mock to work with another testing
framework of your choice; although it will still need Google Test as
an internal dependency.  Please read
Billy Donahue's avatar
Billy Donahue committed
51
<http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework>
52
53
for how to do it.

54
55
56
57
Google Mock depends on advanced C++ features and thus requires a more
modern compiler.  The following are needed to use Google Mock:

### Linux Requirements ###
58

59
60
These are the base requirements to build and use Google Mock from a source
package (as described below):
61

62
63
64
  * GNU-compatible Make or "gmake"
  * POSIX-standard shell
  * POSIX(-2) Regular Expressions (regex.h)
65
  * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer)
66
67

### Windows Requirements ###
68

69
70
71
  * Microsoft Visual C++ 8.0 SP1 or newer

### Mac OS X Requirements ###
72

73
74
75
  * Mac OS X 10.4 Tiger or newer
  * Developer Tools Installed

76
77
78
79
80
81
82
83
84
85
86
87
88
Requirements for Contributors
-----------------------------

We welcome patches.  If you plan to contribute a patch, you need to
build Google Mock and its own tests from an SVN checkout (described
below), which has further requirements:

  * Automake version 1.9 or newer
  * Autoconf version 2.59 or newer
  * Libtool / Libtoolize
  * Python version 2.3 or newer (for running some of the tests and
    re-generating certain source files from templates)

89
90
91
Getting the Source
------------------

92
There are two primary ways of getting Google Mock's source code: you
Billy Donahue's avatar
Billy Donahue committed
93
94
95
can download a [stable source release](releases),
or directly check out the source from our Git repository.
The Git checkout requires a few extra steps and some extra software
96
97
packages on your system, but lets you track development and make
patches much more easily, so we highly encourage it.
98

Billy Donahue's avatar
Billy Donahue committed
99
### Git Checkout ###
100

Billy Donahue's avatar
Billy Donahue committed
101
To check out the master branch of Google Mock, run the following git command:
102

Billy Donahue's avatar
Billy Donahue committed
103
    git clone https://github.com/google/googlemock.git
104

Billy Donahue's avatar
Billy Donahue committed
105
If you are using a \*nix system and plan to use the GNU Autotools build
106
107
108
109
110
111
112
system to build Google Mock (described below), you'll need to
configure it now.  Otherwise you are done with getting the source
files.

To prepare the Autotools build system, enter the target directory of
the checkout command you used ('gmock-svn') and proceed with the
following command:
shiqian's avatar
shiqian committed
113

Billy Donahue's avatar
Billy Donahue committed
114
    autoreconf -fvi
shiqian's avatar
shiqian committed
115

116
117
118
119
Once you have completed this step, you are ready to build the library.
Note that you should only need to complete this step once.  The
subsequent 'make' invocations will automatically re-generate the bits
of the build system that need to be changed.
120

121
122
123
124
If your system uses older versions of the autotools, the above command
will fail.  You may need to explicitly specify a version to use.  For
instance, if you have both GNU Automake 1.4 and 1.9 installed and
'automake' would invoke the 1.4, use instead:
125

Billy Donahue's avatar
Billy Donahue committed
126
    AUTOMAKE=automake-1.9 ACLOCAL=aclocal-1.9 autoreconf -fvi
127

shiqian's avatar
shiqian committed
128
Make sure you're using the same version of automake and aclocal.
129

130
131
Setting up the Build
--------------------
132

133
134
135
136
To build Google Mock and your tests that use it, you need to tell your
build system where to find its headers and source files.  The exact
way to do it depends on which build system you use, and is usually
straightforward.
137

138
### Generic Build Instructions ###
139

140
141
142
This section shows how you can integrate Google Mock into your
existing build system.

Billy Donahue's avatar
Billy Donahue committed
143
144
Suppose you put Google Mock in directory ${GMOCK\_DIR} and Google Test
in ${GTEST\_DIR} (the latter is ${GMOCK\_DIR}/gtest by default).  To
145
146
147
build Google Mock, create a library build target (or a project as
called by Visual Studio and Xcode) to compile

Billy Donahue's avatar
Billy Donahue committed
148
    ${GTEST_DIR}/src/gtest-all.cc and ${GMOCK_DIR}/src/gmock-all.cc
149
150
151

with

Billy Donahue's avatar
Billy Donahue committed
152
    ${GTEST_DIR}/include and ${GMOCK_DIR}/include
153

154
155
in the system header search path, and

Billy Donahue's avatar
Billy Donahue committed
156
    ${GTEST_DIR} and ${GMOCK_DIR}
157
158

in the normal header search path.  Assuming a Linux-like system and gcc,
159
160
something like the following will do:

Billy Donahue's avatar
Billy Donahue committed
161
162
163
164
165
166
167
    g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \
        -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \
        -pthread -c ${GTEST_DIR}/src/gtest-all.cc
    g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \
        -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \
        -pthread -c ${GMOCK_DIR}/src/gmock-all.cc
    ar -rv libgmock.a gtest-all.o gmock-all.o
168

169
170
(We need -pthread as Google Test and Google Mock use threads.)

171
Next, you should compile your test source file with
Billy Donahue's avatar
Billy Donahue committed
172
${GTEST\_DIR}/include and ${GMOCK\_DIR}/include in the header search
173
174
path, and link it with gmock and any other necessary libraries:

Billy Donahue's avatar
Billy Donahue committed
175
176
    g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \
        -pthread path/to/your_test.cc libgmock.a -o your_test
177
178
179
180
181
182
183
184
185
186
187

As an example, the make/ directory contains a Makefile that you can
use to build Google Mock on systems where GNU make is available
(e.g. Linux, Mac OS X, and Cygwin).  It doesn't try to build Google
Mock's own tests.  Instead, it just builds the Google Mock library and
a sample test.  You can use it as a starting point for your own build
script.

If the default settings are correct for your environment, the
following commands should succeed:

Billy Donahue's avatar
Billy Donahue committed
188
189
190
    cd ${GMOCK_DIR}/make
    make
    ./gmock_test
191

Billy Donahue's avatar
Billy Donahue committed
192
If you see errors, try to tweak the contents of [make/Makefile](make/Makefile) to make them go away.
193
194
195

### Windows ###

196
197
198
The msvc/2005 directory contains VC++ 2005 projects and the msvc/2010
directory contains VC++ 2010 projects for building Google Mock and
selected tests.
199

200
201
202
Change to the appropriate directory and run "msbuild gmock.sln" to
build the library and tests (or open the gmock.sln in the MSVC IDE).
If you want to create your own project to use with Google Mock, you'll
Billy Donahue's avatar
Billy Donahue committed
203
have to configure it to use the `gmock_config` propety sheet.  For that:
204
205
206

 * Open the Property Manager window (View | Other Windows | Property Manager)
 * Right-click on your project and select "Add Existing Property Sheet..."
Billy Donahue's avatar
Billy Donahue committed
207
 * Navigate to `gmock_config.vsprops` or `gmock_config.props` and select it.
208
209
210
211
212
213
214
215
216
217
 * In Project Properties | Configuration Properties | General | Additional
   Include Directories, type <path to Google Mock>/include.

Tweaking Google Mock
--------------------

Google Mock can be used in diverse environments.  The default
configuration may not work (or may not work well) out of the box in
some environments.  However, you can easily tweak Google Mock by
defining control macros on the compiler command line.  Generally,
Billy Donahue's avatar
Billy Donahue committed
218
these macros are named like `GTEST_XYZ` and you define them to either 1
219
220
221
or 0 to enable or disable a certain feature.

We list the most frequently used macros below.  For a complete list,
Billy Donahue's avatar
Billy Donahue committed
222
223
see file [${GTEST\_DIR}/include/gtest/internal/gtest-port.h](
../googletest/include/gtest/internal/gtest-port.h).
224
225

### Choosing a TR1 Tuple Library ###
226

227
228
229
230
231
232
233
234
235
236
Google Mock uses the C++ Technical Report 1 (TR1) tuple library
heavily.  Unfortunately TR1 tuple is not yet widely available with all
compilers.  The good news is that Google Test 1.4.0+ implements a
subset of TR1 tuple that's enough for Google Mock's need.  Google Mock
will automatically use that implementation when the compiler doesn't
provide TR1 tuple.

Usually you don't need to care about which tuple library Google Test
and Google Mock use.  However, if your project already uses TR1 tuple,
you need to tell Google Test and Google Mock to use the same TR1 tuple
237
library the rest of your project uses, or the two tuple
238
239
implementations will clash.  To do that, add

Billy Donahue's avatar
Billy Donahue committed
240
    -DGTEST_USE_OWN_TR1_TUPLE=0
241
242

to the compiler flags while compiling Google Test, Google Mock, and
243
244
245
your tests.  If you want to force Google Test and Google Mock to use
their own tuple library, just add

Billy Donahue's avatar
Billy Donahue committed
246
    -DGTEST_USE_OWN_TR1_TUPLE=1
247
248

to the compiler flags instead.
249
250
251
252
253

If you want to use Boost's TR1 tuple library with Google Mock, please
refer to the Boost website (http://www.boost.org/) for how to obtain
it and set it up.

254
255
256
257
### As a Shared Library (DLL) ###

Google Mock is compact, so most users can build and link it as a static
library for the simplicity.  Google Mock can be used as a DLL, but the
Billy Donahue's avatar
Billy Donahue committed
258
259
260
same DLL must contain Google Test as well.  See
[Google Test's README][gtest_readme]
for instructions on how to set up necessary compiler settings.
261
262

### Tweaking Google Mock ###
263

264
Most of Google Test's control macros apply to Google Mock as well.
Billy Donahue's avatar
Billy Donahue committed
265
Please see [Google Test's README][gtest_readme] for how to tweak them.
266

267
268
Upgrading from an Earlier Version
---------------------------------
269

270
271
272
273
We strive to keep Google Mock releases backward compatible.
Sometimes, though, we have to make some breaking changes for the
users' long-term benefits.  This section describes what you'll need to
do if you are upgrading from an earlier version of Google Mock.
274

vladlosev's avatar
vladlosev committed
275
### Upgrading from 1.1.0 or Earlier ###
shiqian's avatar
shiqian committed
276

277
You may need to explicitly enable or disable Google Test's own TR1
Billy Donahue's avatar
Billy Donahue committed
278
279
tuple library.  See the instructions in section "[Choosing a TR1 Tuple
Library](../googletest/#choosing-a-tr1-tuple-library)".
280

281
### Upgrading from 1.4.0 or Earlier ###
282

283
284
285
On platforms where the pthread library is available, Google Test and
Google Mock use it in order to be thread-safe.  For this to work, you
may need to tweak your compiler and/or linker flags.  Please see the
Billy Donahue's avatar
Billy Donahue committed
286
287
"[Multi-threaded Tests](../googletest#multi-threaded-tests
)" section in file Google Test's README for what you may need to do.
288

Billy Donahue's avatar
Billy Donahue committed
289
290
291
292
293
294
If you have custom matchers defined using `MatcherInterface` or
`MakePolymorphicMatcher()`, you'll need to update their definitions to
use the new matcher API (
[monomorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Monomorphic_Matchers),
[polymorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers)).
Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected.
295
296


297
298
Developing Google Mock
----------------------
299

300
301
302
303
304
305
306
307
308
309
This section discusses how to make your own changes to Google Mock.

### Testing Google Mock Itself ###

To make sure your changes work as intended and don't break existing
functionality, you'll want to compile and run Google Test's own tests.
For that you'll need Autotools.  First, make sure you have followed
the instructions in section "SVN Checkout" to configure Google Mock.
Then, create a build output directory and enter it.  Next,

Billy Donahue's avatar
Billy Donahue committed
310
    ${GMOCK_DIR}/configure  # Standard GNU configure script, --help for more info
311
312
313
314

Once you have successfully configured Google Mock, the build steps are
standard for GNU-style OSS packages.

Billy Donahue's avatar
Billy Donahue committed
315
316
    make        # Standard makefile following GNU conventions
    make check  # Builds and runs all tests - all should pass.
317
318
319
320
321
322

Note that when building your project against Google Mock, you are building
against Google Test as well.  There is no need to configure Google Test
separately.

### Regenerating Source Files ###
323
324
325
326

Some of Google Mock's source files are generated from templates (not
in the C++ sense) using a script.  A template file is named FOO.pump,
where FOO is the name of the file it will generate.  For example, the
Billy Donahue's avatar
Billy Donahue committed
327
328
file `include/gmock/gmock-generated-actions.h.pump` is used to generate
`gmock-generated-actions.h` in the same directory.
329
330

Normally you don't need to worry about regenerating the source files,
331
unless you need to modify them.  In that case, you should modify the
Billy Donahue's avatar
Billy Donahue committed
332
corresponding `.pump` files instead and run the 'pump' script (for Pump
333
is Useful for Meta Programming) to regenerate them.  You can find
Billy Donahue's avatar
Billy Donahue committed
334
335
336
pump.py in the `${GTEST_DIR}/scripts/` directory.  Read the
[Pump manual](http://code.google.com/p/googletest/wiki/PumpManual)
for how to use it.
337
338
339
340


### Contributing a Patch ###

Billy Donahue's avatar
Billy Donahue committed
341
342
We welcome patches.  Please read the [Google Mock developer's Guide](
http://code.google.com/p/googlemock/wiki/DevGuide)
343
344
345
346
for how you can contribute.  In particular, make sure you have signed
the Contributor License Agreement, or we won't be able to accept the
patch.

347
348

Happy testing!
Billy Donahue's avatar
Billy Donahue committed
349
350

[gtest_readme]: ../googletest/ "googletest"