OpenLiberty / open-liberty

Open Liberty is a highly composable, fast to start, dynamic application server runtime environment
https://openliberty.io
Eclipse Public License 2.0
1.15k stars 589 forks source link

FAT Approval Test Summary for Publish a standalone Open Liberty Grafana dashboard to grafana.com #11393

Closed kabicin closed 4 years ago

kabicin commented 4 years ago

1) Describe the test strategy & approach for this feature, and describe how the approach verifies the functions delivered by this feature. The description should include the positive and negative testing done, whether all testing is automated, what manual tests exist (if any) and where the tests are stored (source control). Automated testing is expected for all features with manual testing considered an exception to the rule.

To preface, the Grafana dashboard visualizes mpMetrics-2.x data for standalone Open Liberty servers. In our specific scenario we have chosen manual testing over automated testing for the following reasons.

Firstly, we have no effective way to manage or create automated tests for the Grafana dashboard since it is not a part of the Liberty product. In addition, automatic tests would be hard to control. Performing equality operations on time-series data that is often system-dependent (i.e. Process CPU Time could be lower for faster CPUs), would be difficult to analyze and makes such tests hard to create.

The manual test factors:

2) Collectively as a team you need to assess your confidence in the testing delivered based on the values below. This should be done as a team and not an individual to ensure more eyes are on it and that pressures to deliver quickly are absorbed by the team as a whole.

0 - No automated testing delivered

We are confident that our manual testing is sufficient to maintain the current Grafana dashboard overtime. Our team collectively assessed the reliability of our custom Prometheus queries and overall dashboard through multiple live demos within meetings and also through email discussion. Showing the dashboard to the team in this case means sharing the dashboard to IBMers who have worked with or are currently working with MicroProfile Metrics and to the WebSphere Observability architect. We are aware that we will be the first to use the IBM ID, "openlibertyproject" through grafana.com and so the update process of this dashboard has been adjusted within our team's internal repository.

dave-waddling commented 4 years ago

Hi @kabicin,

Thanks for completing the Feature Test Summary. I agree that having no automated testing makes sense here and the manual testing seems more than sufficient. I'll add the FAT Focal Approval to the parent epic at this time.