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

Merge pull request #574 from BillyDonahue/undoc

Browse Source 
Undoc
This commit is contained in:
Billy Donahue 2015-08-30 12:49:46 -04:00
commit ff49eded84
3 changed files with 201 additions and 319 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
README.md
View File

@ -1,16 +1,35 @@
# Google Test #
Welcome to **Google Test**, Google's C++ test framework! Welcome to **Google Test**, Google's C++ test framework!
This GitHub repository is a merger of the formerly separate GoogleTest and GoogleMock projects. This repository is a merger of the formerly separate GoogleTest and
These were so closely related that it makes sense to maintain and release them together. GoogleMock projects. These were so closely related that it makes sense to
maintain and release them together.
## GoogleTest ## 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!
Based on the [XUnit](https://en.wikipedia.org/wiki/XUnit) architecture. **Google Mock** is an extension to Google Test for writing and using C++ mock
Supports automatic test discovery, a rich set of assertions, user-defined classes. See the separate [Google Mock documentation](googlemock/README.md).
assertions, death tests, fatal and non-fatal failures, value- and
type-parameterized tests, various options for running the tests, and XML test More detailed documentation for googletest (including build instructions) are
report generation. in its interior [googletest/README.md](googletest/README.md) file.
## Features ##
* An [XUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
* Test discovery.
* A rich set of assertions.
* User-defined assertions.
* Death tests.
* Fatal and non-fatal failures.
* Value-parameterized tests.
* Type-parameterized tests.
* Various options for running the tests.
* XML test report generation.
## Platforms ## ## Platforms ##
@ -29,12 +48,14 @@ Google test has been used on a variety of platforms:
In addition to many internal projects at Google, Google Test is also used by In addition to many internal projects at Google, Google Test is also used by
the following notable projects: the following notable projects:
* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS) * The [Chromium projects](http://www.chromium.org/) (behind the Chrome
* The [LLVM](http://llvm.org/) compiler browser and Chrome OS).
* [Protocol Buffers](http://code.google.com/p/protobuf/) (Google's data interchange format) * The [LLVM](http://llvm.org/) compiler.
* The [OpenCV](http://opencv.org/) computer vision library * [Protocol Buffers](http://code.google.com/p/protobuf/), Google's data
interchange format.
* The [OpenCV](http://opencv.org/) computer vision library.
## Google Test-related open source projects ## ## Related Open Source Projects ##
[Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that runs [Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that runs
your test binary, allows you to track its progress via a progress bar, and your test binary, allows you to track its progress via a progress bar, and
@ -46,47 +67,70 @@ listener for Google Test that implements the
[TAP protocol](http://en.wikipedia.org/wiki/Test_Anything_Protocol) for test [TAP protocol](http://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
result output. If your test runner understands TAP, you may find it useful. result output. If your test runner understands TAP, you may find it useful.
## About Google Mock ## ## Requirements ##
**Google Mock** is an extension to Google Test for writing and using C++ mock classes. Google Test is designed to have fairly minimal requirements to build
It is inspired by [jMock](http://www.jmock.org/), [EasyMock](http://www.easymock.org/), and use with your projects, but there are some. Currently, we support
and [Hamcrest](http://code.google.com/p/hamcrest/), and designed with C++'s specifics in mind. Linux, Windows, Mac OS X, and Cygwin. We will also make our best
effort to support other platforms (e.g. Solaris, AIX, and z/OS).
However, since core members of the Google Test project have no access
to these platforms, Google Test may have outstanding issues there. If
you notice any problems on your platform, please notify
<googletestframework@googlegroups.com>. Patches for fixing them are
even more welcome!
Google mock: ### Linux Requirements ###
* lets you create mock classes trivially using simple macros. These are the base requirements to build and use Google Test from a source
* supports a rich set of matchers and actions. package (as described below):
* handles unordered, partially ordered, or completely ordered expectations.
* is extensible by users.
We hope you find it useful! * GNU-compatible Make or gmake
* POSIX-standard shell
* POSIX(-2) Regular Expressions (regex.h)
* A C++98-standard-compliant compiler
## Using Google Mock Without Google Test ## ### Windows Requirements ###
Google Mock is not a testing framework itself. Instead, it needs a
testing framework for writing tests. Google Mock works seamlessly
with [Google Test](http://code.google.com/p/googletest/), butj
you can also use it with [any C++ testing framework](googlemock/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework).
## Getting Started ## * Microsoft Visual C++ v7.1 or newer
If you are new to the project, we suggest that you read the user ### Cygwin Requirements ###
documentation in the following order:
* Learn the [basics](http://code.google.com/p/googletest/wiki/Primer) of Google Test, if you choose to use Google Mock with it (recommended). * Cygwin v1.5.25-14 or newer
* Read [Google Mock for Dummies](ForDummies.md).
* Read the instructions on how to [build Google Mock](http://code.google.com/p/googlemock/source/browse/trunk/README).
You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. ### Mac OS X Requirements ###
Once you understand the basics, check out the rest of the docs: * Mac OS X v10.4 Tiger or newer
* XCode Developer Tools
* [CheatSheet](googlemock/docs/CheatSheet.md) - all the commonly used stuff at a glance. ### Requirements for Contributors ###
* [CookBook](googlemock/docs/CookBook.md) - recipes for getting things done, including advanced techniques.
If you need help, please check the [KnownIssues](googlemock/docs/KnownIssues.md) and We welcome patches. If you plan to contribute a patch, you need to
[FrequentlyAskedQuestions](googlemock/docs/frequentlyaskedquestions.md) before build Google Test and its own tests from a git checkout (described
posting a question on the [googlemock discussion group](http://groups.google.com/group/googlemock). below), which has further requirements:
We'd love to have your help! Please read the Developer Guides if you are willing to contribute to the development. * [Python](http://python.org/) v2.3 or newer (for running some of
the tests and re-generating certain source files from templates)
* [CMake](http://www.cmake.org/) v2.6.4 or newer
Happy mocking! ## Regenerating Source Files ##
Some of Google Test's source files are generated from templates (not
in the C++ sense) using a script.
For example, the
file include/gtest/internal/gtest-type-util.h.pump is used to generate
gtest-type-util.h in the same directory.
You don't need to worry about regenerating the source files
unless you need to modify them. You would then modify the
corresponding `.pump` files and run the '[pump.py](googletest/scripts/pump.py)'
generator script. See the [Pump Manual](googletest/docs/PumpManual.md).
### Contributing Code ###
We welcome patches. Please read the
[Developer's Guide](googletest/docs/DevGuide.md)
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.
Happy testing!

229
googlemock/README.md
View File

@ -1,84 +1,121 @@
Google C++ Mocking Framework ## Google Mock ##
============================
<http://github.com/google/googlemock/> The Google C++ mocking framework.
Overview ### Overview ###
--------
Google's framework for writing and using C++ mock classes on a variety Google's framework for writing and using C++ mock classes.
of platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc). It can help you derive better designs of your system and write better tests.
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.
Google Mock: It is inspired by:
- provides a declarative syntax for defining mocks, * [jMock](http://www.jmock.org/),
- can easily define partial (hybrid) mocks, which are a cross of real * [EasyMock](http://www.easymock.org/), and
and mock objects, * [Hamcrest](http://code.google.com/p/hamcrest/),
- handles functions of arbitrary types and overloaded functions,
- comes with a rich set of matchers for validating function arguments, and designed with C++'s specifics in mind.
- uses an intuitive syntax for controlling the behavior of a mock,
- does automatic verification of expectations (no record-and-replay Google mock:
needed),
- allows arbitrary (partial) ordering constraints on * lets you create mock classes trivially using simple macros.
function calls to be expressed, * supports a rich set of matchers and actions.
- lets a user extend it by defining new matchers and actions. * handles unordered, partially ordered, or completely ordered expectations.
- does not use exceptions, and * is extensible by users.
- is easy to learn and use.
We hope you find it useful!
### Features ###
* 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.
* Is easy to learn and use.
Please see the project page above for more information as well as the Please see the project page above for more information as well as the
mailing list for questions, discussions, and development. There is 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](scripts/generator/) is
project](http://code.google.com/p/cppclean/) and under the Apache from [cppclean](http://code.google.com/p/cppclean/) and released under
License, which is different from Google Mock's license. the Apache License, which is different from Google Mock's license.
Requirements for End Users ## Getting Started ##
--------------------------
Google Mock is implemented on top of the [Google Test C++ testing If you are new to the project, we suggest that you read the user
framework](http://github.com/google/googletest/), and depends on it. documentation in the following order:
You must use the bundled version of Google Test when using Google Mock, or
you may get compiler/linker errors. * Learn the [basics](../googletest/docs/Primer.md) of
Google Test, if you choose to use Google Mock with it (recommended).
* Read [Google Mock for Dummies](docs/ForDummies.md).
* Read the instructions below on how to build Google Mock.
You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation.
Once you understand the basics, check out the rest of the docs:
* [CheatSheet](googlemock/docs/CheatSheet.md) - all the commonly used stuff
at a glance.
* [CookBook](googlemock/docs/CookBook.md) - recipes for getting things done,
including advanced techniques.
If you need help, please check the
[KnownIssues](googlemock/docs/KnownIssues.md) and
[FrequentlyAskedQuestions](googlemock/docs/frequentlyaskedquestions.md) before
posting a question on the
[discussion group](http://groups.google.com/group/googlemock).
### Using Google Mock Without Google Test ###
Google Mock is not a testing framework itself. Instead, it needs a
testing framework for writing tests. Google Mock works seamlessly
with [Google Test](http://code.google.com/p/googletest/), butj
you can also use it with [any C++ testing framework](googlemock/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework).
### Requirements for End Users ###
Google Mock is implemented on top of [Google Test](
http://github.com/google/googletest/), and depends on it.
You must use the bundled version of Google Test when using Google Mock.
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, although it will still need Google Test. Please read
an internal dependency. Please read ["Using_Google_Mock_with_Any_Testing_Framework"](
<http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework> docs/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework)
for how to do it. for instructions.
Google Mock depends on advanced C++ features and thus requires a more Google Mock depends on advanced C++ features and thus requires a more
modern compiler. The following are needed to use Google Mock: modern compiler. The following are needed to use Google Mock:
### Linux Requirements ### #### Linux Requirements ####
These are the base requirements to build and use Google Mock from a source
package (as described below):
* GNU-compatible Make or "gmake" * GNU-compatible Make or "gmake"
* POSIX-standard shell * POSIX-standard shell
* POSIX(-2) Regular Expressions (regex.h) * POSIX(-2) Regular Expressions (regex.h)
* C++98-standard-compliant compiler (e.g. GCC 3.4 or newer) * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer)
### Windows Requirements ### #### Windows Requirements ####
* Microsoft Visual C++ 8.0 SP1 or newer * Microsoft Visual C++ 8.0 SP1 or newer
### Mac OS X Requirements ### #### Mac OS X Requirements ####
* Mac OS X 10.4 Tiger or newer * Mac OS X 10.4 Tiger or newer
* Developer Tools Installed * Developer Tools Installed
Requirements for Contributors ### Requirements for Contributors ###
-----------------------------
We welcome patches. If you plan to contribute a patch, you need to 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 build Google Mock and its tests, which has further requirements:
below), which has further requirements:
* Automake version 1.9 or newer * Automake version 1.9 or newer
* Autoconf version 2.59 or newer * Autoconf version 2.59 or newer
@ -86,62 +123,29 @@ below), which has further requirements:
* Python version 2.3 or newer (for running some of the tests and * Python version 2.3 or newer (for running some of the tests and
re-generating certain source files from templates) re-generating certain source files from templates)
Getting the Source ### Building Google Mock ###
------------------
There are two primary ways of getting Google Mock's source code: you #### Preparing to Build (Unix only) ####
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
packages on your system, but lets you track development and make
patches much more easily, so we highly encourage it.
### Git Checkout ### If you are using a Unix system and plan to use the GNU Autotools build
To check out the master branch of Google Mock, run the following git command:
git clone https://github.com/google/googlemock.git
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.
files.
To prepare the Autotools build system, enter the target directory of To prepare the Autotools build system:
the checkout command you used ('gmock-svn') and proceed with the
following command:
cd googlemock
autoreconf -fvi autoreconf -fvi
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.
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:
AUTOMAKE=automake-1.9 ACLOCAL=aclocal-1.9 autoreconf -fvi
Make sure you're using the same version of automake and aclocal.
Setting up the Build
--------------------
To build Google Mock and your tests that use it, you need to tell your 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 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 way to do it depends on which build system you use, and is usually
straightforward. straightforward.
### Generic Build Instructions ###
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
@ -189,7 +193,8 @@ following commands should succeed:
make make
./gmock_test ./gmock_test
If you see errors, try to tweak the contents of [make/Makefile](make/Makefile) to make them go away. If you see errors, try to tweak the contents of
[make/Makefile](make/Makefile) to make them go away.
### Windows ### ### Windows ###
@ -208,8 +213,7 @@ have to configure it to use the `gmock_config` propety sheet. For that:
* 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.
Tweaking Google Mock ### Tweaking Google Mock ###
--------------------
Google Mock can be used in diverse environments. The default 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
@ -264,21 +268,20 @@ for instructions on how to set up necessary compiler settings.
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 [Google Test's README][gtest_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 ###
---------------------------------
We strive to keep Google Mock releases backward compatible. We strive to keep Google Mock releases backward compatible.
Sometimes, though, we have to make some breaking changes for the Sometimes, though, we have to make some breaking changes for the
users' long-term benefits. This section describes what you'll need to users' long-term benefits. This section describes what you'll need to
do if you are upgrading from an earlier version of Google Mock. 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](../googletest/#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
@ -293,21 +296,19 @@ use the new matcher API (
[polymorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers)). [polymorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers)).
Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected. Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected.
### Developing Google Mock ###
Developing Google Mock
----------------------
This section discusses how to make your own changes to Google Mock. This section discusses how to make your own changes to Google Mock.
### Testing Google Mock Itself ### #### Testing Google Mock Itself ####
To make sure your changes work as intended and don't break existing 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. 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 For that you'll need Autotools. First, make sure you have followed
the instructions in section "SVN Checkout" to configure Google Mock. the instructions above to configure Google Mock.
Then, create a build output directory and enter it. Next, Then, create a build output directory and enter it. Next,
${GMOCK_DIR}/configure # Standard GNU configure script, --help for more info ${GMOCK_DIR}/configure # try --help for more info
Once you have successfully configured Google Mock, the build steps are Once you have successfully configured Google Mock, the build steps are
standard for GNU-style OSS packages. standard for GNU-style OSS packages.
@ -319,32 +320,14 @@ 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 against Google Test as well. There is no need to configure Google Test
separately. separately.
### Regenerating Source Files ### #### Contributing a Patch ####
Some of Google Mock's source files are generated from templates (not We welcome patches.
in the C++ sense) using a script. A template file is named FOO.pump, Please read the [Developer's Guide](docs/DevGuide.md)
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
`gmock-generated-actions.h` in the same directory.
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
corresponding `.pump` files instead and run the 'pump' script (for Pump
is Useful for Meta Programming) to regenerate them. You can find
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.
### Contributing a Patch ###
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.
Happy testing! Happy testing!
[gtest_readme]: ../googletest/ "googletest" [gtest_readme]: ../googletest/README.md "googletest"

155
googletest/README.md
View File

@ -1,107 +1,14 @@
Google C++ Testing Framework
============================
https://github.com/google/googletest ### Generic Build Instructions ###
Overview #### Setup ####
--------
Google's framework for writing C++ tests on a variety of platforms
(Linux, Mac OS X, Windows, Windows CE, Symbian, etc). Based on the
xUnit architecture. Supports automatic test discovery, a rich set of
assertions, user-defined assertions, death tests, fatal and non-fatal
failures, various options for running the tests, and XML test report
generation.
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!
Requirements for End Users
--------------------------
Google Test is designed to have fairly minimal requirements to build
and use with your projects, but there are some. Currently, we support
Linux, Windows, Mac OS X, and Cygwin. We will also make our best
effort to support other platforms (e.g. Solaris, AIX, and z/OS).
However, since core members of the Google Test project have no access
to these platforms, Google Test may have outstanding issues there. If
you notice any problems on your platform, please notify
<googletestframework@googlegroups.com>. Patches for fixing them are
even more welcome!
### Linux Requirements ###
These are the base requirements to build and use Google Test from a source
package (as described below):
* GNU-compatible Make or gmake
* POSIX-standard shell
* POSIX(-2) Regular Expressions (regex.h)
* A C++98-standard-compliant compiler
### Windows Requirements ###
* Microsoft Visual C++ 7.1 or newer
### Cygwin Requirements ###
* Cygwin 1.5.25-14 or newer
### Mac OS X Requirements ###
* Mac OS X 10.4 Tiger or newer
* Developer Tools Installed
Also, you'll need [CMake](http://www.cmake.org/ CMake) 2.6.4 or higher if
you want to build the samples using the provided CMake script, regardless
of the platform.
Requirements for Contributors
-----------------------------
We welcome patches. If you plan to contribute a patch, you need to
build Google Test and its own tests from a git checkout (described
below), which has further requirements:
* [Python](http://python.org/) version 2.3 or newer (for running some of the tests and
re-generating certain source files from templates)
* [CMake](http://www.cmake.org/) 2.6.4 or newer
Getting the Source
------------------
Google Test's source is available from its GitHub repository at
<https://github.com/google/googletest>.
The GitHub repository offers stable tagged releases available as .ZIP archives.
A Git checkout requires a few extra steps and some extra software
packages on your system, but lets you track the latest development and
make patches much more easily, so we highly encourage it.
### Source Package ###
Snapshots of Google Test's master branch can be downloaded directly with GitHub's
"Download ZIP" button on the main page.
Versioned releases are also available by clicking on
[Releases](releases) in the project page.
### Git Checkout ###
To check out the master branch of Google Test, run the following git command:
git clone https://github.com/google/googletest.git (via HTTPS)
Setting up the Build
--------------------
To build Google Test and your tests that use it, you need to tell your To build Google Test and your tests that use it, you need to tell your
build system where to find its headers and source files. The exact 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 way to do it depends on which build system you use, and is usually
straightforward. straightforward.
### Generic Build Instructions ### #### Build ####
Suppose you put Google Test in directory `${GTEST_DIR}`. To build it, Suppose you put Google Test in directory `${GTEST_DIR}`. To build it,
create a library build target (or a project as called by Visual Studio create a library build target (or a project as called by Visual Studio
@ -219,8 +126,7 @@ above, you need to either:
supported by Apple, but has been reported to work supported by Apple, but has been reported to work
(http://stackoverflow.com/questions/5378518). (http://stackoverflow.com/questions/5378518).
Tweaking Google Test ### Tweaking Google Test ###
--------------------
Google Test can be used in diverse environments. The default Google Test 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
@ -338,39 +244,7 @@ instead of
in order to define a test. in order to define a test.
Upgrating from an Earlier Version ## Developing Google Test ##
---------------------------------
We strive to keep Google Test 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 Test.
### Upgrading from 1.3.0 or Earlier ###
You may need to explicitly enable or disable Google Test's own TR1
tuple library. See the instructions in section "Choosing a TR1 Tuple
Library".
### Upgrading from 1.4.0 or Earlier ###
The Autotools build script (configure + make) is no longer officially
supportted. You are encouraged to migrate to your own build system or
use CMake. If you still need to use Autotools, you can find
instructions in the README file from Google Test 1.4.0.
On platforms where the pthread library is available, Google Test uses
it in order to be thread-safe. See the "Multi-threaded Tests" section
for what this means to your build script.
If you use Microsoft Visual C++ 7.1 with exceptions disabled, Google
Test will no longer compile. This should affect very few people, as a
large portion of STL (including <string>) doesn't compile in this mode
anyway. We decided to stop supporting it in order to greatly simplify
Google Test's implementation.
Developing Google Test
----------------------
This section discusses how to make your own changes to Google Test. This section discusses how to make your own changes to Google Test.
@ -399,27 +273,8 @@ this is usually done by 'make'. To run the tests, do
All tests should pass. All tests should pass.
### Regenerating Source Files ###
Some of Google Test'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
file include/gtest/internal/gtest-type-util.h.pump is used to generate
gtest-type-util.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.py Python script to corresponding .pump files instead and run the pump.py Python script to
regenerate them. You can find pump.py in the [scripts/](scripts/) directory. regenerate them. You can find pump.py in the [scripts/](scripts/) directory.
Read the [Pump manual](docs/PumpManual.md) for how to use it. Read the [Pump manual](docs/PumpManual.md) for how to use it.
### Contributing a Patch ###
We welcome patches. Please read the
[Google Test developer's guide](docs/DevGuide.md)
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.
Happy testing!