入门
该 create-plugin 工具自动为 @grafana/plugin-e2e
创建基本设置,帮助您轻松开始在插件中进行端到端测试。本指南将引导您完成使用 @grafana/plugin-e2e
运行 Playwright 测试的基本用法。
注意
如果您使用的是 4.6.0 之前的 create-plugin 版本创建的插件,请按照 迁移指南 中的说明手动安装和配置 @grafana/plugin-e2e
。
开始之前
您需要具备以下条件
步骤 1:启动 Grafana
在您的本地机器上启动最新版本的 Grafana,如下所示
- npm
- yarn
- pnpm
npm run server
yarn server
pnpm run server
如果您想启动特定版本的 Grafana,可以通过指定 GRAFANA_VERSION
环境变量来实现。例如
GRAFANA_VERSION=10.4.1 npm run server
步骤 2:运行测试
打开一个新的终端,并在您的本地插件开发目录中运行测试脚本。
- npm
- yarn
- pnpm
npx playwright test
yarn playwright test
pnpm playwright test
步骤 3:在 CI 中运行测试
plugin.json
文件中的 grafanaDependency
属性指定了插件兼容的 Grafana 版本。作为最佳实践,您应该针对所有支持的版本运行 Playwright 端到端测试。使用 create-plugin
创建插件时包含的 GitHub 工作流程确保了这一点。
如果您在创建插件时选择不添加 GitHub 工作流程,作为最佳实践,请按照 CI 指南中的说明针对您的插件支持的所有 Grafana 版本运行 Playwright 端到端测试。
下一步是什么?
接下来,我们建议您查看以下指南