Add VM cache scanning script

Signed-off-by: Tu Dinh <ngoc-tu.dinh@vates.tech>

Author: dinhngtu

scripts/scan_cache.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python3
+
+import contextlib
+import re
+
+import XenAPI
+
+# Scan the current pool for test images that are not described in vm_data.py.
+# Deleting them is up to the user.
+
+
+@contextlib.contextmanager
+def xapi_session(uname="root", pwd=""):
+    session = XenAPI.xapi_local()
+    session.xenapi.login_with_password(uname, pwd, XenAPI.API_VERSION_1_2, "scan_cache.py")
+    try:
+        yield session
+    finally:
+        session.xenapi.logout()
+
+
+def strip_suffix(string, suffix):
+    if string.endswith(suffix):
+        return string[: -len(suffix)]
+    return string
+
+
+def get_cache_url(vm):
+    if type(vm) is tuple:
+        url = vm[1]
+    else:
+        url = vm
+    return strip_suffix(url, '.xva')
+
+
+def get_image_urls():
+    from vm_data import VMS
+
+    image_urls = set()
+    for vm in dict(VMS["single"]).values():
+        image_urls.add(get_cache_url(vm))
+    for vms in dict(VMS["multi"]).values():
+        for vm in vms:
+            image_urls.add(get_cache_url(vm))
+    return image_urls
+
+
+def get_vm_type(session, vm_ref):
+    vm_type = "VM"
+    if session.xenapi.VM.get_is_control_domain(vm_ref):
+        vm_type = "control domain"
+    elif session.xenapi.VM.get_is_default_template(vm_ref):
+        vm_type = "default template"
+    elif session.xenapi.VM.get_is_a_snapshot(vm_ref):
+        vm_type = "snapshot"
+    elif session.xenapi.VM.get_is_a_template(vm_ref):
+        vm_type = "template"
+    return vm_type
+
+
+def main():
+    image_urls = get_image_urls()
+
+    with xapi_session() as session:
+        for vm_ref in session.xenapi.VM.get_all():
+            if get_vm_type(session, vm_ref) != "VM":
+                continue
+            description = session.xenapi.VM.get_name_description(vm_ref)
+            m = re.match(r'\[Cache for (.*)\]', description)
+            if not m:
+                continue
+            current_url = m.group(1)
+            if current_url in image_urls:
+                continue
+            uuid = session.xenapi.VM.get_uuid(vm_ref)
+            label = session.xenapi.VM.get_name_label(vm_ref)
+            print(f"{uuid} {label} {description}")
+
+
+if __name__ == "__main__":
+    main()