Skip to content
/ test Public

The reference C++ unit testing framework (TDD, xUnit, C++03/11/14/17)

License

Notifications You must be signed in to change notification settings

boostorg/test

Repository files navigation

boosttest logo

What is Boost.Test?

Boost.Test is a C++11/14/17 unit testing library, available on a wide range of platforms and compilers.

The library is part of Boost. The latest release of the library is available from the boost web site.

Full instructions for use of this library can be accessed from http://www.boost.org/doc/libs/release/libs/test/

Key features

  • Easy to get started with:
    1. download and deflate the latest boost archive
    2. create a test module with this (header version):
      #define BOOST_TEST_MODULE your_test_module
      #include <boost/test/included/unit_test.hpp>
      
    3. Write your first test case:
      BOOST_AUTO_TEST_CASE( your_test_case ) {
          std::vector<int> a{1, 2};
          std::vector<int> b{1, 2};
          BOOST_TEST( a == b );
      }
      
    4. build and run
    5. done
  • powerful and unique test assertion macro BOOST_TEST, that understands floating points, collections, strings... and uses appropriate comparison paradigm
  • self-registering test cases, organize cases in test suites, apply fixtures on test cases, suites or globally
  • provide assertion context for advanced diagnostic on failure
  • powerful and extensible dataset tests
  • add decoration to test cases and suites for advanced description, group/label, and dependencies
  • powerful command line options and test case filters
  • extensible logging, XML and JUNIT outputs for third-party tools (eg. cont. integration)
  • various usage (shared/static library/header only) for faster integration and/or compilation/build cycles, smaller binaries

Copyright and license

Copyright 2001-2014, Gennadiy Rozental.
Copyright 2013-2020, Boost.Test team.

Distributed under the Boost Software License, Version 1.0.
(Get a copy at www.boost.org/LICENSE_1_0.txt)

Contribute

Please read this document to get started.

Build Status

Boost.Test uses mostly the facility provided by our wonderful Boost testers (column Tests below).

Branch Deps Docs Tests Github Actions
master Deps Documentation Enter the Matrix Build Status
develop Deps Documentation Enter the Matrix Build Status