infomankit 0.3.23__py3-none-any.whl

infoman/performance/cli.py

@@ -0,0 +1,215 @@
+#!/usr/bin/env python3
+"""
+性能测试命令行工具
+
+提供简单的 CLI 接口用于运行性能测试
+"""
+
+import asyncio
+import sys
+from pathlib import Path
+from typing import Optional
+
+import click
+from loguru import logger
+
+from .config import TestConfig
+from .runner import PerformanceTestRunner
+from .reporter import HTMLReporter
+
+
+@click.group()
+@click.version_option()
+def cli():
+    """Infomankit 性能测试工具"""
+    pass
+
+
+@cli.command()
+@click.option(
+    "-c",
+    "--config",
+    "config_file",
+    required=True,
+    type=click.Path(exists=True),
+    help="配置文件路径 (YAML)",
+)
+@click.option(
+    "-o",
+    "--output",
+    "output_file",
+    type=click.Path(),
+    help="报告输出路径 (覆盖配置文件中的设置)",
+)
+@click.option(
+    "-u",
+    "--users",
+    "concurrent_users",
+    type=int,
+    help="并发用户数 (覆盖配置文件中的设置)",
+)
+@click.option(
+    "-d",
+    "--duration",
+    type=int,
+    help="测试持续时间(秒) (覆盖配置文件中的设置)",
+)
+@click.option(
+    "-v", "--verbose", is_flag=True, help="显示详细日志"
+)
+def run(
+    config_file: str,
+    output_file: Optional[str],
+    concurrent_users: Optional[int],
+    duration: Optional[int],
+    verbose: bool,
+):
+    """运行性能测试"""
+
+    # 配置日志级别
+    if not verbose:
+        logger.remove()
+        logger.add(sys.stderr, level="INFO")
+
+    try:
+        # 加载配置
+        logger.info(f"加载配置: {config_file}")
+        config = TestConfig.from_yaml(config_file)
+
+        # 覆盖命令行参数
+        if concurrent_users:
+            config.concurrent_users = concurrent_users
+            logger.info(f"覆盖并发用户数: {concurrent_users}")
+
+        if duration:
+            config.duration = duration
+            logger.info(f"覆盖测试时长: {duration}秒")
+
+        if output_file:
+            config.report_output = output_file
+            logger.info(f"覆盖报告输出: {output_file}")
+
+        # 显示测试信息
+        logger.info("=" * 60)
+        logger.info(f"项目: {config.project_name}")
+        logger.info(f"目标: {config.base_url}")
+        logger.info(f"并发用户: {config.concurrent_users}")
+        logger.info(f"持续时间: {config.duration}秒")
+        logger.info(f"测试用例: {len(config.get_enabled_test_cases())}个")
+        logger.info("=" * 60)
+
+        # 运行测试
+        asyncio.run(_run_test(config))
+
+    except FileNotFoundError as e:
+        logger.error(f"配置文件不存在: {e}")
+        sys.exit(1)
+    except Exception as e:
+        logger.error(f"测试失败: {e}")
+        if verbose:
+            raise
+        sys.exit(1)
+
+
+async def _run_test(config: TestConfig):
+    """执行测试"""
+    # 运行测试
+    runner = PerformanceTestRunner(config)
+    results = await runner.run()
+
+    # 显示简要结果
+    logger.info("\n" + "=" * 60)
+    logger.info("测试结果汇总")
+    logger.info("=" * 60)
+
+    for name, result in results.items():
+        logger.info(f"\n📊 {name}")
+        logger.info(f"  总请求: {result.total_requests}")
+        logger.info(f"  成功率: {result.success_rate:.2f}%")
+        logger.info(f"  平均响应: {result.avg_response_time:.2f}ms")
+        logger.info(f"  P95: {result.p95_response_time:.2f}ms")
+        logger.info(f"  吞吐量: {result.throughput:.2f} req/s")
+        logger.info(f"  评级: {result.overall_level}")
+
+    # 生成报告
+    logger.info("\n" + "=" * 60)
+    logger.info("生成报告...")
+    reporter = HTMLReporter(config)
+    report_path = reporter.generate(results)
+    logger.success(f"✅ 报告已生成: {report_path}")
+    logger.info("=" * 60)
+
+
+@cli.command()
+@click.argument("output", type=click.Path())
+def init(output: str):
+    """生成示例配置文件"""
+    config = TestConfig(
+        project_name="My API",
+        base_url="http://localhost:8000",
+        concurrent_users=10,
+        duration=60,
+    )
+
+    # 添加示例测试用例
+    from .config import APITestCase
+
+    config.add_test_case(
+        APITestCase(
+            name="健康检查",
+            url="/api/health",
+            method="GET",
+            interface_type="fast",
+            description="API 健康检查",
+        )
+    )
+
+    config.add_test_case(
+        APITestCase(
+            name="用户列表",
+            url="/api/v1/users",
+            method="GET",
+            interface_type="normal",
+            params={"page": 1, "page_size": 20},
+            description="用户列表查询",
+        )
+    )
+
+    # 保存配置
+    config.to_yaml(output)
+    logger.success(f"✅ 配置文件已生成: {output}")
+    logger.info("请编辑配置文件后运行测试:")
+    logger.info(f"  infoman perf run -c {output}")
+
+
+@cli.command()
+def standards():
+    """显示性能标准"""
+    from .standards import PerformanceStandards
+
+    logger.info("=" * 60)
+    logger.info("性能标准")
+    logger.info("=" * 60)
+
+    for interface_type, threshold in PerformanceStandards.STANDARDS.items():
+        logger.info(f"\n{interface_type.upper()} 接口:")
+        logger.info(f"  优秀 (Excellent): < {threshold.excellent}ms")
+        logger.info(f"  良好 (Good):      < {threshold.good}ms")
+        logger.info(f"  可接受 (Acceptable): < {threshold.acceptable}ms")
+        logger.info(f"  较差 (Poor):     < {threshold.poor}ms")
+        logger.info(f"  严重 (Critical): >= {threshold.poor}ms")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("成功率标准")
+    logger.info("=" * 60)
+    for level, rate in PerformanceStandards.SUCCESS_RATE_STANDARDS.items():
+        logger.info(f"  {level:12}: >= {rate}%")
+
+
+def main():
+    """主函数"""
+    cli()
+
+
+if __name__ == "__main__":
+    main()

infoman/performance/config.py

@@ -0,0 +1,166 @@
+"""
+性能测试配置
+
+定义测试配置和测试用例
+"""
+
+from typing import Dict, Any, List, Optional, Literal
+from pydantic import BaseModel, Field
+import yaml
+from pathlib import Path
+
+
+class APITestCase(BaseModel):
+    """单个 API 测试用例"""
+
+    name: str = Field(..., description="测试用例名称")
+    url: str = Field(..., description="API URL (相对路径或绝对路径)")
+    method: Literal["GET", "POST", "PUT", "DELETE", "PATCH"] = Field(
+        default="GET",
+        description="HTTP 方法"
+    )
+    headers: Dict[str, str] = Field(
+        default_factory=dict,
+        description="请求头"
+    )
+    params: Dict[str, Any] = Field(
+        default_factory=dict,
+        description="URL 参数 (GET)"
+    )
+    json: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="JSON 请求体 (POST/PUT/PATCH)"
+    )
+    data: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="表单数据"
+    )
+    interface_type: Literal["fast", "normal", "complex", "heavy"] = Field(
+        default="normal",
+        description="接口类型 (用于性能标准评估)"
+    )
+    timeout: int = Field(
+        default=30,
+        description="请求超时时间 (秒)"
+    )
+    description: str = Field(
+        default="",
+        description="测试描述"
+    )
+    enabled: bool = Field(
+        default=True,
+        description="是否启用此测试"
+    )
+
+
+class TestConfig(BaseModel):
+    """性能测试配置"""
+
+    # 基础配置
+    project_name: str = Field(default="Infomankit", description="项目名称")
+    base_url: str = Field(default="http://localhost:8000", description="基础 URL")
+
+    # 并发配置
+    concurrent_users: int = Field(default=10, description="并发用户数")
+    duration: int = Field(default=60, description="测试持续时间 (秒)")
+    spawn_rate: int = Field(default=1, description="每秒启动用户数")
+
+    # 全局请求头
+    global_headers: Dict[str, str] = Field(
+        default_factory=lambda: {
+            "User-Agent": "Infomankit-Performance-Test/1.0",
+            "Accept": "application/json",
+        },
+        description="全局请求头"
+    )
+
+    # 认证配置
+    auth_type: Optional[Literal["basic", "bearer", "custom"]] = Field(
+        default=None,
+        description="认证类型"
+    )
+    auth_token: Optional[str] = Field(default=None, description="Bearer Token")
+    auth_username: Optional[str] = Field(default=None, description="Basic Auth 用户名")
+    auth_password: Optional[str] = Field(default=None, description="Basic Auth 密码")
+
+    # 测试用例
+    test_cases: List[APITestCase] = Field(
+        default_factory=list,
+        description="API 测试用例列表"
+    )
+
+    # 报告配置
+    report_title: str = Field(default="性能测试报告", description="报告标题")
+    report_output: str = Field(
+        default="performance-report.html",
+        description="报告输出路径"
+    )
+
+    # 高级配置
+    think_time_min: int = Field(default=1, description="最小思考时间 (秒)")
+    think_time_max: int = Field(default=3, description="最大思考时间 (秒)")
+
+    stop_on_error: bool = Field(
+        default=False,
+        description="遇到错误时停止测试"
+    )
+
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "project_name": "Infomankit API",
+                "base_url": "http://localhost:8000",
+                "concurrent_users": 50,
+                "duration": 120,
+                "auth_type": "bearer",
+                "auth_token": "your-token-here",
+                "test_cases": [
+                    {
+                        "name": "健康检查",
+                        "url": "/api/health",
+                        "method": "GET",
+                        "interface_type": "fast",
+                    },
+                    {
+                        "name": "用户列表",
+                        "url": "/api/v1/users",
+                        "method": "GET",
+                        "interface_type": "normal",
+                        "params": {"page": 1, "page_size": 20},
+                    },
+                ]
+            }
+        }
+
+    @classmethod
+    def from_yaml(cls, filepath: str) -> "TestConfig":
+        """从 YAML 文件加载配置"""
+        path = Path(filepath)
+        if not path.exists():
+            raise FileNotFoundError(f"配置文件不存在: {filepath}")
+
+        with open(path, "r", encoding="utf-8") as f:
+            data = yaml.safe_load(f)
+
+        return cls(**data)
+
+    def to_yaml(self, filepath: str):
+        """保存配置到 YAML 文件"""
+        path = Path(filepath)
+        path.parent.mkdir(parents=True, exist_ok=True)
+
+        with open(path, "w", encoding="utf-8") as f:
+            yaml.dump(
+                self.model_dump(exclude_none=True),
+                f,
+                allow_unicode=True,
+                sort_keys=False,
+            )
+
+    def add_test_case(self, test_case: APITestCase):
+        """添加测试用例"""
+        self.test_cases.append(test_case)
+
+    def get_enabled_test_cases(self) -> List[APITestCase]:
+        """获取启用的测试用例"""
+        return [tc for tc in self.test_cases if tc.enabled]