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
|
"""
The sign-in page with the welcome text beside it, measured in a browser.
Two columns on a desktop, one on a phone with the form first, and nothing wider
than the screen at any width. The text is the English catalogue's, at its real
length: a fixture shorter than the real copy measures the fixture.
The markup is `LoginPage` and `WelcomePitch` as `auth-page.js` renders them,
inside the shell `app.js` puts every page in. What is under test is the
stylesheet, which is served as it ships.
"""
import json
import re
import shutil
import subprocess
import textwrap
from pathlib import Path
import pytest
HARNESS = Path(__file__).parent / "harness" / "layout_probe.py"
STATIC = Path(__file__).resolve().parents[1] / "src" / "meshbay_hub" / "static"
pytestmark = pytest.mark.skipif(
shutil.which("google-chrome") is None or not (STATIC / "style.css").exists(),
reason="Chrome or the SPA stylesheet is not available")
def _en(key: str) -> str:
source = (STATIC / "locales" / "en.js").read_text(encoding="utf-8")
m = re.search(rf"^\s*'{re.escape(key)}': '([^']*)',$", source, re.M)
assert m, f"{key} is missing from en.js"
return m.group(1)
def _items(*keys: str) -> str:
return "".join(f"<li><span>{_en(k)}</span></li>" for k in keys)
def _page() -> str:
li = _items
# The source row carries the full URL rather than the host name it shows:
# an unbreakable string longer than the real one.
docs = "".join(
f'<li><span class="welcome-docs-label">{_en(label)}</span>'
f'<span class="welcome-docs-links">{links}</span></li>'
for label, links in [
("welcome.docs_source", "https://git.meshbay.org/meshbay.git/about/"),
("welcome.docs_user", f"{_en('welcome.docs_quickstart')} · {_en('welcome.docs_userguide')}"),
("welcome.docs_devel", f"{_en('welcome.docs_design')} · {_en('welcome.docs_protocol')}"),
])
return textwrap.dedent(f"""
<nav class="nav"><div class="nav-left"><a class="nav-brand" href="#/">MeshBay</a></div>
<div class="nav-right"><button class="nav-btn">Login</button></div></nav>
<div class="layout"><main class="main"><div class="page-center"><div class="welcome">
<div class="welcome-side"><div class="card login-card"><h2>Login</h2>
<form><input type="text" placeholder="Username" />
<input type="password" placeholder="Password" /><button>Login</button></form>
<div class="login-footer">No account? <a href="#/register">Register</a></div>
<div class="login-footer"><a href="#/reset">Forgot your passphrase?</a></div>
</div>
<div class="welcome-links"><a class="welcome-cta" href="#">{_en('welcome.download')}</a>
<a class="welcome-legal" href="#">{_en('welcome.legal')}</a></div></div>
<section class="welcome-pitch">
<h1 class="welcome-title">{_en('welcome.title')}</h1>
<p class="welcome-lead">{_en('welcome.lead')}</p>
<ul class="welcome-apps">{li('welcome.app_chat', 'welcome.app_photos',
'welcome.app_media', 'welcome.app_video', 'welcome.app_music')}</ul>
<h2 class="welcome-h">{_en('welcome.how_title')}</h2>
<ol class="welcome-steps">{li('welcome.step_home', 'welcome.step_anywhere',
'welcome.step_share')}</ol>
<h2 class="welcome-h">{_en('welcome.uses_title')}</h2>
<ul class="welcome-uses">{li('welcome.use_chat', 'welcome.use_photos',
'welcome.use_media', 'welcome.use_apps')}</ul>
<div class="welcome-private"><span class="welcome-private-icon"></span><div>
<h2 class="welcome-private-title">{_en('welcome.private_title')}</h2>
<p>{_en('welcome.private_body')}</p>
<ul class="welcome-badges">{li('welcome.badge_free', 'welcome.badge_open',
'welcome.badge_no_ads', 'welcome.badge_no_tracking')}</ul></div></div>
<div class="welcome-docs"><h2 class="welcome-h">{_en('welcome.docs_title')}</h2>
<ul>{docs}</ul></div>
</section>
</div></div></main></div>
""")
PHONES = [320, 360, 412]
DESKTOPS = [1100, 1440]
WIDTHS = PHONES + [768] + DESKTOPS
SELECTORS = [".welcome", ".login-card", ".welcome-pitch", ".welcome-steps", ".welcome-docs",
".welcome-links"]
@pytest.fixture(scope="module")
def measured(tmp_path_factory):
fragment = tmp_path_factory.mktemp("welcome") / "fragment.html"
fragment.write_text(_page(), encoding="utf-8")
proc = subprocess.run(
["python3", str(HARNESS), ",".join(str(w) for w in WIDTHS),
str(fragment), *SELECTORS],
capture_output=True, text=True, timeout=180)
assert proc.returncode == 0, f"probe failed: {proc.stdout}{proc.stderr}"
out = json.loads(proc.stdout)
assert "error" not in out, f"no measurement: {out}"
for w in WIDTHS:
assert out[str(w)]["viewport"]["w"] == w
return out
def _box(measured, width, selector):
box = measured[str(width)]["boxes"][selector]
assert box is not None, f"{selector} did not render at {width} px"
return box
@pytest.mark.parametrize("width", WIDTHS)
def test_nothing_is_wider_than_the_screen(measured, width):
"""A document wider than the screen unpins every sticky header on Android."""
assert measured[str(width)]["docScrollW"] <= width, (
f"the page is {measured[str(width)]['docScrollW']} px wide on a {width} px screen")
for sel in SELECTORS:
box = _box(measured, width, sel)
assert box["offLeft"] == 0 and box["offRight"] == 0, f"{sel} hangs off at {width} px"
@pytest.mark.parametrize("width", PHONES + [768])
def test_a_narrow_screen_shows_the_form_first(measured, width):
card, pitch = _box(measured, width, ".login-card"), _box(measured, width, ".welcome-pitch")
assert pitch["top"] >= card["top"] + card["height"], (
f"at {width} px the welcome text is not below the sign-in form")
@pytest.mark.parametrize("width", DESKTOPS)
def test_a_desktop_puts_the_form_right_of_the_text(measured, width):
"""Text on the left, the form on the right with room between them, and
the form up by the title rather than centred on a column far taller."""
card, pitch = _box(measured, width, ".login-card"), _box(measured, width, ".welcome-pitch")
gap = card["left"] - (pitch["left"] + pitch["width"])
assert gap >= 80, f"at {width} px the form is {gap} px right of the text"
assert pitch["width"] >= 480, f"the text column is {pitch['width']} px at {width} px"
assert 0 <= card["top"] - pitch["top"] <= 80, (
f"at {width} px the form starts {card['top'] - pitch['top']} px below the text")
def test_the_pair_is_centred_in_the_window(measured):
"""Signed out there is no sidebar, and `.main` is capped at 960 px — so
before `.page-center` lifted the cap, a centred form sat centred in the
left 960 px of the window: x=290 in 1440."""
# Against the document's width, not the window's: the probe's frame is
# shorter than the page, so a vertical scrollbar takes its share.
box = _box(measured, 1440, ".welcome")
middle = measured["1440"]["docScrollW"] / 2
centre = box["left"] + box["width"] / 2
assert abs(centre - middle) <= 2, f"the page is centred on x={centre}, not {middle}"
@pytest.mark.parametrize("width", WIDTHS)
def test_the_download_and_legal_links_sit_under_the_form(measured, width):
card, links = _box(measured, width, ".login-card"), _box(measured, width, ".welcome-links")
assert links["top"] >= card["top"] + card["height"], (
f"at {width} px the links are not below the sign-in form")
assert links["top"] - (card["top"] + card["height"]) <= 40, (
f"at {width} px the links are far below the form")
assert abs(links["left"] - card["left"]) <= 1 and abs(links["width"] - card["width"]) <= 1, (
f"at {width} px the links are not aligned with the form")
|