跳转到主要内容

插件端到端测试简介

@grafana/plugin-e2e 是专门为 Grafana 插件开发者设计的。它扩展了 @playwright/test 功能,包括相关的 fixtures、models 和 expect matchers;使得可以在多个 Grafana 版本上全面测试 Grafana 插件的端到端功能。此包简化了测试过程,确保您的插件稳健并兼容各种 Grafana 环境。

问题

插件作者通常希望他们的插件与多个 Grafana 版本兼容。这可能具有挑战性,因为环境、API 和 UI 组件可能因 Grafana 版本的不同而有所不同。因此,手动测试多个版本的 Grafana 上的插件是一个繁琐的过程,因此在大多数情况下,端到端测试提供了更好的解决方案。

解决方案

@grafana/plugin-e2e 工具提供了一种一致的方式来与 Grafana UI 交互,而无需在插件测试代码中处理 UI 偏差。自 8.5.0 以来,@grafana/plugin-e2e 的 API 保证与所有最新次要版本的 Grafana 兼容。除了跨版本兼容性外,该工具还提供了一组简化端到端测试体验的功能。

  • 预定义 fixtures: 提供了一套针对 Grafana 插件测试量身定制的预定义 fixtures。
  • 自定义 models: 提供了代表 Grafana 中的页面和组件的自定义 models,简化了维护并创建可重用代码以避免重复。
  • Expect matchers: 包含了一系列针对 Grafana 插件断言的 expect matchers,帮助您更有效地验证插件行为。
  • 与 Playwright 的集成: 与 Playwright 测试框架无缝集成,利用其强大的浏览器自动化功能。