CLion
 
2022.3
Shortcuts: Windows
Get CLion
You are viewing the documentation for an earlier version of CLion.
  1. Testing
  2. Google Test

Google Test

Last modified: 27 December 2022

Google Test and Google Mock are a pair of unit testing tools developed by Google.

tip

Learn about the framework specifics in the Google Test section of our Unit Testing Tutorial.

Adding Google Test to your project

  1. Download Google Test from the official repository and extract the contents of googletest-main into an empty folder in your project (for example, Google_tests/lib).

    Alternatively, clone Google Test as a git submodule or use CMake to download it (instructions below will not be applicable in the latter case).

  2. Create a CMakeLists.txt file inside the Google_tests folder: right-click it in the project tree and select New | CMakeLists.txt.

    Customize the following lines and add them into your script:

    # 'Google_test' is the subproject name
project(Google_tests)

# 'lib' is the folder with Google Test sources
add_subdirectory(lib)
include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})

# 'Google_Tests_run' is the target name
# 'test1.cpp tests2.cpp' are source files with tests
add_executable(Google_Tests_run test1.cpp tests2.cpp)
target_link_libraries(Google_Tests_run gtest gtest_main)

  3. In your root CMakeLists.txt script, add the add_subdirectory(Google_tests) command to the end, then reload the project.

  4. When writing tests, make sure to add #include "gtest/gtest.h" at the beginning of every .cpp file with your tests code.

tip

Take a look at this example in Unit Testing Tutorial.

Generate menu for Google Test

In the files with gtest included, you can generate code for tests and test fixtures using the Generate menu Alt+Insert.

When called from a fixture, this menu additionally includes SetUp Method and TearDown Method:

generate menu for tests

Google Test run/debug configuration

Although Google Test provides the main() entry, and you can run tests as regular applications, we recommend using the dedicated Google Test run/debug configuration. It includes test-related settings and let you benefit from the built-in test runner, which is unavailable if you run tests as regular programs.

note

CLion automatically creates a Google Test configuration for every CMake target linked with gtest or gmock.

Running tests

In CLion, there are several ways to start a run/debug session for tests, one of which is using special gutter icons. These icons help quickly run or debug a single test or a whole suite/fixture:

gutter icons for tests

Gutter icons also show test results (when already available): success App run configurations test state green2 or failure App run configurations test state red2.

When you run a test/suite/fixture using gutter icons, CLion creates a temporary Google Test configuration, which is greyed out in the configurations list. To save a temporary configuration, select it in the Edit Configurations dialog and press App actions menu saveall:

saving temporary test configuration

Exploring results

When you run tests, the results (and the process) are shown in the test runner window. This window includes:

  • progress bar with the percentage of tests executed so far,

  • tree view of all the running tests with their status and duration,

  • tests' output stream,

  • toolbar with the options to rerun failed App run configurations test state red2 tests, export App toolbar decorator export or open previous results saved automatically App vcs history, sort the tests alphabetically App object browser sorted to easily find a particular test, or sort them by duration App run configurations sortby duration to understand which test ran longer than others.

Test tree shows all the tests while they are being executed one by one. For parameterized tests, you will see the parameters in the tree as well. Also, the tree includes disabled tests (those with the DISABLED prefix in their names) and marks them as skipped with the corresponding icon.

Test runner for Google tests

Skipping tests at runtime

You can configure some tests to be skipped based on a condition evaluated at runtime. For this, use the GTEST_SKIP() macro.

note

Google Test supports this feature starting from the version 1.10.0, so make sure to update the framework's sources in your project.

Add the conditional statement and the GTEST_SKIP() macro to the test you want to skip:

TEST(Foo, Bar) {
    //...
    if (condition)
        GTEST_SKIP_("message"); // or GTEST_SKIP() with no message
    //...
}

Use the Show ignored App run configurations show ignored icon to view/hide skipped tests in the Test Runner tree:

Skipped test in the Test Runner tab

See also

Procedures

Getting Started