Add CLang to CI unit tests (#119)

* init clang ci

* update build & ci

* update jobs

* Making valgrind build optional

* more cleanup

---------

Co-authored-by: Brian Sipos <brian.sipos@jhuapl.edu>

Author: jeronstone

.github/workflows/build-test.yaml

@@ -35,7 +35,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-24.04', 'centos-9']
-        compiler: ['gcc']
+        compiler: ['gcc', 'clang']
     name: Unit Test (${{matrix.os}} ${{matrix.compiler}})
     runs-on: ${{ matrix.os == 'centos-9' && 'ubuntu-24.04' || matrix.os }}
     container: ${{ matrix.os == 'centos-9' && 'quay.io/centos/centos:stream9' || null }}
@@ -70,7 +70,7 @@ jobs:
               ruby pkg-config ccache patch \
               ${{matrix.compiler=='clang' && 'clang llvm' || 'gcc gcc-c++'}} \
               openssl-devel jansson-devel \
-              valgrind xmlstarlet \
+              valgrind valgrind-devel xmlstarlet \
               python3 python3-pip python3-wheel
           pip3 install gcovr
       - name: Checkout repository
@@ -145,7 +145,7 @@ jobs:
               cmake ninja-build \
               ruby pkg-config gcc gcc-c++ ccache patch \
               openssl-devel jansson-devel \
-              valgrind xmlstarlet \
+              valgrind valgrind-devel xmlstarlet \
               python3 python3-pip python3-wheel
           pip3 install gcovr
       - name: Checkout repository

.github/workflows/fuzzing.yaml

@@ -56,7 +56,7 @@ jobs:
               ruby pkg-config ccache patch \
               ${{matrix.compiler=='clang' && 'clang llvm' || 'gcc g++'}} \
               libssl-dev libjansson-dev \
-              valgrind gcovr xmlstarlet
+              gcovr xmlstarlet
           sudo gem install cbor-diag
       - name: Set up OS
         if: startsWith(matrix.os, 'centos')
@@ -69,7 +69,7 @@ jobs:
               ruby pkg-config ccache patch \
               ${{matrix.compiler=='clang' && 'clang llvm' || 'gcc gcc-c++'}} \
               openssl-devel jansson-devel \
-              valgrind xmlstarlet python3-pip
+              xmlstarlet python3-pip
           pip3 install gcovr
           gem install cbor-diag
       - name: Checkout repository

CMakeLists.txt

@@ -116,7 +116,7 @@ if(BUILD_LIB)
     find_package(QCBOR REQUIRED)
     find_package(OpenSSL REQUIRED)
     find_package(Threads REQUIRED)
-    find_package(jansson REQUIRED)
+    find_package(Jansson REQUIRED)
 endif(BUILD_LIB)
 
 include(CheckSymbolExists)
@@ -130,7 +130,9 @@ check_type_size("size_t" SIZE_SIZET LANGUAGE C)
 
 if(BUILD_UNITTEST)
   if(TEST_MEMCHECK)
-    find_program(MEMCHECK_CMD valgrind)
+    find_package(valgrind REQUIRED)
+
+    find_program(MEMCHECK_CMD valgrind REQUIRED)
     message(STATUS "Using valgrind memcheck for tests: ${MEMCHECK_CMD}")
     set(MEMCHECK_OPTIONS
       "--tool=memcheck"

cmake/Findjansson.cmake cmake/FindJansson.cmakecmake/Findjansson.cmake renamed to cmake/FindJansson.cmake

@@ -1,3 +1,6 @@
+# Imports targets for using Jansson libraries:
+#  Jansson::Jansson
+#
 
 # Try pkg-config first
 pkg_search_module(JANSSON jansson IMPORTED_TARGET)

cmake/Findvalgrind.cmake

@@ -0,0 +1,7 @@
+# Imports targets for using valgrind libraries:
+#  valgrind::valgrind
+#
+pkg_search_module(VALGRIND valgrind IMPORTED_TARGET)
+if(VALGRIND_FOUND)
+    add_library(valgrind::valgrind ALIAS PkgConfig::VALGRIND)
+endif(VALGRIND_FOUND)

src/CMakeLists.txt

@@ -68,6 +68,9 @@ set_target_properties(bsl_crypto
 target_link_libraries(bsl_crypto PUBLIC bsl_front)
 target_link_libraries(bsl_crypto PUBLIC MLIB::mlib)
 target_link_libraries(bsl_crypto INTERFACE OpenSSL::Crypto)
+if(TARGET valgrind::valgrind)
+  target_compile_definitions(bsl_crypto PRIVATE HAVE_VALGRIND)
+endif(TARGET valgrind::valgrind)
 
 # Default Security Context library
 set(BSL_DEFAULT_SC_H

src/crypto/CryptoInterface.c

@@ -31,6 +31,10 @@
 #include <openssl/err.h>
 #include <openssl/rand.h>
 
+#if defined(HAVE_VALGRIND)
+#include <valgrind/memcheck.h>
+#endif /* defined(HAVE_VALGRIND) */
+
 /**
  * Struct to hold private key information
  */
@@ -545,6 +549,9 @@ int BSL_Cipher_GetTag(BSL_Cipher_t *cipher_ctx, void **tag)
 {
     int res = EVP_CIPHER_CTX_ctrl(cipher_ctx->libhandle, EVP_CTRL_GCM_GET_TAG, BSL_CRYPTO_AESGCM_AUTH_TAG_LEN, *tag);
     CHK_PROPERTY(res == 1);
+#if defined(HAVE_VALGRIND)
+    VALGRIND_MAKE_MEM_DEFINED(*tag, BSL_CRYPTO_AESGCM_AUTH_TAG_LEN);
+#endif /* defined(HAVE_VALGRIND) */
     return 0;
 }