Gradle How to Display Test Results in the Console in Real Time

Question

I would like to see test results   system out err  log messages from components being tested   as they run in the same console I run   gradle test   And not wait until tests are done to look at the test reports   that are only generated when tests are completed  so I can t  tail -f  anything while tests are running

User · Answer

In Gradle using Android plugin   gradle projectsEvaluated       tasks withType Test    task - gt          task afterTest   desc  result - gt              println  Executing test   desc name     desc className   with result    result resultType                       Then the output will be      Executing test testConversionMinutes  org example app test DurationTest  with result  SUCCESS

User · Answer

Just add the following closure to your build gradle  the output will be printed after the execution of every test  test      useJUnitPlatform       afterTest   desc  result - gt          def output    quot Class name    desc className   Test name    desc name     Test status    result resultType   quot          println    n    output

User · Answer

Disclaimer  I am the developer of the Gradle Test Logger Plugin   You can simply use the Gradle Test Logger Plugin to print beautiful logs on the console  The plugin uses sensible defaults to satisfy most users with little or no configuration but also offers a number of themes and configuration options to suit everyone   Examples   Standard theme   Mocha theme  Usage  plugins       id  com adarshr test-logger  version   lt version gt       Make sure you always get the latest version from Gradle Central   Configuration  You don t need any configuration at all  However  the plugin offers a few options  This can be done as follows  default values shown    testlogger          pick a theme - mocha  standard  plain  mocha-parallel  standard-parallel or plain-parallel     theme  standard          set to false to disable detailed failure logs     showExceptions true         set to false to hide stack traces     showStackTraces true         set to true to remove any filtering applied to stack traces     showFullStackTraces false         set to false to hide exception causes     showCauses true         set threshold in milliseconds to highlight slow tests     slowThreshold 2000         displays a breakdown of passes  failures and skips along with total duration     showSummary true         set to true to see simple class names     showSimpleNames false         set to false to hide passed tests     showPassed true         set to false to hide skipped tests     showSkipped true         set to false to hide failed tests     showFailed true         enable to see standard out and error streams inline with the test results     showStandardStreams false         set to false to hide passed standard out and error streams     showPassedStandardStreams true         set to false to hide skipped standard out and error streams     showSkippedStandardStreams true         set to false to hide failed standard out and error streams     showFailedStandardStreams true     I hope you will enjoy using it

User · Answer

Following on from Benjamin Muschko s answer  19 March 2011   you can use the -i flag along with grep  to filter out 1000s of unwanted lines  Examples  Strong filter - Only display each unit test name and test result and the overall build status  Setup errors or exceptions are not displayed    gradlew test -i   grep -E  quot   gt   BUILD quot    Soft filter - Display each unit test name and test result  as well as setup errors exceptions  But it will also include some irrelevant info    gradlew test -i   grep -E -v  quot  Executing   Creating   Parsing   Using   Merging   Download   title Compiling  AAPT  future   task   app  V InstrumentationResultParser  quot   Soft filter  Alternative syntax   search tokens are split into individual strings    gradlew test -i   grep -v -e  quot  Executing  quot  -e  quot  Creating  quot  -e  quot  Parsing  quot  -e  quot  Using  quot  -e  quot  Merging  quot  -e  quot  Download  quot  -e  quot  title Compiling quot  -e  quot  AAPT quot  -e  quot  future  quot  -e  quot  task  quot  -e  quot  app  quot  -e  quot V InstrumentationResultParser  quot    Explanation of how it works  The first command is   gradlew test -i and  quot -i quot  means  quot Info Verbose quot  mode  which prints the result of each test in real-time  but also displays large amounts of unwanted debug lines  So the output of the first command    gradlew test -i  is piped to a second command grep  which will filter out many unwanted lines  based on a regular expression   quot -E quot  enables the regular expression mode for a single string   quot -e quot  enables regular expressions for multiple strings  and  quot   quot  in the regex string means  quot or quot   In the strong filter  a unit test name and test result is allowed to display using  quot   gt   quot   and the overall status is allowed with  quot BUILD quot   In the soft filter  the  quot -v quot  flag means  quot not containing quot  and  quot   quot  means  quot start of line quot   So it strips out all lines that start with  quot Executing  quot  or start with  quot Creating  quot   etc   Example for Android instrumentation unit tests  with gradle 5 1    gradlew connectedDebugAndroidTest --continue -i   grep -v -e        quot  Transforming  quot  -e  quot  Skipping  quot  -e  quot  Cache  quot  -e  quot  Performance  quot  -e  quot  Creating  quot  -e        quot  Parsing  quot  -e  quot  file  quot  -e  quot ddms   quot  -e  quot  app  quot  -e  quot V InstrumentationResultParser  quot   Example for Jacoco unit test coverage  with gradle 4 10    gradlew createDebugCoverageReport --continue -i   grep -E -v  quot  Executing   Creating   Parsing   Using   Merging   Download   title Compiling  AAPT  future   task   app  V InstrumentationResultParser  quot

User · Answer

As stefanglase answered   adding the following code to your build gradle  since version 1 1  works fine for output on passed  skipped and failed tests   test       testLogging           events  passed    skipped    failed    standardOut    standardError            What I want to say additionally  I found out this is a problem for starters  is that the gradle test command executes the test only one time per change    So if you are running it the second time there will be no output on test results  You can also see this in the building output  gradle then says UP-TO-DATE on tests  So its not executed a n-th time    Smart gradle   If you want to force the test cases to run  use gradle cleanTest test   This is slightly off topic but I hope it will help some newbies   edit  As sparc spread stated in the comments   If you want to force gradle to always run fresh tests  which might not always be a good idea  you can add outputs upToDateWhen  false  to testLogging            Continue reading here   Peace

User · Answer

test  task does not work for Android plugin  for Android plugin use the following      Test Logging tasks withType Test        testLogging           events  started    passed    skipped    failed            See the following  https   stackoverflow com a 31665341 3521637

User · Answer

Here is my fancy version     import org gradle api tasks testing logging TestExceptionFormat import org gradle api tasks testing logging TestLogEvent  tasks withType Test        testLogging              set options for log level LIFECYCLE         events TestLogEvent FAILED                 TestLogEvent PASSED                 TestLogEvent SKIPPED                 TestLogEvent STANDARD OUT         exceptionFormat TestExceptionFormat FULL         showExceptions true         showCauses true         showStackTraces true             set options for log level DEBUG and INFO         debug               events TestLogEvent STARTED                     TestLogEvent FAILED                     TestLogEvent PASSED                     TestLogEvent SKIPPED                     TestLogEvent STANDARD ERROR                     TestLogEvent STANDARD OUT             exceptionFormat TestExceptionFormat FULL                   info events   debug events         info exceptionFormat   debug exceptionFormat          afterSuite   desc  result - gt              if   desc parent       will match the outermost suite                 def output    Results    result resultType     result testCount  tests    result successfulTestCount  passed    result failedTestCount  failed    result skippedTestCount  skipped                   def startItem          endItem                         def repeatLength   startItem length     output length     endItem length                   println   n      -    repeatLength      n    startItem   output   endItem     n      -    repeatLength

User · Answer

If you are using jupiter and none of the answers work  consider verifying it is setup correctly  test       useJUnitPlatform       outputs upToDateWhen   false      dependencies       testImplementation  org junit jupiter junit-jupiter-api 5 7 0      testRuntimeOnly  org junit jupiter junit-jupiter-engine 5 7 0     And then try the accepted answers

User · Answer

If you have a build gradle kts written in Kotlin DSL you can print test results with  I was developing a kotlin multi-platform project  with no  java  plugin applied    tasks withType lt AbstractTestTask gt        afterSuite KotlinClosure2   desc  TestDescriptor  result  TestResult - gt          if  desc parent    null       will match the outermost suite             println  Results    result resultType     result testCount  tests    result successfulTestCount  successes    result failedTestCount  failures    result skippedTestCount  skipped

User · Answer

Merge of Shubham s great answer and JJD use enum instead of string  tasks withType Test       testLogging             set options for log level LIFECYCLE        events TestLogEvent PASSED              TestLogEvent SKIPPED  TestLogEvent FAILED  TestLogEvent STANDARD OUT        showExceptions true        exceptionFormat TestExceptionFormat FULL        showCauses true        showStackTraces true         set options for log level DEBUG and INFO        debug           events TestLogEvent STARTED  TestLogEvent PASSED  TestLogEvent SKIPPED  TestLogEvent FAILED  TestLogEvent STANDARD OUT  TestLogEvent STANDARD ERROR         exceptionFormat TestExceptionFormat FULL                 info events   debug events        info exceptionFormat   debug exceptionFormat         afterSuite   desc  result - gt             if   desc parent       will match the outermost suite                def output    Results    result resultType     result testCount  tests    result successfulTestCount  successes    result failedTestCount  failures    result skippedTestCount  skipped                  def startItem          endItem                        def repeatLength   startItem length     output length     endItem length                  println   n      -    repeatLength      n    startItem   output   endItem     n      -    repeatLength

User · Answer

My favourite minimalistic version based on Shubham Chaudhary answer    Put this in build gradle file   test       afterSuite   desc  result - gt      if   desc parent          println    result resultType                      result testCount  tests                     result successfulTestCount  successes                     result failedTestCount  failures                     result skippedTestCount  skipped

User · Answer

For those using Kotlin DSL  you can do  tasks     named lt Test gt   quot test quot         testLogging showStandardStreams   true

User · Answer

You can add a Groovy closure inside your build gradle file that does the logging for you   test       afterTest   desc  result - gt           logger quiet  Executing test   desc name     desc className   with result    result resultType             On your console it then reads like this    compileJava UP-TO-DATE  compileGroovy  processResources  classes  jar  assemble  compileTestJava  compileTestGroovy  processTestResources  testClasses  test Executing test maturesShouldBeCharged11DollarsForDefaultMovie  movietickets MovieTicketsTests  with result  SUCCESS Executing test studentsShouldBeCharged8DollarsForDefaultMovie  movietickets MovieTicketsTests  with result  SUCCESS Executing test seniorsShouldBeCharged6DollarsForDefaultMovie  movietickets MovieTicketsTests  with result  SUCCESS Executing test childrenShouldBeCharged5DollarsAnd50CentForDefaultMovie  movietickets MovieTicketsTests  with result  SUCCESS  check  build   Since version 1 1 Gradle supports much more options to log test output  With those options at hand you can achieve a similar output with the following configuration   test       testLogging           events  passed    skipped    failed

User · Answer

You could run Gradle with INFO logging level on the command line  It ll show you the result of each test while they are running  Downside is that you will get far more output for other tasks also   gradle test -i

User · Answer

As a follow up to Shubham s great answer I like to suggest using enum values instead of strings  Please take a look at the documentation of the TestLogging class   import org gradle api tasks testing logging TestExceptionFormat import org gradle api tasks testing logging TestLogEvent  tasks withType Test        testLogging           events TestLogEvent FAILED                 TestLogEvent PASSED                 TestLogEvent SKIPPED                 TestLogEvent STANDARD ERROR                 TestLogEvent STANDARD OUT         exceptionFormat TestExceptionFormat FULL         showCauses true         showExceptions true         showStackTraces true

User · Answer

Add this to build gradle to stop gradle from swallowing stdout and stderr   test       testLogging showStandardStreams   true     It s documented here

[testing] Gradle: How to Display Test Results in the Console in Real Time?

Examples related to testing

Examples related to console

Examples related to gradle