diff --git a/.ci/build_doxygen.sh b/.ci/build_doxygen.sh index 20bb11f..5087f2b 100644 --- a/.ci/build_doxygen.sh +++ b/.ci/build_doxygen.sh @@ -1,7 +1,7 @@ DOXYGEN_URL="ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.13.src.tar.gz" cd "${DEPS_DIR}" -if [[ ! -f "${DEPS_DIR}/doxygen/bin/doxygen" ]] ; then +if [[ ! -f "${DEPS_DIR}/doxygen/build/bin/doxygen" ]] ; then echo "Downloading Doxygen" mkdir -p doxygen travis_retry wget --no-check-certificate --quiet -O - "${DOXYGEN_URL}" | tar --strip-components=1 -xz -C doxygen diff --git a/.ci/build_lcov.sh b/.ci/build_lcov.sh new file mode 100644 index 0000000..3b89dd3 --- /dev/null +++ b/.ci/build_lcov.sh @@ -0,0 +1,11 @@ +LCOV_URL="http://ftp.de.debian.org/debian/pool/main/l/lcov/lcov_1.13.orig.tar.gz" +cd "${DEPS_DIR}" + +if [[ ! -f "${DEPS_DIR}/lcov/bin/lcov" ]] ; then + echo "Downloading lcov" + mkdir -p lcov + travis_retry wget --no-check-certificate --quiet -O - "${LCOV_URL}" | tar --strip-components=1 -xz -C lcov +fi + +export PATH="${DEPS_DIR}/lcov/bin:${PATH}" +cd "${TRAVIS_BUILD_DIR}" diff --git a/.ci/prepare_altern.sh b/.ci/prepare_altern.sh new file mode 100644 index 0000000..24f6377 --- /dev/null +++ b/.ci/prepare_altern.sh @@ -0,0 +1,16 @@ +cd "${DEPS_DIR}" +mkdir -p extrabin +cd extrabin + +if [ "$CXX" = "g++" ] ; then + ln -s `which gcc-$COMPILER` gcc + ln -s `which g++-$COMPILER` g++ + ln -s `which gcov-$COMPILER` gcov +else + ln -s `which clang-$COMPILER` clang + ln -s `which clang++-$COMPILER` clang++ +fi + +export PATH="${DEPS_DIR}/extrabin":$PATH + +cd "${TRAVIS_BUILD_DIR}" diff --git a/.ci/run_codecov.sh b/.ci/run_codecov.sh new file mode 100755 index 0000000..fa3ff59 --- /dev/null +++ b/.ci/run_codecov.sh @@ -0,0 +1,13 @@ +set -evx + +cd ${TRAVIS_BUILD_DIR} +cd build +cmake .. -DCLI_SINGLE_FILE_TESTS=OFF -DCMAKE_BUILD_TYPE=Coverage +cmake --build . +cmake --build . --target CLI_coverage + +lcov --directory . --capture --output-file coverage.info # capture coverage info +lcov --remove coverage.info '*/tests/*' '*gtest*' '*gmock*' '/usr/*' --output-file coverage.info # filter out system +lcov --list coverage.info #debug info +# Uploading report to CodeCov +bash <(curl -s https://codecov.io/bash) || echo "Codecov did not collect coverage reports" diff --git a/.ci/travis.sh b/.ci/travis.sh index 933c086..7ee9aca 100755 --- a/.ci/travis.sh +++ b/.ci/travis.sh @@ -1,9 +1,8 @@ #!/usr/bin/env sh set -evx -env | sort mkdir build || true cd build -cmake .. -DCLI_SINGLE_FILE_TESTS=ON -make -CTEST_OUTPUT_ON_FAILURE=1 make test +cmake .. -DCLI_SINGLE_FILE_TESTS=ON -DCMAKE_BUILD_TYPE=Debug +cmake --build . +ctest --output-on-failure diff --git a/.codecov.yml b/.codecov.yml new file mode 100644 index 0000000..a530358 --- /dev/null +++ b/.codecov.yml @@ -0,0 +1,3 @@ + +ignore: + - "tests" diff --git a/.travis.yml b/.travis.yml index dd00c8f..8a6826f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,11 @@ matrix: - ubuntu-toolchain-r-test packages: - g++-6 - env: COMPILER=6 + - curl + - lcov + env: + - COMPILER=6 + - COVERALLS=yes - compiler: gcc addons: apt: @@ -39,17 +43,17 @@ matrix: - ubuntu-toolchain-r-test packages: - g++-4.7 - env: COMPILER=4.7 + env: + - COMPILER=4.7 - os: osx install: - python -c 'import sys; print(sys.version_info[:])' -- if [ "$CXX" = "g++" ] && [ "$TRAVIS_OS_NAME" = "linux" ]; then export CXX="g++-$COMPILER" CC="gcc-$COMPILER"; fi -- if [ "$CXX" = "clang++" ] && [ "$TRAVIS_OS_NAME" = "linux" ]; then export CXX="clang++-$COMPILER" CC="clang-$COMPILER"; fi -- if ["$TRAVIS_OS_NAME" = "osx" ] ; then export CXX="clang++" CC="clang"; fi - DEPS_DIR="${TRAVIS_BUILD_DIR}/deps" +- if [ "$TRAVIS_OS_NAME" = "linux" ]; then cd $TRAVIS_BUILD_DIR && . .ci/prepare_altern.sh ; fi - if [ "$TRAVIS_OS_NAME" = "linux" ] ; then cd $TRAVIS_BUILD_DIR && . .ci/build_cmake.sh ; fi - if [ "$TRAVIS_OS_NAME" = "linux" ] ; then cd $TRAVIS_BUILD_DIR && . .ci/build_doxygen.sh ; fi +- if [ -n "$COVERALLS" ] ; then cd $TRAVIS_BUILD_DIR && . .ci/build_lcov.sh ; fi - cd "${DEPS_DIR}" - if [ "$(python -c 'import sys; print(sys.version_info[0])')" = "2" ] ; then pip install --user pathlib; fi @@ -59,9 +63,10 @@ script: - .ci/travis.sh after_success: +- if [ -n "$COVERALLS" ] ; then cd $TRAVIS_BUILD_DIR && .ci/run_codecov.sh ; fi - echo "${TRAVIS_BRANCH}" - echo "${TRAVIS_PULL_REQUEST}" -- if [[ "${TRAVIS_BRANCH}" == "master" && "${TRAVIS_PULL_REQUEST}" == "false" && "$DEPLOY_MAT" == "yes" ]] ; then echo "Updating docs" && cd $TRAVIS_BUILD_DIR && .ci/build_docs.sh ; fi +- if [ "${TRAVIS_BRANCH}" == "master" && "${TRAVIS_PULL_REQUEST}" == "false" && -n "$DEPLOY_MAT" ] ; then echo "Updating docs" && cd $TRAVIS_BUILD_DIR && .ci/build_docs.sh ; fi deploy: provider: releases diff --git a/CMakeLists.txt b/CMakeLists.txt index 14751c8..cd6fca5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -22,6 +22,12 @@ if(MSVC) add_definitions(-D_CRT_SECURE_NO_WARNINGS) endif() + +if(CMAKE_BUILD_TYPE STREQUAL Coverage) + include(CodeCoverage) + setup_target_for_coverage(CLI_coverage ctest coverage) +endif() + add_library(CLI INTERFACE) target_include_directories(CLI INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include") @@ -58,3 +64,4 @@ option(CLI_EXAMPLES "Build the examples" ${CUR_PROJ}) if(CLI_EXAMPLES) add_subdirectory(examples) endif() + diff --git a/README.md b/README.md index 487187c..690aead 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -[![Build Status Linux and macOS](https://img.shields.io/travis/henryiii/CLI11/master.svg?label=Linux/macOS)](https://travis-ci.org/henryiii/CLI11) -[![Build Status Windows](https://img.shields.io/appveyor/ci/HenrySchreiner/cli11/master.svg?label=Windows)](https://ci.appveyor.com/project/HenrySchreiner/cli11) -[![Join the chat at https://gitter.im/CLI11gitter/Lobby](https://badges.gitter.im/CLI11gitter/Lobby.svg)](https://gitter.im/CLI11gitter/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Build Status Linux and macOS][travis-badge]][travis-link] +[![Build Status Windows][appveyor-badge]][appveyor-link] +[![Code Coverage][codecov-badge]][codecov-link] +[![Join the chat at https://gitter.im/CLI11gitter/Lobby][gitter-badge]][gitter-link] [![License: LGPL v2.1](https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg)](./LICENSE) # CLI11: Command line parser for C++11 @@ -251,3 +252,13 @@ try { This will print help in blue, errors in red, and will reset before returning the terminal to the user. + +[travis-badge]: https://img.shields.io/travis/henryiii/CLI11/master.svg?label=Linux/macOS +[travis-link]: https://travis-ci.org/henryiii/CLI11 +[appveyor-badge]: https://img.shields.io/appveyor/ci/HenrySchreiner/cli11/master.svg?label=Windows +[appveyor-link]: https://ci.appveyor.com/project/HenrySchreiner/cli11 +[codecov-badge]: https://codecov.io/gh/henryiii/CLI11/branch/master/graph/badge.svg +[codecov-link]: https://codecov.io/gh/henryiii/CLI11 +[gitter-badge]: https://badges.gitter.im/CLI11gitter/Lobby.svg +[gitter-link]: https://gitter.im/CLI11gitter/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[license-badge]: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg diff --git a/cmake/CodeCoverage.cmake b/cmake/CodeCoverage.cmake new file mode 100644 index 0000000..879e8e5 --- /dev/null +++ b/cmake/CodeCoverage.cmake @@ -0,0 +1,198 @@ +# Copyright (c) 2012 - 2015, Lars Bilke +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, +# are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software without +# specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +# +# +# 2012-01-31, Lars Bilke +# - Enable Code Coverage +# +# 2013-09-17, Joakim Söderberg +# - Added support for Clang. +# - Some additional usage instructions. +# +# USAGE: + +# 0. (Mac only) If you use Xcode 5.1 make sure to patch geninfo as described here: +# http://stackoverflow.com/a/22404544/80480 +# +# 1. Copy this file into your cmake modules path. +# +# 2. Add the following line to your CMakeLists.txt: +# INCLUDE(CodeCoverage) +# +# 3. Set compiler flags to turn off optimization and enable coverage: +# SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") +# SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") +# +# 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target +# which runs your test executable and produces a lcov code coverage report: +# Example: +# SETUP_TARGET_FOR_COVERAGE( +# my_coverage_target # Name for custom target. +# test_driver # Name of the test driver executable that runs the tests. +# # NOTE! This should always have a ZERO as exit code +# # otherwise the coverage generation will not complete. +# coverage # Name of output directory. +# ) +# +# 4. Build a Debug build: +# cmake -DCMAKE_BUILD_TYPE=Debug .. +# make +# make my_coverage_target +# +# + +# Check prereqs + +FIND_PROGRAM( GCOV_PATH gcov) +FIND_PROGRAM( LCOV_PATH lcov ) +FIND_PROGRAM( GENHTML_PATH genhtml ) +FIND_PROGRAM( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests) + +IF(NOT GCOV_PATH) + MESSAGE(FATAL_ERROR "gcov not found! Aborting...") +ENDIF() # NOT GCOV_PATH + +IF("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang") + IF("${CMAKE_CXX_COMPILER_VERSION}" VERSION_LESS 3) + MESSAGE(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...") + ENDIF() +ELSEIF(NOT CMAKE_COMPILER_IS_GNUCXX) + MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...") +ENDIF() # CHECK VALID COMPILER + +SET(CMAKE_CXX_FLAGS_COVERAGE + "-g -O0 --coverage" + CACHE STRING "Flags used by the C++ compiler during coverage builds." + FORCE ) +SET(CMAKE_C_FLAGS_COVERAGE + "-g -O0 --coverage" + CACHE STRING "Flags used by the C compiler during coverage builds." + FORCE ) +SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE + "--coverage" + CACHE STRING "Flags used for linking binaries during coverage builds." + FORCE ) +SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE + "--coverage" + CACHE STRING "Flags used by the shared libraries linker during coverage builds." + FORCE ) +MARK_AS_ADVANCED( + CMAKE_CXX_FLAGS_COVERAGE + CMAKE_C_FLAGS_COVERAGE + CMAKE_EXE_LINKER_FLAGS_COVERAGE + CMAKE_SHARED_LINKER_FLAGS_COVERAGE ) + +IF ( NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "Coverage")) + MESSAGE( WARNING "Code coverage results with an optimized (non-Debug) build may be misleading" ) +ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug" + + +# Param _targetname The name of new the custom make target +# Param _testrunner The name of the target which runs the tests. +# MUST return ZERO always, even on errors. +# If not, no coverage report will be created! +# Param _outputname lcov output is generated as _outputname.info +# HTML report is generated in _outputname/index.html +# Optional fourth parameter is passed as arguments to _testrunner +# Pass them in list form, e.g.: "-j;2" for -j 2 +FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname) + + IF(NOT LCOV_PATH) + MESSAGE(FATAL_ERROR "lcov not found! Aborting...") + ENDIF() # NOT LCOV_PATH + + IF(NOT GENHTML_PATH) + MESSAGE(FATAL_ERROR "genhtml not found! Aborting...") + ENDIF() # NOT GENHTML_PATH + + SET(coverage_info "${CMAKE_BINARY_DIR}/${_outputname}.info") + SET(coverage_cleaned "${coverage_info}.cleaned") + + SEPARATE_ARGUMENTS(test_command UNIX_COMMAND "${_testrunner}") + + # Setup target + ADD_CUSTOM_TARGET(${_targetname} + + # Cleanup lcov + ${LCOV_PATH} --directory . --zerocounters + + # Run tests + COMMAND ${test_command} ${ARGV3} + + # Capturing lcov counters and generating report + COMMAND ${LCOV_PATH} --directory . --capture --output-file ${coverage_info} + COMMAND ${LCOV_PATH} --remove ${coverage_info} '*/tests/*' '*gtest*' '*gmock*' '/usr/*' --output-file ${coverage_cleaned} + COMMAND ${GENHTML_PATH} -o ${_outputname} ${coverage_cleaned} + COMMAND ${CMAKE_COMMAND} -E remove ${coverage_info} ${coverage_cleaned} + + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report." + ) + + # Show info where to find the report + ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD + COMMAND ; + COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report." + ) + +ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE + +# Param _targetname The name of new the custom make target +# Param _testrunner The name of the target which runs the tests +# Param _outputname cobertura output is generated as _outputname.xml +# Optional fourth parameter is passed as arguments to _testrunner +# Pass them in list form, e.g.: "-j;2" for -j 2 +FUNCTION(SETUP_TARGET_FOR_COVERAGE_COBERTURA _targetname _testrunner _outputname) + + IF(NOT PYTHON_EXECUTABLE) + MESSAGE(FATAL_ERROR "Python not found! Aborting...") + ENDIF() # NOT PYTHON_EXECUTABLE + + IF(NOT GCOVR_PATH) + MESSAGE(FATAL_ERROR "gcovr not found! Aborting...") + ENDIF() # NOT GCOVR_PATH + + ADD_CUSTOM_TARGET(${_targetname} + + # Run tests + ${_testrunner} ${ARGV3} + + # Running gcovr + COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} -e '${CMAKE_SOURCE_DIR}/tests/' -o ${_outputname}.xml + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Running gcovr to produce Cobertura code coverage report." + ) + + # Show info where to find the report + ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD + COMMAND ; + COMMENT "Cobertura code coverage report saved in ${_outputname}.xml." + ) + +ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE_COBERTURA