490-connection-error-path-handling

Signed-off-by: Greg Watts <gwatts@us.ibm.com>

Author: gjwatts

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/DB2Decoder.java

@@ -24,6 +24,7 @@
 import io.netty.handler.codec.ByteToMessageDecoder;
 import io.vertx.core.impl.logging.Logger;
 import io.vertx.core.impl.logging.LoggerFactory;
+import io.vertx.db2client.DB2Exception;
 import io.vertx.sqlclient.impl.command.CommandResponse;
 
 class DB2Decoder extends ByteToMessageDecoder {
@@ -74,6 +75,9 @@ private void decodePayload(ByteBuf payload, int payloadLength) {
             if (LOG.isDebugEnabled())
                 LOG.debug("<<< DECODE " + ctx + " (" + payloadLength + " bytes)");
             ctx.decodePayload(payload, payloadLength);
+        } catch (DB2Exception connex) {
+        	// A common connection error occurred, so don't bother with a hex dump and generic error message 
+        	ctx.completionHandler.handle(CommandResponse.failure(connex));
         } catch (Throwable t) {
             int i = payload.readerIndex();
             payload.readerIndex(startIndex);

vertx-db2-client/src/main/java/io/vertx/db2client/impl/drda/DRDAConnectResponse.java

@@ -15,7 +15,6 @@
  */
 package io.vertx.db2client.impl.drda;
 
-import java.nio.charset.StandardCharsets;
 import java.sql.Connection;
 import java.util.ArrayList;
 import java.util.List;
@@ -1057,13 +1056,13 @@ private void parseSECCHKreply() {
             // 0x03 - OBJDSS sent when not allowed.
             //parseSECTKN (true);
             parseSECTKN(false);
-        }
+        } 
     }
 
     // The Security Check (SECCHKRM) Reply Message indicates the acceptability
     // of the security information.
-    // this method returns the security check code. it is up to the caller to check
-    // the value of this return code and take the appropriate action.
+    // This method throws an exception if the connection was not established
+    // It is up to the caller to catch this exception and take the appropriate action.
     //
     // Returned from Server:
     // SVRCOD - required  (0 - INFO, 8 - ERROR, 16 -SEVERE)
@@ -1132,10 +1131,30 @@ private void parseSECCHKRM() {
         if (!secchkcdReceived)
             throw new IllegalStateException("Did not receive SECCHKCD codepoint");
 //        checkRequiredObjects(svrcodReceived, secchkcdReceived);
-
 //        netConnection.securityCheckComplete(svrcod, secchkcd);
-        if (secchkcd != CodePoint.SECCHKCD_00) {
-            throw new IllegalArgumentException("Authentication failed");
+        
+        switch (secchkcd) {
+        // Security information accepted
+        case CodePoint.SECCHKCD_00:		
+            break;
+        // Missing userid - TODO  We should catch and handle this issue *before* the call to the DB2 server
+        case CodePoint.SECCHKCD_12:
+            // Using SQL error code and state values from JDBC
+            throw new DB2Exception("Missing userid, verify a user value was supplied", SqlCode.MISSING_CREDENTIALS, SQLState.CONNECT_USERID_ISNULL);
+        // Missing password - TODO  We should catch and handle this issue *before* the call to the DB2 server
+        case CodePoint.SECCHKCD_10:
+            // Using SQL error code and state values from similar JDBC reponse
+        	throw new DB2Exception("Missing password, verify a password value was supplied", SqlCode.MISSING_CREDENTIALS, SQLState.CONNECT_PASSWORD_ISNULL);
+        // Invalid credentials
+        case CodePoint.SECCHKCD_0E:
+        case CodePoint.SECCHKCD_0F:
+        case CodePoint.SECCHKCD_13:
+        case CodePoint.SECCHKCD_14:
+        case CodePoint.SECCHKCD_15:
+            // Using SQL error code and state values from similar JDBC response for consistency
+            throw new DB2Exception("Invalid credentials, verify the user and password values supplied are correct", SqlCode.INVALID_CREDENTIALS, SQLState.NET_CONNECT_AUTH_FAILED);
+        default:
+        	throw new IllegalArgumentException("Authentication failed");
         }
     }
 

vertx-db2-client/src/main/java/io/vertx/db2client/impl/drda/SqlCode.java

@@ -26,6 +26,8 @@ public class SqlCode {
 
 	public static final int CONNECTION_REFUSED = -4499;
 	public static final int RDB_NOT_FOUND = -30061;
+	public static final int INVALID_CREDENTIALS = -4214;
+	public static final int MISSING_CREDENTIALS = -4461;
 
     private int code_;
 

vertx-db2-client/src/test/java/io/vertx/db2client/DB2ErrorMessageTest.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright (C) 2020 IBM Corporation
+ *
+ * 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 io.vertx.db2client;
+
+import org.junit.Ignore;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import io.vertx.db2client.impl.drda.SQLState;
+import io.vertx.db2client.impl.drda.SqlCode;
+import io.vertx.ext.unit.TestContext;
+import io.vertx.ext.unit.junit.VertxUnitRunner;
+
+@RunWith(VertxUnitRunner.class)
+public class DB2ErrorMessageTest extends DB2TestBase {
+	
+	@Test
+	@Ignore		// TODO - Need to figure out why this is blowing up in parseACCSECreply()
+	public void testConnectInvalidDatabase(TestContext ctx) {
+	  options.setDatabase("DOES_NOT_EXIST");
+	  DB2Connection.connect(vertx, options, ctx.asyncAssertFailure(err -> {
+		  ctx.assertTrue(err instanceof DB2Exception, "The error message returned is of the wrong type.  It should be a DB2Exception, but it was of type " + err.getClass().getSimpleName());
+//		  DB2Exception ex = (DB2Exception) err;
+//		  ctx.assertTrue(ex.getMessage().contains("Invalid database"), "The SQL error message returned is not correct.  It should have contained \"Invalid database\", but instead it said \"" + ex.getMessage() + "\"");
+	  }));
+	}
+	
+	@Test
+	public void testConnectInvalidUsername(TestContext ctx) {
+	  options.setUser("INVALID_USER_FOR_TESTING");
+	  DB2Connection.connect(vertx, options, ctx.asyncAssertFailure(err -> {
+		  ctx.assertTrue(err instanceof DB2Exception, "The error message returned is of the wrong type.  It should be a DB2Exception, but it was of type " + err.getClass().getSimpleName());
+		  DB2Exception ex = (DB2Exception) err;
+		  ctx.assertTrue(ex.getMessage().contains("Invalid credentials"), "The SQL error message returned is not correct.  It should have contained \"Invalid credentials\", but instead it said \"" + ex.getMessage() + "\"");
+		  ctx.assertEquals(SqlCode.INVALID_CREDENTIALS, ex.getErrorCode());
+		  ctx.assertEquals(SQLState.NET_CONNECT_AUTH_FAILED, ex.getSqlState());
+		  System.out.println(err.getMessage());
+	  }));
+	}
+	
+	@Test
+	public void testConnectInvalidPassword(TestContext ctx) {
+		options.setPassword("INVALID_PASSWORD_FOR_TESTING");
+		  DB2Connection.connect(vertx, options, ctx.asyncAssertFailure(err -> {
+			  ctx.assertTrue(err instanceof DB2Exception, "The error message returned is of the wrong type.  It should be a DB2Exception, but it was of type " + err.getClass().getSimpleName());
+			  DB2Exception ex = (DB2Exception) err;
+			  ctx.assertTrue(ex.getMessage().contains("Invalid credentials"), "The SQL error message returned is not correct.  It should have contained \"Invalid credentials\", but instead it said \"" + ex.getMessage() + "\"");
+			  ctx.assertEquals(SqlCode.INVALID_CREDENTIALS, ex.getErrorCode());
+			  ctx.assertEquals(SQLState.NET_CONNECT_AUTH_FAILED, ex.getSqlState());
+			  System.out.println(err.getMessage());
+		  }));
+	}
+	
+	@Test
+	@Ignore  // TODO - @GJW I want to validate we would always want to fail a test for a blank user name.  If so, we want to catch this *before* we connect to the DB2 server
+	public void testConnectBlankUsername(TestContext ctx) {
+	  options.setUser("");
+	  DB2Connection.connect(vertx, options, ctx.asyncAssertFailure(err -> {
+		  ctx.assertTrue(err instanceof DB2Exception, "The error message returned is of the wrong type.  It should be a DB2Exception, but it was of type " + err.getClass().getSimpleName());
+		  ctx.assertTrue("Missing userid, verify a user value was supplied".equalsIgnoreCase(err.getMessage()), "The text of the returned error message is incorrect.  It should say \"Missing userid, verify a user value was supplied\", but instead, it says \"" + err.getMessage() + "\"");
+	  }));
+	}
+	
+	@Test
+	@Ignore  // TODO - @GJW I want to validate we would always want to fail a test for a blank password.  If so, we want to catch this *before* we connect to the DB2 server 
+	public void testConnectBlankPassword(TestContext ctx) {
+		options.setPassword("");
+		  DB2Connection.connect(vertx, options, ctx.asyncAssertFailure(err -> {
+              ctx.assertTrue(err instanceof DB2Exception, "The error message returned is of the wrong type.  It should be a DB2Exception, but it was of type " + err.getClass().getSimpleName());
+              ctx.assertTrue("Missing password, verify a password value was supplied".equalsIgnoreCase(err.getMessage()), "The text of the returned error message is incorrect.  It should say \"Missing password, verify a password value was supplied\", but instead, it says \"" + err.getMessage() + "\"");		  
+		  }));
+	}
+	
+	@Test
+	@Ignore		// TODO - complete
+	public void testConnectInvalidQuery(TestContext ctx) {
+	}
+}