Added unit tests for plugins

Author: pc9795

pom.xml

@@ -24,6 +24,41 @@
             <artifactId>jackson-databind</artifactId>
             <version>2.9.5</version>
         </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-core</artifactId>
+            <version>1.2.3</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>1.7.30</version>
+        </dependency>
+        <!--Test Dependencies-->
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>5.3.1</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>2.21.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-junit-jupiter</artifactId>
+            <version>2.23.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.4.1</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

samples/example-app/src/main/java/com/exceptionless/sample/app/Main.java

@@ -9,6 +9,8 @@ public static void main(String[] args) {
             System.getenv("EXCEPTIONLESS_SAMPLE_APP_API_KEY"),
             System.getenv("EXCEPTIONLESS_SAMPLE_APP_SERVER_URL"));
 
+    client.getConfigurationManager().useSessions();
+
     client.submitSessionStart();
 
     client.submitException(new RuntimeException("Test exception"));

src/main/java/com/exceptionless/exceptionlessclient/ExceptionlessClient.java

@@ -12,12 +12,15 @@
 import com.exceptionless.exceptionlessclient.plugins.EventPluginRunner;
 import lombok.Builder;
 import lombok.Getter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.time.LocalDate;
 import java.util.Timer;
 import java.util.TimerTask;
 
 public class ExceptionlessClient {
+  private static final Logger LOG = LoggerFactory.getLogger(ExceptionlessClient.class);
   private static final String UPDATE_SETTINGS_TIMER_NAME = "update-settings-timer";
   private static final int UPDATE_SETTINGS_TIMER_INITIAL_DELAY = 5000;
 
@@ -42,7 +45,7 @@ public void run() {
             try {
               configurationManager.getSettingsManager().updateSettingsThreadSafe();
             } catch (Exception e) {
-              configurationManager.getLog().error("Error in updating settings", e);
+              LOG.error("Error in updating settings", e);
             }
           }
         },
@@ -155,9 +158,7 @@ public void submitEvent(EventPluginContext eventPluginContext) {
   }
 
   public void submitSessionEnd(String sessionOrUserId) {
-    configurationManager
-        .getLog()
-        .info(String.format("Submitting session end: %s", sessionOrUserId));
+    LOG.info(String.format("Submitting session end: %s", sessionOrUserId));
     configurationManager.getSubmissionClient().sendHeartBeat(sessionOrUserId, true);
   }
 
@@ -170,11 +171,8 @@ public SubmissionResponse updateEmailAndDescription(
                 referenceId,
                 UserDescription.builder().description(description).emailAddress(email).build());
     if (!response.isSuccess()) {
-      configurationManager
-          .getLog()
-          .error(
-              String.format(
-                  "Failed to submit user email and description for event: %s", referenceId));
+      LOG.error(
+          String.format("Failed to submit user email and description for event: %s", referenceId));
     }
 
     return response;

src/main/java/com/exceptionless/exceptionlessclient/configuration/ConfigurationManager.java

@@ -3,8 +3,9 @@
 import com.exceptionless.exceptionlessclient.exceptions.ClientException;
 import com.exceptionless.exceptionlessclient.lastreferenceidmanager.DefaultLastReferenceIdManager;
 import com.exceptionless.exceptionlessclient.lastreferenceidmanager.LastReferenceIdManagerIF;
-import com.exceptionless.exceptionlessclient.logging.LogIF;
-import com.exceptionless.exceptionlessclient.logging.ConsoleLog;
+import com.exceptionless.exceptionlessclient.logging.LogCapturerAppender;
+import com.exceptionless.exceptionlessclient.logging.LogCapturerIF;
+import com.exceptionless.exceptionlessclient.logging.NullLogCapturer;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
 import com.exceptionless.exceptionlessclient.models.UserInfo;
 import com.exceptionless.exceptionlessclient.models.enums.EventPropertyKey;
@@ -22,16 +23,19 @@
 import com.exceptionless.exceptionlessclient.submission.SubmissionClientIF;
 import lombok.Builder;
 import lombok.Getter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.*;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 
 public class ConfigurationManager {
+  private static final Logger LOG = LoggerFactory.getLogger(ConfigurationManager.class);
+
   @Getter private final EnvironmentInfoCollectorIF environmentInfoCollector;
   @Getter private final ErrorParserIF errorParser;
   @Getter private final LastReferenceIdManagerIF lastReferenceIdManager;
-  @Getter private final LogIF log;
   @Getter private final ModuleCollectorIF moduleCollector;
   @Getter private final RequestInfoCollectorIF requestInfoCollector;
   @Getter private final SubmissionClientIF submissionClient;
@@ -44,15 +48,15 @@ public class ConfigurationManager {
   private final Set<String> userAgentBotPatterns;
   @Getter private final PrivateInformationInclusions privateInformationInclusions;
   private final Set<String> dataExclusions;
-  private PluginManager pluginManager;
+  private final PluginManager pluginManager;
   @Getter private final StorageProviderIF storageProvider;
 
   @Builder
   public ConfigurationManager(
       EnvironmentInfoCollectorIF environmentInfoCollector,
       ErrorParserIF errorParser,
       LastReferenceIdManagerIF lastReferenceIdManager,
-      LogIF log,
+      LogCapturerIF logCatpurer,
       ModuleCollectorIF moduleCollector,
       RequestInfoCollectorIF requestInfoCollector,
       SubmissionClientIF submissionClient,
@@ -62,10 +66,9 @@ public ConfigurationManager(
       Configuration configuration,
       Integer maxQueueItems,
       Integer processingIntervalInSecs) {
-    this.log = log == null ? ConsoleLog.builder().build() : log;
     this.environmentInfoCollector =
         environmentInfoCollector == null
-            ? DefaultEnvironmentInfoCollector.builder().log(this.log).build()
+            ? DefaultEnvironmentInfoCollector.builder().build()
             : environmentInfoCollector;
     this.errorParser = errorParser == null ? DefaultErrorParser.builder().build() : errorParser;
     this.lastReferenceIdManager =
@@ -76,21 +79,20 @@ public ConfigurationManager(
         moduleCollector == null ? DefaultModuleCollector.builder().build() : moduleCollector;
     this.requestInfoCollector =
         requestInfoCollector == null
-            ? DefaultRequestInfoCollector.builder().log(this.log).build()
+            ? DefaultRequestInfoCollector.builder().build()
             : requestInfoCollector;
     this.storageProvider =
         storageProvider == null
             ? InMemoryStorageProvider.builder().maxQueueItems(maxQueueItems).build()
             : storageProvider;
     this.configuration =
-            configuration == null ? Configuration.defaultConfiguration() : configuration;
+        configuration == null ? Configuration.defaultConfiguration() : configuration;
     this.settingsManager =
         SettingsManager.builder()
             .settingsClient(
                 settingsClient == null
                     ? DefaultSettingsClient.builder().configuration(this.configuration).build()
                     : settingsClient)
-            .log(this.log)
             .storageProvider(this.storageProvider)
             .build();
     this.userAgentBotPatterns = new HashSet<>();
@@ -99,28 +101,26 @@ public ConfigurationManager(
             ? DefaultSubmissionClient.builder()
                 .settingsManager(this.settingsManager)
                 .configuration(this.configuration)
-                .log(this.log)
                 .build()
             : submissionClient;
     this.queue =
         queue == null
             ? DefaultEventQueue.builder()
                 .configuration(this.configuration)
-                .log(this.log)
                 .processingIntervalInSecs(processingIntervalInSecs)
                 .storageProvider(this.storageProvider)
                 .submissionClient(this.submissionClient)
                 .build()
             : queue;
-    this.pluginManager = PluginManager.builder().log(this.log).build();
+    this.pluginManager = PluginManager.builder().build();
     this.defaultData = new HashMap<>();
     this.defaultTags = new HashSet<>();
     this.onChangedHandlers = new ArrayList<>();
     this.dataExclusions = new HashSet<>();
     this.privateInformationInclusions = PrivateInformationInclusions.builder().build();
-    this.pluginManager = PluginManager.builder().log(this.log).build();
     checkApiKeyIsValid();
     addPropertyChangeListeners();
+    addLogCapturer(logCatpurer);
   }
 
   private void addPropertyChangeListeners() {
@@ -138,6 +138,18 @@ private void checkApiKeyIsValid() {
         String.format("Apikey is not valid: [%s]", this.configuration.getApiKey()));
   }
 
+  private void addLogCapturer(LogCapturerIF logCatpurer) {
+    logCatpurer = logCatpurer == null ? NullLogCapturer.builder().build() : logCatpurer;
+
+    ch.qos.logback.classic.Logger logBackRootLogger =
+        (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
+    logBackRootLogger.addAppender(LogCapturerAppender.builder().logCapturer(logCatpurer).build());
+  }
+
+  public void addDefaultTags(String... tags) {
+    defaultTags.addAll(Arrays.asList(tags));
+  }
+
   public void addDataExclusions(String... exclusions) {
     dataExclusions.addAll(Arrays.asList(exclusions));
   }
@@ -160,7 +172,7 @@ public Set<String> getUserAgentBotPatterns() {
   }
 
   public void submitSessionHeartbeat(String sessionOrUserId) {
-    log.info(String.format("Submitting session heartbeat: %s", sessionOrUserId));
+    LOG.info(String.format("Submitting session heartbeat: %s", sessionOrUserId));
     submissionClient.sendHeartBeat(sessionOrUserId, false);
   }
 
@@ -216,12 +228,12 @@ public void setUserIdentity(UserInfo userInfo) {
     this.defaultData.put(EventPropertyKey.USER.value(), userInfo);
   }
 
-  public void useSession() {
+  public void useSessions() {
     useSessions(30000);
   }
 
-  public void useSessions(int heartbeatInterval) {
-    addPlugin(HeartbeatPlugin.builder().heartbeatInterval(heartbeatInterval).build());
+  public void useSessions(int heartbeatIntervalInSecs) {
+    addPlugin(HeartbeatPlugin.builder().heartbeatIntervalInSecs(heartbeatIntervalInSecs).build());
   }
 
   public void onChanged(Consumer<ConfigurationManager> onChangedHandler) {
@@ -233,7 +245,7 @@ private void changed() {
       try {
         onChangedHandler.accept(this);
       } catch (Exception e) {
-        log.error(String.format("Error calling on changed handler: %s", e.getMessage()), e);
+        LOG.error(String.format("Error calling on changed handler: %s", e.getMessage()), e);
       }
     }
   }

src/main/java/com/exceptionless/exceptionlessclient/configuration/PluginManager.java

@@ -1,11 +1,12 @@
 package com.exceptionless.exceptionlessclient.configuration;
 
-import com.exceptionless.exceptionlessclient.logging.LogIF;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginIF;
 import com.exceptionless.exceptionlessclient.plugins.preconfigured.*;
 import lombok.Builder;
 import lombok.Getter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -14,12 +15,12 @@
 import java.util.stream.Collectors;
 
 public class PluginManager {
-  private final LogIF log;
+  private static final Logger LOG = LoggerFactory.getLogger(PluginManager.class);
+
   @Getter private List<EventPluginIF> plugins;
 
   @Builder
-  public PluginManager(LogIF log) {
-    this.log = log;
+  public PluginManager() {
     this.plugins = new ArrayList<>();
     configureDefaultPlugins();
     sortPlugins();
@@ -28,17 +29,17 @@ public PluginManager(LogIF log) {
   private void configureDefaultPlugins() {
     addPlugin(ConfigurationDefaultsPlugin.builder().build());
     addPlugin(ErrorPlugin.builder().build());
-    addPlugin(DuplicateErrorCheckerPlugin.builder().log(this.log).build());
-    addPlugin(EventExclusionPlugin.builder().log(this.log).build());
+    addPlugin(DuplicateErrorCheckerPlugin.builder().build());
+    addPlugin(EventExclusionPlugin.builder().build());
     addPlugin(ModuleInfoPlugin.builder().build());
-    addPlugin(RequestInfoPlugin.builder().log(this.log).build());
+    addPlugin(RequestInfoPlugin.builder().build());
     addPlugin(EnvironmentInfoPlugin.builder().build());
     addPlugin(SubmissionMethodPlugin.builder().build());
   }
 
   public void addPlugin(EventPluginIF eventPlugin) {
     if (plugins.stream().anyMatch(plugin -> plugin.getName().equals(eventPlugin.getName()))) {
-      log.info(
+      LOG.info(
           String.format(
               "Can't add plugin, name: %s, priority: %s as a plugin with this name already configured",
               eventPlugin.getName(), eventPlugin.getPriority()));