Package org.apache.maven.surefire.booter

Class ForkingRunListener

  • All Implemented Interfaces:
    ConsoleLogger, ConsoleOutputReceiver, ConsoleStream, RunListener
    public class ForkingRunListener
extends java.lang.Object
implements RunListener, ConsoleLogger, ConsoleOutputReceiver, ConsoleStream
    Encodes the full output of the test run to the stdout stream.
    This class and the ForkClient contain the full definition of the "wire-level" protocol used by the forked process. The protocol is *not* part of any public api and may change without further notice.
    This class is threadsafe.
    The synchronization in the underlying PrintStream (target instance) is used to preserve thread safety of the output stream. To perform multiple writes/prints for a single request, they must synchronize on "target" variable in this class.

    • Constructor Detail

      • ForkingRunListener

        public ForkingRunListener​(java.io.PrintStream target,
                          int testSetChannelId,
                          boolean trimStackTraces)

    • Method Detail

      • testSetStarting

        public void testSetStarting​(TestSetReportEntry report)
        Description copied from interface: RunListener
        Indicates the start of a given test-set
        Specified by:
        testSetStarting in interface RunListener
        Parameters:
        report - the report entry describing the testset

      • testSetCompleted

        public void testSetCompleted​(TestSetReportEntry report)
        Description copied from interface: RunListener
        Indicates end of a given test-set
        Specified by:
        testSetCompleted in interface RunListener
        Parameters:
        report - the report entry describing the testset

      • testStarting

        public void testStarting​(ReportEntry report)
        Description copied from interface: RunListener
        Event fired when a test is about to start
        Specified by:
        testStarting in interface RunListener
        Parameters:
        report - The report entry to log for

      • testSucceeded

        public void testSucceeded​(ReportEntry report)
        Description copied from interface: RunListener
        Event fired when a test ended successfully
        Specified by:
        testSucceeded in interface RunListener
        Parameters:
        report - The report entry to log for

      • testAssumptionFailure

        public void testAssumptionFailure​(ReportEntry report)
        Description copied from interface: RunListener
        Event fired when a test assumption failure was encountered. An assumption failure indicates that the test is not relevant
        Specified by:
        testAssumptionFailure in interface RunListener
        Parameters:
        report - The report entry to log for

      • testError

        public void testError​(ReportEntry report)
        Description copied from interface: RunListener
        Event fired when a test ended with an error (non anticipated problem)
        Specified by:
        testError in interface RunListener
        Parameters:
        report - The report entry to log for

      • testFailed

        public void testFailed​(ReportEntry report)
        Description copied from interface: RunListener
        Event fired when a test ended with a failure (anticipated problem)
        Specified by:
        testFailed in interface RunListener
        Parameters:
        report - The report entry to log for

      • testSkipped

        public void testSkipped​(ReportEntry report)
        Description copied from interface: RunListener
        Event fired when a test is skipped
        Specified by:
        testSkipped in interface RunListener
        Parameters:
        report - The report entry to log for

      • testExecutionSkippedByUser

        public void testExecutionSkippedByUser()
        Description copied from interface: RunListener
        Event fired skipping an execution of remaining test-set in other fork(s); or does nothing if no forks. The method is called by SurefireProvider.

        (The event is fired after the Nth test failed to signal skipping the rest of test-set.)

        Specified by:
        testExecutionSkippedByUser in interface RunListener

      • sendProps

        private void sendProps()

      • writeTestOutput

        public void writeTestOutput​(byte[] buf,
                            int off,
                            int len,
                            boolean stdout)
        Description copied from interface: ConsoleOutputReceiver
        Forwards process output from the running test-case into the reporting system
        Specified by:
        writeTestOutput in interface ConsoleOutputReceiver
        Parameters:
        buf - the buffer to write
        off - offset
        len - len
        stdout - Indicates if this is stdout

      • createHeader

        public static byte[] createHeader​(byte booterCode,
                                  int testSetChannel)

      • log

        private void log​(byte bootCode,
                 java.lang.String message)

      • debug

        public void debug​(java.lang.String message)
        Specified by:
        debug in interface ConsoleLogger

      • info

        public void info​(java.lang.String message)
        Specified by:
        info in interface ConsoleLogger

      • warning

        public void warning​(java.lang.String message)
        Specified by:
        warning in interface ConsoleLogger

      • error

        public void error​(java.lang.String message)
        Specified by:
        error in interface ConsoleLogger
        Parameters:
        message - message to log

      • error

        public void error​(java.lang.String message,
                  java.lang.Throwable t)
        Description copied from interface: ConsoleLogger
        Simply delegates to error( toString( t, message ) ).
        Specified by:
        error in interface ConsoleLogger
        Parameters:
        message - message to log
        t - exception, message and trace to log

      • encodeAndWriteToTarget

        private void encodeAndWriteToTarget​(java.lang.String string)

      • toPropertyString

        private java.lang.String toPropertyString​(java.lang.String key,
                                          java.lang.String value)

      • toString

        private java.lang.String toString​(byte operationCode,
                                  ReportEntry reportEntry,
                                  int testSetChannelId)

      • comma

        private static void comma​(java.lang.StringBuilder stringBuilder)

      • append

        private void append​(java.lang.StringBuilder stringBuilder,
                    java.lang.String message)

      • append

        private void append​(java.lang.StringBuilder stringBuilder,
                    byte b)

      • nullableEncoding

        private void nullableEncoding​(java.lang.StringBuilder stringBuilder,
                              java.lang.Integer source)

      • encode

        private java.lang.String encode​(java.lang.String source)

      • nullableEncoding

        private static void nullableEncoding​(java.lang.StringBuilder stringBuilder,
                                     java.lang.String source)

      • encode

        private void encode​(java.lang.StringBuilder stringBuilder,
                    StackTraceWriter stackTraceWriter)

      • encode

        public static void encode​(java.lang.StringBuilder stringBuilder,
                          StackTraceWriter stackTraceWriter,
                          boolean trimStackTraces)

      • println

        public void println​(java.lang.String message)
        Specified by:
        println in interface ConsoleStream

      • println

        public void println​(byte[] buf,
                    int off,
                    int len)
        Specified by:
        println in interface ConsoleStream