Merge pull request #482 from embhorn/test_update

Update testing with a more flexible framework

Author: aidangarske

CMakeLists.txt

@@ -344,6 +344,25 @@ if (WOLFMQTT_BROKER)
         $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>)
 endif()
 
+add_option("WOLFMQTT_UNIT_TESTS"
+           "Build unit tests (only when wolfMQTT is the top-level project)"
+           "yes" "yes;no")
+# Only build tests when wolfMQTT is the top-level project, to avoid adding
+# a test target to parent projects that consume wolfMQTT via add_subdirectory.
+if(WOLFMQTT_UNIT_TESTS AND CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
+    enable_testing()
+    add_executable(wolfmqtt_unit_tests
+        tests/unit_test.c
+        tests/test_framework.c
+        tests/test_mqtt_packet.c
+        tests/test_mqtt_client.c
+    )
+    target_include_directories(wolfmqtt_unit_tests
+        PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+    target_link_libraries(wolfmqtt_unit_tests wolfmqtt)
+    add_test(NAME wolfmqtt_unit_tests COMMAND wolfmqtt_unit_tests)
+endif()
+
 ####################################################
 # Installation
 ####################################################

README.md

@@ -54,6 +54,9 @@ cmake .. -DWITH_WOLFSSL_TREE=/path/to/wolfssl/
 cmake --build .
 ```
 
+Additional CMake options:
+* `-DWOLFMQTT_UNIT_TESTS=no` disables the `wolfmqtt_unit_tests` target (default `yes`). The target is only added when wolfMQTT is the top-level project, so downstream consumers using `add_subdirectory()` are unaffected.
+
 ### vcpkg
 
  You can download and install wolfMQTT using the [vcpkg](https://github.com/Microsoft/vcpkg):

src/mqtt_client.c

@@ -2581,6 +2581,9 @@ int MqttClient_Ping_ex(MqttClient *client, MqttPing* ping)
 
 int MqttClient_Ping(MqttClient *client)
 {
+    if (client == NULL) {
+        return MQTT_TRACE_ERROR(MQTT_CODE_ERROR_BAD_ARG);
+    }
     return MqttClient_Ping_ex(client, &client->msg.ping);
 }
 

tests/include.am

@@ -2,12 +2,18 @@
 # included from Top Level Makefile.am
 # All paths should be given relative to the root
 
-# Unit tests for packet encode/decode
-check_PROGRAMS += tests/unit_test
-tests_unit_test_SOURCES      = tests/unit_test.c
-tests_unit_test_LDADD        = src/libwolfmqtt.la
-tests_unit_test_DEPENDENCIES = src/libwolfmqtt.la
-tests_unit_test_CPPFLAGS     = $(AM_CPPFLAGS)
+# Unit tests
+check_PROGRAMS += tests/unit_tests
+tests_unit_tests_SOURCES      = tests/unit_test.c \
+                                tests/test_framework.c \
+                                tests/test_mqtt_packet.c \
+                                tests/test_mqtt_client.c
+tests_unit_tests_CPPFLAGS     = -I$(top_srcdir) $(AM_CPPFLAGS)
+tests_unit_tests_LDADD        = src/libwolfmqtt.la
+tests_unit_tests_DEPENDENCIES = src/libwolfmqtt.la
+
+# Test framework header
+noinst_HEADERS += tests/unit_test.h
 
 if BUILD_FUZZ
 if BUILD_BROKER

tests/test_framework.c

@@ -0,0 +1,109 @@
+/* test_framework.c
+ *
+ * Copyright (C) 2006-2026 wolfSSL Inc.
+ *
+ * This file is part of wolfMQTT.
+ *
+ * wolfMQTT 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfMQTT 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
+ */
+
+/* Pass-path smoke tests for every assertion macro defined by unit_test.h.
+ * The fail paths call return after setting ut_current_test_failed, so they
+ * cannot be exercised without the framework reporting the test as failed.
+ * These tests ensure each macro at least compiles and evaluates its
+ * non-failing branch correctly. */
+
+#ifdef HAVE_CONFIG_H
+    #include <config.h>
+#endif
+
+#include "tests/unit_test.h"
+
+void run_framework_tests(void);
+
+TEST(assert_true_pass)
+{
+    ASSERT_TRUE(1);
+    ASSERT_TRUE(1 == 1);
+}
+
+TEST(assert_false_pass)
+{
+    ASSERT_FALSE(0);
+    ASSERT_FALSE(1 == 2);
+}
+
+TEST(assert_eq_pass)
+{
+    ASSERT_EQ(0, 0);
+    ASSERT_EQ(42, 42);
+}
+
+TEST(assert_ne_pass)
+{
+    ASSERT_NE(0, 1);
+    ASSERT_NE(42, -1);
+}
+
+TEST(assert_null_pass)
+{
+    void* p = NULL;
+    ASSERT_NULL(p);
+}
+
+TEST(assert_not_null_pass)
+{
+    int x;
+    ASSERT_NOT_NULL(&x);
+}
+
+TEST(assert_str_eq_pass)
+{
+    ASSERT_STR_EQ("hello", "hello");
+}
+
+TEST(assert_mem_eq_pass)
+{
+    const unsigned char a[] = {0x01, 0x02, 0x03, 0x04};
+    const unsigned char b[] = {0x01, 0x02, 0x03, 0x04};
+    ASSERT_MEM_EQ(a, b, sizeof(a));
+}
+
+/* FAIL has no pass path; guard with a never-true condition so the macro
+ * body is compiled but never executed. */
+TEST(fail_compiles)
+{
+    if (0) {
+        FAIL("unreachable");
+    }
+    ASSERT_TRUE(1);
+}
+
+void run_framework_tests(void)
+{
+    TEST_SUITE_BEGIN("framework", NULL, NULL);
+
+    RUN_TEST(assert_true_pass);
+    RUN_TEST(assert_false_pass);
+    RUN_TEST(assert_eq_pass);
+    RUN_TEST(assert_ne_pass);
+    RUN_TEST(assert_null_pass);
+    RUN_TEST(assert_not_null_pass);
+    RUN_TEST(assert_str_eq_pass);
+    RUN_TEST(assert_mem_eq_pass);
+    RUN_TEST(fail_compiles);
+
+    TEST_SUITE_END();
+}