Fail properly when Oracle url format is not supported (eclipse-vertx#1157)

Fixes eclipse-vertx#1155 The client should fail with a meaningful error message when an unsupported connection format is used, that is: - LDAP syntax - Oracle TNS URL Signed-off-by: Thomas Segismont <tsegismont@gmail.com>

Author: tsegismont

vertx-oracle-client/src/main/java/io/vertx/oracleclient/impl/OracleConnectionUriParser.java

@@ -15,14 +15,13 @@
 
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
+import java.util.Locale;
 
 import static io.vertx.oracleclient.ServerMode.of;
 
 public class OracleConnectionUriParser {
 
- public static final String SCHEME = "oracle:thin:";
- public static final String TCPS_PROTOCOL = "tcps://";
- public static final String TCP_PROTOCOL = "tcp://";
+ private static final String SCHEME = "oracle:thin:";
 
  public static JsonObject parse(String connectionUri) {
  return parse(connectionUri, true);
@@ -77,6 +76,20 @@ static ParsingStage initial(String connectionUri, JsonObject configuration) {
 
  abstract ParsingStage doParse();
 
+ ParsingStage afterAtSign(int i) {
+ if (i == connectionUri.length()) {
+ throw new VertxException("Empty net location", true);
+ }
+ int j = connectionUri.indexOf("://", i);
+ if (j >= i) {
+ return new Protocol(connectionUri, i, j, configuration);
+ }
+ if (connectionUri.charAt(i) == '(') {
+ throw new VertxException("TNS URL Format is not supported", true);
+ }
+ return hostOrIpV6(i);
+ }
+
  ParsingStage hostOrIpV6(int i) {
  return connectionUri.charAt(i) == '[' ? new Ipv6(connectionUri, i + 1, configuration) : new Host(connectionUri, i, configuration);
  }
@@ -128,7 +141,7 @@ ParsingStage doParse() {
  throw new VertxException("Did not find '@' sign", true);
  }
  if (i == beginIdx) {
- return new Protocol(connectionUri, beginIdx + 1, configuration);
+ return afterAtSign(beginIdx + 1);
  }
  String userInfo = connectionUri.substring(beginIdx, i);
  String[] split = userInfo.split(userInfo.indexOf('/') >= 0 ? "/" : ":");
@@ -146,28 +159,34 @@ ParsingStage doParse() {
  configuration.put("user", decodeUrl(user));
  configuration.put("password", decodeUrl(password));
 
- return new Protocol(connectionUri, i + 1, configuration);
+ return afterAtSign(i + 1);
  }
  }
 
  static class Protocol extends ParsingStage {
 
- Protocol(String connectionUri, int beginIdx, JsonObject configuration) {
+ final int endIdx;
+
+ Protocol(String connectionUri, int beginIdx, int endIdx, JsonObject configuration) {
  super(connectionUri, beginIdx, configuration);
+ this.endIdx = endIdx;
  }
 
  @Override
  ParsingStage doParse() {
- int i;
- if (connectionUri.startsWith(TCPS_PROTOCOL, beginIdx)) {
+ if (beginIdx == endIdx) {
+ throw new VertxException("Empty protocol", true);
+ }
+ String protocol = connectionUri.substring(beginIdx, endIdx).toLowerCase(Locale.ROOT);
+ if (protocol.equals("ldap") || protocol.equals("ldaps")) {
+ throw new VertxException("LDAP Syntax is not supported", true);
+ }
+ if (protocol.equals("tcps")) {
  configuration.put("ssl", true);
- i = beginIdx + TCPS_PROTOCOL.length();
- } else if (connectionUri.startsWith(TCP_PROTOCOL, beginIdx)) {
- i = beginIdx + TCP_PROTOCOL.length();
- } else {
- i = beginIdx;
+ } else if (!protocol.equals("tcp")) {
+ throw new VertxException("Unsupported protocol", true);
  }
- return hostOrIpV6(i);
+ return hostOrIpV6(endIdx + 3);
  }
  }
 

vertx-oracle-client/src/main/java/io/vertx/oracleclient/impl/OracleDatabaseHelper.java

@@ -22,8 +22,6 @@
 
 import static io.vertx.oracleclient.impl.Helper.getOrHandleSQLException;
 import static io.vertx.oracleclient.impl.Helper.runOrHandleSQLException;
-import static io.vertx.oracleclient.impl.OracleConnectionUriParser.SCHEME;
-import static io.vertx.oracleclient.impl.OracleConnectionUriParser.TCPS_PROTOCOL;
 
 public class OracleDatabaseHelper {
 
@@ -50,9 +48,9 @@ public static OracleDataSource createDataSource(OracleConnectOptions options) {
  * @return An Oracle Connection JDBC URL
  */
  private static String composeJdbcUrl(OracleConnectOptions options) {
- StringBuilder url = new StringBuilder("jdbc:").append(SCHEME).append("@");
+ StringBuilder url = new StringBuilder("jdbc:oracle:thin:@");
  if (options.isSsl()) {
- url.append(TCPS_PROTOCOL);
+ url.append("tcps://");
  }
  String host = options.getHost();
  if (host.indexOf(':') >= 0) { // IPv6 address

vertx-oracle-client/src/test/java/io/vertx/oracleclient/impl/InvalidOracleConnectionUriParsingTest.java

@@ -16,52 +16,81 @@
 import org.junit.runners.Parameterized;
 import org.junit.runners.Parameterized.Parameters;
 
+import java.util.function.BiConsumer;
+
+import static java.util.Locale.ENGLISH;
 import static org.hamcrest.CoreMatchers.instanceOf;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.junit.Assert.fail;
+import static org.junit.Assert.*;
 
 @RunWith(Parameterized.class)
 public class InvalidOracleConnectionUriParsingTest {
 
  @Parameters(name = "{0}: {1}")
- public static Object[][] data() {
+ public static Object[][] testData() {
  Object[][] params = {
- {"null uri", null},
- {"uri with invalid scheme", "postgresql://user@?host=localhost&port=1234"},
- {"uri with no separated user/password", "oracle:thin:scott@myhost:1521:orcl"},
- {"uri with no separated user/password", "oracle:thin:scott@myhost:1521:orcl"},
- {"uri without password", "oracle:thin:scott/@myhost:1521:orcl"},
- {"uri without user", "oracle:thin:/tiger@myhost:1521:orcl"},
- {"uri with multiple user/password splitters", "oracle:thin:scott/tiger/dragon@myhost:1521:orcl"},
- {"uri without net location", "oracle:thin:scott/tiger"},
- {"uri without SID after host", "oracle:thin:scott/tiger@myhost"},
- {"uri without SID after port", "oracle:thin:scott/tiger@myhost:1521"},
- {"uri with empty SID", "oracle:thin:scott/tiger@myhost:1521:"},
- {"uri with invalid content after host", "oracle:thin:@[::1]sss:1521:orcl"},
- {"uri with invalid IPv6 address", "oracle:thin:@[:1521:orcl"},
- {"uri with empty host", "oracle:thin:@:1521:orcl"},
- {"uri with empty IPv6 address", "oracle:thin:@[]:1521:orcl"},
- {"uri with empty port", "oracle:thin:@myhost::orcl"},
- {"uri with invalid port", "oracle:thin:@myhost:7654645:orcl"},
- {"uri with multiple hosts and ports", "oracle:thin:scott/tiger@myhost1:1521,myhost2:1521:orcl"},
- {"uri with multiple hosts", "oracle:thin:scott/tiger@myhost1,myhost2:1521:orcl"},
- {"uri with empty props", "oracle:thin:scott/tiger@myhost:1521:orcl?"},
- {"uri with empty service name", "oracle:thin:scott/tiger@myhost:1521/"},
- {"uri with empty server mode", "oracle:thin:scott/tiger@myhost:1521/orcl:?prop=val"},
- {"uri with invalid server mode", "oracle:thin:scott/tiger@myhost:1521/orcl:foo"},
- {"uri with service name but empty instance name", "oracle:thin:scott/tiger@myhost:1521/orcl/"},
- {"uri with service name and server mode but empty instance name", "oracle:thin:scott/tiger@myhost:1521/orcl:shared/"},
- {"uri with empty prop", "oracle:thin:scott/tiger@myhost:1521:orcl?&prop2"},
- {"uri with prop having no value", "oracle:thin:scott/tiger@myhost:1521:orcl?prop1&prop2=val2"},
+ testData("null uri", null),
+ testData("uri with invalid scheme", "postgresql://user@?host=localhost&port=1234"),
+ testData("uri with no separated user/password", "oracle:thin:scott@myhost:1521:orcl"),
+ testData("uri with no separated user/password", "oracle:thin:scott@myhost:1521:orcl"),
+ testData("uri without password", "oracle:thin:scott/@myhost:1521:orcl"),
+ testData("uri without user", "oracle:thin:/tiger@myhost:1521:orcl"),
+ testData("uri with multiple user/password splitters", "oracle:thin:scott/tiger/dragon@myhost:1521:orcl"),
+ testData("uri without net location", "oracle:thin:scott/tiger"),
+ testData("uri without SID after host", "oracle:thin:scott/tiger@myhost"),
+ testData("uri without SID after port", "oracle:thin:scott/tiger@myhost:1521"),
+ testData("uri with empty SID", "oracle:thin:scott/tiger@myhost:1521:"),
+ testData("uri with invalid content after host", "oracle:thin:@[::1]sss:1521:orcl"),
+ testData("uri with invalid IPv6 address", "oracle:thin:@[:1521:orcl"),
+ testData("uri with empty host", "oracle:thin:@:1521:orcl"),
+ testData("uri with empty IPv6 address", "oracle:thin:@[]:1521:orcl"),
+ testData("uri with empty port", "oracle:thin:@myhost::orcl"),
+ testData("uri with invalid port", "oracle:thin:@myhost:7654645:orcl"),
+ testData("uri with multiple hosts and ports", "oracle:thin:scott/tiger@myhost1:1521,myhost2:1521:orcl"),
+ testData("uri with multiple hosts", "oracle:thin:scott/tiger@myhost1,myhost2:1521:orcl"),
+ testData("uri with empty props", "oracle:thin:scott/tiger@myhost:1521:orcl?"),
+ testData("uri with empty service name", "oracle:thin:scott/tiger@myhost:1521/"),
+ testData("uri with empty server mode", "oracle:thin:scott/tiger@myhost:1521/orcl:?prop=val"),
+ testData("uri with invalid server mode", "oracle:thin:scott/tiger@myhost:1521/orcl:foo"),
+ testData("uri with service name but empty instance name", "oracle:thin:scott/tiger@myhost:1521/orcl/"),
+ testData("uri with service name and server mode but empty instance name", "oracle:thin:scott/tiger@myhost:1521/orcl:shared/"),
+ testData("uri with empty prop", "oracle:thin:scott/tiger@myhost:1521:orcl?&prop2"),
+ testData("uri with prop having no value", "oracle:thin:scott/tiger@myhost:1521:orcl?prop1&prop2=val2"),
+ testData(
+ "uri with ldap syntax", "oracle:thin:@ldap://ldap.acme.com:7777/sales,cn=OracleContext,dc=com",
+ (s, e) -> {
+ assertNotNull(e.getCause());
+ assertTrue(e.getCause().getMessage().toLowerCase(ENGLISH).contains("ldap"));
+ }),
+ testData("uri with Oracle Net connection descriptor", "oracle:thin:@(DESCRIPTION=\n" +
+ " (LOAD_BALANCE=on)\n" +
+ "(ADDRESS_LIST=\n" +
+ " (ADDRESS=(PROTOCOL=TCP)(HOST=host1) (PORT=1521))\n" +
+ " (ADDRESS=(PROTOCOL=TCP)(HOST=host2)(PORT=1521)))\n" +
+ " (CONNECT_DATA=(SERVICE_NAME=service_name)))",
+ (s, e) -> {
+ assertNotNull(e.getCause());
+ assertTrue(e.getCause().getMessage().toLowerCase(ENGLISH).contains("tns url"));
+ }),
  };
  return params;
  }
 
+ private static Object[] testData(String testName, String uri) {
+ return testData(testName, uri, null);
+ }
+
+ private static Object[] testData(String testName, String uri, BiConsumer<String, Exception> assertions) {
+ return new Object[]{testName, uri, assertions};
+ }
+
  private final String connectionUri;
+ private final BiConsumer<String, Exception> assertions;
 
- public InvalidOracleConnectionUriParsingTest(@SuppressWarnings("unused") String name, String connectionUri) {
+ public InvalidOracleConnectionUriParsingTest(@SuppressWarnings("unused") String name, String connectionUri, BiConsumer<String, Exception> assertions) {
  this.connectionUri = connectionUri;
+ this.assertions = assertions;
  }
 
  @Test
@@ -75,6 +104,9 @@ public void shouldFailToParseInvalidUri() {
  } else {
  assertThat(e, is(instanceOf(IllegalArgumentException.class)));
  }
+ if (assertions != null) {
+ assertions.accept(connectionUri, e);
+ }
  }
  }
 }