Configuration

Boost Unit Test Adapter Configuration

Overview

As described in the User-Manual, the Boost Unit Test Adapter can be configured. This article aims to provide a more technical explanation of the file contents using in-line comments. It is possible to use this as a base for your configuration needs and tweak accordingly.

In order to keep the settings file as simple to read and use, external test runner settings are omitted. For sample configurations for external test runner support, refer to the Additional Sample Configuration Files section.

Boost Unit Test Adapter Sample Configuration

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>

    <!-- General RunSettings Settings Section -->
    <!-- Reference: https://msdn.microsoft.com/en-us/library/jj635153.aspx -->

    <!-- Parallel Test Execution -->
    <!-- Reference: http://blog.drorhelper.com/2015/12/vs2015-update-1-brings-back-parallel.html -->

    <!-- Adapter Specific Settings Section -->

    <!-- Boost Test Adapter Specific Settings Section -->
    <BoostTest>

        <!--
        ExecutionTimeoutMilliseconds - Specifies the duration in milliseconds test process are allowed to execute until forcibly terminated. Use '-1' to allow tests to execute indefinitely.
        Default: '-1' (Indefinite)
        -->
        <ExecutionTimeoutMilliseconds>100</ExecutionTimeoutMilliseconds>

        <!--
        DiscoveryTimeoutMilliseconds - Specifies the duration in milliseconds test process are allowed to execute in order to have their list_content output analyzed until forcibly terminated.
        Default: '5000'
        -->
        <DiscoveryTimeoutMilliseconds>100</DiscoveryTimeoutMilliseconds>

        <!--
        FailTestOnMemoryLeak - Set to 'true'|'1' to fail tests in case memory leaks are detected.
        Default: 'false'|'0'
        -->
        <FailTestOnMemoryLeak>true</FailTestOnMemoryLeak>

        <!--
        LogLevel - Specify Boost.Test log verbosity.
        Possible values: 'All', 'Success', 'TestSuite', 'Message', 'Warning', 'Error', 'CppException', 'SystemError', 'FatalError', 'Nothing'
        Default: 'TestSuite'
        Reference: http://www.boost.org/doc/libs/1_55_0/libs/test/doc/html/utf/user-guide/runtime-config/reference.html
        -->
        <LogLevel>TestSuite</LogLevel>

        <!--
        CatchSystemErrors - Set to 'true'|'1' to force system exceptions (e.g. assert) to be treated as test errors.
        Default: 'false'|'0'
        Reference: http://www.boost.org/doc/libs/1_60_0/libs/test/doc/html/boost_test/utf_reference/rt_param_reference/catch_system.html
        -->
        <CatchSystemErrors>false</CatchSystemErrors>

        <!--
        DetectFloatingPointExceptions - Set to 'true'|'1' to enable Boost.Test's detect_fp_exceptions.
        Default: 'false'|'0'
        Reference: http://www.boost.org/doc/libs/1_60_0/libs/test/doc/html/boost_test/utf_reference/rt_param_reference/detect_fp_exceptions.html
        -->
        <DetectFloatingPointExceptions>true</DetectFloatingPointExceptions>

        <!--
        ExternalTestRunner - Describes the discovery and test execution mechanisms for Boost.Test executables using a custom runner implementation. Refer to 'Additional Sample Configuration Files' for sample configurations.
        -->
        <!-- <ExternalTestRunner /> -->

        <!--
        TestBatchStrategy - Determines how tests should be grouped for execution.
        Possible values: Source, One, TestSuite, TestCase.
        Default: TestCase
        -->
        <TestBatchStrategy>TestSuite</TestBatchStrategy>

        <!--
        RunDisabledTests - Set to 'true'|'1' to force explicitly disabled tests to be run with any other enabled tests if "Run all..." is pressed. By default, only enabled tests are run.
        Default: 'false'|'0'
        -->
        <RunDisabledTests>true</RunDisabledTests>

        <!--
        DEPRECATED: Prefer the use of <ForceBoostVersion> instead
        ForceListContent - Forces the use of 'list_content=DOT' even if the test module is not recognized as a safe module.
        Default: 'false'|'0'
        -->
        <!-- <ForceListContent>false</ForceListContent> -->

        <!--
        ForceBoostVersion - Forces the adapter to assume that all modules are Boost.Test modules using the specified Boost version. The adapter will assume the module's '--list_content' and '--version' capabilities from the specified Boost version.
        -->
        <ForceBoostVersion>1.63</ForceBoostVersion>

        <!--
        WorkingDirectory - Determines the working directory which is to be used during the discovery/execution of the test module. If the test module is executed within a Visual Studio test adapter session, the Working Directory defined in the 'Debug' property sheet configuration overrides this value.
        -->
        <WorkingDirectory>C:\</WorkingDirectory>

        <!--
        EnableStdOutRedirection - Enables/Disables standard output redirection. Note that if disabled, memory leak detection is implicitly disabled.
        Default: 'true'|'1'
        -->
        <EnableStdOutRedirection>true</EnableStdOutRedirection>

        <!--
        EnableStdErrRedirection - Enables/Disables standard error redirection.
        Default: 'true'|'1'
        -->
        <EnableStdErrRedirection>true</EnableStdErrRedirection>

        <!--
        Filters - Define a series of regular expression patterns which determine which test modules should be taken into consideration for discovery/execution.
        Default: All test modules are taken into consideration.
        -->
        <Filters>
            <Include>
                <!-- Include all executables located under 'tests' subdirectories -->
                <Pattern>tests\\[^\\]+?.exe$</Pattern>
            </Include>
            <Exclude>
                <!-- Exclude all DLL shared libraries -->
                <Pattern>.dll$</Pattern>
            </Exclude>
        </Filters>

        <!--
        UseBoost162Workaround - Enables/Disables the Boost 1.62 workaround. Allows the use of the test adapter with Boost.Test released with Boost 1.62.
        Default: 'false'|'0'
        -->
        <UseBoost162Workaround>false</UseBoost162Workaround>

        <!--
        PostTestDelay - Determines a delay (represented in milliseconds) which is applied following test execution to allow correct release of resources.
        Default: 0
        -->
        <PostTestDelay>0</PostTestDelay>

    </BoostTest>

</RunSettings>

Additional Sample Configuration Files

• Sample
• External Test Runner
• Test Filters
• Boost 1.62 Workaround