[MPIR-445] Rendering content log junk during plugin's unit tests execution

[jira-importer]

Elliotte Rusty Harold opened MPIR-445 and commented

(Edit/clarification) When running mvn test of this plugin source code, unit tests have unwanted logs that hide Surefire results messages, like

[INFO] Running org.apache.maven.report.projectinfo.PluginManagementReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.662 s - in org.apache.maven.report.projectinfo.PluginManagementReportTest

 

Another log message that's unneeded and simply clutters the output:

[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.

Reduce to debug or remove completely.

---

No further details from MPIR-445

[jira-importer]

Michael Osipov commented

Hervé Boutemy

[jira-importer]

Hervé Boutemy commented

I don't see this in MPIR output but MSITE output

and I don't get how it's unneeded nor clutters output: skin is an important aspect of site rendering

please show a global output to explain your judgements

[jira-importer]

Michael Osipov commented

Same opinion

[jira-importer]

Elliotte Rusty Harold commented

I saw it in the MPIR test output, but if it's coming from the Maven site plugin I'll move the issue there.

Wherever it comes from, it's still unactionable, unimportant information that Maven users don't care about probably more than 99% of the time. I certainly didn't need it when it showed up in failures I was trying to debug. It just gets in the way. In the extremely rare case where someone might need to know what the skin is, they can look in the pom.xml. Not every piece of data that's available to the running program should be shown to the user. As William Strunk famously said, "Omit Needless Words. Omit Needless Words. Omit Needless Words. "

[jira-importer]

Hervé Boutemy commented

I disagree:

• it's not in pom.xml but site.xml
• there is a default value when omitted that people don't know about
• yes, it's not about debugging failure, but about understanding the magic that happens when rendering a site
• it costs 1 info line of info that is worth it: for sure, not "junk"

again, please show it int the global output of a m-site-p run (or something else if you saw in in another context: when the report is invoked as a direct goal, it could be maven-reporting-impl that does the equivalent site rendering), move it eventually to the right Jira project, and we'll see what is noisy and what is info about the running process

But out of context, I just see bad unjustified judgement without clear view on the context

[jira-importer]

Michael Osipov commented

Hervé Boutemy, +1.

[jira-importer]

Elliotte Rusty Harold commented

Run mvn test on maven-project-info-reports-plugin. By my count that log message appears 17 times:

[INFO] Running org.apache.maven.report.projectinfo.MailingListsReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[WARNING] Invalid mailing list link provided 'test at maven.apache.org': Illegal character in path at index 4: test at maven.apache.org
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.094 s - in org.apache.maven.report.projectinfo.MailingListsReportTest
[INFO] Running org.apache.maven.report.projectinfo.ScmReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.336 s - in org.apache.maven.report.projectinfo.ScmReportTest
[INFO] Running org.apache.maven.report.projectinfo.DependencyManagementReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.158 s - in org.apache.maven.report.projectinfo.DependencyManagementReportTest
[INFO] Running org.apache.maven.report.projectinfo.PluginManagementReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.662 s - in org.apache.maven.report.projectinfo.PluginManagementReportTest
[INFO] Running org.apache.maven.report.projectinfo.DependencyConvergenceReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.189 s - in org.apache.maven.report.projectinfo.DependencyConvergenceReportTest
[INFO] Running org.apache.maven.report.projectinfo.ModulesReportTest
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.242 s - in org.apache.maven.report.projectinfo.ModulesReportTest
[INFO] Running org.apache.maven.report.projectinfo.IndexReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.147 s - in org.apache.maven.report.projectinfo.IndexReportTest
[INFO] Running org.apache.maven.report.projectinfo.IssueManagementReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.122 s - in org.apache.maven.report.projectinfo.IssueManagementReportTest
[INFO] Running org.apache.maven.report.projectinfo.CiManagementReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.226 s - in org.apache.maven.report.projectinfo.CiManagementReportTest
[INFO] Running org.apache.maven.report.projectinfo.SummaryReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.116 s - in org.apache.maven.report.projectinfo.SummaryReportTest
[INFO] Running org.apache.maven.report.projectinfo.TeamReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.176 s - in org.apache.maven.report.projectinfo.TeamReportTest
[INFO] Running org.apache.maven.report.projectinfo.LicensesReportTest
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.
[INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin.

[jira-importer]

Michael Osipov commented

...and that is correct because there are multiple standalone invocations of the reporting plugin.

[jira-importer]

Hervé Boutemy commented

it's during unit tests execution in Surefire?

I really did not expect that looking at plugin build could trigger that issue: we don't care about unit tests output, it's not by looking at these that the output of real use has to be evaluated

[jira-importer]

Michael Osipov commented

Hervé Boutemy, yes with Maven Plugin Testing it runs the mojos are UTs, therefore, each test method is one m-r-impl invocation with searching for the skin.

[jira-importer]

Hervé Boutemy commented

more importantly: we don't care about UT output

issue is definitively candidate to close

[jira-importer]

Michael Osipov commented

Hervé Boutemy, correct.

[jira-importer]

Elliotte Rusty Harold commented

I respectfully disagree. We do care about unit test output. A far too often ignored principle of TDD is that passing tests generate no output, and Maven gets that so, so wrong. It makes testing and debugging far more onerous than it needs to be.

In this case, I do see that the issue can move to the site plugin. I still maintain that this log message is unactionable and unimportant and therefore should be eliminated. The content of this message has no effect. It's a no-op. Whether it says "Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.3 skin" or "Rendering strawberries with extra cream" the user does exactly the same thing with the info: nothing. It simply doesn't matter so it should go.

[jira-importer]

Michael Osipov commented

For non-test this is relevant. We cannot selectively disable it and it is not in Maven Site Plugin.

[jira-importer]

Hervé Boutemy commented

In this case, I do see that the issue can move to the site plugin

we got to the conclusion the message was written by the plugin run as goal, then no, maven-site-plugin has nothing to do with it

We do care about unit test output. A far too often ignored principle of TDD is that passing tests generate no output

I do agree, even if I don't know how we can do it

First, I'll update the issue description, because that's really not obvious that the issue is for plugins's build unit test output, not for normal end-users using the plugin

Then ideas welcome on how to update the plugins's unit-test code to redirect logging outside of System.out: I don't know if it's feasible or not