Refactor: libcrmcommon: Reduce duplication of null output message funcs

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>

Author: nrwahl2

include/crm/common/unittest_internal.h

@@ -148,6 +148,8 @@ void pcmk__expect_fake_text_free_priv(void);
 void pcmk__expect_fake_text_err(void);
 pcmk__output_t *pcmk__output_null_create1(char **argv);
 pcmk__output_t *pcmk__output_null_create2(char **argv);
+int pcmk__output_message_dummy1(pcmk__output_t *out, va_list args);
+int pcmk__output_message_dummy2(pcmk__output_t *out, va_list args);
 
 /*!
  * \internal

lib/common/tests/output/pcmk__output_free_test.c

@@ -13,12 +13,6 @@
 
 #include <crm/common/unittest_internal.h>
 
-static int
-null_message_fn(pcmk__output_t *out, va_list args)
-{
-    return pcmk_rc_ok;
-}
-
 static int
 setup(void **state)
 {
@@ -52,7 +46,7 @@ messages(void **state)
     pcmk__output_t *out = NULL;
 
     pcmk__output_new(&out, "text", NULL, NULL);
-    pcmk__register_message(out, "fake", null_message_fn);
+    pcmk__register_message(out, "fake", pcmk__output_message_dummy1);
 
     pcmk__expect_fake_text_free_priv();
     pcmk__output_free(out);

lib/common/tests/output/pcmk__register_message_test.c

@@ -15,28 +15,19 @@
 
 #include "../../crmcommon_private.h"
 
-static int
-null_message_fn(pcmk__output_t *out, va_list args)
-{
-    return pcmk_rc_ok;
-}
-
-static int
-null_message_fn_2(pcmk__output_t *out, va_list args)
-{
-    return pcmk_rc_ok;
-}
-
 static void
 null_params(void **state)
 {
     pcmk__output_t *out = NULL;
 
     pcmk__output_new(&out, "text", NULL, NULL);
 
-    pcmk__assert_asserts(pcmk__register_message(NULL, "fake", null_message_fn));
-    pcmk__assert_asserts(pcmk__register_message(out, NULL, null_message_fn));
-    pcmk__assert_asserts(pcmk__register_message(out, "", null_message_fn));
+    pcmk__assert_asserts(pcmk__register_message(NULL, "fake",
+                                                pcmk__output_message_dummy1));
+    pcmk__assert_asserts(pcmk__register_message(out, NULL,
+                                                pcmk__output_message_dummy1));
+    pcmk__assert_asserts(pcmk__register_message(out, "",
+                                                pcmk__output_message_dummy1));
     pcmk__assert_asserts(pcmk__register_message(out, "fake", NULL));
 
     pcmk__output_free(out);
@@ -53,18 +44,18 @@ add_message(void **state)
     assert_int_equal(g_hash_table_size(out->messages), 0);
 
     /* Add a fake function and check that it's the only item in the hash table. */
-    pcmk__register_message(out, "fake", null_message_fn);
+    pcmk__register_message(out, "fake", pcmk__output_message_dummy1);
     assert_int_equal(g_hash_table_size(out->messages), 1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "fake"),
-                     null_message_fn);
+                     pcmk__output_message_dummy1);
 
     /* Add a second fake function which should overwrite the first one, leaving
      * only one item in the hash table but pointing at the new function.
      */
-    pcmk__register_message(out, "fake", null_message_fn_2);
+    pcmk__register_message(out, "fake", pcmk__output_message_dummy2);
     assert_int_equal(g_hash_table_size(out->messages), 1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "fake"),
-                     null_message_fn_2);
+                     pcmk__output_message_dummy2);
 
     pcmk__output_free(out);
 }

lib/common/tests/output/pcmk__register_messages_test.c

@@ -15,18 +15,6 @@
 
 #include "../../crmcommon_private.h"
 
-static int
-null_message_fn(pcmk__output_t *out, va_list args)
-{
-    return pcmk_rc_ok;
-}
-
-static int
-null_message_fn_2(pcmk__output_t *out, va_list args)
-{
-    return pcmk_rc_ok;
-}
-
 static void
 invalid_entries(void **state)
 {
@@ -36,8 +24,8 @@ invalid_entries(void **state)
         /* We can't test a NULL message_id here because that's the marker for
          * the end of the table.
          */
-        { "", "", null_message_fn },
-        { "", NULL, null_message_fn },
+        { "", "", pcmk__output_message_dummy1 },
+        { "", NULL, pcmk__output_message_dummy1 },
         { "", "text", NULL },
         { NULL },
     };
@@ -56,8 +44,8 @@ valid_entries(void **state)
     pcmk__output_t *out = NULL;
 
     pcmk__message_entry_t entries[] = {
-        { "msg1", "text", null_message_fn },
-        { "msg2", "text", null_message_fn_2 },
+        { "msg1", "text", pcmk__output_message_dummy1 },
+        { "msg2", "text", pcmk__output_message_dummy2 },
         { NULL },
     };
 
@@ -66,9 +54,9 @@ valid_entries(void **state)
     pcmk__register_messages(out, entries);
     assert_int_equal(g_hash_table_size(out->messages), 2);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg1"),
-                     null_message_fn);
+                     pcmk__output_message_dummy1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg2"),
-                     null_message_fn_2);
+                     pcmk__output_message_dummy2);
 
     pcmk__output_free(out);
 }
@@ -79,8 +67,8 @@ duplicate_message_ids(void **state)
     pcmk__output_t *out = NULL;
 
     pcmk__message_entry_t entries[] = {
-        { "msg1", "text", null_message_fn },
-        { "msg1", "text", null_message_fn_2 },
+        { "msg1", "text", pcmk__output_message_dummy1 },
+        { "msg1", "text", pcmk__output_message_dummy2 },
         { NULL },
     };
 
@@ -89,7 +77,7 @@ duplicate_message_ids(void **state)
     pcmk__register_messages(out, entries);
     assert_int_equal(g_hash_table_size(out->messages), 1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg1"),
-                     null_message_fn_2);
+                     pcmk__output_message_dummy2);
 
     pcmk__output_free(out);
 }
@@ -100,8 +88,8 @@ duplicate_functions(void **state)
     pcmk__output_t *out = NULL;
 
     pcmk__message_entry_t entries[] = {
-        { "msg1", "text", null_message_fn },
-        { "msg2", "text", null_message_fn },
+        { "msg1", "text", pcmk__output_message_dummy1 },
+        { "msg2", "text", pcmk__output_message_dummy1 },
         { NULL },
     };
 
@@ -110,9 +98,9 @@ duplicate_functions(void **state)
     pcmk__register_messages(out, entries);
     assert_int_equal(g_hash_table_size(out->messages), 2);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg1"),
-                     null_message_fn);
+                     pcmk__output_message_dummy1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg2"),
-                     null_message_fn);
+                     pcmk__output_message_dummy1);
 
     pcmk__output_free(out);
 }
@@ -123,7 +111,7 @@ default_handler(void **state)
     pcmk__output_t *out = NULL;
 
     pcmk__message_entry_t entries[] = {
-        { "msg1", "default", null_message_fn },
+        { "msg1", "default", pcmk__output_message_dummy1 },
         { NULL },
     };
 
@@ -132,7 +120,7 @@ default_handler(void **state)
     pcmk__register_messages(out, entries);
     assert_int_equal(g_hash_table_size(out->messages), 1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg1"),
-                     null_message_fn);
+                     pcmk__output_message_dummy1);
 
     pcmk__output_free(out);
 }
@@ -143,8 +131,8 @@ override_default_handler(void **state)
     pcmk__output_t *out = NULL;
 
     pcmk__message_entry_t entries[] = {
-        { "msg1", "default", null_message_fn },
-        { "msg1", "text", null_message_fn_2 },
+        { "msg1", "default", pcmk__output_message_dummy1 },
+        { "msg1", "text", pcmk__output_message_dummy2 },
         { NULL },
     };
 
@@ -153,7 +141,7 @@ override_default_handler(void **state)
     pcmk__register_messages(out, entries);
     assert_int_equal(g_hash_table_size(out->messages), 1);
     assert_ptr_equal(g_hash_table_lookup(out->messages, "msg1"),
-                     null_message_fn_2);
+                     pcmk__output_message_dummy2);
 
     pcmk__output_free(out);
 }

lib/common/unittest.c

@@ -280,4 +280,16 @@ pcmk__output_null_create2(char **argv)
     return NULL;
 }
 
+int
+pcmk__output_message_dummy1(pcmk__output_t *out, va_list args)
+{
+    return pcmk_rc_ok;
+}
+
+int
+pcmk__output_message_dummy2(pcmk__output_t *out, va_list args)
+{
+    return pcmk_rc_ok;
+}
+
 // LCOV_EXCL_STOP