[CALCITE-5136] Avatica build (or CI) must fail if there are deprecation warnings

Fixes applied are:
 * move `new URL(...)` to `new URI(...).toUrl()`
 * move `Assert.assertThat(...)` to `MatcherAssert.assertThat(...)`
 * move `ExpectedException` to `Assert.assertThrows(...)`
 * in all other cases either propagate the deprecation or suppress it.

Author: chrisdennis

.idea/vcs.xml

@@ -404,6 +404,7 @@ allprojects {
 
             withType<JavaCompile>().configureEach {
                 options.encoding = "UTF-8"
+                options.compilerArgs.addAll(listOf("-Xlint:deprecation,-options", "-Werror"))
             }
             withType<Test>().configureEach {
                 testLogging {

build.gradle.kts

@@ -18,7 +18,6 @@
 
 import org.apache.calcite.avatica.ha.ShuffledRoundRobinLBStrategy;
 import org.apache.calcite.avatica.remote.AvaticaHttpClientFactoryImpl;
-import org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification;
 
 import org.apache.hc.core5.util.Timeout;
 
@@ -92,8 +91,13 @@ public enum BuiltInConnectionProperty implements ConnectionProperty {
   /** Password for the key inside keystore */
   KEY_PASSWORD("key_password", Type.STRING, "", false),
 
-  HOSTNAME_VERIFICATION("hostname_verification", Type.ENUM, HostnameVerification.STRICT,
-      HostnameVerification.class, false),
+  @SuppressWarnings("deprecation")
+  HOSTNAME_VERIFICATION("hostname_verification", Type.ENUM,
+      org.apache.calcite.avatica.remote.
+          HostnameVerificationConfigurable.HostnameVerification.STRICT,
+      org.apache.calcite.avatica.remote.
+          HostnameVerificationConfigurable.HostnameVerification.class,
+      false),
 
   TRANSPARENT_RECONNECTION("transparent_reconnection", Type.BOOLEAN, Boolean.FALSE, false),
 

core/src/main/java/org/apache/calcite/avatica/BuiltInConnectionProperty.java

@@ -18,7 +18,6 @@
 
 import org.apache.calcite.avatica.ha.LBStrategy;
 import org.apache.calcite.avatica.remote.AvaticaHttpClientFactory;
-import org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification;
 import org.apache.calcite.avatica.remote.Service;
 
 import java.io.File;
@@ -64,7 +63,9 @@ public interface ConnectionConfig {
   /** @see BuiltInConnectionProperty#KEY_PASSWORD */
   String keyPassword();
   /** @see BuiltInConnectionProperty#HOSTNAME_VERIFICATION */
-  HostnameVerification hostnameVerification();
+  @SuppressWarnings("deprecation")
+  org.apache.calcite.avatica.remote.
+      HostnameVerificationConfigurable.HostnameVerification hostnameVerification();
   /** @see BuiltInConnectionProperty#TRANSPARENT_RECONNECTION */
   boolean transparentReconnectionEnabled();
   /** @see BuiltInConnectionProperty#FETCH_SIZE */

core/src/main/java/org/apache/calcite/avatica/ConnectionConfig.java

@@ -18,7 +18,6 @@
 
 import org.apache.calcite.avatica.ha.LBStrategy;
 import org.apache.calcite.avatica.remote.AvaticaHttpClientFactory;
-import org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification;
 import org.apache.calcite.avatica.remote.Service;
 
 import java.io.File;
@@ -130,9 +129,12 @@ public String keyPassword() {
 
   }
 
-  public HostnameVerification hostnameVerification() {
+  @SuppressWarnings("deprecation")
+  public org.apache.calcite.avatica.remote.
+      HostnameVerificationConfigurable.HostnameVerification hostnameVerification() {
     return BuiltInConnectionProperty.HOSTNAME_VERIFICATION.wrap(properties)
-        .getEnum(HostnameVerification.class);
+        .getEnum(org.apache.calcite.avatica.remote.
+            HostnameVerificationConfigurable.HostnameVerification.class);
   }
 
   @Override public boolean transparentReconnectionEnabled() {

core/src/main/java/org/apache/calcite/avatica/ConnectionConfigImpl.java

@@ -24,8 +24,6 @@
 import org.apache.hc.client5.http.auth.AuthScope;
 import org.apache.hc.client5.http.auth.Credentials;
 import org.apache.hc.client5.http.auth.CredentialsProvider;
-import org.apache.hc.client5.http.auth.KerberosConfig;
-import org.apache.hc.client5.http.auth.KerberosCredentials;
 import org.apache.hc.client5.http.auth.StandardAuthScheme;
 import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
 import org.apache.hc.client5.http.classic.methods.HttpPost;
@@ -34,7 +32,6 @@
 import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
 import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory;
 import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory;
-import org.apache.hc.client5.http.impl.auth.SPNegoSchemeFactory;
 import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
 import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
 import org.apache.hc.client5.http.impl.classic.HttpClients;
@@ -78,8 +75,10 @@ public class AvaticaCommonsHttpClientImpl implements AvaticaHttpClient, HttpClie
   private static final boolean USE_CANONICAL_HOSTNAME = Boolean
       .parseBoolean(System.getProperty("avatica.http.spnego.use_canonical_hostname", "true"));
   private static final boolean STRIP_PORT_ON_SERVER_LOOKUP = true;
-  private static final KerberosConfig KERBEROS_CONFIG =
-          KerberosConfig.custom().setStripPort(STRIP_PORT_ON_SERVER_LOOKUP)
+  @SuppressWarnings("deprecation")
+  private static final org.apache.hc.client5.http.auth.KerberosConfig KERBEROS_CONFIG =
+      org.apache.hc.client5.http.auth.KerberosConfig.custom()
+          .setStripPort(STRIP_PORT_ON_SERVER_LOOKUP)
           .setUseCanonicalHostname(USE_CANONICAL_HOSTNAME)
           .build();
   private static AuthScope anyAuthScope = new AuthScope(null, -1);
@@ -98,10 +97,15 @@ public class AvaticaCommonsHttpClientImpl implements AvaticaHttpClient, HttpClie
   protected long connectTimeout;
   protected long responseTimeout;
 
+  @Deprecated
   public AvaticaCommonsHttpClientImpl(URL url) {
     this.uri = toURI(Objects.requireNonNull(url));
   }
 
+  public AvaticaCommonsHttpClientImpl(URI uri) {
+    this.uri = uri;
+  }
+
   protected void initializeClient(PoolingHttpClientConnectionManager pool,
                                   ConnectionConfig config) {
     this.authCache = new BasicAuthCache();
@@ -128,6 +132,7 @@ protected void initializeClient(PoolingHttpClientConnectionManager pool,
   }
 
   // This is needed because we initialize the client object too early.
+  @SuppressWarnings("deprecation")
   private RequestConfig createRequestConfig() {
     RequestConfig.Builder requestConfigBuilder = RequestConfig.custom();
     requestConfigBuilder
@@ -225,19 +230,23 @@ ClassicHttpResponse executeOpen(HttpHost httpHost, HttpPost post, HttpClientCont
     context.setRequestConfig(createRequestConfig());
   }
 
+  @SuppressWarnings("deprecation")
   @Override public void setGSSCredential(GSSCredential credential) {
 
     this.authRegistry = RegistryBuilder.<AuthSchemeFactory>create()
         .register(StandardAuthScheme.SPNEGO,
-                new SPNegoSchemeFactory(KERBEROS_CONFIG, SystemDefaultDnsResolver.INSTANCE))
+                new org.apache.hc.client5.http.impl.auth.SPNegoSchemeFactory(
+                    KERBEROS_CONFIG,
+                    SystemDefaultDnsResolver.INSTANCE))
         .build();
 
     this.credentialsProvider = new BasicCredentialsProvider();
     if (null != credential) {
       // Non-null credential should be used directly with KerberosCredentials.
       // This is never set by the JDBC driver, nor the tests
       ((BasicCredentialsProvider) this.credentialsProvider)
-              .setCredentials(anyAuthScope, new KerberosCredentials(credential));
+              .setCredentials(anyAuthScope,
+                  new org.apache.hc.client5.http.auth.KerberosCredentials(credential));
     } else {
       // A null credential implies that the user is logged in via JAAS using the
       // java.security.auth.login.config system property
@@ -255,6 +264,7 @@ ClassicHttpResponse executeOpen(HttpHost httpHost, HttpPost post, HttpClientCont
   private static class EmptyCredentials implements Credentials {
     public static final EmptyCredentials INSTANCE = new EmptyCredentials();
 
+    @Deprecated
     @Override public char[] getPassword() {
       return null;
     }

core/src/main/java/org/apache/calcite/avatica/remote/AvaticaCommonsHttpClientImpl.java

@@ -53,6 +53,7 @@ public static AvaticaHttpClientFactoryImpl getInstance() {
     return INSTANCE;
   }
 
+  @SuppressWarnings("deprecation")
   @Override public AvaticaHttpClient getClient(URL url, ConnectionConfig config,
       KerberosConnection kerberosUtil) {
     String className = config.httpClientClass();

core/src/main/java/org/apache/calcite/avatica/remote/AvaticaHttpClientFactoryImpl.java

@@ -17,7 +17,6 @@
 package org.apache.calcite.avatica.remote;
 
 import org.apache.calcite.avatica.ConnectionConfig;
-import org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification;
 
 import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
 import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
@@ -128,11 +127,15 @@ private static void loadTrustStore(SSLContextBuilder sslContextBuilder, Connecti
    * @throws IllegalArgumentException if the provided verification cannot be
    *                                  handled.
    */
-  private static HostnameVerifier getHostnameVerifier(HostnameVerification verification) {
+  @SuppressWarnings("deprecation")
+  private static HostnameVerifier getHostnameVerifier(
+      org.apache.calcite.avatica.remote.
+          HostnameVerificationConfigurable.HostnameVerification verification) {
     // Normally, the configuration logic would give us a default of STRICT if it was
     // not provided by the user. It's easy for us to do a double-check.
     if (verification == null) {
-      verification = HostnameVerification.STRICT;
+      verification = org.apache.calcite.avatica.remote.
+          HostnameVerificationConfigurable.HostnameVerification.STRICT;
     }
     switch (verification) {
     case STRICT:

core/src/main/java/org/apache/calcite/avatica/remote/CommonsHttpClientPoolCache.java

@@ -28,6 +28,8 @@
 import org.slf4j.LoggerFactory;
 
 import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.net.URL;
 import java.sql.Connection;
 import java.sql.SQLException;
@@ -156,8 +158,8 @@ AvaticaHttpClient getHttpClient(AvaticaConnection connection, ConnectionConfig c
       urlStr = config.url();
     }
     try {
-      url = new URL(urlStr);
-    } catch (MalformedURLException e) {
+      url = new URI(urlStr).toURL();
+    } catch (MalformedURLException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
 

core/src/main/java/org/apache/calcite/avatica/remote/Driver.java

@@ -59,8 +59,8 @@ public static Source file(File baseDirectory, String fileName) {
 
   public static Source url(String url) {
     try {
-      return of(new URL(url));
-    } catch (MalformedURLException | IllegalArgumentException e) {
+      return of(new URI(url).toURL());
+    } catch (MalformedURLException | IllegalArgumentException | URISyntaxException e) {
       throw new RuntimeException("Malformed URL: '" + url + "'", e);
     }
   }
@@ -133,11 +133,7 @@ private static URL fileToUrl(File file) {
           filePath += "/";
         }
         try {
-          // We need to encode path. For instance, " " should become "%20"
-          // That is why java.net.URLEncoder.encode(java.lang.String, java.lang.String) is not
-          // suitable because it replaces " " with "+".
-          String encodedPath = new URI(null, null, filePath, null).getRawPath();
-          return new URL("file", null, 0, encodedPath);
+          return new URI("file", filePath, null).toURL();
         } catch (MalformedURLException | URISyntaxException e) {
           throw new IllegalArgumentException("Unable to create URL for file " + filePath, e);
         }