cli-test-framework 0.9.3__tar.gz → 1.0.1__tar.gz

{cli_test_framework-0.9.3/src/cli_test_framework.egg-info → cli_test_framework-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli-test-framework
-Version: 0.9.3
+Version: 1.0.1
 Summary: A powerful command line testing framework in Python with setup modules, parallel execution, and file comparison capabilities.
 Home-page: https://github.com/ozil111/cli-test-framework
 Author: Xiaotong Wang
@@ -23,6 +23,8 @@ Requires-Dist: numpy>=1.21.0; python_version < "3.12"
 Requires-Dist: numpy>=1.26.0; python_version >= "3.12"
 Requires-Dist: setuptools>=75.8.0
 Requires-Dist: wheel>=0.45.1
+Provides-Extra: tui
+Requires-Dist: textual>=0.40.0; extra == "tui"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -30,6 +32,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: project-url
+Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/docs/user_manual.md

@@ -6,6 +6,7 @@
 - [测试用例定义](#测试用例定义)
 - [配置拆分机制](#配置拆分机制)
 - [配置校验](#配置校验)
+- [TUI 交互式管理器](#tui-交互式管理器)
 - [运行测试](#运行测试)
 - [占位符（变量替换）](#占位符变量替换)
 - [标签过滤](#标签过滤)
@@ -304,6 +305,128 @@ cli-test validate test_cases.json --workspace /path/to/project
   [FAIL] Import target not found: /project/cases/nonexistent.json
 ```
 
+## TUI 交互式管理器
+
+当测试用例数量增长到几十甚至上百条时，纯手工编辑 JSON/YAML 配置文件容易出错且效率低下。TUI（Terminal User Interface）交互式管理器提供了一个终端内的可视化界面，支持浏览、搜索、编辑、运行测试用例，所有操作通过键盘快捷键完成，无需切换窗口或打开编辑器。
+
+### 安装
+
+TUI 依赖 `textual` 库，作为可选依赖提供，不影响核心框架的安装体积：
+
+```bash
+# 安装时附带 TUI 支持
+pip install cli-test-framework[tui]
+
+# 或者在已有框架上单独安装 textual
+pip install textual
+```
+
+如果未安装 `textual` 就直接执行 `cli-test tui`，框架会给出友好的安装提示。
+
+### 启动
+
+```bash
+# 打开 TUI 编辑测试用例
+cli-test tui test_cases.json
+
+# YAML 文件同样支持
+cli-test tui test_cases.yaml
+
+# 指定工作目录
+cli-test tui test_cases.json --workspace /path/to/project
+
+# 打开带 import 的主配置文件（自动展开子文件中的所有用例）
+cli-test tui main_config.json
+```
+
+TUI 启动时会自动通过[配置拆分机制](#配置拆分机制)展开 `import` 引用，将所有用例加载到界面中统一管理。
+
+### 界面概览
+
+TUI 启动后显示**用例列表主界面**：
+
+- **顶部状态栏**：当前文件名、用例总数
+- **搜索栏**：`/` 键聚焦搜索框，支持子串/模糊/正则三种模式
+- **用例表格**：六列（序号、名称、命令、标签、超时、模式），支持键盘导航
+- **底部快捷键栏**：显示所有可用操作
+
+### 快捷键
+
+| 快捷键 | 功能 |
+|---|---|
+| `a` | 新增用例 |
+| `e` | 编辑选中的用例 |
+| `d` | 删除选中的用例 |
+| `u` | 复制选中的用例（名称追加 `_copy` 后缀） |
+| `r` | 运行选中的用例，显示执行结果 |
+| `F6` / `Ctrl+S` | 保存修改到文件 |
+| `/` | 聚焦搜索框 |
+| `Esc` | 清除搜索，恢复完整列表 |
+| `Alt+S` | 切换子串搜索模式（大小写不敏感） |
+| `Alt+F` | 切换模糊搜索模式（容忍拼写差异和缩写） |
+| `Alt+R` | 切换正则搜索模式 |
+| `q` / `Ctrl+Q` | 退出 |
+| `↑` / `↓` / `j` / `k` | 上下移动光标 |
+
+搜索时会同时匹配 `name`、`command`、`args`、`tags`、`description` 等字段，匹配结果在表格中高亮显示。
+
+### 编辑用例
+
+选中用例后按 `e` 进入编辑界面。编辑界面根据用例类型有两种模式：
+
+#### 单命令模式
+
+编辑表单包含以下字段：
+
+| 字段 | 说明 |
+|---|---|
+| `Name` | 用例名称（必填） |
+| `Command` | 要执行的命令 |
+| `Args` | 命令参数，每行一个 |
+| `Tags` | 标签列表，每行一个 |
+| `Description` | 用例描述 |
+| `Timeout` | 超时秒数 |
+| Expected | 期望断言的嵌套子表单（见下文） |
+
+#### 步骤序列模式
+
+当用例包含多个有序步骤时，切换到此模式。每个步骤有独立的 `Command`、`Args`、`Expected` 和 `Timeout`，支持添加、删除、编辑和上下移动步骤。
+
+两种模式可通过编辑界面内的快捷键切换，切换时会提示确认以免丢失数据。
+
+### `expected` 字段编辑
+
+`expected` 字段是一个嵌套字典，编辑器提供结构化输入：
+
+| 字段 | 输入方式 |
+|---|---|
+| `return_code` | 数字输入框 |
+| `output_contains` | 多行文本输入，一行一个匹配字符串 |
+| `output_matches` | 正则表达式文本输入 |
+| `compare_files` | 每行一个 JSON 对象，如 `{"actual":"out.txt","baseline":"base.txt","type":"text"}` |
+
+除上述已知字段外，还支持通过 `+ Add` 按钮添加自定义 key=value 对，value 为字符串或 JSON 文本。更多含义见[测试用例定义](#测试用例定义)。
+
+### 运行用例
+
+在列表中选中某条用例，按 `r` 即可实时调用框架执行引擎运行该用例。运行结束后弹出结果面板，显示：
+
+- 通过/失败状态
+- 返回码
+- 耗时
+- 命令输出（stdout/stderr）
+
+结果面板仅展示、不修改配置文件。
+
+### 保存
+
+对用例的任何增删改操作都在**内存中**进行，不会立即写入磁盘。
+
+- 按 `F6` 或 `Ctrl+S` **保存**：将当前全部用例写回原配置文件。
+- 通过 `save_as` 可**另存为**新文件（通过界面菜单操作）。
+
+退出 TUI 时如有未保存的修改，会弹出确认提示。
+
 ## 运行测试
 
 ### 命令行

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/setup.py

@@ -8,7 +8,7 @@ with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name="cli-test-framework",
-    version="0.9.3",
+    version="1.0.1",
     author="Xiaotong Wang",
     author_email="xiaotongwang98@gmail.com",
     description="A powerful command line testing framework in Python with setup modules, parallel execution, and file comparison capabilities.",
@@ -25,6 +25,9 @@ setup(
         "setuptools>=75.8.0",
         "wheel>=0.45.1"
     ],
+    extras_require={
+        "tui": ["textual>=0.40.0"],
+    },
     entry_points={
         'console_scripts': [
             'cli-test=cli_test_framework.cli:main',

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/src/cli_test_framework/cli.py

@@ -44,6 +44,7 @@ Examples:
   cli-test run test_cases.json
   cli-test run test_cases.json --parallel --workers 4
   cli-test run test_cases.yaml --workspace /path/to/project
+  cli-test tui test_cases.json
   cli-test validate main_config.json
   cli-test compare file1.json file2.json
   cli-test compare file1.txt file2.txt --output-format json
@@ -80,6 +81,17 @@ Examples:
                                 'e.g. --var solver=/path/to/solver '
                                 '(can be used multiple times)')
 
+    # ---- TUI command ----
+    tui_parser = subparsers.add_parser(
+        'tui', help='Launch interactive TUI for managing test cases'
+    )
+    tui_parser.add_argument(
+        'config_file', help='Path to the test configuration file (JSON or YAML)'
+    )
+    tui_parser.add_argument(
+        '--workspace', '-w', help='Working directory'
+    )
+
     # ---- Validate command ----
     validate_parser = subparsers.add_parser(
         'validate', help='Validate test configuration without running tests'
@@ -299,6 +311,13 @@ def run_compare(args):
     return bool(exit_code == 0)
 
 
+def run_tui(args):
+    """Launch the TUI manager."""
+    from .tui.app import run_tui as _run_tui
+
+    _run_tui(args.config_file, args.workspace)
+
+
 def run_validate(args):
     """Validate test configuration without running tests."""
     from .config.config_io import validate_config
@@ -348,6 +367,8 @@ def main():
     if args.command == 'run':
         success = run_tests(args)
         sys.exit(0 if success else 1)
+    elif args.command == 'tui':
+        run_tui(args)
     elif args.command == 'validate':
         success = run_validate(args)
         sys.exit(0 if success else 1)

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/src/cli_test_framework/core/config_loader.py

@@ -80,37 +80,51 @@ def _split_and_resolve(
 
 def parse_test_cases(
     config: Dict[str, Any],
-    workspace: Path,
-    path_resolver: Any,
+    workspace: Optional[Path] = None,
+    path_resolver: Any = None,
 ) -> List[TestCase]:
     """Parse ``config['test_cases']`` into a list of ``TestCase`` objects.
 
     Supports both single-command mode and sequence (``steps``) mode.
+
+    When *workspace* and *path_resolver* are provided (Runner mode),
+    required fields are validated and command/args paths are resolved.
+    When omitted (TUI mode), missing fields get sensible defaults and
+    raw values are kept as-is for display purposes.
     """
     cases: List[TestCase] = []
+    resolve = workspace is not None and path_resolver is not None
 
-    for case in config["test_cases"]:
+    for case in config.get("test_cases", []):
         if "steps" in case:
             # ── Sequence mode ──
             steps: List[TestCaseStep] = []
-            for step in case["steps"]:
-                step_required = ["command", "args", "expected"]
-                if not all(field in step for field in step_required):
-                    raise ValueError(
-                        f"Step in test case '{case.get('name', 'unnamed')}' "
-                        f"is missing required fields"
+            for step in case.get("steps", []):
+                if resolve:
+                    step_required = ["command", "args", "expected"]
+                    if not all(field in step for field in step_required):
+                        raise ValueError(
+                            f"Step in test case '{case.get('name', 'unnamed')}' "
+                            f"is missing required fields"
+                        )
+                    executable, resolved_args = _split_and_resolve(
+                        step["command"], step["args"], workspace, path_resolver
                     )
-                executable, resolved_args = _split_and_resolve(
-                    step["command"], step["args"], workspace, path_resolver
-                )
-                steps.append(TestCaseStep(
-                    command=executable,
-                    args=resolved_args,
-                    expected=step["expected"],
-                    timeout=step.get("timeout"),
-                ))
+                    steps.append(TestCaseStep(
+                        command=executable,
+                        args=resolved_args,
+                        expected=step["expected"],
+                        timeout=step.get("timeout"),
+                    ))
+                else:
+                    steps.append(TestCaseStep(
+                        command=step.get("command", ""),
+                        args=step.get("args", []),
+                        expected=step.get("expected", {}),
+                        timeout=step.get("timeout"),
+                    ))
             cases.append(TestCase(
-                name=case["name"],
+                name=case.get("name", ""),
                 steps=steps,
                 description=case.get("description", ""),
                 resources=case.get("resources"),
@@ -118,26 +132,37 @@ def parse_test_cases(
             ))
         else:
             # ── Single-command mode (backward-compatible) ──
-            required_fields = ["name", "command", "args", "expected"]
-            if not all(field in case for field in required_fields):
-                raise ValueError(
-                    f"Test case {case.get('name', 'unnamed')} "
-                    f"is missing required fields"
+            if resolve:
+                required_fields = ["name", "command", "args", "expected"]
+                if not all(field in case for field in required_fields):
+                    raise ValueError(
+                        f"Test case {case.get('name', 'unnamed')} "
+                        f"is missing required fields"
+                    )
+                executable, resolved_args = _split_and_resolve(
+                    case["command"], case["args"], workspace, path_resolver
                 )
-
-            executable, resolved_args = _split_and_resolve(
-                case["command"], case["args"], workspace, path_resolver
-            )
-            cases.append(TestCase(
-                name=case["name"],
-                command=executable,
-                args=resolved_args,
-                expected=case["expected"],
-                description=case.get("description", ""),
-                timeout=case.get("timeout"),
-                resources=case.get("resources"),
-                tags=case.get("tags", []),
-            ))
+                cases.append(TestCase(
+                    name=case["name"],
+                    command=executable,
+                    args=resolved_args,
+                    expected=case["expected"],
+                    description=case.get("description", ""),
+                    timeout=case.get("timeout"),
+                    resources=case.get("resources"),
+                    tags=case.get("tags", []),
+                ))
+            else:
+                cases.append(TestCase(
+                    name=case.get("name", ""),
+                    command=case.get("command", ""),
+                    args=case.get("args", []),
+                    expected=case.get("expected", {}),
+                    description=case.get("description", ""),
+                    timeout=case.get("timeout"),
+                    resources=case.get("resources"),
+                    tags=case.get("tags", []),
+                ))
 
     return cases
 

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/src/cli_test_framework/core/test_case.py

@@ -44,4 +44,20 @@ class TestCase:
                 }
                 for s in self.steps
             ]
-        return result
+        return result
+
+    def to_execution_dict(self) -> Dict[str, Any]:
+        """Convert to the dict format expected by ``execute_single_test_case``.
+
+        Only for single-command mode; sequence cases should use
+        ``execute_sequence()`` instead.
+        """
+        return {
+            "name": self.name,
+            "command": self.command,
+            "args": self.args,
+            "expected": self.expected,
+            "description": self.description or None,
+            "timeout": self.timeout,
+            "resources": self.resources,
+        }

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/src/cli_test_framework/runners/config_runner.py

@@ -67,15 +67,7 @@ class ConfigRunner(BaseRunner):
         if case.steps:
             return self._run_sequence(case)
 
-        case_data: TestCaseData = {
-            "name": case.name,
-            "command": case.command,
-            "args": case.args,
-            "expected": case.expected,
-            "description": case.description or None,
-            "timeout": case.timeout,
-            "resources": case.resources,
-        }
+        case_data = case.to_execution_dict()
 
         command_preview = (
             f"{case_data['command']} {' '.join(case_data['args'])}".strip()

{cli_test_framework-0.9.3 → cli_test_framework-1.0.1}/src/cli_test_framework/runners/parallel_config_runner.py

@@ -226,15 +226,7 @@ class ParallelConfigRunner(ParallelRunner):
         if case.steps:
             result = self._run_sequence(case)
         else:
-            case_data: TestCaseData = {
-                "name": case.name,
-                "command": case.command,
-                "args": case.args,
-                "expected": case.expected,
-                "description": case.description or None,
-                "timeout": case.timeout,
-                "resources": case.resources,
-            }
+            case_data = case.to_execution_dict()
 
             command_preview = (
                 f"{case_data['command']} {' '.join(case_data['args'])}".strip()

cli_test_framework-1.0.1/src/cli_test_framework/tui/__init__.py

@@ -0,0 +1,11 @@
+"""
+TUI Manager for interactive test case CRUD.
+
+Provides a Textual-based terminal UI for browsing, editing and running
+test cases. Relies on :mod:`cli_test_framework.config.config_io` for
+configuration I/O and :mod:`cli_test_framework.core` for execution.
+
+Usage::
+
+    cli-test tui test_cases.json
+"""

cli_test_framework-1.0.1/src/cli_test_framework/tui/app.py

@@ -0,0 +1,78 @@
+"""Textual App entry point for the TUI manager.
+
+Usage::
+
+    from cli_test_framework.tui.app import run_tui
+    run_tui("test_cases.json", workspace="/path/to/project")
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Optional
+
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+
+from .controllers.case_controller import CaseController
+from .screens.case_list import CaseListScreen
+
+
+class CaseManagerApp(App):
+    """Terminal UI for browsing / editing / running test cases."""
+
+    TITLE = "CLI Test Framework - Case Manager"
+
+    BINDINGS = [
+        Binding("ctrl+q", "quit", "Quit", show=True, priority=True),
+        Binding("q", "quit", "Quit", show=True, priority=True),
+    ]
+
+    CSS = """
+    Screen {
+        background: $surface;
+    }
+    """
+
+    def __init__(self, config_file: str, workspace: Optional[str] = None):
+        super().__init__()
+        self._config_file = config_file
+        self._workspace = workspace
+        self._controller = CaseController()
+
+    def on_mount(self) -> None:
+        try:
+            count = self._controller.load(self._config_file, self._workspace)
+            self.notify(f"Loaded {count} test cases from {Path(self._config_file).name}")
+        except Exception as e:
+            self.notify(f"Failed to load config: {e}", severity="error")
+
+        self.push_screen(CaseListScreen(self._controller))
+
+
+# ---------------------------------------------------------------------------
+# Public entry point
+# ---------------------------------------------------------------------------
+
+
+def run_tui(config_file: str, workspace: Optional[str] = None) -> None:
+    """Launch the TUI manager.
+
+    Safe to call without installing textual — raises :exc:`ImportError`
+    with a friendly message if textual is not available.
+    """
+    try:
+        import textual  # noqa: F401 — verify textual is importable
+    except ImportError:
+        import sys
+
+        print(
+            "TUI 功能需要安装 textual。请运行：\n"
+            "  pip install cli-test-framework[tui]\n"
+            "或：\n"
+            "  pip install textual"
+        )
+        sys.exit(1)
+
+    app = CaseManagerApp(config_file, workspace)
+    app.run()