How to setup Google C++ Testing Framework (gtest)

Question

It is not documented on the web site and people seems having problem setting up the framework. Can someone please show step by step introduction to a sample project setup.

Answer 1

I did a video tutorial about the setup: http://www.youtube.com/watch?v=mzSzwQOmMRs

Answer 2

Having built gtest, this is what I have done:

1. Add \mypath\gtest-1.0.1\Debug (or Release) to Common Properties->Linker->General->Additional Library Directories
2. Add gtest.lib and gtest_main.lib to Common Properties->Linker->Input->Additional Dependencies

After that I just write my tests using TEST or TEST_F as appropriate and compile them together with my main function:

int main(int argc, char** argv)
{
    testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}

Answer 3

In Microsoft Visual Studio, misconfigured runtime library type causes link errors.

VS 2005(and 2008) uses Multithreaded DLL or Multithreaded Debug DLL as default. But Google Test library uses Mulithreaded or Mulithreaded debug runtime as default.

So, choose appropriate run time library type for google test library. (in Configuration properties -> Code Generation -> Runtime Library).

Answer 4

Many errors, took a while to fix.

Here are simple steps:

# Download Googletest ZIP file from: https://github.com/google/googletest

# Googletest visual studio solution

Open    C:\googletest\googletest\msvc\2010\gtest.sln
    Change "Solution configuration"
        from "Debug" to "Release"
    Build Solution
        creates gtest.lib

# Your project:

Project Properties > Configuration Properties > VC++ Directories > Include Directories
    append the following:       ;C:\googletest\googletest\include

Project Properties > Configuration Properties > Linker > General > Additional Library Directories > 
    append the following:           ;C:\googletest\googletest\msvc\2010\gtest\Win32-Release

Project Properties > Configuration Properties > C/C++ > Runtime Library
    Remove the value of the above. (or match it to Googletest project)

Answer 5

(These instructions get the testing framework working for the Debug configuration. It should be pretty trivial to apply the same process to the Release configuration.)

Get Google C++ Testing Framework

1. Download the latest gtest framework
2. Unzip to C:\gtest

Build the Framework Libraries

1. Open C:\gtest\msvc\gtest.sln in Visual Studio
2. Set Configuration to "Debug"
3. Build Solution

Create and Configure Your Test Project

1. Create a new solution and choose the template Visual C++ > Win32 > Win32 Console Application
2. Right click the newly created project and choose Properties
3. Change Configuration to Debug.
4. Configuration Properties > C/C++ > General > Additional Include Directories: Add C:\gtest\include
5. Configuration Properties > C/C++ > Code Generation > Runtime Library: If your code links to a runtime DLL, choose Multi-threaded Debug DLL (/MDd). If not, choose Multi-threaded Debug (/MTd).
6. Configuration Properties > Linker > General > Additional Library Directories: Add C:\gtest\msvc\gtest\Debug or C:\gtest\msvc\gtest-md\Debug, depending on the location of gtestd.lib
7. Configuration Properties > Linker > Input > Additional Dependencies: Add gtestd.lib

Verifying Everything Works

1. Open the cpp in your Test Project containing the main() function.

2. Paste the following code:

   #include "stdafx.h"  
   #include <iostream>
   
   #include "gtest/gtest.h"
   
   TEST(sample_test_case, sample_test)
   {
       EXPECT_EQ(1, 1);
   }
   
   int main(int argc, char** argv) 
   { 
       testing::InitGoogleTest(&argc, argv); 
       RUN_ALL_TESTS(); 
       std::getchar(); // keep console window open until Return keystroke
   }
   

3. Debug > Start Debugging

If everything worked, you should see the console window appear and show you the unit test results.

Answer 6

What Arlaharen said was basically right, except he left out the part which explains your linker errors. First of all, you need to build your application without the CRT as a runtime library. You should always do this anyways, as it really simplifies distribution of your application. If you don't do this, then all of your users need the Visual C++ Runtime Library installed, and those who do not will complain about mysterious DLL's missing on their system... for the extra few hundred kilobytes that it costs to link in the CRT statically, you save yourself a lot of headache later in support (trust me on this one -- I've learned it the hard way!).

Anyways, to do this, you go to the target's properties -> C/C++ -> Code Generation -> Runtime Library, and it needs to be set as "Multi-Threaded" for your Release build and "Multi-Threaded Debug" for your Debug build.

Since the gtest library is built in the same way, you need to make sure you are linking against the correct version of it, or else the linker will pull in another copy of the runtime library, which is the error you saw (btw, this shouldn't make a difference if you are using MFC or not). You need to build gtest as both a Debug and Release mode and keep both copies. You then link against gtest.lib/gtest_main.lib in your Release build and gtestd.lib/gtest_maind.lib in your Debug build.

Also, you need to make sure that your application points to the directory where the gtest header files are stored (in properties -> C/C++ -> General -> Additional Include Directories), but if you got to the linker error, I assume that you already managed to get this part correct, or else you'd have a lot more compiler errors to deal with first.