Fix CMake test building

A CMake unit test build was added.

The original tests (examples) were fixed so they can be compiled on
Windows using MSVC2022 and MinGW. The `ccm-test` has been updated so
that it returns the status of test completion. The file `getopt.c` was
borrowed from the libcoap project.

The `CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS` variable must be set before a
`add_libray()` call.

Unimportant compiler warnings were disabled, and other warnings were
fixed.

GitHub Actions are unified and optimized.

Author: raspopov

.github/workflows/main.yml

@@ -17,65 +17,70 @@ env:
 
 jobs:
   build-linux-autotools:
+    name: Build for Linux using Autotools
     runs-on: ubuntu-latest
     strategy:
       matrix:
         CC: ["gcc", "clang" ]
+
     steps:
-      - uses: actions/checkout@v3
-      - name: setup
-        run: |
-          sudo apt-get update && sudo apt-get install -y libcunit1-dev libtool libtool-bin exuberant-ctags valgrind
-          ./autogen.sh
-      - name: configure
-        run: |
-          # mkdir build-${{matrix.CC}}
-          # cd build-${{matrix.CC}}
-          $GITHUB_WORKSPACE/configure --enable-tests
-      - name: compile
-        run: |
-          # cd build-${{matrix.CC}}
-          make EXTRA_CFLAGS=-Werror
-      - name: tests
-        run: |
-          # cd build-${{matrix.CC}}
-          libtool --mode=execute valgrind --track-origins=yes --leak-check=yes --show-reachable=yes --error-exitcode=123 --quiet tests/unit-tests/testdriver
-          libtool --mode=execute valgrind --track-origins=yes --leak-check=yes --show-reachable=yes --error-exitcode=123 --quiet tests/ccm-test
+    - name: checkout
+      uses: actions/checkout@v3
+    - name: setup
+      uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: libcunit1-dev libtool libtool-bin exuberant-ctags valgrind
+        version: 1.0
+    - name: configure
+      run: |
+        # mkdir build-${{matrix.CC}}
+        # cd build-${{matrix.CC}}
+        $GITHUB_WORKSPACE/autogen.sh
+        $GITHUB_WORKSPACE/configure --enable-tests
+    - name: compile
+      run: |
+        # cd build-${{matrix.CC}}
+        make EXTRA_CFLAGS=-Werror
+    - name: tests
+      run: |
+        # cd build-${{matrix.CC}}
+        libtool --mode=execute valgrind --track-origins=yes --leak-check=yes --show-reachable=yes --error-exitcode=123 --quiet tests/unit-tests/testdriver
+        libtool --mode=execute valgrind --track-origins=yes --leak-check=yes --show-reachable=yes --error-exitcode=123 --quiet tests/ccm-test
 
-  build-linux-cmake:
-    name: Build for Linux using CMake
-    runs-on: ubuntu-latest
+  build-cmake:
+    name: Build using CMake
+    runs-on: ${{ matrix.config.os }}
+    strategy:
+      matrix:
+        config:
+        - os: ubuntu-latest
+          vcpkg_triplet: x64-linux-release
+        - os: macos-latest
+          vcpkg_triplet: arm64-osx-release
+        - os: windows-latest
+          vcpkg_triplet: x64-windows-release
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Build tinydtls
+    - name: checkout
+      uses: actions/checkout@v3
+    - name: setup
+      uses: johnwason/vcpkg-action@v7
+      id: vcpkg
+      with:
+        pkgs: cunit
+        triplet: ${{ matrix.config.vcpkg_triplet }}
+        cache-key: ${{ matrix.config.os }}
+        token: ${{ github.token }}
+    - name: configure
       run: |
         cmake -E make_directory build_test
         cd build_test
-        cmake -DWARNING_TO_ERROR=ON -Dmake_tests=ON ..
-        cmake --build .
-  build-macos-cmake:
-    name: Build for macOS using CMake
-    runs-on: macos-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Build tinydtls
+        cmake ${{ steps.vcpkg.outputs.vcpkg-cmake-config }} -G "Unix Makefiles" -DWARNING_TO_ERROR=ON -Dmake_tests=ON ..
+    - name: compile
       run: |
-        cmake -E make_directory build_test
         cd build_test
-        cmake -DWARNING_TO_ERROR=ON -Dmake_tests=ON ..
         cmake --build .
-
-  build-windows:
-    name: Build for Windows using CMake
-    runs-on: windows-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Build tinydtls
+    - name: test
       run: |
-        cmake -E make_directory build_test
         cd build_test
-        cmake -G "Unix Makefiles" -DWARNING_TO_ERROR=ON ..
-        cmake --build .
+        ctest --verbose

.gitignore

@@ -91,3 +91,5 @@ CMakeFiles
 tinydtls.dir
 Debug
 Release
+*.json
+out

AutoConf.cmake

@@ -68,9 +68,10 @@ check_function_exists (strdup         HAVE_STRDUP)
 check_function_exists (strerror       HAVE_STRERROR)
 check_function_exists (strnlen        HAVE_STRNLEN)
 check_function_exists (fls            HAVE_FLS)
+check_function_exists (snprintf       HAVE_SNPRINTF)
 check_function_exists (vprintf        HAVE_VPRINTF)
 check_function_exists (inet_ntop      HAVE_INET_NTOP)
-check_function_exists (random      HAVE_RANDOM)
+check_function_exists (random         HAVE_RANDOM)
 
 if(HAVE_SYS_RANDOM_H)
    # zephyr/ncs 1.9.1 seems to link getrandom but doesn't offer a header

CMakeLists.txt

@@ -19,11 +19,12 @@
 #
 ###############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(tinydtls)
 
 include (AutoConf.cmake)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
 
 if(NOT ZEPHYR_BASE)
    option(BUILD_SHARED_LIBS "Link using shared libs" OFF)
@@ -52,6 +53,10 @@ endif()
 
 option(WARNING_TO_ERROR "force all compiler warnings to be errors" OFF)
 
+if(MSVC)
+    option(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS "Export all symbols when compiling to a .dll" ON)
+endif()
+
 configure_file(dtls_config.h.cmake.in dtls_config.h )
 
 add_library(tinydtls)
@@ -73,14 +78,13 @@ target_sources(tinydtls PRIVATE
    ecc/ecc.c)
 
 target_include_directories(tinydtls PUBLIC ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR})
-target_compile_definitions(tinydtls PUBLIC DTLSv12 WITH_SHA256 SHA2_USE_INTTYPES_H DTLS_CHECK_CONTENTTYPE)
+target_compile_definitions(tinydtls PUBLIC DTLSv12 WITH_SHA256 SHA2_USE_INTTYPES_H DTLS_CHECK_CONTENTTYPE $<$<BOOL:${make_tests}>:TEST_INCLUDE>)
 
 if(MSVC)
-    option(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS "Export all symbols when compiling to a .dll" ON)
-    target_compile_options(tinydtls PRIVATE -Wall)
+    target_compile_options(tinydtls PRIVATE -Wall -wd4200 -wd4710 -wd4711 -wd4668 -wd4820 -wd5045 -D_CRT_SECURE_NO_WARNINGS)
     if(${WARNING_TO_ERROR})
         target_compile_options(tinydtls PRIVATE -WX)
-     endif()
+    endif()
 elseif(NOT ZEPHYR_BASE)
     target_compile_options(tinydtls PRIVATE -fPIC -pedantic -std=c99 -Wall -Wextra -Wformat-security -Winline -Wmissing-declarations -Wmissing-prototypes -Wnested-externs -Wpointer-arith -Wshadow -Wstrict-prototypes -Wswitch-default -Wswitch-enum -Wunused)
     if(${WARNING_TO_ERROR})
@@ -92,6 +96,10 @@ set_target_properties(tinydtls PROPERTIES VERSION ${PACKAGE_VERSION} SOVERSION $
 
 if( ${make_tests} )
     add_subdirectory(tests)
+    add_subdirectory(tests/unit-tests)
+    include(CTest)
+    add_test(NAME test COMMAND testdriver)
+    add_test(NAME ccm-test COMMAND ccm-test)
 endif()
 
 if(BUILD_SHARED_LIBS)

cmake/FindCUnit.cmake

@@ -0,0 +1,94 @@
+# FindCUnit
+# ---------
+#
+# Find the CUnit library.
+#
+# Imported Targets
+# ^^^^^^^^^^^^^^^^
+#
+# This module defines the following :prop_tgt:`IMPORTED` targets:
+#
+# ``CUnit::cunit``
+#   The CUnit library, if found.
+#
+# Result Variables
+# ^^^^^^^^^^^^^^^^
+#
+# This module will set the following variables in your project:
+#
+# ``CUnit_FOUND``
+#   System has the CUnit library.
+# ``CUnit_VERSION``
+#   The version of CUnit found.
+# ``CUnit_INCLUDE_DIR``
+#   The CUnit include directory.
+# ``CUnit_LIBRARIES``
+#   All CUnit libraries.
+#
+# Hints
+# ^^^^^
+#
+# Set ``CUnit_ROOT_DIR`` to the root directory of a CUnit installation.
+
+if(CUnit_INCLUDE_DIR AND CUnit_LIBRARIES)
+  # in cache already
+  set(CUnit_FIND_QUIETLY TRUE)
+endif()
+
+if(CUnit_ROOT_DIR)
+  set(_CUnit_EXTRA_FIND_ARGS "NO_CMAKE_FIND_ROOT_PATH")
+endif()
+
+find_path(
+  CUnit_INCLUDE_DIR
+  NAMES CUnit/CUnit.h
+  PATH_SUFFIXES include
+  HINTS ${PROJECT_SOURCE_DIR}
+        ${CMAKE_CURRENT_BINARY_DIR}
+        ${CUnit_ROOT_DIR}
+        ${_CUnit_EXTRA_FIND_ARGS})
+
+find_library(
+  CUnit_LIBRARIES
+  NAMES cunit
+  PATH_SUFFIXES lib
+  HINTS ${PROJECT_SOURCE_DIR}
+        ${CMAKE_CURRENT_BINARY_DIR}
+        ${CUnit_ROOT_DIR}
+        ${_CUnit_EXTRA_FIND_ARGS})
+
+if(CUnit_INCLUDE_DIR AND EXISTS "${CUnit_INCLUDE_DIR}/CUnit/CUnit.h")
+  file(STRINGS "${CUnit_INCLUDE_DIR}/CUnit/CUnit.h" CUnit_VERSION_STR
+    REGEX "#[\t ]*define[\t ]+CU_VERSION[\t ]+\"[^\"]+\"")
+  string(REGEX REPLACE "^.*CU_VERSION[\t ]+\"([^\"]+)\""
+    "\\1" CUnit_VERSION_STR "${CUnit_VERSION_STR}")
+  set(CUnit_VERSION "${CUnit_VERSION_STR}")
+  unset(CUnit_VERSION_STR)
+endif()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(
+  CUnit
+  FAIL_MESSAGE "Could NOT find CUnit, try to set the path to CUnit root folder in the system variable CUnit_ROOT_DIR"
+  REQUIRED_VARS CUnit_INCLUDE_DIR
+                CUnit_LIBRARIES
+  VERSION_VAR CUnit_VERSION)
+
+if(NOT
+   TARGET
+   CUnit::cunit)
+  add_library(
+    CUnit::cunit
+    UNKNOWN
+    IMPORTED)
+  set_target_properties(
+    CUnit::cunit
+    PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${CUnit_INCLUDE_DIR}"
+               VERSION "${CUnit_VERSION}"
+               IMPORTED_LINK_INTERFACE_LANGUAGES "C"
+               IMPORTED_LOCATION "${CUnit_LIBRARIES}")
+endif()
+
+mark_as_advanced(
+  CUnit_INCLUDE_DIR
+  CUnit_LIBRARIES)

dtls.c

@@ -1678,7 +1678,7 @@ dtls_prepare_record(dtls_peer_t *peer, dtls_security_parameters_t *security,
   unsigned int i;
 
   if (*rlen < DTLS_RH_LENGTH) {
-    dtls_alert("The sendbuf (%zu bytes) is too small\n", *rlen);
+    dtls_alert("The sendbuf (%u bytes) is too small\n", (unsigned)*rlen);
     return dtls_alert_fatal_create(DTLS_ALERT_INTERNAL_ERROR);
   }
 
@@ -3437,8 +3437,8 @@ check_server_certificate(dtls_context_t *ctx,
   data += DTLS_HS_LENGTH;
 
   if (dtls_uint24_to_int(data) != DTLS_EC_SUBJECTPUBLICKEY_SIZE) {
-    dtls_alert("expect length of %zu bytes for certificate\n",
-	       DTLS_EC_SUBJECTPUBLICKEY_SIZE);
+    dtls_alert("expect length of %u bytes for certificate\n",
+	       (unsigned)DTLS_EC_SUBJECTPUBLICKEY_SIZE);
     return dtls_alert_fatal_create(DTLS_ALERT_DECODE_ERROR);
   }
   data += sizeof(uint24);

dtls_debug.c

@@ -247,7 +247,7 @@ dsrv_print_addr(const session_t *addr, char *buf, size_t len) {
 #endif /* ! HAVE_INET_NTOP */
 }
 
-#if !defined(WITH_CONTIKI) && !defined(_MSC_VER)
+#if !defined(WITH_CONTIKI)
 
 static void
 dtls_logging_handler(log_t level, const char *message) {
@@ -410,7 +410,7 @@ dtls_dsrv_hexdump_log(log_t level, const char *name, const unsigned char *buf, s
   dtls_mutex_lock(&static_mutex);
 #endif /* DTLS_CONSTRAINED_STACK */
   if (extend) {
-    snprintf(message, sizeof(message), "%s: (%zu bytes):\n", name, length);
+    snprintf(message, sizeof(message), "%s: (%u bytes):\n", name, (unsigned)length);
     log_handler(level, message);
     len = 0;
     while (length-- && len + 1 < sizeof(message)) {
@@ -439,7 +439,7 @@ dtls_dsrv_hexdump_log(log_t level, const char *name, const unsigned char *buf, s
       }
     }
   } else {
-    len = snprintf(message, sizeof(message), "%s: (%zu bytes): ", name, length);
+    len = snprintf(message, sizeof(message), "%s: (%u bytes): ", name, (unsigned)length);
     while (length-- && len + 1 < sizeof(message)) {
       len += snprintf(&message[len], sizeof(message)-len, "%02X", *buf++);
     }
@@ -474,7 +474,7 @@ dtls_dsrv_hexdump_log(log_t level, const char *name, const unsigned char *buf, s
     PRINTF("%s ", loglevels[level]);
 
   if (extend) {
-    PRINTF("%s: (%zu bytes):\n", name, length);
+    PRINTF("%s: (%u bytes):\n", name, (unsigned)length);
 
     while (length--) {
       if (n % 16 == 0)
@@ -491,7 +491,7 @@ dtls_dsrv_hexdump_log(log_t level, const char *name, const unsigned char *buf, s
       }
     }
   } else {
-    PRINTF("%s: (%zu bytes): ", name, length);
+    PRINTF("%s: (%u bytes): ", name, (unsigned)length);
     while (length--)
       PRINTF("%02X", *buf++);
   }

dtls_debug.h

@@ -100,13 +100,13 @@ void dtls_set_log_handler(dtls_log_handler_t app_handler);
  * Writes the given text to \c stdout. The text is output only when \p
  * level is below or equal to the log level that set by
  * set_log_level(). */
-#ifdef HAVE_VPRINTF
+#if !defined(WITH_CONTIKI)
 #if (defined(__GNUC__) && !defined(__MINGW32__))
 void dsrv_log(log_t level, const char *format, ...) __attribute__ ((format(printf, 2, 3)));
 #else /* !__GNUC__ && !__MINGW32__ */
 void dsrv_log(log_t level, const char *format, ...);
 #endif /* !__GNUC__ && !__MINGW32__ */
-#else
+#elif defined(HAVE_VPRINTF)
 #define dsrv_log(level, format, ...) PRINTF(format, ##__VA_ARGS__)
 #endif
 
@@ -129,8 +129,8 @@ void dtls_dsrv_log_addr(log_t level, const char *name, const session_t *addr);
 #define dtls_notice(...) LOG_INF(__VA_ARGS__)
 #define dtls_info(...) LOG_INF(__VA_ARGS__)
 #define dtls_debug(...) LOG_DBG(__VA_ARGS__)
-#define dtls_debug_hexdump(name, buf, length) { LOG_DBG("%s (%zu bytes):", name, (size_t)(length)); LOG_HEXDUMP_DBG(buf, length, name); }
-#define dtls_debug_dump(name, buf, length) { LOG_DBG("%s (%zu bytes):", name, (size_t)(length)); LOG_HEXDUMP_DBG(buf, length, name); }
+#define dtls_debug_hexdump(name, buf, length) { LOG_DBG("%s (%u bytes):", name, (unsigned)(length)); LOG_HEXDUMP_DBG(buf, length, name); }
+#define dtls_debug_dump(name, buf, length) { LOG_DBG("%s (%u bytes):", name, (unsigned)(length)); LOG_HEXDUMP_DBG(buf, length, name); }
 #elif defined(RIOT_VERSION)
 #define dtls_emerg(...) LOG_ERROR(__VA_ARGS__)
 #define dtls_alert(...) LOG_ERROR(__VA_ARGS__)
@@ -139,8 +139,8 @@ void dtls_dsrv_log_addr(log_t level, const char *name, const session_t *addr);
 #define dtls_notice(...) LOG_INFO(__VA_ARGS__)
 #define dtls_info(...) LOG_INFO(__VA_ARGS__)
 #define dtls_debug(...) LOG_DEBUG(__VA_ARGS__)
-#define dtls_debug_hexdump(name, buf, length) { if (LOG_DEBUG <= LOG_LEVEL) { LOG_DEBUG("-= %s (%zu bytes) =-\n", name, (size_t)(length)); od_hex_dump(buf, length, 0); }}
-#define dtls_debug_dump(name, buf, length) { if (LOG_DEBUG <= LOG_LEVEL) { LOG_DEBUG("%s (%zu bytes):", name, (size_t)(length)); od_hex_dump(buf, length, 0); }}
+#define dtls_debug_hexdump(name, buf, length) { if (LOG_DEBUG <= LOG_LEVEL) { LOG_DEBUG("-= %s (%u bytes) =-\n", name, (unsigned)(length)); od_hex_dump(buf, length, 0); }}
+#define dtls_debug_dump(name, buf, length) { if (LOG_DEBUG <= LOG_LEVEL) { LOG_DEBUG("%s (%u bytes):", name, (unsigned)(length)); od_hex_dump(buf, length, 0); }}
 #else /* neither RIOT nor Zephyr */
 #define dtls_emerg(...) dsrv_log(DTLS_LOG_EMERG, __VA_ARGS__)
 #define dtls_alert(...) dsrv_log(DTLS_LOG_ALERT, __VA_ARGS__)