mirror of
https://github.com/retspen/webvirtcloud
synced 2026-11-08 11:16:47 +00:00
3730a95c02
Found by review (Codex and agy) of the XML editor's dialog: - A busy or moved VM made the page reload and the edit was lost. The dialog's requests now get these answers as JSON (X-Requested-With, as the create page's flavor forms) and show them; any other failure says the edit is still in the editor. - libvirt finds the VM to define by the XML's UUID: another VM's UUID overwrote that VM past its lock, a new or missing one added a VM. The XML must keep this VM's UUID; a malformed one is refused with the parser's error, as on the create page. - Save sends the XML whose diff the dialog shows, also when two previews answer out of order; a failed save keeps the diff and Save. - The edited XML is defined with the line breaks libvirt gave, not the form's CRLF, and the VM's state is read before the definition, so a failed read cannot turn a saved change into an error.
124 lines
6.5 KiB
Python
124 lines
6.5 KiB
Python
from unittest.mock import patch
|
|
|
|
from computes.models import Compute
|
|
from django.contrib.auth import get_user_model
|
|
from django.contrib.messages import get_messages
|
|
from django.test import TestCase
|
|
from django.urls import reverse
|
|
from instances.models import Instance
|
|
from libvirt import libvirtError
|
|
from vrtManager.instance import PERSISTENT_XML
|
|
from logs.models import Logs
|
|
from operations import claims
|
|
|
|
UUID = "11111111-2222-3333-4444-888888888888"
|
|
CURRENT = f"<domain>\n <name>xml-vm</name>\n <uuid>{UUID}</uuid>\n <memory>1024</memory>\n</domain>"
|
|
LIVE = f"<domain id='3'>\n <name>xml-vm</name>\n <uuid>{UUID}</uuid>\n <memory>512</memory>\n</domain>"
|
|
EDITED = CURRENT.replace("1024", "2048")
|
|
|
|
|
|
class ChangeXmlTestCase(TestCase):
|
|
"""The XML editor shows what a change does before it is saved, and saves
|
|
only over the definition it was opened with: the persistent one, which a
|
|
running VM uses at its next start."""
|
|
|
|
def setUp(self):
|
|
self.client.force_login(get_user_model().objects.create_superuser("xml_admin", "x@example.com", "pw"))
|
|
compute = Compute.objects.create(name="xml-compute", hostname="127.0.0.1", login="", password="", type=4)
|
|
self.instance = Instance.objects.create(compute=compute, name="xml-vm", uuid=UUID)
|
|
|
|
def post(self, status=5, xml=EDITED, base=CURRENT, confirm=False, define_error=None):
|
|
data = {"inst_xml": xml, "base": base}
|
|
if confirm:
|
|
data["confirm"] = "1"
|
|
with patch("instances.models.wvmInstance") as wvm:
|
|
wvm.return_value.get_status.return_value = status
|
|
wvm.return_value._XMLDesc.side_effect = lambda flags: CURRENT if flags == PERSISTENT_XML else LIVE
|
|
wvm.return_value._defineXML.side_effect = define_error
|
|
response = self.client.post(reverse("instances:change_xml", args=[self.instance.id]), data)
|
|
return response, wvm.return_value._defineXML
|
|
|
|
def test_without_confirm_the_change_is_shown_not_saved(self):
|
|
response, define = self.post()
|
|
define.assert_not_called()
|
|
diff = response.json()["diff"]
|
|
self.assertIn("- <memory>1024</memory>", diff)
|
|
self.assertIn("+ <memory>2048</memory>", diff)
|
|
|
|
def test_an_unchanged_definition_shows_no_difference(self):
|
|
response, _ = self.post(xml=CURRENT)
|
|
self.assertEqual(response.json()["diff"], [])
|
|
|
|
def test_a_confirmed_change_is_saved_and_logged(self):
|
|
response, define = self.post(confirm=True)
|
|
define.assert_called_once_with(EDITED)
|
|
self.assertEqual(response.json(), {"saved": True})
|
|
self.assertIn("XML", " ".join(str(m) for m in get_messages(response.wsgi_request)))
|
|
row = Logs.objects.get(instance_uuid=self.instance.uuid)
|
|
self.assertEqual((row.message, row.success), ("VM xml-vm: change XML", True))
|
|
|
|
def test_a_definition_changed_since_the_editor_opened_is_not_overwritten(self):
|
|
for confirm in (False, True):
|
|
with self.subTest(confirm=confirm):
|
|
response, define = self.post(base="<domain>older</domain>", confirm=confirm)
|
|
define.assert_not_called()
|
|
self.assertEqual(response.status_code, 409)
|
|
self.assertIn("changed since", response.json()["error"])
|
|
|
|
def test_a_definition_libvirt_refuses_comes_back_with_the_reason(self):
|
|
response, define = self.post(confirm=True, define_error=libvirtError("unsupported configuration: bad memory"))
|
|
self.assertEqual(response.status_code, 400)
|
|
self.assertIn("bad memory", response.json()["error"])
|
|
row = Logs.objects.get(instance_uuid=self.instance.uuid)
|
|
self.assertEqual((row.message, row.success), ("VM xml-vm: change XML: unsupported configuration: bad memory", False))
|
|
|
|
def test_a_running_or_paused_vm_gets_the_definition_for_its_next_start(self):
|
|
for status in (1, 3):
|
|
with self.subTest(status=status):
|
|
response, define = self.post(status, confirm=True)
|
|
define.assert_called_once_with(EDITED)
|
|
self.assertIn("next start", " ".join(str(m) for m in get_messages(response.wsgi_request)))
|
|
|
|
def test_the_line_breaks_a_form_posts_are_the_same_definition(self):
|
|
response, _ = self.post(base=CURRENT.replace("\n", "\r\n"))
|
|
self.assertEqual(response.status_code, 200)
|
|
|
|
def test_an_empty_definition_is_refused(self):
|
|
response, define = self.post(xml=" ", confirm=True)
|
|
define.assert_not_called()
|
|
self.assertEqual(response.status_code, 400)
|
|
|
|
def test_a_busy_vm_answers_the_dialog_so_the_edit_stays(self):
|
|
# the dialog's script sends X-Requested-With; a page form gets the redirect
|
|
with patch("instances.views.libvirt_instance_lock", side_effect=claims.Busy("instance:xml-vm")), \
|
|
patch("instances.models.wvmInstance") as wvm:
|
|
url = reverse("instances:change_xml", args=[self.instance.id])
|
|
data = {"inst_xml": EDITED, "base": CURRENT, "confirm": "1"}
|
|
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH="XMLHttpRequest")
|
|
self.assertEqual(response.status_code, 409)
|
|
self.assertIn("try again", response.json()["detail"])
|
|
self.assertEqual(list(get_messages(response.wsgi_request)), [])
|
|
self.assertEqual(self.client.post(url, data).status_code, 302)
|
|
wvm.return_value._defineXML.assert_not_called()
|
|
|
|
def test_the_xml_must_keep_the_vms_uuid(self):
|
|
# libvirt finds the VM to define by the XML's UUID: another VM's would
|
|
# overwrite that VM, a new or missing one would add a VM
|
|
other = CURRENT.replace(UUID, "99999999-2222-3333-4444-888888888888")
|
|
for xml in (other, CURRENT.replace(f" <uuid>{UUID}</uuid>\n", "")):
|
|
for confirm in (False, True):
|
|
with self.subTest(xml=xml, confirm=confirm):
|
|
response, define = self.post(xml=xml, confirm=confirm)
|
|
define.assert_not_called()
|
|
self.assertEqual(response.status_code, 400)
|
|
self.assertIn(UUID, response.json()["error"])
|
|
|
|
def test_a_malformed_xml_is_refused_with_the_parser_error(self):
|
|
response, define = self.post(xml="<domain><name>xml-vm</domain>", confirm=True)
|
|
define.assert_not_called()
|
|
self.assertEqual(response.status_code, 400)
|
|
self.assertIn("not well-formed", response.json()["error"])
|
|
|
|
def test_the_edited_xml_is_defined_with_the_line_breaks_libvirt_gave(self):
|
|
_, define = self.post(xml=EDITED.replace("\n", "\r\n"), confirm=True)
|
|
define.assert_called_once_with(EDITED)
|