googletest/README.md

136 lines
4.5 KiB
Markdown
Raw Normal View History

# GoogleTest
#### OSS Builds Status
2015-08-27 03:45:10 +02:00
2019-01-03 17:41:17 +01:00
[![Build Status](https://api.travis-ci.org/google/googletest.svg?branch=master)](https://travis-ci.org/google/googletest)
2017-08-17 08:42:53 +02:00
[![Build status](https://ci.appveyor.com/api/projects/status/4o38plt0xbo1ubc8/branch/master?svg=true)](https://ci.appveyor.com/project/GoogleTestAppVeyor/googletest/branch/master)
2015-08-31 15:43:03 +02:00
### Announcements
2018-08-10 16:59:52 +02:00
#### Release 1.10.x
2018-08-10 16:59:52 +02:00
[Release 1.10.x](https://github.com/google/googletest/releases/tag/release-1.10.0)
is now available.
#### Coming Soon
* Post 1.10.x googletest will follow
[Abseil Live at Head philosophy](https://abseil.io/about/philosophy)
* We are also planning to take a dependency on
[Abseil](https://github.com/abseil/abseil-cpp).
2019-06-12 17:15:00 +02:00
## Welcome to **GoogleTest**, Google's C++ test framework!
2019-06-12 17:15:00 +02:00
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.
### Getting Started
2019-06-12 17:15:00 +02:00
The information for **GoogleTest** is available in the
[GoogleTest Primer](googletest/docs/primer.md) documentation.
**GoogleMock** is an extension to GoogleTest for writing and using C++ mock
classes. See the separate [GoogleMock documentation](googlemock/README.md).
2015-08-30 18:36:37 +02:00
2019-06-12 17:15:00 +02:00
More detailed documentation for googletest is in its interior
[googletest/README.md](googletest/README.md) file.
2015-08-30 18:36:37 +02:00
2019-06-12 17:15:00 +02:00
## Features
2015-08-30 18:36:37 +02:00
2019-06-12 17:15:00 +02:00
* 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.
## Supported Platforms
GoogleTest requires a codebase and compiler compliant with the C++11 standard or
newer.
The GoogleTest code is officially supported on the following platforms.
Operating systems or tools not listed below are community-supported. For
community-supported platforms, patches that do not complicate the code may be
considered.
If you notice any problems on your platform, please file an issue on the
[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues).
Pull requests containing fixes are welcome!
### Operating Systems
2019-06-12 17:15:00 +02:00
* Linux
* macOS
2019-06-12 17:15:00 +02:00
* Windows
### Compilers
* gcc 5.0+
* clang 5.0+
* MSVC 2015+
**macOS users:** Xcode 9.3+ provides clang 5.0+.
### Build Systems
* [Bazel](https://bazel.build/)
* [CMake](https://cmake.org/)
**Note:** Bazel is the build system used by the team internally and in tests.
CMake is supported on a best-effort basis and by the community.
## Who Is Using GoogleTest?
In addition to many internal projects at Google, GoogleTest is also used by the
2019-06-12 17:15:00 +02:00
following notable projects:
2019-06-12 17:15:00 +02:00
* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
and Chrome OS).
* The [LLVM](http://llvm.org/) compiler.
* [Protocol Buffers](https://github.com/google/protobuf), Google's data
2015-08-27 00:28:20 +02:00
interchange format.
2019-06-12 17:15:00 +02:00
* The [OpenCV](http://opencv.org/) computer vision library.
2019-06-12 17:15:00 +02:00
## Related Open Source Projects
2019-06-12 17:15:00 +02:00
[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.
[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
2019-06-12 17:15:00 +02:00
runs your test binary, allows you to track its progress via a progress bar, and
2015-08-26 00:23:36 +02:00
displays a list of test failures. Clicking on one shows failure text. Google
Test UI is written in C#.
2015-08-26 00:23:36 +02:00
[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
listener for GoogleTest that implements the
[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
2015-08-26 00:23:36 +02:00
result output. If your test runner understands TAP, you may find it useful.
[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
runs tests from your binary in parallel to provide significant speed-up.
2019-06-12 17:18:40 +02:00
[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug
your tests.
2018-08-27 21:27:58 +02:00
[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
Code extension allowing to view GoogleTest in a tree view, and run/debug your
tests.
2018-08-27 21:27:58 +02:00
[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
that generates stub code for GoogleTest.
## Contributing Changes
2015-08-25 23:56:57 +02:00
Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to
2019-06-12 17:18:40 +02:00
contribute to this project.
2015-08-25 23:56:57 +02:00
2015-08-27 00:28:20 +02:00
Happy testing!