### **Python自动化测试脚本 (调用eNSP REST API)** 首先，**问题解构**：您希望创建一个Python脚本，通过调用eNSP（或其模拟设备的）REST API来自动化执行一系列功能测试（F1-F5），并生成一个结构化的测试报告。根据参考资料，自动化脚本的核心是利用`requests`库发送HTTP请求[ref_4]，处理JSON响应，并将关键结果和截图整合到报告中。 接下来是**方案推演与实现**： 1. **API交互**：使用Python的`requests`库发送GET/POST请求到eNSP设备的REST API端点。 2. **测试执行与数据收集**：为每项功能测试（F1-F5）定义具体的API调用，解析响应，判断测试是否通过，并记录响应数据。 3. **截图功能**：在执行关键步骤或检查点后，使用脚本调用截图工具（如通过命令行调用`adb`、系统截图API或集成Selenium的`screenshot`方法）[ref_5]，并将截图保存到指定位置。 4. **报告生成**：创建一个HTML或Excel格式的报告，整合测试结果、截图链接、数据记录和问题跟踪。 以下是一个整合上述要点的**Python脚本示例**。此脚本假设您已有eNSP API的基础URL和认证信息，F1-F5测试对应特定的API路径。 ```python import requests import json import time import os import subprocess from datetime import datetime from requests.auth import HTTPBasicAuth import pandas as pd class ENSPAutomationTester: def __init__(self, base_url, username, password, screenshot_dir='./screenshots'): """ 初始化测试器 :param base_url: eNSP REST API的基础URL，例如: http://192.168.1.100:8000/api/v1 :param username: API认证用户名 :param password: API认证密码 :param screenshot_dir: 截图保存目录 """ self.base_url = base_url self.auth = HTTPBasicAuth(username, password) self.session = requests.Session() self.session.auth = self.auth self.screenshot_dir = screenshot_dir self.test_results = [] # 存储每次测试的结果 self._ensure_screenshot_dir() def _ensure_screenshot_dir(self): """确保截图目录存在""" if not os.path.exists(self.screenshot_dir): os.makedirs(self.screenshot_dir) def take_screenshot(self, step_name): """ 执行截图操作（示例为系统命令截图，实际需根据环境调整） :param step_name: 步骤名称，用于命名截图文件 """ # 这是一个示例，实际调用取决于你的截图工具和方式。 # 例如，在Windows上可以使用PIL或`msedge-selenium-tools`，这里用占位符说明。 timestamp = datetime.now().strftime('%Y%m%d_%H%M%S') filename = f"{step_name}_{timestamp}.png" filepath = os.path.join(self.screenshot_dir, filename) # 示例：假设有一个名为'screencapture'的命令行工具（Mac/Linux），实际需替换为具体命令。 # command = ['screencapture', '-x', filepath] # subprocess.run(command, check=False) # 更实际的场景可能是通过Selenium WebDriver控制浏览器进行网络设备界面截图[ref_5]，或调用其他工具API。 print(f"[INFO] 模拟截图保存至: {filepath}") # 为了演示，我们创建一个空文件或标记文件 with open(filepath, 'w') as f: f.write(f"Screenshot placeholder for {step_name}") return filepath # 返回截图文件路径 def call_ensp_api(self, endpoint, method='GET', data=None): """ 调用eNSP REST API的核心方法 :param endpoint: API端点路径，例如 '/interfaces' :param method: HTTP方法 :param data: POST/PUT请求的数据 :return: 响应对象或None """ url = f"{self.base_url}{endpoint}" headers = {'Content-Type': 'application/json'} try: if method.upper() == 'GET': response = self.session.get(url, headers=headers, timeout=30) elif method.upper() == 'POST': response = self.session.post(url, headers=headers, data=json.dumps(data), timeout=30) else: print(f"[ERROR] 不支持的HTTP方法: {method}") return None response.raise_for_status() # 如果状态码不是200，抛出HTTPError return response except requests.exceptions.RequestException as e: print(f"[ERROR] 调用API {url} 失败: {e}") return None def execute_test_case(self, test_id, test_name, api_endpoint, expected_key=None, expected_value=None): """ 执行一个测试用例 :param test_id: 测试用例ID，如 'F1' :param test_name: 测试用例名称 :param api_endpoint: 调用的API端点 :param expected_key: 预期检查的响应字段 :param expected_value: 预期值 :return: 字典，包含测试结果详情 """ print(f"[INFO] 开始执行测试: {test_id} - {test_name}") result = { 'Test_ID': test_id, 'Test_Name': test_name, 'API_Endpoint': api_endpoint, 'Timestamp': datetime.now().isoformat(), 'Status': 'FAIL', # 默认失败 'Response_Data': None, 'Screenshot_Path': None, 'Issue_Description': '' } # 1. 调用API response = self.call_ensp_api(api_endpoint) if not response: result['Issue_Description'] = 'API调用失败或网络异常' self.test_results.append(result) return result # 2. 解析响应数据 try: resp_data = response.json() result['Response_Data'] = json.dumps(resp_data, ensure_ascii=False, indent=2) except json.JSONDecodeError: result['Response_Data'] = response.text # 3. 验证结果（示例逻辑，根据实际API响应调整） test_passed = False if expected_key and expected_value: # 假设响应是一个字典，检查特定键值 if isinstance(resp_data, dict) and resp_data.get(expected_key) == expected_value: test_passed = True else: # 如果没有明确的预期值，可以检查HTTP状态码或响应中其他成功标志 if response.status_code == 200: test_passed = True # 也可以添加更复杂的业务逻辑判断 # 4. 根据测试结果记录状态和截图 if test_passed: result['Status'] = 'PASS' print(f"[PASS] 测试 {test_id} 通过") else: result['Status'] = 'FAIL' result['Issue_Description'] = f'预期条件不满足。预期: {expected_key}={expected_value}' print(f"[FAIL] 测试 {test_id} 失败") # 失败时截图用于问题分析[ref_5] screenshot_path = self.take_screenshot(f"{test_id}_FAIL") result['Screenshot_Path'] = screenshot_path self.test_results.append(result) return result def run_all_tests(self): """定义并执行F1到F5的测试套件""" # 这里是测试用例定义的示例。你需要根据实际的eNSP API文档来填充具体端点、方法和预期值。 test_cases = [ {'id': 'F1', 'name': '设备连通性测试', 'endpoint': '/system/status', 'exp_key': 'status', 'exp_val': 'online'}, {'id': 'F2', 'name': '接口状态检查', 'endpoint': '/interfaces/GigabitEthernet0/0/1', 'exp_key': 'adminStatus', 'exp_val': 'up'}, {'id': 'F3', 'name': '路由表项检查', 'endpoint': '/routing-table', 'exp_key': None, 'exp_val': None}, # 仅检查是否返回200 {'id': 'F4', 'name': '配置下发测试', 'endpoint': '/config/acl', 'method': 'POST', 'data': {'name': 'test_acl', 'rules': []}}, # POST示例 {'id': 'F5', 'name': '性能采样测试', 'endpoint': '/system/cpu-usage', 'exp_key': 'usage', 'exp_val': (lambda x: x < 80)} # 使用函数进行复杂校验 ] for tc in test_cases: # 简化处理，对于POST请求需要特殊处理 if tc.get('method') == 'POST': # 实际实现中，需要调整execute_test_case方法来支持POST和自定义数据 print(f"[WARN] POST测试 {tc['id']} 需要扩展execute_test_case方法来实现") continue self.execute_test_case( test_id=tc['id'], test_name=tc['name'], api_endpoint=tc['endpoint'], expected_key=tc.get('exp_key'), expected_value=tc.get('exp_val') ) time.sleep(1) # 测试间短暂等待 def generate_test_report(self, report_path='./test_report.xlsx'): """生成包含测试结果、截图链接、数据记录和问题跟踪矩阵的Excel报告""" if not self.test_results: print("[WARN] 没有测试结果可生成报告") return # 1. 创建测试结果汇总表 (Data Record Sheet) df_summary = pd.DataFrame(self.test_results) # 选择要在报告中显示的列 summary_cols = ['Test_ID', 'Test_Name', 'Status', 'Timestamp', 'Issue_Description', 'Screenshot_Path'] df_report = df_summary[summary_cols].copy() # 2. 创建问题跟踪矩阵 (Issue Tracking Matrix) # 从失败或存在问题的测试用例中提取问题 df_issues = df_summary[df_summary['Status'] == 'FAIL'].copy() if not df_issues.empty: df_issues['Issue_ID'] = [f'ISSUE_{i+1:03d}' for i in range(len(df_issues))] df_issues['Severity'] = 'High' # 严重程度，可根据规则自动判断或手动预设 df_issues['Assigned_To'] = '' df_issues['Status_Issue'] = 'Open' issue_cols = ['Issue_ID', 'Test_ID', 'Test_Name', 'Issue_Description', 'Severity', 'Assigned_To', 'Status_Issue', 'Screenshot_Path'] df_issue_matrix = df_issues[issue_cols] else: df_issue_matrix = pd.DataFrame(columns=['Issue_ID', 'Test_ID', 'Test_Name', 'Issue_Description', 'Severity', 'Assigned_To', 'Status_Issue', 'Screenshot_Path']) # 3. 生成Excel报告（包含多个Sheet） with pd.ExcelWriter(report_path, engine='openpyxl') as writer: df_report.to_excel(writer, sheet_name='测试结果汇总', index=False) # 如果需要，可以将详细的响应数据放到另一个Sheet df_summary[['Test_ID', 'Response_Data']].to_excel(writer, sheet_name='详细响应数据', index=False) df_issue_matrix.to_excel(writer, sheet_name='问题跟踪矩阵', index=False) # 4. 在Excel中插入截图（高级操作，需使用openpyxl库） # 注意：直接在Excel单元格中嵌入图片较为复杂，通常更简单的做法是在报告中存储截图路径。 # 这里仅将路径作为超链接或文本存储。 workbook = writer.book summary_sheet = writer.sheets['测试结果汇总'] # 可以为截图路径列添加超链接（如果路径是有效的文件路径） # 这部分代码较复杂，作为示例，我们仅存储路径字符串。 print(f"[INFO] 测试报告已生成: {report_path}") print(f"[INFO] 截图存储在目录: {self.screenshot_dir}") # 使用示例 if __name__ == "__main__": # 配置你的eNSP API连接信息 BASE_URL = "http://<ensp_device_ip>:<port>/api/v1" USERNAME = "admin" PASSWORD = "password" tester = ENSPAutomationTester(base_url=BASE_URL, username=USERNAME, password=USERNAME) # 执行所有测试 tester.run_all_tests() # 生成测试报告 report_file = f"ENSP_Test_Report_{datetime.now().strftime('%Y%m%d_%H%M%S')}.xlsx" tester.generate_test_report(report_path=report_file) ``` ### **测试报告模板详解** 上述脚本生成的Excel报告是一个核心模板，它直接包含了您要求的关键元素。下面对模板结构进行说明： | 元素 | 对应Sheet/列 | 描述与实现 | | :--- | :--- | :--- | | **截图位置** | `测试结果汇总`表中的`Screenshot_Path`列 | 记录每次失败测试所关联的截图文件**完整或相对路径**。在Excel中，可以将此列格式化为超链接，点击即可打开截图文件[ref_5]。 | | **数据记录表** | `测试结果汇总`和`详细响应数据`两个Sheet | 1. **测试结果汇总**：核心概览，包含测试ID、名称、状态、时间戳、问题描述和截图路径。<br>2. **详细响应数据**：存储原始API响应JSON或文本，供深入分析和回溯[ref_6]。 | | **问题跟踪矩阵** | `问题跟踪矩阵` Sheet | 专门从失败的测试用例中提取问题，形成跟踪矩阵。包含字段：问题ID、关联的测试ID、测试名称、问题描述、严重程度、指派给谁、问题状态（Open/In Progress/Closed）以及关联的截图路径。这直接服务于问题管理和闭环跟踪[ref_1]。 | 这个方案的优势在于： 1. **高度自动化**：从测试执行、结果验证、失败截图到报告生成，全过程由脚本驱动，极大提升了测试效率[ref_1][ref_4]。 2. **结构清晰**：报告采用多Sheet的Excel格式，将数据记录与问题管理分离，逻辑清晰，便于不同角色（如测试工程师、开发人员、项目经理）查阅和操作。 3. **可追溯性强**：每个测试结果都关联了时间戳、原始响应数据和失败截图，为问题定位和回归测试提供了完整依据[ref_6]。 4. **可扩展性好**：`execute_test_case`方法和`test_cases`列表可以方便地扩展以支持更多API端点和更复杂的验证逻辑，例如支持`POST`请求或自定义校验函数（如F5示例中的CPU使用率检查）。 **注意事项**：实际使用时，您需要根据eNSP设备或对应网络设备（如参考F5设备的iControl REST API[ref_2][ref_4]）的真实REST API文档，替换脚本中的`BASE_URL`、认证方式和具体的`test_cases`定义。截图功能`take_screenshot`的实现也需要根据您测试的具体环境（如是通过设备Web界面截图，还是通过模拟器命令行截图）进行调整[ref_5]。