Restore code coverage

Arnfinn · robertodr · ilfreddy · commit b066ea2ac018 · 2018-02-07T11:46:16.000+01:00
- Replaced coveralls with codecov

Co-authored-by: Roberto Di Remigio &lt;roberto.diremigio@gmail.com&gt;
diff --git a/.ci/Dangerfile b/.ci/Dangerfile
@@ -20,7 +20,13 @@ end
 commit_lint.check disable: [:subject_cap, :subject_period]
 
 # Check code style with clang-format
-code_style_validation.check file_extensions: ['.hpp', '.cpp', '.h'], ignore_file_patterns: [/^external\//]
+code_style_validation.check file_extensions: ['.hpp', '.cpp', '.h'],
+                            ignore_file_patterns: [/^external\//]
+
+# Check code style with YAPF
+code_style_validation.check validator: 'yapf',
+                            file_extensions: ['.py'],
+                            ignore_file_patterns: [/^external\//]
 
 # ------------------------------------------------------------------------------
 # What changed?
diff --git a/.ci/Gemfile b/.ci/Gemfile
@@ -4,4 +4,4 @@ source "https://rubygems.org"
 gem "danger"
 gem "danger-commit_lint"
 gem "danger-lgtm"
-gem 'danger-code_style_validation', '0.1.0' , :git => 'https://github.com/flix-tech/danger-code_style_validation.git'
+gem 'danger-code_style_validation', '0.3.0' , :git => 'https://github.com/flix-tech/danger-code_style_validation.git'
diff --git a/.ci/Gemfile.lock b/.ci/Gemfile.lock
@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/flix-tech/danger-code_style_validation.git
-  revision: 05925775fa1ba9cd3eda09437c8c7efba31ef59e
+  revision: f1ffb28af0f4d6f27711639abcd1e29ed065e232
   specs:
-    danger-code_style_validation (0.1.0)
+    danger-code_style_validation (0.3.0)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -59,9 +59,9 @@ PLATFORMS
 
 DEPENDENCIES
   danger
-  danger-code_style_validation (= 0.1.0)!
+  danger-code_style_validation (= 0.3.0)!
   danger-commit_lint
   danger-lgtm
 
 BUNDLED WITH
-   1.14.4
+   1.14.6
diff --git a/.travis.yml b/.travis.yml
@@ -23,7 +23,7 @@ branches:
 matrix:
   include:
     - os: linux
-      addons: &1
+      addons:
         apt:
           packages:
             - cmake3
@@ -77,22 +77,20 @@ matrix:
         - PYTHON='python3'
         - RUN_DANGER=true
     - os: linux
-      addons: *1
-      env:
-        - CXX_COMPILER='g++-4.6'
-        - C_COMPILER='gcc-4.6'
-        - Fortran_COMPILER='gfortran-4.6'
-        - BUILD_TYPE='debug'
-        - PYTHON='python2'
-        - COVERAGE='--coverage'
-        - RUN_DANGER=false
-  allow_failures:
-    - os: linux
-      addons: *1
+      addons:
+        apt:
+          packages:
+            - cmake3
+            - cmake3-data
+            - g++-4.8
+            - gcc-4.8
+            - gfortran-4.8
+            - libboost-math-dev
+            - lcov
       env:
-        - CXX_COMPILER='g++-4.6'
-        - C_COMPILER='gcc-4.6'
-        - Fortran_COMPILER='gfortran-4.6'
+        - CXX_COMPILER='g++-4.8'
+        - C_COMPILER='gcc-4.8'
+        - Fortran_COMPILER='gfortran-4.8'
         - BUILD_TYPE='debug'
         - PYTHON='python2'
         - COVERAGE='--coverage'
@@ -121,10 +119,17 @@ script:
   - python setup.py --cxx=${CXX_COMPILER} --cc=${C_COMPILER} --fc=${Fortran_COMPILER} --type=${BUILD_TYPE} ${STATIC} ${COVERAGE}
   - cd build
   - ../.ci/ci_build.sh
-  - python ../.ci/ci_test.py ctest --output-on-failure --verbose
+  - travis_wait python ../.ci/ci_test.py ctest --output-on-failure --verbose --parallel 2
   - python ../.ci/ci_print_failing.py
 after_success:
   - |
-    if [[ "${COVERAGE}" = true ]]; then
-      coveralls --root .. -E ".*external.*" -E ".*CMakeFiles.*" -E ".*generated.*" -E ".*tests*" -E ".*tools.*" -E ".*cmake*" -E ".*doc*" -E ".*examples*" || echo 'coveralls upload failed.'
+    if [[ "$COVERAGE" = "--coverage" ]]; then
+      cd $TRAVIS_BUILD_DIR
+      lcov --version
+      lcov --directory . --capture --output-file coverage.info
+      lcov --remove coverage.info '/usr/*' --output-file coverage.info
+      lcov --remove coverage.info 'external/*' --output-file coverage.info
+      lcov --remove coverage.info 'tests/*' --output-file coverage.info
+      lcov --list coverage.info
+      bash <(curl -s https://codecov.io/bash) -X gcov || echo "Codecov did not collect coverage reports"
     fi
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@
   `<build_dir>/lib64` (or `<build_dir>/lib`) as path to `libpcm.so.1`.
   For the executable in `<install_prefix>/bin` the `RPATH` will contain
   `<install_prefix>/lib64` (or `<install_prefix>/lib`) as path to `libpcm.so.1`.
+- Code coverage analysis was restored. We now use
+  [Codecov](https://codecov.io). Thanks @arnfinn :tada:
 
 ### Changed
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -33,7 +33,7 @@ include(autocmake_custom_color_messages)
 include(autocmake_ccache)
 include(windows)
 include(autocmake_definitions)
-include(autocmake_code_coverage)
+include(code_coverage)
 include(autocmake_int64)
 include(autocmake_omp)
 include(autocmake_safeguards)
diff --git a/Pipfile b/Pipfile
@@ -8,7 +8,6 @@ name = "pypi"
 [packages]
 
 breathe = "*"
-cpp-coveralls = "*"
 matplotlib = "*"
 "pep8" = "*"
 Pygments = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![DOI](https://zenodo.org/badge/23794148.svg)](https://zenodo.org/badge/latestdoi/23794148)
 [![Travis CI build status](https://travis-ci.org/PCMSolver/pcmsolver.svg?branch=release%2F1.Y)](https://travis-ci.org/PCMSolver/pcmsolver)
 [![Documentation Status](https://readthedocs.org/projects/pcmsolver/badge/?version=stable)](http://pcmsolver.readthedocs.org/en/latest/?badge=latest)
-[![Coverage Status](https://coveralls.io/repos/PCMSolver/pcmsolver/badge.svg?branch=release%2F1.Y)](https://coveralls.io/r/PCMSolver/pcmsolver?branch=release)
+[![Coverage Status](https://codecov.io/gh/PCMSolver/pcmsolver/branch/release%2F1.Y/graph/badge.svg)](https://codecov.io/gh/PCMSolver/pcmsolver)
 [![Coverity Scan Build](https://scan.coverity.com/projects/3046/badge.svg)](https://scan.coverity.com/projects/3046)
 
 PCMSolver
@@ -31,12 +31,13 @@ using the `Pipfile` and `Pipfile.lock` files. The following
 compilers are used:
 
 1. GCC 4.6, Python 2.7 This build generates _both_ the shared and static
-   libraries, linking executables to the former. The build is run with and
-   without coverage analysis, the latter being a _debug_ build.
+   libraries, linking executables to the former.
 2. GCC 6.3.0, Python 2.7 This build generates _only_ the static library.
 3. Clang 3.5, GFortran 4.6, Python 3.5 This build generates _both_ the shared and static
-   libraries, linking executables to the former. The build is run with and
-   without coverage analysis, the latter being a _debug_ build.
+   libraries, linking executables to the former.
+4. GCC 4.8, Python 2.7 This is a _debug_ build generating _both_ the shared and static
+   libraries, linking executables to the former. The build is run with
+   coverage analysis for submission to [Codecov](https://codecov.io).
 
 The build needed for submission to [Coverity scan](https://scan.coverity.com/)
 is triggered by pushes to the `coverity_scan` branch. It is run on
diff --git a/api/CMakeLists.txt b/api/CMakeLists.txt
@@ -3,6 +3,10 @@ install(FILES ${PROJECT_SOURCE_DIR}/api/PCMInput.h DESTINATION ${CMAKE_INSTALL_I
 
 if(ENABLE_Fortran_API)
     add_library(fortran_bindings OBJECT ${PROJECT_SOURCE_DIR}/api/pcmsolver.f90)
-    set_target_properties(fortran_bindings PROPERTIES INCLUDE_DIRECTORIES "")
+    set_target_properties(fortran_bindings
+      PROPERTIES
+        INCLUDE_DIRECTORIES ""
+        POSITION_INDEPENDENT_CODE 1
+      )
     list(APPEND _objects $<TARGET_OBJECTS:fortran_bindings>)
 endif()
diff --git a/cmake/autocmake.yml b/cmake/autocmake.yml
@@ -27,7 +27,7 @@ modules:
       - '%(url_root)modules/ccache.cmake'
       - 'custom/windows.cmake'
       - '%(url_root)modules/definitions.cmake'
-      - '%(url_root)modules/code_coverage.cmake'
+      - 'custom/code_coverage.cmake'
       - '%(url_root)modules/int64.cmake'
       - '%(url_root)modules/omp.cmake'
       - '%(url_root)modules/safeguards.cmake'
diff --git a/cmake/custom/code_coverage.cmake b/cmake/custom/code_coverage.cmake
@@ -0,0 +1,66 @@
+# (c) https://github.com/coderefinery/autocmake/blob/master/AUTHORS.md
+# licensed under BSD-3: https://github.com/coderefinery/autocmake/blob/master/LICENSE
+
+#.rst:
+#
+# Enables code coverage by appending corresponding compiler flags.
+#
+# Variables modified (provided the corresponding language is enabled)::
+#
+#   CMAKE_Fortran_FLAGS
+#   CMAKE_C_FLAGS
+#   CMAKE_CXX_FLAGS
+#
+# autocmake.yml configuration::
+#
+#   docopt: "--coverage Enable code coverage [default: OFF]."
+#   define: "'-DENABLE_CODE_COVERAGE={0}'.format(arguments['--coverage'])"
+
+option(ENABLE_CODE_COVERAGE "Enable code coverage" OFF)
+
+if(ENABLE_CODE_COVERAGE)
+  if(NOT CMAKE_BUILD_TYPE STREQUAL "debug")
+    message(WARNING "Code coverage analysis results with an optimized (non-Debug) build may be misleading")
+  endif()
+
+  find_program(GCOV_PATH gcov)
+  if(NOT GCOV_PATH)
+    message(FATAL_ERROR "Code coverage analysis requires gcov!")
+  endif()
+
+  if(DEFINED CMAKE_Fortran_COMPILER_ID)
+    if(CMAKE_Fortran_COMPILER_ID MATCHES GNU)
+      set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -fprofile-arcs -ftest-coverage")
+    else()
+      message(FATAL_ERROR "Code coverage analysis requires the GNU Fortran compiler!")
+    endif()
+  endif()
+
+  if(DEFINED CMAKE_C_COMPILER_ID)
+    if(CMAKE_C_COMPILER_ID MATCHES "(Apple)?[Cc]lang")
+      if(CMAKE_C_COMPILER_VERSION VERSION_LESS 3)
+        message(FATAL_ERROR "Code coverage analysis on Mac OS X requires Clang version 3.0.0 or greater!")
+      else()
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage")
+      endif()
+    elseif(CMAKE_C_COMPILER_ID MATCHES GNU)
+      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage")
+    else()
+      message(FATAL_ERROR "Code coverage analysis requires the GNU C compiler!")
+    endif()
+  endif()
+
+  if(DEFINED CMAKE_CXX_COMPILER_ID)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "(Apple)?[Cc]lang")
+      if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 3)
+        message(FATAL_ERROR "Code coverage analysis on Mac OS X requires Clang version 3.0.0 or greater!")
+      else()
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
+      endif()
+    elseif(CMAKE_CXX_COMPILER_ID MATCHES GNU)
+      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
+    else()
+      message(FATAL_ERROR "Code coverage analysis requires the GNU C++ compiler!")
+    endif()
+  endif()
+endif()
diff --git a/cmake/downloaded/autocmake_code_coverage.cmake b/cmake/downloaded/autocmake_code_coverage.cmake
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,2 @@
+ignore:
+  - "src/utils/getkw"
diff --git a/default.nix b/default.nix
@@ -4,7 +4,7 @@ let
     owner = "NixOS";
     repo = "nixpkgs-channels";
     rev = "nixos-unstable";
-    sha256 = "15fcl29a97f68j1pjywmrjm31rdh1a21jz9airlsbzpl4lc3zhfi";
+    sha256 = "1zcbvzxk1vyk4ngfdyss8mlb3mqp050ygpnwqny0bxbzlqkrc4bh";
   });
 in
   with import nixpkgs {
@@ -35,8 +35,8 @@ in
       exa
       ffmpeg
       gfortran
-      gfortran.cc.lib
       graphviz
+      lcov
       pipenv
       python3Full
       python3Packages.docopt
diff --git a/doc/programmers/maintenance.rst b/doc/programmers/maintenance.rst
@@ -46,6 +46,19 @@ Danger.Systems Errors
 - Code style for ``.hpp``, ``.cpp``, ``.h`` files follows the conventions in
   ``.clang-format``.
 
+- Code style for ``.py`` files follows the conventions in ``.style.yapf``.
+
+Updating the Danger Bot
+=======================
+
+The bot reports results from running the `Danger.System ruby gem
+<http://danger.systems/ruby/>`_. From time to time, it is necessary to update
+the ``Gemfile`` and ``Gemfile.lock``:
+
+.. code-block:: bash
+
+   bundle install --gemfile=.ci/Gemfile
+
 Minting a new release
 ---------------------
 
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,4 @@
 breathe
-cpp-coveralls
 matplotlib
 pep8
 Pygments
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -31,7 +31,6 @@ if(NOT STATIC_LIBRARY_ONLY)
     set_target_properties(pcm-shared PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR}
                                                 CXX_VISIBILITY_PRESET hidden
                                                 VISIBILITY_INLINES_HIDDEN 1
-                                                MACOSX_RPATH ON
                                                 OUTPUT_NAME "pcm"
                                                 EXPORT_NAME "pcm")
 
