"""Tests for annual health-check form content and client-side behavior."""
from pathlib import Path
import re
import unittest
ROOT = Path(__file__).resolve().parents[1]
def read_static(name):
"""Return the text of one static asset."""
return (ROOT / "static" / name).read_text(encoding="utf-8")
class HealthCheckFormTests(unittest.TestCase):
def test_form_includes_privacy_notice_and_review_without_save_claim(self):
html = read_static("health-check.html")
self.assertIn('', html)
self.assertIn("Never enter seed phrases", html)
self.assertIn('id="health-check-form"', html)
self.assertIn("Review check", html)
self.assertIn("No data from this form has been stored", html)
def test_form_selects_one_key_and_one_wallet_software(self):
html = read_static("health-check.html")
self.assertIn('id="key-select"', html)
self.assertIn('name="wallet_software"', html)
self.assertIn('id="next-check-preview"', html)
self.assertNotIn("next_check_due", html)
self.assertIn('name="contact_info_verified"', html)
def test_the_form_sections_follow_the_agreed_order(self):
html = read_static("health-check.html")
eyebrows = re.findall(r'
([^<]+)
', html)
# The page heading comes first, and the form is renumbered with
# 04 / Standards gone (section 24.3). The blocked-keys note adds no
# section of its own (section 26.1).
self.assertEqual(
eyebrows,
[
"Annual security check",
"01 / Schedule",
"02 / Key",
"03 / Compatibility",
"04 / External research",
"05 / Contact confirmation",
"06 / Notes",
"Review",
],
)
def test_form_script_covers_the_checklist_fields_and_status_values(self):
script = read_static("health-check.js")
for field in (
"hardware_works",
"address_path",
"seed_backup_verified",
):
self.assertIn(field, script)
for status in ("SECURE", "PATCHED", "VULNERABLE", "COMPROMISED"):
self.assertIn(status, script)
self.assertIn("formatLocalDate", script)
# The summary lists the results that need follow-up. The list of the
# checks that were still awaiting an answer was removed, because the form
# itself already shows what is missing (section 32.2 point 11).
self.assertIn("Results requiring follow-up", script)
self.assertNotIn("Needs assessment", script)
def test_the_bip327_and_slip39_function_is_gone(self):
html = read_static("health-check.html")
script = read_static("health-check.js")
history = read_static("history.js")
# The whole function is removed (section 24.2), so neither the form, the
# script, nor the history view mentions it any more.
self.assertNotIn("BIP327", html)
self.assertNotIn("SLIP39", html)
self.assertNotIn("tool-checks", html)
self.assertNotIn("toolChecks", script)
self.assertNotIn("standardsStatuses", script)
self.assertNotIn("tool_checks", script)
self.assertNotIn("BIP327", history)
self.assertNotIn("tool_checks", history)
def test_form_script_no_longer_uses_the_removed_fields(self):
script = read_static("health-check.js")
for removed in ("seed_backup_status", "address_verified", "derivation_height"):
self.assertNotIn(removed, script)
def test_the_wallet_software_choices_come_from_the_settings_and_the_cloud_keys(self):
script = read_static("health-check.js")
html = read_static("health-check.html")
self.assertIn("walletSoftwareChoices", script)
self.assertIn("renderWalletSoftwareOptions", script)
# The settings list plus the name of every configured cloud key
# (section 25.4).
self.assertIn("/api/settings", script)
self.assertIn("walletSoftwareList", script)
self.assertIn('key.type === "cloud"', script)
self.assertIn("key.name", script)
# The old fixed list and the built-in Sparrow constant are gone from both
# the markup and the script.
self.assertNotIn('option value="Nunchuk"', html)
self.assertNotIn("KEY_PRODUCTS", script)
self.assertNotIn("SPARROW_SOFTWARE", script)
def test_form_script_uses_the_configured_key_name(self):
script = read_static("health-check.js")
self.assertIn("expectedLabels", script)
self.assertIn("key.name", script)
self.assertNotIn("keyProductFor", script)
self.assertNotIn("CLOUD_KEY_NUMBER", script)
def test_form_script_derives_from_availability(self):
script = read_static("health-check.js")
self.assertIn("/api/previous-values", script)
self.assertIn("derivedSummary", script)
self.assertIn("Derived from availability and the address path", script)
self.assertIn('key.type === "cloud"', script)
# The section 20 carry-forward of a third provider is gone (section 23.3).
self.assertNotIn("carriedSecurity", script)
self.assertNotIn("Carried forward from the last saved check", script)
# The cloud key no longer renders the cloud results as form fields, and
# the derived values themselves are gone (section 25.6).
self.assertNotIn('makeField("Cloud health check"', script)
self.assertNotIn('makeField("Provider operational"', script)
self.assertNotIn("cloud_health_status", script)
self.assertNotIn("cloud_provider_operational", script)
def test_form_prefills_the_saved_values_as_input_values(self):
script = read_static("health-check.js")
# A previous value is a real input value, not an HTML placeholder, so an
# untouched field is saved as it stands (section 23.1).
self.assertIn("previousText", script)
self.assertIn("input.value = value", script)
self.assertNotIn("input.placeholder", script)
self.assertIn('previousText(previous, "firmware_version")', script)
# The address path is prefilled from the key profile, because that is the
# stored path it is compared with (section 25.1).
self.assertIn("key.address_path", script)
self.assertIn("updateSoftwareVersionValue", script)
self.assertIn("softwareVersionInput.value = reusable", script)
self.assertIn("previous.wallet_software === walletSoftwareSelect.value", script)
def test_form_requires_an_explicit_compatibility_status(self):
html = read_static("health-check.html")
script = read_static("health-check.js")
self.assertIn('id="software-compatibility"', html)
self.assertIn('', html)
self.assertIn('name="software_compatibility_status" required', html)
self.assertNotIn('value="NOT_ASSESSED"', html)
# The hidden control carries the derived value for the cloud key and is
# not required for a key that was not available (sections 20 and 22).
self.assertIn("softwareCompatibilitySelect.required", script)
self.assertIn("compatibilityDerived", script)
self.assertIn('softwareCompatibilitySelect.value = "OK"', script)
def test_form_requires_hardware_works_and_the_contact_confirmation(self):
html = read_static("health-check.html")
script = read_static("health-check.js")
# Hardware works is a required choice for an available hardware key
# (section 24.1), so the placeholder is not an answer.
self.assertIn("hardwareWorksOptions", script)
self.assertIn('["", "Select status"]', script)
self.assertIn('makeSelect(hardwareWorksOptions, "hardware_works")', script)
self.assertNotIn("booleanOptions", script)
# The required flag is cleared when the key was not available, because a
# hidden required control would block the submission. The address path is
# no longer a field of its own (section 25.1).
self.assertIn('["hardware_works", "seed_backup_verified"]', script)
self.assertNotIn("address_path_verified", script)
# The confirmation is required in the markup, with the same placeholder,
# and it has no "not assessed" value.
self.assertIn('name="contact_info_verified" required', html)
self.assertNotIn("Not assessed", html)
def test_form_asks_about_the_selected_key_holder_and_reminds_about_updates(self):
html = read_static("health-check.html")
script = read_static("health-check.js")
self.assertIn("this key holder's contact details are current?", html)
self.assertIn('', html)
self.assertIn('', html)
self.assertIn("KEY_COUNT = 3", script)
self.assertIn('/api/setup', script)
self.assertIn("collectSetup", script)
self.assertIn("address_path", script)
self.assertIn("_address_path", script)
# The type and the address path are locked once the setup is saved, while
# the name may be changed in the settings (sections 25.1 and 25.2).
self.assertIn("lockForm", script)
self.assertIn("/settings", script)
def test_the_settings_page_has_the_two_sections(self):
html = read_static("settings.html")
self.assertIn('', html)
self.assertIn("Never enter seed phrases", html)
eyebrows = re.findall(r'
([^<]+)
', html)
# The key names, the address paths and the type are changed in the
# rotation section, so the page has no separate keys section
# (section 28). The page heading is the h1 on its own, without an eyebrow
# that repeats it (section 32.3).
self.assertEqual(eyebrows, ["01 / Wallet software", "02 / Key rotation"])
self.assertIn("
Settings
", html)
self.assertNotIn("01 / Keys", html)
self.assertNotIn('id="keys-list"', html)
self.assertIn('id="wallet-software-list"', html)
self.assertIn('id="rotation-list"', html)
self.assertIn('id="add-software"', html)
self.assertIn('id="save-software"', html)
self.assertIn('id="save-keys"', html)
self.assertIn("Save keys", html)
def test_the_settings_page_warns_about_moving_the_funds_and_changing_the_path(self):
html = read_static("settings.html")
# Rotating a key creates a new wallet, so the funds have to be moved
# (section 25.2), and the key is a new one, so its path has to change
# (section 26.3).
self.assertIn("Rotating a key creates a new wallet", html)
self.assertIn("Move your funds from the old multisig setup to the new one", html)
self.assertIn("Do not discard the old keys", html)
self.assertIn("The address path must change", html)
self.assertIn("Every key needs its own new path", html)
self.assertIn('id="rotation-replaced"', html)
self.assertIn("I confirm that each selected key has been replaced", html)
# The unchanged-path confirmation is gone (section 26.3).
self.assertNotIn('id="rotation-path-unchanged"', html)
self.assertNotIn("address path of each selected key is unchanged", html)
# Removing an entry closes the alerts that software raised (section 26.7),
# and the two removal helps are one paragraph (section 32.3).
self.assertIn("Removing an entry also closes the alerts that software raised", html)
self.assertNotIn("Removing an entry never changes a saved check", html)
self.assertIn(
"Removing an entry never changes a saved check: the software selected "
"in an earlier check stays as it was recorded. Removing an entry also "
"closes the alerts that software raised",
html,
)
def test_the_settings_script_stores_the_list_whole_and_saves_the_keys(self):
script = read_static("settings.js")
self.assertIn("/api/settings/keys", script)
self.assertIn("/api/settings/wallet-software", script)
self.assertIn("/api/keys/", script)
self.assertIn("rotate", script)
self.assertIn("wallet_software", script)
self.assertIn("collectSoftware", script)
# One action saves both the renamed keys and the rotated ones, and the
# confirmation is only asked for when something is rotated (section 28).
self.assertIn("collectKeys", script)
self.assertIn("saveKeys", script)
self.assertIn("keep_name", script)
self.assertIn("replaced", script)
self.assertIn("rotationReplaced.checked", script)
# The address path is locked as soon as the key has a saved check, and the
# name may always be changed (sections 25.1 and 25.2).
self.assertIn("has_checks", script)
self.assertIn("pathInput.disabled", script)
# A link from the dashboard pre-selects the key it points at.
self.assertIn("requestedRotation", script)
# The rotation records a new, unique address path (sections 26.2 and 26.3).
self.assertIn("rotation-path", script)
self.assertIn("rotation_path_", script)
self.assertIn("address_path: entry.address_path", script)
self.assertIn("Write the new address path of every key you mark for rotation", script)
# The name field starts on the name the key has now (section 26.3).
self.assertIn("makeTextInput(key.name, 60)", script)
# The type is only offered together with a rotation, because a type change
# means the key is a new one (section 28).
self.assertIn("rotation-type", script)
self.assertIn("makeSelect", script)
self.assertIn('["hardware", "Hardware"]', script)
self.assertIn("type: entry.type", script)
self.assertIn("typeSelect.disabled", script)
# The removed confirmation is gone.
self.assertNotIn("address_path_unchanged", script)
self.assertNotIn("rotationPathUnchanged", script)
# Removing an entry closes the alerts that software raised (section 26.7).
self.assertIn("acknowledged", script)
self.assertIn("raised by the removed software were closed", script)
def test_history_shows_a_note_when_no_security_status_was_recorded(self):
script = read_static("history.js")
self.assertIn("securityTable", script)
self.assertIn("No security statuses were recorded", script)
def test_history_shows_the_contact_status_as_text(self):
script = read_static("history.js")
self.assertIn("Contact details confirmed", script)
self.assertIn("record.contact_info_verified", script)
def test_history_shows_the_derived_address_path_result(self):
script = read_static("history.js")
# The result is derived by the server, so it is shown as a derived value
# (sections 9 and 25.1).
self.assertIn("Address path verified (derived)", script)
self.assertIn("keyCheck.address_path_verified", script)
self.assertIn("keyCheck.address_path", script)
# The removed cloud results are no longer shown (section 25.6).
self.assertNotIn("Cloud health check", script)
self.assertNotIn("Provider operational", script)
self.assertNotIn("cloud_health_status", script)
self.assertNotIn("cloud_provider_operational", script)
def test_history_shows_the_follow_up_that_was_closed(self):
script = read_static("history.js")
# A closure that belongs to a key is shown as a card, with the code, the
# action written out, and the date (section 27). The source is not a
# column of its own (section 32.1).
self.assertIn("Follow-up closed", script)
self.assertIn("closed_alerts", script)
self.assertIn("closedAlertsTable", script)
self.assertIn("acknowledged_at", script)
self.assertIn("No follow-up was closed on this check.", script)
self.assertIn('["Alert", "Action", "Closed"]', script)
self.assertNotIn('"Source"', script)
# The action labels are duplicated here, which is the existing pattern.
self.assertIn("ACTION_LABELS", script)
self.assertIn('rotate: "Rotate key"', script)
self.assertIn('replace_hardware: "Replace hardware"', script)
self.assertIn('contact_updated: "Contact details updated"', script)
def test_history_card_shows_the_key_and_a_short_status(self):
script = read_static("history.js")
# The card shows the date, the key by its number and name, and whether the
# check left anything to follow up. The next due date and the software
# text are gone (section 32.2 point 14).
self.assertIn("check.checked_at", script)
self.assertIn("keyNamesText(check)", script)
self.assertIn("check.key_names", script)
self.assertIn("followUpText(check)", script)
self.assertIn("check.needs_follow_up", script)
self.assertIn('"Needs follow-up" : "All OK"', script)
self.assertNotIn("Next check due ${check.next_check_due}", script)
self.assertNotIn("Software ${check.software_compatibility_status}", script)
self.assertNotIn("keyNumbersText", script)
def test_history_merges_the_software_and_the_hardware_lines(self):
# The wallet software and its version share one line, and so do the
# hardware model and the firmware version (section 32.1).
script = read_static("history.js")
self.assertIn("mergedLine", script)
self.assertIn(
'["Wallet software", mergedLine(record.wallet_software, record.software_version)]',
script,
)
self.assertIn("mergedLine(keyCheck.model, keyCheck.firmware_version)", script)
# The two separate lines are gone.
self.assertNotIn('["Software version", record.software_version]', script)
self.assertNotIn('["Firmware version", keyCheck.firmware_version]', script)
def test_the_pages_offer_one_way_back_to_the_dashboard(self):
# The brand mark is the way back to the dashboard, so the pages carry no
# extra "Back to dashboard" link in the top bar. The blocked-keys note
# keeps its own link, which points at the dashboard for another reason
# (sections 26.1 and 32.1).
for name in ("history.html", "settings.html", "setup.html", "health-check.html"):
self.assertNotIn("Back to dashboard", read_static(name), name)
self.assertIn(
"Open the dashboard to close the alerts", read_static("health-check.html")
)
def test_the_history_page_starts_no_check(self):
# A check is started from the dashboard, so the history page carries no
# button of its own (section 32.1).
html = read_static("history.html")
self.assertNotIn("Start annual health check", html)
self.assertIn("Saved health checks", html)
def test_the_history_page_offers_the_export_in_its_own_section(self):
# The export moved from the dashboard to the history page, and it has a
# section of its own there, after the saved-check list: a title bar, the
# button, and the line that explains what the file holds (section 32.7
# point 5 and follow-up points 1 and 4).
html = read_static("history.html")
styles = read_static("styles.css")
link = 'Download CSV'
self.assertIn(link, html)
# No download attribute, so the dated filename from Content-Disposition is
# the one that wins (section 31 point 3).
self.assertNotIn("download=", html)
# The section stands after the list and before the detail section, and it
# carries a title bar of its own.
self.assertLess(html.index('id="history-list-title"'), html.index('id="export-title"'))
self.assertLess(html.index('id="export-title"'), html.index('id="history-detail"'))
self.assertLess(html.index('id="export-title"'), html.index(link))
self.assertIn('
Export
', html)
self.assertIn('
Download the report
', html)
# The line that explains the file stands under the button, and the
# free-standing note the dashboard used to carry is gone with the section
# that held it (follow-up points 4 and 5).
self.assertIn(
'
Every saved key check is exported', html
)
self.assertIn("one row per key check, as a dated CSV file.", html)
self.assertLess(html.index(link), html.index("one row per key check"))
self.assertNotIn('id="workflow-note"', html)
self.assertNotIn("Save a health check to see it in the history.", html)
# The button no longer needs the rule that gave it room inside the page
# heading, because it has a section of its own now.
self.assertNotIn(".page-heading > .secondary-button", styles)
def test_the_history_links_to_the_detail_section(self):
# Both entry points land on the detail section of the history page: the
# View link carries its anchor, and the form opens the check it has just
# saved there (section 32.7 follow-up point 3).
page = read_static("history.html")
history = read_static("history.js")
form = read_static("health-check.js")
# The anchor the two links point at is the detail section itself.
self.assertIn('id="history-detail"', page)
self.assertIn("link.href = `/history?id=${check.id}#history-detail`;", history)
self.assertIn("const target = `/history?id=${encodeURIComponent(saved.id)}#history-detail`;", form)
# The section is hidden until a check is opened, and a hidden element has
# no box to scroll to, so the page reveals it first and then moves to it.
self.assertIn("revealDetail", history)
self.assertIn(
'detailSection.scrollIntoView({ behavior: "smooth", block: "start" });',
history,
)
def test_stylesheet_makes_the_hidden_attribute_work_on_grid_containers(self):
styles = read_static("styles.css")
self.assertIn(".form-stack[hidden]", styles)
self.assertIn(".field-grid[hidden]", styles)
self.assertIn(".form-section[hidden]", styles)
def test_stylesheet_separates_the_rotation_note_from_the_list(self):
html = read_static("settings.html")
styles = read_static("styles.css")
# Only the spacing between the warning note and the rotation list changes
# (section 26.6).
self.assertIn('class="form-stack rotation-list"', html)
self.assertIn(".rotation-list { margin-top: 22px; }", styles)
def test_stylesheet_gives_the_help_line_room_before_its_block(self):
styles = read_static("styles.css")
# A help line is followed by its block with a little more air, on the
# three pages that put a block right under one (section 32.2 point 1).
self.assertIn(".field-help + .field-grid,", styles)
self.assertIn(".field-help + .form-stack { margin-top: 12px; }", styles)
# The block is a field grid on the setup page and a stack on the check
# form and the settings page, and all three put a help line above it.
for name, block in (
("setup.html", 'class="field-grid"'),
("health-check.html", 'class="form-stack"'),
("settings.html", 'class="form-stack"'),
):
html = read_static(name)
self.assertIn('