1 2 # Google Test # 3 4 [](https://travis-ci.org/google/googletest) 5 [](https://ci.appveyor.com/project/GoogleTestAppVeyor/googletest/branch/master) 6 7 **PR FREEZE COMING SOON** 8 9 We are working on a large refactoring that would make it hard to accept external PRs. *Really Soon Now* we will not be accepting new PRs until the refactoring has been completed. 10 11 **Future Plans**: 12 * 1.8.x Release - [the 1.8.x](https://github.com/google/googletest/releases/tag/release-1.8.1) is the last release that works with pre-C++11 compilers. The 1.8.x will not accept any requests for any new features and any bugfix requests will only be accepted if proven "critical" 13 * Post 1.8.x - work to improve/cleanup/pay technical debt. When this work is completed there will be a 1.9.x tagged release 14 * Post 1.9.x googletest will follow [Abseil Live at Head philosophy](https://abseil.io/about/philosophy) 15 16 17 Welcome to **Google Test**, Google's C++ test framework! 18 19 This repository is a merger of the formerly separate GoogleTest and 20 GoogleMock projects. These were so closely related that it makes sense to 21 maintain and release them together. 22 23 Please subscribe to the mailing list at googletestframework (a] googlegroups.com for questions, discussions, and development. 24 There is also an IRC channel on [OFTC](https://webchat.oftc.net/) (irc.oftc.net) #gtest available. 25 26 Getting started information for **Google Test** is available in the 27 [Google Test Primer](googletest/docs/primer.md) documentation. 28 29 **Google Mock** is an extension to Google Test for writing and using C++ mock 30 classes. See the separate [Google Mock documentation](googlemock/README.md). 31 32 More detailed documentation for googletest (including build instructions) are 33 in its interior [googletest/README.md](googletest/README.md) file. 34 35 ## Features ## 36 37 * An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework. 38 * Test discovery. 39 * A rich set of assertions. 40 * User-defined assertions. 41 * Death tests. 42 * Fatal and non-fatal failures. 43 * Value-parameterized tests. 44 * Type-parameterized tests. 45 * Various options for running the tests. 46 * XML test report generation. 47 48 ## Platforms ## 49 50 Google test has been used on a variety of platforms: 51 52 * Linux 53 * Mac OS X 54 * Windows 55 * Cygwin 56 * MinGW 57 * Windows Mobile 58 * Symbian 59 * PlatformIO 60 61 ## Who Is Using Google Test? ## 62 63 In addition to many internal projects at Google, Google Test is also used by 64 the following notable projects: 65 66 * The [Chromium projects](http://www.chromium.org/) (behind the Chrome 67 browser and Chrome OS). 68 * The [LLVM](http://llvm.org/) compiler. 69 * [Protocol Buffers](https://github.com/google/protobuf), Google's data 70 interchange format. 71 * The [OpenCV](http://opencv.org/) computer vision library. 72 * [tiny-dnn](https://github.com/tiny-dnn/tiny-dnn): header only, dependency-free deep learning framework in C++11. 73 74 ## Related Open Source Projects ## 75 76 [GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based automated test-runner and Graphical User Interface with powerful features for Windows and Linux platforms. 77 78 [Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that runs 79 your test binary, allows you to track its progress via a progress bar, and 80 displays a list of test failures. Clicking on one shows failure text. Google 81 Test UI is written in C#. 82 83 [GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event 84 listener for Google Test that implements the 85 [TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test 86 result output. If your test runner understands TAP, you may find it useful. 87 88 [gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that 89 runs tests from your binary in parallel to provide significant speed-up. 90 91 [GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter) is a VS Code extension allowing to view Google Tests in a tree view, and run/debug your tests. 92 93 ## Requirements ## 94 95 Google Test is designed to have fairly minimal requirements to build 96 and use with your projects, but there are some. Currently, we support 97 Linux, Windows, Mac OS X, and Cygwin. We will also make our best 98 effort to support other platforms (e.g. Solaris, AIX, and z/OS). 99 However, since core members of the Google Test project have no access 100 to these platforms, Google Test may have outstanding issues there. If 101 you notice any problems on your platform, please notify 102 [googletestframework (a] googlegroups.com](https://groups.google.com/forum/#!forum/googletestframework). Patches for fixing them are 103 even more welcome! 104 105 ### Linux Requirements ### 106 107 These are the base requirements to build and use Google Test from a source 108 package (as described below): 109 110 * GNU-compatible Make or gmake 111 * POSIX-standard shell 112 * POSIX(-2) Regular Expressions (regex.h) 113 * A C++11-standard-compliant compiler 114 115 ### Windows Requirements ### 116 117 * Microsoft Visual C++ 2015 or newer 118 119 ### Cygwin Requirements ### 120 121 * Cygwin v1.5.25-14 or newer 122 123 ### Mac OS X Requirements ### 124 125 * Mac OS X v10.4 Tiger or newer 126 * Xcode Developer Tools 127 128 ## Contributing change 129 130 Please read the [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on 131 how to contribute to this project. 132 133 Happy testing! 134
