Merge lp:~marcustomlinson/unity-js-scopes/add-coverage into lp:unity-js-scopes

[Marcus Tomlinson]

Added test coverage report

[lp:~marcustomlinson/unity-js-scopes/add-coverage]

124. By Marcus Tomlinson on 2015-12-18

Merged SIGTERM fix

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:124
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/63/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/64/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/64/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/63/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/63/rebuild

review: Needs Fixing (continuous-integration)

[lp:~marcustomlinson/unity-js-scopes/add-coverage]

125. By Marcus Tomlinson on 2015-12-18

Added cmake modules dir to root CMakeLists.txt

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:125
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/65/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/66
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/66
        deb: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/66/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/65

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/65/rebuild

review: Approve (continuous-integration)

[lp:~marcustomlinson/unity-js-scopes/add-coverage]

126. By Marcus Tomlinson on 2015-12-23

Exclude headers from coverage report as they are never hit via our Node boundaries

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:126
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/67/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/68
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/68
        deb: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/68/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/67

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/67/rebuild

review: Approve (continuous-integration)

[Alexandre Abreu (abreu-alexandre)]

+1

review: Approve

[Marcus Tomlinson (marcustomlinson)]

Top approving

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-11-13 08:28:39 +0000
+++ CMakeLists.txt	2015-12-23 08:26:29 +0000
@@ -20,13 +20,7 @@
 
 project(js-scopes)
 
-include(CheckCXXCompilerFlag)
-include(CheckIncludeFileCXX)
-
-# Standard install paths
-include(GNUInstallDirs)
-
-set(CMAKE_INCLUDE_CURRENT_DIR TRUE CACHE INTERNAL "")
+# Retrieve dependencies
 
 message(STATUS "Retrieving deps")
 
@@ -40,6 +34,29 @@
   message(FATAL_ERROR "Retriving deps failed")
 endif()
 
+# Configure CMake environment
+
+string(TOLOWER "${CMAKE_BUILD_TYPE}" cmake_build_type_lower)
+
+set(CMAKE_INCLUDE_CURRENT_DIR TRUE CACHE INTERNAL "")
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
+
+include(CheckCXXCompilerFlag)
+include(CheckIncludeFileCXX)
+include(EnableCoverageReport)
+include(GNUInstallDirs)
+
+# Enable testing
+
+enable_testing()
+
+add_custom_target(
+  check
+  ${CMAKE_CTEST_COMMAND} --force-new-ctest-process --output-on-failure
+)
+
+# Add includes
+
 include_directories(
   ${CMAKE_CURRENT_SOURCE_DIR}/deps/node.js/deps/uv/include
   ${CMAKE_CURRENT_SOURCE_DIR}/deps/node.js/deps/v8/include
@@ -48,8 +65,7 @@
   ${CMAKE_CURRENT_SOURCE_DIR}/src
   )
 
-string(TOLOWER "${CMAKE_BUILD_TYPE}" cmake_build_type_tolower)
-if(cmake_build_type_tolower STREQUAL "debug")
+if(cmake_build_type_lower MATCHES debug)
   link_directories(
     ${CMAKE_CURRENT_SOURCE_DIR}/deps/node.js/out/Debug
   )
@@ -59,8 +75,11 @@
   )
 endif()
 
+# Add sources
+
+add_subdirectory(doc)
 add_subdirectory(src)
-add_subdirectory(doc)
+add_subdirectory(tests)
 
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/examples
         DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes)
@@ -70,11 +89,15 @@
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/qtc-templates/scope-js
         DESTINATION /usr/ubuntu-sdk-ide/share/qtcreator/templates/wizards/ubuntu)
 
-# Set up the tests
-enable_testing()
-add_subdirectory(tests)
+# Enable coverage report
 
-add_custom_target(
-  check
-  ${CMAKE_CTEST_COMMAND} --force-new-ctest-process --output-on-failure
-)
+if (cmake_build_type_lower MATCHES coverage)
+  ENABLE_COVERAGE_REPORT(TARGETS unity_js_scopes_bindings
+                         FILTER /usr/include
+                                ${CMAKE_CURRENT_SOURCE_DIR}/deps/*
+                                ${CMAKE_CURRENT_SOURCE_DIR}/examples/*
+                                ${CMAKE_CURRENT_SOURCE_DIR}/qtc-templates/*
+                                ${CMAKE_CURRENT_SOURCE_DIR}/src/*.h
+                                ${CMAKE_CURRENT_SOURCE_DIR}/tests/*
+                                ${CMAKE_BINARY_DIR}/*)
+endif()

=== added directory 'cmake'
=== added file 'cmake/EnableCoverageReport.cmake'
--- cmake/EnableCoverageReport.cmake	1970-01-01 00:00:00 +0000
+++ cmake/EnableCoverageReport.cmake	2015-12-23 08:26:29 +0000
@@ -0,0 +1,166 @@
+# - Creates a special coverage build type and target on GCC.
+#
+# Defines a function ENABLE_COVERAGE_REPORT which generates the coverage target
+# for selected targets. Optional arguments to this function are used to filter
+# unwanted results using globbing expressions. Moreover targets with tests for
+# the source code can be specified to trigger regenerating the report if the
+# test has changed
+#
+# ENABLE_COVERAGE_REPORT(TARGETS target... [FILTER filter...] [TESTS test targets...])
+#
+# To generate a coverage report first build the project with
+# CMAKE_BUILD_TYPE=coverage, then call make test and afterwards make coverage.
+#
+# The coverage report is based on gcov. Depending on the availability of lcov
+# a HTML report will be generated and/or an XML report of gcovr is found.
+# The generated coverage target executes all found solutions. Special targets
+# exist to create e.g. only the xml report: coverage-xml. 
+#
+# Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
+#
+# This program is free software; you can redistribute it
+# and/or modify it under the terms of the GNU General
+# Public License as published by the Free Software Foundation;
+# either version 2, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+
+INCLUDE(ParseArguments)
+
+FIND_PACKAGE(Lcov)
+FIND_PACKAGE(gcovr)
+
+FUNCTION(ENABLE_COVERAGE_REPORT)
+    
+    # argument parsing
+    PARSE_ARGUMENTS(ARG "FILTER;TARGETS;TESTS" "" ${ARGN})
+    
+    SET(COVERAGE_RAW_FILE "${CMAKE_BINARY_DIR}/coverage.raw.info")
+    SET(COVERAGE_FILTERED_FILE "${CMAKE_BINARY_DIR}/coverage.info")
+    SET(COVERAGE_REPORT_DIR "${CMAKE_BINARY_DIR}/coveragereport")
+    SET(COVERAGE_XML_FILE "${CMAKE_BINARY_DIR}/coverage.xml")
+    SET(COVERAGE_XML_COMMAND_FILE "${CMAKE_BINARY_DIR}/coverage-xml.cmake")
+    
+    # decide if there is any tool to create coverage data
+    SET(TOOL_FOUND FALSE)
+    IF(LCOV_FOUND OR GCOVR_FOUND)
+        SET(TOOL_FOUND TRUE)
+    ENDIF()
+    IF(NOT TOOL_FOUND)
+        MESSAGE(STATUS "Cannot enable coverage targets because neither lcov nor gcovr are found.")
+    ENDIF()
+    
+    STRING(TOLOWER "${CMAKE_BUILD_TYPE}" COVERAGE_BUILD_TYPE)
+    IF(CMAKE_COMPILER_IS_GNUCXX AND TOOL_FOUND AND "${COVERAGE_BUILD_TYPE}" MATCHES "coverage")
+    
+        MESSAGE(STATUS "Coverage support enabled for targets: ${ARG_TARGETS}")
+    
+        # create coverage build type
+        SET(CMAKE_CXX_FLAGS_COVERAGE ${CMAKE_CXX_FLAGS_DEBUG} PARENT_SCOPE)
+        SET(CMAKE_C_FLAGS_COVERAGE ${CMAKE_C_FLAGS_DEBUG} PARENT_SCOPE)
+        SET(CMAKE_CONFIGURATION_TYPES ${CMAKE_CONFIGURATION_TYPES} coverage PARENT_SCOPE)
+    
+        # instrument targets
+        SET_TARGET_PROPERTIES(${ARG_TARGETS} PROPERTIES COMPILE_FLAGS --coverage
+                                                        LINK_FLAGS --coverage)
+    
+        # html report
+        IF (LCOV_FOUND)
+        
+            MESSAGE(STATUS "Enabling HTML coverage report")
+    
+            # set up coverage target
+            
+            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_RAW_FILE}
+                               COMMAND ${LCOV_EXECUTABLE} -c -d ${CMAKE_BINARY_DIR} -o ${COVERAGE_RAW_FILE}
+                               WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+                               COMMENT "Collecting coverage data"
+                               DEPENDS ${ARG_TARGETS} ${ARG_TESTS}
+                               VERBATIM)
+            
+            # filter unwanted stuff
+            LIST(LENGTH ARG_FILTER FILTER_LENGTH)
+            IF(${FILTER_LENGTH} GREATER 0)
+                SET(FILTER COMMAND ${LCOV_EXECUTABLE})
+                FOREACH(F ${ARG_FILTER})
+                    SET(FILTER ${FILTER} -r ${COVERAGE_FILTERED_FILE} ${F})
+                ENDFOREACH()
+                SET(FILTER ${FILTER} -o ${COVERAGE_FILTERED_FILE})
+            ELSE()
+                SET(FILTER "")
+            ENDIF()
+            
+            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_FILTERED_FILE}
+                               COMMAND ${LCOV_EXECUTABLE} -e ${COVERAGE_RAW_FILE} "${CMAKE_SOURCE_DIR}*"  -o ${COVERAGE_FILTERED_FILE}
+                               ${FILTER}
+                               DEPENDS ${COVERAGE_RAW_FILE}
+                               COMMENT "Filtering recorded coverage data for project-relevant entries"
+                               VERBATIM)
+            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_REPORT_DIR}
+                               COMMAND ${CMAKE_COMMAND} -E make_directory ${COVERAGE_REPORT_DIR}
+                               COMMAND ${GENHTML_EXECUTABLE} --legend --show-details -t "${PROJECT_NAME} test coverage" -o ${COVERAGE_REPORT_DIR} ${COVERAGE_FILTERED_FILE}
+                               DEPENDS ${COVERAGE_FILTERED_FILE}
+                               COMMENT "Generating HTML coverage report in ${COVERAGE_REPORT_DIR}"
+                               VERBATIM)
+                               
+            ADD_CUSTOM_TARGET(coverage-html
+                              DEPENDS ${COVERAGE_REPORT_DIR})
+                              
+        ENDIF()
+        
+        # xml coverage report
+        IF(GCOVR_FOUND)
+        
+            MESSAGE(STATUS "Enabling XML coverage report")
+
+            # filter unwanted stuff
+            SET(GCOV_FILTER "")
+            LIST(LENGTH ARG_FILTER FILTER_LENGTH)
+            IF(${FILTER_LENGTH} GREATER 0)
+                FOREACH(F ${ARG_FILTER})
+                    SET(GCOV_FILTER "${GCOV_FILTER} -e \"${F}\"")
+                ENDFOREACH()
+            ENDIF()
+
+            # gcovr cannot write directly to a file so the execution needs to
+            # be wrapped in a cmake file that generates the file output
+            FILE(WRITE ${COVERAGE_XML_COMMAND_FILE}
+                 "SET(ENV{LANG} en)\n")
+            FILE(APPEND ${COVERAGE_XML_COMMAND_FILE}
+                 "EXECUTE_PROCESS(COMMAND \"${GCOVR_EXECUTABLE}\" -x -r \"${CMAKE_SOURCE_DIR}\" ${GCOV_FILTER} OUTPUT_FILE \"${COVERAGE_XML_FILE}\" WORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\")\n")
+        
+            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_XML_FILE}
+                               COMMAND ${CMAKE_COMMAND} ARGS -P ${COVERAGE_XML_COMMAND_FILE}
+                               COMMENT "Generating coverage XML report"
+                               VERBATIM)
+                               
+            ADD_CUSTOM_TARGET(coverage-xml
+                              DEPENDS ${COVERAGE_XML_FILE})
+        
+        ENDIF()
+        
+        # provide a global coverage target executing both steps if available
+        SET(GLOBAL_DEPENDS "")
+        IF(LCOV_FOUND)
+            LIST(APPEND GLOBAL_DEPENDS ${COVERAGE_REPORT_DIR})
+        ENDIF()
+        IF(GCOVR_FOUND)
+            LIST(APPEND GLOBAL_DEPENDS ${COVERAGE_XML_FILE})
+        ENDIF()
+        IF(LCOV_FOUND OR GCOVR_FOUND)
+            ADD_CUSTOM_TARGET(coverage
+                              DEPENDS ${GLOBAL_DEPENDS})
+        ENDIF()
+                          
+    ENDIF()
+
+    # This gets rid of any stale .gcda files. Run this if a running a binary causes lots of messages about
+    # about a "merge mismatch for summaries".
+    ADD_CUSTOM_TARGET(clean-coverage COMMAND find ${CMAKE_BINARY_DIR} -name '*.gcda' | xargs rm -f)
+
+ENDFUNCTION()   

=== added file 'cmake/FindLcov.cmake'
--- cmake/FindLcov.cmake	1970-01-01 00:00:00 +0000
+++ cmake/FindLcov.cmake	2015-12-23 08:26:29 +0000
@@ -0,0 +1,29 @@
+# - Find lcov 
+# Will define:
+#
+# LCOV_EXECUTABLE - the lcov binary
+# GENHTML_EXECUTABLE - the genhtml executable
+#
+# Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
+#
+# This program is free software; you can redistribute it
+# and/or modify it under the terms of the GNU General
+# Public License as published by the Free Software Foundation;
+# either version 2, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+
+INCLUDE(FindPackageHandleStandardArgs)
+
+FIND_PROGRAM(LCOV_EXECUTABLE lcov)
+FIND_PROGRAM(GENHTML_EXECUTABLE genhtml)
+
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(Lcov DEFAULT_MSG LCOV_EXECUTABLE GENHTML_EXECUTABLE)
+
+# only visible in advanced view
+MARK_AS_ADVANCED(LCOV_EXECUTABLE GENHTML_EXECUTABLE)

=== added file 'cmake/Findgcovr.cmake'
--- cmake/Findgcovr.cmake	1970-01-01 00:00:00 +0000
+++ cmake/Findgcovr.cmake	2015-12-23 08:26:29 +0000
@@ -0,0 +1,31 @@
+# - Find gcovr scrip 
+# Will define:
+#
+# GCOVR_EXECUTABLE - the gcovr script
+#
+# Uses:
+#
+# GCOVR_ROOT - root to search for the script
+#
+# Copyright (C) 2011 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
+#
+# This program is free software; you can redistribute it
+# and/or modify it under the terms of the GNU General
+# Public License as published by the Free Software Foundation;
+# either version 2, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+
+INCLUDE(FindPackageHandleStandardArgs)
+
+FIND_PROGRAM(GCOVR_EXECUTABLE gcovr HINTS ${GCOVR_ROOT} "${GCOVR_ROOT}/bin")
+
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(gcovr DEFAULT_MSG GCOVR_EXECUTABLE)
+
+# only visible in advanced view
+MARK_AS_ADVANCED(GCOVR_EXECUTABLE)

=== added file 'cmake/ParseArguments.cmake'
--- cmake/ParseArguments.cmake	1970-01-01 00:00:00 +0000
+++ cmake/ParseArguments.cmake	2015-12-23 08:26:29 +0000
@@ -0,0 +1,52 @@
+# Parse arguments passed to a function into several lists separated by
+# upper-case identifiers and options that do not have an associated list e.g.:
+#
+# SET(arguments
+#   hello OPTION3 world
+#   LIST3 foo bar
+#   OPTION2
+#   LIST1 fuz baz
+#   )
+# PARSE_ARGUMENTS(ARG "LIST1;LIST2;LIST3" "OPTION1;OPTION2;OPTION3" ${arguments})
+#
+# results in 7 distinct variables:
+#  * ARG_DEFAULT_ARGS: hello;world
+#  * ARG_LIST1: fuz;baz
+#  * ARG_LIST2:
+#  * ARG_LIST3: foo;bar
+#  * ARG_OPTION1: FALSE
+#  * ARG_OPTION2: TRUE
+#  * ARG_OPTION3: TRUE
+#
+# taken from http://www.cmake.org/Wiki/CMakeMacroParseArguments 
+
+MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
+    SET(DEFAULT_ARGS)
+    FOREACH(arg_name ${arg_names})    
+        SET(${prefix}_${arg_name})
+    ENDFOREACH(arg_name)
+    FOREACH(option ${option_names})
+        SET(${prefix}_${option} FALSE)
+    ENDFOREACH(option)
+    
+    SET(current_arg_name DEFAULT_ARGS)
+    SET(current_arg_list)
+    FOREACH(arg ${ARGN})            
+        SET(larg_names ${arg_names})    
+        LIST(FIND larg_names "${arg}" is_arg_name)                   
+        IF (is_arg_name GREATER -1)
+            SET(${prefix}_${current_arg_name} ${current_arg_list})
+            SET(current_arg_name ${arg})
+            SET(current_arg_list)
+        ELSE (is_arg_name GREATER -1)
+            SET(loption_names ${option_names})    
+            LIST(FIND loption_names "${arg}" is_option)            
+            IF (is_option GREATER -1)
+                SET(${prefix}_${arg} TRUE)
+            ELSE (is_option GREATER -1)
+                SET(current_arg_list ${current_arg_list} ${arg})
+            ENDIF (is_option GREATER -1)
+        ENDIF (is_arg_name GREATER -1)
+    ENDFOREACH(arg)
+    SET(${prefix}_${current_arg_name} ${current_arg_list})
+ENDMACRO(PARSE_ARGUMENTS)

=== modified file 'src/bindings/CMakeLists.txt'
--- src/bindings/CMakeLists.txt	2015-12-23 08:26:29 +0000
+++ src/bindings/CMakeLists.txt	2015-12-23 08:26:29 +0000
@@ -93,9 +93,9 @@
   COMMAND ${CMAKE_COMMAND} -E make_directory
     "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes/lib"
 
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different
+  COMMAND ${CMAKE_COMMAND} -E create_symlink
     "${CMAKE_CURRENT_BINARY_DIR}/unity_js_scopes_bindings.node"
-    "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes"
+    "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes/unity_js_scopes_bindings.node"
   COMMAND ${CMAKE_COMMAND} -E copy_if_different
     "${CMAKE_CURRENT_SOURCE_DIR}/index.js"
     "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes"

=== modified file 'src/common/CMakeLists.txt'
--- src/common/CMakeLists.txt	2015-11-13 08:28:39 +0000
+++ src/common/CMakeLists.txt	2015-12-23 08:26:29 +0000
@@ -45,7 +45,7 @@
   dl
 )
 
-if(cmake_build_type_tolower STREQUAL "debug")
+if(cmake_build_type_lower MATCHES debug)
   add_custom_command(
     TARGET nodejs-static PRE_LINK
     COMMAND ${CMAKE_SOURCE_DIR}/deps/build-debug.sh

=== modified file 'src/launcher/CMakeLists.txt'
--- src/launcher/CMakeLists.txt	2015-11-13 08:28:39 +0000
+++ src/launcher/CMakeLists.txt	2015-12-23 08:26:29 +0000
@@ -73,9 +73,9 @@
   COMMAND ${CMAKE_COMMAND} -E make_directory
     "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes/bin"
 
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different
+  COMMAND ${CMAKE_COMMAND} -E create_symlink
     "${CMAKE_CURRENT_BINARY_DIR}/unity-js-scopes-launcher"
-    "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes/bin"
+    "${CMAKE_BINARY_DIR}/tests/node_modules/unity-js-scopes/bin/unity-js-scopes-launcher"
 )
 
 install(TARGETS ${LAUNCHER_EXECUTABLE_NAME}