Feature: tools: Use formatted output in crm_diff.c

cts/cli/crm_diff_new.xml

@@ -1,4 +1,4 @@
-<cib crm_feature_set="3.2.0" validate-with="pacemaker-3.2" epoch="1" num_updates="0" admin_epoch="0">
+<cib crm_feature_set="3.2.0" validate-with="pacemaker-3.2" epoch="1" num_updates="1" admin_epoch="0">
   <configuration>
     <crm_config>
       <cluster_property_set id="cib-bootstrap-options">

cts/cli/crm_diff_patchset.xml

@@ -0,0 +1,63 @@
+<diff format="2">
+  <version>
+    <source admin_epoch="0" epoch="1" num_updates="0"/>
+    <target admin_epoch="0" epoch="1" num_updates="1"/>
+  </version>
+  <change operation="delete" path="/cib/configuration/comment" position="0"/>
+  <change operation="delete" path="/cib/configuration/comment" position="1"/>
+  <change operation="delete" path="/cib/configuration/comment" position="2"/>
+  <change operation="delete" path="/cib/configuration/resources/comment" position="0"/>
+  <change operation="delete" path="/cib/configuration/resources/primitive[@id='Fencing']/operations/op[@id='Fencing-start-0']"/>
+  <change operation="modify" path="/cib/configuration/crm_config/cluster_property_set[@id='cib-bootstrap-options']/nvpair[@id='cib-bootstrap-options-cluster-name']">
+    <change-list>
+      <change-attr name="value" operation="set" value="mycluster"/>
+      <change-attr name="name" operation="set" value="cluster-name"/>
+    </change-list>
+    <change-result>
+      <nvpair id="cib-bootstrap-options-cluster-name" value="mycluster" name="cluster-name"/>
+    </change-result>
+  </change>
+  <change operation="create" path="/cib/configuration/nodes" position="4">
+    <node id="4" uname="node4"/>
+  </change>
+  <change operation="create" path="/cib/configuration" position="2">
+    <!-- test: add a new comment below this one -->
+  </change>
+  <change operation="create" path="/cib/configuration" position="3">
+    <!-- hello world -->
+  </change>
+  <change operation="create" path="/cib/configuration/resources" position="0">
+    <!-- test: modify this comment to say something different -->
+  </change>
+  <change operation="modify" path="/cib/configuration/resources/primitive[@id='Fencing']/instance_attributes[@id='Fencing-params']/nvpair[@id='Fencing-pcmk_host_list']">
+    <change-list>
+      <change-attr name="value" operation="set" value="node1 node2 node3 node4"/>
+    </change-list>
+    <change-result>
+      <nvpair id="Fencing-pcmk_host_list" name="pcmk_host_list" value="node1 node2 node3 node4"/>
+    </change-result>
+  </change>
+  <change operation="modify" path="/cib/configuration/resources/primitive[@id='Fencing']/operations/op[@id='Fencing-monitor-120s']">
+    <change-list>
+      <change-attr name="timeout" operation="set" value="120s"/>
+      <change-attr name="name" operation="set" value="monitor"/>
+    </change-list>
+    <change-result>
+      <op id="Fencing-monitor-120s" interval="120s" timeout="120s" name="monitor"/>
+    </change-result>
+  </change>
+  <change operation="move" path="/cib/configuration/resources/primitive[@id='dummy']/instance_attributes[@id='dummy-params']/nvpair[@id='dummy-op_sleep']" position="1"/>
+  <change operation="move" path="/cib/configuration/resources/primitive[@id='dummy']/instance_attributes[@id='dummy-params']/nvpair[@id='dummy-fake']" position="2"/>
+  <change operation="modify" path="/cib/configuration/resources/primitive[@id='dummy']/operations/op[@id='dummy-monitor-5s']">
+    <change-list>
+      <change-attr name="name" operation="set" value="monitor"/>
+      <change-attr name="timeout" operation="unset"/>
+    </change-list>
+    <change-result>
+      <op id="dummy-monitor-5s" interval="5s" name="monitor"/>
+    </change-result>
+  </change>
+  <change operation="create" path="/cib/configuration" position="6">
+    <!-- test: move this comment to end of configuration -->
+  </change>
+</diff>

cts/cts-cli.in

@@ -450,7 +450,7 @@ class Test:
 
     def _log_test_failed(self, app, rc):
         """Log a message when a test fails."""
-        self._output.append(f"* Failed (rc={rc:.3d}): {app:<23} - {self.desc}")
+        self._output.append(f"* Failed (rc={rc:03d}): {app:<23} - {self.desc}")
 
     def _log_test_passed(self, app):
         """Log a message when a test passes."""
@@ -2385,10 +2385,46 @@ class CrmDiffRegressionTest(RegressionTest):
     @property
     def tests(self):
         """A list of Test instances to be run as part of this regression test."""
+
+        old_file = f"{cts_cli_data}/crm_diff_old.xml"
+        new_file = f"{cts_cli_data}/crm_diff_new.xml"
+        patch_file = f"{cts_cli_data}/crm_diff_patchset.xml"
+
+        with open(f"{cts_cli_data}/crm_diff_old.xml", "r") as file:
+            old_str = f"'{file.read()}'"
+        with open(f"{cts_cli_data}/crm_diff_new.xml", "r") as file:
+            new_str = f"'{file.read()}'"
+
         return [
-            Test("Create an XML patchset",
-                 f"crm_diff -o {cts_cli_data}/crm_diff_old.xml -n {cts_cli_data}/crm_diff_new.xml",
-                 expected_rc=ExitStatus.ERROR)
+            Test("Create an XML patchset from files",
+                 f"crm_diff -o {old_file} -n {new_file}",
+                 expected_rc=ExitStatus.ERROR),
+            Test("Create an XML patchset from strings",
+                 f"crm_diff -O {old_str} -N {new_str}",
+                 expected_rc=ExitStatus.ERROR),
+            Test("Create an XML patchset from old file, new string",
+                 f"crm_diff -o {old_file} -N {new_str}",
+                 expected_rc=ExitStatus.ERROR),
+            Test("Create an XML patchset from old string, new file",
+                 f"crm_diff -O {old_str} -n {new_file}",
+                 expected_rc=ExitStatus.ERROR),
+
+            Test("Create an XML patchset from files",
+                 f"crm_diff -o {old_file} -n {new_file} --cib",
+                 expected_rc=ExitStatus.ERROR),
+            Test("Create an XML patchset from files",
+                 f"crm_diff -o {old_file} -n {new_file} --no-version",
+                 expected_rc=ExitStatus.ERROR),
+            Test("Create an XML patchset from files",
+                 f"crm_diff -o {old_file} -n {new_file} --cib --no-version",
+                 expected_rc=ExitStatus.USAGE),
+
+            Test("Apply an XML patchset to a file",
+                 f"crm_diff -o {old_file} -p {patch_file}"),
+            Test("Apply an XML patchset to a string",
+                 f"crm_diff -O {old_str} -p {patch_file}"),
+            Test("Apply an XML patchset to a file",
+                 f"crm_diff -o {old_file} -p {patch_file} --cib"),
         ]
 
 

daemons/controld/controld_te_actions.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -299,10 +299,11 @@ controld_record_action_event(pcmk__graph_action_t *action,
     rsc = pcmk__xe_create(rsc, PCMK__XE_LRM_RESOURCE);
     crm_xml_add(rsc, PCMK_XA_ID, rsc_id);
 
-
-    crm_copy_xml_element(action_rsc, rsc, PCMK_XA_TYPE);
-    crm_copy_xml_element(action_rsc, rsc, PCMK_XA_CLASS);
-    crm_copy_xml_element(action_rsc, rsc, PCMK_XA_PROVIDER);
+    crm_xml_add(rsc, PCMK_XA_TYPE, crm_element_value(action_rsc, PCMK_XA_TYPE));
+    crm_xml_add(rsc, PCMK_XA_CLASS,
+                crm_element_value(action_rsc, PCMK_XA_CLASS));
+    crm_xml_add(rsc, PCMK_XA_PROVIDER,
+                crm_element_value(action_rsc, PCMK_XA_PROVIDER));
 
     pcmk__create_history_xml(rsc, op, CRM_FEATURE_SET, target_rc, target,
                              __func__);

include/crm/common/xml.h

@@ -35,7 +35,8 @@ extern "C" {
 
 xmlNode *xml_create_patchset(
     int format, xmlNode *source, xmlNode *target, bool *config, bool manage_version);
-int xml_apply_patchset(xmlNode *xml, xmlNode *patchset, bool check_version);
+int xml_apply_patchset(xmlNode *xml, const xmlNode *patchset,
+                       bool check_version);
 
 #ifdef __cplusplus
 }

include/crm/common/xml_element.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -42,24 +42,6 @@ int crm_element_value_timeval(const xmlNode *data, const char *name_sec,
                               const char *name_usec, struct timeval *dest);
 char *crm_element_value_copy(const xmlNode *data, const char *name);
 
-/*!
- * \brief Copy an element from one XML object to another
- *
- * \param[in]     obj1     Source XML
- * \param[in,out] obj2     Destination XML
- * \param[in]     element  Name of element to copy
- *
- * \return Pointer to copied value (from source)
- */
-static inline const char *
-crm_copy_xml_element(const xmlNode *obj1, xmlNode *obj2, const char *element)
-{
-    const char *value = crm_element_value(obj1, element);
-
-    crm_xml_add(obj2, element, value);
-    return value;
-}
-
 #ifdef __cplusplus
 }
 #endif

include/crm/common/xml_element_compat.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -35,6 +35,10 @@ void crm_xml_set_id(xmlNode *xml, const char *format, ...) G_GNUC_PRINTF(2, 3);
 //! \deprecated Do not use
 xmlNode *sorted_xml(xmlNode *input, xmlNode *parent, gboolean recursive);
 
+//! \deprecated Do not use
+const char *crm_copy_xml_element(const xmlNode *obj1, xmlNode *obj2,
+                                 const char *element);
+
 #ifdef __cplusplus
 }
 #endif

include/crm/common/xml_names.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -157,6 +157,7 @@ extern "C" {
 #define PCMK_XE_PACEMAKERD                  "pacemakerd"
 #define PCMK_XE_PARAMETER                   "parameter"
 #define PCMK_XE_PARAMETERS                  "parameters"
+#define PCMK_XE_PATCHSET                    "patchset"
 #define PCMK_XE_PERIOD                      "period"
 #define PCMK_XE_PODMAN                      "podman"
 #define PCMK_XE_PORT_MAPPING                "port-mapping"
@@ -214,6 +215,7 @@ extern "C" {
 #define PCMK_XE_TIMING                      "timing"
 #define PCMK_XE_TIMINGS                     "timings"
 #define PCMK_XE_TRANSITION                  "transition"
+#define PCMK_XE_UPDATED                     "updated"
 #define PCMK_XE_UTILIZATION                 "utilization"
 #define PCMK_XE_UTILIZATIONS                "utilizations"
 #define PCMK_XE_VALIDATE                    "validate"

include/crm/crm.h

@@ -63,7 +63,7 @@ extern "C" {
  * >=3.2.0:  DC supports PCMK_EXEC_INVALID and PCMK_EXEC_NOT_CONNECTED
  * >=3.19.0: DC supports PCMK__CIB_REQUEST_COMMIT_TRANSACT
  */
-#define CRM_FEATURE_SET "3.20.1"
+#define CRM_FEATURE_SET "3.20.2"
 
 /* Pacemaker's CPG protocols use fixed-width binary fields for the sender and
  * recipient of a CPG message. This imposes an arbitrary limit on cluster node

include/crm_internal.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2024 the Pacemaker project contributors
+ * Copyright 2006-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -38,6 +38,7 @@
 
 #include <crm/lrmd.h>
 #include <crm/cluster/internal.h>
+#include <crm/common/cmdline_internal.h>
 #include <crm/common/digest_internal.h>
 #include <crm/common/logging.h>
 #include <crm/common/logging_internal.h>

lib/common/digest.c

@@ -176,6 +176,9 @@ pcmk__digest_xml(const xmlNode *xml, bool filter)
 
     pcmk__xml_string(xml, (filter? pcmk__xml_fmt_filtered : 0), buf, 0);
     digest = crm_md5sum(buf->str);
+    if (digest == NULL) {
+        goto done;
+    }
 
     pcmk__if_tracing(
         {
@@ -192,6 +195,8 @@ pcmk__digest_xml(const xmlNode *xml, bool filter)
         },
         {}
     );
+
+done:
     g_string_free(buf, TRUE);
     return digest;
 }