From 19659d839c58c108c3e3c7459380c70fb6a40c4a Mon Sep 17 00:00:00 2001
From: Peter Krempa <pkrempa@redhat.com>
Date: Wed, 31 Mar 2021 09:18:57 +0200
Subject: [PATCH] virTestCompareToFile: Add possibility to skip unwrapping of
 input file
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

In some cases we might want to compare already wrapped data against a
wrapped file. Introduce virTestCompareToFileFull with a 'unwrap' boolean
which will control the unwrapping.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
---
 tests/testutils.c | 46 +++++++++++++++++++++++++++++++++++-----------
 tests/testutils.h |  3 +++
 2 files changed, 38 insertions(+), 11 deletions(-)

diff --git a/tests/testutils.c b/tests/testutils.c
index 6b104405f7..0f6b3a9705 100644
--- a/tests/testutils.c
+++ b/tests/testutils.c
@@ -352,6 +352,7 @@ virTestRewrapFile(const char *filename)
  * @param actual: actual output text
  * @param actualName: name designator of the actual text
  * @param regenerate: enable or disable regenerate functionality
+ * @param rewrap: enable or disable rewrapping when regenerating
  *
  * Display expected and actual output text, trimmed to first and last
  * characters at which differences occur. Displays names of the text strings if
@@ -363,7 +364,8 @@ virTestDifferenceFullInternal(FILE *stream,
                               const char *expectName,
                               const char *actual,
                               const char *actualName,
-                              bool regenerate)
+                              bool regenerate,
+                              bool rewrap)
 {
     const char *expectStart;
     const char *expectEnd;
@@ -386,7 +388,8 @@ virTestDifferenceFullInternal(FILE *stream,
             return -1;
         }
 
-        if (virTestRewrapFile(expectName) < 0) {
+        if (rewrap &&
+            virTestRewrapFile(expectName) < 0) {
             virDispatchError(NULL);
             return -1;
         }
@@ -454,7 +457,7 @@ virTestDifferenceFull(FILE *stream,
                       const char *actualName)
 {
     return virTestDifferenceFullInternal(stream, expect, expectName,
-                                         actual, actualName, true);
+                                         actual, actualName, true, true);
 }
 
 /**
@@ -477,7 +480,7 @@ virTestDifferenceFullNoRegenerate(FILE *stream,
                                   const char *actualName)
 {
     return virTestDifferenceFullInternal(stream, expect, expectName,
-                                         actual, actualName, false);
+                                         actual, actualName, false, false);
 }
 
 /**
@@ -566,12 +569,14 @@ int virTestDifferenceBin(FILE *stream,
 /*
  * @param actual: String input content
  * @param filename: File to compare @actual against
+ * @param unwrap: Remove '\\\n' sequences from file content before comparison
  *
  * If @actual is NULL, it's treated as an empty string.
  */
 int
-virTestCompareToFile(const char *actual,
-                     const char *filename)
+virTestCompareToFileFull(const char *actual,
+                         const char *filename,
+                         bool unwrap)
 {
     g_autofree char *filecontent = NULL;
     g_autofree char *fixedcontent = NULL;
@@ -580,8 +585,13 @@ virTestCompareToFile(const char *actual,
     if (!cmpcontent)
         cmpcontent = "";
 
-    if (virTestLoadFile(filename, &filecontent) < 0 && !virTestGetRegenerate())
-        return -1;
+    if (unwrap) {
+        if (virTestLoadFile(filename, &filecontent) < 0 && !virTestGetRegenerate())
+            return -1;
+    } else {
+        if (virFileReadAll(filename, INT_MAX, &filecontent) < 0 && !virTestGetRegenerate())
+            return -1;
+    }
 
     if (filecontent) {
         size_t filecontentLen = strlen(filecontent);
@@ -596,15 +606,29 @@ virTestCompareToFile(const char *actual,
     }
 
     if (STRNEQ_NULLABLE(cmpcontent, filecontent)) {
-        virTestDifferenceFull(stderr,
-                              filecontent, filename,
-                              cmpcontent, NULL);
+        virTestDifferenceFullInternal(stderr, filecontent, filename,
+                                      cmpcontent, NULL, true, unwrap);
         return -1;
     }
 
     return 0;
 }
 
+
+/*
+ * @param actual: String input content
+ * @param filename: File to compare @actual against
+ *
+ * If @actual is NULL, it's treated as an empty string.
+ */
+int
+virTestCompareToFile(const char *actual,
+                     const char *filename)
+{
+    return virTestCompareToFileFull(actual, filename, true);
+}
+
+
 int
 virTestCompareToULL(unsigned long long expect,
                     unsigned long long actual)
diff --git a/tests/testutils.h b/tests/testutils.h
index 4a49c1ca65..da8ca2dea5 100644
--- a/tests/testutils.h
+++ b/tests/testutils.h
@@ -63,6 +63,9 @@ int virTestDifferenceBin(FILE *stream,
                          const char *expect,
                          const char *actual,
                          size_t length);
+int virTestCompareToFileFull(const char *actual,
+                             const char *filename,
+                             bool unwrap);
 int virTestCompareToFile(const char *actual,
                          const char *filename);
 int virTestCompareToString(const char *expect,