[gnome-boxes/wip/automated-tests: 17/19] tests: Backup existing VMs before execution

[Zeeshan Ali Khattak <zeeshanak src gnome org>]

commit 54b85af318e29f1671ba24c039d3ad6d3c512491
Author: Vladimir Benes <vbenes redhat com>
Date:   Fri Jan 9 09:55:54 2015 -0500

    tests: Backup existing VMs before execution
    
    Existing VMs along with their saved states and snaphots, and sources are
    now moved away (instead of deletion) prior to test batch execution and
    restored after wards.
    
    Warning and manual restore howto are also added into README file.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=736288

 tests/README         |   14 +++++-
 tests/environment.py |  101 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+), 3 deletions(-)
---
diff --git a/tests/README b/tests/README
index 6a7cf05..1b9695c 100644
--- a/tests/README
+++ b/tests/README
@@ -5,6 +5,17 @@ Tests for GNOME 3 Boxes application. Tests are written in python using Behave [1
 and Dogtail [2] frameworks. Tests are divided into several feature files and can
 be executed accordingly.
 
+Warning
+=======
+
+All existing VMs and brokers are deleted prior to execution of test batch and
+are restored after wards.
+
+Do not interrupt running tests as such action may corrupt VM restoration. If
+that happens all data are stored in ~/boxes_backup and have to be imported
+manually. Steps to import can be found in environment.py in after_all()
+function.
+
 Structure
 =========
 
@@ -72,9 +83,6 @@ Requirements
 Execution
 =========
 
-WARNING: These tests are designed to run in a prestine test environment and to
-         that end, remove all your VMs.
-
 * in tests directory run:
   * behave
   to run full test set
diff --git a/tests/environment.py b/tests/environment.py
index 3da67a5..3b41870 100644
--- a/tests/environment.py
+++ b/tests/environment.py
@@ -64,6 +64,56 @@ def before_all(context):
     except Exception as e:
         print "Error in before_all: %s" % e.message
 
+    f = open(os.devnull, "w")
+
+    try:
+        call("mkdir ~/boxes_backup", shell=True)
+
+        print "** Backing up session machines"
+
+        # First ensure all boxes are shutdown
+        call("for i in $(virsh list --all|tail -n +3|head -n -1|sed -e 's/^ \(-\|[0-9]\+\) *//'|cut -d' ' 
-f1); do " +
+             "    virsh destroy $i; done", shell=True, stdout=f, stderr=f)
+
+        # copy configuration XML of all machines
+        call("for i in $(virsh list --all|tail -n +3|head -n -1|sed -e 's/^ \(-\|[0-9]\+\) *//'|cut -d' ' 
-f1); do " +
+             "    virsh dumpxml $i > ~/boxes_backup/$i.xml; done", shell=True, stdout=f)
+
+        # move disk images
+        call("mkdir ~/boxes_backup/images", shell=True)
+        call("mv ~/.local/share/gnome-boxes/images/* ~/boxes_backup/images/ || true", shell=True, stderr=f)
+
+        # Backup snapshots
+        call("mkdir ~/boxes_backup/snapshot", shell=True)
+        call("cp -R ~/.config/libvirt/qemu/snapshot/* ~/boxes_backup/snapshot/ || true", shell=True, 
stderr=f)
+
+        # now remove all snapshots
+        call("for i in $(virsh list --all|tail -n +3|head -n -1|sed -e 's/^ \(-\|[0-9]\+\) *//'|cut -d' ' 
-f1); do " +
+             "    for j in $(virsh snapshot-list $i|tail -n +3|head -n -1|sed 's/^ //'|cut -d' ' -f1); do " +
+             "        virsh snapshot-delete $i $j|| true; done; done", shell=True, stdout=f)
+
+        # move save states
+        call("mkdir ~/boxes_backup/save", shell=True)
+        call("mv ~/.config/libvirt/qemu/save/* ~/boxes_backup/save/ || true", shell=True, stderr=f)
+
+        # move all sources
+        print "** Backing up all sources"
+
+        call("mkdir ~/boxes_backup/sources", shell=True)
+        call("mv ~/.cache/gnome-boxes/sources/* ~/boxes_backup/sources/ || true", shell=True, stderr=f)
+
+        # create marker
+        call('touch /tmp/boxes_backup', shell=True)
+        print "* Done\n"
+
+    except Exception as e:
+        print "Error in backup: %s" % e.message
+
+    # Undefine all boxes
+    call("for i in $(virsh list --all|tail -n +3|head -n -1|sed -e 's/^ \(-\|[0-9]\+\) *//'|cut -d' ' -f1); 
do " +
+         "    virsh undefine --managed-save $i; done", shell=True, stdout=f)
+    f.close()
+
 def before_scenario(context, scenario):
     pass
 
@@ -122,6 +172,13 @@ def after_scenario(context, scenario):
     """
 
     try:
+        # Remove qemu____system to avoid deleting system broker machines
+        for tag in scenario.tags:
+            if 'system_broker' in tag:
+                call("rm -rf ~/.cache/gnome-boxes/sources/qemu____system", shell=True)
+                context.app_class.quit()
+                context.app_class = App('gnome-boxes')
+                context.app = context.app_class.startViaCommand()
 
         # Attach journalctl logs
         if hasattr(context, "embed"):
@@ -173,3 +230,47 @@ def after_scenario(context, scenario):
         # Stupid behave simply crashes in case exception has occurred
         print "Error in after_scenario: %s" % e.message
 
+def after_all(context):
+    if not os.path.isfile('/tmp/boxes_backup'):
+        return
+
+    f = open(os.devnull, "w")
+
+    print "** Restoring Boxes backup"
+    # move images back
+    call("mv ~/boxes_backup/images/* ~/.local/share/gnome-boxes/images/", shell=True)
+
+    # move save states back
+    call("mv ~/boxes_backup/save/* ~/.config/libvirt/qemu/save/", shell=True, stdout=f)
+
+    # import machines
+    call("for i in $(ls ~/boxes_backup |grep xml); do virsh define ~/boxes_backup/$i; done", shell=True, 
stdout=f)
+
+    # import snapshots
+    # IFS moved to _ as snapshots have spaces in names
+    # there are two types of snapshots running/shutoff
+    # so we need to import each typo into different state running vs shutted down
+    call("export IFS='_'; cd ~/boxes_backup/snapshot/; \
+          for i in * ; do\
+              for s in $i/*.xml; \
+                  do virsh snapshot-create $i ~/boxes_backup/snapshot/$s; \
+              done; \
+              virsh start $i; \
+              for s in $i/*.xml; \
+                  do virsh snapshot-create $i ~/boxes_backup/snapshot/$s; \
+              done; \
+              virsh save $i ~/.config/libvirt/qemu/save/$i.save ; \
+              cd -; \
+              done", shell=True, stdout=f, stderr=f)
+
+    call("mv ~/boxes_backup/sources/* ~/.cache/gnome-boxes/sources/", shell=True, stdout=f)
+
+    # delete marker
+    call("rm -rf /tmp/boxes_backup", shell=True, stdout=f)
+
+    # delete backup
+    call("rm -rf ~/boxes_backup", shell=True, stdout=f)
+
+    print "* Done\n"
+
+    f.close()