Merge pull request #391 from praveenag/1.4

praveenag · web-flow · commit 45c2930bc28f · 2017-07-18T10:41:44.000+01:00
better exception messages when database is down.
diff --git a/driver/src/main/java/org/neo4j/driver/internal/security/TLSSocketChannel.java b/driver/src/main/java/org/neo4j/driver/internal/security/TLSSocketChannel.java
@@ -53,6 +53,7 @@ public class TLSSocketChannel implements ByteChannel
 {
     private final ByteChannel channel;      // The real channel the data is sent to and read from
     private final Logger logger;
+    private final BoltServerAddress address;
 
     private SSLEngine sslEngine;
 
@@ -65,17 +66,20 @@ public class TLSSocketChannel implements ByteChannel
 
     private static final ByteBuffer DUMMY_BUFFER = ByteBuffer.allocate( 0 );
 
-    public static TLSSocketChannel create( BoltServerAddress address, SecurityPlan securityPlan, ByteChannel channel, Logger logger )
+    public static TLSSocketChannel create( BoltServerAddress address, SecurityPlan securityPlan,
+                                           ByteChannel channel, Logger logger )
             throws IOException
     {
         SSLEngine sslEngine = securityPlan.sslContext().createSSLEngine( address.host(), address.port() );
         sslEngine.setUseClientMode( true );
-        return create( channel, logger, sslEngine );
+        return create( channel, logger, sslEngine, address );
     }
 
-    public static TLSSocketChannel create( ByteChannel channel, Logger logger, SSLEngine sslEngine ) throws IOException
+    public static TLSSocketChannel create( ByteChannel channel, Logger logger, SSLEngine sslEngine,
+                                           BoltServerAddress address ) throws IOException
     {
-        TLSSocketChannel tlsChannel = new TLSSocketChannel( channel, logger, sslEngine );
+
+        TLSSocketChannel tlsChannel = new TLSSocketChannel( channel, logger, sslEngine, address );
         try
         {
             tlsChannel.runHandshake();
@@ -87,9 +91,10 @@ public static TLSSocketChannel create( ByteChannel channel, Logger logger, SSLEn
         return tlsChannel;
     }
 
-    TLSSocketChannel( ByteChannel channel, Logger logger, SSLEngine sslEngine )
+    TLSSocketChannel( ByteChannel channel, Logger logger, SSLEngine sslEngine, BoltServerAddress address )
             throws IOException
     {
+        this.address = address;
         this.logger = logger;
         this.channel = channel;
         this.sslEngine = sslEngine;
@@ -167,9 +172,10 @@ int channelRead( ByteBuffer toBuffer ) throws IOException
             {
                 // best effort
             }
+
             throw new ServiceUnavailableException(
-                    "SSL Connection terminated while receiving data. " +
-                    "This can happen due to network instabilities, or due to restarts of the database." );
+                    "Failed to receive any data from the connected address " + address + ". " +
+                            "Please ensure a working connection to the database." );
         }
         return read;
     }
@@ -193,8 +199,8 @@ int channelWrite( ByteBuffer fromBuffer ) throws IOException
                 // best effort
             }
             throw new ServiceUnavailableException(
-                    "SSL Connection terminated while writing data. " +
-                    "This can happen due to network instabilities, or due to restarts of the database." );
+                    "Failed to send any data to the connected address " + address + ". " +
+                            "Please ensure a working connection to the database." );
         }
         return written;
     }
diff --git a/driver/src/test/java/org/neo4j/driver/internal/security/TLSSocketChannelTest.java b/driver/src/test/java/org/neo4j/driver/internal/security/TLSSocketChannelTest.java
@@ -26,6 +26,7 @@
 import javax.net.ssl.SSLHandshakeException;
 import javax.net.ssl.SSLSession;
 
+import org.neo4j.driver.internal.net.BoltServerAddress;
 import org.neo4j.driver.v1.exceptions.ServiceUnavailableException;
 import org.neo4j.driver.v1.exceptions.SecurityException;
 
@@ -40,6 +41,7 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 import static org.neo4j.driver.internal.logging.DevNullLogger.DEV_NULL_LOGGER;
+import static org.neo4j.driver.internal.net.BoltServerAddress.LOCAL_DEFAULT;
 import static org.neo4j.driver.internal.security.TLSSocketChannel.create;
 
 public class TLSSocketChannelTest
@@ -59,7 +61,7 @@ public void shouldCloseConnectionIfFailedToRead() throws Throwable
         when( mockedSslSession.getPacketBufferSize() ).thenReturn( 10 );
 
         // When
-        TLSSocketChannel channel = new TLSSocketChannel( mockedChannel, DEV_NULL_LOGGER, mockedSslEngine );
+        TLSSocketChannel channel = new TLSSocketChannel( mockedChannel, DEV_NULL_LOGGER, mockedSslEngine, LOCAL_DEFAULT );
 
         try
         {
@@ -69,7 +71,8 @@ public void shouldCloseConnectionIfFailedToRead() throws Throwable
         catch( Exception e )
         {
             assertThat( e, instanceOf( ServiceUnavailableException.class ) );
-            assertThat( e.getMessage(), startsWith( "SSL Connection terminated while receiving data. " ) );
+            assertThat( e.getMessage(), startsWith( "Failed to receive any data from the connected address " +
+                    "localhost:7687. Please ensure a working connection to the database." ) );
         }
         // Then
         verify( mockedChannel ).close();
@@ -89,7 +92,7 @@ public void shouldCloseConnectionIfFailedToWrite() throws Throwable
         when( mockedSslSession.getPacketBufferSize() ).thenReturn( 10 );
 
         // When
-        TLSSocketChannel channel = new TLSSocketChannel( mockedChannel, DEV_NULL_LOGGER, mockedSslEngine );
+        TLSSocketChannel channel = new TLSSocketChannel( mockedChannel, DEV_NULL_LOGGER, mockedSslEngine, LOCAL_DEFAULT );
 
         try
         {
@@ -99,7 +102,8 @@ public void shouldCloseConnectionIfFailedToWrite() throws Throwable
         catch( Exception e )
         {
             assertThat( e, instanceOf( ServiceUnavailableException.class ) );
-            assertThat( e.getMessage(), startsWith( "SSL Connection terminated while writing data. " ) );
+            assertThat( e.getMessage(), startsWith( "Failed to send any data to the connected address localhost:7687. " +
+                    "Please ensure a working connection to the database." ) );
         }
 
         // Then
@@ -123,7 +127,7 @@ public void shouldThrowUnauthorizedIfFailedToHandshake() throws Throwable
         // When & Then
         try
         {
-            create( mockedChannel, DEV_NULL_LOGGER, mockedSslEngine );
+            create( mockedChannel, DEV_NULL_LOGGER, mockedSslEngine, LOCAL_DEFAULT );
             fail( "Should fail to run handshake" );
         }
         catch( Exception e )
diff --git a/driver/src/test/java/org/neo4j/driver/v1/integration/TLSSocketChannelReadFragmentationIT.java b/driver/src/test/java/org/neo4j/driver/v1/integration/TLSSocketChannelReadFragmentationIT.java
@@ -29,11 +29,13 @@
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLEngine;
 
+import org.neo4j.driver.internal.net.BoltServerAddress;
 import org.neo4j.driver.internal.security.TLSSocketChannel;
 
 import static org.hamcrest.core.IsEqual.equalTo;
 import static org.junit.Assert.assertThat;
 import static org.neo4j.driver.internal.logging.DevNullLogger.DEV_NULL_LOGGER;
+import static org.neo4j.driver.internal.net.BoltServerAddress.LOCAL_DEFAULT;
 
 /**
  * This tests that the TLSSocketChannel handles every combination of network buffer sizes that we
@@ -58,7 +60,7 @@ protected void testForBufferSizes( byte[] blobOfData, int networkFrameSize, int
         SocketAddress address = new InetSocketAddress( serverSocket.getInetAddress(), serverSocket.getLocalPort() );
         ByteChannel ch = new LittleAtATimeChannel( SocketChannel.open( address ), networkFrameSize );
 
-        try ( TLSSocketChannel channel = TLSSocketChannel.create( ch, DEV_NULL_LOGGER, engine ) )
+        try ( TLSSocketChannel channel = TLSSocketChannel.create( ch, DEV_NULL_LOGGER, engine, LOCAL_DEFAULT ) )
         {
             ByteBuffer readBuffer = ByteBuffer.allocate( blobOfData.length );
             while ( readBuffer.position() < readBuffer.capacity() )
diff --git a/driver/src/test/java/org/neo4j/driver/v1/integration/TLSSocketChannelWriteFragmentationIT.java b/driver/src/test/java/org/neo4j/driver/v1/integration/TLSSocketChannelWriteFragmentationIT.java
@@ -30,12 +30,14 @@
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLEngine;
 
+import org.neo4j.driver.internal.net.BoltServerAddress;
 import org.neo4j.driver.internal.security.TLSSocketChannel;
 
 import static org.hamcrest.core.IsEqual.equalTo;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
 import static org.neo4j.driver.internal.logging.DevNullLogger.DEV_NULL_LOGGER;
+import static org.neo4j.driver.internal.net.BoltServerAddress.LOCAL_DEFAULT;
 
 /**
  * This tests that the TLSSocketChannel handles every combination of network buffer sizes that we
@@ -60,7 +62,7 @@ protected void testForBufferSizes( byte[] blobOfData, int networkFrameSize, int
         SocketAddress address = new InetSocketAddress( serverSocket.getInetAddress(), serverSocket.getLocalPort() );
         ByteChannel ch = new LittleAtATimeChannel( SocketChannel.open( address ), networkFrameSize );
 
-        try ( TLSSocketChannel channel = TLSSocketChannel.create( ch, DEV_NULL_LOGGER, engine ) )
+        try ( TLSSocketChannel channel = TLSSocketChannel.create( ch, DEV_NULL_LOGGER, engine, LOCAL_DEFAULT ) )
         {
             ByteBuffer writeBuffer = ByteBuffer.wrap( blobOfData );
             while ( writeBuffer.position() < writeBuffer.capacity() )

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ public class TLSSocketChannel implements ByteChannel`
`53`	`53`	`{`
`54`	`54`	`private final ByteChannel channel; // The real channel the data is sent to and read from`
`55`	`55`	`private final Logger logger;`
	`56`	`+ private final BoltServerAddress address;`
`56`	`57`
`57`	`58`	`private SSLEngine sslEngine;`
`58`	`59`
`@@ -65,17 +66,20 @@ public class TLSSocketChannel implements ByteChannel`
`65`	`66`
`66`	`67`	`private static final ByteBuffer DUMMY_BUFFER = ByteBuffer.allocate( 0 );`
`67`	`68`
`68`		`- public static TLSSocketChannel create( BoltServerAddress address, SecurityPlan securityPlan, ByteChannel channel, Logger logger )`
	`69`	`+ public static TLSSocketChannel create( BoltServerAddress address, SecurityPlan securityPlan,`
	`70`	`+ ByteChannel channel, Logger logger )`
`69`	`71`	`throws IOException`
`70`	`72`	`{`
`71`	`73`	`SSLEngine sslEngine = securityPlan.sslContext().createSSLEngine( address.host(), address.port() );`
`72`	`74`	`sslEngine.setUseClientMode( true );`
`73`		`- return create( channel, logger, sslEngine );`
	`75`	`+ return create( channel, logger, sslEngine, address );`
`74`	`76`	`}`
`75`	`77`
`76`		`- public static TLSSocketChannel create( ByteChannel channel, Logger logger, SSLEngine sslEngine ) throws IOException`
	`78`	`+ public static TLSSocketChannel create( ByteChannel channel, Logger logger, SSLEngine sslEngine,`
	`79`	`+ BoltServerAddress address ) throws IOException`
`77`	`80`	`{`
`78`		`- TLSSocketChannel tlsChannel = new TLSSocketChannel( channel, logger, sslEngine );`
	`81`	`+`
	`82`	`+ TLSSocketChannel tlsChannel = new TLSSocketChannel( channel, logger, sslEngine, address );`
`79`	`83`	`try`
`80`	`84`	`{`
`81`	`85`	`tlsChannel.runHandshake();`
`@@ -87,9 +91,10 @@ public static TLSSocketChannel create( ByteChannel channel, Logger logger, SSLEn`
`87`	`91`	`return tlsChannel;`
`88`	`92`	`}`
`89`	`93`
`90`		`- TLSSocketChannel( ByteChannel channel, Logger logger, SSLEngine sslEngine )`
	`94`	`+ TLSSocketChannel( ByteChannel channel, Logger logger, SSLEngine sslEngine, BoltServerAddress address )`
`91`	`95`	`throws IOException`
`92`	`96`	`{`
	`97`	`+ this.address = address;`
`93`	`98`	`this.logger = logger;`
`94`	`99`	`this.channel = channel;`
`95`	`100`	`this.sslEngine = sslEngine;`
`@@ -167,9 +172,10 @@ int channelRead( ByteBuffer toBuffer ) throws IOException`
`167`	`172`	`{`
`168`	`173`	`// best effort`
`169`	`174`	`}`
	`175`	`+`
`170`	`176`	`throw new ServiceUnavailableException(`
`171`		`- "SSL Connection terminated while receiving data. " +`
`172`		`- "This can happen due to network instabilities, or due to restarts of the database." );`
	`177`	`+ "Failed to receive any data from the connected address " + address + ". " +`
	`178`	`+ "Please ensure a working connection to the database." );`
`173`	`179`	`}`
`174`	`180`	`return read;`
`175`	`181`	`}`
`@@ -193,8 +199,8 @@ int channelWrite( ByteBuffer fromBuffer ) throws IOException`
`193`	`199`	`// best effort`
`194`	`200`	`}`
`195`	`201`	`throw new ServiceUnavailableException(`
`196`		`- "SSL Connection terminated while writing data. " +`
`197`		`- "This can happen due to network instabilities, or due to restarts of the database." );`
	`202`	`+ "Failed to send any data to the connected address " + address + ". " +`
	`203`	`+ "Please ensure a working connection to the database." );`
`198`	`204`	`}`
`199`	`205`	`return written;`
`200`	`206`	`}`