chore(Java): disable verbose unit test logging #948
Conversation
| // Disable Verbose test logging to make the LocalCMCTests less flaky. | ||
| // It is hard to log 300k messages to a terminal, | ||
| // particularly if 10 threads are concurrently writing to the terminal. | ||
| // testLogging { | ||
| // lifecycle { | ||
| // events = mutableSetOf(org.gradle.api.tasks.testing.logging.TestLogEvent.FAILED, org.gradle.api.tasks.testing.logging.TestLogEvent.PASSED, org.gradle.api.tasks.testing.logging.TestLogEvent.SKIPPED) | ||
| // exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL | ||
| // showExceptions = true | ||
| // showCauses = true | ||
| // showStackTraces = true | ||
| // showStandardStreams = true | ||
| // } | ||
| // info.events = lifecycle.events | ||
| // info.exceptionFormat = lifecycle.exceptionFormat | ||
| // } |
There was a problem hiding this comment.
Why not just remove this instead of commenting?
There was a problem hiding this comment.
Because if a test fails,
it is very helpful to know what it is.
Which this lifecycle logging helps with.
Locally, the logs are not that helpful,
as TestNG will write a test report HTML.
But that report is not available from GitHub CI.
Only the logs are.
Hence, it is nice to leave this comment block in case someone needs it in the future.
There was a problem hiding this comment.
Then maybe use a flag or disable the params that control this? Maybe this can help: https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/logging/TestExceptionFormat.html#SHORT
I'm afraid that by commenting it out, we are creating a precedence that it's okay to comment out code for "future" use case. And have seen this in our code base. If nothing else, we can remove this and add link to the gradle doc.
Issue #, if available:
Description of changes:
Disable Verbose test logging to make the LocalCMCTests less flaky.
It is hard to log 300k messages to a terminal,
particularly if 10 threads are concurrently writing to the terminal.
This MAY reduce how often we encounter a LocalCMCTests failure that appears like:
The theory is that by removing the event lifecycle handler from the concurrency testing,
each of the 300k tests completes without triggering the handler.
The assumption is that the event lifecycle handler is a cause for concurrent testing failure.
Squash/merge commit message, if applicable:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.