Merge pull request #16 from exceptionless/testing

Added unit tests for settings package

Author: pc9795

src/main/java/com/exceptionless/exceptionlessclient/models/settings/ServerSettings.java

@@ -2,20 +2,26 @@
 
 import com.exceptionless.exceptionlessclient.models.enums.ServerSettingKey;
 import com.exceptionless.exceptionlessclient.utils.Utils;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 import lombok.Builder;
 import lombok.Value;
 import lombok.experimental.NonFinal;
 
 import java.util.*;
 import java.util.stream.Collectors;
 
-@Builder
+@JsonDeserialize(builder = ServerSettings.ServerSettingsBuilder.class)
+@Builder(builderClassName = "ServerSettingsBuilder")
 @Value
 @NonFinal
 public class ServerSettings {
-  long version;
-  @Builder.Default
-  Map<String, String> settings = new HashMap<>();
+  Long version;
+  @Builder.Default Map<String, String> settings = new HashMap<>();
+
+  // Required for Jackson to work with Lombok Immutable(@Value + @Builder)
+  @JsonPOJOBuilder(withPrefix = "")
+  public static class ServerSettingsBuilder {}
 
   public Optional<String> getTypeAndSourceSetting(String type, String source) {
     String prefix = String.format("@@%s", type);

src/main/java/com/exceptionless/exceptionlessclient/models/submission/SettingsResponse.java

@@ -9,8 +9,12 @@
 @Value
 @NonFinal
 public class SettingsResponse {
-  private boolean success;
-  private ServerSettings settings;
-  private Exception exception;
-  private String message;
+  @Builder.Default Boolean success = false;
+  ServerSettings settings;
+  Exception exception;
+  String message;
+
+  public Boolean isSuccess() {
+    return success;
+  }
 }

src/main/java/com/exceptionless/exceptionlessclient/settings/DefaultSettingsClient.java

@@ -4,18 +4,16 @@
 import com.exceptionless.exceptionlessclient.models.settings.ServerSettings;
 import com.exceptionless.exceptionlessclient.models.submission.SettingsResponse;
 import com.exceptionless.exceptionlessclient.utils.Utils;
+import com.exceptionless.exceptionlessclient.utils.VisibleForTesting;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.Builder;
 
-import java.io.IOException;
 import java.net.URI;
-import java.net.URISyntaxException;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
 import java.time.Duration;
 
-
 public class DefaultSettingsClient implements SettingsClientIF {
   private final Configuration configuration;
   private final HttpClient httpClient;
@@ -26,14 +24,20 @@ public DefaultSettingsClient(Configuration configuration) {
     this.httpClient = HttpClient.newHttpClient();
   }
 
+  @VisibleForTesting
+  DefaultSettingsClient(Configuration configuration, HttpClient httpClient) {
+    this.configuration = configuration;
+    this.httpClient = httpClient;
+  }
+
   @Override
   public SettingsResponse getSettings(long version) {
     try {
       URI uri =
           new URI(
               String.format(
                   "%s/api/v2/projects/config?v=%s&access_token=%s",
-                  version, configuration.getServerUrl(), configuration.getApiKey()));
+                  configuration.getServerUrl(), version, configuration.getApiKey()));
 
       HttpRequest request =
           HttpRequest.newBuilder()
@@ -54,7 +58,7 @@ public SettingsResponse getSettings(long version) {
           Utils.JSON_MAPPER.readValue(response.body(), new TypeReference<ServerSettings>() {});
 
       return SettingsResponse.builder().success(true).settings(serverSettings).build();
-    } catch (URISyntaxException | InterruptedException | IOException e) {
+    } catch (Exception e) {
       return SettingsResponse.builder().success(false).exception(e).message(e.getMessage()).build();
     }
   }

src/main/java/com/exceptionless/exceptionlessclient/settings/SettingsManager.java

@@ -71,10 +71,10 @@ public void updateSettings() {
 
       SettingsResponse response = settingsClient.getSettings(currentVersion);
       if (!response.isSuccess()) {
-        LOG.warn(String.format("Unable to update settings: %s:", response.getMessage()));
+        LOG.warn(String.format("Unable to update settings: %s", response.getMessage()));
         return;
       }
-      ServerSettings prevValue = storageProvider.getSettings().peek().getValue();
+      ServerSettings prevValue = getSavedServerSettings();
       storageProvider.getSettings().save(response.getSettings());
       propertyChangeSupport.firePropertyChange("settings", prevValue, response.getSettings());
     } finally {

src/main/java/com/exceptionless/exceptionlessclient/utils/Utils.java

@@ -61,20 +61,16 @@ public static Map<String, List<String>> getQueryParams(URI uri) {
 
   public static boolean match(String value, String pattern) {
     if (value == null) {
-      // todo remove
-      LOG.info("Null received for value");
       return false;
     }
     if (pattern == null) {
-      // todo remove
-      LOG.info("Null received for pattern");
       return false;
     }
     // todo check this works or not;
     boolean result = value.toLowerCase().matches(pattern);
+
     if (result) {
-      // todo remove
-      LOG.info(String.format("Value [%s] matches pattern [%s]", value, pattern));
+      LOG.trace(String.format("Value [%s] matches pattern [%s]", value, pattern));
       return true;
     }
     return false;

src/test/java/com/exceptionless/exceptionlessclient/settings/DefaultSettingsClientTest.java

@@ -0,0 +1,110 @@
+package com.exceptionless.exceptionlessclient.settings;
+
+import com.exceptionless.exceptionlessclient.TestFixtures;
+import com.exceptionless.exceptionlessclient.configuration.Configuration;
+import com.exceptionless.exceptionlessclient.models.settings.ServerSettings;
+import com.exceptionless.exceptionlessclient.models.submission.SettingsResponse;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import java.io.IOException;
+import java.net.http.HttpClient;
+import java.net.http.HttpResponse;
+import java.time.Duration;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.argThat;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.doThrow;
+
+@ExtendWith(MockitoExtension.class)
+public class DefaultSettingsClientTest {
+  @Mock private HttpClient httpClient;
+  @Mock private HttpResponse<String> response;
+  private DefaultSettingsClient settingsClient;
+
+  @BeforeEach
+  public void setup() {
+    Configuration configuration =
+        TestFixtures.aDefaultConfiguration()
+            .serverUrl("http://test-server-url")
+            .apiKey("test-api-key")
+            .settingsClientTimeoutInMillis(10)
+            .build();
+    settingsClient = new DefaultSettingsClient(configuration, httpClient);
+  }
+
+  @Test
+  public void itCanHandleASuccessfulResponse() throws IOException, InterruptedException {
+    doReturn(response)
+        .when(httpClient)
+        .send(
+            argThat(
+                httpRequest ->
+                    httpRequest.method().equals("GET")
+                        && httpRequest.timeout().isPresent()
+                        && httpRequest.timeout().get().equals(Duration.ofMillis(10))
+                        && httpRequest.headers().firstValue("X-Exceptionless-Client").isPresent()
+                        && httpRequest
+                            .headers()
+                            .firstValue("X-Exceptionless-Client")
+                            .get()
+                            .equals("exceptionless-java")
+                        && httpRequest
+                            .uri()
+                            .toString()
+                            .equals(
+                                "http://test-server-url/api/v2/projects/config?v=1&access_token=test-api-key")),
+            any());
+    doReturn(
+            "{\n"
+                + "\t\"version\":1,\n"
+                + "\t\"settings\":{\n"
+                + "\t\t\"key\":\"value\"\n"
+                + "\t}\n"
+                + "}")
+        .when(response)
+        .body();
+    doReturn(200).when(response).statusCode();
+
+    SettingsResponse response = settingsClient.getSettings(1);
+
+    assertThat(response.getMessage()).isNull();
+    assertThat(response.getException()).isNull();
+    assertThat(response.isSuccess()).isTrue();
+    assertThat(response.getSettings())
+        .isEqualTo(ServerSettings.builder().version(1L).settings(Map.of("key", "value")).build());
+  }
+
+  @Test
+  public void itCanHandleAUnsuccessfulResponse() throws IOException, InterruptedException {
+    doReturn(response).when(httpClient).send(any(), any());
+    doReturn("test-response").when(response).body();
+    doReturn(400).when(response).statusCode();
+
+    SettingsResponse response = settingsClient.getSettings(1);
+
+    assertThat(response.getMessage()).isEqualTo("test-response");
+    assertThat(response.getException()).isNull();
+    assertThat(response.isSuccess()).isFalse();
+    assertThat(response.getSettings()).isNull();
+  }
+
+  @Test
+  public void itCanHandleAnyException() throws IOException, InterruptedException {
+    RuntimeException e = new RuntimeException("test");
+    doThrow(e).when(httpClient).send(any(), any());
+
+    SettingsResponse response = settingsClient.getSettings(1);
+
+    assertThat(response.getMessage()).isEqualTo("test");
+    assertThat(response.getException()).isEqualTo(e);
+    assertThat(response.isSuccess()).isFalse();
+    assertThat(response.getSettings()).isNull();
+  }
+}