SHA256
forked from course-team/tjhlp-gitea
`ROOT` 是仓库根, 但断言用的是 `${ROOT}/custom/...`, 那个路径根本不存在, 于是
`if [[ -f ... ]]` 永远为假 —— 「生成的 zh-CN 语言文件已无工单」这条从未真正跑过
(在预览/生产上跑都是直接跳过, 看不出来)。改成 `customization/custom/...`。
顺带加上首页(登录后)学期答疑入口卡片的模板层断言: 卡片模板在位 + dashboard.tmpl
里确实 include 了它。渲染结果需要登录才能看, 那部分在 preview.sh check 里
(它用 previewadmin 登录后抓首页)。
实测: customization/check.sh 对预览与生产都跑通(生产多一条 OIDC 入口 307)。
129 lines
5.9 KiB
Bash
Executable File
129 lines
5.9 KiB
Bash
Executable File
#!/usr/bin/env bash
|
||
# 定制生效断言 —— 对任意实例跑一遍, 预览与生产共用。
|
||
# 用法:
|
||
# customization/check.sh http://127.0.0.1:2081 # 预览
|
||
# customization/check.sh https://cpp.tongji.sh/QA # 生产(CI 里也调这个)
|
||
#
|
||
# 退出码: 0 全通过 / 1 有断言失败 / 2 用法错误。
|
||
# 只读: 只发 GET, 不改任何东西。
|
||
set -uo pipefail
|
||
|
||
BASE_URL="${1:-}"
|
||
if [[ -z ${BASE_URL} ]]; then
|
||
sed -n '2,9p' "$0"
|
||
exit 2
|
||
fi
|
||
BASE_URL="${BASE_URL%/}"
|
||
ORIGIN="$(printf '%s' "${BASE_URL}" | sed -E 's#(^https?://[^/]+).*#\1#')"
|
||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||
|
||
fail=0
|
||
ok() { printf ' ✓ %s\n' "$1"; }
|
||
bad() {
|
||
printf ' ✗ %s\n' "$1"
|
||
fail=1
|
||
}
|
||
skip() { printf ' – %s\n' "$1"; }
|
||
|
||
tmp="$(mktemp -d)"
|
||
trap 'rm -rf "${tmp}"' EXIT
|
||
# --noproxy: 验证目标都在内网, 走代理只会把 200 变成 502(见 deploy/README.md 陷阱 5)
|
||
curl_() { curl -sS --noproxy '*' --max-time 20 "$@"; }
|
||
|
||
echo "== 定制检查 ${BASE_URL} =="
|
||
|
||
# --- 首页 -------------------------------------------------------------------
|
||
if ! curl_ -fsS -H 'Accept-Language: zh-CN' "${BASE_URL}/" -o "${tmp}/home.html"; then
|
||
echo " ✗ 首页打不开(HTTP 非 2xx), 后面不再检查"
|
||
exit 1
|
||
fi
|
||
ok "首页可访问"
|
||
|
||
grep -q "先搜索,再提问" "${tmp}/home.html" &&
|
||
ok "首页用的是定制模板 home.tmpl" || bad "首页没有定制模板的内容"
|
||
grep -q "assets/tjhlp/ask-guide.html" "${tmp}/home.html" &&
|
||
ok "导航栏/首页已指向课程提问指南" || bad "没找到提问指南链接"
|
||
! grep -q "painless\|极易搭建\|Easy to install\|Cross-platform" "${tmp}/home.html" &&
|
||
ok "首页已无 Gitea 功能介绍" || bad "首页仍有 Gitea 功能介绍文案"
|
||
! grep -qi "powered by" "${tmp}/home.html" &&
|
||
ok "页脚已无 Powered by Gitea" || bad "页脚仍有 Powered by"
|
||
! grep -q "docs.gitea.com" "${tmp}/home.html" &&
|
||
ok "页面已无 docs.gitea.com 外链" || bad "仍有 docs.gitea.com 外链"
|
||
grep -q 'name="description" content="同济大学高级语言程序设计课程答疑平台"' "${tmp}/home.html" &&
|
||
ok "meta description 已替换" || bad "meta description 未替换"
|
||
|
||
# --- 与课程官网的联动 -------------------------------------------------------
|
||
grep -q "https://cpp.tongji.sh/Website/" "${tmp}/home.html" &&
|
||
ok "首页/导航栏已链接课程官网" || bad "首页没有课程官网链接"
|
||
grep -q "https://cpp.tongji.sh/Website/ask-question/" "${tmp}/home.html" &&
|
||
ok "首页已链接官网《学会提问》" || bad "首页没有《学会提问》链接"
|
||
if curl_ -fsS -o "${tmp}/guide.html" "${BASE_URL}/assets/tjhlp/ask-guide.html"; then
|
||
ok "custom/public 静态页可访问"
|
||
grep -q "Website/ask-question/" "${tmp}/guide.html" &&
|
||
ok "站内提问指南已回链官网" || bad "站内提问指南没有官网链接"
|
||
else
|
||
bad "提问指南静态页 404"
|
||
fi
|
||
|
||
# --- 中文术语与登录页 -------------------------------------------------------
|
||
if curl_ -fsS -H 'Accept-Language: zh-CN' "${BASE_URL}/user/login" -o "${tmp}/login.html"; then
|
||
ok "登录页可访问"
|
||
grep -q "管理员登录" "${tmp}/login.html" &&
|
||
ok "登录页有独立的「管理员登录」卡片" || bad "登录页缺少管理员登录卡片"
|
||
! grep -q "webauthn-error\|signin-passkey" "${tmp}/login.html" &&
|
||
ok "登录页已无空的通行密钥(WebAuthn)方框" || bad "登录页仍有通行密钥区块"
|
||
# OIDC 入口: 配了认证源的实例才会渲染 external-login-navigator
|
||
if grep -q 'id="external-login-navigator"' "${tmp}/login.html"; then
|
||
href="$(grep -o 'href="[^"]*/user/oauth2/[^"]*"' "${tmp}/login.html" | head -1 |
|
||
sed -E 's/^href="//; s/"$//')"
|
||
if [[ -z ${href} ]]; then
|
||
bad "登录页有认证源区块但没解析出 OAuth2 链接"
|
||
else
|
||
code="$(curl_ -o /dev/null -w '%{http_code}' "${ORIGIN}${href}")"
|
||
# 307 = 认证源注册成功并跳转统一身份认证; 404 = 认证源没注册上(见 README 陷阱 6)
|
||
[[ ${code} == 307 ]] &&
|
||
ok "OIDC 入口 ${href} 返回 307(跳转统一身份认证)" ||
|
||
bad "OIDC 入口返回 ${code}, 期望 307(404 = 认证源没注册上)"
|
||
fi
|
||
else
|
||
skip "该实例未配置认证源, 跳过 OIDC 入口检查(预览实例属此情况)"
|
||
fi
|
||
else
|
||
bad "登录页打不开"
|
||
fi
|
||
|
||
# 术语: 中文界面里不该再出现「工单」
|
||
if curl_ -fsS -H 'Accept-Language: zh-CN' -o "${tmp}/issues.html" \
|
||
"${BASE_URL}/course-team/tjhlp-gitea/issues"; then
|
||
! grep -q "工单" "${tmp}/issues.html" &&
|
||
ok "Issue 列表页中文界面已无「工单」" || bad "Issue 列表页仍有「工单」"
|
||
else
|
||
skip "读不到 issue 列表页(需要登录?), 跳过「工单」检查"
|
||
fi
|
||
|
||
# --- 仓库内文件(在 checkout 里跑时才有意义) --------------------------------
|
||
if [[ -d ${ROOT}/issue-templates ]]; then
|
||
! grep -rq "example.com" "${ROOT}/issue-templates/" &&
|
||
ok "Issue 模板已无 example.com 占位链接" || bad "Issue 模板里仍有 example.com"
|
||
fi
|
||
if [[ -f ${ROOT}/customization/custom/options/locale/locale_zh-CN.json ]]; then
|
||
! grep -q "工单" "${ROOT}/customization/custom/options/locale/locale_zh-CN.json" &&
|
||
ok "生成的 zh-CN 语言文件已无「工单」" || bad "语言文件里仍有「工单」"
|
||
fi
|
||
# 首页(登录后)的学期答疑入口卡片: 渲染结果需要登录才能看, 这里只断言模板层
|
||
# (运行时的渲染断言在 customization/preview/preview.sh check 里, 要登录)。
|
||
if [[ -f ${ROOT}/customization/custom/templates/custom/tjhlp_semester_card.tmpl ]]; then
|
||
grep -q "本学期答疑入口" "${ROOT}/customization/custom/templates/custom/tjhlp_semester_card.tmpl" &&
|
||
ok "首页答疑入口卡片模板在位" || bad "卡片模板里没有预期的内容"
|
||
grep -q 'template "custom/tjhlp_semester_card"' \
|
||
"${ROOT}/customization/custom/templates/user/dashboard/dashboard.tmpl" &&
|
||
ok "dashboard.tmpl 已 include 学期答疑入口卡片" || bad "dashboard.tmpl 没有 include 卡片"
|
||
fi
|
||
|
||
if [[ ${fail} == 0 ]]; then
|
||
echo "全部检查通过"
|
||
else
|
||
echo "存在检查未通过项"
|
||
fi
|
||
exit "${fail}"
|