SCANNERAPI-182 change read timeout to be configurable (#60)

Author: CSchulz

api/src/main/java/org/sonarsource/scanner/api/internal/OkHttpClientFactory.java

@@ -46,8 +46,9 @@
 
 public class OkHttpClientFactory {
 
+  static final String READ_TIMEOUT_SEC_PROPERTY = "sonar.ws.timeout";
   static final int CONNECT_TIMEOUT_MILLISECONDS = 5_000;
-  static final int READ_TIMEOUT_MILLISECONDS = 500_000;
+  static final int DEFAULT_READ_TIMEOUT_MILLISECONDS = 500_000;
   static final String NONE = "NONE";
   static final String P11KEYSTORE = "PKCS11";
   private static final String PROXY_AUTHORIZATION = "Proxy-Authorization";
@@ -59,8 +60,13 @@ private OkHttpClientFactory() {
   static OkHttpClient create(Logger logger) {
     OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();
 
+    int readTimeout = DEFAULT_READ_TIMEOUT_MILLISECONDS;
+    if (!System.getProperty(READ_TIMEOUT_SEC_PROPERTY, "").isEmpty()) {
+      readTimeout = Integer.parseInt(System.getProperty(READ_TIMEOUT_SEC_PROPERTY));
+    }
+
     okHttpClientBuilder.connectTimeout(CONNECT_TIMEOUT_MILLISECONDS, TimeUnit.MILLISECONDS);
-    okHttpClientBuilder.readTimeout(READ_TIMEOUT_MILLISECONDS, TimeUnit.MILLISECONDS);
+    okHttpClientBuilder.readTimeout(readTimeout, TimeUnit.MILLISECONDS);
 
     ConnectionSpec tls = new ConnectionSpec.Builder(ConnectionSpec.MODERN_TLS)
       .allEnabledTlsVersions()

api/src/test/java/org/sonarsource/scanner/api/internal/OkHttpClientFactoryTest.java

@@ -40,6 +40,8 @@
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
 import okhttp3.mockwebserver.RecordedRequest;
+
+import org.junit.After;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.experimental.theories.DataPoint;
@@ -51,6 +53,7 @@
 
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.assertj.core.api.Assertions.fail;
 import static org.mockito.Mockito.mock;
 
@@ -65,10 +68,16 @@ public class OkHttpClientFactoryTest {
   private static final String KEYSTORE_PASSWORD = "abcdef";
   private static final String KEYSTORE_FILE = "/server.jks";
   private static final Logger logger = mock(Logger.class);
+  private static final String SONAR_WS_TIMEOUT = "sonar.ws.timeout";
 
   @Rule
   public ExpectedException expectedException = ExpectedException.none();
 
+  @After
+  public void cleanSystemProperty() {
+    System.clearProperty(SONAR_WS_TIMEOUT);
+  }
+
   @Test
   public void support_tls_versions_of_java8() {
     OkHttpClient underTest = OkHttpClientFactory.create(logger);
@@ -77,6 +86,25 @@ public void support_tls_versions_of_java8() {
     assertThat(underTest.sslSocketFactory()).isInstanceOf(SSLSocketFactory.getDefault().getClass());
   }
 
+  @Test
+  public void support_custom_timeouts() {
+    int readTimeout = 2000;
+    System.setProperty(SONAR_WS_TIMEOUT, String.valueOf(readTimeout));
+
+    Logger logger = mock(Logger.class);
+    OkHttpClient underTest = OkHttpClientFactory.create(logger);
+
+    assertThat(underTest.readTimeoutMillis()).isEqualTo(readTimeout);
+  }
+
+  @Test
+  public void support_custom_timeouts_throws_exception_on_non_number() {
+    System.setProperty(SONAR_WS_TIMEOUT, "fail");
+
+    Logger logger = mock(Logger.class);
+    assertThatThrownBy(() -> OkHttpClientFactory.create(logger)).isInstanceOf(NumberFormatException.class);
+  }
+
   private void assertTlsAndClearTextSpecifications(OkHttpClient client) {
     List<ConnectionSpec> connectionSpecs = client.connectionSpecs();
     assertThat(connectionSpecs).hasSize(2);