Skip to content

Commit

Permalink
reworked the oracle url parser to correctly parse easy connect urls. …
Browse files Browse the repository at this point in the history 
…implemented tests with junit5. (#58)
  • Loading branch information
@dimovelev @malafeev
dimovelev authored and malafeev committed Jan 2, 2020
1 parent a38d7e9 commit 90e6b8c
Show file tree
Hide file tree
Showing 3 changed files with 222 additions and 112 deletions.
18 changes: 18 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,24 @@
<version>3.13.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.5.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-launcher</artifactId>
<version>1.5.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
<version>5.5.2</version>
<scope>test</scope>
</dependency>

</dependencies>

Expand Down
229 changes: 117 additions & 112 deletions src/main/java/io/opentracing/contrib/jdbc/parser/OracleURLParser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,135 +13,140 @@
*/
package io.opentracing.contrib.jdbc.parser;

import io.opentracing.contrib.jdbc.ConnectionInfo;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class OracleURLParser extends AbstractURLParser {
import io.opentracing.contrib.jdbc.ConnectionInfo;

public static final String SERVICE_NAME_FLAG = "@//";
public static final String TNSNAME_URL_FLAG = "DESCRIPTION";
public static final String SID_NAME_FLAG = "@";
private static final String DB_TYPE = "oracle";
private static final int DEFAULT_PORT = 1521;
public class OracleURLParser implements ConnectionURLParser {
public static final String DB_TYPE = "oracle";
public static final String PREFIX = "jdbc:oracle:thin:";
public static final int DEFAULT_PORT = 1521;
private static Pattern EASY_CONNECT_PATTERN = Pattern.compile(
"(?<username>.*)@(//)?(?<host>[^:/]+)(?<port>:[0-9]+)?(?<service>[:/][^:/]+)?(?<server>:[^:/]+)?(?<instance>/[^:/]+)?");

@Override
protected URLLocation fetchDatabaseHostsIndexRange(String url) {
int hostLabelStartIndex;
if (isServiceNameURL(url)) {
hostLabelStartIndex = url.indexOf(SERVICE_NAME_FLAG) + 3;
} else {
hostLabelStartIndex = url.indexOf("@") + 1;
}
int hostLabelEndIndex = url.lastIndexOf(":");
if (isSIDNameURL(url)) {
hostLabelEndIndex = url.length();
@Override
public ConnectionInfo parse(final String url) {
if (url != null && url.startsWith(PREFIX)) {
OracleConnectionInfo connectionInfo = parseTnsName(url.substring(PREFIX.length()));
if (connectionInfo == null) {
connectionInfo = parseEasyConnect(url.substring(PREFIX.length()));
}
if (connectionInfo != null) {
return new ConnectionInfo.Builder(connectionInfo.getDbPeer()) //
.dbType(DB_TYPE) //
.dbInstance(connectionInfo.getDbInstance()) //
.build();
}
}
return null;
}
return new URLLocation(hostLabelStartIndex, hostLabelEndIndex);
}

@Override
protected URLLocation fetchDatabaseNameIndexRange(String url) {
int hostLabelStartIndex;
int hostLabelEndIndex = url.length();
if (isServiceNameURL(url)) {
hostLabelStartIndex = url.lastIndexOf("/") + 1;
} else if (isTNSNameURL(url)) {
hostLabelStartIndex = url.indexOf("=", url.indexOf("SERVICE_NAME")) + 1;
hostLabelEndIndex = url.indexOf(")", hostLabelStartIndex);
} else if (isSIDNameURL(url)) {
hostLabelStartIndex = url.indexOf("@") + 1;
} else {
hostLabelStartIndex = url.lastIndexOf(":") + 1;
private OracleConnectionInfo parseTnsName(final String url) {
final String hosts = parseDatabaseHostsFromTnsUrl(url);
if (hosts != null) {
final int idxServiceName = url.indexOf("SERVICE_NAME");
final int start = url.indexOf('=', idxServiceName) + 1;
final int end = url.indexOf(")", start);
final String serviceName = url.substring(start, end);
return new OracleConnectionInfo() //
.setDbPeer(hosts) //
.setDbInstance(serviceName);
}
return null;
}
return new URLLocation(hostLabelStartIndex, hostLabelEndIndex);
}

private boolean isServiceNameURL(String url) {
return url.contains(SERVICE_NAME_FLAG);
}
public static String parseDatabaseHostsFromTnsUrl(String url) {
int beginIndex = url.indexOf("DESCRIPTION");
if (beginIndex == -1) {
return null;
}
List<String> hosts = new ArrayList<String>();
do {
int hostStartIndex = url.indexOf("HOST", beginIndex);
if (hostStartIndex == -1) {
break;
}
int equalStartIndex = url.indexOf("=", hostStartIndex);
int hostEndIndex = url.indexOf(")", hostStartIndex);
String host = url.substring(equalStartIndex + 1, hostEndIndex);

private boolean isSIDNameURL(String url) {
return url.contains(SID_NAME_FLAG) && !url.contains(SERVICE_NAME_FLAG) && !url
.substring(url.indexOf(SID_NAME_FLAG) + 1).contains(":");
}

private boolean isTNSNameURL(String url) {
return url.contains(TNSNAME_URL_FLAG);
}
int port = DEFAULT_PORT;
int portStartIndex = url.indexOf("PORT", hostEndIndex);
int portEndIndex = url.length();
if (portStartIndex != -1) {
int portEqualStartIndex = url.indexOf("=", portStartIndex);
portEndIndex = url.indexOf(")", portEqualStartIndex);
port = Integer.parseInt(url.substring(portEqualStartIndex + 1, portEndIndex).trim());
}
hosts.add(host.trim() + ":" + port);
beginIndex = portEndIndex;
} while (true);
return join(",", hosts);
}

@Override
public ConnectionInfo parse(String url) {
if (isTNSNameURL(url)) {
return tnsNameURLParse(url);
} else {
return commonsURLParse(url);
private static String join(String delimiter, List<String> list) {
if (list == null || list.isEmpty()) {
return "";
}
StringBuilder builder = new StringBuilder();
for (int i = 0, len = list.size(); i < len; i++) {
if (i == (len - 1)) {
builder.append(list.get(i));
} else {
builder.append(list.get(i)).append(delimiter);
}
}
return builder.toString();
}
}

private ConnectionInfo commonsURLParse(final String url) {
String host = fetchDatabaseHostsFromURL(url);
String[] hostSegment = splitDatabaseAddress(host);
String databaseName = fetchDatabaseNameFromURL(url);
if (hostSegment.length == 1) {
return new ConnectionInfo.Builder(host, DEFAULT_PORT).dbType(DB_TYPE).dbInstance(databaseName)
.build();
} else {
return new ConnectionInfo.Builder(hostSegment[0], Integer.valueOf(hostSegment[1]))
.dbType(DB_TYPE).dbInstance(databaseName).build();
/**
* Implementation according to https://www.oracle.com/technetwork/database/enterprise-edition/oraclenetservices-neteasyconnect-133058.pdf
*
* @param url the url without the oracle jdbc prefix
* @return the oracle connection info if the url could be parsed, or null otherwise.
*/
public static OracleConnectionInfo parseEasyConnect(final String url) {
final Matcher matcher = EASY_CONNECT_PATTERN.matcher(url);
if (matcher.matches()) {
final OracleConnectionInfo result = new OracleConnectionInfo();
final String host = matcher.group("host");
final String portGroup = matcher.group("port");
final int dbPort = portGroup != null ? Integer.parseInt(portGroup.substring(1)) : DEFAULT_PORT;
result.setDbPeer(host + ":" + dbPort);
final String service = matcher.group("service");
if (service != null) {
result.setDbInstance(service.substring(1));
} else {
result.setDbInstance(host);
}
return result;
}
return null;
}
}

private ConnectionInfo tnsNameURLParse(final String url) {
String host = parseDatabaseHostsFromURL(url);
String databaseName = fetchDatabaseNameFromURL(url);
return new ConnectionInfo.Builder(host).dbType(DB_TYPE).dbInstance(databaseName).build();
}
public static class OracleConnectionInfo {
private String dbInstance;
private String dbPeer;

private String parseDatabaseHostsFromURL(String url) {
int beginIndex = url.indexOf("DESCRIPTION");
List<String> hosts = new ArrayList<String>();
do {
int hostStartIndex = url.indexOf("HOST", beginIndex);
if (hostStartIndex == -1) {
break;
}
int equalStartIndex = url.indexOf("=", hostStartIndex);
int hostEndIndex = url.indexOf(")", hostStartIndex);
String host = url.substring(equalStartIndex + 1, hostEndIndex);
public String getDbInstance() {
return dbInstance;
}

int port = DEFAULT_PORT;
int portStartIndex = url.indexOf("PORT", hostEndIndex);
int portEndIndex = url.length();
if (portStartIndex != -1) {
int portEqualStartIndex = url.indexOf("=", portStartIndex);
portEndIndex = url.indexOf(")", portEqualStartIndex);
port = Integer.parseInt(url.substring(portEqualStartIndex + 1, portEndIndex).trim());
}
hosts.add(host.trim() + ":" + port);
beginIndex = portEndIndex;
}
while (true);
return join(",", hosts);
}
public OracleConnectionInfo setDbInstance(final String dbInstance) {
this.dbInstance = dbInstance;
return this;
}

private String join(String delimiter, List<String> list) {
if (list == null || list.isEmpty()) {
return "";
}
StringBuilder builder = new StringBuilder();
for (int i = 0, len = list.size(); i < len; i++) {
if (i == (len - 1)) {
builder.append(list.get(i));
} else {
builder.append(list.get(i)).append(delimiter);
}
}
return builder.toString();
}
public String getDbPeer() {
return dbPeer;
}

private String[] splitDatabaseAddress(String address) {
String[] hostSegment = address.split(":");
return hostSegment;
}
public OracleConnectionInfo setDbPeer(final String dbPeer) {
this.dbPeer = dbPeer;
return this;
}
}
}
87 changes: 87 additions & 0 deletions src/test/java/io/opentracing/contrib/jdbc/parser/OracleURLParserTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/*
* Copyright 2017-2019 The OpenTracing Authors
*
* 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.opentracing.contrib.jdbc.parser;

import java.util.stream.Stream;

import io.opentracing.contrib.jdbc.ConnectionInfo;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import static org.assertj.core.api.Assertions.assertThat;

class OracleURLParserTest {
private static final String ORACLE = "oracle";
private final OracleURLParser testee = new OracleURLParser();

private static Stream<Arguments> easyConnectUrls() {
return Stream.of( //
Arguments.of("jdbc:oracle:thin:@192.168.105.100", "192.168.105.100:1521", "192.168.105.100"), //
Arguments.of("jdbc:oracle:thin:@192.168.105.100:1234", "192.168.105.100:1234", "192.168.105.100"), //
Arguments.of("jdbc:oracle:thin:@localhost/XEPDB1", "localhost:1521", "XEPDB1"), //
Arguments.of("jdbc:oracle:thin:@localhost:1234/XEPDB1", "localhost:1234", "XEPDB1"), //
Arguments.of("jdbc:oracle:thin:@//localhost:1234/XEPDB1", "localhost:1234", "XEPDB1"), //
Arguments.of("jdbc:oracle:thin:@//localhost:1234/XEPDB1:server/instance", "localhost:1234", "XEPDB1") //
);
}

private static Stream<Arguments> tnsNameUrls() {
return Stream.of( //
Arguments
.of("jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST= localhost )(PORT= 1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=orcl)))",
"localhost:1521", "orcl"), //
Arguments
.of("jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL= TCP)(HOST=hostA)(PORT= 1523 ))(ADDRESS=(PROTOCOL=TCP)(HOST=hostB)(PORT= 1521 )))(SOURCE_ROUTE=yes)(CONNECT_DATA=(SERVICE_NAME=orcl)))",
"hostA:1523,hostB:1521", "orcl") //
);
}

private static Stream<Arguments> otherUrls() {
return Stream.of( //
Arguments.of("jdbc:oracle:thin:@localhost:orcl", "localhost:1521", "orcl"), //
Arguments.of("jdbc:oracle:thin:@localhost:1522:orcl", "localhost:1522", "orcl"), //
Arguments.of("jdbc:oracle:thin:@//localhost:1521/orcl", "localhost:1521", "orcl"), //
Arguments.of("jdbc:oracle:thin:scott/tiger@myhost:1521:orcl", "myhost:1521", "orcl"), //
Arguments.of("jdbc:oracle:thin:@orcl", "orcl:1521", "orcl") //
);
}

@ParameterizedTest(name = "[{0}]")
@MethodSource("easyConnectUrls")
void parseEasyConnect(final String url, final String dbPeer, final String dbInstance) {
final ConnectionInfo result = testee.parse(url);
assertThat(result.getDbType()).isEqualTo(ORACLE);
assertThat(result.getDbPeer()).isEqualTo(dbPeer);
assertThat(result.getDbInstance()).isEqualTo(dbInstance);
}

@ParameterizedTest(name = "[{0}]")
@MethodSource("tnsNameUrls")
void parseTnsName(final String url, final String dbPeer, final String dbInstance) {
final ConnectionInfo result = testee.parse(url);
assertThat(result.getDbType()).isEqualTo(ORACLE);
assertThat(result.getDbPeer()).isEqualTo(dbPeer);
assertThat(result.getDbInstance()).isEqualTo(dbInstance);
}

@ParameterizedTest(name = "[{0}]")
@MethodSource("otherUrls")
void parseOther(final String url, final String dbPeer, final String dbInstance) {
final ConnectionInfo result = testee.parse(url);
assertThat(result.getDbType()).isEqualTo(ORACLE);
assertThat(result.getDbPeer()).isEqualTo(dbPeer);
assertThat(result.getDbInstance()).isEqualTo(dbInstance);
}
}

0 comments on commit 90e6b8c

Please sign in to comment.