Cpp unit test framework

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

A lightweight unit testing framework for C++

License

unittest-cpp/unittest-cpp

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

Maintenance of UnitTest++, recently sporadic, is officially on hiatus until 26 November 2020. Subscribe to #180 for updates.

UnitTest++ is a lightweight unit testing framework for C++. It was designed to do test-driven development on a wide variety of platforms. Simplicity, portability, speed, and small footprint are all very important aspects of UnitTest++. UnitTest++ is mostly standard C++ and makes minimal use of advanced library and language features, which means it should be easily portable to just about any platform. Out of the box, the following platforms are supported:

The full documentation for building and using UnitTest++ can be found on the GitHub wiki page. The contents of this wiki are also included as a git submodule under the docs folder, so version-specific Markdown documentation is always available along with the download.

While there are currently some bundled automake files, UnitTest++ is primarily built and supported using CMake.

git clone https://github.com/unittest-cpp/unittest-cpp 

svn checkout https://github.com/unittest-cpp/unittest-cpp/trunk unittest-cpp 

git clone https://github.com/unittest-cpp/unittest-cpp cd unittest-cpp git checkout v2.0.0 

svn checkout https://github.com/unittest-cpp/unittest-cpp/tags/v2.0.0 unittest-cpp 

UnitTest++ is free software. You may copy, distribute, and modify it under the terms of the License contained in the file LICENSE distributed with this package. This license is the same as the MIT/X Consortium license.

Contributors not included in github history

• Jim Tilander
• Kim Grasman
• Jonathan Jansson
• Dirck Blaskey
• Rory Driscoll
• Dan Lind
• Matt Kimmel — Submitted with permission from Blue Fang Games
• Anthony Moralez
• Jeff Dixon
• Randy Coulman
• Lieven van der Heide

• Change Check method supporting CHECK macro to accept argument by reference
• Introduce long macro forms (e.g. UNITTEST_CHECK); make short forms optional
• Improved Visual Studio 2015 support
• Full List

• Visual Studio 2015 support
• CMake-based build management
• Integration of SourceForge and Google Code versions of the project
• Full List

• CHECK macros work at arbitrary stack depth from inside TESTs.
• Remove obsolete TEST_UTILITY macros
• Predicated test execution (via TestRunner::RunTestsIf)
• Better exception handling for fixture ctors/dtors.
• VC6/7/8/9 support

• Removed dynamic memory allocations (other than streams)
• MinGW support
• Consistent (native) line endings
• Minor bug fixing

• First pass at documentation.
• More detailed error crash catching in fixtures.
• Standard streams used for printing objects under check. This should allow the use of standard class types such as std::string or other custom classes with stream operators to ostream.
• Standard streams can be optionally compiled off by defining UNITTEST_USE_CUSTOM_STREAMS in Config.h
• Added named test suites
• Added CHECK_ARRAY2D_CLOSE
• Posix library name is libUnitTest++.a now
• Floating point numbers are postfixed with ‘f’ in the failure reports

• CHECK macros do not have side effects even if one of the parameters changes state
• Removed CHECK_ARRAY_EQUAL (too similar to CHECK_ARRAY_CLOSE)
• Added local and global time constraints
• Removed dependencies on strstream
• Improved Posix signal to exception translator
• Failing tests are added to Visual Studio’s error list
• Fixed Visual Studio projects to work with spaces in directories

Источник

Write unit tests for C/C++ in Visual Studio

Applies to: Visual Studio Visual Studio for Mac Visual Studio Code

You can write and run your C++ unit tests by using the Test Explorer window. It works just like it does for other languages. For more information about using Test Explorer, see Run unit tests with Test Explorer.

Some features such as Live Unit Testing, Coded UI Tests and IntelliTest aren’t supported for C++.

Visual Studio includes these C++ test frameworks with no extra downloads required:

You can use the installed frameworks, or write your own test adapter for whatever framework you want to use within Visual Studio. A test adapter integrates unit tests with the Test Explorer window. Several third-party adapters are available on the Visual Studio Marketplace. For more information, see Install third-party unit test frameworks.

Visual Studio 2017 and later (Professional and Enterprise)

C++ unit test projects support CodeLens.

Visual Studio 2017 and later (all editions)

• Google Test Adapter is included as a default component of the Desktop development with C++ workload. It has a project template that you can add to a solution. Right-click on the solution node in Solution Explorer and choose Add >New Project on the shortcut menu to add the project template. It also has options you can configure via Tools >Options. For more information, see How to: Use Google Test in Visual Studio.
• Boost.Test is included as a default component of the Desktop development with C++ workload. It’s integrated with Test Explorer, but currently doesn’t have a project template. It must be manually configured. For more information, see How to: Use Boost.Test in Visual Studio.
• CTest support is included with the C++ CMake tools component, which is part of the Desktop development with C++ workload. For more information, see How to: Use CTest in Visual Studio.

Visual Studio 2015 and earlier

You can download the Google Test adapter and Boost.Test Adapter extensions on the Visual Studio Marketplace. Find them at Test adapter for Boost.Test and Test adapter for Google Test.

Basic test workflow

The following sections show the basic steps to get you started with C++ unit testing. The basic configuration is similar for both the Microsoft and Google Test frameworks. Boost.Test requires that you manually create a test project.

Create a test project in Visual Studio 2022

Define and run unit tests inside one or more test projects. A test project creates a separate app that calls the code in your executable and reports on its behavior. Create test projects in the same solution as the code you want to test.

To add a new test project to an existing solution,

1. Right-click on the Solution node in Solution Explorer.
2. In the pop-up menu, choose Add >New Project.
3. Set Language to C++ and type «test» into the search box. The following illustration shows the test projects that are available when the Desktop Development with C++ and the UWP Development workload are installed:

Create a test project in Visual Studio 2019

Define and run tests inside one or more test projects. Create the projects in the same solution as the code you want to test. To add a new test project to an existing solution,

1. Right-click on the Solution node in Solution Explorer.
2. In the pop-up menu, choose Add >New Project.
3. Set Language to C++ and type «test» into the search box. The following illustration shows the test projects that are available when the Desktop Development with C++ and the UWP Development workload are installed:

Create references to other projects in the solution

To enable access to the functions in the project under test, add a reference to the project in your test project. Right-click on the test project node in Solution Explorer for a pop-up menu. Choose Add > Reference. In the Add Reference dialog, choose the project(s) you want to test.

Link to object or library files

If the test code doesn’t export the functions that you want to test, add the output .obj or .lib files to the dependencies of the test project. For more information, see To link the tests to the object or library files. Don’t include object files that have a main function or another standard entry point such as wmain , WinMain , or DllMain . When you add new source files to your project, update the test project dependencies to include the corresponding object files.

Add #include directives for header files

Next, in your unit test .cpp file, add an #include directive for any header files that declare the types and functions you want to test. Type #include » , and then IntelliSense activates to help you choose. Repeat for any more headers.

To avoid having to type the full path in each include statement in the source file, add the required folders in Project > Properties > C/C++ > General > Additional Include Directories.

Write test methods

This section shows syntax for the Microsoft Unit Testing Framework for C/C++. It is documented here: Microsoft.VisualStudio.TestTools.CppUnitTestFramework API reference. For Google Test documentation, see Google Test primer. For Boost.Test, see Boost Test library: The unit test framework.

The .cpp file in your test project has a stub class and method defined for you. They show an example of how to write test code. The signatures use the TEST_CLASS and TEST_METHOD macros, which make the methods discoverable from the Test Explorer window.

TEST_CLASS and TEST_METHOD are part of the Microsoft Native Test Framework. Test Explorer discovers test methods in other supported frameworks in a similar way.

A TEST_METHOD returns void. To produce a test result, use the static methods in the Assert class to test actual results against expected results. In the following example, assume MyClass has a constructor that takes a std::string . This example shows how you can test that the constructor initializes the class the way you expect:

In the previous example, the result of the Assert::AreEqual call determines whether the test passes or fails. The Assert class contains many other methods to compare expected results with actual results.

You can add traits to test methods to specify test owners, priority, and other information. You can then use these values to sort and group tests in Test Explorer. For more information, see Run unit tests with Test Explorer.

Run the tests

1. On the Test menu, choose Windows >Test Explorer. The following illustration shows a test project whose tests have not yet run.

Note CTest integration with Test Explorer is not yet available. Run CTest tests from the CMake main menu.

If any of your tests are missing from the window, build the test project by right-clicking its node in Solution Explorer and choosing Build or Rebuild.

In Test Explorer, choose Run All, or select the specific tests you want to run. Right-click on a test for other options, including running it in debug mode with breakpoints enabled. After all the tests run, the window shows the tests that passed and the ones that failed.

For failed tests, the message displays details that help to diagnose the cause. Right-click on the failing test for a pop-up menu. Choose Debug to step through the function where the failure occurred.

For more information on using Test Explorer, see Run unit tests with Test Explorer.

For more information on unit testing, see Unit test basics.

Use CodeLens

Visual Studio 2017 and later (Professional and Enterprise editions)

CodeLens lets you quickly see the status of a unit test without leaving the code editor.

Initialize CodeLens for a C++ unit test project in any of the following ways:

• Edit and build your test project or solution.
• Rebuild your project or solution.
• Run tests from the Test Explorer window.

After it’s initialized, you can see the test status icons above each unit test.

Choose the icon for more information, or to run or debug the unit test:

See also

Источник