Additional API parameters for save&restore compare feature

Author: georgweiss

app/save-and-restore/util/src/main/java/org/phoebus/saveandrestore/util/SnapshotUtil.java

@@ -286,7 +286,10 @@ public void release() {
      * if the comparison evaluates to equal, then the actual live and stored value are not added to the {@link CompareResult}
      * objects in order to avoid handling/transferring potentially large amounts of data.
      */
-    public List<CompareResult> comparePvs(final List<SnapshotItem> savedSnapshotItems, double tolerance) {
+    public List<CompareResult> comparePvs(final List<SnapshotItem> savedSnapshotItems,
+                                          double tolerance,
+                                          PvCompareMode comparisonMode,
+                                          boolean skipReadback) {
         if (tolerance < 0) {
             throw new RuntimeException("Tolerance value must be >=0");
         }

app/save-and-restore/util/src/test/java/org/phoebus/saveandrestore/util/SnapshotUtilTest.java

@@ -15,6 +15,7 @@
 import org.phoebus.applications.saveandrestore.model.CompareResult;
 import org.phoebus.applications.saveandrestore.model.ConfigPv;
 import org.phoebus.applications.saveandrestore.model.ConfigurationData;
+import org.phoebus.applications.saveandrestore.model.PvCompareMode;
 import org.phoebus.applications.saveandrestore.model.SnapshotItem;
 import org.phoebus.core.vtypes.VTypeHelper;
 import org.phoebus.pv.PV;
@@ -98,15 +99,15 @@ public void testComparePvs(){
         snapshotItem2.setConfigPv(configPv2);
         snapshotItem2.setValue(VDouble.of(771.0, Alarm.none(), Time.now(), Display.none()));
 
-        List<CompareResult> compareResults = snapshotUtil.comparePvs(List.of(snapshotItem1, snapshotItem2), 0.0);
+        List<CompareResult> compareResults = snapshotUtil.comparePvs(List.of(snapshotItem1, snapshotItem2), 0.0, PvCompareMode.ABSOLUTE, false);
 
         assertTrue(compareResults.get(0).isEqual());
         assertTrue(compareResults.get(1).isEqual());
 
         snapshotItem1.setValue(VDouble.of(43.0, Alarm.none(), Time.now(), Display.none()));
         snapshotItem2.setValue(VDouble.of(771.0, Alarm.none(), Time.now(), Display.none()));
 
-        compareResults = snapshotUtil.comparePvs(List.of(snapshotItem1, snapshotItem2), 0.0);
+        compareResults = snapshotUtil.comparePvs(List.of(snapshotItem1, snapshotItem2), 0.0,  PvCompareMode.ABSOLUTE, false);
 
         assertFalse(compareResults.get(0).isEqual());
         assertNotNull(compareResults.get(0).getStoredValue());
@@ -118,12 +119,12 @@ public void testComparePvs(){
         snapshotItem1.setValue(VDouble.of(43.0, Alarm.none(), Time.now(), Display.none()));
         snapshotItem2.setValue(VDouble.of(771.0, Alarm.none(), Time.now(), Display.none()));
 
-        compareResults = snapshotUtil.comparePvs(List.of(snapshotItem1, snapshotItem2), 10.0);
+        compareResults = snapshotUtil.comparePvs(List.of(snapshotItem1, snapshotItem2), 10.0, PvCompareMode.ABSOLUTE, false);
 
         assertTrue(compareResults.get(0).isEqual());
         assertTrue(compareResults.get(1).isEqual());
 
-        assertThrows(RuntimeException.class, () -> snapshotUtil.comparePvs(null, -77));
+        assertThrows(RuntimeException.class, () -> snapshotUtil.comparePvs(null, -77, PvCompareMode.ABSOLUTE, false));
 
     }
 }

services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/controllers/ComparisonController.java

@@ -20,6 +20,7 @@
 import org.phoebus.applications.saveandrestore.model.CompareResult;
 import org.phoebus.applications.saveandrestore.model.CompositeSnapshotData;
 import org.phoebus.applications.saveandrestore.model.Node;
+import org.phoebus.applications.saveandrestore.model.PvCompareMode;
 import org.phoebus.applications.saveandrestore.model.SnapshotItem;
 import org.phoebus.saveandrestore.util.SnapshotUtil;
 import org.phoebus.service.saveandrestore.NodeNotFoundException;
@@ -59,7 +60,10 @@ public class ComparisonController extends BaseController {
      * comparison evaluates to "equal" for a PV.
      */
     @GetMapping(value = "/{nodeId}", produces = JSON)
-    public List<CompareResult> compare(@PathVariable String nodeId, @RequestParam(value = "tolerance", required = false, defaultValue = "0") double tolerance) {
+    public List<CompareResult> compare(@PathVariable String nodeId,
+                                       @RequestParam(value = "tolerance", required = false, defaultValue = "0") double tolerance,
+                                       @RequestParam(value = "comparisonMode", required = false, defaultValue = "ABSOLUTE") PvCompareMode pvCompareMode,
+                                       @RequestParam(value = "skipReadback", required = false, defaultValue = "false") boolean skipReadback) {
         if(tolerance < 0){
             throw new IllegalArgumentException("Tolerance must be >=0");
         }
@@ -69,9 +73,9 @@ public List<CompareResult> compare(@PathVariable String nodeId, @RequestParam(va
         }
         switch (node.getNodeType()) {
             case SNAPSHOT:
-                return snapshotUtil.comparePvs(getSnapshotItems(node.getUniqueId()), tolerance);
+                return snapshotUtil.comparePvs(getSnapshotItems(node.getUniqueId()), tolerance, pvCompareMode, skipReadback);
             case COMPOSITE_SNAPSHOT:
-                return snapshotUtil.comparePvs(getCompositeSnapshotItems(node.getUniqueId()), tolerance);
+                return snapshotUtil.comparePvs(getCompositeSnapshotItems(node.getUniqueId()), tolerance, pvCompareMode, skipReadback);
             default:
                 throw new IllegalArgumentException("Node type" + node.getNodeType() + " cannot be compared");
         }