After selecting one of these options, you can customize the pattern as needed (for instance, to generate tests into the source location). You can use the following variables when you are customizing the pattern:

• ${test_ext} - C++test-specific extension of a test suite file (.cpp).
• ${file_name-}  File name.
• ${file_base_name-}  File name without extension.
• ${file_ext-}  File extension.
• ${file_loc-}  File location.
• ${file_loc_rel-}  File location relative to the project root.
• ${file_uid-}  File unique identifier.
• ${function_name-}  Tested function name.
• ${function_uid-}  Tested function unique identifier (hash-code computed from the function signature/mangled name).
• ${src_file_name-}  Name of context (source) file. (A "context file" is a source file that describes the compilation unit in which the given tested function is defined).
• ${src_file_base_name-}  Name of context (source) file without extension.
• ${src_file_ext-}  Extension of context (source) file.
• ${src_file_loc-}  Context (source) file location.
• ${src_file_loc_rel-} Context (source) file location relative to the project root.
• ${src_file_uid-}  Source (context) Context file unique identifier (hash-code computed from the source file location).

Appending or Replacing Existing Tests

You can also control whether C++test will append or replace existing tests if the generated test file has the same name and location as an existing test suite file. This behavior is determined by the When generating tests for code with an existing test suite setting, which provides the following options:

• Add tests for functions without tests: C++test will generate test cases for functions without tests. The existing tests will not be affected or modified.
• Add tests for all functions: C++test will generate test cases for all functions. The existing tests will not be affected or modified.
• Replace the existing test suite: C++test will generate test cases for all functions. The existing test suite will be removed and then replaced with the new one.

Common Test Generation Goals

Anchor
Common Test Generation_Goals Common Test Generation_Goals

The following table explains how to configure the Test Configuration’s generation options to accomplish common test generation goals. Options covered include the  Generation> General tab’s Generate tests for code option and the Generation> Test suite tab’s When generating tests for a code with an existing test suite option. 

Choosing the Layout Option That Suit Your Goals

This section explains how to configure the Test suite output file and layout option (in the Test Configuration’s Generation> Test suite tab) to suit various layout needs. To help you understand how each option discussed translates to actual projects, we show how it would affect the following sample project:

MyProject
  headers
    MyClass.h // contains foo() definition
  sources
    MyClass.cpp // contains bar() and goo() definitions

To generate a single test suite file for each function, keep tests in a separate directory

Use ${project_loc}/tests/${file_loc_rel}/${file_name}/
TestSuite_${function_name}.${test_ext}

Sample layout:

MyProject
  headers
    MyClass.h
  sources
    MyClass.cpp
  tests
    headers
	MyClass.h
	    TestSuite_foo.cpp // contains tests for foo()
     sources
	MyClass.cpp
	  TestSuite_bar.cpp // contains tests for bar()
          TestSuite_goo.cpp // contains tests for goo()

Sample layout:

MyProject
 Header Files
   MyClass.h
 Source Files
   MyClass.cpp
 tests
   Header Files
     MyClass.h
	TestSuite_foo.cpp // contains tests for foo()
   Source Files
     MyClass.cpp
	TestSuite_bar.cpp // contains tests for bar()
	TestSuite_goo.cpp // contains tests for goo() 

To generate a single test suite file for each source/header file, keep tests in a separate directory

Use ${project_loc}/tests/${file_loc_rel}/
TestSuite_${file_base_name}_${file_ext}.${test_ext}

Sample layout:

MyProject
  headers
    MyClass.h
  sources
    MyClass.cpp
  tests
    headers
	TestSuite_MyClass_h.cpp // contains tests for foo()
    sources
	TestSuite_MyClass_cpp.cpp // contains tests for bar() and goo()

To generate a single test suite file for each source/header file, keep tests with the tested files

Use ${project_loc}/${file_loc_rel}/tests/
TestSuite_${file_base_name}_${file_ext}.${test_ext}

Sample layout:

MyProject
  headers
    MyClass.h
    tests
	TestSuite_MyClass_h.cpp // contains tests for foo()
  sources
    MyClass.cpp
    tests
	TestSuite_MyClass_cpp.cpp // contains tests for bar() and goo()
 
 

To keep auto-generated test suite files with original source files

Use ${project_loc}/tests/${file_loc_rel}/${file_name}/
TestSuite_${function_name}.${test_ext}

Sample layout:

MyProject
  module1
    sources
	MyClass.cpp 
	tests
	  TestSuite_MyClass_cpp.cpp
    headers
	MyClass.h
	tests
	  TestSuite_MyClass_h.cpp

To keep the auto-generated test files in an intuitive structure (outside of my original files)

Use ${project}/tests/${source_loc_rel:/MyProject/module1}/
TestSuite_${source_base_name}_${source_ext}.${test_ext}

Sample layout:

MyProject
  module1
    sources
	MyClass.cpp
    headers
	MyClass.h
  tests
    TestSuite_MyClass_cpp.cpp
  headers
    TestSuite_MyClass_h.cpp

To keep test files flat in a single directory (if the project does not have duplicate names)

Use ${project}/tests/TestSuite_${source_base_name}_${source_ext}.${test_ext}

Sample layout:

MyProject
  module1
    sources
	MyClass.cpp
    headers
	MyClass.h
  tests
    TestSuite_MyClass_cpp.cpp
    TestSuite_MyClass_h.cpp

To use "One test suite per function" mode

Use ${project}/tests/${source_base_name}_${source_ext}/
TestSuite_${function_name}_${function_uid}.${test_ext}

Sample layout:

MyProject
  module1
    sources
	MyClass.cpp
    headers
	MyClass.h
  tests
    MyClass_cpp
	TestSuite_foo_1234abcd.cpp
	TestSuite_foo_4321abcd.cpp
	TestSuite_goo_4321dcba.cpp
    MyClass_h
	TestSuite_bar_2143badc.cpp