1 ## Google Mock ## 2 3 The Google C++ mocking framework. 4 5 ### Overview ### 6 7 Google's framework for writing and using C++ mock classes. 8 It can help you derive better designs of your system and write better tests. 9 10 It is inspired by: 11 12 * [jMock](http://www.jmock.org/), 13 * [EasyMock](http://www.easymock.org/), and 14 * [Hamcrest](http://code.google.com/p/hamcrest/), 15 16 and designed with C++'s specifics in mind. 17 18 Google mock: 19 20 * lets you create mock classes trivially using simple macros. 21 * supports a rich set of matchers and actions. 22 * handles unordered, partially ordered, or completely ordered expectations. 23 * is extensible by users. 24 25 We hope you find it useful! 26 27 ### Features ### 28 29 * Provides a declarative syntax for defining mocks. 30 * Can easily define partial (hybrid) mocks, which are a cross of real 31 and mock objects. 32 * Handles functions of arbitrary types and overloaded functions. 33 * Comes with a rich set of matchers for validating function arguments. 34 * Uses an intuitive syntax for controlling the behavior of a mock. 35 * Does automatic verification of expectations (no record-and-replay needed). 36 * Allows arbitrary (partial) ordering constraints on 37 function calls to be expressed,. 38 * Lets an user extend it by defining new matchers and actions. 39 * Does not use exceptions. 40 * Is easy to learn and use. 41 42 Please see the project page above for more information as well as the 43 mailing list for questions, discussions, and development. There is 44 also an IRC channel on OFTC (irc.oftc.net) #gtest available. Please 45 join us! 46 47 Please note that code under [scripts/generator](scripts/generator/) is 48 from [cppclean](http://code.google.com/p/cppclean/) and released under 49 the Apache License, which is different from Google Mock's license. 50 51 ## Getting Started ## 52 53 If you are new to the project, we suggest that you read the user 54 documentation in the following order: 55 56 * Learn the [basics](../../master/googletest/docs/Primer.md) of 57 Google Test, if you choose to use Google Mock with it (recommended). 58 * Read [Google Mock for Dummies](../../master/googlemock/docs/ForDummies.md). 59 * Read the instructions below on how to build Google Mock. 60 61 You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. 62 63 Once you understand the basics, check out the rest of the docs: 64 65 * [CheatSheet](../../master/googlemock/docs/CheatSheet.md) - all the commonly used stuff 66 at a glance. 67 * [CookBook](../../master/googlemock/docs/CookBook.md) - recipes for getting things done, 68 including advanced techniques. 69 70 If you need help, please check the 71 [KnownIssues](docs/KnownIssues.md) and 72 [FrequentlyAskedQuestions](docs/FrequentlyAskedQuestions.md) before 73 posting a question on the 74 [discussion group](http://groups.google.com/group/googlemock). 75 76 77 ### Using Google Mock Without Google Test ### 78 79 Google Mock is not a testing framework itself. Instead, it needs a 80 testing framework for writing tests. Google Mock works seamlessly 81 with [Google Test](https://github.com/google/googletest), but 82 you can also use it with [any C++ testing framework](../../master/googlemock/docs/ForDummies.md#using-google-mock-with-any-testing-framework). 83 84 ### Requirements for End Users ### 85 86 Google Mock is implemented on top of [Google Test]( 87 http://github.com/google/googletest/), and depends on it. 88 You must use the bundled version of Google Test when using Google Mock. 89 90 You can also easily configure Google Mock to work with another testing 91 framework, although it will still need Google Test. Please read 92 ["Using_Google_Mock_with_Any_Testing_Framework"]( 93 ../../master/googlemock/docs/ForDummies.md#using-google-mock-with-any-testing-framework) 94 for instructions. 95 96 Google Mock depends on advanced C++ features and thus requires a more 97 modern compiler. The following are needed to use Google Mock: 98 99 #### Linux Requirements #### 100 101 * GNU-compatible Make or "gmake" 102 * POSIX-standard shell 103 * POSIX(-2) Regular Expressions (regex.h) 104 * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer) 105 106 #### Windows Requirements #### 107 108 * Microsoft Visual C++ 8.0 SP1 or newer 109 110 #### Mac OS X Requirements #### 111 112 * Mac OS X 10.4 Tiger or newer 113 * Developer Tools Installed 114 115 ### Requirements for Contributors ### 116 117 We welcome patches. If you plan to contribute a patch, you need to 118 build Google Mock and its tests, which has further requirements: 119 120 * Automake version 1.9 or newer 121 * Autoconf version 2.59 or newer 122 * Libtool / Libtoolize 123 * Python version 2.3 or newer (for running some of the tests and 124 re-generating certain source files from templates) 125 126 ### Building Google Mock ### 127 128 #### Using CMake #### 129 130 If you have CMake available, it is recommended that you follow the 131 [build instructions][gtest_cmakebuild] 132 as described for Google Test. 133 134 If are using Google Mock with an 135 existing CMake project, the section 136 [Incorporating Into An Existing CMake Project][gtest_incorpcmake] 137 may be of particular interest. 138 To make it work for Google Mock you will need to change 139 140 target_link_libraries(example gtest_main) 141 142 to 143 144 target_link_libraries(example gmock_main) 145 146 This works because `gmock_main` library is compiled with Google Test. 147 However, it does not automatically add Google Test includes. 148 Therefore you will also have to change 149 150 if (CMAKE_VERSION VERSION_LESS 2.8.11) 151 include_directories("${gtest_SOURCE_DIR}/include") 152 endif() 153 154 to 155 156 if (CMAKE_VERSION VERSION_LESS 2.8.11) 157 include_directories(BEFORE SYSTEM 158 "${gtest_SOURCE_DIR}/include" "${gmock_SOURCE_DIR}/include") 159 else() 160 target_include_directories(gmock_main SYSTEM BEFORE INTERFACE 161 "${gtest_SOURCE_DIR}/include" "${gmock_SOURCE_DIR}/include") 162 endif() 163 164 This will addtionally mark Google Mock includes as system, which will 165 silence compiler warnings when compiling your tests using clang with 166 `-Wpedantic -Wall -Wextra -Wconversion`. 167 168 169 #### Preparing to Build (Unix only) #### 170 171 If you are using a Unix system and plan to use the GNU Autotools build 172 system to build Google Mock (described below), you'll need to 173 configure it now. 174 175 To prepare the Autotools build system: 176 177 cd googlemock 178 autoreconf -fvi 179 180 To build Google Mock and your tests that use it, you need to tell your 181 build system where to find its headers and source files. The exact 182 way to do it depends on which build system you use, and is usually 183 straightforward. 184 185 This section shows how you can integrate Google Mock into your 186 existing build system. 187 188 Suppose you put Google Mock in directory `${GMOCK_DIR}` and Google Test 189 in `${GTEST_DIR}` (the latter is `${GMOCK_DIR}/gtest` by default). To 190 build Google Mock, create a library build target (or a project as 191 called by Visual Studio and Xcode) to compile 192 193 ${GTEST_DIR}/src/gtest-all.cc and ${GMOCK_DIR}/src/gmock-all.cc 194 195 with 196 197 ${GTEST_DIR}/include and ${GMOCK_DIR}/include 198 199 in the system header search path, and 200 201 ${GTEST_DIR} and ${GMOCK_DIR} 202 203 in the normal header search path. Assuming a Linux-like system and gcc, 204 something like the following will do: 205 206 g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \ 207 -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \ 208 -pthread -c ${GTEST_DIR}/src/gtest-all.cc 209 g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \ 210 -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \ 211 -pthread -c ${GMOCK_DIR}/src/gmock-all.cc 212 ar -rv libgmock.a gtest-all.o gmock-all.o 213 214 (We need -pthread as Google Test and Google Mock use threads.) 215 216 Next, you should compile your test source file with 217 ${GTEST\_DIR}/include and ${GMOCK\_DIR}/include in the header search 218 path, and link it with gmock and any other necessary libraries: 219 220 g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \ 221 -pthread path/to/your_test.cc libgmock.a -o your_test 222 223 As an example, the make/ directory contains a Makefile that you can 224 use to build Google Mock on systems where GNU make is available 225 (e.g. Linux, Mac OS X, and Cygwin). It doesn't try to build Google 226 Mock's own tests. Instead, it just builds the Google Mock library and 227 a sample test. You can use it as a starting point for your own build 228 script. 229 230 If the default settings are correct for your environment, the 231 following commands should succeed: 232 233 cd ${GMOCK_DIR}/make 234 make 235 ./gmock_test 236 237 If you see errors, try to tweak the contents of 238 [make/Makefile](make/Makefile) to make them go away. 239 240 ### Windows ### 241 242 The msvc/2005 directory contains VC++ 2005 projects and the msvc/2010 243 directory contains VC++ 2010 projects for building Google Mock and 244 selected tests. 245 246 Change to the appropriate directory and run "msbuild gmock.sln" to 247 build the library and tests (or open the gmock.sln in the MSVC IDE). 248 If you want to create your own project to use with Google Mock, you'll 249 have to configure it to use the `gmock_config` propety sheet. For that: 250 251 * Open the Property Manager window (View | Other Windows | Property Manager) 252 * Right-click on your project and select "Add Existing Property Sheet..." 253 * Navigate to `gmock_config.vsprops` or `gmock_config.props` and select it. 254 * In Project Properties | Configuration Properties | General | Additional 255 Include Directories, type <path to Google Mock>/include. 256 257 ### Tweaking Google Mock ### 258 259 Google Mock can be used in diverse environments. The default 260 configuration may not work (or may not work well) out of the box in 261 some environments. However, you can easily tweak Google Mock by 262 defining control macros on the compiler command line. Generally, 263 these macros are named like `GTEST_XYZ` and you define them to either 1 264 or 0 to enable or disable a certain feature. 265 266 We list the most frequently used macros below. For a complete list, 267 see file [${GTEST\_DIR}/include/gtest/internal/gtest-port.h]( 268 ../googletest/include/gtest/internal/gtest-port.h). 269 270 ### Choosing a TR1 Tuple Library ### 271 272 Google Mock uses the C++ Technical Report 1 (TR1) tuple library 273 heavily. Unfortunately TR1 tuple is not yet widely available with all 274 compilers. The good news is that Google Test 1.4.0+ implements a 275 subset of TR1 tuple that's enough for Google Mock's need. Google Mock 276 will automatically use that implementation when the compiler doesn't 277 provide TR1 tuple. 278 279 Usually you don't need to care about which tuple library Google Test 280 and Google Mock use. However, if your project already uses TR1 tuple, 281 you need to tell Google Test and Google Mock to use the same TR1 tuple 282 library the rest of your project uses, or the two tuple 283 implementations will clash. To do that, add 284 285 -DGTEST_USE_OWN_TR1_TUPLE=0 286 287 to the compiler flags while compiling Google Test, Google Mock, and 288 your tests. If you want to force Google Test and Google Mock to use 289 their own tuple library, just add 290 291 -DGTEST_USE_OWN_TR1_TUPLE=1 292 293 to the compiler flags instead. 294 295 If you want to use Boost's TR1 tuple library with Google Mock, please 296 refer to the Boost website (http://www.boost.org/) for how to obtain 297 it and set it up. 298 299 ### As a Shared Library (DLL) ### 300 301 Google Mock is compact, so most users can build and link it as a static 302 library for the simplicity. Google Mock can be used as a DLL, but the 303 same DLL must contain Google Test as well. See 304 [Google Test's README][gtest_readme] 305 for instructions on how to set up necessary compiler settings. 306 307 ### Tweaking Google Mock ### 308 309 Most of Google Test's control macros apply to Google Mock as well. 310 Please see [Google Test's README][gtest_readme] for how to tweak them. 311 312 ### Upgrading from an Earlier Version ### 313 314 We strive to keep Google Mock releases backward compatible. 315 Sometimes, though, we have to make some breaking changes for the 316 users' long-term benefits. This section describes what you'll need to 317 do if you are upgrading from an earlier version of Google Mock. 318 319 #### Upgrading from 1.1.0 or Earlier #### 320 321 You may need to explicitly enable or disable Google Test's own TR1 322 tuple library. See the instructions in section "[Choosing a TR1 Tuple 323 Library](../googletest/#choosing-a-tr1-tuple-library)". 324 325 #### Upgrading from 1.4.0 or Earlier #### 326 327 On platforms where the pthread library is available, Google Test and 328 Google Mock use it in order to be thread-safe. For this to work, you 329 may need to tweak your compiler and/or linker flags. Please see the 330 "[Multi-threaded Tests](../googletest#multi-threaded-tests 331 )" section in file Google Test's README for what you may need to do. 332 333 If you have custom matchers defined using `MatcherInterface` or 334 `MakePolymorphicMatcher()`, you'll need to update their definitions to 335 use the new matcher API ( 336 [monomorphic](./docs/CookBook.md#writing-new-monomorphic-matchers), 337 [polymorphic](./docs/CookBook.md#writing-new-polymorphic-matchers)). 338 Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected. 339 340 ### Developing Google Mock ### 341 342 This section discusses how to make your own changes to Google Mock. 343 344 #### Testing Google Mock Itself #### 345 346 To make sure your changes work as intended and don't break existing 347 functionality, you'll want to compile and run Google Test's own tests. 348 For that you'll need Autotools. First, make sure you have followed 349 the instructions above to configure Google Mock. 350 Then, create a build output directory and enter it. Next, 351 352 ${GMOCK_DIR}/configure # try --help for more info 353 354 Once you have successfully configured Google Mock, the build steps are 355 standard for GNU-style OSS packages. 356 357 make # Standard makefile following GNU conventions 358 make check # Builds and runs all tests - all should pass. 359 360 Note that when building your project against Google Mock, you are building 361 against Google Test as well. There is no need to configure Google Test 362 separately. 363 364 #### Contributing a Patch #### 365 366 We welcome patches. 367 Please read the [Developer's Guide](docs/DevGuide.md) 368 for how you can contribute. In particular, make sure you have signed 369 the Contributor License Agreement, or we won't be able to accept the 370 patch. 371 372 Happy testing! 373 374 [gtest_readme]: ../googletest/README.md "googletest" 375 [gtest_cmakebuild]: ../googletest/README.md#using-cmake "Using CMake" 376 [gtest_incorpcmake]: ../googletest/README.md#incorporating-into-an-existing-cmake-project "Incorporating Into An Existing CMake Project" 377
