diff options
author | Billy Donahue <billydonahue@google.com> | 2015-08-30 16:36:37 (GMT) |
---|---|---|
committer | Billy Donahue <billydonahue@google.com> | 2015-08-30 16:36:37 (GMT) |
commit | 23bd6d8a9b8e38a661020a827b9f9d117ce23904 (patch) | |
tree | 93d30cb9b7033c6cdde960efc6f32e7f63f211d3 /README.md | |
parent | b55ac7f36ff032d5519cf55b84ca930ff9f80b97 (diff) | |
download | googletest-23bd6d8a9b8e38a661020a827b9f9d117ce23904.zip googletest-23bd6d8a9b8e38a661020a827b9f9d117ce23904.tar.gz googletest-23bd6d8a9b8e38a661020a827b9f9d117ce23904.tar.bz2 |
readme mergingrefs/pull/573/head
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 115 |
1 files changed, 65 insertions, 50 deletions
@@ -1,5 +1,5 @@ -## Google Test ## +# Google Test # Welcome to **Google Test**, Google's C++ test framework! @@ -7,18 +7,29 @@ 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. -Google Test conforms to the [XUnit](https://en.wikipedia.org/wiki/XUnit) -test framework pattern. It features: +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! - * 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 +**Google Mock** is an extension to Google Test for writing and using C++ mock +classes. See the separate [Google Mock documentation](googlemock/README.md). + +More detailed instructions for googletest are in its interior +[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 ## @@ -56,60 +67,63 @@ 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 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. +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 ### -Google mock: +These are the base requirements to build and use Google Test from a source +package (as described below): - * 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. + * GNU-compatible Make or gmake + * POSIX-standard shell + * POSIX(-2) Regular Expressions (regex.h) + * A C++98-standard-compliant compiler -We hope you find it useful! +### Windows Requirements ### -### Using Google Mock Without Google Test ### + * Microsoft Visual C++ v7.1 or newer -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). +### Cygwin Requirements ### -## Getting Started ## + * Cygwin v1.5.25-14 or newer -If you are new to the project, we suggest that you read the user -documentation in the following order: +### Mac OS X Requirements ### - * 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](googlemock/docs/ForDummies.md). - * Read the instructions on how to [build Google Mock](googlemock/README.md). + * Mac OS X v10.4 Tiger or newer + * XCode Developer Tools -You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. +Also, you'll need [CMake](http://www.cmake.org/) v2.6.4 or higher if +you want to build the samples using the provided CMake script, regardless +of the platform. -Once you understand the basics, check out the rest of the docs: +### Requirements for Contributors ### - * [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. +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: -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). + * [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 -### Regenerating Source Files ### +## 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)' @@ -117,7 +131,8 @@ generator script. See the [Pump Manual](googletest/docs/PumpManual.md). ### Contributing Code ### -We welcome patches. Please read the [Developer's Guide](docs/DevGuide.md) +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. |