1# GoogleTest
2
3### Announcements
4
5#### Documentation Updates
6
7Our documentation is now live on GitHub Pages at
8https://google.github.io/googletest/. We recommend browsing the documentation on
9GitHub Pages rather than directly in the repository.
10
11#### Release 1.17.0
12
13[Release 1.17.0](https://github.com/google/googletest/releases/tag/v1.17.0) is
14now available.
15
16The 1.17.x branch [requires at least
17C++17]((https://opensource.google/documentation/policies/cplusplus-support#c_language_standard).
18
19#### Continuous Integration
20
21We use Google's internal systems for continuous integration.
22
23#### Coming Soon
24
25*   We are planning to take a dependency on
26    [Abseil](https://github.com/abseil/abseil-cpp).
27
28## Welcome to **GoogleTest**, Google's C++ test framework!
29
30This repository is a merger of the formerly separate GoogleTest and GoogleMock
31projects. These were so closely related that it makes sense to maintain and
32release them together.
33
34### Getting Started
35
36See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
37documentation. We recommend starting with the
38[GoogleTest Primer](https://google.github.io/googletest/primer.html).
39
40More information about building GoogleTest can be found at
41[googletest/README.md](googletest/README.md).
42
43## Features
44
45*   xUnit test framework: \
46    Googletest is based on the [xUnit](https://en.wikipedia.org/wiki/XUnit)
47    testing framework, a popular architecture for unit testing
48*   Test discovery: \
49    Googletest automatically discovers and runs your tests, eliminating the need
50    to manually register your tests
51*   Rich set of assertions: \
52    Googletest provides a variety of assertions, such as equality, inequality,
53    exceptions, and more, making it easy to test your code
54*   User-defined assertions: \
55    You can define your own assertions with Googletest, making it simple to
56    write tests that are specific to your code
57*   Death tests: \
58    Googletest supports death tests, which verify that your code exits in a
59    certain way, making it useful for testing error-handling code
60*   Fatal and non-fatal failures: \
61    You can specify whether a test failure should be treated as fatal or
62    non-fatal with Googletest, allowing tests to continue running even if a
63    failure occurs
64*   Value-parameterized tests: \
65    Googletest supports value-parameterized tests, which run multiple times with
66    different input values, making it useful for testing functions that take
67    different inputs
68*   Type-parameterized tests: \
69    Googletest also supports type-parameterized tests, which run with different
70    data types, making it useful for testing functions that work with different
71    data types
72*   Various options for running tests: \
73    Googletest provides many options for running tests including running
74    individual tests, running tests in a specific order and running tests in
75    parallel
76
77## Supported Platforms
78
79GoogleTest follows Google's
80[Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support).
81See
82[this table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md)
83for a list of currently supported versions of compilers, platforms, and build
84tools.
85
86## Who Is Using GoogleTest?
87
88In addition to many internal projects at Google, GoogleTest is also used by the
89following notable projects:
90
91*   The [Chromium projects](https://www.chromium.org/) (behind the Chrome
92    browser and Chrome OS).
93*   The [LLVM](https://llvm.org/) compiler.
94*   [Protocol Buffers](https://github.com/google/protobuf), Google's data
95    interchange format.
96*   The [OpenCV](https://opencv.org/) computer vision library.
97
98## Related Open Source Projects
99
100[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
101automated test-runner and Graphical User Interface with powerful features for
102Windows and Linux platforms.
103
104[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
105runs your test binary, allows you to track its progress via a progress bar, and
106displays a list of test failures. Clicking on one shows failure text. GoogleTest
107UI is written in C#.
108
109[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
110listener for GoogleTest that implements the
111[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
112result output. If your test runner understands TAP, you may find it useful.
113
114[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
115runs tests from your binary in parallel to provide significant speed-up.
116
117[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
118is a VS Code extension allowing to view GoogleTest in a tree view and run/debug
119your tests.
120
121[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
122Code extension allowing to view GoogleTest in a tree view and run/debug your
123tests.
124
125[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
126that generates stub code for GoogleTest.
127
128## Contributing Changes
129
130Please read
131[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/main/CONTRIBUTING.md)
132for details on how to contribute to this project.
133
134Happy testing!
135