diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 130 |
1 files changed, 87 insertions, 43 deletions
@@ -1,16 +1,35 @@ +# Google Test # + 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. + +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! + +**Google Mock** is an extension to Google Test for writing and using C++ mock +classes. See the separate [Google Mock documentation](googlemock/README.md). -## GoogleTest ## +More detailed documentation for googletest (including build instructions) are +in its interior [googletest/README.md](googletest/README.md) file. -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. +## 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 ## @@ -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 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](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 @@ -46,47 +67,70 @@ listener for Google Test that implements the [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. -## About Google Mock ## +## Requirements ## + +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 ### -**Google Mock** is an extension to Google Test for writing and using C++ mock classes. -It is inspired by [jMock](http://www.jmock.org/), [EasyMock](http://www.easymock.org/), -and [Hamcrest](http://code.google.com/p/hamcrest/), and designed with C++'s specifics in mind. + * Microsoft Visual C++ v7.1 or newer -Google mock: +### Cygwin Requirements ### - * lets you create mock classes trivially using simple macros. - * supports a rich set of matchers and actions. - * handles unordered, partially ordered, or completely ordered expectations. - * is extensible by users. + * Cygwin v1.5.25-14 or newer -We hope you find it useful! +### Mac OS X Requirements ### -## 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). + * Mac OS X v10.4 Tiger or newer + * XCode Developer Tools -## Getting Started ## +### Requirements for Contributors ### -If you are new to the project, we suggest that you read the user -documentation in the following order: +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: - * 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). + * [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 -You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. +## Regenerating Source Files ## -Once you understand the basics, check out the rest of the docs: +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. - * [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. +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). -If you need help, please check the [KnownIssues](googlemock/docs/KnownIssues.md) and -[FrequentlyAskedQuestions](googlemock/docs/frequentlyaskedquestions.md) before -posting a question on the [googlemock discussion group](http://groups.google.com/group/googlemock). +### Contributing Code ### -We'd love to have your help! Please read the Developer Guides if you are willing to contribute to the development. +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 mocking! +Happy testing! |