Plugin E2E: Tasklist

[sunker]

Which areas does this feature request relate to

• Create Plugin
• Sign Plugin
• Plugin E2E
• Documentation

Problem

This epic contains a list of all the tasks that need to be completed for the plugin e2e package MVP.

For a detailed description of the problem, see grafana/grafana#77484.

Tasks

Beta Give feedback

1. Add new workspace
2. Add e2e selectors
3. Add first fixtures
4. Enable testing Config editor page
5. Enable testing the Query editor
6. Add provisioning file
7. Enable testing the Variable editor
8. Enable testing the Annotation editor
9. Enable testing Explore
10. Add GH action that resolves target versions for Grafana
11. Replace magic strings with selectors (Plugin E2E: Enable testing the query editor in Explore #581 (comment))
12. Plugin E2E: Publish to NPM #605
    patch plugin-e2e release released +4
13. Harmonise model instantiations and navigation
14. Plugin E2E: Change FE feature toggles during test session #651
    minor release +2
15. Feat: Add proper selectors for UI components #724
    0 of 4
    enhancement +1
    
16. Plugin E2E: Add expect matcher for alert box #610
    patch release released +3
17. Plugin E2E: Add isFeatureToggleEnabled fixture #612
    patch release released +3
18. Plugin E2E: Enable testing panel plugins #616
    minor release released +3
19. Plugin E2E: Add contributing guidelines #634
    minor release released +3
20. Plugin E2E: Publish report to cloud storage #645
    no-changelog +1
21. Refine publish to GCS step (Plugin E2E: Publish report to cloud storage #645 (review))
22. Plugin E2E: Enable assertion on panel data #688
    minor release released +3
    
23. Bug: Fix broken selectors in Explore page #728
    +0
    
24. Plugin-E2E: Docs #731
    10 of 10
    enhancement type/epic +2
    

Solution

See grafana/grafana#77484.

Alternatives

No response

Additional context

No response

Are you interested in contributing the solution?

• Yes
• No

[yesoreyeram]

Good to see that we are improving our E2E suite. BTW, did we consider breaking this into sub categories such as datasources e2e and panels e2e. By that way, we can understand what is important for different type of plugins. Also it would be nice if we can recommend series of scenarios to test for datasource developers such as how to test config editors for various scenarios, how to test query editors and query responses. Also it would be nice if we can come up with some guidelines on what a datasource developer should test and shouldn't test. ( by accident, it is easy that a plugin authors will start testing grafana functionality instead of plugin functionality )

[sunker]

Thanks for feedback @yesoreyeram!

This is somewhat confusing, but this issue just lists actions for this repo. The overall epic is defined in the Grafana repo, and it in turn has an issue that aimed to align on what scenarios plugin-e2e should provide for data source plugins. I shared this in the #grafana-data-sources channel to collect feedback a while back.

But I totally agree with you here - we should provide guidelines on how to E2E test the different kinds of plugins. Me and @sympatheticmoose have made a rough draft of what we'd like to cover in the docs for plugin-e2e:

├── getting-started
│   ├── installation.md
│   └── writing-tests.md
│   ├── ci-github-actions.md
├── guides
│   ├── best-practices.md
│   ├── how-to-test-data-source-plugins.md # frontend and backend
│   └──how-to-test-panel-plugins.md
│   ├── how-to-test-app-plugins.md
│   ├── assertions.md
│   ├── ci.md
│   ├── feature-toggles.md
│   ├── playwright-configuration.md
│   ├── provisioning.md
└── migration
    └── migrating-from-grafana-e2e.md
├── api ref
│   ├── assertions.md
│   ├── classes.md
│   └── fixtures.md

As you can see, we'll walk through testing the different plugin types, best practices and much more in the guides.

[tolzhabayev]

@sunker I think we can close this one?

[sunker]

Yes 👍