1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
#!/bin/bash
#==========================================================================
#
# Copyright Insight Software Consortium
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0.txt
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#==========================================================================*/
if [[ $# == 0 || $1 == "--help" ]]
then
echo " "
echo " How to use this script "
echo " "
echo " 0) Use Linux or Mac "
echo " - install lcov"
echo " - use the gcc compiler"
echo " "
echo " 1) Add the CMake flags: "
echo " "
echo " CMAKE_CXX_FLAGS:STRING=-g -O0 -fprofile-arcs -ftest-coverage "
echo " CMAKE_C_FLAGS:STRING= -g -O0 -fprofile-arcs -ftest-coverage "
echo " "
echo " 2) Compile VTK for Debug "
echo " "
echo " CMAKE_BUILD_TYPE Debug "
echo " "
echo " 3) From the TOP of the binary directory type the "ctest" expression that "
echo " selects the tests that you want to use to generate coverage (Ideally "
echo " this should only need to be the unit tests of the class in question). "
echo " "
echo " For example: "
echo " "
echo " ctest -R TestPLY -V -N "
echo " "
echo " This will print to the console the command line instructions needed to "
echo " run the tests (-V option), but without running the tests (-N option). "
echo " "
echo " 4) From the TOP of the binary directory type the path to this script in "
echo " the VTK source tree. Add the relative path from your location at the TOP "
echo " of the binary directory to the directory of the Module for which you want "
echo " to compute code coverage, and add the selection expression that you put "
echo " after ctest in numeral (3) above. "
echo " "
echo " More specifically, for example: "
echo " "
echo " computeCodeCoverageLocallyForOneTest.sh ./IO \ "
echo " -R TestPLY "
echo " "
echo " "
echo " This will run the selected tests in VTK and generate code coverage for "
echo " the entire toolkit, but only from the test that you have selected. The "
echo " code coverage report will be generated in HTML can be opened with your "
echo " favorite browser. The HTML report will be placed in the IO directory. "
echo " For example, in the case above: "
echo " "
echo " In Linux, you can do firefox ./IO/index.html "
echo " In Mac, you can do open ./IO/index.html "
echo " "
else
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
#==========================================================================
echo -n "Please wait while lcov deletes all .da files in . and subdirectories..."
lcov --quiet --directory . --zerocounters
echo "Done"
destinationdir=$1
shift
ctest $*
echo -n "Please wait while lcov captures the coverage data..."
#
# Some compilers (e.g. clang) place the .gcda files in the wrong directory
#
cd $destinationdir
lcov --quiet --directory . --capture --output-file app.info
echo "Done"
echo -n "Please wait while lcov removes coverage for some files..."
lcov --quiet --remove app.info '*ThirdParty*' '*Instantiator.*' 'vtkType*Array.*' '*Tcl.cxx' '*TCLInit.cxx' '*Python.cxx' '*Wrapping*' '*Examples*' '*Testing*' '*Utilities*' '*_s.cxx' '*_vs*.cxx' '*_fs*.cxx' '*GS.cxx' '*VS.cxx' '*FS.cxx' '*FP*.cxx' '*VP*.cxx' 'vtkgl.cxx' '/usr/*' --output-file app.info2
echo "Done"
echo -n "Please wait while genhtml generates an HTML view from lcov coverage data files..."
genhtml --quiet app.info2 >/dev/null 2>&1
echo "Done"
echo "To view results on Linux, type firefox "$destinationdir"/index.html"
echo "To view results on Mac, type open "$destinationdir"/index.html"
fi
|