吴让宇
c5905a5b1e
方向反转：此前 SKILL.md 是「模板渲染产物」、sap-cli 是源；现 sap-cli 归档， sap-cli-skill 承接开发与分发，SKILL.md 回归手工维护的正本。 迁移（来自 sap-cli，共 104 文件）： - tests/ 692 例测试（15 个文件的内联 sys.path 改指 assets/） - openspec/ SDD 规格与归档变更（42 文件） - docs/ 开发文档与 ADT 原理（含 dev/CLAUDE.md、AGENTS.md） - .claude/ rules 副本 + settings.json（供 Claude Code） - .github/ .hermes/ .pre-commit-config.yaml .editorconfig CLAUDE.md - scripts/ 保持仅 setup.py（pack_skill.py 已随旧仓归档，不迁） 修复（迁移暴露的真实缺陷）： - assets/pyproject.toml 的 build-backend 写作 `setuptools.backends._legacy:_Backend`， 该模块在 setuptools 中不存在 → `pip install -e` 从来装不上。改为 build_meta。 实测：临时 venv 安装成功，sap-cli --help 正常列出 31 个命令 - pyproject readme 指向不存在的 assets/README.md（editable 安装会失败）→ 改内联文本 - pyproject urls 改指 sap-cli-skill 机制调整： - .github/workflows/ci.yml 适配 assets/ 布局；顶部注明该工作流仅 GitHub 执行， 本仓在 Gitee 不会自动跑 - pre-commit 增本地测试门禁（Gitee 上真正生效的那道） - .gitignore 合并旧仓完整规则（保留 log/ 下 md 知识库入库，只忽略运行日志） - 大文件上限 100KB→1MB（架构图 512KB） 守卫测试 tests/unit/test_repo_guards.py（10 → 18 例）： - SKILL.md 须记录 parser 全部 CLI 命令 / 铁律 1-5 须为真实小节标题 / 示例不得违反铁律 5 - references/ 规则齐备；.claude/rules 与 references 必须一致（实测抓到一次真实漂移） - VERSION == sapcli.__version__ == README 版本 - 仓内不得再出现 pack_skill.py / skill-src（防废弃流程回潮） 698 tests OK；editable 安装与 CLI 入口经临时 venv 实测通过。 docs/RELEASING.md 重写为单源开发流程。
56 lines
1.9 KiB
Markdown
56 lines
1.9 KiB
Markdown
# Connection Specification
|
|
|
|
## Purpose
|
|
|
|
定义 sap-cli 与 SAP 系统建立连接、完成身份认证和会话管理的行为。
|
|
|
|
## Requirements
|
|
|
|
### Requirement: User Authentication
|
|
|
|
系统 SHALL 通过 SAP ADT REST API 使用 HTTP Basic Auth 进行身份认证。
|
|
|
|
#### Scenario: Successful login
|
|
- **WHEN** 用户提供有效的 SAP 主机地址、客户端编号、用户名和密码
|
|
- **THEN** 系统打印 "登录成功" 并建立可用会话
|
|
|
|
#### Scenario: Login failure
|
|
- **WHEN** 用户提供了无效的 SAP 凭据
|
|
- **THEN** 系统打印错误信息并以非零退出码退出
|
|
|
|
#### Scenario: Config not found
|
|
- **WHEN** 用户未提供配置文件且未设置环境变量
|
|
- **THEN** 系统打印配置缺失提示，列出需要的环境变量名称，并以非零退出码退出
|
|
|
|
### Requirement: Configuration Loading
|
|
|
|
系统 SHALL 支持 config.ini 文件和环境变量两种配置方式，环境变量优先于配置文件。
|
|
|
|
#### Scenario: Load from config file
|
|
- **WHEN** 用户运行命令且当前目录或指定路径存在有效的 config.ini
|
|
- **THEN** 系统从配置文件读取 SAP 连接参数
|
|
|
|
#### Scenario: Environment variable override
|
|
- **WHEN** 同时存在配置文件和环境变量
|
|
- **THEN** 环境变量值覆盖配置文件中的对应项
|
|
|
|
#### Scenario: Profile selection
|
|
- **WHEN** 用户通过 --profile 参数指定配置 section
|
|
- **THEN** 系统从 config.ini 的对应 section 读取配置
|
|
|
|
#### Scenario: Client number default
|
|
- **WHEN** 配置中未指定 SAP 客户端编号
|
|
- **THEN** 系统使用默认值 "100"
|
|
|
|
### Requirement: Global Options
|
|
|
|
系统 SHALL 支持全局命令行选项。
|
|
|
|
#### Scenario: Custom config path
|
|
- **WHEN** 用户通过 --config 指定配置文件路径
|
|
- **THEN** 系统从指定路径加载配置
|
|
|
|
#### Scenario: No command specified
|
|
- **WHEN** 用户运行程序但未指定任何子命令
|
|
- **THEN** 系统打印帮助信息并以退出码 1 退出
|