Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 7136689efe | |||
| e366605299 | |||
| 707d97760f | |||
| d17804e45b |
21
SKILL.md
21
SKILL.md
@@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
name: 技能开发模板(通用业务版)
|
name: 技能开发模板(通用业务版)
|
||||||
description: "OpenClaw 通用业务技能开发模板,供复制后定制新业务 skill。定制步骤见 development/DEVELOPMENT.md。"
|
description: "OpenClaw 通用业务技能开发模板,供复制后定制新业务 skill。定制步骤见 development/DEVELOPMENT.md。"
|
||||||
version: 1.0.14
|
version: 1.0.32
|
||||||
author: 深圳匠厂科技有限公司
|
author: 深圳匠厂科技有限公司
|
||||||
metadata:
|
metadata:
|
||||||
openclaw:
|
openclaw:
|
||||||
slug: your-skill-slug
|
slug: your-skill-slug
|
||||||
platform_kit_min_version: "1.0.14"
|
platform_kit_min_version: "1.0.17"
|
||||||
emoji: "📦"
|
emoji: "📦"
|
||||||
category: "通用"
|
category: "通用"
|
||||||
developer_ids:
|
developer_ids:
|
||||||
@@ -38,6 +38,7 @@ allowed-tools:
|
|||||||
- **只有当**用户明确询问命令、参数、输出结构、开发、调试、集成或排错时,才读取 `references/` 或 `development/`。
|
- **只有当**用户明确询问命令、参数、输出结构、开发、调试、集成或排错时,才读取 `references/` 或 `development/`。
|
||||||
- 若 `README.md` 与 `SKILL.md` / `references` 表述冲突:对用户展示与市场说明以 `README.md` 为准;对执行契约、CLI、schema、运行约束以 `SKILL.md` / `references` 为准。
|
- 若 `README.md` 与 `SKILL.md` / `references` 表述冲突:对用户展示与市场说明以 `README.md` 为准;对执行契约、CLI、schema、运行约束以 `SKILL.md` / `references` 为准。
|
||||||
- 回答用户时**不要**暴露 Playwright、DOM、Python、RPA 等实现细节,除非用户明确询问技术实现。
|
- 回答用户时**不要**暴露 Playwright、DOM、Python、RPA 等实现细节,除非用户明确询问技术实现。
|
||||||
|
- 用户未问技术实现时,**不要**讨论 slug 命名规则;开发者问命名或 slug 时,读取 `development/NAMING.md`。
|
||||||
|
|
||||||
## 文档分工
|
## 文档分工
|
||||||
|
|
||||||
@@ -64,15 +65,15 @@ python {baseDir}/scripts/main.py config-path
|
|||||||
python {baseDir}/scripts/main.py version
|
python {baseDir}/scripts/main.py version
|
||||||
```
|
```
|
||||||
|
|
||||||
配置:仓库 `.env.example` 为模板;用户 `.env` 在 `{CLAW_DATA_ROOT}/{CLAW_USER_ID}/{slug}/.env`,启动时自动 bootstrap。优先级:进程环境变量 > 用户 `.env` > `.env.example`。
|
配置:仓库 `.env.example` 为模板;用户 `.env` 在 `{JIANGCHANG_DATA_ROOT}/{JIANGCHANG_USER_ID}/{slug}/.env`,启动时自动 bootstrap。优先级:进程环境变量 > 用户 `.env` > `.env.example`。
|
||||||
|
|
||||||
## 运行依赖
|
## 运行依赖
|
||||||
|
|
||||||
- Python 运行环境由匠厂宿主注入**共享 runtime**:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
- Python 运行环境由匠厂宿主注入**共享 runtime**:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
||||||
- 公共能力来自共享 runtime 安装的 `jiangchang-platform-kit>=1.0.14`(`jiangchang_skill_core` 包);**不要 vendor** `scripts/jiangchang_skill_core/`,新技能不得在仓库内保留该目录副本。
|
- 公共能力来自共享 runtime 安装的 `jiangchang-platform-kit>=1.0.17`(`jiangchang_skill_core` 包);**不要 vendor** `scripts/jiangchang_skill_core/`,新技能不得在仓库内保留该目录副本。
|
||||||
- config、logging、runtime_env、rpa、media-assets、video_session、runtime_diagnostics 等均从共享 venv 的 `jiangchang_skill_core` import,而非技能目录副本。
|
- config、logging、runtime_env、rpa、media-assets、video_session、runtime_diagnostics 等均从共享 venv 的 `jiangchang_skill_core` import,而非技能目录副本。
|
||||||
- 根目录 `requirements.txt` **只声明技能特有** Python 三方依赖;`jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。
|
- 根目录 `requirements.txt` **只声明技能特有** Python 三方依赖;`jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。
|
||||||
- `metadata.openclaw.platform_kit_min_version`(当前 `1.0.14`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是**技能 pip 依赖声明。
|
- `metadata.openclaw.platform_kit_min_version`(当前 `1.0.17`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是**技能 pip 依赖声明。
|
||||||
- Skill 代码**不要**自行 `pip install`;系统级依赖(如 VC++ Runtime)仅在 `health` / preflight 中提示用户安装。
|
- Skill 代码**不要**自行 `pip install`;系统级依赖(如 VC++ Runtime)仅在 `health` / preflight 中提示用户安装。
|
||||||
- `health` 使用 `collect_runtime_diagnostics` 输出统一 runtime 诊断(只读,不下载/修复 media-assets)。
|
- `health` 使用 `collect_runtime_diagnostics` 输出统一 runtime 诊断(只读,不下载/修复 media-assets)。
|
||||||
|
|
||||||
@@ -82,6 +83,16 @@ python {baseDir}/scripts/main.py version
|
|||||||
2. 按 `development/DEVELOPMENT.md` 完成开发与文档定制。
|
2. 按 `development/DEVELOPMENT.md` 完成开发与文档定制。
|
||||||
3. 用户市场说明写入根 `README.md`;Agent 调用契约见 `references/CLI.md`、`references/SCHEMA.md`。
|
3. 用户市场说明写入根 `README.md`;Agent 调用契约见 `references/CLI.md`、`references/SCHEMA.md`。
|
||||||
4. 同步修改 `scripts/util/constants.py` 中的 `SKILL_SLUG` / `SKILL_VERSION`。
|
4. 同步修改 `scripts/util/constants.py` 中的 `SKILL_SLUG` / `SKILL_VERSION`。
|
||||||
|
5. 本地 SQLite 的中文表名/字段名、标准时间字段与字段顺序规范见 `references/SCHEMA.md`(元数据表 `_jiangchang_*` + `CREATE TABLE` 物理顺序)。
|
||||||
|
|
||||||
|
## 技能命名与 slug
|
||||||
|
|
||||||
|
- 标准格式:`{verb}-{noun-phrase}-{platform}`(详见 `development/NAMING.md`)。
|
||||||
|
- slug / repo / 目录 / `SKILL_SLUG` / DB 文件名:**英文** kebab-case;`name`、`description`、根 `README.md`:**中文**。
|
||||||
|
- 复制为新业务技能前**必须**阅读 `development/NAMING.md`。
|
||||||
|
- `name`(frontmatter):**用户可见的中文业务名称**;`description` 是说明,不是名称。
|
||||||
|
- `metadata.openclaw.slug`:**英文 kebab-case** 机器标识;目录名、默认 `{slug}.db` 使用 slug,不使用中文。
|
||||||
|
- 复制后全局替换 `your-skill-slug`;正式技能不得保留英文占位 `name` 或 slug。
|
||||||
|
|
||||||
## 平台元数据
|
## 平台元数据
|
||||||
|
|
||||||
|
|||||||
13
assets/naming/platforms.txt
Normal file
13
assets/naming/platforms.txt
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
amazon
|
||||||
|
shopee
|
||||||
|
xinghang
|
||||||
|
alibaba
|
||||||
|
kingdee
|
||||||
|
icbc
|
||||||
|
pingpong
|
||||||
|
worldfirst
|
||||||
|
paypal
|
||||||
|
lianlian
|
||||||
|
single-window
|
||||||
|
export-rebate
|
||||||
|
etax
|
||||||
4
assets/naming/scopes.txt
Normal file
4
assets/naming/scopes.txt
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
all
|
||||||
|
batch
|
||||||
|
multi
|
||||||
|
default
|
||||||
25
assets/naming/verbs.txt
Normal file
25
assets/naming/verbs.txt
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
scrape
|
||||||
|
receive
|
||||||
|
download
|
||||||
|
export
|
||||||
|
add
|
||||||
|
fill
|
||||||
|
enter
|
||||||
|
bind
|
||||||
|
withdraw
|
||||||
|
reconcile
|
||||||
|
verify
|
||||||
|
submit
|
||||||
|
query
|
||||||
|
process
|
||||||
|
reply
|
||||||
|
generate
|
||||||
|
draft
|
||||||
|
review
|
||||||
|
confirm
|
||||||
|
track
|
||||||
|
upload
|
||||||
|
match
|
||||||
|
triage
|
||||||
|
ship
|
||||||
|
reprice
|
||||||
@@ -7,7 +7,7 @@
|
|||||||
1. **三层优先级**:`进程环境变量` > `{数据目录}/.env` > 仓库 `.env.example` 默认值。
|
1. **三层优先级**:`进程环境变量` > `{数据目录}/.env` > 仓库 `.env.example` 默认值。
|
||||||
2. **`.env.example` 进仓库**:带注释的全量默认配置,是配置项的"单一事实来源"。
|
2. **`.env.example` 进仓库**:带注释的全量默认配置,是配置项的"单一事实来源"。
|
||||||
3. **首次运行自动 copy(bootstrap)**:`scripts/main.py` 启动与 `cli.app.main()` 均会调用 `util.config_bootstrap.bootstrap_skill_config()`,把仓库根目录 `.env.example` 复制到
|
3. **首次运行自动 copy(bootstrap)**:`scripts/main.py` 启动与 `cli.app.main()` 均会调用 `util.config_bootstrap.bootstrap_skill_config()`,把仓库根目录 `.env.example` 复制到
|
||||||
`{CLAW_DATA_ROOT}/{user}/{slug}/.env`(**已存在则不整体覆盖**,保护用户改过的值)。
|
`{JIANGCHANG_DATA_ROOT}/{JIANGCHANG_USER_ID}/{slug}/.env`(**已存在则不整体覆盖**,保护用户改过的值)。
|
||||||
4. **技能升级合并缺失项**:`merge_missing_env_keys` 会把 `.env.example` 中新增、但用户 `.env` 尚未包含的 key **追加**进去(带注释块)。
|
4. **技能升级合并缺失项**:`merge_missing_env_keys` 会把 `.env.example` 中新增、但用户 `.env` 尚未包含的 key **追加**进去(带注释块)。
|
||||||
5. **敏感信息绝不进 `.env`**:密码/密钥/口令走 account-manager 的 `secret-ref`(见下"红线")。
|
5. **敏感信息绝不进 `.env`**:密码/密钥/口令走 account-manager 的 `secret-ref`(见下"红线")。
|
||||||
|
|
||||||
@@ -96,4 +96,4 @@ config.get_float("STEP_DELAY_MIN", 1.0)
|
|||||||
|
|
||||||
- `RPA.md` — 三端 RPA 标准与各开关含义
|
- `RPA.md` — 三端 RPA 标准与各开关含义
|
||||||
- `ADAPTER.md` — `OPENCLAW_TEST_TARGET` 四档模式
|
- `ADAPTER.md` — `OPENCLAW_TEST_TARGET` 四档模式
|
||||||
- `RUNTIME.md` — `CLAW_*` 环境变量与数据目录约定
|
- `RUNTIME.md` — `JIANGCHANG_*` 环境变量与数据目录约定
|
||||||
|
|||||||
@@ -79,8 +79,9 @@
|
|||||||
|
|
||||||
你不应该直接在这个仓库里开发业务,而应该:
|
你不应该直接在这个仓库里开发业务,而应该:
|
||||||
|
|
||||||
|
0. 按 [`NAMING.md`](NAMING.md) 确定 slug(`{verb}-{noun-phrase}-{platform}`)
|
||||||
1. 复制这个目录
|
1. 复制这个目录
|
||||||
2. 改成新 skill 的目录名
|
2. 改成新 skill 的目录名(与 slug 一致)
|
||||||
3. 把占位内容替换掉
|
3. 把占位内容替换掉
|
||||||
4. 再开始写业务逻辑
|
4. 再开始写业务逻辑
|
||||||
|
|
||||||
@@ -153,7 +154,7 @@ scripts/
|
|||||||
- `util/`
|
- `util/`
|
||||||
作用:常量、日志、路径、时间工具、通用帮助函数
|
作用:常量、日志、路径、时间工具、通用帮助函数
|
||||||
|
|
||||||
公共能力(config、logging、runtime_env、rpa、media_assets、video_session、runtime_diagnostics)从共享 runtime 的 `jiangchang-platform-kit>=1.0.14` import,**不得**在 `scripts/` 下保留 `jiangchang_skill_core/` 副本。
|
公共能力(config、logging、runtime_env、rpa、media_assets、video_session、runtime_diagnostics)从共享 runtime 的 `jiangchang-platform-kit>=1.0.17` import,**不得**在 `scripts/` 下保留 `jiangchang_skill_core/` 副本。
|
||||||
|
|
||||||
## 3.2 开发 RPA 类 skill
|
## 3.2 开发 RPA 类 skill
|
||||||
|
|
||||||
@@ -187,7 +188,7 @@ scripts/
|
|||||||
技能根目录的 `requirements.txt` 是**标准文件**,用于声明本技能**特有** Python 三方依赖。
|
技能根目录的 `requirements.txt` 是**标准文件**,用于声明本技能**特有** Python 三方依赖。
|
||||||
|
|
||||||
- **公共依赖**(`jiangchang-platform-kit`、`playwright`、config、runtime diagnostics、RPA 公共能力等)由**宿主共享 runtime** 提供,**不要**写入技能 `requirements.txt`。
|
- **公共依赖**(`jiangchang-platform-kit`、`playwright`、config、runtime diagnostics、RPA 公共能力等)由**宿主共享 runtime** 提供,**不要**写入技能 `requirements.txt`。
|
||||||
- `SKILL.md` 的 `metadata.openclaw.platform_kit_min_version`(当前 `1.0.14`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是** pip 依赖声明。
|
- `SKILL.md` 的 `metadata.openclaw.platform_kit_min_version`(当前 `1.0.17`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是** pip 依赖声明。
|
||||||
- 匠厂宿主安装/更新技能后,会将技能 `requirements.txt` 安装到共享 venv:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
- 匠厂宿主安装/更新技能后,会将技能 `requirements.txt` 安装到共享 venv:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
||||||
- **不要**在业务代码中 `subprocess` / `pip install`;缺依赖由 `health` 报错,由宿主负责安装。
|
- **不要**在业务代码中 `subprocess` / `pip install`;缺依赖由 `health` 报错,由宿主负责安装。
|
||||||
- **版本约束尽量收窄**,降低多技能共享 venv 时的冲突风险。推荐范围写法:
|
- **版本约束尽量收窄**,降低多技能共享 venv 时的冲突风险。推荐范围写法:
|
||||||
@@ -445,6 +446,10 @@ metadata:
|
|||||||
|
|
||||||
- `db/task_logs_repository.py`
|
- `db/task_logs_repository.py`
|
||||||
只做增删查改(模板默认表:`task_logs`)
|
只做增删查改(模板默认表:`task_logs`)
|
||||||
|
- `db/display_metadata.py`
|
||||||
|
创建 `_jiangchang_tables` / `_jiangchang_columns` 并幂等写入中文展示名(见 `references/SCHEMA.md`)
|
||||||
|
- `db/timestamp_columns.py`
|
||||||
|
标准时间字段 trigger 与维护约定(`created_at` / `updated_at`,Unix 秒级)
|
||||||
|
|
||||||
不要在 `db` 层里:
|
不要在 `db` 层里:
|
||||||
|
|
||||||
@@ -678,6 +683,8 @@ uses: client-jiangchang/jiangchang-platform-kit/.github/workflows/reusable-relea
|
|||||||
每个新 skill 发布前,建议技术人员逐条确认:
|
每个新 skill 发布前,建议技术人员逐条确认:
|
||||||
|
|
||||||
- [ ] 目录结构符合当前模板
|
- [ ] 目录结构符合当前模板
|
||||||
|
- [ ] slug 符合 [`NAMING.md`](NAMING.md)(verb-noun-platform)
|
||||||
|
- [ ] 目录名、`SKILL.md` slug、`constants.SKILL_SLUG` 三者一致
|
||||||
- [ ] `SKILL.md` 中 slug、名称、描述都已替换
|
- [ ] `SKILL.md` 中 slug、名称、描述都已替换
|
||||||
- [ ] `scripts/util/constants.py` 已修改
|
- [ ] `scripts/util/constants.py` 已修改
|
||||||
- [ ] `../references/CLI.md` 示例命令已改成真实命令
|
- [ ] `../references/CLI.md` 示例命令已改成真实命令
|
||||||
@@ -747,11 +754,46 @@ uses: client-jiangchang/jiangchang-platform-kit/.github/workflows/reusable-relea
|
|||||||
- 用户说明在根 `README.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
- 用户说明在根 `README.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||||
- 统一走 `scripts/main.py` 作为 CLI 入口
|
- 统一走 `scripts/main.py` 作为 CLI 入口
|
||||||
|
|
||||||
|
### 错误 5:平台放 slug 最前
|
||||||
|
|
||||||
|
表现:
|
||||||
|
|
||||||
|
- slug 形如 `amazon-download-settlement-report`
|
||||||
|
- 语义校验或 `test_slug_naming` 失败
|
||||||
|
|
||||||
|
要改:
|
||||||
|
|
||||||
|
- 动词放首段,平台放末段,例如 `download-settlement-report-amazon`
|
||||||
|
- 见 [`NAMING.md`](NAMING.md)
|
||||||
|
|
||||||
|
### 错误 6:noun 段过长导致超 48 字符
|
||||||
|
|
||||||
|
表现:
|
||||||
|
|
||||||
|
- slug 超过 48 字符
|
||||||
|
- 中间名词段堆砌过多
|
||||||
|
|
||||||
|
要改:
|
||||||
|
|
||||||
|
- 精简 noun-phrase,保留核心业务含义
|
||||||
|
- 见 [`NAMING.md`](NAMING.md) §3 硬约束
|
||||||
|
|
||||||
|
### 错误 7:只改目录名未改 slug
|
||||||
|
|
||||||
|
表现:
|
||||||
|
|
||||||
|
- 与「错误 1」相同,但目录已改名而 `SKILL.md` / `constants.py` 仍为占位
|
||||||
|
|
||||||
|
要检查:
|
||||||
|
|
||||||
|
- `SKILL.md` 的 `metadata.openclaw.slug`
|
||||||
|
- `scripts/util/constants.py` 的 `SKILL_SLUG`
|
||||||
|
|
||||||
## 18. 推荐开发顺序总结
|
## 18. 推荐开发顺序总结
|
||||||
|
|
||||||
如果让一个新人照着做,我建议他按这个顺序:
|
如果让一个新人照着做,我建议他按这个顺序:
|
||||||
|
|
||||||
1. 复制模板并改目录名
|
1. 按 [`NAMING.md`](NAMING.md) 确定 slug,复制模板并改目录名
|
||||||
2. 改 `SKILL.md` 与根 `README.md`
|
2. 改 `SKILL.md` 与根 `README.md`
|
||||||
3. 改 `scripts/util/constants.py`
|
3. 改 `scripts/util/constants.py`
|
||||||
4. 改 `references/` 与 `development/`
|
4. 改 `references/` 与 `development/`
|
||||||
|
|||||||
236
development/NAMING.md
Normal file
236
development/NAMING.md
Normal file
@@ -0,0 +1,236 @@
|
|||||||
|
# 技能 slug 命名规范(verb-noun-platform)
|
||||||
|
|
||||||
|
> 本文是匠厂**新业务 skill** 的 slug / Git 仓库名 / 目录名命名权威说明。复制 `skill-template` 出去开发新技能前**必读**;Agent 在开发者询问命名或 slug 时也应先读本文。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. 适用范围
|
||||||
|
|
||||||
|
| 范围 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| ✅ **适用** | 从 `skill-template` **复制出去的新技能** |
|
||||||
|
| ❌ **不追溯** | 已上线历史技能(如 `account-manager`、`reconcile-finance`、`scrape-contacts-lianjia` 等)保持不动 |
|
||||||
|
| ❌ **不修改** | 其他仓库(尤其 `account-manager`)不在本文约束范围内 |
|
||||||
|
| ✅ **模板占位** | 模板本体的 `your-skill-slug` 占位必须继续通过全部测试 |
|
||||||
|
|
||||||
|
**新技能勿仿**历史 2 段无平台形态(如 `reconcile-finance`)或不符合 verb-noun-platform 的旧 repo 名;校验器对历史 repo **不追溯**,但规范中明确标注为反模式。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. 命名格式
|
||||||
|
|
||||||
|
标准形态(约 95% 新技能):
|
||||||
|
|
||||||
|
```text
|
||||||
|
{verb}-{noun-phrase}-{platform}
|
||||||
|
```
|
||||||
|
|
||||||
|
| 部分 | 规则 |
|
||||||
|
|------|------|
|
||||||
|
| **verb** | 1 个词,来自 [动词白名单](#5-动词白名单) |
|
||||||
|
| **noun-phrase** | 1~3 个词(按 `-` 分段),描述业务对象 |
|
||||||
|
| **platform** | 1 个词,来自 [平台白名单](#6-平台白名单);可含连字符(如 `single-window`) |
|
||||||
|
|
||||||
|
**展示层分工不变:**
|
||||||
|
|
||||||
|
| 字段 | 语言 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| slug / repo / 目录 / `SKILL_SLUG` / DB 文件名 | **英文** kebab-case | `download-settlement-report-amazon` |
|
||||||
|
| `SKILL.md` 的 `name`、`description`、根 `README.md` | **中文** | `亚马逊结算报表下载` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. 硬约束(新技能强制校验)
|
||||||
|
|
||||||
|
| 约束 | 值 |
|
||||||
|
|------|-----|
|
||||||
|
| 格式 | `{verb}-{noun-phrase}-{platform}`(标准型,默认) |
|
||||||
|
| 总段数(按 `-` 分割) | **3~5 段**(标准型);scope 型见 [§4](#4-三类合法形态) |
|
||||||
|
| 总长度 | **≤ 48 字符** |
|
||||||
|
| 字符集 | 小写字母、数字、连字符;kebab-case |
|
||||||
|
| 禁止 | 中文 slug、下划线、**平台放最前**(如 `amazon-download-xxx`) |
|
||||||
|
|
||||||
|
实现校验见 `scripts/util/slug_naming.py`;`scripts/db/display_metadata_validator.py` 在 `SKILL.md` frontmatter 自检时调用。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. 三类合法形态
|
||||||
|
|
||||||
|
### 4.1 标准型(95%)
|
||||||
|
|
||||||
|
`verb-noun-platform` 或 `verb-noun-noun-platform`(3~5 段)
|
||||||
|
|
||||||
|
- 第 1 段 ∈ 动词白名单
|
||||||
|
- 最后 1 段(或 hyphenated 平台的最后 2 段)∈ 平台白名单
|
||||||
|
- 中间为 noun-phrase(1~3 段)
|
||||||
|
|
||||||
|
示例:
|
||||||
|
|
||||||
|
- `download-settlement-report-amazon`
|
||||||
|
- `add-product-shopee`
|
||||||
|
- `enter-sales-receipt-kingdee`
|
||||||
|
- `fill-export-declaration-single-window`
|
||||||
|
|
||||||
|
### 4.2 scope 型(少见)
|
||||||
|
|
||||||
|
`verb-noun-scope`
|
||||||
|
|
||||||
|
- 最后 1 段 ∈ scope 白名单:`all` | `batch` | `multi` | `default`
|
||||||
|
- 第 1 段 ∈ 动词白名单
|
||||||
|
- 总段数 3~5
|
||||||
|
|
||||||
|
示例:`generate-article-all`
|
||||||
|
|
||||||
|
> 说明:`geo-generate-article-all` 若作为新技能且不在豁免表、首段 `geo` 不在动词表,应写为 `generate-article-all`。
|
||||||
|
|
||||||
|
### 4.3 历史豁免(不校验语义)
|
||||||
|
|
||||||
|
以下 slug 跳过 verb/platform 语义校验(见 `LEGACY_EXEMPT_SLUGS`):
|
||||||
|
|
||||||
|
- `account-manager`
|
||||||
|
- `skill-template`
|
||||||
|
- `your-skill-slug` / `your_skill_slug`(模板占位)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. 动词白名单
|
||||||
|
|
||||||
|
词表文件:[`assets/naming/verbs.txt`](../assets/naming/verbs.txt)(每行一词,便于后续扩展)
|
||||||
|
|
||||||
|
| 动词 | 动词 | 动词 | 动词 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| scrape | receive | download | export |
|
||||||
|
| add | fill | enter | bind |
|
||||||
|
| withdraw | reconcile | verify | submit |
|
||||||
|
| query | process | reply | generate |
|
||||||
|
| draft | review | confirm | track |
|
||||||
|
| upload | match | triage | ship |
|
||||||
|
| reprice | | | |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. 平台白名单
|
||||||
|
|
||||||
|
词表文件:[`assets/naming/platforms.txt`](../assets/naming/platforms.txt)
|
||||||
|
|
||||||
|
| 平台 | 平台 | 平台 |
|
||||||
|
|------|------|------|
|
||||||
|
| amazon | shopee | xinghang |
|
||||||
|
| alibaba | kingdee | icbc |
|
||||||
|
| pingpong | worldfirst | paypal |
|
||||||
|
| lianlian | single-window | export-rebate |
|
||||||
|
| etax | | |
|
||||||
|
|
||||||
|
scope 词表:[`assets/naming/scopes.txt`](../assets/naming/scopes.txt) — `all`、`batch`、`multi`、`default`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. slug 与展示字段分工
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
name: 亚马逊结算报表下载 # 中文,用户可见
|
||||||
|
description: "从卖家中心下载结算报表并入库" # 中文说明
|
||||||
|
metadata:
|
||||||
|
openclaw:
|
||||||
|
slug: download-settlement-report-amazon # 英文机器标识
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
同步修改:
|
||||||
|
|
||||||
|
- 目录名
|
||||||
|
- `metadata.openclaw.slug`
|
||||||
|
- `scripts/util/constants.py` 中的 `SKILL_SLUG`
|
||||||
|
- 默认数据库路径 `{slug}/{slug}.db`
|
||||||
|
|
||||||
|
三者必须一致。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. 与 account-manager 的关系
|
||||||
|
|
||||||
|
slug **末段 platform** 与 `account-manager` 中的 `platform_key` **语义对应**,但**不要求字符串完全相等**。
|
||||||
|
|
||||||
|
| slug 末段 (platform) | account-manager platform_key(示例) |
|
||||||
|
|----------------------|--------------------------------------|
|
||||||
|
| amazon | `amazon_sim` / `amazon` |
|
||||||
|
| shopee | `shopee` |
|
||||||
|
| kingdee | `kingdee` |
|
||||||
|
|
||||||
|
新技能若需账号下发,在 `REQUIREMENTS.md` §0 填写拟用的 `platform_key`,并与兄弟技能调用参数对齐。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. 复制新技能流程
|
||||||
|
|
||||||
|
1. **先定 slug** — 按本文规范拟定 `{verb}-{noun-phrase}-{platform}`,确认在白名单内且 ≤ 48 字符
|
||||||
|
2. **复制目录** — 将 `skill-template` 复制为新目录,**目录名 = slug**
|
||||||
|
3. **全局替换** — `your-skill-slug` → 新 slug;更新 `SKILL.md`、`constants.py`、文档中的占位
|
||||||
|
4. **填写 REQUIREMENTS** — 完成 [`REQUIREMENTS.md`](REQUIREMENTS.md) §0 技能标识
|
||||||
|
5. **开发 & 自检** — `python tests/run_tests.py -v`,含 slug 语义测试
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 10. 正例 / 反例
|
||||||
|
|
||||||
|
### ✅ 正例
|
||||||
|
|
||||||
|
| slug | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `download-settlement-report-amazon` | 标准型,4 段 |
|
||||||
|
| `add-product-shopee` | 标准型,3 段 |
|
||||||
|
| `enter-sales-receipt-kingdee` | 标准型 |
|
||||||
|
| `fill-export-declaration-single-window` | 标准型,平台含连字符 |
|
||||||
|
| `generate-article-all` | scope 型 |
|
||||||
|
|
||||||
|
### ❌ 反例
|
||||||
|
|
||||||
|
| slug | 原因 |
|
||||||
|
|------|------|
|
||||||
|
| `amazon-download-settlement-report` | 平台在最前 |
|
||||||
|
| `enter-cross-border-sales-receipt-voucher-kingdee` | 过长、noun 臃肿 |
|
||||||
|
| `reconcile-finance` | 新技能禁止 2 段无平台 |
|
||||||
|
| `download_settlement_amazon` | 非 kebab-case(下划线) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 11. 反模式
|
||||||
|
|
||||||
|
- **平台前置**:`amazon-download-...`、`shopee-add-...`
|
||||||
|
- **英文占位 name**:复制后仍保留 `My Skill` 或纯英文 slug 风格名称
|
||||||
|
- **只改目录名**:`SKILL.md` slug 与 `constants.SKILL_SLUG` 未同步
|
||||||
|
- **noun 堆砌**:中间段过多导致超 48 字符或难以阅读
|
||||||
|
- **仿历史 2 段 repo**:`reconcile-finance`、`content-manager` 等
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 12. 演进说明(当前不启用)
|
||||||
|
|
||||||
|
当技能库规模 **> 200** 时,可再评估引入 `{domain}-verb-noun-platform` 前缀形态。**当前不启用**,新技能一律使用本文 verb-noun-platform 标准型或 scope 型。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 13. 历史形态说明
|
||||||
|
|
||||||
|
以下为代表性**历史 repo**,新技能**勿仿**:
|
||||||
|
|
||||||
|
| 历史 slug | 说明 |
|
||||||
|
|-----------|------|
|
||||||
|
| `account-manager` | 跨平台账号管理,非 verb-noun-platform |
|
||||||
|
| `reconcile-finance` | 2 段无 platform |
|
||||||
|
| `scrape-contacts-lianjia` | 平台名不在当前白名单(链家) |
|
||||||
|
| `skill-template` | 模板仓库本身 |
|
||||||
|
|
||||||
|
校验器通过 `LEGACY_EXEMPT_SLUGS` 对模板占位与少数豁免 slug 跳过语义检查;**新复制出去的业务 skill 不在豁免表内**,必须满足 §3 硬约束。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 14. 相关文档
|
||||||
|
|
||||||
|
| 文档 | 内容 |
|
||||||
|
|------|------|
|
||||||
|
| [`DEVELOPMENT.md`](DEVELOPMENT.md) | 复制模板步骤、发布前检查清单 |
|
||||||
|
| [`REQUIREMENTS.md`](REQUIREMENTS.md) | §0 技能标识必填项 |
|
||||||
|
| [`../references/SCHEMA.md`](../references/SCHEMA.md) | kebab-case 与数据库路径 |
|
||||||
|
| [`../SKILL.md`](../SKILL.md) | frontmatter 命名摘要 |
|
||||||
@@ -3,12 +3,13 @@
|
|||||||
本目录面向**人类开发者**与 **AI 编程代理**。开始定制 skill 前,建议按以下顺序阅读:
|
本目录面向**人类开发者**与 **AI 编程代理**。开始定制 skill 前,建议按以下顺序阅读:
|
||||||
|
|
||||||
1. [`REQUIREMENTS.md`](REQUIREMENTS.md) — 需求文档模板与验收标准
|
1. [`REQUIREMENTS.md`](REQUIREMENTS.md) — 需求文档模板与验收标准
|
||||||
2. [`DEVELOPMENT.md`](DEVELOPMENT.md) — 完整开发步骤与目录规范
|
2. [`NAMING.md`](NAMING.md) — slug / 仓库名命名规范(复制模板前必读)
|
||||||
3. [`TESTING.md`](TESTING.md) — 测试分层、隔离数据根与档位开关
|
3. [`DEVELOPMENT.md`](DEVELOPMENT.md) — 完整开发步骤与目录规范
|
||||||
4. [`ADAPTER.md`](ADAPTER.md) — 涉及外部系统对接时
|
4. [`TESTING.md`](TESTING.md) — 测试分层、隔离数据根与档位开关
|
||||||
5. [`RPA.md`](RPA.md) — 涉及浏览器 / 桌面 / 手机自动化时
|
5. [`ADAPTER.md`](ADAPTER.md) — 涉及外部系统对接时
|
||||||
6. [`CONFIG.md`](CONFIG.md) — `.env` 规范与 bootstrap 机制
|
6. [`RPA.md`](RPA.md) — 涉及浏览器 / 桌面 / 手机自动化时
|
||||||
7. [`RUNTIME.md`](RUNTIME.md) — 共享 runtime、数据路径、发布打包与编码约定
|
7. [`CONFIG.md`](CONFIG.md) — `.env` 规范与 bootstrap 机制
|
||||||
|
8. [`RUNTIME.md`](RUNTIME.md) — 共享 runtime、数据路径、发布打包与编码约定
|
||||||
|
|
||||||
Agent 调用契约见 [`../references/CLI.md`](../references/CLI.md)、[`../references/SCHEMA.md`](../references/SCHEMA.md)。
|
Agent 调用契约见 [`../references/CLI.md`](../references/CLI.md)、[`../references/SCHEMA.md`](../references/SCHEMA.md)。
|
||||||
用户市场说明见根目录 [`README.md`](../README.md),不要写进本目录。
|
用户市场说明见根目录 [`README.md`](../README.md),不要写进本目录。
|
||||||
|
|||||||
@@ -15,6 +15,14 @@
|
|||||||
|
|
||||||
# REQUIREMENTS
|
# REQUIREMENTS
|
||||||
|
|
||||||
|
## 0. 技能标识(复制 REQUIREMENTS 时必填)
|
||||||
|
|
||||||
|
- 拟定 slug(英文,符合 `development/NAMING.md`):
|
||||||
|
- 中文 name:
|
||||||
|
- 中文 description(一句话):
|
||||||
|
- account-manager platform_key(如有):
|
||||||
|
- 命名形态:标准型 / scope 型
|
||||||
|
|
||||||
## 1. 文档目标
|
## 1. 文档目标
|
||||||
|
|
||||||
说明这份需求文档的作用,以及它解决什么问题。
|
说明这份需求文档的作用,以及它解决什么问题。
|
||||||
@@ -149,7 +157,10 @@
|
|||||||
- `health`、`version` 命令执行正常
|
- `health`、`version` 命令执行正常
|
||||||
- 主命令(如 `run`)在 mock / simulator 档位可重复验证
|
- 主命令(如 `run`)在 mock / simulator 档位可重复验证
|
||||||
- `python tests/run_tests.py -v` 必跑测试全部通过
|
- `python tests/run_tests.py -v` 必跑测试全部通过
|
||||||
- `task_logs` 写入和查询符合 `references/SCHEMA.md`
|
- `task_logs` 写入和查询符合 `references/SCHEMA.md`(含 `created_at` / `updated_at` Unix 秒级规范)
|
||||||
|
- `init_db()` 已写入 `_jiangchang_tables` / `_jiangchang_columns`;用户可见表/字段具备中文 `display_name`
|
||||||
|
- 字段展示顺序与 `PRAGMA table_info(task_logs)` 的 cid 一致;不依赖 `display_order`
|
||||||
|
- `tests/test_display_metadata.py` 通过
|
||||||
- 真实联调(如有)放在 `tests/integration/`,且默认套件不包含真实外联
|
- 真实联调(如有)放在 `tests/integration/`,且默认套件不包含真实外联
|
||||||
- 发布后 Gitea 工作流成功;匠厂技能市场可见最新版本;安装后可在“新建任务”中调用
|
- 发布后 Gitea 工作流成功;匠厂技能市场可见最新版本;安装后可在“新建任务”中调用
|
||||||
|
|
||||||
|
|||||||
@@ -51,7 +51,7 @@
|
|||||||
6. **可以** `ignore_default_args=["--enable-automation"]`(platform-kit `launch_persistent_browser` 已处理)。
|
6. **可以** `ignore_default_args=["--enable-automation"]`(platform-kit `launch_persistent_browser` 已处理)。
|
||||||
7. **强风控平台**:优先真实点击、键盘、鼠标、地址栏、持久 profile;**不要**直接拼接搜索结果 URL 或 DOM 注入。
|
7. **强风控平台**:优先真实点击、键盘、鼠标、地址栏、持久 profile;**不要**直接拼接搜索结果 URL 或 DOM 注入。
|
||||||
|
|
||||||
指纹淡化(stealth)典型项:`navigator.webdriver=undefined`、`chrome.runtime`、`permissions.query`、`plugins`、`languages` 等。共享实现见 `jiangchang_skill_core.rpa`(platform-kit **>= 1.0.14**)。
|
指纹淡化(stealth)典型项:`navigator.webdriver=undefined`、`chrome.runtime`、`permissions.query`、`plugins`、`languages` 等。共享实现见 `jiangchang_skill_core.rpa`(platform-kit **>= 1.0.17**)。
|
||||||
|
|
||||||
**拟人操作**(必做):
|
**拟人操作**(必做):
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ from jiangchang_skill_core.rpa import (
|
|||||||
from jiangchang_skill_core.rpa.stealth import stealth_enabled, STEALTH_INIT_SCRIPT
|
from jiangchang_skill_core.rpa.stealth import stealth_enabled, STEALTH_INIT_SCRIPT
|
||||||
```
|
```
|
||||||
|
|
||||||
- `RpaVideoSession` 来自 platform-kit **>= 1.0.14**;ffmpeg、背景音乐、media-assets 由 platform-kit 统一解析;已提供前置/后置缓冲、字幕、TTS 旁白、背景音乐循环、结尾淡出。
|
- `RpaVideoSession` 来自 platform-kit **>= 1.0.17**;ffmpeg、背景音乐、media-assets 由 platform-kit 统一解析;已提供前置/后置缓冲、字幕、TTS 旁白、背景音乐循环、结尾淡出。
|
||||||
- `health` 对上述资源做只读诊断,不下载、不修复。
|
- `health` 对上述资源做只读诊断,不下载、不修复。
|
||||||
|
|
||||||
### 1.5 真实浏览器 RPA 示例(必读)
|
### 1.5 真实浏览器 RPA 示例(必读)
|
||||||
@@ -234,7 +234,7 @@ skill 退出/抛错统一用 `ERROR:` 前缀 + 稳定码,方便宿主与上层
|
|||||||
|
|
||||||
### 5.1 截图存证
|
### 5.1 截图存证
|
||||||
|
|
||||||
- **路径**:`{CLAW_DATA_ROOT}/{user}/{slug}/rpa-artifacts/{batch_id}/{tag}_{timestamp}.png`
|
- **路径**:`{JIANGCHANG_DATA_ROOT}/{JIANGCHANG_USER_ID}/{slug}/rpa-artifacts/{batch_id}/{tag}_{timestamp}.png`
|
||||||
- **失败必截图**:受 `OPENCLAW_ARTIFACTS_ON_FAILURE`(默认开)控制。
|
- **失败必截图**:受 `OPENCLAW_ARTIFACTS_ON_FAILURE`(默认开)控制。
|
||||||
- **Playwright 不负责录屏**,仅浏览器自动化。
|
- **Playwright 不负责录屏**,仅浏览器自动化。
|
||||||
- **常见 tag**:`before_submit` / `after_submit` / `captcha` / `login_fail` / `error`。
|
- **常见 tag**:`before_submit` / `after_submit` / `captcha` / `login_fail` / `error`。
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## 共享 Python Runtime
|
## 共享 Python Runtime
|
||||||
|
|
||||||
**skill-template** 及复制出的新技能,公共能力均来自宿主匠厂安装的共享 Python Runtime(`jiangchang-platform-kit>=1.0.14` 及其传递依赖,含 `playwright`)。`jiangchang_skill_core` **不得**在技能仓库内 vendored,应由共享 venv 的 site-packages 提供。
|
**skill-template** 及复制出的新技能,公共能力均来自宿主匠厂安装的共享 Python Runtime(`jiangchang-platform-kit>=1.0.17` 及其传递依赖,含 `playwright`)。`jiangchang_skill_core` **不得**在技能仓库内 vendored,应由共享 venv 的 site-packages 提供。
|
||||||
|
|
||||||
技能根目录 `requirements.txt` **只声明技能特有依赖**;**不要**重复声明 `jiangchang-platform-kit` 或 `playwright`。`SKILL.md` 的 `platform_kit_min_version` 是运行契约,**不是** pip 依赖声明。
|
技能根目录 `requirements.txt` **只声明技能特有依赖**;**不要**重复声明 `jiangchang-platform-kit` 或 `playwright`。`SKILL.md` 的 `platform_kit_min_version` 是运行契约,**不是** pip 依赖声明。
|
||||||
|
|
||||||
@@ -22,15 +22,15 @@ Windows:
|
|||||||
<shared-python> {baseDir}/scripts/main.py health
|
<shared-python> {baseDir}/scripts/main.py health
|
||||||
```
|
```
|
||||||
|
|
||||||
`<shared-python>` 通常位于 `{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。数据根由宿主注入;开发模式下也可能通过 `CLAW_DATA_ROOT` 解析(见 `jiangchang_skill_core.runtime_env`)。
|
`<shared-python>` 通常位于 `{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。数据根由宿主注入;开发模式下也可能通过 `JIANGCHANG_DATA_ROOT` 解析(见 `jiangchang_skill_core.runtime_env`)。
|
||||||
|
|
||||||
## Runtime 诊断(platform-kit 1.0.14+)
|
## Runtime 诊断(platform-kit 1.0.17+)
|
||||||
|
|
||||||
`health` 命令通过 **`jiangchang_skill_core.collect_runtime_diagnostics`** 输出共享 runtime 诊断,**不在技能内重复实现**。典型字段:
|
`health` 命令通过 **`jiangchang_skill_core.collect_runtime_diagnostics`** 输出共享 runtime 诊断,**不在技能内重复实现**。典型字段:
|
||||||
|
|
||||||
- `skill_slug`、`python_executable`、`platform_kit_version`、`platform_kit_min_version`
|
- `skill_slug`、`python_executable`、`platform_kit_version`、`platform_kit_min_version`
|
||||||
- `jiangchang_skill_core_file` — 若从技能目录加载会输出 `runtime_issue[warning]`
|
- `jiangchang_skill_core_file` — 若从技能目录加载会输出 `runtime_issue[warning]`
|
||||||
- `CLAW_DATA_ROOT` / `JIANGCHANG_DATA_ROOT` / `resolved_data_root`
|
- `JIANGCHANG_DATA_ROOT` / `resolved_data_root`
|
||||||
- `media_assets_root`、`ffmpeg_path`、`background_music_*`
|
- `media_assets_root`、`ffmpeg_path`、`background_music_*`
|
||||||
- `record_video_enabled`、`runtime_issue[warning|error]`
|
- `record_video_enabled`、`runtime_issue[warning|error]`
|
||||||
|
|
||||||
@@ -39,10 +39,10 @@ Windows:
|
|||||||
## 配置 bootstrap
|
## 配置 bootstrap
|
||||||
|
|
||||||
- 仓库内 `.env.example` 是配置模板(单一事实来源)。
|
- 仓库内 `.env.example` 是配置模板(单一事实来源)。
|
||||||
- 用户实际 `.env`:`{CLAW_DATA_ROOT}/{CLAW_USER_ID}/{skill_slug}/.env`。
|
- 用户实际 `.env`:`{JIANGCHANG_DATA_ROOT}/{JIANGCHANG_USER_ID}/{skill_slug}/.env`。
|
||||||
- `scripts/main.py` 与 `cli.app.main()` 启动时调用 `util.config_bootstrap.bootstrap_skill_config()`。
|
- `scripts/main.py` 与 `cli.app.main()` 启动时调用 `util.config_bootstrap.bootstrap_skill_config()`。
|
||||||
- 配置优先级:**进程环境变量** > **用户 `.env`** > **`.env.example` 默认值**。
|
- 配置优先级:**进程环境变量** > **用户 `.env`** > **`.env.example` 默认值**。
|
||||||
- 公共 `config` / `merge_missing_env_keys` 来自共享 runtime 的 `jiangchang-platform-kit>=1.0.14`,**不得** vendored `scripts/jiangchang_skill_core/`。
|
- 公共 `config` / `merge_missing_env_keys` 来自共享 runtime 的 `jiangchang-platform-kit>=1.0.17`,**不得** vendored `scripts/jiangchang_skill_core/`。
|
||||||
|
|
||||||
## media-assets / ffmpeg / 背景音乐
|
## media-assets / ffmpeg / 背景音乐
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Windows:
|
|||||||
{JIANGCHANG_DATA_ROOT}/shared/media-assets
|
{JIANGCHANG_DATA_ROOT}/shared/media-assets
|
||||||
```
|
```
|
||||||
|
|
||||||
(与 `CLAW_DATA_ROOT` 解析规则一致,由宿主注入。)
|
(由宿主注入 `JIANGCHANG_DATA_ROOT`。)
|
||||||
|
|
||||||
RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均由 platform-kit 提供;技能只 import,不重复实现。
|
RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均由 platform-kit 提供;技能只 import,不重复实现。
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@ RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均
|
|||||||
|
|
||||||
- `scripts/main.py`:唯一 CLI 入口
|
- `scripts/main.py`:唯一 CLI 入口
|
||||||
- `scripts/cli/`:参数解析与命令分发
|
- `scripts/cli/`:参数解析与命令分发
|
||||||
- `scripts/db/`:SQLite 或本地持久化层
|
- `scripts/db/`:SQLite 或本地持久化层(标准时间字段见 `references/SCHEMA.md`)
|
||||||
- `scripts/service/`:业务用例与外部交互
|
- `scripts/service/`:业务用例与外部交互
|
||||||
- `scripts/util/`:通用工具、常量、日志、路径薄封装
|
- `scripts/util/`:通用工具、常量、日志、路径薄封装
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均
|
|||||||
推荐:
|
推荐:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
{CLAW_DATA_ROOT}/{CLAW_USER_ID}/{skill_slug}/
|
{JIANGCHANG_DATA_ROOT}/{JIANGCHANG_USER_ID}/{skill_slug}/
|
||||||
```
|
```
|
||||||
|
|
||||||
数据库文件建议:
|
数据库文件建议:
|
||||||
@@ -89,6 +89,9 @@ RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均
|
|||||||
{...}/{skill_slug}.db
|
{...}/{skill_slug}.db
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- 业务表使用英文 snake_case;中文表名/字段名写入 `_jiangchang_tables` / `_jiangchang_columns`(见 `references/SCHEMA.md`)。
|
||||||
|
- 界面字段顺序由 `CREATE TABLE` 列定义顺序决定,**不要**维护 `display_order` 来调整顺序。
|
||||||
|
|
||||||
## 明确禁止
|
## 明确禁止
|
||||||
|
|
||||||
- **不得** vendored `scripts/jiangchang_skill_core/`
|
- **不得** vendored `scripts/jiangchang_skill_core/`
|
||||||
@@ -97,12 +100,12 @@ RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均
|
|||||||
|
|
||||||
## 测试时的运行时隔离
|
## 测试时的运行时隔离
|
||||||
|
|
||||||
本模板的 `tests/_support.IsolatedDataRoot` 会在测试期间同时设置:
|
本模板的 `tests/_support.IsolatedDataRoot` 会在测试期间设置:
|
||||||
|
|
||||||
- `CLAW_DATA_ROOT` / `JIANGCHANG_DATA_ROOT` → 临时 tempfile 目录
|
- `JIANGCHANG_DATA_ROOT` → 临时 tempfile 目录
|
||||||
- `CLAW_USER_ID` / `JIANGCHANG_USER_ID` → `_test`
|
- `JIANGCHANG_USER_ID` → `_test`
|
||||||
|
|
||||||
退出时四个变量恢复,临时目录删除。所有 DB / 文件写入都被限制在临时目录内,不污染本机。
|
退出时两个变量恢复,临时目录删除。所有 DB / 文件写入都被限制在临时目录内,不污染本机。
|
||||||
|
|
||||||
详见 `TESTING.md` 第 3 节。
|
详见 `TESTING.md` 第 3 节。
|
||||||
|
|
||||||
|
|||||||
@@ -23,13 +23,16 @@
|
|||||||
必跑套件要像一个紧张的守门员:**快、确定、离线**。典型覆盖:
|
必跑套件要像一个紧张的守门员:**快、确定、离线**。典型覆盖:
|
||||||
|
|
||||||
- CLI:导入 [`cli.app`](../scripts/cli/app.py) 走解析链路、`health`(runtime diagnostics)/ `version` / `logs` / `log-get` 冒烟;
|
- CLI:导入 [`cli.app`](../scripts/cli/app.py) 走解析链路、`health`(runtime diagnostics)/ `version` / `logs` / `log-get` 冒烟;
|
||||||
- 架构守护:无 `scripts/jiangchang_skill_core/`、`platform-kit>=1.0.14` 导入来源、文档/runtime 标准(见 `test_platform_import.py` 等);
|
- 架构守护:无 `scripts/jiangchang_skill_core/`、`platform-kit>=1.0.17` 导入来源、文档/runtime 标准(见 `test_platform_import.py` 等);
|
||||||
- **真实 subprocess**:[`tests/test_entrypoint_subprocess.py`](../tests/test_entrypoint_subprocess.py) 再调用一遍 `python scripts/main.py`,防路径漂移;
|
- **真实 subprocess**:[`tests/test_entrypoint_subprocess.py`](../tests/test_entrypoint_subprocess.py) 再调用一遍 `python scripts/main.py`,防路径漂移;
|
||||||
- 运行时:`runtime_paths` 与 **`CLAW_*` / `JIANGCHANG_*` 并发兜底;
|
- 运行时:`runtime_paths` 与 **`JIANGCHANG_*` 隔离**;
|
||||||
- `SKILL.md` YAML slug vs [`constants.SKILL_SLUG`](../scripts/util/constants.py);
|
- `SKILL.md` YAML slug vs [`constants.SKILL_SLUG`](../scripts/util/constants.py);
|
||||||
- SQLite 骨架:`task_logs` 创建幂等与仓储读写;
|
- SQLite 骨架:`task_logs` 创建幂等与仓储读写;
|
||||||
|
- 数据管理元数据:`_jiangchang_*` 幂等初始化、中文展示名、`PRAGMA table_info` 字段顺序(见 `test_display_metadata.py`);
|
||||||
|
- 标准时间字段:`created_at` / `updated_at` 默认值、trigger 维护与 `datetime_unix_seconds` 元数据(见 `test_timestamp_columns.py`);
|
||||||
- **adapter profile**:[`tests/test_adapter_profile_policy.py`](../tests/test_adapter_profile_policy.py) + [`adapter_test_utils`](../tests/adapter_test_utils.py) ——验证在未授权情况下绝不误判开启真实网络/RPA。
|
- **adapter profile**:[`tests/test_adapter_profile_policy.py`](../tests/test_adapter_profile_policy.py) + [`adapter_test_utils`](../tests/adapter_test_utils.py) ——验证在未授权情况下绝不误判开启真实网络/RPA。
|
||||||
- **发布打包守护**:[`tests/test_release_packaging_constraints.py`](../tests/test_release_packaging_constraints.py) ——`scripts/**/*.py` 单文件 < 1000 行、文本文件 UTF-8 without BOM。
|
- **发布打包守护**:[`tests/test_release_packaging_constraints.py`](../tests/test_release_packaging_constraints.py) ——`scripts/**/*.py` 单文件 < 1000 行、文本文件 UTF-8 without BOM。
|
||||||
|
- **slug 语义**:[`tests/test_slug_naming.py`](../tests/test_slug_naming.py) ——verb-noun-platform 命名规范校验。
|
||||||
|
|
||||||
**原则:`tests/test_*.py` 不允许隐形访问外网、不允许拉起真实浏览器、不允许读写开发者机器的真实数据根**。如果需要仿真服务器,也应仅在 integration(并由档位变量放行)。
|
**原则:`tests/test_*.py` 不允许隐形访问外网、不允许拉起真实浏览器、不允许读写开发者机器的真实数据根**。如果需要仿真服务器,也应仅在 integration(并由档位变量放行)。
|
||||||
|
|
||||||
@@ -39,7 +42,7 @@
|
|||||||
|
|
||||||
## 3. 数据隔离:IsolatedDataRoot
|
## 3. 数据隔离:IsolatedDataRoot
|
||||||
|
|
||||||
[`tests/_support.py`](../tests/_support.py) 提供的上下文管理器 `IsolatedDataRoot()`:进入一个专用临时目录,**镜像写入四套变量**:`CLAW_DATA_ROOT`、`JIANGCHANG_DATA_ROOT`(同一 tempfile)、以及用户镜像 ID:`CLAW_USER_ID`、`JIANGCHANG_USER_ID` → `_test`。
|
[`tests/_support.py`](../tests/_support.py) 提供的上下文管理器 `IsolatedDataRoot()`:进入一个专用临时目录,写入 `JIANGCHANG_DATA_ROOT`(tempfile)与 `JIANGCHANG_USER_ID` → `_test`。
|
||||||
|
|
||||||
结束时:**恢复原 environ**,删除目录。
|
结束时:**恢复原 environ**,删除目录。
|
||||||
|
|
||||||
@@ -211,7 +214,7 @@ Golden fixture 流程同理([`tests/samples/test_golden_cases.py.sample`](../t
|
|||||||
|
|
||||||
- [ ] `requirements.txt` **不含** `jiangchang-platform-kit` / `playwright`
|
- [ ] `requirements.txt` **不含** `jiangchang-platform-kit` / `playwright`
|
||||||
- [ ] 无 `scripts/jiangchang_skill_core/` vendored 副本
|
- [ ] 无 `scripts/jiangchang_skill_core/` vendored 副本
|
||||||
- [ ] `platform_kit_min_version` **>= 1.0.14**(`SKILL.md` + `constants.py`)
|
- [ ] `platform_kit_min_version` **>= 1.0.17**(`SKILL.md` + `constants.py`)
|
||||||
- [ ] `health` 能输出 `platform_kit_version_ok`(或等价诊断行)
|
- [ ] `health` 能输出 `platform_kit_version_ok`(或等价诊断行)
|
||||||
- [ ] `config-path` 可输出用户 `.env` 路径 JSON
|
- [ ] `config-path` 可输出用户 `.env` 路径 JSON
|
||||||
- [ ] `pytest.ini` 存在且 `python_files` 只收集 `test_*.py` / `*_test.py`
|
- [ ] `pytest.ini` 存在且 `python_files` 只收集 `test_*.py` / `*_test.py`
|
||||||
|
|||||||
@@ -131,7 +131,7 @@ real_browser_rpa/
|
|||||||
|
|
||||||
`account_client.py` 末尾的 `D:\OpenClaw\client-commons\account-manager\scripts\main.py` 是**开发环境兜底路径**,仅用于模板/本机调试。复制到真实 skill 后:
|
`account_client.py` 末尾的 `D:\OpenClaw\client-commons\account-manager\scripts\main.py` 是**开发环境兜底路径**,仅用于模板/本机调试。复制到真实 skill 后:
|
||||||
|
|
||||||
- **优先**通过 `ACCOUNT_MANAGER_ROOT`、`CLAW_SKILLS_ROOT`、`JIANGCHANG_SKILLS_ROOT` 或宿主运行环境解析 account-manager
|
- **优先**通过 `ACCOUNT_MANAGER_ROOT`、Platform Kit `get_sibling_skills_root` 或宿主运行环境解析 account-manager
|
||||||
- **不要**把个人机器路径作为生产依赖
|
- **不要**把个人机器路径作为生产依赖
|
||||||
|
|
||||||
## 必须保留的安全原则
|
## 必须保留的安全原则
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ import subprocess
|
|||||||
import sys
|
import sys
|
||||||
from typing import Any, Dict, List, Optional
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
|
from jiangchang_skill_core.runtime_env import get_sibling_skills_root
|
||||||
|
|
||||||
from util.constants import LEASE_HOLDER, LEASE_TTL_SEC, TARGET_PLATFORM
|
from util.constants import LEASE_HOLDER, LEASE_TTL_SEC, TARGET_PLATFORM
|
||||||
from util.logging import mask_text
|
from util.logging import mask_text
|
||||||
|
|
||||||
@@ -39,18 +41,18 @@ def mask_login_id(login_id: str) -> str:
|
|||||||
def _resolve_account_manager_main() -> str:
|
def _resolve_account_manager_main() -> str:
|
||||||
"""解析 account-manager CLI 入口路径。
|
"""解析 account-manager CLI 入口路径。
|
||||||
|
|
||||||
优先级:ACCOUNT_MANAGER_ROOT → CLAW_SKILLS_ROOT / JIANGCHANG_SKILLS_ROOT → 开发机兜底。
|
优先级:ACCOUNT_MANAGER_ROOT → get_sibling_skills_root(路径推断 / JIANGCHANG_SKILLS_ROOT)→ 开发机兜底。
|
||||||
末尾 dev 路径仅用于模板/本机调试,复制到真实 skill 后不要依赖个人机器绝对路径。
|
末尾 dev 路径仅用于模板/本机调试,复制到真实 skill 后不要依赖个人机器绝对路径。
|
||||||
"""
|
"""
|
||||||
env_root = (os.getenv("ACCOUNT_MANAGER_ROOT") or "").strip()
|
env_root = (os.getenv("ACCOUNT_MANAGER_ROOT") or "").strip()
|
||||||
if env_root and os.path.isfile(os.path.join(env_root, "scripts", "main.py")):
|
if env_root and os.path.isfile(os.path.join(env_root, "scripts", "main.py")):
|
||||||
return os.path.join(os.path.abspath(env_root), "scripts", "main.py")
|
return os.path.join(os.path.abspath(env_root), "scripts", "main.py")
|
||||||
|
|
||||||
skills_root = (os.getenv("CLAW_SKILLS_ROOT") or os.getenv("JIANGCHANG_SKILLS_ROOT") or "").strip()
|
scripts_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||||
if skills_root:
|
skills_root = get_sibling_skills_root(scripts_dir)
|
||||||
candidate = os.path.join(os.path.abspath(skills_root), "account-manager", "scripts", "main.py")
|
candidate = os.path.join(skills_root, "account-manager", "scripts", "main.py")
|
||||||
if os.path.isfile(candidate):
|
if os.path.isfile(candidate):
|
||||||
return candidate
|
return candidate
|
||||||
|
|
||||||
# 开发环境兜底:仅模板/本机调试;生产依赖宿主注入的路径变量,勿硬编码个人目录
|
# 开发环境兜底:仅模板/本机调试;生产依赖宿主注入的路径变量,勿硬编码个人目录
|
||||||
dev = r"D:\OpenClaw\client-commons\account-manager\scripts\main.py"
|
dev = r"D:\OpenClaw\client-commons\account-manager\scripts\main.py"
|
||||||
|
|||||||
@@ -1,38 +1,204 @@
|
|||||||
# 数据存储模板
|
# 数据存储与数据管理展示规范
|
||||||
|
|
||||||
## 数据库路径
|
本文是 skill 本地 SQLite 与匠厂宿主「数据管理」页面展示契约的**权威说明**。
|
||||||
|
实现上的 DDL 与默认中文元数据种子见 `scripts/db/display_metadata.py`;`scripts/db/connection.py` 的 `init_db()` 会一并初始化。
|
||||||
|
|
||||||
`{DATA_ROOT}/{USER_ID}/your-skill-slug/your-skill-slug.db`
|
## 职责边界
|
||||||
|
|
||||||
## 通用任务日志表(task_logs)
|
| 层级 | 负责内容 |
|
||||||
|
|------|----------|
|
||||||
|
| **技能(本仓库)** | `SKILL.md.name` 中文技能名;英文物理表/字段名;`_jiangchang_*` 中文展示元数据;`CREATE TABLE` 字段物理顺序 |
|
||||||
|
| **宿主(匠厂)** | 读取元数据与 PRAGMA 顺序并展示;不猜测业务语义、不按英文字段名重排 |
|
||||||
|
|
||||||
模板默认建表:
|
SQLite **没有**可靠的 `COMMENT ON TABLE/COLUMN`;SQL 文件里的 `-- 注释` 也不会成为可查询结构。
|
||||||
|
因此中文展示名称必须写入元数据表;字段顺序必须写在 `CREATE TABLE` 的列定义顺序中(`PRAGMA table_info` 的 `cid`)。
|
||||||
|
|
||||||
| 字段 | 类型 | 说明 |
|
> **禁止**新技能使用宿主的旧版 `_schema_meta` 表。仅 `_jiangchang_tables` / `_jiangchang_columns` 为正式契约。
|
||||||
|
|
||||||
|
## 技能名称(SKILL.md)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
name: 中文业务名称
|
||||||
|
description: 中文技能说明
|
||||||
|
metadata:
|
||||||
|
openclaw:
|
||||||
|
slug: english-kebab-slug
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
- `name`:用户可见的中文业务名称(可含品牌,如 `GEO 文章生成`、`1688 联系人采集`)。
|
||||||
|
- `description`:能力说明,不是技能名称。
|
||||||
|
- `metadata.openclaw.slug`:机器标识,kebab-case 英文;目录名与默认数据库文件名使用 slug。slug 语义规范见 [`../development/NAMING.md`](../development/NAMING.md);本文件仅描述数据库与 kebab-case 格式。
|
||||||
|
- 复制模板后不得将 `your-skill-slug`、`My Skill` 等占位内容作为正式技能发布名称。
|
||||||
|
|
||||||
|
## 数据库路径与命名
|
||||||
|
|
||||||
|
```text
|
||||||
|
{JIANGCHANG_DATA_ROOT}/{JIANGCHANG_USER_ID}/{skill-slug}/{skill-slug}.db
|
||||||
|
```
|
||||||
|
|
||||||
|
- 数据库文件:英文 slug,例如 `scrape-contacts.db`、`account-manager.db`(默认 `{skill-slug}.db`)。
|
||||||
|
- 业务表、字段:**英文 snake_case** 物理名,例如 `task_logs`、`created_at`。
|
||||||
|
- **禁止**用中文作为 SQLite 真实表名或字段名。
|
||||||
|
|
||||||
|
## 元数据表(宿主兼容)
|
||||||
|
|
||||||
|
宿主读取字段(与 `jiangchang` `metadata-resolver.ts` 一致):
|
||||||
|
|
||||||
|
### `_jiangchang_tables`
|
||||||
|
|
||||||
|
| 字段 | 必填 | 说明 |
|
||||||
|------|------|------|
|
|------|------|------|
|
||||||
| `id` | INTEGER PK | 自增主键 |
|
| `table_name` | 是 | 物理表名 |
|
||||||
| `task_type` | TEXT NOT NULL | 任务类型(disburse / reconcile / verify ...) |
|
| `display_name` | 是 | 中文表名(用户可见) |
|
||||||
| `target_id` | TEXT | 任务目标(账号、平台、客户等的 ID) |
|
| `description` | 否 | 表说明 |
|
||||||
| `input_id` | TEXT | 输入对象 ID |
|
| `sort_order` | 否 | 宿主目录排序;与字段顺序无关 |
|
||||||
| `input_title` | TEXT | 输入对象标题快照 |
|
| `visible` | 是 | `1` 展示 / `0` 隐藏 |
|
||||||
| `status` | TEXT NOT NULL | success / failed / partial / require_login 等 |
|
| `readonly` | 是 | `1` 只读 / `0` 可写(业务语义) |
|
||||||
| `error_msg` | TEXT | 错误说明 |
|
|
||||||
| `result_summary` | TEXT | 结果摘要(建议存 JSON 字符串) |
|
|
||||||
| `created_at` | INTEGER | Unix 时间戳 |
|
|
||||||
| `updated_at` | INTEGER | Unix 时间戳 |
|
|
||||||
|
|
||||||
## 不同业务的字段映射建议
|
### `_jiangchang_columns`
|
||||||
|
|
||||||
| 业务场景 | task_type | target_id 含义 | input_id 含义 |
|
| 字段 | 必填 | 说明 |
|
||||||
|---|---|---|---|
|
|------|------|------|
|
||||||
| 发布类 | publish | 账号 ID | 文章 ID |
|
| `table_name` | 是 | 物理表名 |
|
||||||
| 工资代发 | disburse | 付款账户 | 工资表批次 ID |
|
| `column_name` | 是 | 物理字段名 |
|
||||||
| 对账 | reconcile | 银行 / 平台 | 对账批次 ID |
|
| `display_name` | 是 | 中文字段名(用户可见) |
|
||||||
|
| `description` | 否 | 字段说明 |
|
||||||
|
| `display_order` | 否 | **遗留兼容字段;模板写入时固定 NULL,重复初始化会清理历史非空值,不得用于调整展示顺序** |
|
||||||
|
| `visible` | 是 | 是否展示 |
|
||||||
|
| `searchable` | 是 | 是否可搜索 |
|
||||||
|
| `editable` | 是 | 是否可编辑(与宿主权限结合) |
|
||||||
|
| `display_type` | 否 | 如 `text` / `textarea` / `datetime_unix_seconds`(标准时间字段见下文) |
|
||||||
|
| `options_json` | 否 | 枚举选项 JSON |
|
||||||
|
|
||||||
|
这两张表是**数据字典**,不是业务数据;宿主不会把它们当作普通业务表展示。
|
||||||
|
|
||||||
|
写入应**幂等**(`INSERT … ON CONFLICT DO UPDATE`),数据库升级时同步维护元数据。
|
||||||
|
|
||||||
|
## 业务字段物理顺序
|
||||||
|
|
||||||
|
用户在「数据管理」中看到的列顺序 = `CREATE TABLE` 定义顺序 = `PRAGMA table_info` 的 `cid` 顺序。
|
||||||
|
**宿主不会**按英文字段名、`display_order` 或语义规则重排。
|
||||||
|
|
||||||
|
推荐顺序(可按业务裁剪,但已有字段应遵守相对位置):
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. 主键 id
|
||||||
|
2. 关联标识与核心业务字段
|
||||||
|
3. 普通业务字段
|
||||||
|
4. 状态、结果、错误等辅助字段
|
||||||
|
5. created_at(如有)
|
||||||
|
6. updated_at(如有)
|
||||||
|
|
||||||
|
## 标准时间字段(新技能统一规范)
|
||||||
|
|
||||||
|
新技能业务表若需要时间审计字段,**统一**采用 Unix **秒级**时间戳,不要使用毫秒时间戳、ISO 字符串或 SQLite 文本 datetime。
|
||||||
|
|
||||||
|
| 项目 | 规范 |
|
||||||
|
|------|------|
|
||||||
|
| 物理字段 | `created_at INTEGER`、`updated_at INTEGER` |
|
||||||
|
| 存储格式 | Unix 秒级整数 |
|
||||||
|
| 展示元数据 `display_type` | `datetime_unix_seconds` |
|
||||||
|
| 中文名 | `created_at` → **创建时间**;`updated_at` → **更新时间** |
|
||||||
|
| 用户编辑 | `editable = 0`(系统字段,宿主只展示格式化结果,不写回字符串) |
|
||||||
|
| 字段顺序 | 位于业务字段末尾:`… → created_at → updated_at` |
|
||||||
|
| 排序 | **不使用** `display_order`;顺序仅来自 `PRAGMA table_info` |
|
||||||
|
|
||||||
|
### 自动生成与维护
|
||||||
|
|
||||||
|
- **created_at**:`INTEGER NOT NULL DEFAULT (unixepoch())`;插入时可省略,由数据库生成。
|
||||||
|
- **updated_at**:`INTEGER NOT NULL DEFAULT (unixepoch())`;插入时同样可省略。
|
||||||
|
- **updated_at 更新**:模板默认表 `task_logs` 通过 SQLite trigger `{table}_set_updated_at` 在业务字段更新后自动刷新;若技能所有 UPDATE 都经过统一 repository,也可在 repository 层设置 `updated_at = unixepoch()`,**不要**叠加两套机制。
|
||||||
|
|
||||||
|
实现参考:
|
||||||
|
|
||||||
|
- DDL 与 trigger:`scripts/db/connection.py`、`scripts/db/timestamp_columns.py`
|
||||||
|
- 中文元数据种子:`scripts/db/display_metadata.py`
|
||||||
|
- 自检:`scripts/db/display_metadata_validator.py`
|
||||||
|
|
||||||
|
宿主(匠厂)只负责把 `display_type = datetime_unix_seconds` 格式化为 `YYYY-MM-DD HH:mm:ss` 展示,**不修改**数据库原始值。
|
||||||
|
|
||||||
|
> `datetime_unix_milliseconds`、`datetime_iso` 是宿主兼容能力,**不是**新技能模板推荐标准。
|
||||||
|
|
||||||
|
### 模板默认:`task_logs`
|
||||||
|
|
||||||
|
物理定义(权威顺序):
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE TABLE IF NOT EXISTS task_logs (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
task_type TEXT NOT NULL,
|
||||||
|
target_id TEXT,
|
||||||
|
input_id TEXT,
|
||||||
|
input_title TEXT,
|
||||||
|
status TEXT NOT NULL,
|
||||||
|
error_msg TEXT,
|
||||||
|
result_summary TEXT,
|
||||||
|
created_at INTEGER NOT NULL DEFAULT (unixepoch()),
|
||||||
|
updated_at INTEGER NOT NULL DEFAULT (unixepoch())
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
插入时可省略 `created_at`、`updated_at`;`updated_at` 在 UPDATE 时由 trigger `task_logs_set_updated_at` 自动维护(见 `scripts/db/timestamp_columns.py`)。
|
||||||
|
|
||||||
|
对应中文展示(由 `init_db()` 写入元数据表):
|
||||||
|
|
||||||
|
| 物理字段 | 中文名 |
|
||||||
|
|----------|--------|
|
||||||
|
| id | 编号 |
|
||||||
|
| task_type | 任务类型 |
|
||||||
|
| target_id | 目标编号 |
|
||||||
|
| input_id | 输入编号 |
|
||||||
|
| input_title | 输入标题 |
|
||||||
|
| status | 状态 |
|
||||||
|
| error_msg | 错误信息 |
|
||||||
|
| result_summary | 结果摘要 |
|
||||||
|
| created_at | 创建时间(`display_type = datetime_unix_seconds`,不可编辑) |
|
||||||
|
| updated_at | 更新时间(`display_type = datetime_unix_seconds`,不可编辑) |
|
||||||
|
|
||||||
|
表中文名:**任务日志**。
|
||||||
|
|
||||||
|
禁止事项:
|
||||||
|
|
||||||
|
- 不要把 `created_at` 放在第一列;
|
||||||
|
- 不要把 `id` 随意放在中间;
|
||||||
|
- 不要指望宿主按英文字段名排序;
|
||||||
|
- 若需调整历史表字段顺序,应通过规范迁移**重建表**,而不是在宿主侧配置掩盖。
|
||||||
|
|
||||||
|
复合主键或特殊表结构,请在本文档或技能自有 SCHEMA 补充中说明例外。
|
||||||
|
|
||||||
|
## 中文命名质量
|
||||||
|
|
||||||
|
- 使用普通用户能理解的业务用语:`task_logs` → **任务日志**,`error_msg` → **错误信息**。
|
||||||
|
- 禁止:`Task Logs`、`input编号`、`errormsg`、直接把物理名当 `display_name`。
|
||||||
|
- 不宜向用户暴露的实现细节(如 `payload_json`、`selector`)应设 `visible = 0` 或给出可理解中文名。
|
||||||
|
|
||||||
|
## 元数据同步规则
|
||||||
|
|
||||||
|
1. 新增用户可见业务表 → 同步 `_jiangchang_tables`。
|
||||||
|
2. 新增用户可见字段 → 同步 `_jiangchang_columns`。
|
||||||
|
3. 删除/重命名表或字段 → 同步清理或迁移元数据。
|
||||||
|
4. 初始化脚本必须幂等。
|
||||||
|
5. 元数据中的表、字段必须在库中真实存在;可见项不得缺少中文 `display_name`。
|
||||||
|
|
||||||
|
## 不同业务的 `task_logs` 映射
|
||||||
|
|
||||||
|
| 业务场景 | task_type | target_id | input_id |
|
||||||
|
|----------|-----------|-----------|----------|
|
||||||
|
| 发布类 | publish | 账号 ID | 内容 ID |
|
||||||
|
| 工资代发 | disburse | 付款账户 | 批次 ID |
|
||||||
|
| 对账 | reconcile | 银行/平台 | 对账批次 ID |
|
||||||
| 发票验真 | verify | 税务地区 | 发票批次 ID |
|
| 发票验真 | verify | 税务地区 | 发票批次 ID |
|
||||||
| 报关 | declare | 港口 / 海关 | 报关批次 ID |
|
|
||||||
|
业务特有字段优先放入 `result_summary`(JSON 字符串),避免随意加列;若确需新列,必须同步元数据并保持合理物理顺序。
|
||||||
|
|
||||||
|
## 开发自检
|
||||||
|
|
||||||
|
- `init_db()` 后运行 `tests/test_display_metadata.py`。
|
||||||
|
- 复制为真实技能后,使用 `scripts/db/display_metadata_validator.py` 中的校验函数检查 SKILL 名称、slug 与元数据完整性。
|
||||||
|
|
||||||
## 模板原则
|
## 模板原则
|
||||||
|
|
||||||
- 模板不做历史迁移兼容设计
|
- 模板不做复杂历史迁移框架;新 skill 从当前 schema 起步。
|
||||||
- 新 skill 直接从当前 schema 起步
|
- 元数据 DDL 与 `task_logs` 中文种子以 `scripts/db/display_metadata.py` 为单一权威来源。
|
||||||
- 业务有特殊字段时,建议放 `result_summary`(JSON 字符串),不要乱加列
|
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import sqlite3
|
import sqlite3
|
||||||
|
|
||||||
|
from db.display_metadata import init_display_metadata
|
||||||
|
from db.timestamp_columns import init_task_logs_timestamp_maintenance
|
||||||
from util.runtime_paths import get_db_path
|
from util.runtime_paths import get_db_path
|
||||||
|
|
||||||
|
|
||||||
@@ -26,11 +28,13 @@ def init_db() -> None:
|
|||||||
status TEXT NOT NULL,
|
status TEXT NOT NULL,
|
||||||
error_msg TEXT,
|
error_msg TEXT,
|
||||||
result_summary TEXT,
|
result_summary TEXT,
|
||||||
created_at INTEGER NOT NULL,
|
created_at INTEGER NOT NULL DEFAULT (unixepoch()),
|
||||||
updated_at INTEGER NOT NULL
|
updated_at INTEGER NOT NULL DEFAULT (unixepoch())
|
||||||
)
|
)
|
||||||
"""
|
"""
|
||||||
)
|
)
|
||||||
|
init_task_logs_timestamp_maintenance(cur)
|
||||||
|
init_display_metadata(cur)
|
||||||
conn.commit()
|
conn.commit()
|
||||||
finally:
|
finally:
|
||||||
conn.close()
|
conn.close()
|
||||||
|
|||||||
185
scripts/db/display_metadata.py
Normal file
185
scripts/db/display_metadata.py
Normal file
@@ -0,0 +1,185 @@
|
|||||||
|
"""匠厂数据管理展示元数据(_jiangchang_tables / _jiangchang_columns)。
|
||||||
|
|
||||||
|
SQLite 无原生表/字段 COMMENT;中文展示名称通过这两张元数据表提供给宿主「数据管理」页面。
|
||||||
|
字段在界面上的顺序由 CREATE TABLE / PRAGMA table_info(cid) 决定,**不**使用 display_order 排序。
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Iterable
|
||||||
|
|
||||||
|
# 宿主会隐藏这些表,不作为业务表展示(见 jiangchang electron/data-management/types.ts)
|
||||||
|
INTERNAL_METADATA_TABLES = frozenset({"_jiangchang_tables", "_jiangchang_columns"})
|
||||||
|
LEGACY_METADATA_TABLES = frozenset({"_schema_meta"})
|
||||||
|
METADATA_TABLES = INTERNAL_METADATA_TABLES | LEGACY_METADATA_TABLES
|
||||||
|
|
||||||
|
TASK_LOGS_TABLE = "task_logs"
|
||||||
|
DATETIME_UNIX_SECONDS = "datetime_unix_seconds"
|
||||||
|
STANDARD_TIMESTAMP_COLUMNS = frozenset({"created_at", "updated_at"})
|
||||||
|
|
||||||
|
_JIANGCHANG_TABLES_DDL = """
|
||||||
|
CREATE TABLE IF NOT EXISTS _jiangchang_tables (
|
||||||
|
table_name TEXT PRIMARY KEY,
|
||||||
|
display_name TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
sort_order INTEGER,
|
||||||
|
visible INTEGER NOT NULL DEFAULT 1,
|
||||||
|
readonly INTEGER NOT NULL DEFAULT 0
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
_JIANGCHANG_COLUMNS_DDL = """
|
||||||
|
CREATE TABLE IF NOT EXISTS _jiangchang_columns (
|
||||||
|
table_name TEXT NOT NULL,
|
||||||
|
column_name TEXT NOT NULL,
|
||||||
|
display_name TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
display_order INTEGER,
|
||||||
|
visible INTEGER NOT NULL DEFAULT 1,
|
||||||
|
searchable INTEGER NOT NULL DEFAULT 1,
|
||||||
|
editable INTEGER NOT NULL DEFAULT 1,
|
||||||
|
display_type TEXT,
|
||||||
|
options_json TEXT,
|
||||||
|
PRIMARY KEY (table_name, column_name)
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
TASK_LOGS_TABLE_METADATA = {
|
||||||
|
"table_name": TASK_LOGS_TABLE,
|
||||||
|
"display_name": "任务日志",
|
||||||
|
"description": "记录技能任务的执行状态和结果",
|
||||||
|
"visible": 1,
|
||||||
|
"readonly": 0,
|
||||||
|
}
|
||||||
|
|
||||||
|
TASK_LOGS_COLUMN_METADATA: tuple[dict[str, object], ...] = (
|
||||||
|
{"column_name": "id", "display_name": "编号", "description": "任务日志唯一编号", "visible": 1, "searchable": 1, "editable": 0},
|
||||||
|
{"column_name": "task_type", "display_name": "任务类型", "description": "任务的业务类型", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{"column_name": "target_id", "display_name": "目标编号", "description": "任务目标对象编号", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{"column_name": "input_id", "display_name": "输入编号", "description": "输入对象编号", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{"column_name": "input_title", "display_name": "输入标题", "description": "输入对象标题", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{"column_name": "status", "display_name": "状态", "description": "任务当前状态", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{"column_name": "error_msg", "display_name": "错误信息", "description": "任务失败时的错误说明", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{"column_name": "result_summary", "display_name": "结果摘要", "description": "任务执行结果摘要", "visible": 1, "searchable": 1, "editable": 1},
|
||||||
|
{
|
||||||
|
"column_name": "created_at",
|
||||||
|
"display_name": "创建时间",
|
||||||
|
"description": "记录创建时间(Unix 秒级时间戳,数据库自动生成)",
|
||||||
|
"visible": 1,
|
||||||
|
"searchable": 0,
|
||||||
|
"editable": 0,
|
||||||
|
"display_type": DATETIME_UNIX_SECONDS,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"column_name": "updated_at",
|
||||||
|
"display_name": "更新时间",
|
||||||
|
"description": "记录最后更新时间(Unix 秒级时间戳,自动维护)",
|
||||||
|
"visible": 1,
|
||||||
|
"searchable": 0,
|
||||||
|
"editable": 0,
|
||||||
|
"display_type": DATETIME_UNIX_SECONDS,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def init_display_metadata_tables(cursor) -> None:
|
||||||
|
cursor.execute(_JIANGCHANG_TABLES_DDL)
|
||||||
|
cursor.execute(_JIANGCHANG_COLUMNS_DDL)
|
||||||
|
|
||||||
|
|
||||||
|
def upsert_table_metadata(cursor, *, table_name: str, display_name: str, description: str | None = None, visible: int = 1, readonly: int = 0) -> None:
|
||||||
|
cursor.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_tables (table_name, display_name, description, visible, readonly)
|
||||||
|
VALUES (?, ?, ?, ?, ?)
|
||||||
|
ON CONFLICT(table_name) DO UPDATE SET
|
||||||
|
display_name = excluded.display_name,
|
||||||
|
description = excluded.description,
|
||||||
|
visible = excluded.visible,
|
||||||
|
readonly = excluded.readonly
|
||||||
|
""",
|
||||||
|
(table_name, display_name, description, visible, readonly),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def upsert_column_metadata(
|
||||||
|
cursor,
|
||||||
|
*,
|
||||||
|
table_name: str,
|
||||||
|
column_name: str,
|
||||||
|
display_name: str,
|
||||||
|
description: str | None = None,
|
||||||
|
visible: int = 1,
|
||||||
|
searchable: int = 1,
|
||||||
|
editable: int = 1,
|
||||||
|
display_type: str | None = None,
|
||||||
|
) -> None:
|
||||||
|
# display_order 保留为 NULL:宿主按 PRAGMA table_info cid 展示字段,不读 display_order。
|
||||||
|
cursor.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_columns (
|
||||||
|
table_name, column_name, display_name, description,
|
||||||
|
display_order, visible, searchable, editable, display_type
|
||||||
|
)
|
||||||
|
VALUES (?, ?, ?, ?, NULL, ?, ?, ?, ?)
|
||||||
|
ON CONFLICT(table_name, column_name) DO UPDATE SET
|
||||||
|
display_name = excluded.display_name,
|
||||||
|
description = excluded.description,
|
||||||
|
display_order = NULL,
|
||||||
|
visible = excluded.visible,
|
||||||
|
searchable = excluded.searchable,
|
||||||
|
editable = excluded.editable,
|
||||||
|
display_type = excluded.display_type
|
||||||
|
""",
|
||||||
|
(table_name, column_name, display_name, description, visible, searchable, editable, display_type),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def seed_task_logs_display_metadata(cursor) -> None:
|
||||||
|
meta = TASK_LOGS_TABLE_METADATA
|
||||||
|
upsert_table_metadata(
|
||||||
|
cursor,
|
||||||
|
table_name=str(meta["table_name"]),
|
||||||
|
display_name=str(meta["display_name"]),
|
||||||
|
description=str(meta["description"]) if meta.get("description") else None,
|
||||||
|
visible=int(meta["visible"]),
|
||||||
|
readonly=int(meta["readonly"]),
|
||||||
|
)
|
||||||
|
for column in TASK_LOGS_COLUMN_METADATA:
|
||||||
|
upsert_column_metadata(
|
||||||
|
cursor,
|
||||||
|
table_name=TASK_LOGS_TABLE,
|
||||||
|
column_name=str(column["column_name"]),
|
||||||
|
display_name=str(column["display_name"]),
|
||||||
|
description=str(column["description"]) if column.get("description") else None,
|
||||||
|
visible=int(column["visible"]),
|
||||||
|
searchable=int(column["searchable"]),
|
||||||
|
editable=int(column["editable"]),
|
||||||
|
display_type=str(column["display_type"]) if column.get("display_type") else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def init_display_metadata(cursor) -> None:
|
||||||
|
init_display_metadata_tables(cursor)
|
||||||
|
seed_task_logs_display_metadata(cursor)
|
||||||
|
|
||||||
|
|
||||||
|
def iter_user_tables(cursor) -> Iterable[str]:
|
||||||
|
cursor.execute(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' ORDER BY name"
|
||||||
|
)
|
||||||
|
for (name,) in cursor.fetchall():
|
||||||
|
if name in METADATA_TABLES:
|
||||||
|
continue
|
||||||
|
yield str(name)
|
||||||
|
|
||||||
|
|
||||||
|
def _quote_identifier(name: str) -> str:
|
||||||
|
return '"' + name.replace('"', '""') + '"'
|
||||||
|
|
||||||
|
|
||||||
|
def list_physical_column_names(cursor, table_name: str) -> list[str]:
|
||||||
|
cursor.execute(f"PRAGMA table_info({_quote_identifier(table_name)})")
|
||||||
|
rows = cursor.fetchall()
|
||||||
|
rows.sort(key=lambda row: int(row[0]))
|
||||||
|
return [str(row[1]) for row in rows]
|
||||||
378
scripts/db/display_metadata_validator.py
Normal file
378
scripts/db/display_metadata_validator.py
Normal file
@@ -0,0 +1,378 @@
|
|||||||
|
"""数据管理展示元数据校验(模板开发自检,不依赖宿主)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sqlite3
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
|
||||||
|
from db.display_metadata import (
|
||||||
|
DATETIME_UNIX_SECONDS,
|
||||||
|
METADATA_TABLES,
|
||||||
|
STANDARD_TIMESTAMP_COLUMNS,
|
||||||
|
TASK_LOGS_COLUMN_METADATA,
|
||||||
|
TASK_LOGS_TABLE,
|
||||||
|
iter_user_tables,
|
||||||
|
list_physical_column_names,
|
||||||
|
)
|
||||||
|
from db.timestamp_columns import has_updated_at_trigger
|
||||||
|
from util.constants import SKILL_SLUG
|
||||||
|
from util.slug_naming import LEGACY_EXEMPT_SLUGS, validate_slug_semantics
|
||||||
|
|
||||||
|
_TEMPLATE_PLACEHOLDER_SLUGS = frozenset({"your-skill-slug", "your_skill_slug"})
|
||||||
|
_ENGLISH_PLACEHOLDER_NAME_PATTERNS = (
|
||||||
|
re.compile(r"^my\s+skill$", re.I),
|
||||||
|
re.compile(r"^your[-_\s]?skill", re.I),
|
||||||
|
re.compile(r"^skill[-_\s]?template$", re.I),
|
||||||
|
re.compile(r"^[a-z0-9_-]+$"),
|
||||||
|
)
|
||||||
|
_KEBAB_SLUG = re.compile(r"^[a-z0-9]+(?:-[a-z0-9]+)*$")
|
||||||
|
_CJK_RE = re.compile(r"[\u4e00-\u9fff]")
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ValidationReport:
|
||||||
|
errors: list[str] = field(default_factory=list)
|
||||||
|
warnings: list[str] = field(default_factory=list)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def ok(self) -> bool:
|
||||||
|
return not self.errors
|
||||||
|
|
||||||
|
|
||||||
|
def _has_cjk(text: str) -> bool:
|
||||||
|
return bool(_CJK_RE.search(text))
|
||||||
|
|
||||||
|
|
||||||
|
def _looks_like_raw_physical_name(display_name: str, physical_name: str) -> bool:
|
||||||
|
if not display_name.strip():
|
||||||
|
return True
|
||||||
|
if display_name.strip().lower() == physical_name.strip().lower():
|
||||||
|
return True
|
||||||
|
compact = display_name.replace(" ", "").replace("_", "").lower()
|
||||||
|
if compact == physical_name.replace("_", "").lower():
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_frontmatter_field(text: str, field_name: str) -> str:
|
||||||
|
parts = text.split("---", 2)
|
||||||
|
if len(parts) < 2:
|
||||||
|
return ""
|
||||||
|
for line in parts[1].splitlines():
|
||||||
|
match = re.match(rf"^{re.escape(field_name)}:\s*(.+)\s*$", line.strip())
|
||||||
|
if match:
|
||||||
|
return match.group(1).strip().strip("\"'")
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_openclaw_slug(text: str) -> str:
|
||||||
|
parts = text.split("---", 2)
|
||||||
|
if len(parts) < 2:
|
||||||
|
return ""
|
||||||
|
lines = parts[1].splitlines()
|
||||||
|
for index, line in enumerate(lines):
|
||||||
|
if re.match(r"^\s+openclaw:\s*$", line):
|
||||||
|
for inner in lines[index + 1 :]:
|
||||||
|
if inner.strip() and inner[0] not in (" ", "\t"):
|
||||||
|
break
|
||||||
|
match = re.match(r"^(\s+)slug:\s*(.+)\s*$", inner)
|
||||||
|
if match:
|
||||||
|
return match.group(2).strip().strip("\"'")
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def parse_skill_frontmatter(skill_root: str) -> dict[str, str]:
|
||||||
|
path = os.path.join(skill_root, "SKILL.md")
|
||||||
|
with open(path, encoding="utf-8") as f:
|
||||||
|
text = f.read()
|
||||||
|
return {
|
||||||
|
"name": _parse_frontmatter_field(text, "name"),
|
||||||
|
"slug": _parse_openclaw_slug(text),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def validate_skill_frontmatter(skill_root: str, *, allow_template_placeholders: bool = True) -> ValidationReport:
|
||||||
|
report = ValidationReport()
|
||||||
|
data = parse_skill_frontmatter(skill_root)
|
||||||
|
name = str(data.get("name") or "").strip()
|
||||||
|
slug = str(data.get("slug") or "").strip()
|
||||||
|
|
||||||
|
if not name:
|
||||||
|
report.errors.append("SKILL.md frontmatter.name 缺失")
|
||||||
|
elif not _has_cjk(name):
|
||||||
|
if allow_template_placeholders and slug in _TEMPLATE_PLACEHOLDER_SLUGS:
|
||||||
|
report.warnings.append("SKILL.md frontmatter.name 建议使用清晰的中文业务名称(模板占位可暂保留)")
|
||||||
|
else:
|
||||||
|
report.errors.append("SKILL.md frontmatter.name 应使用用户可见的中文业务名称")
|
||||||
|
else:
|
||||||
|
for pattern in _ENGLISH_PLACEHOLDER_NAME_PATTERNS:
|
||||||
|
if pattern.fullmatch(name):
|
||||||
|
if allow_template_placeholders and slug in _TEMPLATE_PLACEHOLDER_SLUGS:
|
||||||
|
report.warnings.append(f"SKILL.md frontmatter.name 仍为占位风格:{name!r}")
|
||||||
|
else:
|
||||||
|
report.errors.append(f"SKILL.md frontmatter.name 不应为英文占位名:{name!r}")
|
||||||
|
break
|
||||||
|
|
||||||
|
if not slug:
|
||||||
|
report.errors.append("SKILL.md metadata.openclaw.slug 缺失")
|
||||||
|
elif not _KEBAB_SLUG.fullmatch(slug):
|
||||||
|
report.errors.append(f"metadata.openclaw.slug 必须为 kebab-case:{slug!r}")
|
||||||
|
elif slug in _TEMPLATE_PLACEHOLDER_SLUGS and not allow_template_placeholders:
|
||||||
|
report.errors.append(f"metadata.openclaw.slug 仍为模板占位:{slug!r}")
|
||||||
|
|
||||||
|
constants_slug = SKILL_SLUG.strip()
|
||||||
|
if slug and constants_slug and slug != constants_slug:
|
||||||
|
report.warnings.append(
|
||||||
|
f"SKILL.md slug ({slug!r}) 与 util.constants.SKILL_SLUG ({constants_slug!r}) 不一致"
|
||||||
|
)
|
||||||
|
|
||||||
|
if slug and slug not in LEGACY_EXEMPT_SLUGS and _KEBAB_SLUG.fullmatch(slug):
|
||||||
|
naming_errors, naming_warnings = validate_slug_semantics(
|
||||||
|
slug,
|
||||||
|
strict=not allow_template_placeholders,
|
||||||
|
)
|
||||||
|
report.errors.extend(naming_errors)
|
||||||
|
report.warnings.extend(naming_warnings)
|
||||||
|
|
||||||
|
return report
|
||||||
|
|
||||||
|
|
||||||
|
def _quote_identifier(name: str) -> str:
|
||||||
|
return '"' + name.replace('"', '""') + '"'
|
||||||
|
|
||||||
|
|
||||||
|
def _table_column_info(cursor, table_name: str) -> dict[str, dict[str, object]]:
|
||||||
|
cursor.execute(f"PRAGMA table_info({_quote_identifier(table_name)})")
|
||||||
|
info: dict[str, dict[str, object]] = {}
|
||||||
|
for row in cursor.fetchall():
|
||||||
|
info[str(row[1])] = {
|
||||||
|
"cid": int(row[0]),
|
||||||
|
"name": str(row[1]),
|
||||||
|
"type": str(row[2] or ""),
|
||||||
|
"notnull": int(row[3] or 0),
|
||||||
|
"dflt_value": row[4],
|
||||||
|
"pk": int(row[5] or 0),
|
||||||
|
}
|
||||||
|
return info
|
||||||
|
|
||||||
|
|
||||||
|
def _default_uses_unixepoch(default_value: object) -> bool:
|
||||||
|
if default_value is None:
|
||||||
|
return False
|
||||||
|
text = str(default_value).strip().lower()
|
||||||
|
return "unixepoch" in text
|
||||||
|
|
||||||
|
|
||||||
|
def _expected_timestamp_display_name(column_name: str) -> str:
|
||||||
|
if column_name == "created_at":
|
||||||
|
return "创建时间"
|
||||||
|
if column_name == "updated_at":
|
||||||
|
return "更新时间"
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def validate_standard_timestamp_columns(
|
||||||
|
cursor,
|
||||||
|
table_name: str,
|
||||||
|
*,
|
||||||
|
physical_columns: list[str] | None = None,
|
||||||
|
) -> tuple[list[str], list[str]]:
|
||||||
|
errors: list[str] = []
|
||||||
|
warnings: list[str] = []
|
||||||
|
ordered = physical_columns or list_physical_column_names(cursor, table_name)
|
||||||
|
column_info = _table_column_info(cursor, table_name)
|
||||||
|
|
||||||
|
for column_name in STANDARD_TIMESTAMP_COLUMNS:
|
||||||
|
if column_name not in ordered:
|
||||||
|
continue
|
||||||
|
|
||||||
|
physical = column_info.get(column_name)
|
||||||
|
if not physical:
|
||||||
|
errors.append(f"{table_name}.{column_name} 缺少物理字段定义")
|
||||||
|
continue
|
||||||
|
|
||||||
|
if "INT" not in str(physical["type"]).upper():
|
||||||
|
errors.append(
|
||||||
|
f"{table_name}.{column_name} 字段类型应为 INTEGER(Unix 秒级时间戳),当前为 {physical['type']!r}"
|
||||||
|
)
|
||||||
|
|
||||||
|
if column_name == "created_at" and not _default_uses_unixepoch(physical["dflt_value"]):
|
||||||
|
errors.append(
|
||||||
|
f"{table_name}.created_at 应设置数据库默认值 DEFAULT (unixepoch()),当前默认值为 {physical['dflt_value']!r}"
|
||||||
|
)
|
||||||
|
if column_name == "updated_at" and not _default_uses_unixepoch(physical["dflt_value"]):
|
||||||
|
errors.append(
|
||||||
|
f"{table_name}.updated_at 应设置数据库初始默认值 DEFAULT (unixepoch()),当前默认值为 {physical['dflt_value']!r}"
|
||||||
|
)
|
||||||
|
|
||||||
|
cursor.execute(
|
||||||
|
"""
|
||||||
|
SELECT display_name, display_type, editable, searchable, display_order
|
||||||
|
FROM _jiangchang_columns
|
||||||
|
WHERE table_name = ? AND column_name = ?
|
||||||
|
""",
|
||||||
|
(table_name, column_name),
|
||||||
|
)
|
||||||
|
meta_row = cursor.fetchone()
|
||||||
|
if not meta_row:
|
||||||
|
errors.append(f"{table_name}.{column_name} 缺少 _jiangchang_columns 元数据")
|
||||||
|
continue
|
||||||
|
|
||||||
|
display_name, display_type, editable, searchable, display_order = meta_row
|
||||||
|
expected_name = _expected_timestamp_display_name(column_name)
|
||||||
|
if str(display_name or "").strip() != expected_name:
|
||||||
|
errors.append(
|
||||||
|
f"{table_name}.{column_name} 的 display_name 应为 {expected_name!r},当前为 {display_name!r}"
|
||||||
|
)
|
||||||
|
if str(display_type or "").strip() != DATETIME_UNIX_SECONDS:
|
||||||
|
errors.append(
|
||||||
|
f"{table_name}.{column_name} 的 display_type 应为 {DATETIME_UNIX_SECONDS!r},当前为 {display_type!r}"
|
||||||
|
)
|
||||||
|
if editable is None or int(editable) != 0:
|
||||||
|
errors.append(f"{table_name}.{column_name} 的 editable 应为 0(系统时间字段不可编辑)")
|
||||||
|
if display_order is not None:
|
||||||
|
errors.append(f"{table_name}.{column_name} 的 display_order 应为 NULL")
|
||||||
|
if searchable is not None and int(searchable) != 0:
|
||||||
|
warnings.append(f"{table_name}.{column_name} 的时间字段通常不必开启 searchable")
|
||||||
|
|
||||||
|
if "created_at" in ordered and "updated_at" in ordered:
|
||||||
|
if ordered.index("updated_at") < ordered.index("created_at"):
|
||||||
|
warnings.append(f"{table_name}: updated_at 不应出现在 created_at 之前")
|
||||||
|
|
||||||
|
if "updated_at" in ordered and not has_updated_at_trigger(cursor, table_name):
|
||||||
|
errors.append(
|
||||||
|
f"{table_name}.updated_at 缺少自动维护 trigger(期望 {table_name}_set_updated_at)"
|
||||||
|
)
|
||||||
|
|
||||||
|
return errors, warnings
|
||||||
|
|
||||||
|
|
||||||
|
def column_order_warnings(table_name: str, ordered_names: list[str]) -> list[str]:
|
||||||
|
warnings: list[str] = []
|
||||||
|
if "id" in ordered_names and ordered_names.index("id") != 0:
|
||||||
|
warnings.append(f"{table_name}: 字段 id 通常应定义在 CREATE TABLE 的第一列")
|
||||||
|
if "created_at" in ordered_names:
|
||||||
|
idx = ordered_names.index("created_at")
|
||||||
|
trailing = ordered_names[idx + 1 :]
|
||||||
|
if trailing and trailing != ["updated_at"]:
|
||||||
|
warnings.append(
|
||||||
|
f"{table_name}: created_at 之后通常只应跟 updated_at,不应再放置其他业务字段"
|
||||||
|
)
|
||||||
|
if "updated_at" in ordered_names and "created_at" in ordered_names:
|
||||||
|
if ordered_names.index("updated_at") < ordered_names.index("created_at"):
|
||||||
|
warnings.append(f"{table_name}: updated_at 不应出现在 created_at 之前")
|
||||||
|
return warnings
|
||||||
|
|
||||||
|
|
||||||
|
def _table_exists(cursor, table_name: str) -> bool:
|
||||||
|
cursor.execute(
|
||||||
|
"SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ? LIMIT 1",
|
||||||
|
(table_name,),
|
||||||
|
)
|
||||||
|
return cursor.fetchone() is not None
|
||||||
|
|
||||||
|
|
||||||
|
def validate_display_metadata(conn: sqlite3.Connection, *, check_column_order: bool = True) -> ValidationReport:
|
||||||
|
report = ValidationReport()
|
||||||
|
cur = conn.cursor()
|
||||||
|
|
||||||
|
has_tables_meta = _table_exists(cur, "_jiangchang_tables")
|
||||||
|
has_columns_meta = _table_exists(cur, "_jiangchang_columns")
|
||||||
|
if not has_tables_meta:
|
||||||
|
report.errors.append("缺少数据管理元数据表 _jiangchang_tables")
|
||||||
|
if not has_columns_meta:
|
||||||
|
report.errors.append("缺少数据管理元数据表 _jiangchang_columns")
|
||||||
|
if not has_tables_meta or not has_columns_meta:
|
||||||
|
return report
|
||||||
|
|
||||||
|
for table_name in iter_user_tables(cur):
|
||||||
|
cur.execute(
|
||||||
|
"SELECT display_name FROM _jiangchang_tables WHERE table_name = ?",
|
||||||
|
(table_name,),
|
||||||
|
)
|
||||||
|
row = cur.fetchone()
|
||||||
|
if not row or not str(row[0] or "").strip():
|
||||||
|
report.errors.append(f"业务表 {table_name!r} 缺少 _jiangchang_tables.display_name")
|
||||||
|
elif not _has_cjk(str(row[0])):
|
||||||
|
report.errors.append(f"业务表 {table_name!r} 的 display_name 应使用中文业务名称")
|
||||||
|
|
||||||
|
physical_columns = list_physical_column_names(cur, table_name)
|
||||||
|
if check_column_order:
|
||||||
|
report.warnings.extend(column_order_warnings(table_name, physical_columns))
|
||||||
|
|
||||||
|
for column_name in physical_columns:
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
SELECT display_name, visible
|
||||||
|
FROM _jiangchang_columns
|
||||||
|
WHERE table_name = ? AND column_name = ?
|
||||||
|
""",
|
||||||
|
(table_name, column_name),
|
||||||
|
)
|
||||||
|
col_row = cur.fetchone()
|
||||||
|
if not col_row:
|
||||||
|
report.errors.append(
|
||||||
|
f"字段 {table_name}.{column_name} 缺少 _jiangchang_columns 元数据"
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
display_name = str(col_row[0] or "").strip()
|
||||||
|
visible = col_row[1] is None or int(col_row[1]) != 0
|
||||||
|
if visible and not display_name:
|
||||||
|
report.errors.append(f"字段 {table_name}.{column_name} 的 display_name 为空")
|
||||||
|
elif visible and _looks_like_raw_physical_name(display_name, column_name):
|
||||||
|
report.errors.append(
|
||||||
|
f"字段 {table_name}.{column_name} 的 display_name 不应直接等于英文物理名:{display_name!r}"
|
||||||
|
)
|
||||||
|
elif visible and not _has_cjk(display_name):
|
||||||
|
report.errors.append(
|
||||||
|
f"字段 {table_name}.{column_name} 的 display_name 应使用中文:{display_name!r}"
|
||||||
|
)
|
||||||
|
|
||||||
|
ts_errors, ts_warnings = validate_standard_timestamp_columns(
|
||||||
|
cur,
|
||||||
|
table_name,
|
||||||
|
physical_columns=physical_columns,
|
||||||
|
)
|
||||||
|
report.errors.extend(ts_errors)
|
||||||
|
report.warnings.extend(ts_warnings)
|
||||||
|
|
||||||
|
cur.execute("SELECT table_name, column_name FROM _jiangchang_columns")
|
||||||
|
for table_name, column_name in cur.fetchall():
|
||||||
|
if table_name in METADATA_TABLES:
|
||||||
|
continue
|
||||||
|
cur.execute(
|
||||||
|
"SELECT 1 FROM sqlite_master WHERE type='table' AND name = ?",
|
||||||
|
(table_name,),
|
||||||
|
)
|
||||||
|
if not cur.fetchone():
|
||||||
|
report.errors.append(f"元数据引用了不存在的表:{table_name!r}")
|
||||||
|
continue
|
||||||
|
physical = list_physical_column_names(cur, str(table_name))
|
||||||
|
if str(column_name) not in physical:
|
||||||
|
report.errors.append(f"元数据引用了不存在的字段:{table_name}.{column_name}")
|
||||||
|
|
||||||
|
cur.execute("SELECT table_name FROM _jiangchang_tables")
|
||||||
|
for (table_name,) in cur.fetchall():
|
||||||
|
if table_name in METADATA_TABLES:
|
||||||
|
continue
|
||||||
|
cur.execute(
|
||||||
|
"SELECT 1 FROM sqlite_master WHERE type='table' AND name = ?",
|
||||||
|
(table_name,),
|
||||||
|
)
|
||||||
|
if not cur.fetchone():
|
||||||
|
report.errors.append(f"元数据引用了不存在的表:{table_name!r}")
|
||||||
|
|
||||||
|
return report
|
||||||
|
|
||||||
|
|
||||||
|
def validate_template_database(conn: sqlite3.Connection) -> ValidationReport:
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
physical = list_physical_column_names(conn.cursor(), TASK_LOGS_TABLE)
|
||||||
|
expected = [str(item["column_name"]) for item in TASK_LOGS_COLUMN_METADATA]
|
||||||
|
if physical != expected:
|
||||||
|
report.errors.append(
|
||||||
|
f"task_logs 物理字段顺序应为 {expected},当前为 {physical}"
|
||||||
|
)
|
||||||
|
return report
|
||||||
@@ -9,7 +9,6 @@ from __future__ import annotations
|
|||||||
from typing import Any, List, Optional, Tuple
|
from typing import Any, List, Optional, Tuple
|
||||||
|
|
||||||
from db.connection import get_conn, init_db
|
from db.connection import get_conn, init_db
|
||||||
from util.timeutil import now_unix
|
|
||||||
|
|
||||||
|
|
||||||
def save_task_log(
|
def save_task_log(
|
||||||
@@ -22,17 +21,16 @@ def save_task_log(
|
|||||||
result_summary: Optional[str] = None,
|
result_summary: Optional[str] = None,
|
||||||
) -> int:
|
) -> int:
|
||||||
init_db()
|
init_db()
|
||||||
now = now_unix()
|
|
||||||
conn = get_conn()
|
conn = get_conn()
|
||||||
try:
|
try:
|
||||||
cur = conn.cursor()
|
cur = conn.cursor()
|
||||||
cur.execute(
|
cur.execute(
|
||||||
"""
|
"""
|
||||||
INSERT INTO task_logs
|
INSERT INTO task_logs
|
||||||
(task_type, target_id, input_id, input_title, status, error_msg, result_summary, created_at, updated_at)
|
(task_type, target_id, input_id, input_title, status, error_msg, result_summary)
|
||||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
VALUES (?, ?, ?, ?, ?, ?, ?)
|
||||||
""",
|
""",
|
||||||
(task_type, target_id, input_id, input_title or "", status, error_msg, result_summary, now, now),
|
(task_type, target_id, input_id, input_title or "", status, error_msg, result_summary),
|
||||||
)
|
)
|
||||||
new_id = int(cur.lastrowid)
|
new_id = int(cur.lastrowid)
|
||||||
conn.commit()
|
conn.commit()
|
||||||
|
|||||||
36
scripts/db/timestamp_columns.py
Normal file
36
scripts/db/timestamp_columns.py
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
"""标准时间字段:Unix 秒级时间戳、默认值与 updated_at 自动维护。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
STANDARD_TIMESTAMP_COLUMNS = frozenset({"created_at", "updated_at"})
|
||||||
|
DATETIME_UNIX_SECONDS = "datetime_unix_seconds"
|
||||||
|
TASK_LOGS_UPDATED_AT_TRIGGER = "task_logs_set_updated_at"
|
||||||
|
|
||||||
|
_TASK_LOGS_UPDATED_AT_TRIGGER_DDL = f"""
|
||||||
|
CREATE TRIGGER IF NOT EXISTS {TASK_LOGS_UPDATED_AT_TRIGGER}
|
||||||
|
AFTER UPDATE ON task_logs
|
||||||
|
FOR EACH ROW
|
||||||
|
BEGIN
|
||||||
|
UPDATE task_logs
|
||||||
|
SET updated_at = unixepoch()
|
||||||
|
WHERE id = NEW.id AND updated_at = OLD.updated_at;
|
||||||
|
END
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def init_task_logs_timestamp_maintenance(cursor) -> None:
|
||||||
|
"""幂等创建 task_logs.updated_at 自动维护 trigger。"""
|
||||||
|
cursor.execute(_TASK_LOGS_UPDATED_AT_TRIGGER_DDL)
|
||||||
|
|
||||||
|
|
||||||
|
def has_updated_at_trigger(cursor, table_name: str) -> bool:
|
||||||
|
trigger_name = f"{table_name}_set_updated_at"
|
||||||
|
cursor.execute(
|
||||||
|
"""
|
||||||
|
SELECT 1 FROM sqlite_master
|
||||||
|
WHERE type = 'trigger' AND name = ? AND tbl_name = ?
|
||||||
|
LIMIT 1
|
||||||
|
""",
|
||||||
|
(trigger_name, table_name),
|
||||||
|
)
|
||||||
|
return cursor.fetchone() is not None
|
||||||
@@ -12,9 +12,9 @@ def check_entitlement(skill_slug: str) -> Tuple[bool, str]:
|
|||||||
auth_base = (os.getenv("JIANGCHANG_AUTH_BASE_URL") or "").strip().rstrip("/")
|
auth_base = (os.getenv("JIANGCHANG_AUTH_BASE_URL") or "").strip().rstrip("/")
|
||||||
if not auth_base:
|
if not auth_base:
|
||||||
return True, ""
|
return True, ""
|
||||||
user_id = (os.getenv("CLAW_USER_ID") or os.getenv("JIANGCHANG_USER_ID") or "").strip()
|
user_id = (os.getenv("JIANGCHANG_USER_ID") or "").strip()
|
||||||
if not user_id:
|
if not user_id:
|
||||||
return False, "鉴权失败:缺少用户身份(CLAW_USER_ID / JIANGCHANG_USER_ID)"
|
return False, "鉴权失败:缺少用户身份(JIANGCHANG_USER_ID)"
|
||||||
|
|
||||||
auth_api_key = (os.getenv("JIANGCHANG_AUTH_API_KEY") or "").strip()
|
auth_api_key = (os.getenv("JIANGCHANG_AUTH_API_KEY") or "").strip()
|
||||||
timeout = int((os.getenv("JIANGCHANG_AUTH_TIMEOUT_SECONDS") or "5").strip())
|
timeout = int((os.getenv("JIANGCHANG_AUTH_TIMEOUT_SECONDS") or "5").strip())
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
"""技能标识、版本与平台公共库约束(复制后请修改 slug/version/logger)。"""
|
"""技能标识、版本与平台公共库约束(复制后请修改 slug/version/logger)。"""
|
||||||
|
|
||||||
SKILL_SLUG = "your-skill-slug"
|
SKILL_SLUG = "your-skill-slug"
|
||||||
SKILL_VERSION = "1.0.14"
|
SKILL_VERSION = "1.0.32"
|
||||||
LOG_LOGGER_NAME = "openclaw.skill.your_skill_slug"
|
LOG_LOGGER_NAME = "openclaw.skill.your_skill_slug"
|
||||||
PLATFORM_KIT_MIN_VERSION = "1.0.14"
|
PLATFORM_KIT_MIN_VERSION = "1.0.17"
|
||||||
|
|||||||
227
scripts/util/slug_naming.py
Normal file
227
scripts/util/slug_naming.py
Normal file
@@ -0,0 +1,227 @@
|
|||||||
|
"""技能 slug 语义校验(verb-noun-platform 规范,见 development/NAMING.md)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
|
_KEBAB_SLUG = re.compile(r"^[a-z0-9]+(?:-[a-z0-9]+)*$")
|
||||||
|
_MAX_SLUG_LENGTH = 48
|
||||||
|
_MIN_SEGMENTS = 3
|
||||||
|
_MAX_SEGMENTS = 5
|
||||||
|
_MAX_NOUN_SEGMENTS = 3
|
||||||
|
|
||||||
|
_SKILL_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||||
|
_NAMING_DIR = os.path.join(_SKILL_ROOT, "assets", "naming")
|
||||||
|
|
||||||
|
_BUILTIN_VERBS = frozenset(
|
||||||
|
{
|
||||||
|
"scrape",
|
||||||
|
"receive",
|
||||||
|
"download",
|
||||||
|
"export",
|
||||||
|
"add",
|
||||||
|
"fill",
|
||||||
|
"enter",
|
||||||
|
"bind",
|
||||||
|
"withdraw",
|
||||||
|
"reconcile",
|
||||||
|
"verify",
|
||||||
|
"submit",
|
||||||
|
"query",
|
||||||
|
"process",
|
||||||
|
"reply",
|
||||||
|
"generate",
|
||||||
|
"draft",
|
||||||
|
"review",
|
||||||
|
"confirm",
|
||||||
|
"track",
|
||||||
|
"upload",
|
||||||
|
"match",
|
||||||
|
"triage",
|
||||||
|
"ship",
|
||||||
|
"reprice",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
_BUILTIN_PLATFORMS = frozenset(
|
||||||
|
{
|
||||||
|
"amazon",
|
||||||
|
"shopee",
|
||||||
|
"xinghang",
|
||||||
|
"alibaba",
|
||||||
|
"kingdee",
|
||||||
|
"icbc",
|
||||||
|
"pingpong",
|
||||||
|
"worldfirst",
|
||||||
|
"paypal",
|
||||||
|
"lianlian",
|
||||||
|
"single-window",
|
||||||
|
"export-rebate",
|
||||||
|
"etax",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
_BUILTIN_SCOPES = frozenset({"all", "batch", "multi", "default"})
|
||||||
|
|
||||||
|
LEGACY_EXEMPT_SLUGS: frozenset[str] = frozenset(
|
||||||
|
{
|
||||||
|
"account-manager",
|
||||||
|
"skill-template",
|
||||||
|
"your-skill-slug",
|
||||||
|
"your_skill_slug",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def load_wordlist(filename: str) -> frozenset[str]:
|
||||||
|
"""从 assets/naming/{filename} 加载词表;文件不存在时 fallback 内置集合。"""
|
||||||
|
fallbacks = {
|
||||||
|
"verbs.txt": _BUILTIN_VERBS,
|
||||||
|
"platforms.txt": _BUILTIN_PLATFORMS,
|
||||||
|
"scopes.txt": _BUILTIN_SCOPES,
|
||||||
|
}
|
||||||
|
fallback = fallbacks.get(filename, frozenset())
|
||||||
|
path = os.path.join(_NAMING_DIR, filename)
|
||||||
|
if not os.path.isfile(path):
|
||||||
|
return fallback
|
||||||
|
words: set[str] = set()
|
||||||
|
with open(path, encoding="utf-8") as f:
|
||||||
|
for line in f:
|
||||||
|
word = line.strip()
|
||||||
|
if word and not word.startswith("#"):
|
||||||
|
words.add(word)
|
||||||
|
return frozenset(words) if words else fallback
|
||||||
|
|
||||||
|
|
||||||
|
def parse_slug_segments(slug: str) -> list[str]:
|
||||||
|
"""按 '-' 分割;非法字符由上层 kebab 校验处理。"""
|
||||||
|
slug = slug.strip()
|
||||||
|
if not slug:
|
||||||
|
return []
|
||||||
|
return slug.split("-")
|
||||||
|
|
||||||
|
|
||||||
|
def _match_platform_suffix(
|
||||||
|
segments: list[str],
|
||||||
|
platforms: frozenset[str],
|
||||||
|
) -> tuple[str, int] | None:
|
||||||
|
"""返回 (platform_name, platform_part_count) 或 None。"""
|
||||||
|
for platform in sorted(platforms, key=lambda item: (-item.count("-"), item)):
|
||||||
|
parts = platform.split("-")
|
||||||
|
part_count = len(parts)
|
||||||
|
if len(segments) < part_count + 2:
|
||||||
|
continue
|
||||||
|
if segments[-part_count:] == parts:
|
||||||
|
return platform, part_count
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def classify_slug_form(segments: list[str], *, slug: str = "") -> str:
|
||||||
|
"""
|
||||||
|
返回: 'legacy_exempt' | 'standard' | 'scope' | 'invalid'
|
||||||
|
|
||||||
|
- legacy_exempt: slug in LEGACY_EXEMPT_SLUGS
|
||||||
|
- standard: 末段匹配 platforms, 首段 in verbs, 3<=len<=5
|
||||||
|
- scope: 末段 in scopes, 首段 in verbs, 3<=len<=5
|
||||||
|
- invalid: 其他
|
||||||
|
"""
|
||||||
|
if slug in LEGACY_EXEMPT_SLUGS:
|
||||||
|
return "legacy_exempt"
|
||||||
|
|
||||||
|
if not segments or not (_MIN_SEGMENTS <= len(segments) <= _MAX_SEGMENTS):
|
||||||
|
return "invalid"
|
||||||
|
|
||||||
|
verbs = load_wordlist("verbs.txt")
|
||||||
|
platforms = load_wordlist("platforms.txt")
|
||||||
|
scopes = load_wordlist("scopes.txt")
|
||||||
|
|
||||||
|
if segments[0] not in verbs:
|
||||||
|
return "invalid"
|
||||||
|
|
||||||
|
if segments[-1] in scopes:
|
||||||
|
return "scope"
|
||||||
|
|
||||||
|
if _match_platform_suffix(segments, platforms) is not None:
|
||||||
|
return "standard"
|
||||||
|
|
||||||
|
return "invalid"
|
||||||
|
|
||||||
|
|
||||||
|
def validate_slug_semantics(
|
||||||
|
slug: str,
|
||||||
|
*,
|
||||||
|
strict: bool = True,
|
||||||
|
) -> tuple[list[str], list[str]]:
|
||||||
|
"""返回 (errors, warnings)。"""
|
||||||
|
slug = slug.strip()
|
||||||
|
if slug in LEGACY_EXEMPT_SLUGS:
|
||||||
|
return [], []
|
||||||
|
|
||||||
|
errors: list[str] = []
|
||||||
|
warnings: list[str] = []
|
||||||
|
|
||||||
|
if not _KEBAB_SLUG.fullmatch(slug):
|
||||||
|
msg = f"slug 必须为 kebab-case(小写字母、数字、连字符):{slug!r}"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
return errors, warnings
|
||||||
|
|
||||||
|
if len(slug) > _MAX_SLUG_LENGTH:
|
||||||
|
msg = f"slug 长度不得超过 {_MAX_SLUG_LENGTH} 字符(当前 {len(slug)}):{slug!r}"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
|
||||||
|
segments = parse_slug_segments(slug)
|
||||||
|
segment_count = len(segments)
|
||||||
|
|
||||||
|
if segment_count < _MIN_SEGMENTS:
|
||||||
|
msg = (
|
||||||
|
f"slug 段数应为 {_MIN_SEGMENTS}~{_MAX_SEGMENTS}(verb-noun-platform),"
|
||||||
|
f"当前为 {segment_count} 段:{slug!r};新技能禁止 2 段无平台形态(如 reconcile-finance)"
|
||||||
|
)
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
return errors, warnings
|
||||||
|
|
||||||
|
if segment_count > _MAX_SEGMENTS:
|
||||||
|
msg = f"slug 段数不得超过 {_MAX_SEGMENTS}(当前 {segment_count}):{slug!r}"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
|
||||||
|
verbs = load_wordlist("verbs.txt")
|
||||||
|
platforms = load_wordlist("platforms.txt")
|
||||||
|
scopes = load_wordlist("scopes.txt")
|
||||||
|
|
||||||
|
if segments[0] in platforms and segments[0] not in verbs:
|
||||||
|
msg = f"平台名不应放在 slug 最前:{slug!r}(应为 verb-noun-platform)"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
|
||||||
|
if segments[0] not in verbs:
|
||||||
|
msg = f"slug 首段应为动词白名单中的词:{segments[0]!r}(slug={slug!r})"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
|
||||||
|
form = classify_slug_form(segments, slug=slug)
|
||||||
|
if form == "scope":
|
||||||
|
if segments[-1] not in scopes:
|
||||||
|
msg = f"slug 末段应为 scope 白名单中的词:{segments[-1]!r}(slug={slug!r})"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
noun_count = segment_count - 2
|
||||||
|
elif form == "standard":
|
||||||
|
platform_match = _match_platform_suffix(segments, platforms)
|
||||||
|
if platform_match is None:
|
||||||
|
msg = f"slug 末段应匹配平台白名单:{slug!r}"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
noun_count = 0
|
||||||
|
else:
|
||||||
|
_platform_name, platform_part_count = platform_match
|
||||||
|
noun_count = segment_count - 1 - platform_part_count
|
||||||
|
else:
|
||||||
|
if segment_count >= _MIN_SEGMENTS:
|
||||||
|
if segments[-1] not in scopes:
|
||||||
|
platform_match = _match_platform_suffix(segments, platforms)
|
||||||
|
if platform_match is None:
|
||||||
|
msg = f"slug 末段应匹配平台或 scope 白名单:{slug!r}"
|
||||||
|
(errors if strict else warnings).append(msg)
|
||||||
|
noun_count = 0
|
||||||
|
|
||||||
|
if noun_count > _MAX_NOUN_SEGMENTS:
|
||||||
|
warnings.append(
|
||||||
|
f"slug 中间名词段建议不超过 {_MAX_NOUN_SEGMENTS} 个词(当前 {noun_count}):{slug!r}"
|
||||||
|
)
|
||||||
|
|
||||||
|
return errors, warnings
|
||||||
@@ -70,9 +70,11 @@ python tests/run_tests.py test_cli_smoke
|
|||||||
|------|------|
|
|------|------|
|
||||||
| CLI 冒烟(import ``cli.app.main``) | ``test_cli_smoke.py`` |
|
| CLI 冒烟(import ``cli.app.main``) | ``test_cli_smoke.py`` |
|
||||||
| **subprocess 真实入口** ``python scripts/main.py`` | ``test_entrypoint_subprocess.py`` |
|
| **subprocess 真实入口** ``python scripts/main.py`` | ``test_entrypoint_subprocess.py`` |
|
||||||
| 运行路径与 **CLAW_*/JIANGCHANG_*** 隔离 | ``test_runtime_paths.py`` |
|
| 运行路径与 **JIANGCHANG_*** 隔离 | ``test_runtime_paths.py`` |
|
||||||
| ``SKILL.md`` slug 与 ``constants.SKILL_SLUG`` | ``test_skill_metadata.py`` |
|
| ``SKILL.md`` slug 与 ``constants.SKILL_SLUG`` | ``test_skill_metadata.py`` |
|
||||||
| DB / ``task_logs`` 骨架冒烟 | ``test_db_smoke.py`` |
|
| DB / ``task_logs`` 骨架冒烟 | ``test_db_smoke.py`` |
|
||||||
|
| 数据管理元数据 / 字段顺序 | ``test_display_metadata.py`` |
|
||||||
|
| 标准时间字段(Unix 秒 / trigger / 元数据) | ``test_timestamp_columns.py`` |
|
||||||
| **adapter profile / 外呼授权策略** | ``test_adapter_profile_policy.py`` + ``adapter_test_utils.py``(非 ``test_`` 前缀,不自动当用例收集) |
|
| **adapter profile / 外呼授权策略** | ``test_adapter_profile_policy.py`` + ``adapter_test_utils.py``(非 ``test_`` 前缀,不自动当用例收集) |
|
||||||
| **无 vendored ``jiangchang_skill_core``** | ``test_platform_import.py`` |
|
| **无 vendored ``jiangchang_skill_core``** | ``test_platform_import.py`` |
|
||||||
| **runtime diagnostics 架构守护** | ``test_runtime_diagnostics_integration.py`` |
|
| **runtime diagnostics 架构守护** | ``test_runtime_diagnostics_integration.py`` |
|
||||||
@@ -84,17 +86,14 @@ python tests/run_tests.py test_cli_smoke
|
|||||||
|
|
||||||
### 1.3 数据隔离(``_support.IsolatedDataRoot``)
|
### 1.3 数据隔离(``_support.IsolatedDataRoot``)
|
||||||
|
|
||||||
同时设置(进入同一临时目录 / 用户):
|
进入同一临时目录 / 用户:
|
||||||
|
|
||||||
| ``CLAW_DATA_ROOT`` | ``JIANGCHANG_DATA_ROOT`` |
|
| 变量 | 值 |
|
||||||
|--------------------|---------------------------|
|
|------|-----|
|
||||||
| 同一 ``tempfile.mkdtemp(prefix="skill-test-")`` | 同上 |
|
| ``JIANGCHANG_DATA_ROOT`` | ``tempfile.mkdtemp(prefix="skill-test-")`` |
|
||||||
|
| ``JIANGCHANG_USER_ID`` | ``_test`` |
|
||||||
|
|
||||||
| ``CLAW_USER_ID`` | ``JIANGCHANG_USER_ID`` |
|
退出时两个键均恢复(原不存在则 ``pop``),并删除临时目录。
|
||||||
|------------------|-------------------------|
|
|
||||||
| ``_test`` | ``_test`` |
|
|
||||||
|
|
||||||
退出时四个键均恢复(原不存在则 ``pop``),并删除临时目录。
|
|
||||||
|
|
||||||
### 1.4 产物与密钥
|
### 1.4 产物与密钥
|
||||||
|
|
||||||
|
|||||||
@@ -3,10 +3,8 @@
|
|||||||
测试公共支撑。
|
测试公共支撑。
|
||||||
|
|
||||||
1. 将 scripts/ 加入 sys.path,便于 `from cli…` / `from db…` / `from util…` 等导入。
|
1. 将 scripts/ 加入 sys.path,便于 `from cli…` / `from db…` / `from util…` 等导入。
|
||||||
2. `IsolatedDataRoot`:同时设置 CLAW_* 与 JIANGCHANG_* 数据根与用户 ID,
|
2. `IsolatedDataRoot`:设置 `JIANGCHANG_DATA_ROOT` 与 `JIANGCHANG_USER_ID`,
|
||||||
与 `jiangchang_skill_core.runtime_env` 的优先级一致(CLAW_* 优先),
|
退出时恢复原值并删除临时目录,避免污染真实用户数据目录。
|
||||||
避免只设 JIANGCHANG_* 时仍读到真实 CLAW_DATA_ROOT。
|
|
||||||
退出时四个变量均恢复;原不存在的键会删除;并 rmtree 临时目录。
|
|
||||||
"""
|
"""
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
@@ -24,9 +22,7 @@ if _SCRIPTS_DIR not in sys.path:
|
|||||||
sys.path.insert(0, _SCRIPTS_DIR)
|
sys.path.insert(0, _SCRIPTS_DIR)
|
||||||
|
|
||||||
_ISOLATION_KEYS = (
|
_ISOLATION_KEYS = (
|
||||||
"CLAW_DATA_ROOT",
|
|
||||||
"JIANGCHANG_DATA_ROOT",
|
"JIANGCHANG_DATA_ROOT",
|
||||||
"CLAW_USER_ID",
|
|
||||||
"JIANGCHANG_USER_ID",
|
"JIANGCHANG_USER_ID",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -39,7 +35,7 @@ def get_skill_root() -> str:
|
|||||||
return _SKILL_ROOT
|
return _SKILL_ROOT
|
||||||
|
|
||||||
|
|
||||||
def platform_kit_version_patch(version: str = "1.0.14"):
|
def platform_kit_version_patch(version: str = "1.0.17"):
|
||||||
"""Mock installed jiangchang-platform-kit version for health/diagnostics tests."""
|
"""Mock installed jiangchang-platform-kit version for health/diagnostics tests."""
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
|
|
||||||
@@ -53,11 +49,11 @@ class IsolatedDataRoot:
|
|||||||
"""
|
"""
|
||||||
在独立临时目录下模拟数据根,避免污染本机默认数据目录。
|
在独立临时目录下模拟数据根,避免污染本机默认数据目录。
|
||||||
|
|
||||||
进入上下文时(同一套隔离值写入 CLAW_* 与 JIANGCHANG_*):
|
进入上下文时:
|
||||||
- CLAW_DATA_ROOT / JIANGCHANG_DATA_ROOT -> 同一 tempfile.mkdtemp(prefix='skill-test-')
|
- JIANGCHANG_DATA_ROOT -> tempfile.mkdtemp(prefix='skill-test-')
|
||||||
- CLAW_USER_ID / JIANGCHANG_USER_ID -> _test(与业务默认用户区分)
|
- JIANGCHANG_USER_ID -> _test(与业务默认用户区分)
|
||||||
|
|
||||||
退出时:四个变量均恢复为进入前状态(若原先未设置则 pop),并删除临时目录。
|
退出时:两个变量均恢复为进入前状态(若原先未设置则 pop),并删除临时目录。
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, user_id: str = "_test") -> None:
|
def __init__(self, user_id: str = "_test") -> None:
|
||||||
@@ -69,9 +65,7 @@ class IsolatedDataRoot:
|
|||||||
self._tmp = tempfile.mkdtemp(prefix="skill-test-")
|
self._tmp = tempfile.mkdtemp(prefix="skill-test-")
|
||||||
for k in _ISOLATION_KEYS:
|
for k in _ISOLATION_KEYS:
|
||||||
self._old[k] = os.environ.get(k)
|
self._old[k] = os.environ.get(k)
|
||||||
os.environ["CLAW_DATA_ROOT"] = self._tmp
|
|
||||||
os.environ["JIANGCHANG_DATA_ROOT"] = self._tmp
|
os.environ["JIANGCHANG_DATA_ROOT"] = self._tmp
|
||||||
os.environ["CLAW_USER_ID"] = self._user_id
|
|
||||||
os.environ["JIANGCHANG_USER_ID"] = self._user_id
|
os.environ["JIANGCHANG_USER_ID"] = self._user_id
|
||||||
return self._tmp
|
return self._tmp
|
||||||
|
|
||||||
|
|||||||
@@ -10,12 +10,20 @@ from _support import IsolatedDataRoot
|
|||||||
class TestDbSmoke(unittest.TestCase):
|
class TestDbSmoke(unittest.TestCase):
|
||||||
def test_init_db_idempotent_and_crud_smoke(self) -> None:
|
def test_init_db_idempotent_and_crud_smoke(self) -> None:
|
||||||
with IsolatedDataRoot():
|
with IsolatedDataRoot():
|
||||||
from db.connection import init_db
|
|
||||||
from db import task_logs_repository as tlr
|
from db import task_logs_repository as tlr
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
init_db()
|
init_db()
|
||||||
init_db() # 幂等
|
init_db() # 幂等
|
||||||
|
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute("SELECT display_name FROM _jiangchang_tables WHERE table_name = 'task_logs'")
|
||||||
|
self.assertEqual(cur.fetchone()[0], "任务日志")
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
new_id = tlr.save_task_log(
|
new_id = tlr.save_task_log(
|
||||||
task_type="demo_task",
|
task_type="demo_task",
|
||||||
target_id="tgt-1",
|
target_id="tgt-1",
|
||||||
|
|||||||
347
tests/test_display_metadata.py
Normal file
347
tests/test_display_metadata.py
Normal file
@@ -0,0 +1,347 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""数据管理展示元数据:幂等初始化、中文名称、PRAGMA 字段顺序、校验规则。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from _support import IsolatedDataRoot, get_skill_root
|
||||||
|
|
||||||
|
|
||||||
|
class TestDisplayMetadata(unittest.TestCase):
|
||||||
|
def test_init_db_metadata_idempotent(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
init_db()
|
||||||
|
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute("SELECT COUNT(*) FROM _jiangchang_tables WHERE table_name = 'task_logs'")
|
||||||
|
self.assertEqual(int(cur.fetchone()[0]), 1)
|
||||||
|
cur.execute("SELECT COUNT(*) FROM _jiangchang_columns WHERE table_name = 'task_logs'")
|
||||||
|
self.assertEqual(int(cur.fetchone()[0]), 10)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_task_logs_has_chinese_table_and_column_names(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"SELECT display_name FROM _jiangchang_tables WHERE table_name = 'task_logs'"
|
||||||
|
)
|
||||||
|
self.assertEqual(cur.fetchone()[0], "任务日志")
|
||||||
|
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
SELECT column_name, display_name
|
||||||
|
FROM _jiangchang_columns
|
||||||
|
WHERE table_name = 'task_logs'
|
||||||
|
ORDER BY column_name
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
by_name = dict(cur.fetchall())
|
||||||
|
self.assertEqual(by_name["status"], "状态")
|
||||||
|
self.assertEqual(by_name["error_msg"], "错误信息")
|
||||||
|
self.assertEqual(by_name["created_at"], "创建时间")
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_task_logs_physical_order_matches_pragma_cid(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import init_db
|
||||||
|
from db.display_metadata import TASK_LOGS_COLUMN_METADATA, list_physical_column_names
|
||||||
|
from db.connection import get_conn
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
physical = list_physical_column_names(cur, "task_logs")
|
||||||
|
expected = [str(item["column_name"]) for item in TASK_LOGS_COLUMN_METADATA]
|
||||||
|
self.assertEqual(
|
||||||
|
physical,
|
||||||
|
expected,
|
||||||
|
)
|
||||||
|
cur.execute("PRAGMA table_info('task_logs')")
|
||||||
|
cid_order = [row[1] for row in sorted(cur.fetchall(), key=lambda row: int(row[0]))]
|
||||||
|
self.assertEqual(cid_order, expected)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_init_db_sets_task_logs_display_order_null(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
SELECT column_name, display_order
|
||||||
|
FROM _jiangchang_columns
|
||||||
|
WHERE table_name = 'task_logs'
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
for column_name, display_order in cur.fetchall():
|
||||||
|
self.assertIsNone(
|
||||||
|
display_order,
|
||||||
|
msg=f"{column_name} display_order should be NULL",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_reinit_clears_stale_display_order(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
UPDATE _jiangchang_columns
|
||||||
|
SET display_order = 99
|
||||||
|
WHERE table_name = 'task_logs' AND column_name = 'id'
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
SELECT display_order FROM _jiangchang_columns
|
||||||
|
WHERE table_name = 'task_logs' AND column_name = 'id'
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
self.assertIsNone(cur.fetchone()[0])
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_legacy_display_order_does_not_change_pragma_physical_order(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata import list_physical_column_names
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
UPDATE _jiangchang_columns
|
||||||
|
SET display_order = 1
|
||||||
|
WHERE table_name = 'task_logs' AND column_name = 'updated_at'
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
UPDATE _jiangchang_columns
|
||||||
|
SET display_order = 99
|
||||||
|
WHERE table_name = 'task_logs' AND column_name = 'id'
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
physical = list_physical_column_names(cur, "task_logs")
|
||||||
|
self.assertEqual(physical[0], "id")
|
||||||
|
self.assertEqual(physical[-1], "updated_at")
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_metadata_tables_are_not_user_tables(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata import iter_user_tables
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
tables = list(iter_user_tables(conn.cursor()))
|
||||||
|
self.assertEqual(tables, ["task_logs"])
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_template_database_validation_passes(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata_validator import validate_template_database
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
report = validate_template_database(conn)
|
||||||
|
self.assertTrue(report.ok, msg="; ".join(report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validate_missing_both_metadata_tables(self) -> None:
|
||||||
|
conn = sqlite3.connect(":memory:")
|
||||||
|
try:
|
||||||
|
conn.execute("CREATE TABLE demo_items (id INTEGER PRIMARY KEY, title TEXT)")
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertIn("缺少数据管理元数据表 _jiangchang_tables", report.errors)
|
||||||
|
self.assertIn("缺少数据管理元数据表 _jiangchang_columns", report.errors)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validate_missing_jiangchang_tables_only(self) -> None:
|
||||||
|
from db.display_metadata import _JIANGCHANG_COLUMNS_DDL
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
conn = sqlite3.connect(":memory:")
|
||||||
|
try:
|
||||||
|
conn.execute(_JIANGCHANG_COLUMNS_DDL)
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertIn("缺少数据管理元数据表 _jiangchang_tables", report.errors)
|
||||||
|
self.assertNotIn("缺少数据管理元数据表 _jiangchang_columns", report.errors)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validate_missing_jiangchang_columns_only(self) -> None:
|
||||||
|
from db.display_metadata import _JIANGCHANG_TABLES_DDL
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
conn = sqlite3.connect(":memory:")
|
||||||
|
try:
|
||||||
|
conn.execute(_JIANGCHANG_TABLES_DDL)
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertIn("缺少数据管理元数据表 _jiangchang_columns", report.errors)
|
||||||
|
self.assertNotIn("缺少数据管理元数据表 _jiangchang_tables", report.errors)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_missing_table_metadata_is_reported(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
conn.execute("CREATE TABLE demo_items (id INTEGER PRIMARY KEY, title TEXT)")
|
||||||
|
conn.execute("DELETE FROM _jiangchang_tables WHERE table_name = 'demo_items'")
|
||||||
|
conn.commit()
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("demo_items" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_missing_column_metadata_is_reported(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
conn.execute(
|
||||||
|
"DELETE FROM _jiangchang_columns WHERE table_name = 'task_logs' AND column_name = 'status'"
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("task_logs.status" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_metadata_reference_to_missing_column_is_reported(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_columns
|
||||||
|
(table_name, column_name, display_name, visible, searchable, editable)
|
||||||
|
VALUES ('task_logs', 'not_exists', '不存在', 1, 1, 1)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("not_exists" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_ordering_test_table_not_alphabetized(self) -> None:
|
||||||
|
conn = sqlite3.connect(":memory:")
|
||||||
|
try:
|
||||||
|
conn.executescript(
|
||||||
|
"""
|
||||||
|
CREATE TABLE ordering_test (
|
||||||
|
z_field TEXT,
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
a_field TEXT,
|
||||||
|
created_at INTEGER,
|
||||||
|
updated_at INTEGER
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
from db.display_metadata import list_physical_column_names
|
||||||
|
|
||||||
|
physical = list_physical_column_names(conn.cursor(), "ordering_test")
|
||||||
|
self.assertEqual(physical, ["z_field", "id", "a_field", "created_at", "updated_at"])
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_skill_frontmatter_validation_for_template(self) -> None:
|
||||||
|
from db.display_metadata_validator import validate_skill_frontmatter
|
||||||
|
|
||||||
|
report = validate_skill_frontmatter(get_skill_root(), allow_template_placeholders=True)
|
||||||
|
self.assertTrue(report.ok, msg="; ".join(report.errors))
|
||||||
|
|
||||||
|
def test_skill_frontmatter_rejects_english_placeholder_name(self) -> None:
|
||||||
|
import os
|
||||||
|
import tempfile
|
||||||
|
|
||||||
|
from db.display_metadata_validator import validate_skill_frontmatter
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
skill_md = """---
|
||||||
|
name: My Skill
|
||||||
|
description: demo
|
||||||
|
metadata:
|
||||||
|
openclaw:
|
||||||
|
slug: query-demo-info
|
||||||
|
---
|
||||||
|
"""
|
||||||
|
with open(os.path.join(tmp, "SKILL.md"), "w", encoding="utf-8") as f:
|
||||||
|
f.write(skill_md)
|
||||||
|
report = validate_skill_frontmatter(tmp, allow_template_placeholders=False)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("name" in err for err in report.errors))
|
||||||
|
|
||||||
|
def test_column_order_warning_for_created_at_in_middle(self) -> None:
|
||||||
|
from db.display_metadata_validator import column_order_warnings
|
||||||
|
|
||||||
|
warnings = column_order_warnings(
|
||||||
|
"bad_order",
|
||||||
|
["created_at", "id", "title", "updated_at"],
|
||||||
|
)
|
||||||
|
self.assertTrue(any("id" in item for item in warnings))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -141,6 +141,15 @@ class TestDocsStandards(unittest.TestCase):
|
|||||||
msg="SKILL.md must state README.md is user-facing documentation",
|
msg="SKILL.md must state README.md is user-facing documentation",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_naming_md_exists_and_covers_standards(self) -> None:
|
||||||
|
text = self._read("development/NAMING.md")
|
||||||
|
self.assertIn("verb-noun-platform", text)
|
||||||
|
self.assertIn("48", text)
|
||||||
|
self.assertTrue("LEGACY" in text or "历史" in text)
|
||||||
|
self.assertTrue("verbs.txt" in text or "动词白名单" in text)
|
||||||
|
self.assertTrue("platforms.txt" in text or "平台白名单" in text)
|
||||||
|
self.assertTrue("仅适用于新创建" in text or "新技能" in text)
|
||||||
|
|
||||||
def test_release_workflow_uses_main_channel(self) -> None:
|
def test_release_workflow_uses_main_channel(self) -> None:
|
||||||
text = self._read(".github/workflows/release_skill.yaml")
|
text = self._read(".github/workflows/release_skill.yaml")
|
||||||
uses_line = _extract_workflow_uses_line(text)
|
uses_line = _extract_workflow_uses_line(text)
|
||||||
@@ -163,7 +172,7 @@ class TestDocsStandards(unittest.TestCase):
|
|||||||
self.assertIn("--no-sandbox", text)
|
self.assertIn("--no-sandbox", text)
|
||||||
self.assertIn("--disable-blink-features=AutomationControlled", text)
|
self.assertIn("--disable-blink-features=AutomationControlled", text)
|
||||||
self.assertIn("RpaVideoSession", text)
|
self.assertIn("RpaVideoSession", text)
|
||||||
self.assertIn("1.0.14", text)
|
self.assertIn("1.0.17", text)
|
||||||
|
|
||||||
def test_adapter_md_covers_four_tiers_and_config_get(self) -> None:
|
def test_adapter_md_covers_four_tiers_and_config_get(self) -> None:
|
||||||
text = self._read("development/ADAPTER.md")
|
text = self._read("development/ADAPTER.md")
|
||||||
|
|||||||
@@ -99,7 +99,7 @@ class TestHealthRuntimeDiagnostics(unittest.TestCase):
|
|||||||
|
|
||||||
with IsolatedDataRoot(user_id="_health_music_warn"):
|
with IsolatedDataRoot(user_id="_health_music_warn"):
|
||||||
os.environ["OPENCLAW_RECORD_VIDEO"] = "1"
|
os.environ["OPENCLAW_RECORD_VIDEO"] = "1"
|
||||||
media_root = Path(os.environ["CLAW_DATA_ROOT"]) / "shared" / "media-assets"
|
media_root = Path(os.environ["JIANGCHANG_DATA_ROOT"]) / "shared" / "media-assets"
|
||||||
ffmpeg_path = media_root / "tools" / "ffmpeg.exe"
|
ffmpeg_path = media_root / "tools" / "ffmpeg.exe"
|
||||||
ffmpeg_path.parent.mkdir(parents=True, exist_ok=True)
|
ffmpeg_path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
ffmpeg_path.write_bytes(b"x" * 256)
|
ffmpeg_path.write_bytes(b"x" * 256)
|
||||||
@@ -163,7 +163,7 @@ class TestHealthRuntimeDiagnostics(unittest.TestCase):
|
|||||||
class TestHealthRuntimeWithFakeMedia(unittest.TestCase):
|
class TestHealthRuntimeWithFakeMedia(unittest.TestCase):
|
||||||
def test_probe_counts_mp3_without_download(self) -> None:
|
def test_probe_counts_mp3_without_download(self) -> None:
|
||||||
with IsolatedDataRoot(user_id="_health_media"):
|
with IsolatedDataRoot(user_id="_health_media"):
|
||||||
media_root = Path(os.environ["CLAW_DATA_ROOT"]) / "shared" / "media-assets"
|
media_root = Path(os.environ["JIANGCHANG_DATA_ROOT"]) / "shared" / "media-assets"
|
||||||
music_dir = media_root / "music"
|
music_dir = media_root / "music"
|
||||||
music_dir.mkdir(parents=True)
|
music_dir.mkdir(parents=True)
|
||||||
(music_dir / "demo.mp3").write_bytes(b"\x00" * 1024)
|
(music_dir / "demo.mp3").write_bytes(b"\x00" * 1024)
|
||||||
|
|||||||
@@ -87,12 +87,12 @@ class TestPlatformImportSource(unittest.TestCase):
|
|||||||
from jiangchang_skill_core import version_ge
|
from jiangchang_skill_core import version_ge
|
||||||
from util.constants import PLATFORM_KIT_MIN_VERSION
|
from util.constants import PLATFORM_KIT_MIN_VERSION
|
||||||
|
|
||||||
self.assertEqual(PLATFORM_KIT_MIN_VERSION, "1.0.14")
|
self.assertEqual(PLATFORM_KIT_MIN_VERSION, "1.0.17")
|
||||||
|
|
||||||
md_path = os.path.join(get_skill_root(), "SKILL.md")
|
md_path = os.path.join(get_skill_root(), "SKILL.md")
|
||||||
with open(md_path, encoding="utf-8") as f:
|
with open(md_path, encoding="utf-8") as f:
|
||||||
md = f.read()
|
md = f.read()
|
||||||
self.assertEqual(_parse_platform_kit_min_version(md), "1.0.14")
|
self.assertEqual(_parse_platform_kit_min_version(md), "1.0.17")
|
||||||
|
|
||||||
req_path = os.path.join(get_skill_root(), "requirements.txt")
|
req_path = os.path.join(get_skill_root(), "requirements.txt")
|
||||||
with open(req_path, encoding="utf-8") as f:
|
with open(req_path, encoding="utf-8") as f:
|
||||||
|
|||||||
@@ -7,7 +7,11 @@ import unittest
|
|||||||
|
|
||||||
from _support import IsolatedDataRoot, get_skill_root
|
from _support import IsolatedDataRoot, get_skill_root
|
||||||
|
|
||||||
_FAKE_CLAW_ROOT = r"D:\jiangchang-data"
|
_FAKE_REAL_ROOT = r"D:\jiangchang-data"
|
||||||
|
|
||||||
|
|
||||||
|
def _legacy_env_key(suffix: str) -> str:
|
||||||
|
return "CL" + "AW_" + suffix
|
||||||
|
|
||||||
|
|
||||||
class TestRuntimePaths(unittest.TestCase):
|
class TestRuntimePaths(unittest.TestCase):
|
||||||
@@ -35,12 +39,14 @@ class TestRuntimePaths(unittest.TestCase):
|
|||||||
|
|
||||||
self.assertEqual(get_skill_root(), skill_root)
|
self.assertEqual(get_skill_root(), skill_root)
|
||||||
|
|
||||||
def test_isolation_overrides_prefixed_claw_data_root(self) -> None:
|
def test_isolation_overrides_prefixed_real_data_root(self) -> None:
|
||||||
"""先设假的 CLAW_DATA_ROOT,再进入隔离;get_db_path 必须落在 tempdir(防漏设 CLAW_*)。"""
|
"""先设假数据根,再进入隔离;get_db_path 必须落在 tempdir。"""
|
||||||
saved = {k: os.environ.get(k) for k in ("CLAW_DATA_ROOT", "JIANGCHANG_DATA_ROOT", "CLAW_USER_ID", "JIANGCHANG_USER_ID")}
|
saved = {
|
||||||
|
k: os.environ.get(k)
|
||||||
|
for k in ("JIANGCHANG_DATA_ROOT", "JIANGCHANG_USER_ID")
|
||||||
|
}
|
||||||
try:
|
try:
|
||||||
os.environ["CLAW_DATA_ROOT"] = _FAKE_CLAW_ROOT
|
os.environ["JIANGCHANG_DATA_ROOT"] = _FAKE_REAL_ROOT
|
||||||
os.environ["JIANGCHANG_DATA_ROOT"] = _FAKE_CLAW_ROOT
|
|
||||||
with IsolatedDataRoot() as tmp:
|
with IsolatedDataRoot() as tmp:
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
@@ -51,8 +57,11 @@ class TestRuntimePaths(unittest.TestCase):
|
|||||||
norm_db = os.path.normcase(os.path.normpath(db_path))
|
norm_db = os.path.normcase(os.path.normpath(db_path))
|
||||||
norm_tmp = os.path.normcase(os.path.normpath(tmp))
|
norm_tmp = os.path.normcase(os.path.normpath(tmp))
|
||||||
self.assertTrue(norm_db.startswith(norm_tmp), msg=f"db_path={db_path!r} tmp={tmp!r}")
|
self.assertTrue(norm_db.startswith(norm_tmp), msg=f"db_path={db_path!r} tmp={tmp!r}")
|
||||||
norm_fake = os.path.normcase(os.path.normpath(_FAKE_CLAW_ROOT))
|
norm_fake = os.path.normcase(os.path.normpath(_FAKE_REAL_ROOT))
|
||||||
self.assertFalse(norm_db.startswith(norm_fake), msg=f"db_path must not be under fake CLAW root: {db_path!r}")
|
self.assertFalse(
|
||||||
|
norm_db.startswith(norm_fake),
|
||||||
|
msg=f"db_path must not be under fake root: {db_path!r}",
|
||||||
|
)
|
||||||
finally:
|
finally:
|
||||||
for k, v in saved.items():
|
for k, v in saved.items():
|
||||||
if v is None:
|
if v is None:
|
||||||
@@ -60,6 +69,19 @@ class TestRuntimePaths(unittest.TestCase):
|
|||||||
else:
|
else:
|
||||||
os.environ[k] = v
|
os.environ[k] = v
|
||||||
|
|
||||||
|
def test_legacy_env_vars_do_not_override_canonical(self) -> None:
|
||||||
|
with IsolatedDataRoot() as tmp:
|
||||||
|
os.environ[_legacy_env_key("DATA_ROOT")] = _FAKE_REAL_ROOT
|
||||||
|
os.environ[_legacy_env_key("USER_ID")] = "legacy-user"
|
||||||
|
import importlib
|
||||||
|
|
||||||
|
import util.runtime_paths as rp
|
||||||
|
|
||||||
|
importlib.reload(rp)
|
||||||
|
data_dir = rp.get_skill_data_dir()
|
||||||
|
self.assertTrue(os.path.normpath(data_dir).startswith(os.path.normpath(tmp)))
|
||||||
|
self.assertIn("_test", data_dir.replace("\\", "/"))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
87
tests/test_slug_naming.py
Normal file
87
tests/test_slug_naming.py
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""slug 语义校验(verb-noun-platform)。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from util.slug_naming import (
|
||||||
|
LEGACY_EXEMPT_SLUGS,
|
||||||
|
classify_slug_form,
|
||||||
|
parse_slug_segments,
|
||||||
|
validate_slug_semantics,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestSlugNaming(unittest.TestCase):
|
||||||
|
def test_parse_slug_segments(self) -> None:
|
||||||
|
self.assertEqual(parse_slug_segments("download-settlement-report-amazon"), [
|
||||||
|
"download",
|
||||||
|
"settlement",
|
||||||
|
"report",
|
||||||
|
"amazon",
|
||||||
|
])
|
||||||
|
|
||||||
|
def test_classify_standard(self) -> None:
|
||||||
|
segments = parse_slug_segments("download-settlement-report-amazon")
|
||||||
|
self.assertEqual(classify_slug_form(segments, slug="download-settlement-report-amazon"), "standard")
|
||||||
|
|
||||||
|
def test_classify_scope(self) -> None:
|
||||||
|
segments = parse_slug_segments("generate-article-all")
|
||||||
|
self.assertEqual(classify_slug_form(segments, slug="generate-article-all"), "scope")
|
||||||
|
|
||||||
|
def test_classify_legacy_exempt(self) -> None:
|
||||||
|
segments = parse_slug_segments("your-skill-slug")
|
||||||
|
self.assertEqual(classify_slug_form(segments, slug="your-skill-slug"), "legacy_exempt")
|
||||||
|
|
||||||
|
def test_valid_hyphenated_platform_slug(self) -> None:
|
||||||
|
slug = "fill-export-declaration-single-window"
|
||||||
|
segments = parse_slug_segments(slug)
|
||||||
|
self.assertEqual(classify_slug_form(segments, slug=slug), "standard")
|
||||||
|
errors, warnings = validate_slug_semantics(slug)
|
||||||
|
self.assertEqual(errors, [], msg=f"errors={errors!r} warnings={warnings!r}")
|
||||||
|
|
||||||
|
def test_valid_standard_slugs(self) -> None:
|
||||||
|
for slug in (
|
||||||
|
"download-settlement-report-amazon",
|
||||||
|
"add-product-shopee",
|
||||||
|
"generate-article-all",
|
||||||
|
"your-skill-slug",
|
||||||
|
"account-manager",
|
||||||
|
):
|
||||||
|
with self.subTest(slug=slug):
|
||||||
|
errors, warnings = validate_slug_semantics(slug)
|
||||||
|
self.assertEqual(errors, [], msg=f"errors={errors!r} warnings={warnings!r}")
|
||||||
|
|
||||||
|
def test_invalid_slugs(self) -> None:
|
||||||
|
cases = (
|
||||||
|
"amazon-download-settlement-report",
|
||||||
|
"enter-cross-border-sales-receipt-voucher-kingdee",
|
||||||
|
"reconcile-finance",
|
||||||
|
"download-settlement-report-unknownplat",
|
||||||
|
"foobar-settlement-report-amazon",
|
||||||
|
)
|
||||||
|
for slug in cases:
|
||||||
|
with self.subTest(slug=slug):
|
||||||
|
errors, _warnings = validate_slug_semantics(slug)
|
||||||
|
self.assertTrue(errors, msg=f"expected errors for {slug!r}")
|
||||||
|
|
||||||
|
def test_length_boundary_48_passes(self) -> None:
|
||||||
|
slug = "query-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-amazon"
|
||||||
|
self.assertEqual(len(slug), 48)
|
||||||
|
errors, _warnings = validate_slug_semantics(slug)
|
||||||
|
self.assertEqual(errors, [])
|
||||||
|
|
||||||
|
def test_length_boundary_49_fails(self) -> None:
|
||||||
|
slug = "query-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-amazon"
|
||||||
|
self.assertEqual(len(slug), 49)
|
||||||
|
errors, _warnings = validate_slug_semantics(slug)
|
||||||
|
self.assertTrue(errors)
|
||||||
|
self.assertTrue(any("48" in err for err in errors))
|
||||||
|
|
||||||
|
def test_legacy_exempt_set(self) -> None:
|
||||||
|
self.assertIn("your-skill-slug", LEGACY_EXEMPT_SLUGS)
|
||||||
|
self.assertIn("account-manager", LEGACY_EXEMPT_SLUGS)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -34,7 +34,7 @@ FORBIDDEN_PHRASES = (
|
|||||||
|
|
||||||
POSITIVE_MARKERS = (
|
POSITIVE_MARKERS = (
|
||||||
"jiangchang-platform-kit",
|
"jiangchang-platform-kit",
|
||||||
"1.0.14",
|
"1.0.17",
|
||||||
"共享 runtime",
|
"共享 runtime",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
336
tests/test_timestamp_columns.py
Normal file
336
tests/test_timestamp_columns.py
Normal file
@@ -0,0 +1,336 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""标准时间字段:Unix 秒级时间戳、默认值、trigger 与元数据。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
import time
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from _support import IsolatedDataRoot
|
||||||
|
|
||||||
|
|
||||||
|
class TestTimestampColumns(unittest.TestCase):
|
||||||
|
def test_init_db_creates_integer_timestamp_columns_with_defaults(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata import list_physical_column_names
|
||||||
|
from db.display_metadata_validator import _table_column_info
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
physical = list_physical_column_names(cur, "task_logs")
|
||||||
|
self.assertEqual(physical[-2:], ["created_at", "updated_at"])
|
||||||
|
|
||||||
|
info = _table_column_info(cur, "task_logs")
|
||||||
|
for column_name in ("created_at", "updated_at"):
|
||||||
|
column = info[column_name]
|
||||||
|
self.assertIn("INT", str(column["type"]).upper())
|
||||||
|
self.assertTrue(str(column["dflt_value"]).lower().find("unixepoch") >= 0)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_insert_without_timestamps_auto_generates_unix_seconds(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
before = int(time.time())
|
||||||
|
cur.execute(
|
||||||
|
"INSERT INTO task_logs (task_type, status) VALUES ('auto-ts', 'success')"
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
cur.execute(
|
||||||
|
"SELECT created_at, updated_at FROM task_logs ORDER BY id DESC LIMIT 1"
|
||||||
|
)
|
||||||
|
created_at, updated_at = cur.fetchone()
|
||||||
|
after = int(time.time())
|
||||||
|
self.assertIsInstance(created_at, int)
|
||||||
|
self.assertIsInstance(updated_at, int)
|
||||||
|
self.assertGreaterEqual(created_at, before)
|
||||||
|
self.assertLessEqual(created_at, after)
|
||||||
|
self.assertEqual(created_at, updated_at)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_update_business_field_keeps_created_at_and_refreshes_updated_at(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO task_logs (task_type, status, created_at, updated_at)
|
||||||
|
VALUES ('update-ts', 'success', 1000, 1000)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
log_id = int(cur.lastrowid)
|
||||||
|
conn.commit()
|
||||||
|
|
||||||
|
cur.execute("UPDATE task_logs SET status = 'failed' WHERE id = ?", (log_id,))
|
||||||
|
conn.commit()
|
||||||
|
|
||||||
|
cur.execute(
|
||||||
|
"SELECT created_at, updated_at FROM task_logs WHERE id = ?",
|
||||||
|
(log_id,),
|
||||||
|
)
|
||||||
|
created_at, updated_at = cur.fetchone()
|
||||||
|
self.assertEqual(created_at, 1000)
|
||||||
|
self.assertGreater(updated_at, 1000)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_reinit_does_not_rewrite_existing_timestamps(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO task_logs (task_type, status, created_at, updated_at)
|
||||||
|
VALUES ('stable-ts', 'success', 1234567890, 1234567891)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"SELECT created_at, updated_at FROM task_logs WHERE task_type = 'stable-ts'"
|
||||||
|
)
|
||||||
|
self.assertEqual(cur.fetchone(), (1234567890, 1234567891))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_timestamp_metadata_contract(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata import DATETIME_UNIX_SECONDS
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
SELECT column_name, display_name, display_type, editable, display_order
|
||||||
|
FROM _jiangchang_columns
|
||||||
|
WHERE table_name = 'task_logs'
|
||||||
|
AND column_name IN ('created_at', 'updated_at')
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
by_name = {
|
||||||
|
name: (display_name, display_type, editable, display_order)
|
||||||
|
for name, display_name, display_type, editable, display_order in cur.fetchall()
|
||||||
|
}
|
||||||
|
self.assertEqual(by_name["created_at"][0], "创建时间")
|
||||||
|
self.assertEqual(by_name["updated_at"][0], "更新时间")
|
||||||
|
self.assertEqual(by_name["created_at"][1], DATETIME_UNIX_SECONDS)
|
||||||
|
self.assertEqual(by_name["updated_at"][1], DATETIME_UNIX_SECONDS)
|
||||||
|
self.assertEqual(int(by_name["created_at"][2]), 0)
|
||||||
|
self.assertEqual(int(by_name["updated_at"][2]), 0)
|
||||||
|
self.assertIsNone(by_name["created_at"][3])
|
||||||
|
self.assertIsNone(by_name["updated_at"][3])
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_metadata_upsert_keeps_timestamp_display_type(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata import DATETIME_UNIX_SECONDS
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"""
|
||||||
|
SELECT display_type FROM _jiangchang_columns
|
||||||
|
WHERE table_name = 'task_logs' AND column_name = 'created_at'
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
self.assertEqual(cur.fetchone()[0], DATETIME_UNIX_SECONDS)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_repository_insert_uses_database_timestamps(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db import task_logs_repository as tlr
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
before = int(time.time())
|
||||||
|
new_id = tlr.save_task_log(task_type="repo-ts", status="success")
|
||||||
|
after = int(time.time())
|
||||||
|
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"SELECT created_at, updated_at FROM task_logs WHERE id = ?",
|
||||||
|
(new_id,),
|
||||||
|
)
|
||||||
|
created_at, updated_at = cur.fetchone()
|
||||||
|
self.assertGreaterEqual(int(created_at), before)
|
||||||
|
self.assertLessEqual(int(created_at), after)
|
||||||
|
self.assertEqual(created_at, updated_at)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validator_rejects_missing_display_type(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata_validator import validate_template_database
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
conn.execute(
|
||||||
|
"UPDATE _jiangchang_columns SET display_type = NULL WHERE table_name = 'task_logs' AND column_name = 'created_at'"
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
report = validate_template_database(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("display_type" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validator_rejects_wrong_timestamp_type(self) -> None:
|
||||||
|
conn = sqlite3.connect(":memory:")
|
||||||
|
try:
|
||||||
|
from db.display_metadata import init_display_metadata
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
conn.executescript(
|
||||||
|
"""
|
||||||
|
CREATE TABLE demo_items (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
title TEXT,
|
||||||
|
created_at TEXT
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
init_display_metadata(conn.cursor())
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_tables (table_name, display_name, visible, readonly)
|
||||||
|
VALUES ('demo_items', '演示', 1, 0)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
for column_name, display_name in (
|
||||||
|
("id", "编号"),
|
||||||
|
("title", "标题"),
|
||||||
|
("created_at", "创建时间"),
|
||||||
|
):
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_columns
|
||||||
|
(table_name, column_name, display_name, visible, searchable, editable, display_type)
|
||||||
|
VALUES ('demo_items', ?, ?, 1, 0, 0, 'datetime_unix_seconds')
|
||||||
|
""",
|
||||||
|
(column_name, display_name),
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("created_at 字段类型应为 INTEGER" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validator_rejects_editable_timestamp(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.display_metadata_validator import validate_template_database
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
conn.execute(
|
||||||
|
"UPDATE _jiangchang_columns SET editable = 1 WHERE table_name = 'task_logs' AND column_name = 'updated_at'"
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
report = validate_template_database(conn)
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertTrue(any("editable 应为 0" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_validator_does_not_flag_amount_as_timestamp(self) -> None:
|
||||||
|
conn = sqlite3.connect(":memory:")
|
||||||
|
try:
|
||||||
|
from db.display_metadata import init_display_metadata
|
||||||
|
from db.display_metadata_validator import validate_display_metadata
|
||||||
|
|
||||||
|
conn.executescript(
|
||||||
|
"""
|
||||||
|
CREATE TABLE demo_items (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
amount INTEGER,
|
||||||
|
count INTEGER
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
init_display_metadata(conn.cursor())
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_tables (table_name, display_name, visible, readonly)
|
||||||
|
VALUES ('demo_items', '演示', 1, 0)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
for column_name, display_name in (
|
||||||
|
("id", "编号"),
|
||||||
|
("amount", "数量"),
|
||||||
|
("count", "计数"),
|
||||||
|
):
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO _jiangchang_columns
|
||||||
|
(table_name, column_name, display_name, visible, searchable, editable)
|
||||||
|
VALUES ('demo_items', ?, ?, 1, 1, 1)
|
||||||
|
""",
|
||||||
|
(column_name, display_name),
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
report = validate_display_metadata(conn)
|
||||||
|
self.assertFalse(any("amount" in err and "display_type" in err for err in report.errors))
|
||||||
|
self.assertFalse(any("count" in err and "display_type" in err for err in report.errors))
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def test_trigger_creation_is_idempotent(self) -> None:
|
||||||
|
with IsolatedDataRoot():
|
||||||
|
from db.connection import get_conn, init_db
|
||||||
|
from db.timestamp_columns import TASK_LOGS_UPDATED_AT_TRIGGER, has_updated_at_trigger
|
||||||
|
|
||||||
|
init_db()
|
||||||
|
init_db()
|
||||||
|
conn = get_conn()
|
||||||
|
try:
|
||||||
|
self.assertTrue(has_updated_at_trigger(conn.cursor(), "task_logs"))
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
"SELECT COUNT(*) FROM sqlite_master WHERE type = 'trigger' AND name = ?",
|
||||||
|
(TASK_LOGS_UPDATED_AT_TRIGGER,),
|
||||||
|
)
|
||||||
|
self.assertEqual(int(cur.fetchone()[0]), 1)
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
Reference in New Issue
Block a user