Class EventChannelEncoder
java.lang.Object
org.apache.maven.surefire.api.stream.AbstractStreamEncoder<ForkedProcessEventType>
org.apache.maven.surefire.booter.stream.EventEncoder
org.apache.maven.surefire.booter.spi.EventChannelEncoder
- All Implemented Interfaces:
MasterProcessChannelEncoder
magic number : opcode : run mode [: opcode specific data]*
- Since:
- 3.0.0-M4
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionThe encoder for events. -
Method Summary
Modifier and TypeMethodDescriptionvoid
The provider acquires a new test set to run.void
bye()
Say BYE on exit.boolean
void
consoleDebugLog
(String message) Debug log.void
consoleErrorLog
(String message) Error log.void
consoleErrorLog
(String message, Throwable t) Error log.void
Error log.void
consoleErrorLog
(StackTraceWriter stackTraceWriter, boolean trimStackTraces) Error log.void
consoleInfoLog
(String message) Info log.void
consoleWarningLog
(String message) Warning log.private void
encode
(CharsetEncoder encoder, ByteBuffer result, String message, String smartStackTrace, String stackTrace) private void
encode
(CharsetEncoder encoder, ByteBuffer result, EventChannelEncoder.StackTrace stw) (package private) ByteBuffer
encode
(ForkedProcessEventType operation, ReportEntry reportEntry, boolean trimStackTraces) Used operations:
ForkedProcessEventType.BOOTERCODE_TESTSET_STARTING
,ForkedProcessEventType.BOOTERCODE_TESTSET_COMPLETED
,ForkedProcessEventType.BOOTERCODE_TEST_STARTING
,ForkedProcessEventType.BOOTERCODE_TEST_SUCCEEDED
,ForkedProcessEventType.BOOTERCODE_TEST_FAILED
,ForkedProcessEventType.BOOTERCODE_TEST_ERROR
,ForkedProcessEventType.BOOTERCODE_TEST_SKIPPED
,ForkedProcessEventType.BOOTERCODE_TEST_ASSUMPTIONFAILURE
.private void
encode
(ForkedProcessEventType operation, ReportEntry reportEntry, boolean trimStackTraces, boolean sync) (package private) ByteBuffer
encodeMessage
(ForkedProcessEventType eventType, String message) (package private) ByteBuffer
encodeMessage
(ForkedProcessEventType eventType, RunMode runMode, Long testRunId, String message) private void
encodeOpcode
(ForkedProcessEventType eventType, boolean sync) (package private) void
private void
error
(StackTraceWriter stackTraceWriter, boolean trimStackTraces, ForkedProcessEventType eventType, boolean sync) void
Called on JVM exit error.void
sendExitError
(StackTraceWriter stackTraceWriter, boolean trimStackTraces) ForkedBooter tear down has failed while waiting for BYE_ACK command.private void
setOutErr
(ForkedProcessEventType eventType, RunMode runMode, Long testRunId, String message) void
The provider wants to stop the progress.void
testAssumptionFailure
(ReportEntry reportEntry, boolean trimStackTraces) The test assumption failure.void
testError
(ReportEntry reportEntry, boolean trimStackTraces) The test error.void
testFailed
(ReportEntry reportEntry, boolean trimStackTraces) The test has failed.void
testOutput
(TestOutputReportEntry reportEntry) Test output, a line or characters.void
testSetCompleted
(TestSetReportEntry reportEntry, boolean trimStackTraces) The test set has finished.void
testSetStarting
(TestSetReportEntry reportEntry, boolean trimStackTraces) The test set has started.void
testSkipped
(ReportEntry reportEntry, boolean trimStackTraces) The test is skipped.void
testStarting
(ReportEntry reportEntry, boolean trimStackTraces) The test has started.void
testSucceeded
(ReportEntry reportEntry, boolean trimStackTraces) The test has succeeded.private static String
toStackTrace
(StackTraceWriter stw, boolean trimStackTraces) protected void
write
(ByteBuffer frame, boolean sync) Methods inherited from class org.apache.maven.surefire.booter.stream.EventEncoder
enumToByteArray, getCharset, getEncodedCharsetName, getEncodedMagicNumber, newCharsetEncoder
Methods inherited from class org.apache.maven.surefire.api.stream.AbstractStreamEncoder
encode, encode, encodeCharset, encodeHeader, encodeHeader, encodeInteger, encodeString, estimateBufferLength
-
Field Details
-
trouble
-
onExit
private volatile boolean onExit
-
-
Constructor Details
-
EventChannelEncoder
The encoder for events.- Parameters:
out
- the channel available for writing the events
-
-
Method Details
-
checkError
public boolean checkError()- Specified by:
checkError
in interfaceMasterProcessChannelEncoder
- Returns:
true
if the encoder's stream has got an error
-
onJvmExit
public void onJvmExit()Description copied from interface:MasterProcessChannelEncoder
Called on JVM exit error.- Specified by:
onJvmExit
in interfaceMasterProcessChannelEncoder
-
encodeSystemProperties
-
testSetStarting
Description copied from interface:MasterProcessChannelEncoder
The test set has started.- Specified by:
testSetStarting
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testSetCompleted
Description copied from interface:MasterProcessChannelEncoder
The test set has finished.- Specified by:
testSetCompleted
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testStarting
Description copied from interface:MasterProcessChannelEncoder
The test has started.- Specified by:
testStarting
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testSucceeded
Description copied from interface:MasterProcessChannelEncoder
The test has succeeded.- Specified by:
testSucceeded
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testFailed
Description copied from interface:MasterProcessChannelEncoder
The test has failed.- Specified by:
testFailed
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testSkipped
Description copied from interface:MasterProcessChannelEncoder
The test is skipped.- Specified by:
testSkipped
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testError
Description copied from interface:MasterProcessChannelEncoder
The test error.- Specified by:
testError
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testAssumptionFailure
Description copied from interface:MasterProcessChannelEncoder
The test assumption failure.- Specified by:
testAssumptionFailure
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- test set report entrytrimStackTraces
-true
if stack trace trimming
-
testOutput
Description copied from interface:MasterProcessChannelEncoder
Test output, a line or characters.- Specified by:
testOutput
in interfaceMasterProcessChannelEncoder
- Parameters:
reportEntry
- std/out or std/err context
-
setOutErr
private void setOutErr(ForkedProcessEventType eventType, RunMode runMode, Long testRunId, String message) -
consoleInfoLog
Description copied from interface:MasterProcessChannelEncoder
Info log.- Specified by:
consoleInfoLog
in interfaceMasterProcessChannelEncoder
- Parameters:
message
- message of info logger
-
consoleErrorLog
Description copied from interface:MasterProcessChannelEncoder
Error log.- Specified by:
consoleErrorLog
in interfaceMasterProcessChannelEncoder
- Parameters:
message
- message of error logger
-
consoleErrorLog
Description copied from interface:MasterProcessChannelEncoder
Error log.- Specified by:
consoleErrorLog
in interfaceMasterProcessChannelEncoder
- Parameters:
t
- exception
-
consoleErrorLog
Description copied from interface:MasterProcessChannelEncoder
Error log.- Specified by:
consoleErrorLog
in interfaceMasterProcessChannelEncoder
- Parameters:
message
- additional error messaget
- exception
-
consoleErrorLog
Description copied from interface:MasterProcessChannelEncoder
Error log.- Specified by:
consoleErrorLog
in interfaceMasterProcessChannelEncoder
- Parameters:
stackTraceWriter
- printable stack tracetrimStackTraces
-true
if selected trimmed stack trace to print into encoder channel/stream
-
consoleDebugLog
Description copied from interface:MasterProcessChannelEncoder
Debug log.- Specified by:
consoleDebugLog
in interfaceMasterProcessChannelEncoder
- Parameters:
message
- message of debug logger
-
consoleWarningLog
Description copied from interface:MasterProcessChannelEncoder
Warning log.- Specified by:
consoleWarningLog
in interfaceMasterProcessChannelEncoder
- Parameters:
message
- message of warning logger
-
bye
public void bye()Description copied from interface:MasterProcessChannelEncoder
Say BYE on exit. ForkBooter will consequently wait for BYE_ACK command which finally drains the (std/in) sink channel.- Specified by:
bye
in interfaceMasterProcessChannelEncoder
-
stopOnNextTest
public void stopOnNextTest()Description copied from interface:MasterProcessChannelEncoder
The provider wants to stop the progress.- Specified by:
stopOnNextTest
in interfaceMasterProcessChannelEncoder
-
acquireNextTest
public void acquireNextTest()Description copied from interface:MasterProcessChannelEncoder
The provider acquires a new test set to run.- Specified by:
acquireNextTest
in interfaceMasterProcessChannelEncoder
-
sendExitError
Description copied from interface:MasterProcessChannelEncoder
ForkedBooter tear down has failed while waiting for BYE_ACK command.- Specified by:
sendExitError
in interfaceMasterProcessChannelEncoder
- Parameters:
stackTraceWriter
- printable stack tracetrimStackTraces
-true
if selected trimmed stack trace to print into encoder channel/stream
-
error
private void error(StackTraceWriter stackTraceWriter, boolean trimStackTraces, ForkedProcessEventType eventType, boolean sync) -
encode
private void encode(ForkedProcessEventType operation, ReportEntry reportEntry, boolean trimStackTraces, boolean sync) -
encodeOpcode
-
write
- Overrides:
write
in classAbstractStreamEncoder<ForkedProcessEventType>
-
encode
-
encode
private void encode(CharsetEncoder encoder, ByteBuffer result, String message, String smartStackTrace, String stackTrace) -
encode
ByteBuffer encode(ForkedProcessEventType operation, ReportEntry reportEntry, boolean trimStackTraces) Used operations:
ForkedProcessEventType.BOOTERCODE_TESTSET_STARTING
,ForkedProcessEventType.BOOTERCODE_TESTSET_COMPLETED
,ForkedProcessEventType.BOOTERCODE_TEST_STARTING
,ForkedProcessEventType.BOOTERCODE_TEST_SUCCEEDED
,ForkedProcessEventType.BOOTERCODE_TEST_FAILED
,ForkedProcessEventType.BOOTERCODE_TEST_ERROR
,ForkedProcessEventType.BOOTERCODE_TEST_SKIPPED
,ForkedProcessEventType.BOOTERCODE_TEST_ASSUMPTIONFAILURE
.
-
encodeMessage
ByteBuffer encodeMessage(ForkedProcessEventType eventType, RunMode runMode, Long testRunId, String message) -
encodeMessage
-
toStackTrace
-