Merge pull request #679 from gjmwoods/4.0-increase-logging-on-it-tests

adding the ability to dump logs of local standalone and cluster neo4j…

Author: zhenlineo

driver/src/test/java/org/neo4j/driver/stress/AbstractStressTestBase.java

@@ -22,6 +22,7 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
 
@@ -88,6 +89,7 @@
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
 import static org.neo4j.driver.SessionConfig.builder;
 
+@ExtendWith( DumpLogsOnFailureWatcher.class )
 abstract class AbstractStressTestBase<C extends AbstractContext>
 {
     private static final int THREAD_COUNT = Integer.getInteger( "threadCount", 8 );
@@ -209,6 +211,8 @@ private void runStressTest( Function<C,List<Future<?>>> threadLauncher ) throws
         verifyResults( context, resourcesInfo );
     }
 
+    abstract void dumpLogs();
+
     abstract URI databaseUri();
 
     abstract AuthToken authToken();

driver/src/test/java/org/neo4j/driver/stress/CausalClusteringStressIT.java

@@ -128,6 +128,12 @@ void printStats( Context context )
         System.out.println( "Bookmark failures: " + context.getBookmarkFailures() );
     }
 
+    @Override
+    void dumpLogs()
+    {
+        clusterRule.dumpClusterLogs();
+    }
+
     private static ClusterAddresses fetchClusterAddresses( Driver driver )
     {
         Set<String> followers = new HashSet<>();

driver/src/test/java/org/neo4j/driver/stress/DumpLogsOnFailureWatcher.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2002-2020 "Neo4j,"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed 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.
+ */
+package org.neo4j.driver.stress;
+
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.TestWatcher;
+
+import java.util.Optional;
+
+public class DumpLogsOnFailureWatcher implements TestWatcher
+{
+    @Override
+    public void testDisabled( ExtensionContext context, Optional<String> reason )
+    {
+        // do nothing
+    }
+
+    @Override
+    public void testSuccessful( ExtensionContext context )
+    {
+        // do nothing
+    }
+
+    @Override
+    public void testAborted( ExtensionContext context, Throwable cause )
+    {
+        // do nothing
+    }
+
+    @Override
+    public void testFailed( ExtensionContext context, Throwable cause )
+    {
+        if ( context.getTestInstance().isPresent() && context.getTestInstance().get() instanceof AbstractStressTestBase<?>)
+        {
+            AbstractStressTestBase<?> clusterTest = (AbstractStressTestBase<?>)  context.getTestInstance().get();
+            clusterTest.dumpLogs();
+        }
+    }
+}

driver/src/test/java/org/neo4j/driver/stress/RxWriteQuery.java

@@ -30,6 +30,7 @@
 import org.neo4j.driver.reactive.RxSession;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 
 public class RxWriteQuery<C extends AbstractContext> extends AbstractRxQuery<C>
 {

driver/src/test/java/org/neo4j/driver/stress/RxWriteQueryWithRetries.java

@@ -30,6 +30,8 @@
 import org.neo4j.driver.reactive.RxSession;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class RxWriteQueryWithRetries<C extends AbstractContext> extends AbstractRxQuery<C>
 {
@@ -45,7 +47,7 @@ public RxWriteQueryWithRetries( AbstractStressTestBase<C> stressTest, Driver dri
     public CompletionStage<Void> execute( C context )
     {
         CompletableFuture<Void> queryFinished = new CompletableFuture<>();
-        Flux.usingWhen( Mono.fromSupplier( () -> newSession( AccessMode.READ, context ) ),
+        Flux.usingWhen( Mono.fromSupplier( () -> newSession( AccessMode.WRITE, context ) ),
                 session -> session.writeTransaction( tx -> tx.run( "CREATE ()" ).consume() ), RxSession::close )
                 .subscribe( summary -> {
                     queryFinished.complete( null );

driver/src/test/java/org/neo4j/driver/stress/SingleInstanceStressIT.java

@@ -114,4 +114,10 @@ long getReadQueryCount()
             return readQueries.get();
         }
     }
+
+    @Override
+    void dumpLogs()
+    {
+        neo4j.dumpLogs();
+    }
 }

driver/src/test/java/org/neo4j/driver/util/DatabaseExtension.java

@@ -173,4 +173,9 @@ public ServerVersion version()
     {
         return ServerVersion.version( driver() );
     }
+
+    public void dumpLogs()
+    {
+        runner.dumpDebugLog();
+    }
 }

driver/src/test/java/org/neo4j/driver/util/Neo4jRunner.java

@@ -19,13 +19,15 @@
 package org.neo4j.driver.util;
 
 import java.io.File;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.net.StandardSocketOptions;
 import java.net.URI;
 import java.nio.channels.SocketChannel;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Scanner;
 
 import org.neo4j.driver.AuthToken;
 import org.neo4j.driver.Config;
@@ -240,6 +242,29 @@ public void restartNeo4j( Neo4jSettings neo4jSettings )
         }
     }
 
+    /**
+     * prints the debug log contents to stdOut
+     */
+    public void dumpDebugLog()
+    {
+        try
+        {
+            System.out.println( "Debug log for: " + HOME_DIR );
+            Scanner input = new Scanner( new File( HOME_DIR + "/logs/debug.log" ));
+
+            while (input.hasNextLine())
+            {
+                System.out.println(input.nextLine());
+            }
+        }
+        catch ( FileNotFoundException e )
+        {
+            System.out.println("Unable to find debug log file for: " + HOME_DIR);
+            e.printStackTrace();
+        }
+
+    }
+
     private enum ServerStatus
     {
         ONLINE, OFFLINE

driver/src/test/java/org/neo4j/driver/util/cc/Cluster.java

@@ -18,6 +18,7 @@
  */
 package org.neo4j.driver.util.cc;
 
+import java.io.FileNotFoundException;
 import java.net.URI;
 import java.net.UnknownHostException;
 import java.nio.file.Path;
@@ -175,6 +176,24 @@ public Driver getDirectDriver( ClusterMember member )
         return clusterDrivers.getDriver( member );
     }
 
+    public void dumpClusterDebugLog()
+    {
+        for ( ClusterMember member : members )
+        {
+
+            System.out.println( "Debug log for: " + member.getPath().toString() );
+            try
+            {
+                member.dumpDebugLog();
+            }
+            catch ( FileNotFoundException e )
+            {
+                System.out.println("Unable to find debug log file for: " + member.getPath().toString());
+                e.printStackTrace();
+            }
+        }
+    }
+
     @Override
     public void close()
     {

driver/src/test/java/org/neo4j/driver/util/cc/ClusterMember.java

@@ -18,10 +18,13 @@
  */
 package org.neo4j.driver.util.cc;
 
+import java.io.File;
+import java.io.FileNotFoundException;
 import java.net.URI;
 import java.net.UnknownHostException;
 import java.nio.file.Path;
 import java.util.Objects;
+import java.util.Scanner;
 
 import org.neo4j.driver.internal.BoltServerAddress;
 
@@ -63,6 +66,16 @@ public Path getPath()
         return path;
     }
 
+    public void dumpDebugLog() throws FileNotFoundException
+    {
+        Scanner input = new Scanner( new File( path.toAbsolutePath().toString() + "/logs/debug.log" ));
+
+        while (input.hasNextLine())
+        {
+            System.out.println(input.nextLine());
+        }
+    }
+
     @Override
     public boolean equals( Object o )
     {

driver/src/test/java/org/neo4j/driver/util/cc/LocalOrRemoteClusterExtension.java

@@ -23,6 +23,7 @@
 import org.junit.jupiter.api.extension.BeforeAllCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
 
+import java.io.FileNotFoundException;
 import java.net.URI;
 
 import org.neo4j.driver.internal.util.DriverFactoryWithOneEventLoopThread;
@@ -99,6 +100,14 @@ public void afterAll( ExtensionContext context )
         }
     }
 
+    public void dumpClusterLogs()
+    {
+        if ( localClusterExtension != null )
+        {
+            localClusterExtension.getCluster().dumpClusterDebugLog();
+        }
+    }
+
     private void deleteDataInRemoteCluster()
     {
         DriverFactoryWithOneEventLoopThread driverFactory = new DriverFactoryWithOneEventLoopThread();