[SUREFIRE-2046] Resolved TODOs. Updated callbacks ForkedProcessPropertyEventListener and ForkedProcessStandardOutErrEventListener.

Tibor17 · Tibor17 · commit db99f166dfdb · 2022-03-27T19:19:05.000+02:00
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java
@@ -211,7 +211,7 @@ public void handle( ReportEntry reportEntry )
     private final class SystemPropertiesListener implements ForkedProcessPropertyEventListener
     {
         @Override
-        public void handle( RunMode runMode, String key, String value )
+        public void handle( String key, String value, RunMode runMode, Long testRunId )
         {
             testVmSystemProperties.put( key, value );
         }
@@ -220,18 +220,18 @@ public void handle( RunMode runMode, String key, String value )
     private final class StdOutListener implements ForkedProcessStandardOutErrEventListener
     {
         @Override
-        public void handle( RunMode runMode, String output, boolean newLine )
+        public void handle( String output, boolean newLine, RunMode runMode, Long testRunId )
         {
-            writeTestOutput( output, newLine, true );
+            writeTestOutput( output, true, newLine, runMode, testRunId );
         }
     }
 
     private final class StdErrListener implements ForkedProcessStandardOutErrEventListener
     {
         @Override
-        public void handle( RunMode runMode, String output, boolean newLine )
+        public void handle( String output, boolean newLine, RunMode runMode, Long testRunId )
         {
-            writeTestOutput( output, newLine, false );
+            writeTestOutput( output, false, newLine, runMode, testRunId );
         }
     }
 
@@ -393,10 +393,10 @@ void dumpToLoFile( String msg )
         util.dumpStreamText( msg, reportsDir, forkNumber );
     }
 
-    private void writeTestOutput( String output, boolean newLine, boolean isStdout )
+    private void writeTestOutput( String output, boolean isStdout, boolean newLine, RunMode runMode, Long testRunId )
     {
         getConsoleOutputReceiver()
-                .writeTestOutput( new TestOutputReportEntry( output, isStdout, newLine, /*todo*/ null, null ) );
+                .writeTestOutput( new TestOutputReportEntry( output, isStdout, newLine, runMode, testRunId ) );
     }
 
     public Map<String, String> getTestVmSystemProperties()
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java
@@ -207,18 +207,20 @@ else if ( event.isStandardStreamCategory() )
             ForkedProcessStandardOutErrEventListener listener = stdOutErrEventListeners.get( eventType );
             if ( listener != null )
             {
-                listener.handle( standardStreamEvent.getRunMode(), standardStreamEvent.getMessage(), newLine );
+                listener.handle( standardStreamEvent.getMessage(), newLine,
+                    standardStreamEvent.getRunMode(), standardStreamEvent.getTestRunId() );
             }
         }
         else if ( event.isSysPropCategory() )
         {
             SystemPropertyEvent systemPropertyEvent = (SystemPropertyEvent) event;
             RunMode runMode = systemPropertyEvent.getRunMode();
+            Long testRunId = systemPropertyEvent.getTestRunId();
             String key = systemPropertyEvent.getKey();
             String value = systemPropertyEvent.getValue();
             if ( propertyEventListener != null )
             {
-                propertyEventListener.handle( runMode, key, value );
+                propertyEventListener.handle( key, value, runMode, testRunId );
             }
         }
         else if ( event.isTestCategory() )
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessPropertyEventListener.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessPropertyEventListener.java
@@ -27,5 +27,5 @@
  */
 public interface ForkedProcessPropertyEventListener
 {
-    void handle( RunMode runMode, String key, String value );
+    void handle( String key, String value, RunMode runMode, Long testRunId );
 }
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessStandardOutErrEventListener.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessStandardOutErrEventListener.java
@@ -27,5 +27,5 @@
  */
 public interface ForkedProcessStandardOutErrEventListener
 {
-    void handle( RunMode runMode, String output, boolean newLine );
+    void handle( String output, boolean newLine, RunMode runMode, Long testRunId );
 }
diff --git a/maven-surefire-common/src/test/java/org/apache/maven/plugin/surefire/extensions/ForkedProcessEventNotifierTest.java b/maven-surefire-common/src/test/java/org/apache/maven/plugin/surefire/extensions/ForkedProcessEventNotifierTest.java
@@ -540,7 +540,7 @@ public void testStdOutStream() throws Exception
 
             ForkedProcessEventNotifier notifier = new ForkedProcessEventNotifier();
             StandardOutErrEventAssertionListener listener =
-                new StandardOutErrEventAssertionListener( NORMAL_RUN, "msg", false );
+                new StandardOutErrEventAssertionListener( NORMAL_RUN, 1L, "msg", false );
             notifier.setStdOutListener( listener );
 
             EH eventHandler = new EH();
@@ -579,7 +579,7 @@ public void testStdOutStreamPrint() throws Exception
 
             ForkedProcessEventNotifier notifier = new ForkedProcessEventNotifier();
             StandardOutErrEventAssertionListener listener =
-                new StandardOutErrEventAssertionListener( NORMAL_RUN, "", false );
+                new StandardOutErrEventAssertionListener( NORMAL_RUN, 1L, "", false );
             notifier.setStdOutListener( listener );
 
             EH eventHandler = new EH();
@@ -618,7 +618,7 @@ public void testStdOutStreamPrintWithNull() throws Exception
 
             ForkedProcessEventNotifier notifier = new ForkedProcessEventNotifier();
             StandardOutErrEventAssertionListener listener =
-                new StandardOutErrEventAssertionListener( NORMAL_RUN, null, false );
+                new StandardOutErrEventAssertionListener( NORMAL_RUN, 1L, null, false );
             notifier.setStdOutListener( listener );
 
             EH eventHandler = new EH();
@@ -657,7 +657,7 @@ public void testStdOutStreamPrintln() throws Exception
 
             ForkedProcessEventNotifier notifier = new ForkedProcessEventNotifier();
             StandardOutErrEventAssertionListener listener =
-                new StandardOutErrEventAssertionListener( NORMAL_RUN, "", true );
+                new StandardOutErrEventAssertionListener( NORMAL_RUN, 1L, "", true );
             notifier.setStdOutListener( listener );
 
             EH eventHandler = new EH();
@@ -696,7 +696,7 @@ public void testStdOutStreamPrintlnWithNull() throws Exception
 
             ForkedProcessEventNotifier notifier = new ForkedProcessEventNotifier();
             StandardOutErrEventAssertionListener listener =
-                new StandardOutErrEventAssertionListener( NORMAL_RUN, null, true );
+                new StandardOutErrEventAssertionListener( NORMAL_RUN, 1L, null, true );
             notifier.setStdOutListener( listener );
 
             EH eventHandler = new EH();
@@ -735,7 +735,7 @@ public void testStdErrStream() throws Exception
 
             ForkedProcessEventNotifier notifier = new ForkedProcessEventNotifier();
             StandardOutErrEventAssertionListener listener =
-                new StandardOutErrEventAssertionListener( NORMAL_RUN, "msg", false );
+                new StandardOutErrEventAssertionListener( NORMAL_RUN, 1L, "msg", false );
             notifier.setStdErrListener( listener );
 
             EH eventHandler = new EH();
@@ -995,11 +995,12 @@ private static class PropertyEventAssertionListener implements ForkedProcessProp
         private final Map<?, ?> sysProps = System.getProperties();
         private final AtomicInteger counter = new AtomicInteger();
 
-        public void handle( RunMode runMode, String key, String value )
+        public void handle( String key, String value, RunMode runMode, Long testRunId )
         {
             called.set( true );
             counter.incrementAndGet();
             assertThat( runMode ).isEqualTo( NORMAL_RUN );
+            assertThat( testRunId ).isEqualTo( 1L );
             assertTrue( sysProps.containsKey( key ) );
             assertThat( sysProps.get( key ) ).isEqualTo( value );
         }
@@ -1067,23 +1068,28 @@ private static class StandardOutErrEventAssertionListener implements ForkedProce
     {
         final AtomicBoolean called = new AtomicBoolean();
         private final RunMode runMode;
+        private final long testRunId;
         private final String output;
         private final boolean newLine;
 
-        StandardOutErrEventAssertionListener( RunMode runMode, String output, boolean newLine )
+        StandardOutErrEventAssertionListener( RunMode runMode, long testRunId, String output, boolean newLine )
         {
             this.runMode = runMode;
+            this.testRunId = testRunId;
             this.output = output;
             this.newLine = newLine;
         }
 
-        public void handle( RunMode runMode, String output, boolean newLine )
+        public void handle( String output, boolean newLine, RunMode runMode, Long testRunId )
         {
             called.set( true );
 
             assertThat( runMode )
                     .isEqualTo( this.runMode );
 
+            assertThat( testRunId )
+                .isEqualTo( this.testRunId );
+
             assertThat( output )
                     .isEqualTo( this.output );
 

Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ public void handle( ReportEntry reportEntry )`
`211`	`211`	`private final class SystemPropertiesListener implements ForkedProcessPropertyEventListener`
`212`	`212`	`{`
`213`	`213`	`@Override`
`214`		`- public void handle( RunMode runMode, String key, String value )`
	`214`	`+ public void handle( String key, String value, RunMode runMode, Long testRunId )`
`215`	`215`	`{`
`216`	`216`	`testVmSystemProperties.put( key, value );`
`217`	`217`	`}`
`@@ -220,18 +220,18 @@ public void handle( RunMode runMode, String key, String value )`
`220`	`220`	`private final class StdOutListener implements ForkedProcessStandardOutErrEventListener`
`221`	`221`	`{`
`222`	`222`	`@Override`
`223`		`- public void handle( RunMode runMode, String output, boolean newLine )`
	`223`	`+ public void handle( String output, boolean newLine, RunMode runMode, Long testRunId )`
`224`	`224`	`{`
`225`		`- writeTestOutput( output, newLine, true );`
	`225`	`+ writeTestOutput( output, true, newLine, runMode, testRunId );`
`226`	`226`	`}`
`227`	`227`	`}`
`228`	`228`
`229`	`229`	`private final class StdErrListener implements ForkedProcessStandardOutErrEventListener`
`230`	`230`	`{`
`231`	`231`	`@Override`
`232`		`- public void handle( RunMode runMode, String output, boolean newLine )`
	`232`	`+ public void handle( String output, boolean newLine, RunMode runMode, Long testRunId )`
`233`	`233`	`{`
`234`		`- writeTestOutput( output, newLine, false );`
	`234`	`+ writeTestOutput( output, false, newLine, runMode, testRunId );`
`235`	`235`	`}`
`236`	`236`	`}`
`237`	`237`
`@@ -393,10 +393,10 @@ void dumpToLoFile( String msg )`
`393`	`393`	`util.dumpStreamText( msg, reportsDir, forkNumber );`
`394`	`394`	`}`
`395`	`395`
`396`		`- private void writeTestOutput( String output, boolean newLine, boolean isStdout )`
	`396`	`+ private void writeTestOutput( String output, boolean isStdout, boolean newLine, RunMode runMode, Long testRunId )`
`397`	`397`	`{`
`398`	`398`	`getConsoleOutputReceiver()`
`399`		`- .writeTestOutput( new TestOutputReportEntry( output, isStdout, newLine, /todo/ null, null ) );`
	`399`	`+ .writeTestOutput( new TestOutputReportEntry( output, isStdout, newLine, runMode, testRunId ) );`
`400`	`400`	`}`
`401`	`401`
`402`	`402`	`public Map<String, String> getTestVmSystemProperties()`
Original file line number	Diff line number	Diff line change
`@@ -207,18 +207,20 @@ else if ( event.isStandardStreamCategory() )`
`207`	`207`	`ForkedProcessStandardOutErrEventListener listener = stdOutErrEventListeners.get( eventType );`
`208`	`208`	`if ( listener != null )`
`209`	`209`	`{`
`210`		`- listener.handle( standardStreamEvent.getRunMode(), standardStreamEvent.getMessage(), newLine );`
	`210`	`+ listener.handle( standardStreamEvent.getMessage(), newLine,`
	`211`	`+ standardStreamEvent.getRunMode(), standardStreamEvent.getTestRunId() );`
`211`	`212`	`}`
`212`	`213`	`}`
`213`	`214`	`else if ( event.isSysPropCategory() )`
`214`	`215`	`{`
`215`	`216`	`SystemPropertyEvent systemPropertyEvent = (SystemPropertyEvent) event;`
`216`	`217`	`RunMode runMode = systemPropertyEvent.getRunMode();`
	`218`	`+ Long testRunId = systemPropertyEvent.getTestRunId();`
`217`	`219`	`String key = systemPropertyEvent.getKey();`
`218`	`220`	`String value = systemPropertyEvent.getValue();`
`219`	`221`	`if ( propertyEventListener != null )`
`220`	`222`	`{`
`221`		`- propertyEventListener.handle( runMode, key, value );`
	`223`	`+ propertyEventListener.handle( key, value, runMode, testRunId );`
`222`	`224`	`}`
`223`	`225`	`}`
`224`	`226`	`else if ( event.isTestCategory() )`
Original file line number	Diff line number	Diff line change
`@@ -27,5 +27,5 @@`
`27`	`27`	`*/`
`28`	`28`	`public interface ForkedProcessPropertyEventListener`
`29`	`29`	`{`
`30`		`- void handle( RunMode runMode, String key, String value );`
	`30`	`+ void handle( String key, String value, RunMode runMode, Long testRunId );`
`31`	`31`	`}`