You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
virt/engine/tests/test_frontend_page_layout.py

201 lines
8.5 KiB
Python

"""Keep VM creation and reinstall in the dashboard, not in modal dialogs."""
from __future__ import annotations
from collections import defaultdict
from dataclasses import dataclass
from html.parser import HTMLParser
from pathlib import Path
import pytest
STATIC_DIR = Path(__file__).resolve().parents[1] / "static"
VOID_TAGS = {
"area", "base", "br", "col", "embed", "hr", "img", "input",
"link", "meta", "param", "source", "track", "wbr",
}
@dataclass(frozen=True)
class Element:
tag: str
attrs: dict[str, str | None]
ancestors: tuple[Element, ...]
@property
def element_id(self) -> str | None:
return self.attrs.get("id")
class PageParser(HTMLParser):
def __init__(self) -> None:
super().__init__(convert_charrefs=True)
self.stack: list[Element] = []
self.elements: list[Element] = []
def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None:
element = Element(tag, dict(attrs), tuple(self.stack))
self.elements.append(element)
if tag not in VOID_TAGS:
self.stack.append(element)
def handle_startendtag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None:
self.elements.append(Element(tag, dict(attrs), tuple(self.stack)))
def handle_endtag(self, tag: str) -> None:
for index in range(len(self.stack) - 1, -1, -1):
if self.stack[index].tag == tag:
del self.stack[index:]
return
@pytest.fixture(scope="module")
def page() -> tuple[list[Element], dict[str, list[Element]]]:
parser = PageParser()
parser.feed((STATIC_DIR / "index.html").read_text(encoding="utf-8"))
assert not parser.stack, "Unclosed HTML element in the dashboard page"
by_id: dict[str, list[Element]] = defaultdict(list)
for element in parser.elements:
if element.element_id:
by_id[element.element_id].append(element)
return parser.elements, by_id
@pytest.mark.parametrize("prefix", ["create", "reinstall"])
def test_vm_form_is_a_dashboard_page_not_a_modal(page, prefix: str) -> None:
_, by_id = page
forms = by_id[f"{prefix}-form"]
assert len(forms) == 1
form = forms[0]
assert form.tag == "form"
ancestor_ids = {ancestor.element_id for ancestor in form.ancestors}
assert {"dashboard-view", "vm-workspace", f"{prefix}-view"} <= ancestor_ids
for element in (*form.ancestors, form):
assert element.tag != "dialog"
assert element.attrs.get("role") != "dialog"
assert "modal-backdrop" not in (element.attrs.get("class") or "").split()
back_buttons = by_id[f"{prefix}-back"]
assert len(back_buttons) == 1
assert back_buttons[0].tag == "button"
assert f"{prefix}-view" in {
ancestor.element_id for ancestor in back_buttons[0].ancestors
}
def test_old_vm_modal_elements_and_js_references_are_removed(page) -> None:
_, by_id = page
script = (STATIC_DIR / "app.js").read_text(encoding="utf-8")
for element_id in ("create-modal", "reinstall-modal"):
assert element_id not in by_id
assert element_id not in script
def test_every_html_id_is_unique(page) -> None:
_, by_id = page
duplicates = sorted(element_id for element_id, elements in by_id.items() if len(elements) > 1)
assert duplicates == []
def test_rescue_iso_pool_is_a_distinct_host_setting(page) -> None:
_, by_id = page
rescue_pool = by_id["host-rescue-iso-pool"][0]
assert rescue_pool.tag == "input"
assert rescue_pool.attrs["name"] == "rescue_iso_pool"
assert "required" not in rescue_pool.attrs # Existing installations can configure it later.
assert "host-form" in {ancestor.element_id for ancestor in rescue_pool.ancestors}
assert "rescue-templates-workspace" in {
ancestor.element_id for ancestor in by_id["rescue-directory-note"][0].ancestors
}
html = (STATIC_DIR / "index.html").read_text(encoding="utf-8")
assert "面板只注册已存在的目录,不会自动创建" in html
assert "不会出现在创建虚拟机的安装 ISO 列表中" in html
script = (STATIC_DIR / "app.js").read_text(encoding="utf-8")
assert 'byId("host-rescue-iso-pool").value = configured ? (hostConfig.rescue_iso_pool || "") : "";' in script
assert 'rescue_iso_pool: rescueIsoPool' in script
assert 'rescueIsoPool && rescueIsoPool === isoPool' in script
assert '"host-iso-pool", "host-rescue-iso-pool", "host-network"' in script
assert 'text("rescue-directory-note", rescueIsoPool' in script
def test_rescue_pages_are_separate_dashboard_pages(page) -> None:
_, by_id = page
rescue = by_id["rescue-view"][0]
assert {ancestor.element_id for ancestor in rescue.ancestors} >= {
"dashboard-view", "vm-workspace",
}
assert "hidden" in rescue.attrs
form = by_id["rescue-form"][0]
assert "rescue-view" in {ancestor.element_id for ancestor in form.ancestors}
assert "modal-backdrop" not in {
token
for ancestor in (*form.ancestors, form)
for token in (ancestor.attrs.get("class") or "").split()
}
catalog = by_id["rescue-templates-workspace"][0]
assert "dashboard-view" in {ancestor.element_id for ancestor in catalog.ancestors}
assert "hidden" in catalog.attrs
upload = by_id["rescue-template-upload-form"][0]
assert "rescue-templates-workspace" in {
ancestor.element_id for ancestor in upload.ancestors
}
assert by_id["rescue-template-file"][0].attrs["type"] == "file"
def test_rescue_frontend_uses_streaming_upload_and_job_status(page) -> None:
_, by_id = page
assert by_id["rescue-templates-button"][0].tag == "button"
assert by_id["rescue-templates-mobile-button"][0].tag == "button"
script = (STATIC_DIR / "app.js").read_text(encoding="utf-8")
assert '"rescue-templates-button", "rescue-templates-mobile-button"' in script
assert 'rawBody: file, contentType: "application/octet-stream"' in script
assert "file.text()" not in script.split(
'byId("rescue-template-upload-form").addEventListener', 1
)[1].split("async function startRescueVmAction", 1)[0]
assert '"/api/v1/rescue-templates"' in script
assert '/rescue/exit`' in script
assert 'pollRescueImport(jobId' in script
assert 'pollVmRescueJob(jobId' in script
assert 'actionButton("紧急救援"' in script
assert 'const rescueMode = vm.rescue_mode === true;' in script
assert 'const rescueStaged = vm.rescue_staged === true;' in script
assert 'const rescueGuard = rescueMode || rescueStaged;' in script
assert 'typeof job.warning === "string"' in script
html = (STATIC_DIR / "index.html").read_text(encoding="utf-8")
assert "救援系统的登录方式和密码由该 ISO 自身决定" in html
def test_rescue_timeout_advises_manual_power_cycle_only_when_iso_is_staged(page) -> None:
_, by_id = page
assert "rescue-view" in by_id
script = (STATIC_DIR / "app.js").read_text(encoding="utf-8")
html = (STATIC_DIR / "index.html").read_text(encoding="utf-8")
assert "正常关机失败或超时" in html
assert "只有救援页显示“已预挂载”时" in html
assert "点击“强制重启进入救援”" in html
assert "强制断电并冷启动" in html
assert "“强制重置”不保证读取新保存的启动配置" in html
assert "若预挂载未成功,请先核查错误" in html
assert 'shutdownFailed && job.operation === "enter"' in script
assert 'shutdownFailed && job.operation === "exit"' in script
assert 'current?.staged === true && job.operation === "enter"' in script
assert 'state.rescueStaged = result?.staged === true;' in script
assert 'state.rescuePowerState = String(result?.power_state || "unknown");' in script
assert 'job.pending_manual_restart === true' in script
assert "正常关机失败或超时,救援 ISO 已预挂载但尚未进入救援系统" in script
assert '/rescue/force-start`' in script
assert 'ack_data_loss: true' in script
assert 'byId("rescue-force-start").addEventListener' in script
assert by_id["rescue-force-start"][0].attrs["type"] == "button"
assert 'disabled: busy || (rescueMode && !rescueStaged)' in script
assert 'title: rescueStaged ? "从已预挂载的救援 ISO 开机"' in script
assert "“强制重置”不保证读取新启动配置" in script
assert "面板不会自动强制断电" in script
assert 'else if (shuttingDown)' in script
assert '() => openConfirm(vm, "poweroff")' in script
assert "客服" not in html
assert "客服" not in script