wurangyu/sap-cli-skill
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat: sap-cli skill v2.1.0 — self-contained distributable package

Browse Source 
- assets/: sap-cli source (v2.1.0, 26 commands, 16 object types)
- references/: tool constraints + error handling (self-contained)
- scripts/setup.py: one-click install/config/verify
- SKILL.md: full command reference + dual-platform install guide
- VERSION: 2.1.0

Built from D:/Codespace/sap-cli via scripts/pack_skill.py
This commit is contained in:
wurangyu
2026-06-13 20:52:24 +08:00
commit 1e39b6da88
49 changed files with 7172 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
references/error-handling.md
+121
View File
@@ -0,0 +1,121 @@
# 错误处理流程
sap-cli 命令失败时的标准处理流程。严格按顺序执行。
## 通用流程
```
命令失败
↓
1. 诊断根因（使用方式错误 or 代码/环境问题？）
↓
2. 使用方式错误 → 修正参数后重试
↓
3. sap-cli 限制 → 报告失败，不绕过
↓
4. SAP 系统限制 → 穷尽自动化方案
↓
5. 确认无法自动化 → 请求用户 SAP GUI 操作
```
## 步骤 1：诊断根因
检查以下项目：
| 检查项 | 方法 |
|--------|------|
| 命令参数是否正确 | 对照 `python main.py --help` 和 SKILL.md 验证参数 |
| 文件是否存在、内容是否为空 | `cat` 或 `ls` 检查 |
| 传输请求号是否正确 | `python main.py transport info --corr_nr DEVK901XXX` |
| 网络连接是否正常 | `python main.py config show` 验证配置 |
| 对象是否存在于 SAP | `python main.py info --name XXX --type class` |
## 步骤 2：使用方式错误
修正后重试。常见修正：
- 缺少 `--corr_nr` → 加上传输请求号
- 对象名大小写错误 → sap-cli 会自动处理，但路径要注意
- 文件路径错误 → 检查相对/绝对路径
- 对象类型不匹配 → 用 `python main.py --help` 确认支持的类型
## 步骤 3：sap-cli 限制
如果确认不是使用方式问题，**如实报告错误信息**，不要尝试绕过 sap-cli：
```
❌ 错误做法：写 Python requests 脚本绕过
❌ 错误做法：用 curl 直接调 ADT 端点
❌ 错误做法：导入 ADTClient 调内部方法
✅ 正确做法：报告失败，说明原因
```
## 步骤 4：穷尽自动化方案（SAP 系统限制时）
遇到 SAP 系统限制时，按以下顺序穷尽自动化方案：
### 方案 A：调整 sap-cli 参数重试
- 尝试不同的 `--corr_nr`
- 尝试 `--dry-run` 预览后执行
- 检查是否有残留锁（`show-table` 查看 SM12 相关信息）
### 方案 B：ABAP 报表 workaround
通过 `run-program` 执行辅助报表：
```bash
# 清除残留锁
python main.py sync --type report --name ZSAPILOT_CLEAR_LOCKS --path <file> --corr_nr DEVK901XXX
python main.py run-program --name ZSAPILOT_CLEAR_LOCKS
```
### 方案 C：delete + recreate
如果对象需要完全重写：
```bash
python main.py delete --name ZMY_CLASS --type class
python main.py sync --name ZMY_CLASS --type class --path <file> --corr_nr DEVK901XXX
```
注意：delete 可能因传输请求绑定而失败（HTTP 423），此时需要用户在 SE09 操作。
### 方案 D：activate 单独重试
```bash
python main.py activate --name ZMY_CLASS --type class --corr_nr DEVK901XXX
```
NW 7.40 的 double-activate 已内置在 sap-cli 中。如果 activate 仍然失败，**不要再尝试其他激活策略**，直接报告给用户。
## 步骤 5：请求用户 SAP GUI 操作
**只在确认所有自动化方案穷尽后**才请求用户操作。
### 必须一次性给出完整操作清单
当需要用户在 SAP GUI 操作时，**绝不能渐进式发现问题**：
- ❌ 错误：先让用户加字段 A，测试后发现缺字段 B，又让用户加字段 B
- ✅ 正确：先做全面对比分析（`show-table` vs 代码中的字段引用），一次性给出完整变更清单
### 系统表操作的 4 步授权流程
如果需要操作系统表（唯一的例外情况）：
1. **解释原因** — 为什么需要操作系统表
2. **列出具体操作** — 表名 + 操作类型（如 `DELETE FROM SEOCLASS WHERE ...`）
3. **说明风险和替代方案** — 可能的副作用、有没有不操作系统表的替代方案
4. **等待用户确认** — 得到明确授权后才执行
## 常见失败场景速查
| 错误 | 常见原因 | 处理方式 |
|------|----------|----------|
| HTTP 406 (Lock DDIC) | NW 7.40 不支持 DDIC 对象 ADT Lock | 报告用户，SE09 处理 |
| HTTP 403 (Locked) | 残留 enqueue lock | 先尝试 `run-program` 清锁报表，不行才 SM12 |
| HTTP 400 (SaveFailure) | 类 DEFINITION 与 SAP 不一致 | 检查本地 vs SAP 的 DEFINITION 差异 |
| HTTP 423 (Transport lock) | 对象绑定在传输请求中 | 报告用户，SE09 处理 |
| 激活失败仍 inactive | NW 7.40 ADT 限制 | sap-cli 已内置 double-activate，仍失败则报告用户去 SE09 |
| `WITH EMPTY KEY` 运行 dump | NW 7.40 不支持 | 修改为 `WITH NON-UNIQUE KEY` 或 `WITH DEFAULT KEY` |
references/sap-tool-constraints.md
+103
View File
@@ -0,0 +1,103 @@
# sap-cli 使用约束
本文件定义使用 sap-cli 操作 SAP 系统时的 **硬性约束**。违反任何一条都会被 Hooks 拦截。
## 🚫 规则 1：只使用 sap-cli 命令操作 SAP 系统
操作 SAP 系统时，**必须且只能**使用 `python main.py <命令>` 的形式。
**严禁以下行为**：
| 禁止操作 | 原因 |
|----------|------|
| 用 Python `requests` / `urllib` 直接调 ADT REST 端点 | 必须通过 sap-cli 命令 |
| 用 curl 直接调 ADT 端点（`/sap/bc/adt/*`） | 必须通过 sap-cli 命令 |
| 用 curl 调 SOAP RFC（`/sap/bc/soap/rfc`） | 必须通过 sap-cli 的 `read-table` 命令 |
| 编写 Python 脚本导入 `sapcli.client.ADTClient` 后直接调内部方法 | sap-cli 的内部 API 不是公开接口 |
| 在 Python 脚本中手动构造 ADT XML body | 必须通过 sap-cli 命令处理 |
| 用 `python -c` 内联调用 requests 访问 SAP | 同上 |
**唯一合法的 SAP 交互方式**：
```bash
cd D:/Codespace/sap-cli && python main.py <command> [options]
```
### 例外（仅在以下情况下允许）
- `run-program` 执行自定义 ABAP 报表 — 这是 sap-cli 的内置功能
- 用户**明确要求**使用其他方式（如"请用 curl 测试这个端点"）
- **开发 sap-cli 本身**（作为项目开发而非使用工具时）
## 🚫 规则 2：禁止修改 SAP 标准开发对象
SAP 系统中的标准交付对象（`CL_*`、`CX_*`、`IF_*`、`SAPL*` 等）**严禁修改**。
| 禁止 | 说明 |
|------|------|
| `download` 标准对象后修改再 `sync` 回去 | 破坏 SAP 系统一致性 |
| 对标准对象执行 `delete` | 不可逆操作 |
| `run-program` 修改标准对象源码 | 同上 |
**允许**（只读）：
- ✅ `download` / `info` / `list` / `search` / `whereused`
- ✅ `show-table` / `read-table` — 查看结构和数据
- ✅ `diff` — 对比分析
**判定标准**：对象 original system 不是用户自己的开发系统，或对象名以 SAP 标准命名空间开头。**不确定时先问用户**。
## 🚫 规则 3：禁止操作系统表数据
SAP 系统表（存储元数据、运行时状态、内部配置的表）**严禁直接操作**。
| 禁止 | 典型表 |
|------|--------|
| INSERT / UPDATE / DELETE / MODIFY 系统表 | TADIR, E071, SEOCLASS, REPOSRC, D010SINF, T000, TDEVC, TSTC |
**允许**（只读）：
- ✅ `read-table` / `show-table` 查看（SELECT）系统表数据用于诊断
- ✅ `run-program` 报表中 SELECT 读取系统表
**唯一例外**：用户**明确授权**后才能操作系统表，且必须遵循 4 步授权流程（见 error-handling.md）。
## 🚫 规则 4：sync 命令必须带 --corr_nr
```bash
# ✅ 正确
python main.py sync --name ZMY_CLASS --type class --path ./src/zmy.abap --corr_nr DEVK901362
# ❌ 错误（缺少 --corr_nr，会触发交互式传输请求选择）
python main.py sync --name ZMY_CLASS --type class --path ./src/zmy.abap
```
## 🚫 规则 5：DDIC 对象的 NW 7.40 限制
在 NW 7.40 上，DDIC 对象（domain、dataelement、table）的 ADT Lock 返回 HTTP 406。
- 这是 **SAP 系统限制**，不是 sap-cli 的 bug
- sync DDIC 失败时，不要反复重试 — 报告给用户，让用户通过 SAP GUI SE09 处理
- 新建的 DDIC 对象（不存在于 SAP）可通过 `create --definition` 创建
## 🚫 规则 6：查表数据用 read-table，查表结构用 show-table
sap-cli 已内置这些命令，不要自己写 HTTP 调用。
```bash
# 查看表结构
python main.py show-table --name ZSAPILOT_OBJ
# 查看表数据
python main.py read-table --name ZSAPILOT_OBJ --max-rows 50
```
## 自检清单
每次执行 SAP 操作前，确认：
1. ✅ 我在用 `python main.py <命令>` 吗？
2. ✅ 我没有直接调 ADT/SOAP/RFC 端点吗？
3. ✅ 我操作的是 Z* 开头的自定义对象吗？
4. ✅ 我没有 INSERT/UPDATE/DELETE 系统表吗？
5. ✅ sync 命令带了 `--corr_nr` 吗？