You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ti...@apache.org on 2020/07/20 00:30:11 UTC
[maven-surefire] branch flush updated (27cc4cc -> 384e598)
This is an automated email from the ASF dual-hosted git repository.
tibordigana pushed a change to branch flush
in repository https://gitbox.apache.org/repos/asf/maven-surefire.git.
discard 27cc4cc [SUREFIRE-1827] The console output is not flushed
new 384e598 [SUREFIRE-1827] The console output is not flushed
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (27cc4cc)
\
N -- N -- N refs/heads/flush (384e598)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../maven/surefire/api/util/internal/Channels.java | 16 +++++++++++++--
.../util/internal/WritableBufferedByteChannel.java | 1 +
...stractMasterProcessChannelProcessorFactory.java | 23 ++++++++++++++++------
...LegacyMasterProcessChannelProcessorFactory.java | 5 +++--
...refireMasterProcessChannelProcessorFactory.java | 4 ++--
5 files changed, 37 insertions(+), 12 deletions(-)
[maven-surefire] 01/01: [SUREFIRE-1827] The console output is not
flushed
Posted by ti...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tibordigana pushed a commit to branch flush
in repository https://gitbox.apache.org/repos/asf/maven-surefire.git
commit 384e59828a9d0af2e56d9a8804fa23a9e9cd8547
Author: tibordigana <ti...@apache.org>
AuthorDate: Wed Jul 8 15:37:07 2020 +0200
[SUREFIRE-1827] The console output is not flushed
---
.../AbstractNoninterruptibleWritableChannel.java | 15 +--
.../maven/surefire/api/util/internal/Channels.java | 16 +++-
.../util/internal/WritableBufferedByteChannel.java | 2 +
.../api/util/internal/ChannelsWriterTest.java | 47 ++++++++-
...stractMasterProcessChannelProcessorFactory.java | 106 +++++++++++++++++++++
...LegacyMasterProcessChannelProcessorFactory.java | 15 ++-
...refireMasterProcessChannelProcessorFactory.java | 10 +-
7 files changed, 183 insertions(+), 28 deletions(-)
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/AbstractNoninterruptibleWritableChannel.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/AbstractNoninterruptibleWritableChannel.java
index fe998f3..c2641e5 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/AbstractNoninterruptibleWritableChannel.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/AbstractNoninterruptibleWritableChannel.java
@@ -67,17 +67,12 @@ abstract class AbstractNoninterruptibleWritableChannel implements WritableBuffer
src.flip();
}
- int countWrittenBytes = 0;
-
- if ( src.hasRemaining() )
+ int countWrittenBytes = src.remaining();
+ writeImpl( src );
+ src.position( src.limit() );
+ if ( flush )
{
- countWrittenBytes = src.remaining();
- writeImpl( src );
- src.position( src.limit() );
- if ( flush )
- {
- flushImpl();
- }
+ flushImpl();
}
return countWrittenBytes;
}
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/Channels.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/Channels.java
index 7bd4efc..2ee6cc8 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/Channels.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/Channels.java
@@ -32,7 +32,9 @@ import java.nio.channels.ClosedChannelException;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.util.concurrent.ExecutionException;
+import java.util.concurrent.atomic.AtomicLong;
+import static java.lang.Math.max;
import static java.util.Objects.requireNonNull;
/**
@@ -227,17 +229,27 @@ public final class Channels
};
}
- private static WritableBufferedByteChannel newChannel( @Nonnull OutputStream out, @Nonnegative int bufferSize )
+ private static WritableBufferedByteChannel newChannel( @Nonnull OutputStream out, @Nonnegative final int bufferSize )
{
requireNonNull( out, "the stream should not be null" );
final OutputStream bos = bufferSize == 0 ? out : new BufferedOutputStream( out, bufferSize );
return new AbstractNoninterruptibleWritableChannel()
{
+ private final AtomicLong bytesCounter = new AtomicLong();
+
+ @Override
+ public long countBufferOverflows()
+ {
+ return bufferSize == 0 ? 0 : max( bytesCounter.get() - 1, 0 ) / bufferSize;
+ }
+
@Override
protected void writeImpl( ByteBuffer src ) throws IOException
{
- bos.write( src.array(), src.arrayOffset() + src.position(), src.remaining() );
+ int count = src.remaining();
+ bos.write( src.array(), src.arrayOffset() + src.position(), count );
+ bytesCounter.getAndAdd( count );
}
@Override
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/WritableBufferedByteChannel.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/WritableBufferedByteChannel.java
index 42c0d08..ea86a82 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/WritableBufferedByteChannel.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/WritableBufferedByteChannel.java
@@ -29,8 +29,10 @@ import java.nio.channels.WritableByteChannel;
* and the channel is flushed after the buffer has overflew.
* <br>
* The method {@link #write(ByteBuffer)} flushes every written message.
+ * You can flush the channel by {@link #write(ByteBuffer) writing} the zero length of {@link ByteBuffer}.
*/
public interface WritableBufferedByteChannel extends WritableByteChannel
{
void writeBuffered( ByteBuffer src ) throws IOException;
+ long countBufferOverflows();
}
diff --git a/surefire-api/src/test/java/org/apache/maven/surefire/api/util/internal/ChannelsWriterTest.java b/surefire-api/src/test/java/org/apache/maven/surefire/api/util/internal/ChannelsWriterTest.java
index 4befc24..24a09f3 100644
--- a/surefire-api/src/test/java/org/apache/maven/surefire/api/util/internal/ChannelsWriterTest.java
+++ b/surefire-api/src/test/java/org/apache/maven/surefire/api/util/internal/ChannelsWriterTest.java
@@ -137,6 +137,48 @@ public class ChannelsWriterTest
}
@Test
+ public void shouldFlushWhenEmptyBuffer() throws Exception
+ {
+ final boolean[] flushed = {false};
+ ByteArrayOutputStream out = new ByteArrayOutputStream()
+ {
+ @Override
+ public void flush() throws IOException
+ {
+ flushed[0] = true;
+ super.flush();
+ }
+ };
+ WritableByteChannel channel = Channels.newChannel( out );
+ ByteBuffer bb = ByteBuffer.allocate( 0 );
+ int countWritten = channel.write( bb );
+ assertThat( countWritten )
+ .isEqualTo( 0 );
+ assertThat( flushed[0] )
+ .isTrue();
+ }
+
+ @Test
+ public void shouldFlushWhenEmptyBufferOnBufferedWrites() throws Exception
+ {
+ final boolean[] flushed = {false};
+ ByteArrayOutputStream out = new ByteArrayOutputStream()
+ {
+ @Override
+ public void flush() throws IOException
+ {
+ flushed[0] = true;
+ super.flush();
+ }
+ };
+ WritableBufferedByteChannel channel = Channels.newBufferedChannel( out );
+ ByteBuffer bb = ByteBuffer.allocate( 0 );
+ channel.writeBuffered( bb );
+ assertThat( flushed[0] )
+ .isFalse();
+ }
+
+ @Test
public void bufferedChannel() throws Exception
{
ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -151,11 +193,6 @@ public class ChannelsWriterTest
assertThat( out.toByteArray() )
.isEmpty();
- channel.write( ByteBuffer.allocate( 0 ) );
-
- assertThat( out.toByteArray() )
- .isEmpty();
-
channel.write( ByteBuffer.wrap( new byte[] {4} ) );
assertThat( out.toByteArray() )
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/AbstractMasterProcessChannelProcessorFactory.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/AbstractMasterProcessChannelProcessorFactory.java
new file mode 100644
index 0000000..63407f2
--- /dev/null
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/AbstractMasterProcessChannelProcessorFactory.java
@@ -0,0 +1,106 @@
+package org.apache.maven.surefire.booter.spi;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.maven.surefire.api.util.internal.WritableBufferedByteChannel;
+import org.apache.maven.surefire.spi.MasterProcessChannelProcessorFactory;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.security.AccessControlException;
+import java.security.PrivilegedAction;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.atomic.AtomicLong;
+
+import static java.security.AccessController.doPrivileged;
+import static java.util.concurrent.Executors.newScheduledThreadPool;
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static org.apache.maven.surefire.api.util.internal.DaemonThreadFactory.newDaemonThreadFactory;
+
+/**
+ * Default implementation of {@link MasterProcessChannelProcessorFactory}.
+ */
+public abstract class AbstractMasterProcessChannelProcessorFactory
+ implements MasterProcessChannelProcessorFactory
+{
+ private static final String STREAM_FLUSHER = "surefire-forkedjvm-stream-flusher";
+ private final ScheduledExecutorService flusher;
+
+ public AbstractMasterProcessChannelProcessorFactory()
+ {
+ flusher = newScheduledThreadPool( 1, newDaemonThreadFactory( STREAM_FLUSHER ) );
+ }
+
+ protected void schedulePeriodicFlusher( int delayInMillis, final WritableBufferedByteChannel channel )
+ {
+ final AtomicLong bufferOverflows = new AtomicLong();
+ flusher.scheduleWithFixedDelay( new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ long currentBufferOverflows = channel.countBufferOverflows();
+ // optimization: flush the Channel only if the buffer has not overflew after last period of time
+ if ( bufferOverflows.get() == currentBufferOverflows )
+ {
+ try
+ {
+ channel.write( ByteBuffer.allocate( 0 ) );
+ }
+ catch ( Exception e )
+ {
+ // cannot do anything about this I/O issue
+ }
+ }
+ else
+ {
+ bufferOverflows.set( currentBufferOverflows );
+ }
+ }
+ }, 0L, delayInMillis, MILLISECONDS );
+ }
+
+ @Override
+ public void close() throws IOException
+ {
+ try
+ {
+ doPrivileged( new PrivilegedAction<Object>()
+ {
+ @Override
+ public Object run()
+ {
+ flusher.shutdown();
+ // Do NOT call awaitTermination() due to this would unnecessarily prolong teardown
+ // time of the JVM. It is not a critical situation when the JXM exits this daemon
+ // thread because the interrupted flusher does not break any business function.
+ // All business data is already safely flushed by test events, then by sending BYE
+ // event at the exit time and finally by flushEventChannelOnExit() in ForkedBooter.
+ return null;
+ }
+ }
+ );
+ }
+ catch ( AccessControlException e )
+ {
+ // ignore
+ }
+ }
+}
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/LegacyMasterProcessChannelProcessorFactory.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/LegacyMasterProcessChannelProcessorFactory.java
index 1344f3d..aaf5243 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/LegacyMasterProcessChannelProcessorFactory.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/LegacyMasterProcessChannelProcessorFactory.java
@@ -21,7 +21,7 @@ package org.apache.maven.surefire.booter.spi;
import org.apache.maven.surefire.api.booter.MasterProcessChannelDecoder;
import org.apache.maven.surefire.api.booter.MasterProcessChannelEncoder;
-import org.apache.maven.surefire.spi.MasterProcessChannelProcessorFactory;
+import org.apache.maven.surefire.api.util.internal.WritableBufferedByteChannel;
import java.io.IOException;
import java.net.MalformedURLException;
@@ -36,8 +36,10 @@ import static org.apache.maven.surefire.api.util.internal.Channels.newBufferedCh
* @since 3.0.0-M5
*/
public class LegacyMasterProcessChannelProcessorFactory
- implements MasterProcessChannelProcessorFactory
+ extends AbstractMasterProcessChannelProcessorFactory
{
+ private static final int FLUSH_PERIOD_MILLIS = 200;
+
@Override
public boolean canUse( String channelConfig )
{
@@ -62,11 +64,8 @@ public class LegacyMasterProcessChannelProcessorFactory
@Override
public MasterProcessChannelEncoder createEncoder()
{
- return new LegacyMasterProcessChannelEncoder( newBufferedChannel( System.out ) );
- }
-
- @Override
- public void close()
- {
+ WritableBufferedByteChannel channel = newBufferedChannel( System.out );
+ schedulePeriodicFlusher( FLUSH_PERIOD_MILLIS, channel );
+ return new LegacyMasterProcessChannelEncoder( channel );
}
}
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/SurefireMasterProcessChannelProcessorFactory.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/SurefireMasterProcessChannelProcessorFactory.java
index 9efff25..62eefdd 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/SurefireMasterProcessChannelProcessorFactory.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/SurefireMasterProcessChannelProcessorFactory.java
@@ -21,7 +21,7 @@ package org.apache.maven.surefire.booter.spi;
import org.apache.maven.surefire.api.booter.MasterProcessChannelDecoder;
import org.apache.maven.surefire.api.booter.MasterProcessChannelEncoder;
-import org.apache.maven.surefire.spi.MasterProcessChannelProcessorFactory;
+import org.apache.maven.surefire.api.util.internal.WritableBufferedByteChannel;
import java.io.IOException;
import java.net.InetSocketAddress;
@@ -53,8 +53,9 @@ import static org.apache.maven.surefire.api.util.internal.DaemonThreadFactory.ne
* @since 3.0.0-M5
*/
public class SurefireMasterProcessChannelProcessorFactory
- implements MasterProcessChannelProcessorFactory
+ extends AbstractMasterProcessChannelProcessorFactory
{
+ private static final int FLUSH_PERIOD_MILLIS = 200;
private volatile AsynchronousSocketChannel clientSocketChannel;
@Override
@@ -104,12 +105,15 @@ public class SurefireMasterProcessChannelProcessorFactory
@Override
public MasterProcessChannelEncoder createEncoder()
{
- return new LegacyMasterProcessChannelEncoder( newBufferedChannel( newOutputStream( clientSocketChannel ) ) );
+ WritableBufferedByteChannel channel = newBufferedChannel( newOutputStream( clientSocketChannel ) );
+ schedulePeriodicFlusher( FLUSH_PERIOD_MILLIS, channel );
+ return new LegacyMasterProcessChannelEncoder( channel );
}
@Override
public void close() throws IOException
{
+ super.close();
if ( clientSocketChannel != null && clientSocketChannel.isOpen() )
{
clientSocketChannel.close();