Documentation
¶
Overview ¶
Package common 提供GoAdmin框架的通用测试函数
文件名: api.go 包名: common 作者: GoAdmin Team 创建日期: 2026-01-10
功能描述: 本文件提供了API接口测试功能，用于验证GoAdmin框架的API接口是否正常工作 主要测试管理员相关的API接口，包括列表查询、表单获取等功能
核心概念: - API测试: 使用httpexpect库对GoAdmin框架的API接口进行自动化测试 - JSON响应: API接口返回JSON格式的响应数据，包含状态码和业务数据 - HTTP请求: 使用GET/POST等HTTP方法访问API接口 - 请求头: 设置Accept等请求头，指定响应数据格式 - 查询参数: 通过URL查询参数传递请求参数（如编辑ID） - Cookie认证: 通过会话cookie进行身份验证
技术栈: - httpexpect: HTTP请求测试库，提供链式API进行HTTP请求和响应验证 - config: GoAdmin配置模块，提供URL生成和配置管理功能 - constant: GoAdmin常量模块，提供框架常量定义
测试范围: - 管理员列表API: 测试获取管理员列表数据 - 更新表单API: 测试获取编辑管理员的表单数据 - 创建表单API: 测试获取新建管理员的表单数据
使用场景: - 集成测试: 在集成测试中验证API接口功能 - 回归测试: 在代码变更后验证API接口是否正常 - CI/CD: 在持续集成流程中自动运行API测试
注意事项: - API接口需要身份验证，必须携带有效的会话cookie - API接口返回JSON格式数据，包含code、data、msg等字段 - code=200表示请求成功，code=400表示请求参数错误 - 编辑表单需要提供编辑对象的ID（通过constant.EditPKKey参数） - Accept请求头设置为"application/json, text/plain, */*"，表示接受JSON格式响应
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExtraTest ¶
func ExtraTest(e *httpexpect.Expect)
ExtraTest 执行GoAdmin管理插件的扩展测试 包含权限、角色、管理员、API、菜单、操作日志、外部数据源和正常表格测试
参数:
- e: HTTP期望对象，用于发送HTTP请求和验证响应
功能特性:
- 执行认证测试并获取会话 cookie
- 测试权限管理功能
- 测试角色管理功能
- 测试管理员管理功能
- 测试 API 接口功能
- 测试菜单管理功能
- 测试操作日志功能
- 测试外部数据源功能
- 测试正常表格功能
测试流程:
- 执行认证测试，获取会话 cookie
- 执行权限管理测试
- 执行角色管理测试
- 执行管理员管理测试
- 执行 API 接口测试
- 执行菜单管理测试
- 执行操作日志测试
- 执行外部数据源测试
- 执行正常表格测试
说明:
该函数是扩展测试套件，包含了 GoAdmin 管理插件的所有功能测试 测试使用黑盒测试方法，通过 HTTP 请求验证各个功能是否正常工作 所有测试都使用 httpexpect 库进行 HTTP 请求和响应验证 认证测试返回的 cookie 用于后续所有测试的身份验证
func Test ¶
func Test(e *httpexpect.Expect)
Test 执行GoAdmin管理插件的基本功能测试 包含权限、角色、管理员、菜单和操作日志测试
参数:
- e: HTTP期望对象，用于发送HTTP请求和验证响应
功能特性:
- 执行认证测试并获取会话 cookie
- 测试权限管理功能
- 测试角色管理功能
- 测试管理员管理功能
- 测试菜单管理功能
- 测试操作日志功能
测试流程:
- 执行认证测试，获取会话 cookie
- 执行权限管理测试
- 执行角色管理测试
- 执行管理员管理测试
- 执行菜单管理测试
- 执行操作日志测试
说明:
该函数是基本测试套件，包含了 GoAdmin 管理插件的核心功能测试 测试使用黑盒测试方法，通过 HTTP 请求验证各个功能是否正常工作 所有测试都使用 httpexpect 库进行 HTTP 请求和响应验证 认证测试返回的 cookie 用于后续所有测试的身份验证 与 ExtraTest 的区别是不包含 API 测试、外部数据源测试和正常表格测试
Types ¶
This section is empty.
Source Files