基于文件夹测试的网络设备解析器开发-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_42610010/article/details/147937483

基于文件夹测试的网络设备解析器开发

背景简介

在软件开发中，确保代码质量是至关重要的。特别是在网络设备的解析器开发中，能够有效地创建和管理测试用例对于保证代码的稳定性和可靠性至关重要。本文将探讨如何利用 genieparser 库创建基于文件夹的测试，以及如何将其贡献回库中。

创建基于文件夹的测试

genieparser 库提供了两种类型的测试：基于文件夹的测试和基于unittest的测试。目标是过渡到基于文件夹的测试。这种方式有助于减少合并冲突，避免样板代码的重复，并且使得测试的创建和管理更加简单。

要开始创建测试，首先需要在测试目录（ src/genie/libs/parser/{OS}/tests ）中创建一个与解析器类名称相匹配的文件夹。例如，针对IOS-XE设备的 ShowLicenseSummary 解析器，需要创建以下文件夹结构：

src/genie/libs/parser/iosxe/tests/ShowLicenseSummary/cli/empty
src/genie/libs/parser/iosxe/tests/ShowLicenseSummary/cli/equal

在 empty 文件夹中，创建一个空的 _output.txt 文件。在 equal 文件夹中，创建包含原始命令输出、预期解析输出和任何潜在参数的文件。测试文件通常包括 _arguments.json 、 _expected.py 和 _output.txt 。

编写测试

每个测试通常包括三个文件，它们通过文件名的共同部分联系起来，例如：

golden_output1_arguments.json
golden_output1_expected.py
golden_output1_output.txt

golden_output1_output.txt 包含执行相关命令时预期的原始输出。
golden_output1_expected.py 是一个Python文件，包含一个名为 expected_output 的变量，该变量存储预期的输出结构。
golden_output1_arguments.json 包含解析器参数的键/值对。

运行测试

编写完测试后，可以通过进入 genieparser 库根目录下的测试目录（ /genieparser/tests ）来运行它们。可以运行所有测试、针对单个操作系统的所有测试，或者针对单个解析器的单一测试。测试脚本 folder_parsing_job.py 使用 AEtest 测试基础设施运行测试，输出 PASSED/FAILED 结果。

更新变更日志

在将更改推送到GitHub之前，需要更新变更日志，记录更改、添加或修复的内容。这通常在 genieparser/changelog/undistributed 目录下创建一个新文件，并遵循给定的模板格式。

提交Pull Request

最后，使用Git命令 git push –u origin {branch_name} 将更改推送到分叉的仓库。然后在GitHub上的原始 genieparser 库上打开一个Pull Request。每个Pull Request应包含必要的部分，如描述、动机和上下文、影响、截图以及检查清单。