feat: Support HTTP proxies with credentials. (#2176)

Author: jdm-square

buildSrc/src/main/kotlin/Dependencies.kt

@@ -36,6 +36,7 @@ object Dependencies {
     //endregion ktor
 
     const val LOGBACK = "ch.qos.logback:logback-classic:${Versions.LOGBACK}"
+    const val JBOSS_LOGGING = "org.jboss.logging:commons-logging-jboss-logging:${Versions.JBOSS_LOGGING}"
 
     const val WOODSTOX = "com.fasterxml.woodstox:woodstox-core:${Versions.WOODSTOX}"
 

buildSrc/src/main/kotlin/Versions.kt

@@ -89,6 +89,11 @@ object Versions {
     // https://commons.apache.org/proper/commons-text/
     const val COMMON_TEXT = "1.9"
 
+    // https://github.com/jboss-logging/commons-logging-jboss-logging
+    // JBoss logging dep is used by the Google Auth library when configuring a proxy.
+    // https://github.com/googleapis/google-auth-library-java#configuring-a-proxy
+    const val JBOSS_LOGGING = "1.0.0.Final"
+
     // https://github.com/fusesource/jansi/releases
     const val JANSI = "2.4.0"
 

docs/index.md

@@ -1058,7 +1058,13 @@ and flank's example [gradle-export-api](https://github.com/Flank/flank/tree/mast
 6) > How can I find project id?
    
   Please check the [firebase documentation](https://firebase.google.com/docs/projects/learn-more?hl=en#find_the_project_id) about finding the project id
+
+7) > How do I run Flank with a proxy?
+  
+  `java -Dhttps.proxyHost=localhost -Dhttps.proxyPort=8080 -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass -jar ./test_runner/build/libs/flank.jar firebase test android run`
 
+  See [google-auth-library-java](https://github.com/googleapis/google-auth-library-java#configuring-a-proxy) for details.
+  
 
 # Resources
 

test_runner/build.gradle.kts

@@ -195,6 +195,7 @@ dependencies {
     implementation(Dependencies.KOTLIN_REFLECT)
 
     implementation(Dependencies.LOGBACK)
+    implementation(Dependencies.JBOSS_LOGGING)
 
     implementation(Dependencies.PICOCLI)
     annotationProcessor(Dependencies.PICOCLI_CODEGEN)

test_runner/src/main/kotlin/ftl/client/google/Credentials.kt

@@ -2,6 +2,8 @@ package ftl.client.google
 
 import com.google.api.client.http.GoogleApiLogger
 import com.google.api.client.http.HttpRequestInitializer
+import com.google.api.client.http.apache.v2.ApacheHttpTransport
+import com.google.auth.http.HttpTransportFactory
 import com.google.auth.oauth2.AccessToken
 import com.google.auth.oauth2.GoogleCredentials
 import com.google.auth.oauth2.ServiceAccountCredentials
@@ -10,6 +12,12 @@ import flank.common.isWindows
 import ftl.config.FtlConstants
 import ftl.http.HttpTimeoutIncrease
 import ftl.run.exception.FlankGeneralError
+import org.apache.http.HttpHost
+import org.apache.http.auth.AuthScope
+import org.apache.http.auth.UsernamePasswordCredentials
+import org.apache.http.impl.client.BasicCredentialsProvider
+import org.apache.http.impl.client.ProxyAuthenticationStrategy
+import org.apache.http.impl.conn.DefaultProxyRoutePlanner
 import java.io.IOException
 import java.util.Date
 
@@ -19,7 +27,12 @@ val credential: GoogleCredentials by lazy {
         else ->
             runCatching {
                 GoogleApiLogger.silenceComputeEngine()
-                ServiceAccountCredentials.getApplicationDefault()
+                val httpTransportFactory = getHttpTransportFactory()
+                if (httpTransportFactory != null) {
+                    ServiceAccountCredentials.getApplicationDefault(httpTransportFactory)
+                } else {
+                    ServiceAccountCredentials.getApplicationDefault()
+                }
             }.getOrElse {
                 when {
                     isWindows -> loadCredentialsWindows()
@@ -29,6 +42,31 @@ val credential: GoogleCredentials by lazy {
     }
 }
 
+private fun getHttpTransportFactory(): HttpTransportFactory? {
+    val proxyHost = System.getProperty("http.proxyHost") ?: return null
+    val proxyPort = System.getProperty("http.proxyPort")?.toInt() ?: return null
+    val proxyPassword = System.getProperty("http.proxyPassword") ?: return null
+    val proxyUsername = System.getProperty("http.proxyUser") ?: return null
+
+    val proxyHostDetails = HttpHost(proxyHost, proxyPort)
+    val httpRoutePlanner = DefaultProxyRoutePlanner(proxyHostDetails)
+
+    val credentialsProvider = BasicCredentialsProvider()
+    credentialsProvider.setCredentials(
+        AuthScope(proxyHostDetails.getHostName(), proxyHostDetails.getPort()),
+        UsernamePasswordCredentials(proxyUsername, proxyPassword)
+    )
+
+    val httpClient = ApacheHttpTransport.newDefaultHttpClientBuilder()
+        .setRoutePlanner(httpRoutePlanner)
+        .setProxyAuthenticationStrategy(ProxyAuthenticationStrategy.INSTANCE)
+        .setDefaultCredentialsProvider(credentialsProvider)
+        .build()
+
+    val httpTransport = ApacheHttpTransport(httpClient)
+    return HttpTransportFactory { httpTransport }
+}
+
 private fun loadCredentialsWindows() = runCatching {
     loadGoogleAccountCredentials()
 }.getOrElse {