From 5e3ad22eea2ae3ccb1a7185416382afb714d551a Mon Sep 17 00:00:00 2001
From: Haijiao Zhao <haizhao@redhat.com>
Date: Tue, 13 Jun 2023 05:28:28 -0400
Subject: [PATCH] Add case of save-image-dumpxml

- VIRT-297301 - Dumpxml from saved file by save-image-dumpxml cmd

Signed-off-by: Haijiao Zhao <haizhao@redhat.com>
---
 .../save_and_restore/save_image_dumpxml.cfg   |  27 +++++
 .../save_and_restore/save_image_dumpxml.py    | 107 ++++++++++++++++++
 2 files changed, 134 insertions(+)
 create mode 100644 libvirt/tests/cfg/save_and_restore/save_image_dumpxml.cfg
 create mode 100644 libvirt/tests/src/save_and_restore/save_image_dumpxml.py

diff --git a/libvirt/tests/cfg/save_and_restore/save_image_dumpxml.cfg b/libvirt/tests/cfg/save_and_restore/save_image_dumpxml.cfg
new file mode 100644
index 0000000000..21c4054970
--- /dev/null
+++ b/libvirt/tests/cfg/save_and_restore/save_image_dumpxml.cfg
@@ -0,0 +1,27 @@
+- save_and_restore.save_image_dumpxml:
+    type = save_image_dumpxml
+    start_vm = no
+    variants scenario:
+        - no_opt:
+            options =
+            check_sec = yes
+            expect_graph_pw = no
+        - security_info_opt:
+            options = --security-info
+            check_sec = yes
+            expect_graph_pw = yes
+        - xpath_opt:
+            options = --xpath
+            check_os = yes
+            variants:
+                - default:
+                    options += ' //os'
+                - wrap:
+                    options += ' //os --wrap'
+    variants mode:
+        - readonly:
+            only no_opt, security_info_opt
+            virsh_options = ' -r'
+            status_error = yes
+            error_msg = 'read only access prevents virDomainSaveImageGetXMLDesc'
+        - normal:
diff --git a/libvirt/tests/src/save_and_restore/save_image_dumpxml.py b/libvirt/tests/src/save_and_restore/save_image_dumpxml.py
new file mode 100644
index 0000000000..bc0faae035
--- /dev/null
+++ b/libvirt/tests/src/save_and_restore/save_image_dumpxml.py
@@ -0,0 +1,107 @@
+import logging
+import os
+
+from virttest import utils_misc
+from virttest import virsh
+from virttest.libvirt_xml import base
+from virttest.libvirt_xml import vm_xml
+from virttest.utils_test import libvirt
+
+LOG = logging.getLogger('avocado.test.' + __name__)
+VIRSH_ARGS = {'debug': True, 'ignore_status': False}
+
+
+def check_graph_passwd(test, output, passwd, expect=True):
+    """
+    Check whether output meets expectation
+
+    :param test: test instance
+    :param output: output string
+    :param passwd: passwd to check
+    :param expect: expect or not, defaults to True
+    """
+    expect_prefix = "" if expect else "not"
+    found = passwd in output
+    actual_prefix = "" if found else "not"
+    msg = f'Expect {expect_prefix} found graphic password, '\
+          f'actually {actual_prefix} found it.'
+    if found == expect:
+        LOG.debug(msg)
+    else:
+        test.fail(msg)
+
+
+def check_osxml(test, vmxml, output, wrap):
+    """
+    Check whether os xml equals to the output
+
+    :param test: test instance
+    :param vmxml: vmxml instance
+    :param output: output string
+    :param wrap: wrap or not
+    """
+    if wrap:
+        wrap_xml = base.LibvirtXMLBase()
+        wrap_xml.xml = output
+        children = list(wrap_xml.xmltreefile.get_parent_map('nodes').keys())
+        if len(children) != 1:
+            test.fail('Found more than 1 elements in wrapped xml, '
+                      'there should only be "os"')
+    osxml = vmxml.os
+    dump_osxml = vm_xml.VMOSXML()
+    dump_osxml.xml = wrap_xml.get_section_string('/os') if wrap else output
+
+    if osxml == dump_osxml:
+        LOG.debug('osxml is identical with the output of save-image-dumpxml')
+    else:
+        test.fail('osxml changed after save-image-dumpxml')
+
+
+def run(test, params, env):
+    """
+    Test virsh save-image-dumpxml with options
+    """
+    vm_name = params.get('main_vm')
+    vm = env.get_vm(vm_name)
+
+    status_error = "yes" == params.get('status_error', 'no')
+    error_msg = params.get('error_msg', '')
+    virsh_options = params.get('virsh_options', '')
+    options = params.get('options', '')
+    rand_id = utils_misc.generate_random_string(3)
+    save_path = f'/var/tmp/{vm_name}_{rand_id}.save'
+    graph_passwd = utils_misc.generate_random_string(6)
+    expect_graph_pw = 'yes' == params.get('expect_graph_pw')
+    check_sec = 'yes' == params.get('check_sec')
+    check_os = 'yes' == params.get('check_os')
+
+    vmxml = vm_xml.VMXML.new_from_inactive_dumpxml(vm_name)
+    bkxml = vmxml.copy()
+
+    try:
+        vm_xml.VMXML.set_graphics_attr(vm_name, {'passwd': graph_passwd})
+
+        vm.start()
+        vm.wait_for_login().close()
+
+        virsh.save(vm_name, save_path, **VIRSH_ARGS)
+        result = virsh.save_image_dumpxml(save_path, options=options,
+                                          debug=True, virsh_opt=virsh_options)
+        libvirt.check_exit_status(result, status_error)
+        if status_error:
+            libvirt.check_result(result, error_msg)
+
+        else:
+            output_xml = result.stdout_text
+            if check_sec:
+                check_graph_passwd(test, output_xml, graph_passwd,
+                                   expect_graph_pw)
+
+            if check_os:
+                wrap = True if '--wrap' in options else False
+                check_osxml(test, vmxml, output_xml, wrap)
+
+    finally:
+        bkxml.sync()
+        if os.path.exists(save_path):
+            os.remove(save_path)