README.md

   1 # GoogleTest
   2
   3 ### Announcements
   4
   5 #### Live at Head
   6
   7 GoogleTest now follows the
   8 [Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support).
   9 We recommend
  10 [updating to the latest commit in the `main` branch as often as possible](https://github.com/abseil/abseil-cpp/blob/master/FAQ.md#what-is-live-at-head-and-how-do-i-do-it).
  11
  12 #### Documentation Updates
  13
  14 Our documentation is now live on GitHub Pages at
  15 https://google.github.io/googletest/. We recommend browsing the documentation on
  16 GitHub Pages rather than directly in the repository.
  17
  18 #### Release 1.11.0
  19
  20 [Release 1.11.0](https://github.com/google/googletest/releases/tag/release-1.11.0)
  21 is now available.
  22
  23 #### Coming Soon
  24
  25 *   We are planning to take a dependency on
  26     [Abseil](https://github.com/abseil/abseil-cpp).
  27 *   More documentation improvements are planned.
  28
  29 ## Welcome to **GoogleTest**, Google's C++ test framework!
  30
  31 This repository is a merger of the formerly separate GoogleTest and GoogleMock
  32 projects. These were so closely related that it makes sense to maintain and
  33 release them together.
  34
  35 ### Getting Started
  36
  37 See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
  38 documentation. We recommend starting with the
  39 [GoogleTest Primer](https://google.github.io/googletest/primer.html).
  40
  41 More information about building GoogleTest can be found at
  42 [googletest/README.md](googletest/README.md).
  43
  44 ## Features
  45
  46 *   An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
  47 *   Test discovery.
  48 *   A rich set of assertions.
  49 *   User-defined assertions.
  50 *   Death tests.
  51 *   Fatal and non-fatal failures.
  52 *   Value-parameterized tests.
  53 *   Type-parameterized tests.
  54 *   Various options for running the tests.
  55 *   XML test report generation.
  56
  57 ## Supported Platforms
  58
  59 GoogleTest requires a codebase and compiler compliant with the C++11 standard or
  60 newer.
  61
  62 The GoogleTest code is officially supported on the following platforms.
  63 Operating systems or tools not listed below are community-supported. For
  64 community-supported platforms, patches that do not complicate the code may be
  65 considered.
  66
  67 If you notice any problems on your platform, please file an issue on the
  68 [GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues).
  69 Pull requests containing fixes are welcome!
  70
  71 ### Operating Systems
  72
  73 *   Linux
  74 *   macOS
  75 *   Windows
  76
  77 ### Compilers
  78
  79 *   gcc 5.0+
  80 *   clang 5.0+
  81 *   MSVC 2015+
  82
  83 **macOS users:** Xcode 9.3+ provides clang 5.0+.
  84
  85 ### Build Systems
  86
  87 *   [Bazel](https://bazel.build/)
  88 *   [CMake](https://cmake.org/)
  89
  90 **Note:** Bazel is the build system used by the team internally and in tests.
  91 CMake is supported on a best-effort basis and by the community.
  92
  93 ## Who Is Using GoogleTest?
  94
  95 In addition to many internal projects at Google, GoogleTest is also used by the
  96 following notable projects:
  97
  98 *   The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
  99     and Chrome OS).
 100 *   The [LLVM](http://llvm.org/) compiler.
 101 *   [Protocol Buffers](https://github.com/google/protobuf), Google's data
 102     interchange format.
 103 *   The [OpenCV](http://opencv.org/) computer vision library.
 104
 105 ## Related Open Source Projects
 106
 107 [GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
 108 automated test-runner and Graphical User Interface with powerful features for
 109 Windows and Linux platforms.
 110
 111 [GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
 112 runs your test binary, allows you to track its progress via a progress bar, and
 113 displays a list of test failures. Clicking on one shows failure text. GoogleTest
 114 UI is written in C#.
 115
 116 [GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
 117 listener for GoogleTest that implements the
 118 [TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
 119 result output. If your test runner understands TAP, you may find it useful.
 120
 121 [gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
 122 runs tests from your binary in parallel to provide significant speed-up.
 123
 124 [GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
 125 is a VS Code extension allowing to view GoogleTest in a tree view and run/debug
 126 your tests.
 127
 128 [C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
 129 Code extension allowing to view GoogleTest in a tree view and run/debug your
 130 tests.
 131
 132 [Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
 133 that generates stub code for GoogleTest.
 134
 135 ## Contributing Changes
 136
 137 Please read
 138 [`CONTRIBUTING.md`](https://github.com/google/googletest/blob/master/CONTRIBUTING.md)
 139 for details on how to contribute to this project.
 140
 141 Happy testing!