Shell与CLI冒烟测试
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/add-shell-and-cli-smoke-tests-before-refactors-ship
技能介绍
要解决的问题
Shell 脚本和 CLI 工作流往往只被手工验证:改完参数、换掉管道、调整退出码之后,很难判断成功路径是否仍然可用,失败路径是否会误报,输出格式是否还满足调用方预期。重构、发布或事件修复时,这类验证通常靠人肉回放,重复成本高,也容易漏掉边界情况。
核心能力与关键步骤
该技能把验证从一次性手动执行转成可重复执行的 Bats-core 冒烟测试,用 Bash 集中描述脚本或命令行工具的预期行为:
- 成功路径:覆盖正常输入、主流程退出码和关键输出。
- 失败路径:覆盖错误输入、依赖缺失、非零退出码与错误提示。
- 输出契约:校验 stdout/stderr、字段格式、稳定文本或退出状态。
- 回归门禁:在重构、发布或事件修复前,于本地或
CI中重复运行。
核心流程是:先选定待测的 shell 脚本或 CLI 命令,再围绕真实调用方式编写集中式测试,把成功、失败和输出契约拆成可断言用例;随后在变更前运行测试,让编辑后的回归能被机器直接发现。
适用边界与注意点
适合已经具备 Bash 和 Bats-core 的仓库,也适合需要把脆弱命令行工作流固化为回归门禁的代理任务。它关注的是冒烟级验证,不替代完整单元测试、集成测试或安全审计;若上游项目缺少清晰安装或使用说明,应在敏感工作流中使用前先查看上游项目。测试应贴近真实执行环境,避免把临时调试逻辑写进断言。
使用场景
- 重构遗留 shell 脚本前,把成功、失败与输出契约固化成 Bats 测试
- 发布 CLI 工具前,在 CI 中运行冒烟测试,验证退出码和输出格式未被破坏
- 事件修复发布时,为脆弱命令行工作流补集中式回归用例,替代手工回放
- 把代理反复执行的 shell 工作流转成编辑后自动验证的测试脚本
适合人员
- 维护遗留部署脚本的后端工程师:重构时需要自动化验证脚本行为
- 编写内部 CLI 工具的开发工程师:发布前想固定成功、失败与输出契约
- 把命令行工作流交给代理执行的团队:需要可重复验证而非手工回放
- 在 CI 中守护 shell 脚本的 DevOps 工程师:希望重构提交有冒烟门禁