# pitrix-sphere

**Repository Path**: tython/pitrix-sphere

## Basic Information

- **Project Name**: pitrix-sphere
- **Description**: pitrix-sphere
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2025-11-03
- **Last Updated**: 2026-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 自动化测试, e2e, api测试

## README

# Pitrix-Sphere 自动化测试框架

[![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://python.org)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

Pitrix-Sphere 是一个专注于云平台API接口、E2E测试的自动化测试框架。该框架提供了简洁易用的API测试解决方案，可快速验证云平台API、UI的可用性和正确性。

## 🚀 功能特性

- **API测试**: 全面的RESTful API接口测试
- **多种HTTP方法**: 支持GET、POST、PUT、DELETE等HTTP方法
- **灵活配置**: 支持自定义请求头、超时时间等参数
- **多进程/多线程**: 支持多进程和多线程并发测试执行
- **测试标记**: 支持按标记过滤和分类测试用例
- **重试机制**: 支持测试失败自动重试
- **详细报告**: 提供JSON和CSV格式的测试报告
- **日志记录**: 基于loguru的简洁日志系统，包含进程和线程信息
- **简单易用**: 命令行工具，一键运行API测试
- **资源管理**: 自动化资源创建与清理机制
- **类型安全**: 使用Python dataclass和类型提示确保代码质量
- **丰富断言**: 提供丰富的断言，如相等、包含、长度、正则匹配等，自动断言业务码
- **统一断言机制**: 使用自定义[pitrix_assert]实例进行断言，确保测试的一致性和可维护性
- **参数化测试**: 支持测试用例参数化，每个测试数据生成独立的测试实例，提高测试覆盖率
- **业务流程测试**: 支持复杂的业务流程测试，可以编排多个API调用形成完整的业务场景
- **资源等待机制**: 内置资源状态等待机制，确保在适当的状态下进行断言
- **配置驱动**: 支持多种环境配置（testbm、staging、生产等），便于在不同环境中运行测试
- **响应模型**: 所有API响应都封装为类型安全的模型对象，提供IDE友好的自动补全和编译时检查
- **自动资源清理**: 测试完成后自动清理创建的资源，避免资源泄漏和额外费用
- **异常处理**: 统一的异常处理机制，提供清晰的错误信息和堆栈跟踪
- **会话插件机制**: 支持通过插件扩展不同的平台会话实现
- **Hook机制**: 提供前置和后置Hook，支持测试环境准备和资源清理
- **Allure测试报告**: 集成Allure报告生成，提供美观、详细的测试执行报告

## 📋 系统要求

- Python 3.12+
- 操作系统: Linux, macOS, Windows
- 内存: 建议2GB以上
- 网络: 稳定的网络连接（用于API调用）

## 📚 详细文档

要深入了解框架的各个功能模块，请访问 [docs](./docs/) 目录下的详细文档：

- [安装与部署指南](./docs/installer_doc.md) - 如何安装和部署Pitrix-Sphere框架
- [项目架构介绍](./docs/pitrix_sphere_doc.md) - 项目的整体架构和设计理念
- [API请求机制](./docs/apis_request_doc.md) - API请求处理机制和使用方法
- [API架构设计](./docs/apis_architecture_doc.md) - API模块的架构设计原理
- [业务流程测试](./docs/business_flow_doc.md) - 复杂业务流程测试的编写和执行
- [配置模型详解](./docs/common_config_model_doc.md) - 配置管理系统的详细说明
- [数据库表结构](./docs/database_tables_doc.md) - pitrix-sphere db详细说明
- [资源栈管理](./docs/common_resource_stack_doc.md) - 资源栈的创建、管理和清理机制
- [并发测试策略](./docs/concurrent_test_doc.md) - 并发测试的设计和实现方案
- [核心断言系统](./docs/core_assert_doc.md) - 断言机制的详细使用说明
- [Hook机制](./docs/core_hook_doc.md) - 前置和后置Hook的使用方式
- [会话插件系统](./docs/core_session_plugin_doc.md) - 会话插件的扩展和实现
- [流程管理系统](./docs/flow_management_system.md) - 工作流管理系统的使用方法
- [Docker构建指南](./docs/docker_build_doc.md) - Docker镜像的构建和部署
- [E2E测试指南](./docs/e2e_doc.md) - 端到端测试的编写和执行
- [K8s集群API测试](./docs/k8s_cluster_api_doc.md) - Kubernetes集群API测试方法
- [插件和Fixtures规则](./docs/plugin_fixture_rules_doc.md) - 插件和Fixtures的编写规范
- [资源清理工具](./docs/resource_clear_tool_doc.md) - 自动化资源清理工具的使用
- [测试用例标记规则](./docs/testcases_mark_rule_doc.md) - 测试用例标记的使用规范

## 🤝 贡献指南

1. Fork 项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request

## 📝 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。

## 📞 支持

如果您遇到问题或有任何建议，请：

1. 查看 [Issues](https://git.yunify.com/qingcloud/pitrix-sphere/-/merge_requests)
2. 创建新的 Issue
3. 联系维护团队

---

**Pitrix-Sphere** - 让API测试更简单、更可靠！