跳转到主要内容

开始使用

create-plugin 工具会自动生成 @grafana/plugin-e2e 的基本设置，以帮助您轻松开始插件中的端到端测试。本指南将带您了解如何使用 @grafana/plugin-e2e 运行 Playwright 测试的基本用法。

注意

如果您使用的是 4.6.0 之前的 create-plugin 版本创建的插件，请遵循迁移指南，了解如何手动安装和配置 @grafana/plugin-e2e。

开始之前​

您需要以下内容

  • Grafana 插件开发环境。
  • Node.js 版本 18 或更高版本。
  • 对 Playwright 的基本了解。如果您之前没有使用过 Playwright，我们建议您查阅他们的文档中的入门部分。

步骤 1：启动 Grafana​

在本地机器上启动最新版本的 Grafana，如下所示

npm run server

如果您想启动特定版本的 Grafana，可以通过指定 GRAFANA_VERSION 环境变量来实现。例如

GRAFANA_VERSION=10.4.1 npm run server

步骤 2：运行测试​

在本地插件开发目录中打开一个新的终端并运行测试脚本。

npx playwright test

步骤 3：在 CI 中运行测试​

plugin.json 文件中的 grafanaDependency 属性指定了插件兼容的 Grafana 版本。作为最佳实践，运行您的 Playwright 端到端测试，针对所有支持的版本。使用 create-plugin 搭建插件时可以包含的 GitHub 工作流程确保了这一点。

如果您在搭建插件时选择不添加 GitHub 工作流程，作为最佳实践，请遵循CI 指南中的说明，以运行 Playwright 端到端测试，针对您的插件支持的 Grafana 所有版本。

接下来是什么？​

接下来我们建议您查看以下指南