CA-414438 Defend against unexpected VDI name_description contents

It seems to be possible for a description field on an LV snapshot to be
converted to a dictionary, which results in attempts to remove it from
the MGT volume failing after it is deleted, which in turn results in a
subsequent scan failing because an LV which should exist does not.

It is not immediately clear how this ended up as a dictionary as it has
been back and forth through XMLRPC a few times, but to solve the
immediate issue, defend against such things.

Signed-off-by: Tim Smith <[email protected]>

Author: Tim Smith

libs/sm/core/util.py

@@ -116,8 +116,9 @@ def roundup(divisor, value):
 def to_plain_string(obj):
     if obj is None:
         return None
-    if type(obj) == str:
-        return obj
+    if isinstance(obj, dict) and len(obj) == 0:
+        SMlog(f"util.to_plain_string() corrected empty dict to empty str")
+        return ""
     return str(obj)
 
 

libs/sm/srmetadata.py

@@ -712,8 +712,8 @@ def getVdiInfo(self, Dict, generateSector=0):
             # which will be called by all classes
             # and one specific to this class
             if generateSector == 1 or generateSector == 0:
-                label = xml.sax.saxutils.escape(Dict[NAME_LABEL_TAG])
-                desc = xml.sax.saxutils.escape(Dict[NAME_DESCRIPTION_TAG])
+                label = xml.sax.saxutils.escape(util.to_plain_string(Dict[NAME_LABEL_TAG]))
+                desc = xml.sax.saxutils.escape(util.to_plain_string(Dict[NAME_DESCRIPTION_TAG]))
                 label_length = len(to_utf8(label))
                 desc_length = len(to_utf8(desc))