二十八、【环境管理篇】灵活应对:多测试环境配置与切换
二十八、【环境管理篇】灵活应对:多测试环境配置与切换
- 前言
- 准备工作
- 第一部分:后端实现 - `Environment` 模型与 API
- 1. 定义 `Environment` 模型
- 2. 生成并应用数据库迁移
- 3. 创建 `EnvironmentSerializer`
- 4. 创建 `EnvironmentViewSet`
- 5. 注册 `EnvironmentViewSet` 路由
- 6. 更新 `TestPlan` 模型和 `execute_api_test_case` 以关联环境
- 第二部分:前端实现 - 环境管理界面与测试计划选择环境
- 1. 创建环境相关的 API 服务 (`src/api/environment.ts`)
- 2. 添加环境管理页面的路由和侧边栏入口
- 3. 实现环境列表页面 (`src/views/system/EnvironmentListView.vue`)
- 4. 实现环境表单对话框组件 (`src/views/system/components/EnvironmentFormDialog.vue`)
- 5. 更新测试计划编辑页面 (`TestPlanEditView.vue`) 以选择环境
- 第三部分:全面测试
- 总结
前言
一个专业的测试平台需要能够适应多环境的测试需求。例如,同一套接口测试用例,可能需要在不同的环境中运行,而每个环境的 API Base URL、可能需要传入的特定请求头(如 API Key)、或者其他认证信息都可能不同。
我们的目标是实现:
- 集中管理环境配置: 将所有环境的关键信息(如名称、描述、Base URL)存储在数据库中,方便管理。
- 灵活的用例执行: 在触发测试计划执行时,能够指定在哪个环境中运行。
- 后端动态适配: 后端测试执行器能够读取所选环境的配置,并根据这些配置来构建和发送实际的 HTTP 请求。
准备工作
- Django 后端项目就绪: 确保你的
test-platform/backend
项目结构完整。 - Vue3 前端项目就绪。
- Axios 和 API 服务已封装。
- Element Plus 集成完毕。
- 拥有管理员权限: 环境管理功能通常只有管理员才能访问和操作。
第一部分:后端实现 - Environment
模型与 API
1. 定义 Environment
模型
打开 test-platform/api/models.py
,添加 Environment
模型:
# test-platform/api/models.py
from django.db import models
from .base_models import BaseModel # 假设 BaseModel 在同目录的 base_models.py
# ... (其他模型保持不变) ...class Environment(BaseModel): # 继承自 BaseModel"""环境模型存储不同测试环境的配置信息"""# name 和 description 字段从 BaseModel 继承# 环境的 Base URL,例如 'https://dev.api.example.com'base_url = models.URLField(max_length=512, verbose_name="Base URL")# 存储其他环境特定的配置,例如公共请求头、认证信息等 (JSON格式)# 例如:{"headers": {"X-Api-Key": "abc"}, "auth_token": "some_fixed_token"}config_data = models.JSONField(null=True, blank=True, verbose_name="配置数据 (JSON格式)")class Meta:verbose_name = "环境"verbose_name_plural = "环境列表"ordering = ['name']unique_together = ('name', ) # 环境名称应唯一def __str__(self):return self.name
模型字段解释:
base_url
: 该环境的 API 基础 URL。config_data
: JSONField 用于存储任意其他环境特有的键值对配置,例如通用的请求头、认证参数等。
2. 生成并应用数据库迁移
python manage.py makemigrations api
python manage.py migrate api
3. 创建 EnvironmentSerializer
打开 test-platform/api/serializers.py
,添加:
# test-platform/api/serializers.py
# ... (其他 Serializer) ...
from .models import Environment # 确保导入 Environmentclass EnvironmentSerializer(serializers.ModelSerializer):class Meta:model = Environmentfields = ['id', 'name', 'description', 'base_url', 'config_data', 'create_time', 'update_time']read_only_fields = ('create_time', 'update_time')
4. 创建 EnvironmentViewSet
打开 test-platform/api/views.py
,添加:
# test-platform/api/views.py
# ... (其他 ViewSet) ...
from .models import Environment # 确保导入 Environment
from .serializers import EnvironmentSerializer # 确保导入 EnvironmentSerializerclass EnvironmentViewSet(viewsets.ModelViewSet):"""环境管理 API"""queryset = Environment.objects.all().order_by('name')serializer_class = EnvironmentSerializerpermission_classes = [permissions.IsAdminUser] # 通常只有管理员才能管理环境filter_backends = [filters.SearchFilter, filters.OrderingFilter]search_fields = ['name', 'description', 'base_url']ordering_fields = ['name', 'create_time']def perform_create(self, serializer):instance = serializer.save()record_operation_log( # 记录操作日志user=self.request.user, action_type='CREATE', target_resource='环境', target_id=instance.id, description=f"创建了环境: '{instance.name}' (ID: {instance.id})",request=self.request)def perform_update(self, serializer):instance = serializer.save()record_operation_log( # 记录操作日志user=self.request.user, action_type='UPDATE', target_resource='环境', target_id=instance.id, description=f"更新了环境: '{instance.name}' (ID: {instance.id})",request=self.request)def perform_destroy(self, instance):env_name = instance.nameenv_id = instance.idinstance.delete()record_operation_log( # 记录操作日志user=self.request.user, action_type='DELETE', target_resource='环境', target_id=env_id, description=f"删除了环境: '{env_name}' (ID: {env_id})",request=self.request)
5. 注册 EnvironmentViewSet
路由
打开 test-platform/api/urls.py
:
# test-platform/api/urls.py
# ...
from .views import (# ... 其他 ViewSets ...EnvironmentViewSet # 导入 EnvironmentViewSet
)
# ...
router.register(r'environments', EnvironmentViewSet, basename='environment') # 新增环境路由
# ...
6. 更新 TestPlan
模型和 execute_api_test_case
以关联环境
为了在执行测试计划时选择环境,我们需要:
a. 修改 TestPlan
模型,添加一个 ForeignKey
到 Environment
:
# test-platform/api/models.py - TestPlan
# ...
class TestPlan(BaseModel):project = models.ForeignKey(Project, on_delete=models.CASCADE, verbose_name="所属项目", related_name="test_plans")test_cases = models.ManyToManyField(TestCase, verbose_name="包含用例", related_name="test_plans_containing", blank=True)# --- 新增关联环境 ---environment = models.ForeignKey(Environment, on_delete=models.SET_NULL, null=True, blank=True, verbose_name="执行环境")# ...
注意: 将 on_delete
设置为 models.SET_NULL
,表示如果关联的环境被删除,测试计划的 environment
字段会变为 NULL
,而不会级联删除测试计划本身。
b. 生成并应用数据库迁移:
python manage.py makemigrations api
python manage.py migrate api
c. 更新 TestPlanSerializer
(api/serializers.py
):
# test-platform/api/serializers.py - TestPlanSerializer
# ...
class TestPlanSerializer