From: "flichtenheld (Code Review)" Date: Thu, 8 Jan 2026 12:41:15 +0000 References: Reply-To: frank@...2641..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net Message-ID: <846fe7e5c60222a3b32edb12ce93a066644a50a2-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="uzbjdhlrqaA="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[release/2.6]: tests/unit_tests: Port to cmocka 2.0.0 API List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos Cc: openvpn-devel --uzbjdhlrqaA= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: cron2, plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/1462?usp=3Demail to review the following change. Change subject: tests/unit_tests: Port to cmocka 2.0.0 API ...................................................................... tests/unit_tests: Port to cmocka 2.0.0 API But add compat layer so that we can still build against older versions of cmocka. Mostly this is trivial but the custom check function changed its prototype, so that requires some more work. This backport commit additionally includes the fix for test_tls_crypt from commit 6246f2113f6e1fda13bca8de863dd5cc396ab6ef since the other test fixes from the original commit are not relevant to release/2.6. Change-Id: Ifb6594700db71d219643a29c581099c778bcbbc6 Signed-off-by: Frank Lichtenheld Acked-by: Gert Doering Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1449 Message-Id: <20251218104042.5961-1-gert@...1296...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg35= 144.html Signed-off-by: Gert Doering (cherry picked from commit 6db186e0b1d9783ea96e8a945a47fd23b45e4778) --- M CMakeLists.txt M config.h.cmake.in M configure.ac M tests/unit_tests/openvpn/test_common.h M tests/unit_tests/openvpn/test_tls_crypt.c 5 files changed, 49 insertions(+), 12 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/62/1462/1 diff --git a/CMakeLists.txt b/CMakeLists.txt index f7cb5a7..6983d111 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -291,6 +291,18 @@ ) set(HAVE_CONFIG_VERSION_H YES) +if (BUILD_TESTING) + find_package(cmocka CONFIG) + if (TARGET cmocka::cmocka) + set(CMOCKA_LIBRARIES cmocka::cmocka) + else () + pkg_search_module(cmocka cmocka REQUIRED IMPORTED_TARGET) + set(CMOCKA_LIBRARIES PkgConfig::cmocka) + endif () + set(CMAKE_REQUIRED_LIBRARIES ${CMOCKA_LIBRARIES}) + check_include_files(cmocka_version.h HAVE_CMOCKA_VERSION_H) +endif () + configure_file(config.h.cmake.in config.h) configure_file(include/openvpn-plugin.h.in openvpn-plugin.h) # TODO we should remove the need for this, and always include config.h @@ -541,14 +553,6 @@ if (BUILD_TESTING) - find_package(cmocka CONFIG) - if (TARGET cmocka::cmocka) - set(CMOCKA_LIBRARIES cmocka::cmocka) - else () - pkg_search_module(cmocka cmocka REQUIRED IMPORTED_TARGET) - set(CMOCKA_LIBRARIES PkgConfig::cmocka) - endif () - set(unit_tests "test_auth_token" "test_buffer" diff --git a/config.h.cmake.in b/config.h.cmake.in index cedc5be..bf60d39 100644 --- a/config.h.cmake.in +++ b/config.h.cmake.in @@ -86,6 +86,9 @@ /* git version information in config-version.h */ #cmakedefine HAVE_CONFIG_VERSION_H +/* cmocka version information available in cmocka_version.h (>=3D 2.0.0) */ +#cmakedefine HAVE_CMOCKA_VERSION_H + /* Define to 1 if you have the `daemon' function. */ #cmakedefine HAVE_DAEMON diff --git a/configure.ac b/configure.ac index e77fd47..fb8d530 100644 --- a/configure.ac +++ b/configure.ac @@ -1525,7 +1525,16 @@ [have_cmocka=3D"yes"], [AC_MSG_WARN([cmocka.pc not found on the system using pkg-config ${pkg_co= nfig_found}. Unit tests disabled])] ) -AM_CONDITIONAL([ENABLE_UNITTESTS], [test "${enable_unit_tests}" =3D "yes" = -a "${have_cmocka}" =3D "yes" ]) +AM_CONDITIONAL([ENABLE_UNITTESTS], [false]) +if test "${enable_unit_tests}" =3D "yes" -a "${have_cmocka}" =3D "yes"; th= en + AM_CONDITIONAL([ENABLE_UNITTESTS], [true]) + + saved_CFLAGS=3D"${CFLAGS}" + CFLAGS=3D"${CFLAGS} ${CMOCKA_CFLAGS}" + # detect cmocka < 2.0.0 that had no cmocka_version.h + AC_CHECK_HEADERS([cmocka_version.h]) + CFLAGS=3D"${saved_CFLAGS}" +fi AC_SUBST([ENABLE_UNITTESTS]) TEST_LDFLAGS=3D"${OPTIONAL_CRYPTO_LIBS} ${OPTIONAL_PKCS11_HELPER_LIBS}" diff --git a/tests/unit_tests/openvpn/test_common.h b/tests/unit_tests/open= vpn/test_common.h index 50e16d6..e5e4420 100644 --- a/tests/unit_tests/openvpn/test_common.h +++ b/tests/unit_tests/openvpn/test_common.h @@ -25,6 +25,27 @@ #include #include +/* Do we use cmocka < 2.0.0? */ +#ifndef HAVE_CMOCKA_VERSION_H +#define HAVE_OLD_CMOCKA_API 1 +/* compat with various versions of cmocka.h + * Older versions have LargestIntegralType. Newer + * versions use uintmax_t. But LargestIntegralType + * is not guaranteed to be equal to uintmax_t, so + * we can't use that unconditionally. So we only use + * it if cmocka.h does not define LargestIntegralType. + */ +#ifndef LargestIntegralType +#define LargestIntegralType uintmax_t +#endif +/* redefine 2.x API in terms of 1.x API */ +#define CMockaValueData LargestIntegralType +#define check_expected_uint check_expected +#define expect_uint_value expect_value +#define expect_check_data expect_check +#define cast_ptr_to_cmocka_value(x) (x) +#endif + /** * Sets up the environment for unit tests like making both stderr and stdo= ut * non-buffered to avoid messages getting lost if the program exits early. diff --git a/tests/unit_tests/openvpn/test_tls_crypt.c b/tests/unit_tests/o= penvpn/test_tls_crypt.c index 5eb864e..bf5a8ce 100644 --- a/tests/unit_tests/openvpn/test_tls_crypt.c +++ b/tests/unit_tests/openvpn/test_tls_crypt.c @@ -112,8 +112,8 @@ __wrap_buffer_write_file(const char *filename, const struct buffer *buf) { const char *pem =3D BSTR(buf); - check_expected(filename); - check_expected(pem); + check_expected_ptr(filename); + check_expected_ptr(pem); return mock_type(bool); } @@ -121,7 +121,7 @@ struct buffer __wrap_buffer_read_from_file(const char *filename, struct gc_arena *gc) { - check_expected(filename); + check_expected_ptr(filename); const char *pem_str =3D mock_ptr_type(const char *); struct buffer ret =3D alloc_buf_gc(strlen(pem_str) + 1, gc); -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1462?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings?usp=3Demail Gerrit-MessageType: newchange Gerrit-Project: openvpn Gerrit-Branch: release/2.6 Gerrit-Change-Id: Ifb6594700db71d219643a29c581099c778bcbbc6 Gerrit-Change-Number: 1462 Gerrit-PatchSet: 1 Gerrit-Owner: flichtenheld Gerrit-Reviewer: cron2 Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: cron2 --uzbjdhlrqaA= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is cur= rently required from: cron2, plaisthos.

flichtenheld would like plaisthos to review this change.

V= iew Change

tests/unit_tests: Port to cmocka 2.0.0 API<=
br>
But add compat layer so that we can still build
against older ver= sions of cmocka. Mostly this is
trivial but the custom check function ch= anged its
prototype, so that requires some more work.

This backpo= rt commit additionally includes the fix
for test_tls_crypt from commit6246f2113f6e1fda13bca8de863dd5cc396ab6ef since the
other test fixes fr= om the original commit are not
relevant to release/2.6.

Change-Id= : Ifb6594700db71d219643a29c581099c778bcbbc6
Signed-off-by: Frank Lichten= held <frank@...2641...>
Acked-by: Gert Doering <gert@...1296...= >
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1449
Message-= Id: <20251218104042.5961-1-gert@...1296...>
URL: https://www.mail-= archive.com/openvpn-devel@lists.sourceforge.net/msg35144.html
Signed-off= -by: Gert Doering <gert@...1296...>
(cherry picked from commit 6db= 186e0b1d9783ea96e8a945a47fd23b45e4778)
---
M CMakeLists.txt
M conf= ig.h.cmake.in
M configure.ac
M tests/unit_tests/openvpn/test_common.h=
M tests/unit_tests/openvpn/test_tls_crypt.c
5 files changed, 49 inse= rtions(+), 12 deletions(-)

git pull ssh://gerrit=
.openvpn.net:29418/openvpn refs/changes/62/1462/1
diff --git a/CMak=
eLists.txt b/CMakeLists.txt
index f7cb5a7..6983d111 100644<= /span>
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -291,6 +291,18 @@
)
= set(HAVE_CONFIG_VERSION_H YES)

+if (BUILD_TESTING)
+ find_package(cmocka CONFIG)
+ if (TARGET cmocka::cmocka)
+ set(CMOCKA_LIBR= ARIES cmocka::cmocka)
+ else ()
+ = pkg_search_module(cmocka cmocka REQUIRED IMPORTED_TARGET)
+ set(CMOCKA_LIBRARIES PkgCon= fig::cmocka)

+ end= if ()
+ set(CMAKE_= REQUIRED_LIBRARIES ${CMOCKA_LIBRARIES})
+ check_include_files(cmocka_version.h HAVE_CMOCKA_VE= RSION_H)
+endif ()
+
conf= igure_file(config.h.cmake.in config.h)
configure_file(incl= ude/openvpn-plugin.h.in openvpn-plugin.h)
# TODO we should= remove the need for this, and always include config.h
@@ -= 541,14 +553,6 @@


if (B= UILD_TESTING)
- find= _package(cmocka CONFIG)
- if (TARGET cmocka::cmocka)
- set(CMOCKA_LIBRARIES cmocka::cmocka)
- else ()
- pkg_search_module(cmocka cmocka REQUIRED IM= PORTED_TARGET)
- = set(CMOCKA_LIBRARIES PkgConfig::cmocka)
- endif ()
-
set(unit_tests
&qu= ot;test_auth_token"
"test_buffer"
diff --git a/config.h.cmake.in b/config.h.cmake.inindex cedc5be..bf60d39 100644
--- a/config.h.cmake.i= n
+++ b/config.h.cmake.in
@@ -86,6 +86,9 @@=
/* git version information in config-version.h */<= br> #cmakedefine HAVE_CONFIG_VERSION_H

+/* cmocka version information av= ailable in cmocka_version.h (>=3D 2.0.0) */

+#cmakedefine HAVE_CMOCKA_VERSION_H
+

/* Define to 1 = if you have the `daemon' function. */
#cmakedefine HAV= E_DAEMON

diff --git a/configure.ac b/conf= igure.ac
index e77fd47..fb8d530 100644
--- = a/configure.ac
+++ b/configure.ac
@@ -1525,= 7 +1525,16 @@
[have_cmocka=3D"yes"],
= [AC_MSG_WARN([cmocka.pc not found on the system using pkg-config ${= pkg_config_found}. Unit tests disabled])]
)
-AM_CONDITIONAL([ENABLE_UNITTESTS], = [test "${enable_unit_tests}" =3D "yes" -a "${have_= cmocka}" =3D "yes" ])

+AM_CONDITIONAL([ENABLE_UNITTESTS], [false])
+if test "${enable_unit_tests}= " =3D "yes" -a "${have_cmocka}" =3D "yes"= ;; then
+ AM_CONDIT= IONAL([ENABLE_UNITTESTS], [true])
+
+ sa= ved_CFLAGS=3D"${CFLAGS}"
+ CFLAGS=3D"${CFLAGS} ${CMOCKA_CFLAGS}"+ # detect cmocka < 2.0.0= that had no cmocka_version.h
+ AC_CHECK_HEADERS([cmocka_version.h])
+ CFLAGS=3D"${saved_CFLAGS}"
+fi
AC_SU= BST([ENABLE_UNITTESTS])

TEST_LDFLAGS=3D&= quot;${OPTIONAL_CRYPTO_LIBS} ${OPTIONAL_PKCS11_HELPER_LIBS}"diff --git a/tests/unit_tests/openvpn/test_common.h b/tests/unit_tes= ts/openvpn/test_common.h
index 50e16d6..e5e4420 100644

--- a/tests/unit_tests/openvpn/test_common.h
++= + b/tests/unit_tests/openvpn/test_common.h
@@ -25,6 +25,27 = @@
#include <setjmp.h>
#include <= ;cmocka.h>

+/* Do we use cmocka < 2.0.0? */
+#ifndef HAVE_CMOCKA_VERSION_H
+#define HAVE_OLD_CMOCKA_API 1+/* compat with various versi= ons of cmocka.h
+ * O= lder versions have LargestIntegralType. Newer
+ * versions use uintmax_t. But LargestIntegralTyp= e
+ * is not guarante= ed to be equal to uintmax_t, so
+ * we can't use that unconditionally. So we only use=
+ * it if cmocka.h does not= define LargestIntegralType.
+ */
+#ifndef= LargestIntegralType
= +#define LargestIntegralType uintmax_t
+#endif
+/* redefine 2.x API in terms of 1.x API */
+#define CMockaValueData LargestInt= egralType
+#define ch= eck_expected_uint check_expected
+#define expect_uint_value expect_value
+#define expect_check_data= expect_check
+#define cast_ptr_to_cmocka_value(x) (x)
+#endif
+
/**
* Sets up the environmen= t for unit tests like making both stderr and stdout
* non= -buffered to avoid messages getting lost if the program exits early.=
diff --git a/tests/unit_tests/openvpn/test_tls_crypt.c b/tests/un= it_tests/openvpn/test_tls_crypt.c
index 5eb864e..bf5a8ce 10= 0644
--- a/tests/unit_tests/openvpn/test_tls_crypt.c=
+++ b/tests/unit_tests/openvpn/test_tls_crypt.c
@= @ -112,8 +112,8 @@
__wrap_buffer_write_file(const char *fi= lename, const struct buffer *buf)
{
c= onst char *pem =3D BSTR(buf);
- check_expected(filename);
- check_expected(pem);
+ check_expected_ptr(filename);
+ check_expected_ptr(pem);
<= span>

return mock_type(bool);
}
@@ -121,7 +121,7 @@
struct buffer
__wrap_buffer_read_from_file(const char *filename, struct gc_arena *gc= )

{
- = check_expected(filename);
+ check_expected_ptr(filename);

const char *pem_str =3D mock_ptr_type(const char *);
struct buffer ret =3D alloc_buf_gc(strlen(pem_str) + 1, gc);

To view, visit change 1462. To unsubscribe, or for = help writing mail filters, visit settings.

Gerrit-MessageType: newchange
Gerrit-Project: openvpn
Gerrit-Branch: release/2.6
Gerrit-Change-Id: Ifb6594700db71d219643a29c581= 099c778bcbbc6
Gerrit-Change-Number: 1462
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <frank@...2723...= .>
Gerrit-Reviewer: cron2 <gert@...1296...>=
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: cron2 <gert@...1296...>= ;
= --uzbjdhlrqaA=--