address corner case

Author: winterhazel

framework/db/src/main/java/com/cloud/utils/db/TransactionLegacy.java

@@ -31,6 +31,7 @@
 import java.util.Properties;
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicLong;
+import java.util.regex.Pattern;
 
 import javax.sql.DataSource;
 
@@ -87,6 +88,13 @@ public class TransactionLegacy implements Closeable {
     public static final short CONNECTED_DB = -1;
     public static final String CONNECTION_PARAMS = "scrollTolerantForwardOnly=true";
 
+    /**
+     * Format of the pattern that matches a parameter of a connection URI: the name must be at the start of the URI
+     * parameters or right after a parameter separator, and must be followed by "=". Searching for the bare name would
+     * consider the parameter as configured when it is just part of a host, of a database name or of the value of
+     * another parameter.
+     */
+    private static final String URI_PARAM_PATTERN_FORMAT = "(?:^|[?&])%s=";
     private static final String CONNECTION_COLLATION_PARAM = "connectionCollation";
     private static final String CHARACTER_ENCODING_PARAM = "characterEncoding";
     private static final String DEFAULT_CONNECTION_COLLATION = "utf8mb4_general_ci";
@@ -1275,8 +1283,20 @@ protected static String buildConnectionUri(String loadBalanceStrategy, String dr
      * @param connectionUri the connection URI configured by the operator.
      */
     protected static boolean shouldPinConnectionCollation(String connectionUri) {
-        return !StringUtils.containsIgnoreCase(connectionUri, CONNECTION_COLLATION_PARAM)
-                && !StringUtils.containsIgnoreCase(connectionUri, CHARACTER_ENCODING_PARAM);
+        return !containsUriParam(connectionUri, CONNECTION_COLLATION_PARAM)
+                && !containsUriParam(connectionUri, CHARACTER_ENCODING_PARAM);
+    }
+
+    /**
+     * Informs whether the given parameter is defined in the connection URI.
+     *
+     * @param connectionUri the connection URI configured by the operator; it also accepts only the parameters of a URI,
+     *                      as in {@code db.<schema>.url.params};
+     * @param param the name of the parameter to look for.
+     */
+    protected static boolean containsUriParam(String connectionUri, String param) {
+        Pattern pattern = Pattern.compile(String.format(URI_PARAM_PATTERN_FORMAT, Pattern.quote(param)), Pattern.CASE_INSENSITIVE);
+        return pattern.matcher(StringUtils.defaultString(connectionUri)).find();
     }
 
     /**

framework/db/src/test/java/com/cloud/utils/db/TransactionLegacyTest.java

@@ -252,4 +252,104 @@ public void addDefaultConnectionCollationTestUriDefiningCharacterEncodingKeepsIt
 
         Assert.assertEquals(uri, TransactionLegacy.addDefaultConnectionCollation(uri));
     }
+
+    @Test
+    public void shouldPinConnectionCollationTestUriWithHostContainingTheParameterNamesReturnsTrue() {
+        Assert.assertTrue(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://characterEncoding:5555/name"));
+        Assert.assertTrue(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://connectionCollation.example.com:5555/name?someParams"));
+    }
+
+    @Test
+    public void shouldPinConnectionCollationTestUriWithDatabaseNameContainingTheParameterNamesReturnsTrue() {
+        Assert.assertTrue(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://host:5555/connectionCollation"));
+        Assert.assertTrue(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://host:5555/characterEncoding?someParams"));
+    }
+
+    @Test
+    public void shouldPinConnectionCollationTestParameterValueContainingTheParameterNamesReturnsTrue() {
+        Assert.assertTrue(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://host:5555/name?user=connectionCollation"));
+        Assert.assertTrue(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://host:5555/name?user=characterEncoding&someParams"));
+    }
+
+    @Test
+    public void shouldPinConnectionCollationTestUriDefiningTheParametersAsTheFirstOneReturnsFalse() {
+        Assert.assertFalse(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://host:5555/name?connectionCollation=utf8mb4_unicode_ci"));
+        Assert.assertFalse(TransactionLegacy.shouldPinConnectionCollation("jdbc:mysql://host:5555/name?characterEncoding=UTF-8&someParams"));
+    }
+
+    @Test
+    public void addDefaultConnectionCollationTestUriWithHostContainingTheParameterNamesAddsTheDefaultCollation() {
+        String result = TransactionLegacy.addDefaultConnectionCollation("jdbc:mysql://characterEncoding.example.com:5555/name");
+
+        Assert.assertEquals("jdbc:mysql://characterEncoding.example.com:5555/name?connectionCollation=utf8mb4_general_ci", result);
+    }
+
+    @Test
+    public void addDefaultConnectionCollationTestUriWithDatabaseNameContainingTheParameterNamesAddsTheDefaultCollation() {
+        String result = TransactionLegacy.addDefaultConnectionCollation("jdbc:mysql://host:5555/connectionCollation?someParams");
+
+        Assert.assertEquals("jdbc:mysql://host:5555/connectionCollation?someParams&connectionCollation=utf8mb4_general_ci", result);
+    }
+
+    @Test
+    public void getConnectionUriAndDriverTestWithUriWhoseDatabaseNameContainsTheParameterNamePinsTheDefaultCollation() {
+        properties.setProperty("db.cloud.uri", "jdbc:mysql://host:5555/characterEncoding");
+
+        Pair<String, String> result = TransactionLegacy.getConnectionUriAndDriver(properties, null, false, "cloud");
+
+        Assert.assertEquals("jdbc:mysql://host:5555/characterEncoding?connectionCollation=utf8mb4_general_ci", result.first());
+    }
+
+    @Test
+    public void getConnectionUriAndDriverTestWithoutUriAndDatabaseNameContainingTheParameterNamePinsTheDefaultCollation() {
+        properties.setProperty("db.cloud.uri", "");
+        properties.setProperty("db.cloud.driver", "driver");
+        properties.setProperty("db.cloud.name", "connectionCollation");
+
+        Pair<String, String> result = TransactionLegacy.getConnectionUriAndDriver(properties, null, false, "cloud");
+
+        Assert.assertEquals("driver://host:5555/connectionCollation?autoReconnect=false&someParams&scrollTolerantForwardOnly=true"
+                + "&connectionCollation=utf8mb4_general_ci", result.first());
+    }
+
+    @Test
+    public void containsUriParamTestParamDefinedAsTheFirstOneReturnsTrue() {
+        Assert.assertTrue(TransactionLegacy.containsUriParam("jdbc:mysql://host:5555/name?serverTimezone=UTC", "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestParamDefinedAfterOtherParamsReturnsTrue() {
+        Assert.assertTrue(TransactionLegacy.containsUriParam("jdbc:mysql://host:5555/name?someParams&serverTimezone=UTC", "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestOnlyTheUriParamsReturnsTrue() {
+        Assert.assertTrue(TransactionLegacy.containsUriParam("serverTimezone=UTC&someParams", "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestParamIsPartOfTheHostOrOfTheDatabaseNameReturnsFalse() {
+        Assert.assertFalse(TransactionLegacy.containsUriParam("jdbc:mysql://serverTimezone:5555/name", "serverTimezone"));
+        Assert.assertFalse(TransactionLegacy.containsUriParam("jdbc:mysql://host:5555/serverTimezone?someParams", "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestParamIsTheValueOfAnotherParamReturnsFalse() {
+        Assert.assertFalse(TransactionLegacy.containsUriParam("jdbc:mysql://host:5555/name?user=serverTimezone", "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestParamIsNotDefinedReturnsFalse() {
+        Assert.assertFalse(TransactionLegacy.containsUriParam("jdbc:mysql://host:5555/name?someParams", "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestNullConnectionUriReturnsFalse() {
+        Assert.assertFalse(TransactionLegacy.containsUriParam(null, "serverTimezone"));
+    }
+
+    @Test
+    public void containsUriParamTestIsCaseInsensitive() {
+        Assert.assertTrue(TransactionLegacy.containsUriParam("jdbc:mysql://host:5555/name?SERVERTIMEZONE=UTC", "serverTimezone"));
+    }
 }