Skip to content
This repository has been archived by the owner on Oct 20, 2023. It is now read-only.

Pulling test-doc extension for ReportNG #22

Closed
wants to merge 16 commits into from

Conversation

kubamarchwicki
Copy link

Hi there,
I've come across the ReportNG and I found it pretty useful. I used it to generated human readable test documentation.
The project I was involved in had fallen into a CMMI bucket and we had to comply to several procedures - one of which was to document test results. ReportNG didn't work out of the box for me, so I've extended it a bit (keeping in mind the backward compatibility). Things I've required and which I've added to the ReportNG include:

  • I needed to filter which classes are included in the report. We only included IntegrationTests so I've added a parameter "org.uncommons.reportng.name-suffix" which I use to filter out classes I don't want
  • I needed human readable class names so I've allowed to define custom utils class with "org.uncommons.reportng.custom-utils-class". This is instantized within AbstractReporter, with the default Utils class being a fallback.
  • with "org.uncommons.reportng.templates-path" you can define separate path for templates.

That way I was able to create a separate jar: reportng-testdoc which included all my project specific templates, styles and classes. Which has it's own dependencies (like QDox to resolve parameter names) and my own formatter.

The changes are described in the README.txt as well

Thanks. I found ReportNG really useful. It saved me and my team weeks of boring copy and paste from console to Word document to feed the CMMI monster ;-)
Jakub

kubamarchwicki and others added 16 commits November 23, 2011 21:54
* TestDox formatter (substitute class and method names with a human readable form)
* define formatter with configuration parameter "org.uncommons.reportng.name-formatter"
* allow tests filtering (only classes matching "org.uncommons.reportng.name-suffix" will be included in the report)
* hacking velocity templates to parse the names
…ameters names and adding them to method arguments in the report. Reporting layout changes
…g the original reportng flexible an pluggable (DummyFormatter, extending ReportNGUtils)
…ommons.reportng.name-suffix system property optional
….html.vm path. Parametrizing templates_path in config with "org.uncommons.reportng.templates-path"
…urce folder for test classes, if source is not found, the parameter names are ignored.
@dwdyer dwdyer closed this Dec 3, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants