habitable/tests/test_letter.py at main · ghzhost/habitable · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# SPDX-License-Identifier: AGPL-3.0-or-later
# Copyright 2026 Chelsea Kelly-Reif
"""The repair-request letter generator: content, jurisdiction framing, rendering."""

from __future__ import annotations

from collections.abc import Callable
from dataclasses import replace
from pathlib import Path

import pytest

from habitable.capture import capture
from habitable.errors import LetterError
from habitable.letter import (
    PROFILES,
    LetterOptions,
    build_letter,
    render_letter_html,
    resolve_profile,
)
from habitable.tsa import LocalRfc3161TSA
from habitable.vault import Vault


def _case(
    make_vault: Callable[..., Vault], make_jpeg: Callable[..., Path], tsa: LocalRfc3161TSA
) -> Vault:
    vault = make_vault()
    issue = vault.document.add_issue(
        category="mold",
        room="bathroom",
        title="Black mold on ceiling",
        severity="high",
        description="Mold spread after a roof leak.",
        issue_id="i1",
    )
    vault.document.add_timeline_entry(issue, "observed", "spreading")
    capture(vault, make_jpeg(with_location=True), issue_id=issue, tsa=tsa)
    vault.save()
    return vault


def test_build_letter_draws_from_logged_evidence(
    make_vault: Callable[..., Vault], make_jpeg: Callable[..., Path], local_tsa: LocalRfc3161TSA
) -> None:
    vault = _case(make_vault, make_jpeg, local_tsa)
    letter = build_letter(
        vault,
        LetterOptions(
            recipient_name="Acme Property Mgmt",
            sender_name="Tenant T",
            cure_period_days=21,
            date="2026-01-10",
        ),
    )
    assert letter.date == "2026-01-10"
    assert letter.recipient_name == "Acme Property Mgmt"
    assert letter.cure_period_days == 21
    assert len(letter.issues) == 1
    only = letter.issues[0]
    assert only.title == "Black mold on ceiling"
    assert only.evidence_count == 1
    assert only.timestamped_count == 1
    assert only.first_documented  # a date was derived
    assert "21 days" in letter.demand
    assert "not legal advice" in letter.disclaimer.lower()


def test_letter_html_is_accessible_and_escaped(
    make_vault: Callable[..., Vault], make_jpeg: Callable[..., Path], local_tsa: LocalRfc3161TSA
) -> None:
    vault = make_vault()
    vault.document.add_issue(
        category="mold",
        title="Leak",
        description="Danger <script>alert(1)</script> here",
        issue_id="i1",
    )
    letter = build_letter(vault, LetterOptions(sender_name="T", recipient_name="LL"))
    html = render_letter_html(letter)
    assert html.startswith("<!doctype html>")
    assert html.count("<h1>") == 1
    assert 'lang="en"' in html
    assert '<a class="skip" href="#main">' in html
    assert '<main id="main">' in html
    # User content is escaped — no live script element.
    assert "<script>" not in html
    assert "&lt;script&gt;" in html


def test_letter_pdf_renders(
    make_vault: Callable[..., Vault],
    make_jpeg: Callable[..., Path],
    local_tsa: LocalRfc3161TSA,
    tmp_path: Path,
) -> None:
    from habitable.pdf import render_letter_pdf

    vault = _case(make_vault, make_jpeg, local_tsa)
    letter = build_letter(vault, LetterOptions(sender_name="T", recipient_name="LL"))
    out = tmp_path / "letter.pdf"
    render_letter_pdf(letter, out)
    data = out.read_bytes()
    assert data.startswith(b"%PDF-")
    assert b"/Lang" in data
    assert out.stat().st_size > 1000


def test_jurisdiction_profiles_and_fallback() -> None:
    assert resolve_profile("").key == "generic"
    assert resolve_profile("us_habitability").key == "us_habitability"
    assert resolve_profile("US Habitability").key == "us_habitability"  # normalized
    assert resolve_profile("narnia").key == "generic"  # unknown → generic, never refuses
    # Built-in profiles never assert a specific statute/code section — in *any*
    # reader-visible field (the framing and legal reference both render into the
    # letter), not just the legal-reference line.
    for profile in PROFILES.values():
        for text in (profile.label, profile.framing, profile.legal_reference):
            assert "§" not in text
            assert "U.S.C" not in text
            assert "U. S. C" not in text


def test_cure_period_precedence(
    make_vault: Callable[..., Vault], make_jpeg: Callable[..., Path], local_tsa: LocalRfc3161TSA
) -> None:
    vault = make_vault()
    vault.document.add_issue(category="heat", title="No heat", issue_id="i1")
    # Explicit option wins; otherwise the profile default (14) applies.
    explicit = build_letter(vault, LetterOptions(cure_period_days=30))
    assert explicit.cure_period_days == 30
    default = build_letter(vault, LetterOptions())
    assert default.cure_period_days == 14


def test_letter_without_issues_is_an_error(make_vault: Callable[..., Vault]) -> None:
    vault = make_vault()
    with pytest.raises(LetterError):
        build_letter(vault, LetterOptions())


def test_letter_can_scope_to_one_issue(make_vault: Callable[..., Vault]) -> None:
    vault = make_vault()
    vault.document.add_issue(category="mold", title="Mold", issue_id="i1")
    vault.document.add_issue(category="heat", title="No heat", issue_id="i2")
    letter = build_letter(vault, LetterOptions(issue_ids=("i2",)))
    assert [i.issue_id for i in letter.issues] == ["i2"]


@pytest.mark.a11y
def test_letter_html_passes_axe(make_vault: Callable[..., Vault], tmp_path: Path) -> None:
    pytest.importorskip("playwright.sync_api")
    pytest.importorskip("axe_playwright_python.sync_playwright")
    from axe_playwright_python.sync_playwright import Axe
    from playwright.sync_api import Error as PlaywrightError
    from playwright.sync_api import sync_playwright

    vault = make_vault()
    vault.document.add_issue(
        category="mold",
        title="Black mold",
        description="Spread after a roof leak.",
        issue_id="i1",
    )
    letter = build_letter(vault, LetterOptions(sender_name="Tenant", recipient_name="Landlord"))
    out = tmp_path / "letter.html"
    out.write_text(render_letter_html(letter), encoding="utf-8")

    with sync_playwright() as p:
        try:
            browser = p.chromium.launch()
        except PlaywrightError as exc:
            pytest.skip(f"Chromium not available: {exc}")
        try:
            page = browser.new_page()
            page.goto(out.as_uri(), wait_until="load")
            results = Axe().run(page)
        finally:
            browser.close()
    blocking = [
        v
        for v in results.response.get("violations", [])
        if v.get("impact") in {"moderate", "serious", "critical"}
    ]
    assert not blocking, [v["id"] for v in blocking]


# --- Issue #161: the letter declares only what it is -------------------------


def _spanish_vault(make_vault: Callable[..., Vault], name: str = "es-vault") -> Vault:
    """A vault configured `language = "es"` — a supported, documented setup, and
    the one a Spanish-speaking union would use."""
    vault = make_vault(name=name)
    vault.config = replace(vault.config, language="es")
    vault.document.add_issue(category="mold", title="Mold", issue_id="i1")
    vault.save()
    return vault


def test_a_spanish_vault_is_never_given_an_english_letter_labelled_spanish(
    make_vault: Callable[..., Vault],
) -> None:
    """The absence under test: `lang="es"` must not appear on English prose.

    Before this fix, `language="es"` produced a letter whose body was
    byte-identical to the English one and whose only difference was the `lang`
    attribute — a WCAG 3.1.1 failure that makes a screen reader pronounce
    English with Spanish phonetics, and a document that tells a Spanish-speaking
    tenant it is in their language when it is not.
    """
    vault = _spanish_vault(make_vault)
    letter = build_letter(vault, LetterOptions(sender_name="T", recipient_name="LL"))
    html = render_letter_html(letter)

    assert 'lang="es"' not in html
    assert 'lang="en"' in html
    assert letter.language == "en"
    assert letter.requested_language == "es"
    # The unmet request is reported rather than silently dropped.
    assert "es" in letter.language_limitation
    assert "does not ship a reviewed translation" in letter.language_limitation


def test_the_letter_is_byte_identical_in_both_locales_which_is_the_point(
    make_vault: Callable[..., Vault],
) -> None:
    """Pins *why* `lang="es"` was a lie, so a future partial translation cannot
    quietly reintroduce it: as long as the rendered documents are identical, the
    language attribute must be too."""
    english = build_letter(
        _spanish_vault(make_vault, "en-side"),
        LetterOptions(sender_name="T", language="en", date="2026-01-10"),
    )
    spanish = build_letter(
        _spanish_vault(make_vault, "es-side"),
        LetterOptions(sender_name="T", language="es", date="2026-01-10"),
    )

    assert render_letter_html(english) == render_letter_html(spanish)
    assert english.language == spanish.language == "en"
    assert english.language_limitation == ""
    assert spanish.language_limitation != ""


def test_a_letter_with_no_evidence_does_not_claim_a_verifiable_packet(
    make_vault: Callable[..., Vault],
) -> None:
    """The absence under test: no packet offer when there is no packet.

    A case with an issue and zero captures used to produce "documented by 0
    photograph(s) ... A complete, independently-verifiable evidence packet is
    available on request" — an overstatement a landlord's representative can
    call, on the first document carrying the tenant's name.
    """
    vault = make_vault()
    vault.document.add_issue(category="mold", title="Mold", issue_id="i1")
    vault.save()

    letter = build_letter(vault, LetterOptions(sender_name="T", recipient_name="LL"))
    html = render_letter_html(letter)

    assert "0 photograph(s)" not in letter.evidence_summary
    assert "evidence packet is available on request" not in letter.evidence_summary
    assert "independently-verifiable" not in html
    # Says plainly what is true instead of dropping the subject.
    assert "No photographs of these conditions are attached" in letter.evidence_summary
    assert letter.evidence_summary in html


def test_a_letter_with_evidence_still_offers_the_packet(
    make_vault: Callable[..., Vault], make_jpeg: Callable[..., Path], local_tsa: LocalRfc3161TSA
) -> None:
    """Positive control: the claim is gated, not removed."""
    vault = _case(make_vault, make_jpeg, local_tsa)
    letter = build_letter(vault, LetterOptions(sender_name="T", recipient_name="LL"))

    assert "1 photograph(s)" in letter.evidence_summary
    assert "evidence packet is available on request" in letter.evidence_summary
    assert "timestamp tokens whose validity and authority trust must be checked" in (
        letter.evidence_summary
    )


@pytest.mark.parametrize("language", ["en", "es"])
def test_the_lang_attribute_matches_the_language_of_the_content(
    make_vault: Callable[..., Vault], language: str
) -> None:
    """Issue #161 item 4: assert the attribute against the prose, per locale.

    The English marker strings below are the letter's own fixed copy; if a
    reviewed translation ever lands, this test fails until the `lang` attribute
    follows it.
    """
    vault = _spanish_vault(make_vault)
    letter = build_letter(vault, LetterOptions(sender_name="T", language=language))
    html = render_letter_html(letter)

    assert f'lang="{letter.language}"' in html
    english_markers = ("Conditions requiring repair", "Sincerely,", "not legal advice")
    content_is_english = all(marker in html for marker in english_markers)
    assert content_is_english is (letter.language == "en")


@pytest.mark.a11y
def test_letter_html_in_a_spanish_configured_vault_passes_axe(
    make_vault: Callable[..., Vault], tmp_path: Path
) -> None:
    """Issue #161 item 4 asked for an axe scan of the letter. One already exists
    (``test_letter_html_passes_axe``, since PR #16) — but it only ever built a
    letter from an English-configured vault, and axe could not have caught this
    defect regardless: a document declaring ``lang="es"`` over English prose
    passes ``html-has-lang`` and ``valid-lang`` cleanly, because no automated
    checker reads the prose. The content-versus-attribute assertion above is what
    catches it; this scan just extends the existing a11y coverage to the
    Spanish-configured vault, which is the configuration that was broken.
    """
    pytest.importorskip("playwright.sync_api")
    pytest.importorskip("axe_playwright_python.sync_playwright")
    from axe_playwright_python.sync_playwright import Axe
    from playwright.sync_api import Error as PlaywrightError
    from playwright.sync_api import sync_playwright

    letter = build_letter(
        _spanish_vault(make_vault, "axe-es"),
        LetterOptions(sender_name="Tenant", recipient_name="Landlord"),
    )
    out = tmp_path / "letter.html"
    out.write_text(render_letter_html(letter), encoding="utf-8")

    with sync_playwright() as p:
        try:
            browser = p.chromium.launch()
        except PlaywrightError as exc:
            pytest.skip(f"Chromium not available: {exc}")
        try:
            page = browser.new_page()
            page.goto(out.as_uri(), wait_until="load")
            results = Axe().run(page)
        finally:
            browser.close()
    blocking = [
        v
        for v in results.response.get("violations", [])
        if v.get("impact") in {"moderate", "serious", "critical"}
    ]
    assert not blocking, [v["id"] for v in blocking]