In this section:

Introduction

To automatically create a project using an existing build system, C/C++test requires information about the code base's build process. To provide C/C++test with the necessary information, you can run the cpptestscan or cpptesttrace utility shipped with C/C++test to create a C/C++test project that you would normally build using build tools such as GNU make, CMake, or QMake. The utilities output a build data file that includes build information required by C/C++test (see About Build Data Files (.bdf) for details). Alternatively, you can first build a project and then configure it manually using the information collected by the utilities.

If you use CMake, you can also define a C/C++test project directly in the CMake build file. This allows you to automatically generate the C/C++test project during the build with CMake – without having to run cpptestscan or cpptesttrace. See Integrating C/C++test into a CMake Build for details.

You can also import the CMake JSON build definition file using the C/C++test project creation wizard. See Importing Project Using Build Data File with the GUI Wizard for additional information about this project creation method.

About Build Data Files (.bdf)

Build information, such as the working directory, command-line options for the compilation, and link processes of the original build, are stored in a file called the build data file. The following example is a fragment from a build data file:

------- cpptestscan v. 9.4.x.x -------
working_dir=/home/place/project/hypnos/pscom
project_name=pscom
arg=g++
arg=-c
arg=src/io/Path.cc
arg=-Iinclude
arg=-I.
arg=-o
arg=/home/place/project/hypnos/product/pscom/shared/io/Path.o

The build data file can be used as a source of information about project source files, compiler executable, compiler options, linker executable, and options used to build the project. There are three ways to use the build data file to create a project:

• Manually setting up 'Use options from the build data file' as the options source for the project and selecting appropriate build data file (see Creating a Project from the GUI).

• Using the GUI to automatically import a project. See Importing project using Build Data File with the GUI wizard.

  Note

  Required environment variables can also be stored in the build data file if the following apply:

  • Your build system sets up the required environment variables for the compiler/linker to work correctly
  • These variables are not available in the environment when running C++tests.

  See the description of the '--cpptestscanEnvInOutput' option below.

Using cpptestscan or cpptesttrace to Create a Build Data File

The cpptestscan and cpptesttrace executables are shipped with C/C++test in the <INSTALL_DIR>/bin directory. They collect information from the build process of an existing code base, generate build data files with the information, and append information about each execution into a file.

The cpptestscan utility is used as a wrapper for the compiler and/or linker during the normal build. To use cpptestscan with an existing build, build the code base with cpptestscan as the prefix for the compiler/linker executable of an existing build to build the codebase. This can be done in two ways:

• Modify the build command line to use cpptestscan as the wrapper for the compiler/linker executables
• If you don’t want to (or cannot) override the compiler variable on the command line, embed cpptestscan in the actual make file or build script.

To use cpptesttrace with an existing build, build the code base with cpptesttrace as the prefix for the entire build command. cpptesttrace will trace the compiler and linker processes executed during the build and store them in the build data file.

In both cases, you need to either add the C++test installation directory to the PATH environment variable or specify the full path to the either utility.

Additional options for cpptestscan and cpptesttrace are summarized in the following table. Options can be set directly for the cpptestscan command or via environment variables. Most options can be applied to cpptestscan or cpptesttrace by changing the prefix in the command line.

Basic cpptestscan usage:

cpptestscan [options] [compile/link command]
cpptestscan --cpptestscanHelp

Basic cpptesttrace usage:

cpptesttrace [options] [build command]
cpptesttrace --cpptesttraceHelp

Example: Modifying GNU Make Build Command to Using cpptestscan

Assuming that a make-based build in which the compiler variable is CXX and the original compiler is g++:

      make -f </path/to/makefile> <make target> [user-specific options] CXX="cpptestscan --cpptestscanOutputFile=/path/to/name.bdf --cpptestscanProjectName=<projectname> g++"

This will build the code as usual, as well as generate a build data file (name.bdf) in the specified directory.

Example: Modifying GNU Make Build Command Using cpptesttrace

Assume that a regular make-based build is executed with:

     make clean all

you could use the following command line:

     cpptesttrace --cpptesttraceOutputFile=/path/to/name.bdf --cpptesttraceProjectName=<projectname> make clean all

This will build the code as usual and generate a build data file (name.bdf) in the specified directory.

Example: Modifying GNU Makefile to use cpptestscan

If your Makefile uses CXX as a variable for the compiler executable and is normally defined as CXX=g++, you can redefine the variable:

     ifeq ($(BUILD_MODE), PARASOFT_CPPTEST)
     CXX="/usr/local/parasoft/cpptestscan --cpptestscanOutputFile=<selected_location>/MyProject.bdf --cpptestscanProjectName=MyProject g++"
     else
     CXX=g++
     endif

Next, run the build as usual and specify an additional BUILD_MODE variable for make:

     make BUILD_MODE=PARASOFT_CPPTEST

The code will be built and a build data file (MyProject.bdf) will be created. The generated build data file can then be used to create a project from the GUI or from the command line.

Example: Using cpptesttrace with CMake build

Assuming that you have a CMake-based build, you can produce a build data file using cpptesttrace:

1. Run the original CMake command to use CMake to generate make files. For example:

   cmake -G "Unix Makefiles" ../project_root

2. Setup environment variables for cpptestscan making sure to use an absolute path for the output file:

   export CPPTEST_SCAN_PROJECT_NAME=my_project
   export CPPTEST_SCAN_OUTPUT_FILE=$PROJ_ROOT/cpptestscan.bdf

3. Make sure the cpptesttrace executable is available on the PATH.
4. Run the project build normally but with cpptesttrace as a wrapper. For example if normal build command is make clean all for the build with 'cpptesttrace' the command will be cpptesttrace make clean all

A build data file will be generated in the location defined by the CPPTEST_SCAN_OUTPUT_FILE variable. If the varialbe is isn’t set, the build data file(s) will be generated in the Makefiles’ locations.

Example: Using cpptestscan with CMake build

All scripts and commands are bash-based – adapt them as needed for different shells.

Assuming a CMake-based build, do the following to produce a build data file using cpptestscan:

1. Use CMake to re-generate make files with the 'cpptestscan' used as a compiler prefix. Make sure the ‘cpptestscan’ executable is available on the PATH.

   1. If original CMake command is cmake -G “Unix Makefiles” ../project_root, then you need to get rid of existing CMake cache and run cmake overriding compiler variables. The following example assumes 'gcc' is used as a C compiler and 'g++' as a C++ compiler executable:

      rm CMakeCache.txt
      CC="cpptestscan gcc" CXX="cpptestscan g++" cmake -G "Unix Makefiles" ../project_root

   2. Look in the CMakeCache.txt file to see if CMAKE_*_COMPILER variables point to cpptestscan.
   3. If the make files are re-generated,  jump to step 5. Continue if cmake failed in the boot-strap phase because the compiler wasn’t recognized.

2. Prepare the cpptestscan wrapper scripts that will behave like a CMake compiler by creating the following BASH scripts. In this example, we assume 'gcc' is used as a C compiler and 'g++' as a C++ compiler executable:

   >cat cpptest_gcc.sh
   #!/bin/bash
   cpptestscan gcc --cpptestscanRunOrigCmd=no $* > /dev/null 2>&1 gcc $*
   exit $?
   
   >cat cpptest_g++.sh
   #!/bin/bash
   cpptestscan g++ --cpptestscanRunOrigCmd=no $* > /dev/null 2>&1 g++ $*
   exit $?

   
   

   • The first script invokes cpptestscan to extract options without running the compiler. The second script runs the actual compiler so that the entire script looks and acts like a compiler in order to be “accepted” by CMake.
3. Give the scripts executable attributes and place them in a common location so they are acces-sible to everyone who needs to scan make files. Make sure the cpptestscan and the scripts are available on the PATH.
4. Use CMake to re-generate make files with the scripts used as compilers by extending the original CMake command with options that re-generate make files from the prepared scripts.

   • Original CMake command is cmake -G “Unix Makefiles” ../project_root then you need to get rid of existing CMake cache and run cmake overriding compiler vari-ables. In the following example, we assume 'gcc' is used as a C compiler and 'g++' as a C++ compiler executable:

     rm CMakeCache.txt
     cmake -G "Unix Makefiles" -D CMAKE_C_COMPILER=cpptest_gcc.sh -D CMAKE_CXX_COMPILER=cpptest_g++.sh ../project_root

   • Look in the CMakeCache.txt file to see if CMAKE_*_COMPILER variables point to prepared wrappers.

5. Setup environment variables for cpptestscan; make sure to use an absolute path for the out-put BDF file:

   export CPPTEST_SCAN_PROJECT_NAME=my_project
   export CPPTEST_SCAN_OUTPUT_FILE=$PROJ_ROOT/cpptestscan.bdf

6. Run the project build normally without overwriting any make variables. Build data files(s) will be generated in the location defined by the CPPTEST_SCAN_OUTPUT_FILE variable or, if not set, in the location of Makefiles.

Using cpptestscan or cpptestrace with other Build Systems

For non-make-based build systems, usage of cpptestscan and cpptesttrace is very similar to the examples shown above. Typically, a compiler is defined as a variable somewhere in the build scripts. To create a Build Data File from that build system using cpptestscan, prefix the original compiler executable with cpptestscan. To create a Build Data File from that build system using cpptesttrace, prefix whole build command line with cpptesttrace.

Importing Project Using Build Data File with the GUI Wizard

You can use the Project Creation wizard to import a BDF or CMake build definition file, which will create a C++test project.

To create a project from a build data/definition file:

1. Choose File> New> Project and choose C++test> Create project from a build data file (.bdf/.json). 
   
2. Click Next and browse for the build data/definition file.
3. Specify a location for the project. Enabling the Use workspace location project location option creates the project in a subdirectory in the workspace location. Enabling Use external location creates a single project directly in the specified location. If multiple projects are created, then subdirectories for each project will be created in the specified external location. For details on the available project creation options and their impacts, see Working with C++test Projects
4. Specify the compiler settings for the project. You can manually configure the settings or specify the compiler family and click Autodetect to automatically configure them. You can view a list of supported compilers by running cpptestcli with the -list-compilers switch.
   
5. Click Next and verify the project’s structure and content and make modifications as needed. 
    
   1. The first level lists all projects that will be created. To change the project’s name or link additional folders to the project, right-click the project name and choose the appropriate shortcut menu command.
   2. The second level lists all folders that will be linked. To change a folder`s name or prevent it from being included in the project, right-click the folder name and choose the appropriate shortcut menu command.
   3. Deeper in the tree, you will see all folders and files which are present in linked folders. A green marker is used to indicate files referenced in the .bdf file.
6. Click Finish to complete the wizard or click Next to set path variables (optional). If setting the path variables:
   1. Enable the Use Path Variable to define linked folder locations (if applicable) option to use path variables in linked folders and choose either a pre-defined path variable or custom path variable from the Path Variable list menu. If you choose a custom path variable, manually enter the path variable name and value in the corresponding fields.
   2. Click Finish and C++test will create the specified project(s) in the specified location. The project(s) will include all source files whose options were scanned, and project properties should be set up appropriately
      
      

Creating a Project from the Command Line

You can also create a BDF-based project in command line mode by using the -bdf <cpptestscan.bdf> switch to cpptestcli.

If you want to perform analysis (e.g., static analysis and/or test generation) immediately after the project is created, ensure that the cpptestcli command uses -config to invoke the preferred Test Configuration. For example:

cpptestcli -data "</path/to/workspace>" -resource "<projectname>" -config "team://Team Configuration"  -settings "</path/to/name.properties>" -bdf  "</path/to/name.bdf>"

If you simply want to create the project (without performing any analysis), omit  -config. For example:

cpptestcli -data "</path/to/workspace>" -resource "<projectname>" -settings "</path/to/name.properties>" -bdf  "</path/to/name.bdf>"

Note that -config "util/CreateProjectOnly", which was previously used for creating a project without testing, is no longer used in the current version of C/C++test. The fake Test Configuration "util/CreateProjectOnly" is no longer supported.

You can define custom project settings in a plain text options file, which is passed to cpptestcli using the -settings switch. Settings can be specified in the options file as described in Settings (Options) Files.

Examples

The following examples demonstrate  how to create a C/C++test project from the command line using cpptestscan. They use the ATM example project shipped with  C/C++test in <INSTALL_DIR>/examples.

The examples use a make-based build; however, a .bdf file can be produced from any build system.

Assumptions and Prerequisites

• The cpptestscan executable must be added to the PATH environment variable:

  <INSTALL_DIR>/bin/cpptestscan

• The cpptestcli executable must be added to the PATH environment variable: <INSTALL_DIR>/cpptestcli

• g++ is assumed to be the original compiler executable.
• The workspace and .bdf file locations have to be entered in a format supported by the given shell/command prompt. For example:
  • /home/MyWorkspace on UNIX/Cygwin
  • c:\home\MyWorkspace on Windows
  • c:/home/MyWorkspace on Cygwin
• To create a project without performing any testing, omit -config
• To create and test the new project, use the appropriate test configuration (e.g. -config Must-HaveRules).
• A full project rebuild will be performed ("clean all") to ensure that all objects are built in the make run

Example 1 - Creating a C++test project in the workspace location with default settings

1. Create a build data file (.bdf) based on the original Makefile as follows:
   1. Go to the <INSTALL_DIR>/examples/ATM directory.
   2. Build the ATM project while prefixing the original compiler executable with the cpptestscan executable:
      > make CC="cpptestscan g++" clean all
   3. Note that a new data file (cpptestscan.bdf) was created in the <INSTALL_DIR>/examples/ATM directory.
2. Create a C/C++test project based on the build data file (.bdf)  as follows:
   1. Use C/C++test's CLI mode to create a new project in the /home/MyWorkspace workspace:
      > cpptestcli -data /home/MyWorkspace -bdf cpptestscan.bdf
   2. Note that a new C++test project (ATM) was created in MyWorkspace location. It contains all the source files and build options of the original <INSTALL_DIR>/examples/ATM project.

Example 2 - Creating a C++test project in original project's location with "Visual C++ 7.1" set as the compiler and "myProject" set as the project name

1. Create a build data file (.bdf) based on the original Makefile as follows:
   1. Go to the <INSTALL_DIR>/examples/ATM directory.
   2. Build the ATM project while prefixing the original compiler executable with the cpptestscan executable:
      > make CC="cpptestscan --cpptestscanProjectName=myProject g++" clean all
   3. Note that a new data file (cpptestscan.bdf) was created in the <INSTALL_DIR>/examples/ATM directory. Notice that myProject was set as project name.
2. Create a C/C++test project based on the build data file (.bdf) as follows:
   • First, override the default settings:
     1. Create a plain text options file named opts.properties in <INSTALL_DIR>/examples/ATM.
     2. Set the compiler family to Visual C++ 7.1 by entering bdf.import.compiler.family=vc_7_1 into the opts.properties file.
     3. Change the destination project location to the location of the cpptestscan.bdf file (which is located in the original project's directory) by entering:
        bdf.import.location=BDF_LOC into opts.properties file
   • Next, use C++test's CLI mode to create a new project in the /home/MyWorkspace workspace:
     cpptestcli -data /home/MyWorkspace -bdf cpptestscan.bdf -settings opts.properties
   • Finally, note that a New C++test project (myProject) was created in <INSTALL_DIR>/examples/ATM location,  containing all the source files and build options of the original <INSTALL_DIR>/examples/ATM project,  having Visual C++ 7.1 set as compiler family.

Notes:

• vc_7_1, which is listed among supported compilers, was used in this example. To use a custom compiler, you would need to specify its path in the C++test Preferences panel (Configurations> Custom directories> Custom compilers). See Configuring Testing with the Cross Compiler for details.
• The BDF_LOC variable was used as the project location; this refers to the cpptestscan.bdf file's location

The generated build data file can be then used to create a project from the GUI or from the command line.

Integrating C/C++test into a CMake Build

C/C++test ships with an extension for CMake that allows you to define C/C++test projects directly in the CMakeLists.txt build file, using the CMake syntax. The extension includes the cpptest_add_executable() CMake function for defining the C/C++test project, including the project location, structure, and content. As a result, the C/C++test project definition files (.project and .parasoft) and a build data file (.bdf) are automatically generated during the CMake build. When the build completes, you can import the C/C++test project files and the BDF into your workspace to perform analysis and testing.

Support for CMake integration consists of the following components:

• <CPPTEST_INSTALL_DIR>/integration/cmake/cpptest-project.cmake – the C/C++test extension for CMake you need to add to the CMakeFiles.txt build file to provide the C/C++test project definition.
• <CPPTEST_INSTALL_DIR>/integration/cmake/cpptest.templates/*.in – a set of C/C++test templates for automatically generated project definition files that allows you to highly customize the extension for CMake.

In addition, the <CPPTEST_INSTALL_DIR>/examples/CMakeProject  directory includes an example project to demonstrate integration with CMake using the C/C++test extension.

Requirements

• CMake 3.10 or later

Workflow Overview

1. Include <INSTALL_DIR>/integration/cmake/cpptest-project.cmake to your CMakeLists.txt build file.
2. Use the cpptest_add_executable() function to define a target that represents your C/C++test project (see Defining the C/C++test Project for details).
3. Activate C/C++test extension with CPPTEST_PROJECT=ON variable and run CMake with the configure and build commands to generate C/C++test project configuration files.
4. Import the automatically generated C/C++test projects to your Eclipse workspace via the UI (Import> General> Existing Projects into Workspace) or command line (-import <ROOT_FOLDER_OR_PROJECT_FILE>).
5. Create test cases and configure stubs. See Test Creation and Execution for details.
6. Run unit tests.

If you store your test artifacts, such as test cases or stubs, in a source control system, do not check in the automatically generated project definition files or build data files (.bdf). These files should be generated every time your CMake project is built.

Defining the C/C++test Project

To enable CMake to automatically generate C/C++test project files, you must define a target that represents your C/C++test project with the cpptest_add_executable() function. At a minimum, you must must configure:

• the name of the target.
• all the source files you want to add to the C/C++test project.
• build options and dependencies (external libraries) using regular CMake functions, such as target_include_directories() or target_link_libraries().

The following options are available:

cpptest_add_executable(
<target_name>
[CPPTEST_COMPILER_ID <compiler_id>]
[CPPTEST_PROJECT_NAME <test_project_name>]
[CPPTEST_PROJECT_LOC <test_project_location>]
[CPPTEST_PROJECT_FOLDERS <name1=location1> <name2=location2> ...]
[EXCLUDE_FROM_ALL]
SOURCES <src1.cpp> <src2.cpp> ... | TARGETS <target1> <target2> ...
)

Example Integration with CMake

This section demonstates integration with CMake using the example project located in the <CPPTEST_INSTALL_DIR>/examples/CMakeProject  directory.

1. Go to <CPPTEST_INSTALL_DIR>/examples/CMakeProject.
2. If you use a compiler other than the default GNU GCC 9 (x64), replace the default compiler identifier gcc_9-64 with your compiler identifier in modules/mod1/CMakeLists.txt and <CPPTEST_INSTALL_DIR>/integration/cmake/cpptest-project.cmake.

3. Build the example project with the following commands:

   > cd <CPPTEST_INSTALL_DIR>/examples/CMakeProject
   > mkdir build
   > cd build
   > cmake -DCPPTEST_PROJECT=ON ..
   > make

   CMake will build the project and generate the C/C++test projects. The following CMakeLists.txt files define the C/C++test projects (with different project layout and configuration options):

   - app/CMakeLists.txt
   - modules/mod1/CMakeLists.txt
   - tests/cpptest_modules/CMakeLists.txt
4. Open an empty workspace in your IDE where C/C++test is installed.
5. Choose File> Import> General> Existing Projects into Workspace from the IDE menu and navigate to the the <CPPTEST_INSTALL_DIR>/examples/CMakeProject directory to import the three automatically generated projects to your IDE.
6. Generate test cases with the builtin://Generate Unit Tests test configuration.
7. Execute test cases with the builtin://Run Unit Tests test configuration.