Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 89c484cdc4 | |||
| 5e3362e2b0 | |||
| edd07a65d6 | |||
| 7c120b3adc | |||
| ea159ca2fb | |||
| 034c0b3a1c |
@@ -27,6 +27,14 @@ BUILD_TIME ?= $(shell date -u +%Y-%m-%dT%H:%M:%SZ)
|
||||
verify:
|
||||
$(PY) scripts/ci_checks.py
|
||||
|
||||
.PHONY: qa qa-doctor qa-self-test
|
||||
qa:
|
||||
$(PY) scripts/qa_env.py run
|
||||
qa-doctor:
|
||||
$(PY) scripts/qa_env.py doctor
|
||||
qa-self-test:
|
||||
$(PY) -m unittest discover -s scripts -p test_qa_env.py -v
|
||||
|
||||
# 清单:哪些是必需项、在哪个档案(local / ci)下必需
|
||||
list:
|
||||
$(PY) scripts/ci_checks.py --list
|
||||
|
||||
@@ -71,15 +71,16 @@ IT、行政等是待扩展的业务资料范围,不是已经完成的新连接
|
||||
|
||||
## 访问与部署
|
||||
|
||||
### 已部署环境
|
||||
### 运行架构与访问入口
|
||||
|
||||
Compose 中网页入口固定映射为 **宿主机 `8088` → Web 容器 `8080`**。网页和 `/api/` 使用同源入口。
|
||||
| 组件 | 职责 | 接手时从这里看 |
|
||||
|---|---|---|
|
||||
| React/Vite + Web Nginx | 提供静态页面,同源转发 `/api/` 和 `/health` | [前端开发代理](web/vite.config.ts)、[Compose 的 Nginx 配置](deploy/nginx.conf) |
|
||||
| Go API + 治理 PostgreSQL | 认证、角色、来源、绑定、审核、任务与发布记录。云测试使用独立逻辑库 `knowledge_governance_test` | [API](cmd/api)、[接口契约](api/openapi.yaml) |
|
||||
| 普通 worker + 测试 WeKnora | worker 取件、上传、轮询并记录验收结果。WeKnora 负责解析、切片和索引 | [worker](cmd/worker)、[来源接入](docs/OPERATIONS_RUNBOOK.md#接入外部平台) |
|
||||
| 发布 worker + 生产 WeKnora | 按已锁定的批次和目标执行受控发布与读回。问答端通过下游服务使用已发布知识 | [发布 worker](cmd/release-worker)、[操作手册](docs/OPERATIONS_RUNBOOK.md) |
|
||||
|
||||
- 本机访问:`http://127.0.0.1:8088/`
|
||||
- 局域网访问:`http://<服务器内网IP>:8088/`
|
||||
- 健康入口:`http://127.0.0.1:8088/health`
|
||||
|
||||
可以由 NAS 反向代理提供 HTTPS 域名入口,目标为平台服务器的 `8088`,保持路径原样转发。公网开放前必须验证鉴权、访问控制及转发头配置,不直接暴露数据库或内部管理接口。
|
||||
从自己的电脑做系统设置验收,使用 SSH 转发后的 `http://127.0.0.1:28189/`。云测试主控制台使用受限内网入口 `http://100.85.111.121:8088/`。仓内 Compose 则将宿主 `8088` 映射到 Web 容器 `8080`。选择入口时先确认要看的部署。隧道命令、生产 `090` 服务地址和 HTTPS 反代示例见[运维手册](docs/OPERATIONS_RUNBOOK.md#入口与反向代理)。
|
||||
|
||||
**平台入口展示当前部署版本,不是每次 CI 的构建预览。** CI 静态预览由独立链路提供;CI 通过不会自动更新运行服务。
|
||||
|
||||
@@ -94,13 +95,7 @@ Compose 中网页入口固定映射为 **宿主机 `8088` → Web 容器 `8080`*
|
||||
- 来源目录、spool 与运行状态挂载;按部署主机调整路径和 UID/GID。
|
||||
- 测试 WeKnora 连接与对内/对外路由;生产发布按独立配置和授权接线。
|
||||
|
||||
准备完成后,由获授权的操作者执行:
|
||||
|
||||
```bash
|
||||
docker compose up --build -d
|
||||
```
|
||||
|
||||
主机需要提权时,由操作者按本机权限规则执行,不在自动化中默认使用 sudo。停止服务可用 `docker compose down`;**不要执行 `docker compose down -v`,除非明确批准删除数据库卷。**
|
||||
仓内 Compose 含 `postgres` 演练服务。云测试和生产使用阿里云 RDS,部署前先核对目标逻辑库、当前迁移版本、待运行的迁移及所用的环境配置。API 和 worker 启动可执行迁移。已有环境先用 `docker compose config --services` 检查服务清单,按该环境的发布手册切换已验证的产物。前端开发可直接使用下面的 Vite 流程。
|
||||
|
||||
## 配置与安全边界
|
||||
|
||||
@@ -114,7 +109,7 @@ docker compose up --build -d
|
||||
|
||||
## 开发与 CI
|
||||
|
||||
基础环境:Go 1.26、Node.js 22、npm,以及检查脚本所需的 Python 3 和工具链。依赖以仓库锁文件和实际 CI 配置为准。
|
||||
本机和 QA 虚拟机的依赖安装、前后端启动、测试命令及 PostgreSQL 测试库准备见 [开发与测试指南](docs/DEVELOPMENT_AND_TESTING.md)。
|
||||
|
||||
```bash
|
||||
make verify # 完整检查入口:本地与 CI 使用同一套规则
|
||||
|
||||
@@ -0,0 +1,131 @@
|
||||
# 知识治理平台开发与测试
|
||||
|
||||
以下命令从仓库根目录运行。日常开发可在 Ubuntu 宿主进行,指定提交的回归在 `hifox-qa` 的独立检出中运行。部署到阿里云测试服后的验收按 [操作 Runbook](OPERATIONS_RUNBOOK.md) 和 [用户流程验收](USER_FLOWS_ACCEPTANCE.md) 执行。
|
||||
|
||||
## QA 虚拟机一键回归
|
||||
|
||||
在 `hifox-qa` 检出提测提交后,运行下列入口。将 SHA 占位值换成提测记录里的完整提交 SHA。
|
||||
|
||||
```bash
|
||||
make qa-doctor
|
||||
KG_QA_SHA='<完整提交 SHA>' make qa
|
||||
```
|
||||
|
||||
`make qa-doctor` 检查工具链、HiFox 机器在线状态、OMP 模型调用、测试库身份和已安装的迁移。`make qa` 安装锁定依赖,在专用测试库上通过 API 初始化和迁移,随后核对完整迁移序列、API 就绪状态、Web 首页及 Vite 健康代理。通过后执行 Go 和 Vitest 测试,结束时关闭本次启动的服务。每次运行的服务日志保存在 `~/.local/state/knowledge-governance/qa/`。需要提交前完整门禁时执行 `make verify`。
|
||||
|
||||
初次配置由负责人在 QA 虚拟机准备 `~/.config/knowledge-governance/`。以下示例使用虚构的 RDS 主机名。
|
||||
|
||||
| 文件 | 内容 |
|
||||
| --- | --- |
|
||||
| `qa.json` | 当前用户所有、权限 `0600`,字段 `host`、`port`、`database`、`user` |
|
||||
| `qa.pgpass` | 当前用户所有、权限 `0600`,填写与 `qa.json` 匹配的口令条目 |
|
||||
| `rds-ca.pem` | 对应实例的 CA 证书,用于校验 RDS 主机名 |
|
||||
|
||||
```json
|
||||
{"host":"rds.example.test","port":5432,"database":"kg_qa_app","user":"kg_qa_app"}
|
||||
```
|
||||
|
||||
专用非生产 RDS 库和角色以 `kg_qa_` 开头,权限和网络准备见第 2 节。首次运行接受空库,后续运行接受与当前提交兼容的迁移序列。缺库、认证失败、迁移不兼容和端口冲突均会使命令非零退出。浏览器业务 E2E 和专用集成库的 Go 测试按第 4 节执行。
|
||||
|
||||
## 1. 检出代码与安装依赖
|
||||
|
||||
准备 Git、Make、Python 3、Go 1.26(含同一工具链的 `gofmt`)、Node.js 22 和 npm。数据库检查另需 PostgreSQL 客户端 `psql`。首次安装依赖需要能访问 Go 和 npm 的依赖源。
|
||||
|
||||
```bash
|
||||
# QA 在独立克隆中拉取提测分支,使用提测记录里的完整提交 SHA
|
||||
export KG_TARGET_BRANCH='<提测分支名>' KG_TARGET_SHA='<完整提交 SHA>'
|
||||
git fetch origin "$KG_TARGET_BRANCH" && git switch --detach "$KG_TARGET_SHA" &&
|
||||
test "$(git rev-parse HEAD)" = "$KG_TARGET_SHA" && test -z "$(git status --porcelain)"
|
||||
# 上面的命令链若失败,先解决检出或工作区问题再继续
|
||||
|
||||
# 检查当前 shell 的工具链,非交互任务也应设置相同的 PATH
|
||||
export PATH="$(go env GOROOT)/bin:$PATH"
|
||||
go version
|
||||
command -v gofmt
|
||||
node --version
|
||||
npm --version
|
||||
python3 --version
|
||||
make deps-install
|
||||
```
|
||||
|
||||
`make deps-install` 通过 `go mod download` 和 `npm ci` 安装依赖。Go 依赖由 `go.mod` / `go.sum` 约束,前端由 `web/package-lock.json` 锁定。依赖安装失败时先检查工具链、依赖源和锁文件,避免临时改写清单来绕过问题。
|
||||
|
||||
## 2. 准备开发和测试数据库
|
||||
|
||||
无库检查可直接跳到第 4 节。启动 API 或执行真库测试前,由数据库管理员在**非生产 PostgreSQL RDS** 上预建专用空库和登录角色。建议分配 `kg_qa_app` 给应用冒烟,`kg_qa_it` 给 Go 集成测试,各用独立角色。开发宿主另用开发专用库,避免与 QA 共享数据。库未分配时先申请,启动流程以库已存在为前提。
|
||||
|
||||
| 用途 | 所需权限 | 数据初始化 |
|
||||
| --- | --- | --- |
|
||||
| 应用启动与 UI 冒烟 | `CONNECT`,以及目标 schema 内的 `USAGE`、`CREATE` 和对应用对象的读写权限。迁移角色须能修改自己创建的对象。 | 首次 API 启动执行仓库内嵌迁移。用户表为空时创建初始管理员,首次登录必须修改密码。初始口令通过测试环境负责人交接。 |
|
||||
| Go PostgreSQL 集成测试 | `CONNECT` 和目标测试库的 `CREATE` 权限,用于建立各用例自己的 schema。 | 用例创建隔离 schema、执行迁移、写入测试数据并清理。相同测试不要并发指向同一个库,避免固定 schema 名冲突。 |
|
||||
|
||||
两类角色均只授予对应非生产库所需的权限。使用空库和合成数据。密码由操作者在目标机配置到权限为 `0600` 的 PostgreSQL passfile,条目按 `host:port:database:user:password` 填写。使用 RDS CA 校验证书。以下命令先读回实际数据库、角色与 TLS 状态,核对三者再启动 API 或运行真库测试。
|
||||
|
||||
```bash
|
||||
# 用获准的 RDS 主机名、端口、库名、角色和文件路径替换示例值
|
||||
export PGHOST='<非生产 RDS 主机名>' PGPORT=5432
|
||||
export PGDATABASE=kg_qa_app PGUSER=kg_qa_app
|
||||
export PGPASSFILE="$HOME/.config/knowledge-governance/qa.pgpass"
|
||||
export PGSSLROOTCERT="$HOME/.config/knowledge-governance/rds-ca.pem"
|
||||
export PGSSLMODE=verify-full PGCONNECT_TIMEOUT=5
|
||||
psql -X -v ON_ERROR_STOP=1 -c \
|
||||
'SELECT current_database(), current_user, ssl FROM pg_stat_ssl WHERE pid = pg_backend_pid();'
|
||||
```
|
||||
|
||||
如果是云厂商提供的私网地址,先确认执行机通过获准的网络路径可访问 RDS。库名、角色、TLS、连接权限或迁移权限有问题时,先交由环境负责人核对配置。实例上已有数据的库不能当作空库初始化。
|
||||
|
||||
## 3. 启动后端和前端
|
||||
|
||||
**终端 A,启动 API。** 在干净 shell 中执行第 2 节的应用库配置和连通性检查。使用独立测试配置,不加载现网 `.env`。
|
||||
|
||||
```bash
|
||||
export DATABASE_URL="postgresql://${PGUSER}@${PGHOST}:${PGPORT}/${PGDATABASE}?sslmode=verify-full&connect_timeout=5"
|
||||
export APP_ADDR=127.0.0.1:8088
|
||||
export TEST_WEKNORA_ENABLED=false PP_SCAN_ENABLED=false
|
||||
export RELEASE_WORKER_ENABLED=false PRODUCTION_RELEASE_REQUESTS_ENABLED=false
|
||||
export DOBOTAI_OPS_READ_ENABLED=false DOBOTAI_OPS_DIRECTORY_SYNC_ENABLED=false
|
||||
go run ./cmd/api
|
||||
```
|
||||
|
||||
API 会在监听前连接 PostgreSQL、应用迁移并初始化管理员。Web 页面和同步 API 联调只需运行 API 与 Vite。需要验证后台队列时,另用相同的隔离应用库配置启动普通 worker(`go run ./cmd/worker`)。涉及取件或来源刷新的任务还依赖容器内 `/app/scripts` 及获准的来源接线,按部署说明准备。发布 worker 无需启动。
|
||||
|
||||
Vite 通过 `localhost:8088` 转发 `/api` 和健康检查。如果 `8088` 已被其他部署占用,使用端口空闲的 QA 虚拟机运行本节。仅改前端时,可复用一个获准联调的测试 API,但需要先确认 `localhost:8088/health` 可达,并核对该地址指向的环境。
|
||||
|
||||
**终端 B,启动 Web。**
|
||||
|
||||
```bash
|
||||
npm --prefix web run dev -- --host 127.0.0.1 --port 5173 --strictPort
|
||||
```
|
||||
|
||||
在运行服务的机器打开 `http://127.0.0.1:5173/`。另开终端检查 API 与前端代理,再复查迁移记录。最后一条命令需要第 2 节的应用库配置。
|
||||
|
||||
```bash
|
||||
curl --fail --silent --show-error http://127.0.0.1:8088/health
|
||||
curl --fail --silent --show-error http://127.0.0.1:5173/health
|
||||
psql -X -v ON_ERROR_STOP=1 -c \
|
||||
'SELECT version FROM schema_migrations ORDER BY version DESC LIMIT 1;'
|
||||
```
|
||||
|
||||
空库首次启动后,用专用测试账号登录,按当次验收标准验证页面及接口。联调结束在两个终端按 `Ctrl+C` 停服务,数据库由环境管理员按测试数据保留规则管理。
|
||||
|
||||
## 4. 选择测试命令
|
||||
|
||||
| 目的 | 命令 |
|
||||
| --- | --- |
|
||||
| 查看检查及适用范围 | `make list` |
|
||||
| 后端包测试 | `make tests-go` |
|
||||
| 单个 Go 包及相关子包 | `go test -count=1 ./internal/httpapi/...` |
|
||||
| 前端 Vitest 套件 | `make tests-web` |
|
||||
| 单个前端测试文件 | `npm --prefix web test -- src/App.test.tsx` |
|
||||
| 完整提交前检查,与 CI 共用入口 | `make verify` |
|
||||
|
||||
`make verify` 包含安装、格式、静态检查、构建、测试、版本和安全检查,并写出 `ci-report.json`。在未导入真库测试配置的 shell 中运行。若检出时用了 `--no-tags`,先执行 `git fetch --tags origin`,以便版本检查读取正式标签对应的提交。依赖安装与安全检查需要相应网络或缓存。允许跳过的外部依赖用例见 [test-scope.json](../scripts/test-scope.json),真库测试应单独执行并记录结果。
|
||||
|
||||
在应用冒烟之外验证真实 PostgreSQL 行为时,重新按第 2 节切换并核对 **集成测试库和角色**,然后执行目标用例。下面以 UI 设置版本切换用例为例。
|
||||
|
||||
```bash
|
||||
TEST_DATABASE_URL="postgresql://${PGUSER}@${PGHOST}:${PGPORT}/${PGDATABASE}?sslmode=verify-full&connect_timeout=5" \
|
||||
go test -count=1 -v ./internal/platform/postgres -run '^TestUISettingsActivationRetiresPreviousRevisionIntegration$'
|
||||
```
|
||||
|
||||
检查输出出现目标用例的 `PASS`。用例被跳过或没有匹配时,应补齐配置或纠正用例名后重跑。前端 Vitest 负责组件与业务逻辑检查,浏览器 E2E 应单独执行并按 Feature 保存证据。提测记录至少包括完整提交 SHA、执行命令、退出码,以及失败用例的日志或浏览器截图。
|
||||
@@ -3,7 +3,86 @@
|
||||
按"实际干活顺序"排列的**现在的**操作流程。标注:**【新】**本期新增(含本次会话与 `f4e1ecc/6496ee3/9155bd3` 的 dws 取件)|**【变】**既有流程本期有改动|**【既有】**未变,仍照旧走。
|
||||
逐条验收证据请看 `docs/USER_FLOWS_ACCEPTANCE.md`;细节规则看各自专题文档。
|
||||
|
||||
统一入口 **http://127.0.0.1:8088/**(测试栈,右侧面板可直接操作)。角色:管理员 / 文档工程师 / 只读。
|
||||
管理员配置连接和发布授权,文档工程师维护资料,只读成员查看进度。先确定要操作的环境,再按下面的接线与验收步骤进入业务流程。
|
||||
|
||||
## 入口与反向代理
|
||||
|
||||
| 请求从哪里发出 | 地址或路径 | 实际目的地 |
|
||||
|---|---|---|
|
||||
| 已接入内网的运维电脑 | `http://100.85.111.121:8088/` | 云测试治理主站 |
|
||||
| 开发电脑的浏览器 | `http://127.0.0.1:28189/` | SSH 转发到测试机回环 `28189`,由候选 Web 提供静态资源 |
|
||||
| 测试候选 Nginx(host 网络) | `/api/`、`/health` | 测试机 `127.0.0.1:18099` 候选 API |
|
||||
| 同一候选 Nginx | `/api/v1/qa-ops/ai/` | 测试机 `127.0.0.1:18098` 现用治理 API,负责模型配置和连接验证 |
|
||||
| 标准 Compose Web(容器网络) | `/api/`、`/health` | Docker DNS 解析 `api:8080`。静态资源和 SPA 回退由同一 Web 提供 |
|
||||
|
||||
**在开发电脑恢复验收入口。** 前提是 SSH 别名 `weknora-test` 能登录测试机。先查远端服务,再查本机监听。本机端口空闲且远端正常时,在独立终端运行第三条命令,保留该终端。在另一终端执行最后一条并用浏览器打开同一地址。
|
||||
|
||||
```bash
|
||||
ssh weknora-test 'curl -fsS --max-time 5 http://127.0.0.1:28189/health'
|
||||
ss -ltn 'sport = :28189'
|
||||
ssh -NT -o ExitOnForwardFailure=yes -o ServerAliveInterval=30 -o ServerAliveCountMax=3 -L 127.0.0.1:28189:127.0.0.1:28189 weknora-test
|
||||
curl -fsS --max-time 5 http://127.0.0.1:28189/health
|
||||
```
|
||||
|
||||
**为内网域名配置 HTTPS。** 在能访问测试主站的受信任反代机上配置证书、内部 DNS 和访问范围。以下片段放入已有 HTTPS `server`,完整保留 URI、Host 和会话 Cookie。上游应选治理 Web 入口,使 `/assets/`、`/api/`、`/health` 走同一域名。若该入口的内层代理也设置 `X-Forwarded-Proto`,联调时检查其保留受信任 TLS 终止层的协议值以及登录回调的实际 URL。
|
||||
|
||||
```nginx
|
||||
location / {
|
||||
proxy_pass http://100.85.111.121:8088;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
```
|
||||
|
||||
在反代机执行 `nginx -t` 校验待应用配置。入口启用后,通过该域名验证登录、一次 `/api/` 请求和首页实际引用的 JS/CSS。`index.html` 应重新校验,带哈希的资源可长期缓存,缺失的 JS 返回 404。候选切换前后分别记录通用上游和 AI 专用上游。现场可在测试机用以下只读命令查看,容器名以当时部署为准。仓内同源配置见 [deploy/nginx.conf](../deploy/nginx.conf)。
|
||||
|
||||
```bash
|
||||
docker exec kg-test-storage-ui-6444814 nginx -T 2>&1 | grep -E 'listen .*28189|location /api/v1/qa-ops/ai/|set \$(api|health)_upstream|proxy_pass http://127[.]0[.]0[.]1:18098'
|
||||
docker inspect -f '{{.Name}} {{index .Config.Labels "release"}}' kg-test-storage-ui-6444814 kg-accept-090-api
|
||||
```
|
||||
|
||||
**现场版本与回退。** 本次在测试机读到 Web 标签 `4b615abe534b`、API 标签 `341c3154ac91`。完整候选包的 `current` 链接位于 `/opt/knowledge-governance/acceptance/090/current`,单独切换的 Web 位于同级 `web-only/4b615abe534b/dist`,实际反代配置位于 `integration/28189.conf`。切换前记录这三处、容器标签与旧 Web 名称。静态页回退时恢复上次的 Web 资源和对应代理配置。完整候选回退按同批装配工具的 `deploy/accept-090/README.md` 执行。回退后用浏览器重新验证首页资源、模型连接和列库。数据库迁移另按备份与恢复方案处理。
|
||||
|
||||
本次已核实共享测试治理库到 `000082`。对内、对外独立启用的实现依赖 `000083`,待独立库联调或共享库迁移获准后,再验证单侧暂停、保存和刷新。生产 `070` 不在该套验收范围。
|
||||
|
||||
下文系统设置中的绑定、盘点和模型连接步骤适用于上表的测试候选版本。根据现场标签选择对应版本的代码和交付物。
|
||||
|
||||
## 接入外部平台
|
||||
|
||||
| 平台与用途 | 管理员或运维怎样接 | 接通的证据 |
|
||||
|---|---|---|
|
||||
| 钉钉知识库,取目录和文件 | 系统设置 → 数据源配置 → 钉钉授权。用 DWS 设备授权,以来源账号选择组织、空间和范围。API 与 worker 使用部署约定的 DWS 身份目录 | 登录后读回预期空间,选一个有权限的目录校验。登记来源、扫描完成和文件取件分别核验。 |
|
||||
| AList,取工业或教育资料 | 按来源登记服务根地址和允许的目录。普通 worker 读取专用令牌文件。目录接口 `POST /api/fs/list` 使用 `X-Gateway-Token` | 在来源页扫描已知根目录,对照一个子目录和一份文件。下载遵循来源签名链接,凭据和签名 URL 仅留在受控运行环境。[目录与取件](SOURCE_CATALOG_LIVE_ROUTING_ACCEPTANCE.md) |
|
||||
| PP 资料门户 | 在数据源配置填写 HTTPS 根地址和来源账号,点「测试连接」后「保存并校验」。API 和 worker 共享 `PP_AUTH_STATE_FILE` 所在目录 | 真实登录并读取一条目录记录,刷新后核对生效配置。超时或限流时查看待验证状态。 |
|
||||
| WeKnora 测试 090,处理与验收 | 系统设置 → 知识库绑定 → 测试 090。当前测试 API 地址 `http://127.0.0.1:8092`,由治理服务器访问。输入该实例的专用 Key 或使用已配置凭据 | 「验证并读取知识库」能列出预期库。核对名称和 ID,为对内、对外选择不同的目标,保存后刷新读回 |
|
||||
| WeKnora 生产 090,列库与映射 | 在同页切到生产 090,使用下节的转发入口与生产专用 Key。新连接的安全存储由 `WEKNORA_BINDING_MASTER_KEY_FILE` 提供 | 读取生产目录并核对两个目标 ID,保存后重新进入生产页核实。执行发布另按 §5–6 授权 |
|
||||
| 问答 AI 模型 | 系统设置 → AI 模型连接,填写 OpenAI 兼容基础地址(含服务要求的 `/v1`)、模型名及专用 Key。API 与普通 worker 使用同一 `QA_AI_MASTER_KEY_FILE` | 点「测试连接」等待成功,需生效时再保存并刷新检查模型名。存储密钥、权限与 DNS 配置见 [README](../README.md#问答运营模型配置) |
|
||||
|
||||
**生产 090 的两段地址。** 生产机私网 IP 为 `172.29.151.11`,其 WeKnora API 对宿主回环发布 `127.0.0.1:18092`。测试治理机上已有 SSH 本地转发,治理 API 使用 host 网络,故页面的生产服务地址填写 **`http://127.0.0.1:18092`**。请求从治理 API 发出,经测试机的回环监听到生产机的回环 API。浏览器所在电脑的 `127.0.0.1:28189` 则用于打开治理页面。迁到 bridge 网络时要从新 API 容器重新验证上游可达性。
|
||||
|
||||
在**测试治理机**上检验已有通道。`/health` 返回 200 证明转发可用,无凭据列库返回 401 表明请求已到认证层。接着在治理页面安全输入该实例的 Key 并验证真实库列表。本次核验时,生产通道探活成功,匿名列库返回 401。带生产凭据列库和保存映射仍待验收。
|
||||
|
||||
```bash
|
||||
ss -ltnp 'sport = :18092'
|
||||
curl --noproxy '*' --max-time 5 -sS -o /dev/null -w 'health %{http_code}\n' http://127.0.0.1:18092/health
|
||||
curl --noproxy '*' --max-time 5 -sS -o /dev/null -w 'catalog %{http_code}\n' http://127.0.0.1:18092/api/v1/knowledge-bases
|
||||
```
|
||||
|
||||
## 开发测试和现场验收
|
||||
|
||||
1. 在开发机运行 `make list` 查看门禁,`make verify` 做整套检查。以 `ci-report.json` 的 `commit_sha` 对照 `git rev-parse HEAD`,记录失败或跳过项。前端启动和组件测试见 [开发与 CI](../README.md#开发与-ci)。
|
||||
2. 针对后端改动,在独立测试逻辑库核对 `SELECT current_database(), max(version) FROM schema_migrations;` 与候选版本的迁移目录。云端多个候选可能共用治理 RDS。只改静态页面时单独切换 Web,保留原资源和代理配置供回滚。
|
||||
3. 在指定入口以真实账号分别验证。来源页读取一条已知记录,模型页测试到成功终态,知识库绑定在正确环境列库,保存后刷新核对。存储页按最近批次和子库目录分别与 `du -sB1 -- <目录>` 对账。记录入口、Web/API 提交、时间和结果。
|
||||
4. 候选备份页读取宿主采集的 `metadata.json`,API 只读挂载输出目录。「重新盘点」只重读文件。超过 `BACKUP_HOST_METADATA_MAX_AGE` 时,目录、占盘和预测转为未知。宿主重新采集后核对采集时间是否前进、批次是否恢复。测试现场使用按次采集、15 分钟有效期。采集脚本和挂载参数以同批测试候选交付物为准。
|
||||
|
||||
| 症状 | 第一步怎么查 | 如何判定 |
|
||||
|---|---|---|
|
||||
| 浏览器连接被拒 | 对照本机 `28189` 监听和测试机 `/health` | 远端正常、本机无监听时恢复本机 SSH 转发 |
|
||||
| 页面打开,某个 API 404 或 502 | 查浏览器请求路径、Nginx 生效上游及对应 API 版本 | 404 先查路由是否存在,502 先查上游是否可达。AI 页单独核对 `18098` |
|
||||
| 能探活,列库仍灰或返回 401 | 核对选中环境、凭据配置状态、容器运行 UID 与凭据文件可读性 | 用该环境的专用身份实际列库。检查过程只记录状态码和可读性 |
|
||||
| 历史可读,计划或配额显示未知 | 核对快照年龄、执行主机连接与配额字段 | 盘点、SSH 计划、配额分别验证。只有主机实际读回 cron 才能报告下一次执行时间 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -48,7 +48,10 @@ func TestNormalizeRefusesEnabledSettingsWithoutTransportAndBadRecipients(t *test
|
||||
t.Fatalf("defaults not applied: %+v %v", good, err)
|
||||
}
|
||||
// 解析不了的主机名必须仍被判为非法:.invalid 是 RFC 6761 保留域,永远不解析。
|
||||
if _, err := normalize(SettingsInput{Host: "smtp.kg-test.invalid", From: "kb@example.com",
|
||||
// 末尾的点是必须的:构建机的 resolv.conf 可能带 search 域(本环境 Tailscale
|
||||
// 的 tailf49802.ts.net),不带点就会被拼成 smtp.kg-test.invalid.<search> 并
|
||||
// 由 Fake-IP DNS 解析出来,于是这条断言测的是构建机的搜索域而不是被测逻辑。
|
||||
if _, err := normalize(SettingsInput{Host: "smtp.kg-test.invalid.", From: "kb@example.com",
|
||||
Recipients: []string{"a@example.com"}}); err != ErrInvalid {
|
||||
t.Fatalf("unresolvable host must stay invalid, got %v", err)
|
||||
}
|
||||
|
||||
@@ -356,6 +356,10 @@ def cmd_internal_web_test() -> int:
|
||||
def cmd_internal_contracts(go: str) -> int:
|
||||
"""版本契约:结构 + 注入身份必须**真 PASS**(SKIP 判红),
|
||||
并且**开发构建不许自称正式版**(负例:标成 release ⇒ 必须红)。"""
|
||||
qa_rc = subprocess.run(py("-m", "unittest", "discover", "-s", "scripts", "-p", "test_qa_env.py", "-v"),
|
||||
cwd=ROOT).returncode
|
||||
if qa_rc:
|
||||
return qa_rc
|
||||
snapshot_rc = subprocess.run(py("scripts/development_snapshot.py","--self-test"),cwd=ROOT).returncode
|
||||
if snapshot_rc:
|
||||
return 1
|
||||
|
||||
@@ -0,0 +1,374 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Prepare and exercise an isolated Knowledge Governance QA run."""
|
||||
|
||||
import argparse
|
||||
from contextlib import ExitStack
|
||||
import fcntl
|
||||
import http.client
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
import re
|
||||
import shutil
|
||||
import signal
|
||||
import socket
|
||||
import stat
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import time
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
CONFIG = Path.home() / '.config/knowledge-governance/qa.json'
|
||||
API_PORT = 8088
|
||||
WEB_PORT = 5173
|
||||
RUNTIME_RESPONSE = 'KG_QA_RUNTIME_OK'
|
||||
|
||||
|
||||
class QAError(RuntimeError):
|
||||
pass
|
||||
|
||||
|
||||
def report(stage, detail):
|
||||
print(f'[qa:{stage}] {detail}', flush=True)
|
||||
|
||||
|
||||
def capture(argv, stage, timeout=10, env=None):
|
||||
try:
|
||||
return subprocess.run(argv, cwd=ROOT, env=env, text=True, capture_output=True,
|
||||
timeout=timeout, stdin=subprocess.DEVNULL)
|
||||
except FileNotFoundError as exc:
|
||||
raise QAError(f'{stage} 缺少命令 {argv[0]}') from exc
|
||||
except subprocess.TimeoutExpired as exc:
|
||||
raise QAError(f'{stage} 超过 {timeout} 秒') from exc
|
||||
|
||||
|
||||
def private_file(path):
|
||||
try:
|
||||
info = path.lstat()
|
||||
except FileNotFoundError as exc:
|
||||
raise QAError(f'缺少测试配置文件 {path}') from exc
|
||||
if not stat.S_ISREG(info.st_mode) or info.st_uid != os.getuid() or stat.S_IMODE(info.st_mode) != 0o600:
|
||||
raise QAError(f'{path} 必须是当前用户所有的 0600 普通文件')
|
||||
|
||||
|
||||
def database_config(path):
|
||||
private_file(path)
|
||||
try:
|
||||
config = json.loads(path.read_text())
|
||||
except (UnicodeError, json.JSONDecodeError) as exc:
|
||||
raise QAError(f'{path} 不是有效 JSON') from exc
|
||||
if not isinstance(config, dict) or config.keys() != {'host', 'port', 'database', 'user'}:
|
||||
raise QAError('qa.json 只接受 host、port、database、user 四个字段')
|
||||
for field in ('database', 'user'):
|
||||
if not re.fullmatch(r'kg_qa_[a-z0-9_]{1,56}', str(config[field])):
|
||||
raise QAError(f'RDS {field} 必须以 kg_qa_ 开头并使用小写字母、数字或下划线')
|
||||
host = config['host']
|
||||
if not isinstance(host, str) or not re.fullmatch(r'[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)+', host):
|
||||
raise QAError('RDS host 必须填写证书对应的 DNS 主机名')
|
||||
if type(config['port']) is not int or not 1 <= config['port'] <= 65535:
|
||||
raise QAError('RDS port 必须是 1–65535 的整数')
|
||||
return config
|
||||
|
||||
|
||||
def tool_env():
|
||||
allowed = ('HOME', 'PATH', 'LANG', 'TMPDIR', 'GOPROXY', 'GOSUMDB', 'GOPRIVATE', 'GONOSUMDB',
|
||||
'GOMODCACHE', 'GOCACHE', 'npm_config_cache', 'npm_config_registry',
|
||||
'HTTP_PROXY', 'HTTPS_PROXY', 'ALL_PROXY', 'NO_PROXY',
|
||||
'http_proxy', 'https_proxy', 'all_proxy', 'no_proxy')
|
||||
env = {key: os.environ[key] for key in allowed if key in os.environ}
|
||||
env['GOFLAGS'] = '-mod=readonly'
|
||||
return env
|
||||
|
||||
|
||||
def database_env(config, directory):
|
||||
# Keep inherited PG variables and integration switches out of application children.
|
||||
env = tool_env()
|
||||
env.update(PGHOST=config['host'], PGPORT=str(config['port']), PGDATABASE=config['database'],
|
||||
PGUSER=config['user'], PGSSLMODE='verify-full', PGCONNECT_TIMEOUT='5',
|
||||
PGPASSFILE=str(directory / 'qa.pgpass'), PGSSLROOTCERT=str(directory / 'rds-ca.pem'),
|
||||
PGOPTIONS='-c search_path=public', LC_ALL='C',
|
||||
TEST_WEKNORA_ENABLED='false', PP_SCAN_ENABLED='false',
|
||||
RELEASE_WORKER_ENABLED='false', PRODUCTION_RELEASE_REQUESTS_ENABLED='false',
|
||||
DOBOTAI_OPS_READ_ENABLED='false', DOBOTAI_OPS_DIRECTORY_SYNC_ENABLED='false')
|
||||
env['APP_ADDR'] = f'127.0.0.1:{API_PORT}'
|
||||
env['DATA' + 'BASE_URL'] = (
|
||||
f"postgresql://{config['user']}@{config['host']}:{config['port']}/{config['database']}"
|
||||
'?sslmode=verify-full&connect_timeout=5&search_path=public'
|
||||
)
|
||||
return env
|
||||
|
||||
|
||||
def psql(env, sql):
|
||||
result = capture(['psql', '-XAtw', '-v', 'ON_ERROR_STOP=1', '-c', sql], 'RDS 探针', env=env)
|
||||
if result.returncode == 0:
|
||||
return result.stdout.strip()
|
||||
detail = result.stderr.lower()
|
||||
hints = (
|
||||
('password', '口令认证失败,检查 qa.pgpass 和登录角色'),
|
||||
('certificate', 'TLS 校验失败,检查 RDS 主机名和 CA'),
|
||||
('does not exist', '数据库或角色不存在,联系管理员确认专用 QA 库'),
|
||||
('permission denied', 'RDS 权限不足,检查专用 QA 角色的 CONNECT、schema USAGE/CREATE 权限'),
|
||||
('could not translate host name', 'RDS 主机名无法解析,检查私网 DNS'),
|
||||
('timeout', '连接 RDS 超时,检查 QA 虚拟机到 RDS 的私网和安全组'),
|
||||
('connection refused', 'RDS 拒绝 TCP 连接,检查主机名、端口和私网接入'),
|
||||
)
|
||||
hint = next((message for marker, message in hints if marker in detail), '连接或 SQL 探针失败,检查 RDS 接入和权限')
|
||||
raise QAError(f'RDS {hint}(psql 退出 {result.returncode})')
|
||||
|
||||
|
||||
def database_state(env):
|
||||
identity = psql(env, """
|
||||
SELECT concat_ws('|', current_database(), current_user,
|
||||
COALESCE((SELECT ssl FROM pg_stat_ssl WHERE pid = pg_backend_pid()), false),
|
||||
(SELECT NOT (rolsuper OR rolcreaterole OR rolcreatedb OR rolreplication OR rolbypassrls)
|
||||
FROM pg_roles WHERE rolname = current_user),
|
||||
(has_schema_privilege(current_user, 'public', 'USAGE') AND
|
||||
has_schema_privilege(current_user, 'public', 'CREATE')),
|
||||
to_regclass('public.schema_migrations') IS NOT NULL,
|
||||
EXISTS (SELECT FROM pg_class c JOIN pg_namespace n ON n.oid=c.relnamespace
|
||||
WHERE n.nspname = 'public' AND c.relname <> 'schema_migrations')
|
||||
OR EXISTS (SELECT FROM pg_namespace
|
||||
WHERE nspname NOT IN ('public', 'information_schema') AND nspname !~ '^pg_')
|
||||
OR EXISTS (SELECT FROM pg_proc p JOIN pg_namespace n ON n.oid=p.pronamespace
|
||||
WHERE n.nspname = 'public'));
|
||||
""")
|
||||
fields = identity.split('|')
|
||||
if len(fields) != 7 or fields[:4] != [env['PGDATABASE'], env['PGUSER'], 't', 't']:
|
||||
raise QAError('RDS 实际库名、角色、TLS 或角色权限与 QA 配置不符')
|
||||
if fields[4] != 't':
|
||||
raise QAError('RDS 角色需要 public schema 的 USAGE 和 CREATE 权限')
|
||||
rows = psql(env, 'SELECT version FROM public.schema_migrations ORDER BY version;') if fields[5] == 't' else ''
|
||||
if any(not re.fullmatch(r'[0-9]+', row) for row in rows.splitlines()):
|
||||
raise QAError('RDS 迁移记录包含无效版本')
|
||||
return [int(row) for row in rows.splitlines()], fields[6] == 't'
|
||||
|
||||
|
||||
def expected_migrations():
|
||||
paths = (ROOT / 'internal/platform/postgres/migrations').glob('*.up.sql')
|
||||
try:
|
||||
versions = sorted(int(path.name.split('_', 1)[0]) for path in paths)
|
||||
except ValueError as exc:
|
||||
raise QAError('仓库存在无效的迁移文件名') from exc
|
||||
if not versions or len(versions) != len(set(versions)):
|
||||
raise QAError('仓库迁移文件缺失或版本重复')
|
||||
return versions
|
||||
|
||||
|
||||
def check_migrations(expected, applied, nonempty, *, complete):
|
||||
if not applied and nonempty:
|
||||
raise QAError('RDS 非空且缺少有效迁移记录,停止初始化')
|
||||
if expected[:len(applied)] != applied:
|
||||
raise QAError('RDS 迁移序列与当前提交不兼容,使用专用空库或匹配的测试库')
|
||||
if complete and applied != expected:
|
||||
raise QAError(f'RDS 迁移未完成,缺少版本 {expected[len(applied)]} 至 {expected[-1]}')
|
||||
|
||||
|
||||
def check_hifox(output):
|
||||
try:
|
||||
state = json.loads(output)
|
||||
online = state['connected'] is True and state['remoteLiveness']['status'] == 'online'
|
||||
except (ValueError, KeyError, TypeError) as exc:
|
||||
raise QAError('HiFox 未返回有效的在线状态,检查本机注册和接收服务') from exc
|
||||
if not online:
|
||||
raise QAError('HiFox 未确认测试机在线,检查本机接收服务和网络')
|
||||
|
||||
|
||||
def check_checkout(expected):
|
||||
if not re.fullmatch(r'[0-9a-f]{40}', expected):
|
||||
raise QAError('设置 KG_QA_SHA 为提测的完整 40 位 Git SHA')
|
||||
actual = capture(['git', 'rev-parse', 'HEAD'], 'Git 检出')
|
||||
if actual.returncode or actual.stdout.strip() != expected:
|
||||
raise QAError('Git 检出与提测提交不一致')
|
||||
state = capture(['git', 'status', '--porcelain'], 'Git 状态')
|
||||
if state.returncode or state.stdout.strip():
|
||||
raise QAError('QA 需要干净的独立检出,请检查 Git 状态')
|
||||
|
||||
|
||||
def preflight(env):
|
||||
for cmd in ('git', 'make', 'go', 'node', 'npm', 'psql', 'hifox', 'omp'):
|
||||
if not shutil.which(cmd, path=env.get('PATH')):
|
||||
raise QAError(f'工具链缺少 {cmd},检查 QA 机器的 PATH')
|
||||
go = capture(['go', 'env', 'GOROOT', 'GOVERSION'], 'Go 工具链', env=env)
|
||||
fields = go.stdout.splitlines()
|
||||
if go.returncode or len(fields) != 2 or not fields[1].startswith('go1.26.'):
|
||||
raise QAError('QA 需要 Go 1.26 工具链')
|
||||
root = Path(fields[0]) / 'bin'
|
||||
if not os.access(root / 'gofmt', os.X_OK):
|
||||
raise QAError('Go 工具链缺少 gofmt,请安装完整的 Go 1.26')
|
||||
env['PATH'] = f"{root}:{env['PATH']}"
|
||||
node = capture(['node', '--version'], 'Node.js 工具链', env=env)
|
||||
if node.returncode or not node.stdout.startswith('v22.'):
|
||||
raise QAError('QA 需要 Node.js 22 工具链')
|
||||
report('toolchain', f'{fields[1]} / Node.js {node.stdout.strip()}')
|
||||
|
||||
hifox = capture(['hifox', 'computer', 'status', '--output', 'json'], 'HiFox 在线检查', timeout=15)
|
||||
if hifox.returncode:
|
||||
raise QAError(f'HiFox 状态命令失败(退出 {hifox.returncode})')
|
||||
check_hifox(hifox.stdout)
|
||||
report('machine', f'{socket.gethostname()} / HiFox online')
|
||||
prompt = f'Reply with exactly {RUNTIME_RESPONSE}. Do not use tools.'
|
||||
omp = capture(['omp', '--no-session', '-p', prompt], 'OMP Runtime 探针', timeout=35)
|
||||
if omp.returncode or RUNTIME_RESPONSE not in {line.strip() for line in omp.stdout.splitlines()}:
|
||||
raise QAError('OMP Runtime 没有返回探针结果,检查 OMP 模型配置和 Magpie 网关')
|
||||
report('runtime', 'OMP 模型请求通过')
|
||||
|
||||
|
||||
def check_ports():
|
||||
for port in (API_PORT, WEB_PORT):
|
||||
with socket.socket() as listener:
|
||||
listener.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||
try:
|
||||
listener.bind(('127.0.0.1', port))
|
||||
except OSError as exc:
|
||||
raise QAError(f'QA 端口 {port} 无法绑定,检查已有监听进程') from exc
|
||||
|
||||
|
||||
def run_step(argv, stage, env, timeout):
|
||||
report(stage, ' '.join(argv[:2]))
|
||||
process = subprocess.Popen(argv, cwd=ROOT, env=env, stdin=subprocess.DEVNULL, start_new_session=True)
|
||||
try:
|
||||
code = process.wait(timeout=timeout)
|
||||
except subprocess.TimeoutExpired as exc:
|
||||
raise QAError(f'{stage} 超过 {timeout} 秒') from exc
|
||||
finally:
|
||||
stop_process(process)
|
||||
if code:
|
||||
raise QAError(f'{stage} 失败(退出 {code}),查看上方命令输出')
|
||||
|
||||
|
||||
def stop_process(process):
|
||||
try:
|
||||
os.killpg(process.pid, signal.SIGTERM)
|
||||
except ProcessLookupError:
|
||||
pass
|
||||
try:
|
||||
process.wait(timeout=5)
|
||||
except subprocess.TimeoutExpired:
|
||||
try:
|
||||
os.killpg(process.pid, signal.SIGKILL)
|
||||
except ProcessLookupError:
|
||||
pass
|
||||
process.wait(timeout=5)
|
||||
|
||||
|
||||
def start_service(stack, argv, env, log):
|
||||
output = stack.enter_context(log.open('w', encoding='utf-8'))
|
||||
process = subprocess.Popen(argv, cwd=ROOT, env=env, stdin=subprocess.DEVNULL,
|
||||
stdout=output, stderr=subprocess.STDOUT, start_new_session=True)
|
||||
stack.callback(stop_process, process)
|
||||
return process
|
||||
|
||||
|
||||
def request(port, path):
|
||||
connection = http.client.HTTPConnection('127.0.0.1', port, timeout=2)
|
||||
try:
|
||||
connection.request('GET', path)
|
||||
response = connection.getresponse()
|
||||
return response.status, response.getheader('Content-Type', ''), response.read(32768)
|
||||
finally:
|
||||
connection.close()
|
||||
|
||||
|
||||
def probe(port, path, expected):
|
||||
try:
|
||||
code, content_type, body = request(port, path)
|
||||
if code != 200:
|
||||
return False
|
||||
if expected == 'html':
|
||||
return 'text/html' in content_type and b'id="root"' in body
|
||||
return 'application/json' in content_type and json.loads(body)['status'] == expected
|
||||
except (OSError, http.client.HTTPException, ValueError, KeyError, TypeError):
|
||||
return False
|
||||
|
||||
|
||||
def wait_service(process, port, path, expected, log):
|
||||
deadline = time.monotonic() + 45
|
||||
while time.monotonic() < deadline:
|
||||
if process.poll() is not None:
|
||||
raise QAError(f'服务端口 {port} 启动进程提前退出(退出 {process.returncode}),日志 {log}')
|
||||
if probe(port, path, expected):
|
||||
return
|
||||
time.sleep(0.25)
|
||||
raise QAError(f'服务探针超时 127.0.0.1:{port}{path},日志 {log}')
|
||||
|
||||
|
||||
def qa_run(commit, env, db_env, versions, state):
|
||||
with tempfile.TemporaryDirectory(prefix='run-', dir=state) as directory, ExitStack() as services:
|
||||
binary = Path(directory) / 'api'
|
||||
run_step(['make', 'deps-install'], 'deps', env, 300)
|
||||
ldflags = f'-X knowledge-governance/internal/version.CommitSHA={commit}'
|
||||
run_step(['go', 'build', '-ldflags', ldflags, '-o', str(binary), './cmd/api'], 'build-api', env, 300)
|
||||
check_ports()
|
||||
log_dir = Path(tempfile.mkdtemp(prefix=f'{commit[:12]}-', dir=state))
|
||||
report('logs', str(log_dir))
|
||||
app_env = db_env | {'PATH': env['PATH'], 'GOVERNANCE_SPOOL_ROOT': str(Path(directory) / 'spool')}
|
||||
api_log = log_dir / 'api.log'
|
||||
api = start_service(services, [str(binary)], app_env, api_log)
|
||||
wait_service(api, API_PORT, '/readyz', 'ready', api_log)
|
||||
check_migrations(versions, *database_state(db_env), complete=True)
|
||||
report('migration', f'已核对全部 {len(versions)} 条迁移,最新版本 {versions[-1]}')
|
||||
|
||||
web_log = log_dir / 'web.log'
|
||||
web = start_service(services, ['npm', '--prefix', 'web', 'run', 'dev', '--', '--host', '127.0.0.1',
|
||||
'--port', str(WEB_PORT), '--strictPort'], env, web_log)
|
||||
wait_service(web, WEB_PORT, '/', 'html', web_log)
|
||||
wait_service(web, WEB_PORT, '/health', 'ok', web_log)
|
||||
report('services', 'API /readyz、Web 首页与 Vite /health 代理通过')
|
||||
run_step(['make', 'tests-go', 'tests-web'], 'tests', env, 300)
|
||||
check_checkout(commit)
|
||||
if api.poll() is not None or web.poll() is not None or not probe(WEB_PORT, '/health', 'ok'):
|
||||
raise QAError(f'服务在测试期间失去健康状态,日志目录 {log_dir}')
|
||||
report('result', f'PASS {commit},已停止本次 API 和 Web 进程')
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
parser.add_argument('action', choices=('doctor', 'run'))
|
||||
args = parser.parse_args()
|
||||
env = tool_env()
|
||||
try:
|
||||
commit = os.environ.get('KG_QA_SHA', '')
|
||||
if args.action == 'run':
|
||||
check_checkout(commit)
|
||||
check_ports()
|
||||
preflight(env)
|
||||
config_path = Path(os.environ.get('KG_QA_CONFIG', CONFIG)).expanduser().absolute()
|
||||
config = database_config(config_path)
|
||||
private_file(config_path.parent / 'qa.pgpass')
|
||||
if not (config_path.parent / 'rds-ca.pem').is_file():
|
||||
raise QAError(f'缺少 RDS CA 文件 {config_path.parent / "rds-ca.pem"}')
|
||||
db_env = database_env(config, config_path.parent)
|
||||
versions = expected_migrations()
|
||||
if args.action == 'doctor':
|
||||
applied, nonempty = database_state(db_env)
|
||||
check_migrations(versions, applied, nonempty, complete=False)
|
||||
report('database', f'连接与身份正常,已应用 {len(applied)}/{len(versions)} 条迁移')
|
||||
return 0
|
||||
|
||||
state = Path.home() / '.local/state/knowledge-governance/qa'
|
||||
state.mkdir(mode=0o700, parents=True, exist_ok=True)
|
||||
with (state / 'run.lock').open('a') as lock:
|
||||
try:
|
||||
fcntl.flock(lock, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
||||
except BlockingIOError as exc:
|
||||
raise QAError('本机已有 QA 任务,等待当前任务退出') from exc
|
||||
check_ports()
|
||||
check_migrations(versions, *database_state(db_env), complete=False)
|
||||
qa_run(commit, env, db_env, versions, state)
|
||||
return 0
|
||||
except (QAError, OSError, ValueError) as exc:
|
||||
print(f'[qa:FAIL] {exc}', file=sys.stderr)
|
||||
return 1
|
||||
except KeyboardInterrupt:
|
||||
print('[qa:FAIL] QA 任务中断', file=sys.stderr)
|
||||
return 130
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
def interrupt(_signal, _frame):
|
||||
raise KeyboardInterrupt
|
||||
|
||||
signal.signal(signal.SIGTERM, interrupt)
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,99 @@
|
||||
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
|
||||
import json
|
||||
import os
|
||||
from threading import Thread
|
||||
from pathlib import Path
|
||||
import subprocess
|
||||
import tempfile
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
import qa_env
|
||||
|
||||
|
||||
class QAEnvironmentTests(unittest.TestCase):
|
||||
def test_missing_approval_config_names_file(self):
|
||||
with tempfile.TemporaryDirectory() as directory:
|
||||
config = Path(directory) / 'qa.json'
|
||||
with self.assertRaisesRegex(qa_env.QAError, 'qa.json'):
|
||||
qa_env.database_config(config)
|
||||
|
||||
def test_rejects_non_qa_database_before_connection(self):
|
||||
with tempfile.TemporaryDirectory() as directory:
|
||||
config = Path(directory) / 'qa.json'
|
||||
config.write_text(json.dumps(dict(host='rds.example.test', port=5432,
|
||||
database='governance', user='kg_qa_app')))
|
||||
config.chmod(0o600)
|
||||
with self.assertRaisesRegex(qa_env.QAError, 'kg_qa_'):
|
||||
qa_env.database_config(config)
|
||||
|
||||
def test_database_environment_uses_only_approved_identity(self):
|
||||
settings = dict(host='rds.example.test', port=5432, database='kg_qa_app', user='kg_qa_app')
|
||||
with patch.dict(os.environ, {'PGHOSTADDR': '127.0.0.1', 'PGPASSWORD': 'fixture',
|
||||
'PGSERVICE': 'other', 'PRODUCTION_RELEASE_REQUESTS_ENABLED': 'true'}):
|
||||
env = qa_env.database_env(settings, Path('/approved'))
|
||||
self.assertEqual(env['PGHOST'], 'rds.example.test')
|
||||
self.assertEqual(env['PGSSLMODE'], 'verify-full')
|
||||
self.assertEqual(env['PRODUCTION_RELEASE_REQUESTS_ENABLED'], 'false')
|
||||
self.assertFalse({'PGHOSTADDR', 'PGPASSWORD', 'PGSERVICE'} & env.keys())
|
||||
|
||||
def test_empty_database_or_known_migration_prefix_can_bootstrap(self):
|
||||
for applied in ([], [1], [1, 2]):
|
||||
with self.subTest(applied=applied):
|
||||
qa_env.check_migrations([1, 2], applied, False, complete=False)
|
||||
|
||||
def test_pending_migrations_block_testing(self):
|
||||
with self.assertRaisesRegex(qa_env.QAError, '迁移未完成'):
|
||||
qa_env.check_migrations([1, 2], [1], False, complete=True)
|
||||
|
||||
def test_schema_without_ledger_is_rejected(self):
|
||||
with self.assertRaisesRegex(qa_env.QAError, '非空'):
|
||||
qa_env.check_migrations([1, 2], [], True, complete=False)
|
||||
|
||||
def test_unknown_or_missing_middle_migrations_are_rejected(self):
|
||||
for applied in ([1, 3], [1, 2, 3], [2]):
|
||||
with self.subTest(applied=applied), self.assertRaisesRegex(qa_env.QAError, '迁移序列'):
|
||||
qa_env.check_migrations([1, 2], applied, False, complete=False)
|
||||
|
||||
def test_hifox_exit_zero_does_not_override_offline_state(self):
|
||||
with self.assertRaisesRegex(qa_env.QAError, '在线'):
|
||||
qa_env.check_hifox('{"connected":true,"remoteLiveness":{"status":"offline"}}')
|
||||
qa_env.check_hifox('{"connected":true,"remoteLiveness":{"status":"online"}}')
|
||||
|
||||
def test_health_probe_rejects_spa_fallback(self):
|
||||
class Handler(BaseHTTPRequestHandler):
|
||||
def do_GET(self):
|
||||
self.send_response(200)
|
||||
self.send_header('Content-Type', 'text/html')
|
||||
self.end_headers()
|
||||
self.wfile.write(b'<html><div id="root"></div></html>')
|
||||
|
||||
def log_message(self, format, *args):
|
||||
pass
|
||||
|
||||
with ThreadingHTTPServer(('127.0.0.1', 0), Handler) as server:
|
||||
thread = Thread(target=server.serve_forever)
|
||||
thread.start()
|
||||
try:
|
||||
self.assertTrue(qa_env.probe(server.server_port, '/', 'html'))
|
||||
self.assertFalse(qa_env.probe(server.server_port, '/health', 'ok'))
|
||||
finally:
|
||||
server.shutdown()
|
||||
thread.join()
|
||||
|
||||
def test_database_identity_mismatch_stops_before_reading_migrations(self):
|
||||
env = {'PGDATABASE': 'kg_qa_app', 'PGUSER': 'kg_qa_app'}
|
||||
with patch.object(qa_env, 'psql', return_value='other|kg_qa_app|t|t|t|t|t') as probe:
|
||||
with self.assertRaisesRegex(qa_env.QAError, '实际库名'):
|
||||
qa_env.database_state(env)
|
||||
self.assertEqual(probe.call_count, 1)
|
||||
|
||||
def test_full_sha_mismatch_rejects_current_checkout(self):
|
||||
full_sha = subprocess.check_output(['git', 'rev-parse', 'HEAD'], cwd=qa_env.ROOT, text=True).strip()
|
||||
wrong = ('0' if full_sha[0] != '0' else '1') + full_sha[1:]
|
||||
with self.assertRaisesRegex(qa_env.QAError, '提交不一致'):
|
||||
qa_env.check_checkout(wrong)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user