• Overview
• Demonstration
• Documentation
  • Code Coverage
  • Tutorial
  • CoverageBrowser
  • CoverageScanner
  • FAQ
  • Appendix
• Download
• User Forum
• License
• 

Part V
Appendix

• Additional Tools
  • cmreport
  • cmcsexeimport
  • cmmerge
• Code Coverage Benchmarks
  • Test Algorithm
  • Benchmarks
• Building TestCocoon
  • Required Tools
  • Build Installer
  • Build Steps
• Customizing I/O of CoverageScanner library
  • Custom I/O using C file access
  • Custom I/O using SFTP protocol

Appendix A  Additional Tools

A.1  cmreport - Code Coverage Report Generation

Syntax: cmreport -m <csmes_file> -s <selection> ...


Where:

-m <argument> | --csmes=<argument>

CSMes file name

-l <argument> | --level=<argument>

code coverage level

-s <argument> | --select=<argument>

select executions using regular expression

-d <argument> | --deselect=<argument>

deselect executions using regular expression

-h <argument> | --html=<argument>

HTML report output file name

-t <argument> | --text=<argument>

text report output file name

-x <argument> | --xml=<argument>

XML report output file name

--csv-method=<argument>

Generate a CSV report file for each method

--csv-function=<argument>

Generate a CSV report file for each file

--emma=<argument>

Generate an EMMA-XML report

Specific options for HTML/XML output:

--execution-level=<argument>

code coverage level for executions

--method-level=<argument>

code coverage level for methods

--css=<argument>

CSS style sheet

--icon=<argument>

Icon

--title=<argument>

Title

--global=<argument>

Global statistics, values=all, selected or selected_and_first

--method=<argument>

Method statistics, values=all, selected or selected_and_first

--execution=<argument>

Execution statistics, values=all, selected or selected_and_first

--source=<argument>

Source file statistics, values=all, selected or selected_and_first

--method-sort=<argument>

Method sorting, values=name or coverage

--execution-sort=<argument>

Execution sorting, values=name or coverage

--source-sort=<argument>

Source file sorting, values=name or coverage

--global-watermark-low-medium=<argument>

Global watermark setting

--global-watermark-medium-high=<argument>

Global watermark setting

--source-watermark-low-medium=<argument>

Source watermark setting

--source-watermark-medium-high=<argument>

Source watermark setting

--method-watermark-low-medium=<argument>

Method watermark setting

--method-watermark-medium-high=<argument>

Method watermark setting

--execution-watermark-low-medium=<argument>

Execution watermark setting

--execution-watermark-medium-high=<argument>

Execution watermark setting

--source-sublevels=<argument>

Maximum number of intermediate levels for sources

--execution-sublevels=<argument>

Maximum number of intermediate levels for executions

--global-sublevels=<argument>

Maximum number of intermediate levels for global statistics

--method-sublevels=<argument>

Maximum number of intermediate levels for methods

--source-filter-min=<argument>

Filtering out source files according the statistic

--source-filter-max=<argument>

Filtering out source files according the statistic

--method-filter-min=<argument>

Filtering out methods according the statistic

--method-filter-max=<argument>

Filtering out methods according the statistic

--execution-filter-min=<argument>

Filtering out executions according the statistic

--execution-filter-max=<argument>

Filtering out executions according the statistic

-b | --coverage-branch

code coverage on branch level only

-t | --test-coverage

test count mode

-D | --debug

debug flag

--toc

Table of contents

--manually-validated

Manually validated code fragments

--unexecuted

Unexecuted code fragments

--executed

Executed code fragments

--bargraph

Coverage data displayed in a bargraph

Specific options for text output:

--format-executed=<argument>

Line format for the executed for code fragments

--format-unexecuted=<argument>

Line format for the unexecuted for code fragments

Following keywords are substituted:

%f

Source code file name

%l

Line number

%c

Column number

%m

Explanation

It is allowed to to set the output file to an empty string (i.e.: --text=), in this case the standard output of the console is used.

Specific options for CSV output:

--csv-field-separator=<argument>

Field separator for a CSV file

--csv-coma=<argument>

Coma (, or .) used for floats in a CSV file

cmreport is a utility which permits to generate Text, HTML  XML or CSV reports from an instrumentation data base (.csmes file). It generates exactly the same reports as these generated by CoverageBrowser (see chap. export-statistics).

A.2  cmcsexeimport - Command Line Import Utility

Syntax: cmcsexeimport -m <csmes_file> -e <csexe_file> -t <title> [-p <policy>]


Where:

-m <argument>|--csmes=<argument>

CSMes file name

-e <argument>|--csexe=<argument>

CSExe file name

-t <argument>|--title=<argument>

Execution title

-p <argument>|--policy=<argument>

Import policy (ignore_duplicates, import_duplicates_and_empty, import_duplicates or merge)

-P|--passed

Execution marked as passed.

-F|--failed

Execution marked as failed.

-C|--check-manually

Execution marked as to be checked manually.

cmcsexeimport is a utility which permits to import an execution report (.csexe file) into an instrumentation data base (.csmes file). It behaves exactly like CoverageBrowser load of execution report function (see chap. load-execution-report).

A.3  cmmerge - Merging Utility

Syntax: cmmerge -o <output_file> <input_file> ... <input_file>


Where:

-o <argument>|--output=<argument>

CSMes output file

-a|--append

Do not create new output file but merge into an existing CSMes file.

-v|--verbose

Verbose output

-i <argument>|--instrumentation-and-execution=<argument>

Merge only instrumentations and executions present in the reference file (for importing unittests)

cmmerge is a small utility which permits to merge several instrumentation databases (.csmes file) together. It behaves exactly like CoverageBrowser merge function (see chap. mergedatabase).

Appendix B  Code Coverage Benchmarks

B.1  Test Algorithm

The sorting algorithm used for the tests is quicksort.
Source code:

To download: http://www.testcocoon.org/sort.c

B.2  Benchmarks

Appendix C  Building TestCocoon

C.1  Required Tools

For building the documentation L^AT_EX is necessary: on Linux^™ the version provided by the distribution should be fine, on Microsoft^® Windows MiKTeX¹ can be used and on Apple^® Mac OS X Tex Live² can be installed.

Following tools needs to be installed to compile the project:

To generate the installer, following software are necessary:

C.2  Build Installer

To build Qt:

cd gen/linux
./buildqt.sh install 

  cd gen\windows
  buildqt_x86.bat

  cd gen/macos
  ./buildqt.sh

To build TestCocoon installer:

  gen/linux/build.sh 

  cd gen\windows
  build.bat

  gen/macos/build.sh

C.3  Build Steps

To build the sources follows this steps:

1. Create an empty directory which will contains the result of the build (object and executables).
2. In a shell/DOS prompt go into this directory and execute:

       cmake -DCMAKE_BUILD_TYPE=<build_type> <path_of_sources>
       

   Following values of <build_type> are possible:
   

   <build_type>	Description
   debug	debug mode build
   release	release mode build
   log	release mode build with verbose log output

   -G can be used to generate Microsoft^® Visual Studio^® .NET or Apple^® Xcode projects.
3. Execute make or nmake to generate the project.
4. On Unix, ’make install’ (resp. ’make uninstall’) installs TestCocoon (resp. unistalls). Setting the CMake variable CMAKE_INSTALL_PREFIX permits to set the installation path (ex: cmake -DCMAKE_INSTALL_PREFIX=/tmp/InstallTest ...)

Appendix D  Customizing I/O of CoverageScanner library

D.1  Custom I/O using C file access

The following example shows how to generate the execution report using the standard C file API.

To compile the example on Microsoft^® Windows:

cscl customiofile.c

To compile the example on Linux^™ or Apple^® Mac OS X:

csgcc customiofile.c -o customiofile

Source code:

To download: http://www.testcocoon.org/customiofile.c

D.2  Custom I/O using SFTP protocol

The following example shows how to generate the execution report directly on a SFTP server. The SFTP server is part of SSH v2 and is available on most of the Unix platforms. On Microsoft^® Windows, a free SSH server can be downloaded from http://www.freesshd.com.


To compile the example on Microsoft^® Windows:

1. Download libSSH2 from http://www.libssh2.org. Generate the library and set the environment variable LIBSSH2 to the location of the libSSH2 source code.
2. To compile the example:

   cscl %LIBSSH2%\win32\debug_dll\libssh2.lib -DWIN32 --cs-libgen=/MTd 
        /MTd -I %LIBSSH2%\include ws2_32.lib customiosftp.c 
   

3. Execute custom_io_sftp.exe.

To compile the example on Linux^™:

1. Install the development package of libssh2.
2. To compile the example:

   csgcc -lssh2 customiosftp.c -o customiosftp
   

3. Execute custom_io_sftp.

Source code:

To download: http://www.testcocoon.org/customiosftp.c