Refactor: libcrmcommon: Helper in unit test for crm_parse_agent_spec()

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

Author: nrwahl2

lib/common/tests/agents/crm_parse_agent_spec_test.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2023 the Pacemaker project contributors
+ * Copyright 2022-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -13,77 +13,127 @@
 #include <crm/common/agents.h>
 
 static void
-all_params_null(void **state) {
-    assert_int_equal(crm_parse_agent_spec(NULL, NULL, NULL, NULL), -EINVAL);
-    assert_int_equal(crm_parse_agent_spec("", NULL, NULL, NULL), -EINVAL);
-    assert_int_equal(crm_parse_agent_spec(":", NULL, NULL, NULL), -EINVAL);
-    assert_int_equal(crm_parse_agent_spec("::", NULL, NULL, NULL), -EINVAL);
-}
-
-static void
-no_prov_or_type(void **state) {
+assert_parse_agent_spec_as(int line, const char *spec, const char *expected_std,
+                           const char *expected_prov, const char *expected_type,
+                           int expected_rc, bool check_spt)
+{
     char *std = NULL;
     char *prov = NULL;
-    char *ty = NULL;
-
-    assert_int_equal(crm_parse_agent_spec("ocf", &std, &prov, &ty), -EINVAL);
-    assert_int_equal(crm_parse_agent_spec("ocf:", &std, &prov, &ty), -EINVAL);
-    assert_int_equal(crm_parse_agent_spec("ocf::", &std, &prov, &ty), -EINVAL);
+    char *type = NULL;
+    int rc = crm_parse_agent_spec(spec, &std, &prov, &type);
+
+    /* @TODO Define pcmk__assert_int_equal() or similar to do the casting, for
+     * reuse in other unit tests. See T222. It would be nice to convert all of
+     * these "assert_X()" functions in unit tests into macro wrappers for
+     * "assert_X_as()".
+     */
+    _assert_int_equal(cast_to_largest_integral_type(rc),
+                      cast_to_largest_integral_type(expected_rc),
+                      __FILE__, line);
+
+    /* @TODO Move this definition to a common file, for reuse in other unit
+     * tests. See other TODO above.
+     *
+     * Note: Commit 09621179 adds an _assert_ptr_equal() function and changes
+     * the assert_null() and assert_ptr_equal() definitions to use it. However,
+     * this commit is not in any cmocka release at the time of writing.
+     */
+#define pcmk__assert_null(c)    \
+    _assert_int_equal(cast_ptr_to_largest_integral_type(c), \
+                      cast_ptr_to_largest_integral_type(NULL), \
+                      __FILE__, (line))
+
+    if (!check_spt) {
+        /* This is a temporary hack to work around an issue that will be fixed
+         * in an upcoming commit
+         */
+        return;
+    }
+
+    if (expected_std == NULL) {
+        pcmk__assert_null(std);
+    } else {
+        _assert_string_equal(std, expected_std, __FILE__, line);
+        free(std);
+    }
+
+    if (expected_prov == NULL) {
+        pcmk__assert_null(prov);
+    } else {
+        _assert_string_equal(prov, expected_prov, __FILE__, line);
+        free(prov);
+    }
+
+    if (expected_type == NULL) {
+        pcmk__assert_null(type);
+    } else {
+        _assert_string_equal(type, expected_type, __FILE__, line);
+        free(type);
+    }
 }
 
+#define assert_parse_agent_spec(spec, expected_std, expected_prov,      \
+                                expected_type, expected_rc, check_spt)  \
+    assert_parse_agent_spec_as(__LINE__, (spec), (expected_std),        \
+                               (expected_prov), (expected_type),        \
+                               (expected_rc), (check_spt))
+
 static void
-no_type(void **state) {
-    char *std = NULL;
-    char *prov = NULL;
-    char *ty = NULL;
+all_params_null(void **state)
+{
+    int rc = pcmk_ok;
 
-    assert_int_equal(crm_parse_agent_spec("ocf:pacemaker:", &std, &prov, &ty), -EINVAL);
-}
+    rc = crm_parse_agent_spec(NULL, NULL, NULL, NULL);
+    assert_int_equal(rc, -EINVAL);
 
-static void
-get_std_and_ty(void **state) {
-    char *std = NULL;
-    char *prov = NULL;
-    char *ty = NULL;
+    rc = crm_parse_agent_spec("", NULL, NULL, NULL);
+    assert_int_equal(rc, -EINVAL);
 
-    assert_int_equal(crm_parse_agent_spec("stonith:fence_xvm", &std, &prov, &ty), pcmk_ok);
-    assert_string_equal(std, "stonith");
-    assert_null(prov);
-    assert_string_equal(ty, "fence_xvm");
+    rc = crm_parse_agent_spec(":", NULL, NULL, NULL);
+    assert_int_equal(rc, -EINVAL);
 
-    free(std);
-    free(ty);
+    rc = crm_parse_agent_spec("::", NULL, NULL, NULL);
+    assert_int_equal(rc, -EINVAL);
 }
 
 static void
-get_all_values(void **state) {
-    char *std = NULL;
-    char *prov = NULL;
-    char *ty = NULL;
+no_prov_or_type(void **state)
+{
+    assert_parse_agent_spec("ocf", NULL, NULL, NULL, -EINVAL, true);
 
-    assert_int_equal(crm_parse_agent_spec("ocf:pacemaker:ping", &std, &prov, &ty), pcmk_ok);
-    assert_string_equal(std, "ocf");
-    assert_string_equal(prov, "pacemaker");
-    assert_string_equal(ty, "ping");
+    // @FIXME std is freed on error, so set it to NULL or don't check its value
+    assert_parse_agent_spec("ocf:",  NULL, NULL, NULL, -EINVAL, false);
+    assert_parse_agent_spec("ocf::", NULL, NULL, NULL, -EINVAL, false);
+}
 
-    free(std);
-    free(prov);
-    free(ty);
+static void
+no_type(void **state)
+{
+    /* @FIXME std and prov are freed on error, so set them to NULL or don't
+     * check their values
+     */
+    assert_parse_agent_spec("ocf:pacemaker:", NULL, NULL, NULL, -EINVAL, false);
 }
 
 static void
-get_systemd_values(void **state) {
-    char *std = NULL;
-    char *prov = NULL;
-    char *ty = NULL;
+get_std_and_ty(void **state)
+{
+    assert_parse_agent_spec("stonith:fence_xvm", "stonith", NULL, "fence_xvm",
+                            pcmk_ok, true);
+}
 
-    assert_int_equal(crm_parse_agent_spec("systemd:UNIT@A:B", &std, &prov, &ty), pcmk_ok);
-    assert_string_equal(std, "systemd");
-    assert_null(prov);
-    assert_string_equal(ty, "UNIT@A:B");
+static void
+get_all_values(void **state)
+{
+    assert_parse_agent_spec("ocf:pacemaker:ping", "ocf", "pacemaker", "ping",
+                            pcmk_ok, true);
+}
 
-    free(std);
-    free(ty);
+static void
+get_systemd_values(void **state)
+{
+    assert_parse_agent_spec("systemd:UNIT@A:B", "systemd", NULL, "UNIT@A:B",
+                            pcmk_ok, true);
 }
 
 PCMK__UNIT_TEST(NULL, NULL,