diff options
| -rw-r--r-- | README.md | 64 | ||||
| -rw-r--r-- | googlemock/README.md | 91 | ||||
| -rw-r--r-- | googletest/README.md | 58 |
3 files changed, 94 insertions, 119 deletions
@@ -1,16 +1,24 @@ Welcome to **Google Test**, Google's C++ test framework! -This GitHub repository is a merger of the formerly separate GoogleTest and GoogleMock projects. -These were so closely related that it makes sense to maintain and release them together. +This repository is a merger of the formerly separate GoogleTest and +GoogleMock projects. These were so closely related that it makes sense to +maintain and release them together. -## GoogleTest ## +## Google Test ## -Based on the [XUnit](https://en.wikipedia.org/wiki/XUnit) architecture. -Supports automatic test discovery, a rich set of assertions, user-defined -assertions, death tests, fatal and non-fatal failures, value- and -type-parameterized tests, various options for running the tests, and XML test -report generation. +Google Test conforms to the [XUnit](https://en.wikipedia.org/wiki/XUnit) +test framework pattern. It features: + + * 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 ## @@ -29,12 +37,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 the following notable projects: - * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS) - * The [LLVM](http://llvm.org/) compiler - * [Protocol Buffers](http://code.google.com/p/protobuf/) (Google's data interchange format) - * The [OpenCV](http://opencv.org/) computer vision library + * The [Chromium projects](http://www.chromium.org/) (behind the Chrome + browser and Chrome OS). + * The [LLVM](http://llvm.org/) compiler. + * [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](http://code.google.com/p/gtest-gbar/) is test runner that runs your test binary, allows you to track its progress via a progress bar, and @@ -72,9 +82,10 @@ you can also use it with [any C++ testing framework](googlemock/ForDummies.md#Us If you are new to the project, we suggest that you read the user 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). + * Learn the [basics](http://code.google.com/p/googletest/wiki/Primer) of + Google Test, if you choose to use Google Mock with it (recommended). * 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). + * Read the instructions on how to [build Google Mock](googlemock/README.md). You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. @@ -87,6 +98,25 @@ If you need help, please check the [KnownIssues](googlemock/docs/KnownIssues.md) [FrequentlyAskedQuestions](googlemock/docs/frequentlyaskedquestions.md) before posting a question on the [googlemock discussion group](http://groups.google.com/group/googlemock). -We'd love to have your help! Please read the Developer Guides if you are willing to contribute to the development. +### 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. + +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 regenerate them. See the +[Pump Manual](googletest/docs/PumpManual.md). + +### Contributing Code ### + +We welcome patches. Please read the [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 mocking! +Happy testing! diff --git a/googlemock/README.md b/googlemock/README.md index cb51a31a..107685a0 100644 --- a/googlemock/README.md +++ b/googlemock/README.md @@ -1,10 +1,8 @@ -Google C++ Mocking Framework -============================ +## Google C++ Mocking Framework ## <http://github.com/google/googlemock/> -Overview --------- +### Overview ### Google's framework for writing and using C++ mock classes on a variety of platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc). @@ -37,24 +35,23 @@ Please note that code under scripts/generator/ is from the [cppclean project](http://code.google.com/p/cppclean/) and under the Apache 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 -framework](http://github.com/google/googletest/), and depends on it. -You must use the bundled version of Google Test when using Google Mock, or -you may get compiler/linker errors. +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 -framework of your choice; although it will still need Google Test as -an internal dependency. Please read -<http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework> -for how to do it. +framework, although it will still need Google Test. Please read + +["Using_Google_Mock_with_Any_Testing_Framework"]( + docs/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework) +for instructions. 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): @@ -64,17 +61,16 @@ package (as described below): * POSIX(-2) Regular Expressions (regex.h) * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer) -### Windows Requirements ### +#### Windows Requirements #### * Microsoft Visual C++ 8.0 SP1 or newer -### Mac OS X Requirements ### +#### Mac OS X Requirements #### * Mac OS X 10.4 Tiger or newer * Developer Tools Installed -Requirements for Contributors ------------------------------ +### 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 @@ -86,8 +82,7 @@ below), which has further requirements: * Python version 2.3 or newer (for running some of the tests and re-generating certain source files from templates) -Getting the Source ------------------- +### Getting the Source ### There are two primary ways of getting Google Mock's source code: you can download a [stable source release](releases), @@ -127,15 +122,14 @@ instance, if you have both GNU Automake 1.4 and 1.9 installed and Make sure you're using the same version of automake and aclocal. -Setting up the Build --------------------- +### Preparing to Build ### 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. -### Generic Build Instructions ### +### Build ### This section shows how you can integrate Google Mock into your existing build system. @@ -208,8 +202,7 @@ have to configure it to use the `gmock_config` propety sheet. For that: * In Project Properties | Configuration Properties | General | Additional Include Directories, type <path to Google Mock>/include. -Tweaking Google Mock --------------------- +### 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 @@ -264,21 +257,20 @@ for instructions on how to set up necessary compiler settings. 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. -Upgrading from an Earlier Version ---------------------------------- +### Upgrading from an Earlier Version ### 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. -### 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 tuple library. See the instructions in section "[Choosing a TR1 Tuple 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 Google Mock use it in order to be thread-safe. For this to work, you @@ -294,20 +286,19 @@ use the new matcher API ( 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. -### Testing Google Mock Itself ### +#### 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. +the instructions above to configure Google Mock. 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 standard for GNU-style OSS packages. @@ -319,32 +310,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 separately. -### Regenerating Source Files ### - -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 -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 #### - -### 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 +We welcome patches. +Please read the [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! -[gtest_readme]: ../googletest/ "googletest" +[gtest_readme]: ../googletest/README.md "googletest" diff --git a/googletest/README.md b/googletest/README.md index 84ab48d5..0a6d95ba 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -1,10 +1,8 @@ -Google C++ Testing Framework -============================ +## Google C++ Testing Framework ## https://github.com/google/googletest -Overview --------- +### Overview ### Google's framework for writing C++ tests on a variety of platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc). Based on the @@ -18,8 +16,7 @@ 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 --------------------------- +### 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 @@ -31,7 +28,7 @@ you notice any problems on your platform, please notify <googletestframework@googlegroups.com>. Patches for fixing them are even more welcome! -### Linux Requirements ### +#### Linux Requirements #### These are the base requirements to build and use Google Test from a source package (as described below): @@ -41,15 +38,15 @@ package (as described below): * POSIX(-2) Regular Expressions (regex.h) * A C++98-standard-compliant compiler -### Windows Requirements ### +#### Windows Requirements #### * Microsoft Visual C++ 7.1 or newer -### Cygwin Requirements ### +#### Cygwin Requirements #### * Cygwin 1.5.25-14 or newer -### Mac OS X Requirements ### +#### Mac OS X Requirements #### * Mac OS X 10.4 Tiger or newer * Developer Tools Installed @@ -58,8 +55,7 @@ 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 ------------------------------ +### 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 @@ -69,8 +65,7 @@ below), which has further requirements: re-generating certain source files from templates) * [CMake](http://www.cmake.org/) 2.6.4 or newer -Getting the Source ------------------- +## Getting the Source ## Google Test's source is available from its GitHub repository at <https://github.com/google/googletest>. @@ -81,8 +76,8 @@ 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. +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. @@ -93,8 +88,7 @@ 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 --------------------- +## Setting up the Build ## 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 @@ -219,8 +213,7 @@ above, you need to either: supported by Apple, but has been reported to work (http://stackoverflow.com/questions/5378518). -Tweaking Google Test --------------------- +### Tweaking Google Test ### Google Test can be used in diverse environments. The default configuration may not work (or may not work well) out of the box in @@ -338,8 +331,7 @@ instead of in order to define a test. -Upgrating from an Earlier Version ---------------------------------- +### Upgrating from an Earlier Version ### We strive to keep Google Test releases backward compatible. Sometimes, though, we have to make some breaking changes for the @@ -369,8 +361,7 @@ 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 ----------------------- +## Developing Google Test ## This section discusses how to make your own changes to Google Test. @@ -399,27 +390,8 @@ this is usually done by 'make'. To run the tests, do 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, 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 regenerate them. You can find pump.py in the [scripts/](scripts/) directory. 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! |