This section explains how to run analysis and execute tests with C/C++test utilizing a C/C++ toolchain or testing environment provided by a Docker container.

In this section:

Introduction

C/C++test ships with support for running analysis and executing tests in a Docker container. In this scenario, C/C++test hosted on your local machine is configured to run analysis and execute tests in a container that contains your testing environment or C/C++ toolchain.

Docker integration for C/C++test consist of following components:

Requirements

Configuring and Starting the Container

To enable communication between C/C++test and your Docker container, you must ensure that the container has access to all directories on the host that are related to the project you want to test with C/C++test and that C/C++test can identify the container you want to use by its identifier or name.

  1. Mount the following folders to the container:
  2. Assign the container ID or container name to the CPPTEST_CONTAINER_NAME environment variable. For the ease of use, we recommend that you give your container a readable and meaningful name.

Example

The following example assumes that the project and all source files are in the Eclipse workspace /home/devel/workspace and C/C++test is installed in /opt/parasoft/cpptest. The container name is specified with the --name option is "gcc9-test-container" to indicate that the container image includes the GCC 9 compiler.

docker run --rm -it -d -v /opt/parasoft/cpptest:/opt/parasoft/cpptest -v /home/devel/workspace:/home/devel/workspace --name gcc9-test-container gcc:9

Assign the container name to the environment variable:

export CPPTEST_CONTAINER_NAME=gcc9-test-container

Configuring C/C++test to Run Analysis and Testing in the Container

Creating a Custom Compiler Configuration for Unit Testing

Executing tests with C/C++test in a Docker container requires creating a custom compiler configuration to ensure that C/C++test's runtime library can be built inside your container.

  1. Duplicate the compiler configuration that matches your Docker compiler (see Configuring Testing with the Cross Compiler for details about creating a custom compiler configuration).
  2. Modify the <CUSTOM_COMPILER_CONFIG>/gui.properties file to set or remove the following options:
    1. Set autoBuildRuntimeLib=true
    2. Remove -lcpptestruntime64 from linkerCmdLine

You can skip creating a custom compiler configuration if you only run static code analysis.

Setting Up a Project for Testing in a Container

You need to modify your project properties to configure a remote toolchain for your project.

  1. Open the project properties in your IDE.
  2. Go to Parasoft > C/C++test > Build Settings > Compiler settings.
  3. Select the compiler family that matches your compiler configuration; see Creating a Custom Compiler Configuration for Unit Testing.
  4. Replace  the default C / C++ compiler and linker commands with wrapper scripts:
    - C compiler: <CPPTEST_INSTALL_DIR>/integration/docker/remote-gcc
    - C++ compiler: <CPPTEST_INSTALL_DIR>/integration/docker/remote-g++
    - Linker: <CPPTEST_INSTALL_DIR>/integration/docker/remote-g++

    Alternatively, you can copy the scripts from <CPPTEST_INSTALL_DIR>/integration/docker into your project and specify the paths relative to your project. This allows you to store the settings in your source control system and share them across the team. For example:
    - C compiler: ${project_loc}/docker/remote-gcc
    - C++ compiler: ${project_loc}/docker/remote-g++
    - Linker: ${project_loc}/docker/remote-g++

Running Static Analysis in the Container

Before you run static analysis, ensure that your Docker container is running (see Configuring and Starting the Container). No further configuration steps are required.

You can use any test configuration to analyze your code. During analysis, C/C++test will use the C/C++ compiler from the Docker container accessed via the wrapper script you configured in your project properties (see Setting Up a Project for Testing in a Container).

Creating and Executing Unit Test in the Container

Generating Unit Tests

Before you create unit tests with C/C++test, ensure that your Docker container is running (see Configuring and Starting the Container). No further configuration steps are required.

You can use a test configuration to generate unit tests (for example, builtin://Generate Unit Tests). During test generation, C/C++test will use the C/C++ compiler from the Docker container accessed via the wrapper script you configured in your project properties (see Setting Up a Project for Testing in a Container).

Executing Test Cases

Follow these steps to run unit tests with C/C++test:

  1. Before you run unit tests with C/C++test, ensure that your Docker container is running (see Configuring and Starting the Container).
  2. (Optional) Duplicate the built-in Run Unit Tests in Container test configuration and modify the parameters to create a custom test configuration. For example, you can modify the location of the execution wrapper script in Execution > General > Execution details > Remote execution command. The default is:
    ${cpptest:install_dir}/integration/docker/remote-exec).
  3. Run the built-in or custom Run Unit Tests in Container test configuration. C/C++test will:
    1. Build a test executable using the remote toolchain specified in the project properties (see Setting Up a Project for Testing in a Container).
    2. Execute tests inside your container using the remote-exec wrapper script.
    3. Automatically collect test results and coverage information.