maven-surefire-common/src/test/java/org/apache/maven/plugin/surefire/extensions/E2ETest.java

package org.apache.maven.plugin.surefire.extensions;

/*
 * 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.plugin.surefire.log.api.ConsoleLogger;
import org.apache.maven.surefire.api.booter.MasterProcessChannelEncoder;
import org.apache.maven.surefire.booter.spi.SurefireMasterProcessChannelProcessorFactory;
import org.apache.maven.surefire.api.event.Event;
import org.apache.maven.surefire.extensions.EventHandler;
import org.apache.maven.surefire.extensions.ForkNodeArguments;
import org.apache.maven.surefire.extensions.util.CountdownCloseable;
import org.apache.maven.surefire.api.report.ConsoleOutputReceiver;
import org.junit.Test;

import javax.annotation.Nonnull;
import java.io.Closeable;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;

import static org.fest.assertions.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

/**
 * Simulates the End To End use case where Maven process and Surefire process communicate using the TCP/IP protocol.
 */
@SuppressWarnings( "checkstyle:magicnumber" )
public class E2ETest
{
    private static final String LONG_STRING =
        "0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789";

    @Test
    public void test() throws Exception
    {
        ConsoleLogger logger = mock( ConsoleLogger.class );
        ForkNodeArguments arguments = mock( ForkNodeArguments.class );
        when( arguments.getForkChannelId() ).thenReturn( 1 );
        when( arguments.getConsoleLogger() ).thenReturn( logger );
        final SurefireForkChannel server = new SurefireForkChannel( arguments );

        final String connection = server.getForkNodeConnectionString();

        final SurefireMasterProcessChannelProcessorFactory factory = new SurefireMasterProcessChannelProcessorFactory();
        factory.connect( connection );
        final MasterProcessChannelEncoder encoder = factory.createEncoder();

        System.gc();

        TimeUnit.SECONDS.sleep( 3L );

        final CountDownLatch awaitHandlerFinished = new CountDownLatch( 2 );

        Thread t = new Thread()
        {
            @Override
            public void run()
            {
                ConsoleOutputReceiver target = new ConsoleOutputReceiver()
                {
                    @Override
                    public void writeTestOutput( String output, boolean newLine, boolean stdout )
                    {
                        encoder.stdOut( output, true );
                    }
                };

                //PrintStream out = System.out;
                //PrintStream err = System.err;

                //ConsoleOutputCapture.startCapture( target );

                try
                {
                    long t1 = System.currentTimeMillis();
                    for ( int i = 0; i < 400_000; i++ )
                    {
                        //System.out.println( LONG_STRING );
                        encoder.stdOut( LONG_STRING, true );
                    }
                    long t2 = System.currentTimeMillis();
                    long spent = t2 - t1;
                    //System.setOut( out );
                    //System.setErr( err );
                    System.out.println( spent + "ms on write" );
                    awaitHandlerFinished.countDown();
                }
                catch ( Exception e )
                {
                    e.printStackTrace();
                }
            }
        };
        t.setDaemon( true );
        t.start();

        server.connectToClient();

        final AtomicLong readTime = new AtomicLong();

        EventHandler<Event> h = new EventHandler<Event>()
        {
            private final AtomicInteger counter = new AtomicInteger();
            private volatile long t1;

            @Override
            public void handleEvent( @Nonnull Event event )
            {
                try
                {
                    if ( counter.getAndIncrement() == 0 )
                    {
                        t1 = System.currentTimeMillis();
                    }

                    long t2 = System.currentTimeMillis();
                    long spent = t2 - t1;

                    if ( counter.get() % 100_000 == 0 )
                    {
                        System.out.println( spent + "ms: " + counter.get() );
                    }

                    if ( counter.get() == 320_000 )
                    {
                        readTime.set( spent );
                        System.out.println( spent + "ms on read" );
                        awaitHandlerFinished.countDown();
                    }
                }
                catch ( Exception e )
                {
                    e.printStackTrace();
                }
            }
        };

        Closeable c = new Closeable()
        {
            @Override
            public void close()
            {
            }
        };

        ReadableByteChannel stdOut = mock( ReadableByteChannel.class );
        when( stdOut.read( any( ByteBuffer.class ) ) ).thenReturn( -1 );
        server.bindEventHandler( h, new CountdownCloseable( c, 1 ), stdOut )
            .start();

        assertThat( awaitHandlerFinished.await( 30L, TimeUnit.SECONDS ) )
            .isTrue();

        factory.close();
        server.close();

        // 2 seconds while using the encoder/decoder
        // 160 millis of sending pure data without encoder/decoder
        assertThat( readTime.get() )
            .describedAs( "The performance test should assert 2s of read time. "
                + "The limit 6s guarantees that the read time does not exceed this limit on overloaded CPU." )
            .isPositive()
            .isLessThanOrEqualTo( 6_000L );
    }
}