casebook 0.1.0__tar.gz

casebook-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

casebook-0.1.0/PKG-INFO

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: casebook
+Version: 0.1.0
+Summary: A local browser and editor for YAML test cases.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask>=3.1.3
+Requires-Dist: ruamel.yaml>=0.18.6
+Requires-Dist: typer>=0.12.0
+Requires-Dist: watchdog>=4.0.0
+Dynamic: license-file
+
+# Casebook
+
+Casebook 是一个面向 AI 时代测试用例工作的本地工具。
+
+它把需求文档、AI 测试设计规范、JSON Schema 约束、YAML 用例文件和可视化编辑界面连成一条完整工作流：
+
+```text
+docs/requirements/ 需求文档
+  -> AI 按技能包理解需求并生成用例
+  -> releases/ YAML 测试用例
+  -> casebook serve 本地浏览、标记、编辑
+```
+
+Casebook 的目标不是替代测试人员，而是把测试人员从重复录入中释放出来：人负责需求理解、风险判断和评审，AI 负责按规范批量生成结构化用例，Casebook 负责可视化查看和编辑。
+
+## 核心能力
+
+- 一条命令创建标准 Casebook 用例项目。
+- 将需求文档放入 `docs/requirements/`，让 AI 按项目技能包生成测试用例。
+- 使用 `schema/test-case-schema.json` 约束 YAML 用例格式。
+- 在本地 Web UI 中浏览、筛选、展开、标记和编辑 YAML 用例。
+- 保存编辑时直接回写原始 YAML 文件。
+- 使用 `ruamel.yaml` 尽量保留 YAML 注释、字段顺序、缩进和 inline list 风格。
+- 将标记状态保存在 `.casebook/marks.json`，不污染用例文件本身。
+- 监听 YAML 文件变化，并通知浏览器刷新。
+
+## 安装
+
+Casebook 需要 Python 3.10 或更高版本。
+
+在本仓库中安装：
+
+```bash
+pip install -e .
+```
+
+安装后可以使用：
+
+```bash
+casebook --help
+```
+
+## 快速开始
+
+创建一个新的 Casebook 项目：
+
+```bash
+casebook init my-casebook
+cd my-casebook
+```
+
+启动本地用例工作台：
+
+```bash
+casebook serve releases
+```
+
+默认地址：
+
+```text
+http://127.0.0.1:8089
+```
+
+也可以自动打开浏览器：
+
+```bash
+casebook serve releases --open
+```
+
+指定端口：
+
+```bash
+casebook serve releases --port 8090
+```
+
+## 初始化项目
+
+`casebook init <project>` 会创建一个完整的用例项目脚手架：
+
+```text
+my-casebook/
+  AGENTS.md
+  .agents/
+    skills/
+      casebook-test-cases/
+        SKILL.md
+  .vscode/
+    settings.json
+  docs/
+    requirements/
+      login.md
+  releases/
+    example/
+      login.yaml
+  schema/
+    test-case-schema.json
+```
+
+这些文件分别负责：
+
+- `docs/requirements/login.md`：示例需求文档。
+- `releases/example/login.yaml`：由示例需求反向配套的 YAML 测试用例。
+- `schema/test-case-schema.json`：测试用例结构约束。
+- `.agents/skills/casebook-test-cases/SKILL.md`：AI 生成用例时需要遵循的技能包。
+- `AGENTS.md`：项目根目录 AI 入口，提示 AI 读取技能包和 schema。
+- `.vscode/settings.json`：让 VS Code YAML 插件自动关联 schema。
+
+如果目标目录中已经存在同名文件，`init` 默认跳过，不会覆盖：
+
+```bash
+casebook init my-casebook
+```
+
+需要重置脚手架文件时，可以使用：
+
+```bash
+casebook init my-casebook --force
+```
+
+`casebook project <project>` 也可用，等价于 `casebook init <project>`。
+
+## AI 用例生成工作流
+
+推荐工作方式：
+
+1. 将产品需求、接口说明、交互规则或业务背景放入 `docs/requirements/`。
+2. 让 AI 阅读 `AGENTS.md` 和 `.agents/skills/casebook-test-cases/SKILL.md`。
+3. AI 根据需求、技能包和 `schema/test-case-schema.json` 生成 YAML 用例。
+4. 将真实项目用例写入 `releases/<版本或模块>/<功能>.yaml`。
+5. 使用 `casebook serve releases` 查看、标记和编辑用例。
+
+示例目录中的 `releases/example/` 只用于脚手架演示。真实项目用例建议放在更明确的目录中，例如：
+
+```text
+releases/v1-auth/login.yaml
+releases/v5-user-backend/package-management.yaml
+```
+
+## 用例格式
+
+Casebook 读取符合以下结构的 YAML 文件：
+
+```yaml
+metadata:
+  module: "系统认证"
+  feature: "用户登录"
+  owner: "qa"
+  last_reviewed: "2026-06-24"
+  tags: [auth, login]
+
+test_cases:
+  - id: "TC_LOGIN_001"
+    title: "有效用户名和密码登录成功"
+    description: "验证用户使用正确的登录凭证可以成功进入系统。"
+    priority: "P0"
+    type: "functional"
+    preconditions:
+      - 用户已注册并处于正常可登录状态
+    steps:
+      - 输入有效用户名和对应密码
+      - 点击登录按钮
+    expected_results:
+      - 登录成功，进入系统首页
+      - 显示当前用户姓名和欢迎信息
+    tags: [smoke, login]
+    auto: true
+```
+
+字段约束以 `schema/test-case-schema.json` 为准。默认支持的优先级：
+
+```text
+P0, P1, P2
+```
+
+默认支持的类型：
+
+```text
+functional, ui, security, performance, accessibility, business, other, data-consistency
+```
+
+## 本地工作台
+
+启动后，Casebook 提供一个本地 Web UI：
+
+- 左侧按目录展示 YAML 用例文件。
+- 中间展示当前文件的用例列表、统计、优先级和标签。
+- 用例行可以展开，直接查看前置条件、步骤和预期结果。
+- 可以用 Mark 标记需要关注或后续修改的用例。
+- 点击 Edit 打开右侧编辑抽屉，并保存回 YAML 文件。
+
+Casebook 会根据文件修改时间做编辑冲突检查。如果 YAML 文件在页面加载后被外部修改，保存时会提示冲突，避免覆盖他人的改动。
+
+## 命令参考
+
+创建项目：
+
+```bash
+casebook init my-casebook
+```
+
+覆盖脚手架文件：
+
+```bash
+casebook init my-casebook --force
+```
+
+启动默认用例目录：
+
+```bash
+casebook serve releases
+```
+
+同时扫描多个目录：
+
+```bash
+casebook serve releases/v1 releases/v2
+```
+
+指定主机和端口：
+
+```bash
+casebook serve releases --host 127.0.0.1 --port 8090
+```
+
+禁用文件监听：
+
+```bash
+casebook serve releases --no-watch
+```
+
+## 项目状态文件
+
+Casebook 的标记数据保存在项目根目录：
+
+```text
+.casebook/marks.json
+```
+
+示例：
+
+```json
+{
+  "releases/example/login.yaml#TC_LOGIN_001": {
+    "needs_update": true,
+    "updated_at": "2026-06-24T02:00:00+00:00"
+  }
+}
+```
+
+这些状态不写入 YAML 用例文件，因此不会影响用例正文和 schema 校验。
+
+## 开发
+
+本地开发安装：
+
+```bash
+pip install -e .
+```
+
+创建演示项目：
+
+```bash
+casebook init /tmp/casebook-demo
+cd /tmp/casebook-demo
+casebook serve releases
+```
+
+在源码模式下也可以直接运行：
+
+```bash
+python -m casebook.cli init /tmp/casebook-demo
+python -m casebook.cli serve releases
+```
+
+## 设计理念
+
+传统测试用例往往散落在表格、文档和测试管理平台里，格式难统一，版本难追踪，AI 也很难稳定复用。
+
+Casebook 将用例工程化：
+
+- 用 `docs/requirements/` 承载需求输入。
+- 用 `.agents/skills/` 固化测试设计方法。
+- 用 `schema/` 固化结构约束。
+- 用 `releases/` 存放可版本化的 YAML 用例。
+- 用本地 Web UI 完成审阅、标记和编辑。
+
+这让测试用例变成可以被 AI 生成、被 schema 校验、被 Git 管理、被人高效评审的工程资产。