diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/MasterProcessChannelEncoder.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/MasterProcessChannelEncoder.java index c2c4886ba2..193929504d 100644 --- a/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/MasterProcessChannelEncoder.java +++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/MasterProcessChannelEncoder.java @@ -34,49 +34,168 @@ */ public interface MasterProcessChannelEncoder { + /** + * @return {@code true} if the encoder's stream has got an error + */ boolean checkError(); + /** + * Called on JVM exit error. + */ void onJvmExit(); + /** + * System properties after the test set has finished. + * + * @param sysProps system properties handled after the test set tear down + * @param runMode the run mode of particular test set + * @param testRunId the test set identification + */ void systemProperties( Map sysProps, RunMode runMode, Long testRunId ); + /** + * The test set has started. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testSetStarting( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test set has finished. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testSetCompleted( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test has started. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testStarting( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test has succeeded. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testSucceeded( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test has failed. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testFailed( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test is skipped. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testSkipped( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test error. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testError( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * The test assumption failure. + * + * @param reportEntry test set report entry + * @param trimStackTraces {@code true} if stack trace trimming + */ void testAssumptionFailure( ReportEntry reportEntry, boolean trimStackTraces ); + /** + * Test output, a line or characters. + * + * @param reportEntry std/out or std/err context + */ void testOutput( TestOutputReportEntry reportEntry ); + /** + * Info log. + * + * @param msg message of info logger + */ void consoleInfoLog( String msg ); + /** + * Error log. + * + * @param msg message of error logger + */ void consoleErrorLog( String msg ); + /** + * Error log. + * + * @param t exception + */ void consoleErrorLog( Throwable t ); + /** + * Error log. + * + * @param msg additional error message + * @param t exception + */ void consoleErrorLog( String msg, Throwable t ); + /** + * Error log. + * + * @param stackTraceWriter printable stack trace + * @param trimStackTraces {@code true} if selected trimmed stack trace to print into encoder channel/stream + */ void consoleErrorLog( StackTraceWriter stackTraceWriter, boolean trimStackTraces ); + /** + * Debug log. + * + * @param msg message of debug logger + */ void consoleDebugLog( String msg ); + /** + * Warning log. + * + * @param msg message of warning logger + */ void consoleWarningLog( String msg ); + /** + * Say BYE on exit. + * ForkBooter will consequently wait for BYE_ACK command which finally drains the (std/in) sink channel. + */ void bye(); + /** + * The provider wants to stop the progress. + */ void stopOnNextTest(); + /** + * The provider acquires a new test set to run. + */ void acquireNextTest(); + /** + * ForkedBooter tear down has failed while waiting for BYE_ACK command. + * + * @param stackTraceWriter printable stack trace + * @param trimStackTraces {@code true} if selected trimmed stack trace to print into encoder channel/stream + */ void sendExitError( StackTraceWriter stackTraceWriter, boolean trimStackTraces ); }