Low: libcrmcommon: Convert unit test assertion helpers to macros

With a function, the CMocka assert macros showed unhelpful line numbers
on error.

Ref T222

Signed-off-by: Reid Wahl <[email protected]>

Author: nrwahl2

lib/common/tests/cmdline/pcmk__quote_cmdline_test.c

@@ -18,16 +18,14 @@
  * says "The quoting style used is undefined (single or double quotes may be
  * used)."
  */
-static void
-assert_quote_cmdline(const char **argv, const gchar *expected_single,
-                     const gchar *expected_double)
-{
-    gchar *processed = pcmk__quote_cmdline((const char *const *) argv);
-
-    assert_true(pcmk__str_any_of(processed, expected_single, expected_double,
-                                 NULL));
-    g_free(processed);
-}
+#define assert_quote_cmdline(argv, expected_single, expected_double)    \
+    do {                                                                \
+        gchar *processed = pcmk__quote_cmdline(argv);                   \
+                                                                        \
+        assert_true(pcmk__str_any_of(processed, expected_single,        \
+                                     expected_double, NULL));           \
+        g_free(processed);                                              \
+    } while (0)
 
 static void
 empty_input(void **state)

lib/common/tests/iso8601/crm_time_add_days_test.c

@@ -16,22 +16,20 @@
 
 #include <crm/common/iso8601.h>
 
-static void
-assert_add_days(const char *orig_date_time, int days,
-                const char *expected_date_time)
-{
-    crm_time_t *orig = crm_time_new(orig_date_time);
-    crm_time_t *expected = crm_time_new(expected_date_time);
-
-    assert_non_null(orig);
-    assert_non_null(expected);
-
-    crm_time_add_days(orig, days);
-    assert_int_equal(crm_time_compare(orig, expected), 0);
-
-    crm_time_free(orig);
-    crm_time_free(expected);
-}
+#define assert_add_days(orig_date_time, days, expected_date_time)   \
+    do {                                                            \
+        crm_time_t *orig = crm_time_new(orig_date_time);            \
+        crm_time_t *expected = crm_time_new(expected_date_time);    \
+                                                                    \
+        assert_non_null(orig);                                      \
+        assert_non_null(expected);                                  \
+                                                                    \
+        crm_time_add_days(orig, days);                              \
+        assert_int_equal(crm_time_compare(orig, expected), 0);      \
+                                                                    \
+        crm_time_free(orig);                                        \
+        crm_time_free(expected);                                    \
+    } while (0)
 
 static void
 invalid_argument(void **state)

lib/common/tests/iso8601/crm_time_add_seconds_test.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 the Pacemaker project contributors
+ * Copyright 2024-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -16,22 +16,20 @@
 
 #include <crm/common/iso8601.h>
 
-static void
-assert_add_seconds(const char *orig_date_time, int seconds,
-                 const char *expected_date_time)
-{
-    crm_time_t *orig = crm_time_new(orig_date_time);
-    crm_time_t *expected = crm_time_new(expected_date_time);
-
-    assert_non_null(orig);
-    assert_non_null(expected);
-
-    crm_time_add_seconds(orig, seconds);
-    assert_int_equal(crm_time_compare(orig, expected), 0);
-
-    crm_time_free(orig);
-    crm_time_free(expected);
-}
+#define assert_add_seconds(orig_date_time, seconds, expected_date_time) \
+    do {                                                                \
+        crm_time_t *orig = crm_time_new(orig_date_time);                \
+        crm_time_t *expected = crm_time_new(expected_date_time);        \
+                                                                        \
+        assert_non_null(orig);                                          \
+        assert_non_null(expected);                                      \
+                                                                        \
+        crm_time_add_seconds(orig, seconds);                            \
+        assert_int_equal(crm_time_compare(orig, expected), 0);          \
+                                                                        \
+        crm_time_free(orig);                                            \
+        crm_time_free(expected);                                        \
+    } while (0)
 
 static void
 invalid_argument(void **state)

lib/common/tests/iso8601/crm_time_add_years_test.c

@@ -16,22 +16,20 @@
 
 #include <crm/common/iso8601.h>
 
-static void
-assert_add_years(const char *orig_date_time, int years,
-                 const char *expected_date_time)
-{
-    crm_time_t *orig = crm_time_new(orig_date_time);
-    crm_time_t *expected = crm_time_new(expected_date_time);
-
-    assert_non_null(orig);
-    assert_non_null(expected);
-
-    crm_time_add_years(orig, years);
-    assert_int_equal(crm_time_compare(orig, expected), 0);
-
-    crm_time_free(orig);
-    crm_time_free(expected);
-}
+#define assert_add_years(orig_date_time, years, expected_date_time) \
+    do {                                                            \
+        crm_time_t *orig = crm_time_new(orig_date_time);            \
+        crm_time_t *expected = crm_time_new(expected_date_time);    \
+                                                                    \
+        assert_non_null(orig);                                      \
+        assert_non_null(expected);                                  \
+                                                                    \
+        crm_time_add_years(orig, years);                            \
+        assert_int_equal(crm_time_compare(orig, expected), 0);      \
+                                                                    \
+        crm_time_free(orig);                                        \
+        crm_time_free(expected);                                    \
+    } while (0)
 
 static void
 invalid_argument(void **state)

lib/common/tests/iso8601/pcmk__time_format_hr_test.c

@@ -30,83 +30,78 @@
  * \internal
  * \brief Check that \c pcmk__time_format_hr() produced expected result
  *
- * \param[in] format    Time format string
- * \param[in] expected  Check succeeds if result matches this
+ * \param[in] format    Time format string (<tt>const char *</tt>)
+ * \param[in] expected  Succeed if result matches this (<tt>const char *</tt>)
  */
-static void
-assert_hr_format(const char *format, const char *expected)
-{
-    crm_time_t *dt = NULL;
-    char *result = NULL;
-
-    dt = crm_time_new(DATE_TIME_S);
-    assert_non_null(dt);
-
-    result = pcmk__time_format_hr(format, dt, 0);
-    assert_non_null(result);
-
-    assert_string_equal(result, expected);
-
-    crm_time_free(dt);
-    free(result);
-}
+#define assert_hr_format(format, expected)              \
+    do {                                                \
+        crm_time_t *dt = NULL;                          \
+        char *result = NULL;                            \
+                                                        \
+        dt = crm_time_new(DATE_TIME_S);                 \
+        assert_non_null(dt);                            \
+                                                        \
+        result = pcmk__time_format_hr(format, dt, 0);   \
+        assert_non_null(result);                        \
+        assert_string_equal(result, expected);          \
+                                                        \
+        crm_time_free(dt);                              \
+        free(result);                                   \
+    } while (0)
 
 /*!
  * \internal
  * \brief Check that \c pcmk__time_format_hr() produced expected result (or alt)
  *
- * \param[in] format     Time format string
- * \param[in] expected   Check succeeds if result matches this
- * \param[in] alternate  Check also succeeds if result matches this
+ * \param[in] format     Time format string (<tt>const char *</tt>)
+ * \param[in] expected   Succeed if result matches this (<tt>const char *</tt>)
+ * \param[in] alternate  Succeed if result matches this (<tt>const char *</tt>)
  *
  * \note This allows two possible results because different \c strftime()
  *       implementations handle certain format syntax differently.
  */
-static void
-assert_hr_format_alt(const char *format, const char *expected,
-                     const char *alternate)
-{
-    crm_time_t *dt = NULL;
-    char *result = NULL;
-
-    dt = crm_time_new(DATE_TIME_S);
-    assert_non_null(dt);
-
-    result = pcmk__time_format_hr(format, dt, 0);
-    assert_non_null(result);
-
-    // CMocka has no abstraction for comparing to multiple strings
-    assert_true((strcmp(result, expected) == 0)
-                || (strcmp(result, alternate) == 0));
-
-    crm_time_free(dt);
-    free(result);
-}
+#define assert_hr_format_alt(format, expected, alternate)                   \
+    do {                                                                    \
+        crm_time_t *dt = NULL;                                              \
+        char *result = NULL;                                                \
+                                                                            \
+        dt = crm_time_new(DATE_TIME_S);                                     \
+        assert_non_null(dt);                                                \
+                                                                            \
+        result = pcmk__time_format_hr(format, dt, 0);                       \
+        assert_non_null(result);                                            \
+                                                                            \
+        /* CMocka has no abstraction for comparing to multiple strings */   \
+        assert_true((strcmp(result, expected) == 0)                         \
+                    || (strcmp(result, alternate) == 0));                   \
+                                                                            \
+        crm_time_free(dt);                                                  \
+        free(result);                                                       \
+    } while (0)
 
 /*!
  * \internal
  * \brief Check that \c pcmk__time_format_hr() produced expected high-res result
  *
- * \param[in] format    Time format string
- * \param[in] expected  Check succeeds if result matches this
- * \param[in] usec      Microseconds component of the reference time
+ * \param[in] format    Time format string (<tt>const char *</tt>)
+ * \param[in] expected  Succeed if result matches this (<tt>const char *</tt>)
+ * \param[in] usec      Microseconds component of the reference time (\c int)
  */
-static void
-assert_hr_format_usec(const char *format, const char *expected, int usec)
-{
-    crm_time_t *dt = NULL;
-    char *result = NULL;
-
-    dt = crm_time_new(DATE_TIME_S);
-    assert_non_null(dt);
-
-    result = pcmk__time_format_hr(format, dt, usec);
-    assert_non_null(result);
-    assert_string_equal(result, expected);
-
-    crm_time_free(dt);
-    free(result);
-}
+#define assert_hr_format_usec(format, expected, usec)       \
+    do {                                                    \
+        crm_time_t *dt = NULL;                              \
+        char *result = NULL;                                \
+                                                            \
+        dt = crm_time_new(DATE_TIME_S);                     \
+        assert_non_null(dt);                                \
+                                                            \
+        result = pcmk__time_format_hr(format, dt, usec);    \
+        assert_non_null(result);                            \
+        assert_string_equal(result, expected);              \
+                                                            \
+        crm_time_free(dt);                                  \
+        free(result);                                       \
+    } while (0)
 
 static void
 null_format(void **state)

lib/common/tests/nvpair/pcmk__scan_nvpair_test.c

@@ -13,33 +13,30 @@
 
 #include <crm/common/unittest_internal.h>
 
-static void
-assert_scan_nvpair_success(const gchar *input, const gchar *expected_name,
-                           const gchar *expected_value)
-{
-    gchar *name = NULL;
-    gchar *value = NULL;
-    int rc = pcmk__scan_nvpair(input, &name, &value);
-
-    assert_int_equal(rc, pcmk_rc_ok);
-    assert_string_equal(name, expected_name);
-    assert_string_equal(value, expected_value);
-
-    g_free(name);
-    g_free(value);
-}
-
-static void
-assert_scan_nvpair_failure(const gchar *input)
-{
-    gchar *name = NULL;
-    gchar *value = NULL;
-    int rc = pcmk__scan_nvpair(input, &name, &value);
-
-    assert_int_equal(rc, pcmk_rc_bad_nvpair);
-    assert_null(name);
-    assert_null(value);
-}
+#define assert_scan_nvpair_success(input, expected_name, expected_value)    \
+    do {                                                                    \
+        gchar *name = NULL;                                                 \
+        gchar *value = NULL;                                                \
+        int rc = pcmk__scan_nvpair(input, &name, &value);                   \
+                                                                            \
+        assert_int_equal(rc, pcmk_rc_ok);                                   \
+        assert_string_equal(name, expected_name);                           \
+        assert_string_equal(value, expected_value);                         \
+                                                                            \
+        g_free(name);                                                       \
+        g_free(value);                                                      \
+    } while (0)
+
+#define assert_scan_nvpair_failure(input)                   \
+    do {                                                    \
+        gchar *name = NULL;                                 \
+        gchar *value = NULL;                                \
+        int rc = pcmk__scan_nvpair(input, &name, &value);   \
+                                                            \
+        assert_int_equal(rc, pcmk_rc_bad_nvpair);           \
+        assert_null(name);                                  \
+        assert_null(value);                                 \
+    } while (0)
 
 static void
 null_asserts(void **state)

lib/common/tests/patchset/pcmk__cib_element_in_patchset_test.c

@@ -45,27 +45,21 @@ create_patchset(const char *source_s, const char *target_s)
     return patchset;
 }
 
-static void
-assert_in_patchset(const char *source_s, const char *target_s,
-                   const char *element)
-{
-    xmlNode *patchset = create_patchset(source_s, target_s);
-
-    assert_true(pcmk__cib_element_in_patchset(patchset, element));
-
-    pcmk__xml_free(patchset);
-}
-
-static void
-assert_not_in_patchset(const char *source_s, const char *target_s,
-                       const char *element)
-{
-    xmlNode *patchset = create_patchset(source_s, target_s);
-
-    assert_false(pcmk__cib_element_in_patchset(patchset, element));
-
-    pcmk__xml_free(patchset);
-}
+#define assert_in_patchset(source_s, target_s, element)                 \
+    do {                                                                \
+        xmlNode *patchset = create_patchset(source_s, target_s);        \
+                                                                        \
+        assert_true(pcmk__cib_element_in_patchset(patchset, element));  \
+        pcmk__xml_free(patchset);                                       \
+    } while (0)
+
+#define assert_not_in_patchset(source_s, target_s, element)             \
+    do {                                                                \
+        xmlNode *patchset = create_patchset(source_s, target_s);        \
+                                                                        \
+        assert_false(pcmk__cib_element_in_patchset(patchset, element)); \
+        pcmk__xml_free(patchset);                                       \
+    } while (0)
 
 static void
 null_patchset_asserts(void **state)