跳到主要内容

开始使用

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 版本。

下一步是什么？​

接下来，我们建议你查阅以下指南