python-tutor/scripts/check_site.sh at 0f12712ff887fc27964d646c0756c53ed83dbeed · StewAlexander-com/python-tutor · 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
#!/usr/bin/env bash
# check_site.sh — light validity / asset checks for the hero landing page.
#
# Runs from repo root. Exits non-zero on the first failure, with a clear
# message and an exit code that's safe for CI.

set -euo pipefail

ROOT="$(cd "$(dirname "$0")/.." && pwd)"
SITE="$ROOT/site"
HTML="$SITE/index.html"
CSS="$SITE/style.css"

fail() { echo "✗ $*" >&2; exit 1; }
ok()   { echo "✓ $*"; }

[ -f "$HTML" ] || fail "site/index.html missing"
[ -f "$CSS" ]  || fail "site/style.css missing"
ok "site/index.html and site/style.css present"

# Required meta tags / sections — grep for substrings.
need() {
  grep -q -- "$1" "$HTML" || fail "site/index.html missing: $1"
}
need "<title>Python Tutor"
need 'name="description"'
need 'name="robots"'
need 'name="theme-color"'
need 'rel="canonical"'
need 'property="og:title"'
need 'property="og:description"'
need 'property="og:type"'
need 'property="og:url"'
need 'property="og:site_name"'
need 'property="og:image"'
need 'property="og:image:secure_url"'
need 'property="og:image:type"'
need 'property="og:image:width"'
need 'property="og:image:height"'
need 'property="og:image:alt"'
need 'name="twitter:card"'
need 'name="twitter:title"'
need 'name="twitter:description"'
need 'name="twitter:image"'
need 'name="twitter:image:alt"'
need 'rel="apple-touch-icon"'
need 'rel="manifest"'
need 'id="why"'
need 'id="loop"'
need 'id="screens"'
need 'id="start"'
ok "required <head> and section anchors present"

# Open Graph / Twitter image must be an absolute URL (most scrapers reject relative).
grep -qE 'property="og:image"[^>]*content="https://' "$HTML" \
  || fail "og:image must use an absolute https:// URL"
grep -qE 'name="twitter:image"[^>]*content="https://' "$HTML" \
  || fail "twitter:image must use an absolute https:// URL"
ok "og:image and twitter:image use absolute URLs"

# Social-share asset files must exist on disk at the right sizes.
need_file() { [ -f "$1" ] || fail "missing asset: $1"; }
need_file "$SITE/assets/og-image.png"
need_file "$SITE/assets/og-image-square.png"
need_file "$SITE/assets/favicon.svg"
need_file "$SITE/assets/favicon.ico"
need_file "$SITE/assets/favicon-16.png"
need_file "$SITE/assets/favicon-32.png"
need_file "$SITE/assets/apple-touch-icon.png"
need_file "$SITE/assets/icon-192.png"
need_file "$SITE/assets/icon-512.png"
need_file "$SITE/site.webmanifest"
ok "favicon, manifest, and social-share assets present"

# Validate critical image dimensions where we can.
python3 - "$SITE" <<'PY'
import sys, struct, os
site = sys.argv[1]
def png_size(p):
    with open(p, "rb") as f:
        head = f.read(24)
    if head[:8] != b"\x89PNG\r\n\x1a\n":
        return None
    w, h = struct.unpack(">II", head[16:24])
    return w, h
expected = {
    "assets/og-image.png": (1200, 630),
    "assets/og-image-square.png": (1200, 1200),
    "assets/apple-touch-icon.png": (180, 180),
    "assets/favicon-16.png": (16, 16),
    "assets/favicon-32.png": (32, 32),
    "assets/icon-192.png": (192, 192),
    "assets/icon-512.png": (512, 512),
}
bad = []
for rel, want in expected.items():
    p = os.path.join(site, rel)
    got = png_size(p)
    if got != want:
        bad.append(f"{rel}: got {got}, want {want}")
if bad:
    print("✗ wrong image dimensions:", file=sys.stderr)
    for b in bad: print("    " + b, file=sys.stderr)
    sys.exit(1)
print("✓ all PNG asset dimensions correct")
PY

# webmanifest must reference real icon files and be valid JSON.
python3 - "$SITE" <<'PY'
import json, os, sys
site = sys.argv[1]
mf = os.path.join(site, "site.webmanifest")
data = json.load(open(mf))
icons = data.get("icons", [])
if not icons:
    print("✗ site.webmanifest has no icons", file=sys.stderr); sys.exit(1)
missing = []
for ic in icons:
    src = ic.get("src", "")
    rel = src[2:] if src.startswith("./") else src
    if not os.path.exists(os.path.join(site, rel)):
        missing.append(src)
if missing:
    print("✗ manifest icons missing on disk:", file=sys.stderr)
    for m in missing: print("    " + m, file=sys.stderr)
    sys.exit(1)
print(f"✓ site.webmanifest valid JSON with {len(icons)} resolvable icons")
PY

# Start-page install content must be visible — this page is the entry point
# to the repo, so the clone/install/run commands have to be there literally.
need "git clone https://github.com/StewAlexander-com/python-tutor.git"
need "cd python-tutor"
need "./install.sh"
need "./run.sh --open-browser"
ok "clone / install / run commands present in start section"

# Quick links to repo, README, and issues from the start page.
need 'href="https://github.com/StewAlexander-com/python-tutor"'
need 'href="https://github.com/StewAlexander-com/python-tutor#readme"'
need 'href="https://github.com/StewAlexander-com/python-tutor/issues"'
ok "repo / README / issues links present"

# Copy-to-clipboard buttons should be wired to the command blocks.
need 'class="copy-btn"'
need 'data-copy-target="cmd-clone"'
need 'data-copy-target="cmd-install"'
need 'data-copy-target="cmd-run"'
ok "copy-to-clipboard buttons wired up"

# Every local href/src under site/ must resolve to a real file.
# (We only check ./relative paths — external URLs are skipped.)
python3 - "$HTML" "$SITE" <<'PY'
import re, sys, os
html_path, site_dir = sys.argv[1], sys.argv[2]
src = open(html_path, encoding="utf-8").read()
refs = re.findall(r'(?:href|src)\s*=\s*"(\./[^"]+)"', src)
missing = []
for r in refs:
    rel = r[2:]  # drop "./"
    rel = rel.split("#", 1)[0].split("?", 1)[0]
    p = os.path.join(site_dir, rel)
    if not os.path.exists(p):
        missing.append(r)
if missing:
    print("✗ missing local assets:", file=sys.stderr)
    for m in missing:
        print("    " + m, file=sys.stderr)
    sys.exit(1)
print(f"✓ all {len(refs)} local references resolve")
PY

# Should NOT contain hard-coded localhost links (would break in prod).
if grep -nE 'href="http://localhost' "$HTML" >/dev/null; then
    fail "site/index.html contains hard-coded http://localhost hrefs"
fi
ok "no hard-coded localhost hrefs"

# Cheap structural sanity check: balanced <main> tag.
opens=$(grep -c '<main' "$HTML" || true)
closes=$(grep -c '</main>' "$HTML" || true)
[ "$opens" = "$closes" ] || fail "unbalanced <main> tags ($opens open, $closes close)"
ok "<main> tags balanced"

# GitHub Pages deploy workflow must exist and reference the official actions.
PAGES_WF="$ROOT/.github/workflows/pages.yml"
[ -f "$PAGES_WF" ] || fail ".github/workflows/pages.yml missing (GitHub Pages deploy)"
grep -q "actions/configure-pages" "$PAGES_WF"      || fail "pages.yml missing actions/configure-pages"
grep -q "actions/upload-pages-artifact" "$PAGES_WF" || fail "pages.yml missing actions/upload-pages-artifact"
grep -q "actions/deploy-pages" "$PAGES_WF"          || fail "pages.yml missing actions/deploy-pages"
grep -q "path: site" "$PAGES_WF"                    || fail "pages.yml does not upload the site/ folder"
ok "GitHub Pages workflow present and references official actions"

echo "site checks passed"