Report Generation

[patelutpal]

Is your feature request related to a problem? Please describe.
Not a problem. However, we have customers (internal and external) who are asking for test reports.
For e.g.

• Need a test report that shows a summary of test execution for a release that includes only test case title, and PASS/FAIL result.
• Need a report of all the test cases for a particular test plan and/or product. That may or may not include the body of the test case.

Describe the solution you'd like
Would like a report generation feature, much like the search results, where you can generate a report for Test Cases, Test Plans or Test Runs. What fields are included in the report must be user selectable. For e.g. for a test case report, we may want to include Product Name, Hierarchical Test Plan Structure, Version, Test Case Title, Components, Tags BUT not include the body. This can give a customer an idea of what test case coverage you have for each version of the product and the features introduced in the version.

Where applicable, the report should be exportable to CSV/Excel as well as printable as PDF.

Describe alternatives you've considered
Cant think of any,

Additional context

[atodorov]

Implementation note: https://django-slick-reporting.com/ may be useful here.

The rest needs some more grooming on our side.

[atodorov]

@patelutpal there are several independent items in a single request so I'll try to address them separately as much as possible:

• Need a test report that shows a summary of test execution for a release that includes only test case title, and PASS/FAIL result.

That would be the same filtering options as TELEMETRY -> Testing -> Status matrix but only display the test case names and their statuses in a row. The test case description can be shown as an extendable row. Let's call it "Test execution telemetry".

That's fairly straight-forward to implement and can be prioritized for the next release.

* Need a report of all the test cases for a particular test plan and/or product. That may or may not include the body of the test case.

If you want to see what test cases are included in a particular Product and/or TestPlan that is already available as the Search Test Cases page. With the fix for #3135 it becomes even more useful in the scenario where you have parent-child test plans. So nothing else to do here.

Describe the solution you'd like Would like a report generation feature, much like the search results, where you can generate a report for Test Cases, Test Plans or Test Runs.

This is not easy or straight forward at all. So far I haven't seen a good library that would help us implement similar functionality. In fact there are entire products whose sole purpose is to allow you to build arbitrary charts & reports.

It's very likely that Kiwi TCMS will not be able to deliver a full customization experience at all and probably the best course of action will be towards integration with other products.

For general carts I think the charts designer in Grafana is very useful and it is also a product that's relatively wide-spread in the industry.

I haven't see anything I particularly like or is regarded as widely used around creating tabular reports but also I don't have a need for such functionality so my experience in this area is limited.

What fields are included in the report must be user selectable. For e.g. for a test case report, we may want to include Product Name, Hierarchical Test Plan Structure, Version, Test Case Title, Components, Tags BUT not include the body. This can give a customer an idea of what test case coverage you have for each version of the product and the features introduced in the version.

I've extracted this into #3149

Where applicable, the report should be exportable to CSV/Excel

That's extracted into #3150

as well as printable as PDF.

FTR "Print to PDF" is available in every modern browser so nothing to do on this front.

[patelutpal]

@atodorov
Suggested enhancements to the Search Pages..