Reduce log level of test Gradle projects #3717
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adam-enko
added
the
runner: Gradle plugin
adam-enko
changed the base branch from
master
to
adam/feat/enable-build-cache-in-integration-tests
adam-enko
force-pushed
the
adam/feat/reduce-gradle-testkit-logging
branch
3 times, most recently
from
edb72b0
to
c8a1296
Compare
adam-enko
changed the title
Base automatically changed from
adam/feat/enable-build-cache-in-integration-tests
to
master
August 1, 2024 15:01
adam-enko
force-pushed
the
adam/feat/reduce-gradle-testkit-logging
branch
2 times, most recently
from
b7010d2
to
ac13a82
Compare
### Motivation Too many logs when using Gradle TestKit causes the tests to run slower. This is mainly because Gradle TestKit stores logs in-memory (see gradle/gradle#23965). Reducing the amount of logging would be beneficial for two reasons: - The tests can run faster. - The logs are not cluttered with unimportant messages from other Gradle tasks. We can focus on the Dokka Generator logs. However, reducing the log level to 'lifecycle' would mean that the Dokka Generator logs would not be reported. To work around this, I added an internal flag that can override the default log level of Dokka Generator. The result is that the tests run faster, and test results are easier to read and verify. ### Summary of changes - Reduce the log-level of Gradle tests to 'lifecycle' by default (this can be overridden if necessary). - Introduce an internal flag, `dokka.internal.dokkaGenerator.logLevelOverride`, in AbstractDokkaTask that can re-direct the logs of Dokka Generator to a specific level, independent from the Gradle log level. - Correctly enable `--stacktrace` on all tests, and enable it by default for all tests. ^OSIP-355
adam-enko
force-pushed
the
adam/feat/reduce-gradle-testkit-logging
branch
from
ac13a82
to
8cf4514
Compare
whyoleg
approved these changes
Aug 5, 2024
...-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt
Outdated
Show resolved
Hide resolved
...-gradle-plugin-classic/src/main/kotlin/org/jetbrains/dokka/gradle/tasks/AbstractDokkaTask.kt
Outdated
Show resolved
Hide resolved
| override fun accept(level: String, message: String) { | ||
| if (overrideLogger != null) { | ||
| // when an override level is set, re-route all the messages | ||
| overrideLogger.invoke(message) |
There was a problem hiding this comment.
I'm not sure how I feel (love or hate), that when overriding logger level we will print all messages (even debug), but let's try :)
dkrasnoff
approved these changes
Aug 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Too many logs when using Gradle TestKit causes the tests to run slower. This is mainly because Gradle TestKit stores logs in-memory (see gradle/gradle#23965).
Reducing the amount of logging would be beneficial for two reasons:
However, reducing the log level to 'lifecycle' would mean that the Dokka Generator logs would not be reported. To work around this, I added an internal flag that can override the default log level of Dokka Generator.
The result is that the tests run faster, and test results are easier to read and verify.
Summary of changes
dokka.internal.gradle.dokkaGenerator.logLevelOverride, in AbstractDokkaTask that can re-direct the logs of Dokka Generator to a specific level, independent from the Gradle log level.--stacktraceon all tests, and enable it by default for all tests.^OSIP-355
Depends on