3party/googletest
0
0
Fork 0
mirror of https://github.com/google/googletest.git synced 2025-03-10 17:36:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme.md updates

Browse Source
This commit is contained in:
Billy Donahue 2015-08-25 13:51:43 -04:00
parent 36d1a71bad
commit 06fcd9ff11
1 changed files with 69 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
README.md
View File

@ -1,7 +1,7 @@
Google C++ Mocking Framework Google C++ Mocking Framework
============================ ============================
http://code.google.com/p/googlemock/ <http://github.com/google/googlemock/>
Overview Overview
-------- --------
@ -33,23 +33,22 @@ mailing list for questions, discussions, and development. There is
also an IRC channel on OFTC (irc.oftc.net) #gtest available. Please also an IRC channel on OFTC (irc.oftc.net) #gtest available. Please
join us! join us!
Please note that code under scripts/generator/ is from the cppclean Please note that code under scripts/generator/ is from the [cppclean
project (http://code.google.com/p/cppclean/) and under the Apache project](http://code.google.com/p/cppclean/) and under the Apache
License, which is different from Google Mock's license. License, which is different from Google Mock's license.
Requirements for End Users Requirements for End Users
-------------------------- --------------------------
Google Mock is implemented on top of the Google Test C++ testing Google Mock is implemented on top of the [Google Test C++ testing
framework (http://code.google.com/p/googletest/), and includes the framework](http://github.com/google/googletest/), and depends on it.
latter as part of the SVN repository and distribution package. You You must use the bundled version of Google Test when using Google Mock, or
must use the bundled version of Google Test when using Google Mock, or
you may get compiler/linker errors. you may get compiler/linker errors.
You can also easily configure Google Mock to work with another testing You can also easily configure Google Mock to work with another testing
framework of your choice; although it will still need Google Test as framework of your choice; although it will still need Google Test as
an internal dependency. Please read an internal dependency. Please read
http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework <http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework>
for how to do it. for how to do it.
Google Mock depends on advanced C++ features and thus requires a more Google Mock depends on advanced C++ features and thus requires a more
@ -91,39 +90,19 @@ Getting the Source
------------------ ------------------
There are two primary ways of getting Google Mock's source code: you There are two primary ways of getting Google Mock's source code: you
can download a stable source release in your preferred archive format, can download a [stable source release](releases),
or directly check out the source from our Subversion (SVN) repository. or directly check out the source from our Git repository.
The SVN checkout requires a few extra steps and some extra software The Git checkout requires a few extra steps and some extra software
packages on your system, but lets you track development and make packages on your system, but lets you track development and make
patches much more easily, so we highly encourage it. patches much more easily, so we highly encourage it.
### Source Package ### ### Git Checkout ###
Google Mock is released in versioned source packages which can be To check out the master branch of Google Mock, run the following git command:
downloaded from the download page [1]. Several different archive
formats are provided, but the only difference is the tools needed to
extract their contents, and the size of the resulting file. Download
whichever you are most comfortable with.
[1] http://code.google.com/p/googlemock/downloads/list git clone https://github.com/google/googlemock.git
Once downloaded expand the archive using whichever tools you prefer If you are using a \*nix system and plan to use the GNU Autotools build
for that type. This will always result in a new directory with the
name "gmock-X.Y.Z" which contains all of the source code. Here are
some examples on Linux:
tar -xvzf gmock-X.Y.Z.tar.gz
tar -xvjf gmock-X.Y.Z.tar.bz2
unzip gmock-X.Y.Z.zip
### SVN Checkout ###
To check out the main branch (also known as the "trunk") of Google
Mock, run the following Subversion command:
svn checkout http://googlemock.googlecode.com/svn/trunk/ gmock-svn
If you are using a *nix system and plan to use the GNU Autotools build
system to build Google Mock (described below), you'll need to system to build Google Mock (described below), you'll need to
configure it now. Otherwise you are done with getting the source configure it now. Otherwise you are done with getting the source
files. files.
@ -161,8 +140,8 @@ straightforward.
This section shows how you can integrate Google Mock into your This section shows how you can integrate Google Mock into your
existing build system. existing build system.
Suppose you put Google Mock in directory ${GMOCK_DIR} and Google Test Suppose you put Google Mock in directory ${GMOCK\_DIR} and Google Test
in ${GTEST_DIR} (the latter is ${GMOCK_DIR}/gtest by default). To in ${GTEST\_DIR} (the latter is ${GMOCK\_DIR}/gtest by default). To
build Google Mock, create a library build target (or a project as build Google Mock, create a library build target (or a project as
called by Visual Studio and Xcode) to compile called by Visual Studio and Xcode) to compile
@ -190,7 +169,7 @@ something like the following will do:
(We need -pthread as Google Test and Google Mock use threads.) (We need -pthread as Google Test and Google Mock use threads.)
Next, you should compile your test source file with Next, you should compile your test source file with
${GTEST_DIR}/include and ${GMOCK_DIR}/include in the header search ${GTEST\_DIR}/include and ${GMOCK\_DIR}/include in the header search
path, and link it with gmock and any other necessary libraries: path, and link it with gmock and any other necessary libraries:
g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \ g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \
@ -210,9 +189,7 @@ following commands should succeed:
make make
./gmock_test ./gmock_test
If you see errors, try to tweak the contents of make/Makefile to make If you see errors, try to tweak the contents of [make/Makefile](make/Makefile) to make them go away.
them go away. There are instructions in make/Makefile on how to do
it.
### Windows ### ### Windows ###
@ -223,11 +200,11 @@ selected tests.
Change to the appropriate directory and run "msbuild gmock.sln" to 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). 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 If you want to create your own project to use with Google Mock, you'll
have to configure it to use the gmock_config propety sheet. For that: have to configure it to use the `gmock_config` propety sheet. For that:
* Open the Property Manager window (View | Other Windows | Property Manager) * Open the Property Manager window (View | Other Windows | Property Manager)
* Right-click on your project and select "Add Existing Property Sheet..." * Right-click on your project and select "Add Existing Property Sheet..."
* Navigate to gmock_config.vsprops or gmock_config.props and select it. * Navigate to `gmock_config.vsprops` or `gmock_config.props` and select it.
* In Project Properties | Configuration Properties | General | Additional * In Project Properties | Configuration Properties | General | Additional
Include Directories, type <path to Google Mock>/include. Include Directories, type <path to Google Mock>/include.
@ -238,11 +215,12 @@ Google Mock can be used in diverse environments. The default
configuration may not work (or may not work well) out of the box in configuration may not work (or may not work well) out of the box in
some environments. However, you can easily tweak Google Mock by some environments. However, you can easily tweak Google Mock by
defining control macros on the compiler command line. Generally, defining control macros on the compiler command line. Generally,
these macros are named like GTEST_XYZ and you define them to either 1 these macros are named like `GTEST_XYZ` and you define them to either 1
or 0 to enable or disable a certain feature. or 0 to enable or disable a certain feature.
We list the most frequently used macros below. For a complete list, We list the most frequently used macros below. For a complete list,
see file ${GTEST_DIR}/include/gtest/internal/gtest-port.h. see file [${GTEST\_DIR}/include/gtest/internal/gtest-port.h](
../googletest/include/gtest/internal/gtest-port.h).
### Choosing a TR1 Tuple Library ### ### Choosing a TR1 Tuple Library ###
@ -277,13 +255,14 @@ it and set it up.
Google Mock is compact, so most users can build and link it as a static 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 library for the simplicity. Google Mock can be used as a DLL, but the
same DLL must contain Google Test as well. See Google Test's README same DLL must contain Google Test as well. See
file for instructions on how to set up necessary compiler settings. [Google Test's README][gtest_readme]
for instructions on how to set up necessary compiler settings.
### Tweaking Google Mock ### ### Tweaking Google Mock ###
Most of Google Test's control macros apply to Google Mock as well. Most of Google Test's control macros apply to Google Mock as well.
Please see file ${GTEST_DIR}/README for how to tweak them. Please see [Google Test's README][gtest_readme] for how to tweak them.
Upgrading from an Earlier Version Upgrading from an Earlier Version
--------------------------------- ---------------------------------
@ -296,24 +275,24 @@ do if you are upgrading from an earlier version of Google Mock.
### Upgrading from 1.1.0 or Earlier ### ### Upgrading from 1.1.0 or Earlier ###
You may need to explicitly enable or disable Google Test's own TR1 You may need to explicitly enable or disable Google Test's own TR1
tuple library. See the instructions in section "Choosing a TR1 Tuple tuple library. See the instructions in section "[Choosing a TR1 Tuple
Library". Library](../googletest/#choosing-a-tr1-tuple-library)".
### Upgrading from 1.4.0 or Earlier ### ### Upgrading from 1.4.0 or Earlier ###
On platforms where the pthread library is available, Google Test and 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 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 may need to tweak your compiler and/or linker flags. Please see the
"Multi-threaded Tests" section in file ${GTEST_DIR}/README for what "[Multi-threaded Tests](../googletest#multi-threaded-tests
you may need to do. )" section in file Google Test's README for what you may need to do.
If you have custom matchers defined using MatcherInterface or If you have custom matchers defined using `MatcherInterface` or
MakePolymorphicMatcher(), you'll need to update their definitions to `MakePolymorphicMatcher()`, you'll need to update their definitions to
use the new matcher API [2]. Matchers defined using MATCHER() or use the new matcher API (
MATCHER_P*() aren't affected. [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.
[2] http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Monomorphic_Matchers,
http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers
Developing Google Mock Developing Google Mock
---------------------- ----------------------
@ -345,25 +324,27 @@ separately.
Some of Google Mock's source files are generated from templates (not 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, 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 where FOO is the name of the file it will generate. For example, the
file include/gmock/gmock-generated-actions.h.pump is used to generate file `include/gmock/gmock-generated-actions.h.pump` is used to generate
gmock-generated-actions.h in the same directory. `gmock-generated-actions.h` in the same directory.
Normally you don't need to worry about regenerating the source files, Normally you don't need to worry about regenerating the source files,
unless you need to modify them. In that case, you should modify the unless you need to modify them. In that case, you should modify the
corresponding .pump files instead and run the 'pump' script (for Pump corresponding `.pump` files instead and run the 'pump' script (for Pump
is Useful for Meta Programming) to regenerate them. You can find is Useful for Meta Programming) to regenerate them. You can find
pump.py in the ${GTEST_DIR}/scripts/ directory. Read the Pump manual pump.py in the `${GTEST_DIR}/scripts/` directory. Read the
[3] for how to use it. [Pump manual](http://code.google.com/p/googletest/wiki/PumpManual)
for how to use it.
[3] http://code.google.com/p/googletest/wiki/PumpManual.
### Contributing a Patch ### ### Contributing a Patch ###
We welcome patches. Please read the Google Mock developer's guide [4] We welcome patches. Please read the [Google Mock developer's Guide](
http://code.google.com/p/googlemock/wiki/DevGuide)
for how you can contribute. In particular, make sure you have signed 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 the Contributor License Agreement, or we won't be able to accept the
patch. patch.
[4] http://code.google.com/p/googlemock/wiki/DevGuide
Happy testing! Happy testing!
[gtest_readme]: ../googletest/ "googletest"