[c89stringutils/reports] Generate code coverage ; [c89stringutils/tests] Move around codebase so tests are in a best-practice place (and works properly with CTest)

Author: SamuelMarks

CMakeLists.txt

@@ -20,16 +20,19 @@ elseif ((MSVC_VERSION STRLESS_EQUAL "1900"
             "${CMAKE_BINARY_DIR}/c89stringutils_export.h")
 endif ()
 if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.15")
-    # add compiler warning flags just when building this project via
-    # the BUILD_INTERFACE genex
     set(gcc_like "$<COMPILE_LANG_AND_ID:C,CXX,ARMClang,AppleClang,Clang,GNU,LCC>")
     set(msvc "$<COMPILE_LANG_AND_ID:C,CXX,MSVC>")
     target_compile_options(
             "${PROJECT_NAME}_compiler_flags"
             INTERFACE
-            "$<${gcc_like}:$<BUILD_INTERFACE:-Wshadow;-Wformat=2;-Wall;-pedantic>>"
+            "$<$<AND:${gcc_like},$<CONFIG:Debug>>:$<BUILD_INTERFACE:-Wshadow;-Wformat=2;-Wall;-Wno-missing-braces;-Wno-long-long;-pedantic;-fprofile-arcs;-ftest-coverage>>"
             "$<${msvc}:$<BUILD_INTERFACE:-W3;-WX;-Zi;-permissive->>"
     )
+    target_link_options(
+            "${PROJECT_NAME}_compiler_flags"
+            INTERFACE
+            "$<$<AND:${gcc_like},$<CONFIG:Debug>>:$<BUILD_INTERFACE:--coverage>>"
+    )
 endif (CMAKE_VERSION VERSION_GREATER_EQUAL "3.15")
 # Set the build directories
 if (CMAKE_SYSTEM_NAME STREQUAL "Windows"
@@ -53,9 +56,11 @@ configure_file(
 add_subdirectory("${PROJECT_NAME}")
 
 include(CTest)
-if (BUILD_TESTING)
-    add_subdirectory("${PROJECT_NAME}_tests")
-endif (BUILD_TESTING)
+option(BUILD_TESTING "Build the tests" ON)
+option(C89STRINGUTILS_BUILD_TESTING "Build the tests" ON)
+if (BUILD_TESTING AND C89STRINGUTILS_BUILD_TESTING)
+    add_subdirectory("${PROJECT_NAME}/tests")
+endif (BUILD_TESTING AND C89STRINGUTILS_BUILD_TESTING)
 
 ###########
 # Install #

README.md

@@ -3,6 +3,7 @@ c89stringutils
 [![License](https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![CI for Linux, Windows, macOS](https://github.com/offscale/c89stringutils/actions/workflows/linux-Windows-macOS-sunOS.yml/badge.svg)](https://github.com/offscale/c89stringutils/actions/workflows/github-actions.yml)
 [![CI for FreeBSD](https://api.cirrus-ci.com/github/offscale/c89stringutils.svg)](https://cirrus-ci.com/github/offscale/c89stringutils)
+![coverage](reports/test_coverage.svg)
 [![C89](https://img.shields.io/badge/C-89-blue)](https://en.wikipedia.org/wiki/C89_(C_version))
 
 C89 is missing some nice things. As is MSVC.

c89stringutils/CMakeLists.txt

@@ -55,3 +55,4 @@ install(EXPORT "${LIBRARY_NAME}Targets" DESTINATION "${CMAKE_INSTALL_DATADIR}/${
 
 install(FILES ${Header_Files} "${_export_file}"
         DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
+

c89stringutils/c89stringutils_string_extras.h

@@ -94,12 +94,12 @@ typedef int errno_t;
 #define HAVE_STRNCASECMP_H
 #endif
 
-#if !defined(HAVE_ASPRINTF) && (defined(ANY_BSD) || \
-    defined(__APPLE__) && defined(__MACH__) ||  \
-    defined(_GNU_SOURCE) || defined(_BSD_SOURCE))
+#if !defined(HAVE_ASPRINTF) &&                                                 \
+    (defined(ANY_BSD) || defined(__APPLE__) && defined(__MACH__) ||            \
+     defined(_GNU_SOURCE) || defined(_BSD_SOURCE))
 #define HAVE_ASPRINTF
-#endif /* !defined(HAVE_ASPRINTF) && (defined(ANY_BSD) || \
-          defined(__APPLE__) && defined(__MACH__) ||  \
+#endif /* !defined(HAVE_ASPRINTF) && (defined(ANY_BSD) ||                      \
+          defined(__APPLE__) && defined(__MACH__) ||                           \
           defined(_GNU_SOURCE) || defined(_BSD_SOURCE)) */
 
 #ifdef HAVE_STRINGS_H

…tests/test_c89stringutils/CMakeLists.txt c89stringutils/tests/CMakeLists.txtc89stringutils_tests/test_c89stringutils/CMakeLists.txt renamed to c89stringutils/tests/CMakeLists.txt c89stringutils_tests/test_c89stringutils/CMakeLists.txt renamed to c89stringutils/tests/CMakeLists.txt

@@ -1,5 +1,5 @@
 get_filename_component(EXEC_NAME "${CMAKE_CURRENT_SOURCE_DIR}" NAME)
-string(REPLACE " " "_" EXEC_NAME "${EXEC_NAME}")
+set(EXEC_NAME "${PROJECT_NAME}_${EXEC_NAME}")
 
 #########################
 # Dependencies download #
@@ -31,9 +31,9 @@ source_group("Source Files" FILES "${Source_Files}")
 
 add_executable("${EXEC_NAME}" "${Header_Files}" "${Source_Files}")
 
-target_link_libraries("${EXEC_NAME}" PRIVATE "c89stringutils")
+target_link_libraries("${EXEC_NAME}" PRIVATE "${PROJECT_NAME}")
 if (NOT CMAKE_C_COMPILER_ID STREQUAL "OpenWatcom")
-    target_link_libraries("${EXEC_NAME}" PRIVATE "c89stringutils_compiler_flags")
+    target_link_libraries("${EXEC_NAME}" PRIVATE "${PROJECT_NAME}_compiler_flags")
 endif (NOT CMAKE_C_COMPILER_ID STREQUAL "OpenWatcom")
 target_include_directories(
         "${EXEC_NAME}"

…ngutils_tests/test_c89stringutils/test.c c89stringutils/tests/test.cc89stringutils_tests/test_c89stringutils/test.c renamed to c89stringutils/tests/test.c c89stringutils_tests/test_c89stringutils/test.c renamed to c89stringutils/tests/test.c

@@ -1,6 +1,6 @@
 #include <greatest.h>
 
-#define C89STRINGUTILS_IMPLEMENTATION
+// #define C89STRINGUTILS_IMPLEMENTATION
 #include <c89stringutils_string_extras.h>
 
 static const char *buffer = "hello world";

…test_c89stringutils/test_string_extras.h c89stringutils/tests/test_string_extras.hc89stringutils_tests/test_c89stringutils/test_string_extras.h renamed to c89stringutils/tests/test_string_extras.h c89stringutils_tests/test_c89stringutils/test_string_extras.h renamed to c89stringutils/tests/test_string_extras.h

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# shellcheck disable=SC2236
+if [ ! -z "${BASH_VERSION+x}" ]; then
+  # shellcheck disable=SC3028 disable=SC3054
+  this_file="${BASH_SOURCE[0]}"
+  # shellcheck disable=SC3040
+  set -o pipefail
+elif [ ! -z "${ZSH_VERSION+x}" ]; then
+  # shellcheck disable=SC2296
+  this_file="${(%):-%x}"
+  # shellcheck disable=SC3040
+  set -o pipefail
+else
+  this_file="${0}"
+fi
+ROOT="$( cd "$( dirname -- "${this_file}" )" && pwd )"
+
+# TODO: .pre-commit-config.yaml instead of this
+
+COVERAGE="$(cd "${ROOT}"'/cmake-build-debug' && ctest -C 'Debug' -T 'Coverage' 2>/dev/null | awk 'END {print $NF}')"
+printf '<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: %s"><title>coverage: %s</title><linearGradient id="s" x2="0" y2="%s"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#97ca00"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">%s</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">%s</text></g></svg>' "${COVERAGE}" "${COVERAGE}" "${COVERAGE}" "${COVERAGE}" "${COVERAGE}" > "${ROOT}"'/reports/test_coverage.svg'