Extracted configurations (#21)

* extracted ISettingsFile and added tests

* added documentation for ISettingsFile

* extracted ILoggerConfiguration

* extracted ITimeoutConfiguration

* extracted IRetryConfiguration

* renamed one test

* added empty end line and
updated com.fasterxml.jackson.core to 2.10.2

* renamed constants to upper case

* removed redundant method from ISettingsFile

* fixed naming and added empty line at the end of files

* fixed naming and added empty line at the end of files

* fixed naming and added empty line at the end of files

* merged with master and added test for CustomSettingsFile

* fix for the tests

* merge and small refactoring of tests

* merge from master

* merge from master

* extracted IElementCacheConfiguration

* merge and test fix

* removed SupportedLanguaged and added default language if configuration is absent

* register configuration as singleton

* fixed comments

* moved SettingsFileUtil to ISettingsFile

Author: knysh

src/main/java/aquality/selenium/core/application/AqualityModule.java

@@ -3,8 +3,10 @@
 import aquality.selenium.core.logging.Logger;
 import aquality.selenium.core.utilities.ISettingsFile;
 import aquality.selenium.core.utilities.JsonSettingsFile;
+import aquality.selenium.core.configurations.*;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provider;
+import com.google.inject.Singleton;
 
 /**
  * Describes all dependencies which is registered for the project.
@@ -25,6 +27,10 @@ protected void configure() {
         bind(IApplication.class).toProvider(applicationProvider);
         bind(ISettingsFile.class).toInstance(getSettings());
         bind(Logger.class).toInstance(Logger.getInstance());
+        bind(ILoggerConfiguration.class).to(LoggerConfiguration.class).in(Singleton.class);
+        bind(ITimeoutConfiguration.class).to(TimeoutConfiguration.class).in(Singleton.class);
+        bind(IRetryConfiguration.class).to(RetryConfiguration.class).in(Singleton.class);
+        bind(IElementCacheConfiguration.class).to(ElementCacheConfiguration.class).in(Singleton.class);
     }
 
     /**

src/main/java/aquality/selenium/core/configurations/ElementCacheConfiguration.java

@@ -0,0 +1,20 @@
+package aquality.selenium.core.configurations;
+
+import aquality.selenium.core.utilities.ISettingsFile;
+import com.google.inject.Inject;
+
+public class ElementCacheConfiguration implements IElementCacheConfiguration{
+
+    private static final String IS_ENABLED_PATH = "/elementCache/isEnabled";
+    private boolean isEnabled;
+
+    @Inject
+    public ElementCacheConfiguration(ISettingsFile settingsFile){
+        isEnabled = settingsFile.isValuePresent(IS_ENABLED_PATH) && Boolean.valueOf(settingsFile.getValue(IS_ENABLED_PATH).toString());
+    }
+
+    @Override
+    public boolean isEnabled() {
+        return isEnabled;
+    }
+}

src/main/java/aquality/selenium/core/configurations/IElementCacheConfiguration.java

@@ -0,0 +1,12 @@
+package aquality.selenium.core.configurations;
+
+/**
+ * Provides element's cache configuration.
+ */
+public interface IElementCacheConfiguration {
+
+    /**
+     * @return Is element caching allowed or not.
+     */
+    boolean isEnabled();
+}

src/main/java/aquality/selenium/core/configurations/ILoggerConfiguration.java

@@ -0,0 +1,13 @@
+package aquality.selenium.core.configurations;
+
+/**
+ * Describes logger configuration.
+ */
+public interface ILoggerConfiguration {
+
+    /**
+     * Gets language used inside the library for logging.
+     * @return language used for logging.
+     */
+    String getLanguage();
+}

src/main/java/aquality/selenium/core/configurations/IRetryConfiguration.java

@@ -0,0 +1,21 @@
+package aquality.selenium.core.configurations;
+
+/**
+ * Describes retry configuration.
+ */
+public interface IRetryConfiguration {
+
+    /**
+     * Gets the number of attempts during retry.
+     *
+     * @return Number of retry attempts.
+     */
+    int getNumber();
+
+    /**
+     * Gets the polling interval used in retry.
+     *
+     * @return Polling interval for retry.
+     */
+    long getPollingInterval();
+}

src/main/java/aquality/selenium/core/configurations/ITimeoutConfiguration.java

@@ -0,0 +1,35 @@
+package aquality.selenium.core.configurations;
+
+/**
+ * Provides timeouts configuration.
+ */
+public interface ITimeoutConfiguration {
+
+    /**
+     * Gets WedDriver ImplicitWait timeout.
+     *
+     * @return ImplicitWait timeout.
+     */
+    long getImplicit();
+
+    /**
+     * Gets default ConditionalWait timeout.
+     *
+     * @return ConditionalWait timeout.
+     */
+    long getCondition();
+
+    /**
+     * Gets ConditionalWait polling interval.
+     *
+     * @return polling interval.
+     */
+    long getPollingInterval();
+
+    /**
+     * Gets Command timeout.
+     *
+     * @return Command timeout.
+     */
+    long getCommand();
+}

src/main/java/aquality/selenium/core/configurations/LoggerConfiguration.java

@@ -0,0 +1,20 @@
+package aquality.selenium.core.configurations;
+
+import aquality.selenium.core.utilities.ISettingsFile;
+import com.google.inject.Inject;
+
+public class LoggerConfiguration implements ILoggerConfiguration {
+
+    private static final String DEFAULT_LANGUAGE = "en";
+    private final ISettingsFile settingsFile;
+
+    @Inject
+    public LoggerConfiguration(ISettingsFile settingsFile){
+        this.settingsFile = settingsFile;
+    }
+
+    @Override
+    public String getLanguage() {
+        return settingsFile.getValueOrDefault("/logger/language", DEFAULT_LANGUAGE).toString();
+    }
+}

src/main/java/aquality/selenium/core/configurations/RetryConfiguration.java

@@ -0,0 +1,25 @@
+package aquality.selenium.core.configurations;
+
+import aquality.selenium.core.utilities.ISettingsFile;
+import com.google.inject.Inject;
+
+public class RetryConfiguration implements IRetryConfiguration {
+    private final int number;
+    private final long pollingInterval;
+
+    @Inject
+    public RetryConfiguration(ISettingsFile settingsFile) {
+        this.number = Integer.parseInt(settingsFile.getValue("/retry/number").toString());
+        this.pollingInterval = Long.parseLong(settingsFile.getValue("/retry/pollingInterval").toString());
+    }
+
+    @Override
+    public int getNumber() {
+        return number;
+    }
+
+    @Override
+    public long getPollingInterval() {
+        return pollingInterval;
+    }
+}

src/main/java/aquality/selenium/core/configurations/TimeoutConfiguration.java

@@ -0,0 +1,58 @@
+package aquality.selenium.core.configurations;
+
+import aquality.selenium.core.utilities.ISettingsFile;
+import com.google.inject.Inject;
+
+public class TimeoutConfiguration implements ITimeoutConfiguration{
+
+    private final ISettingsFile settingsFile;
+    private final long condition;
+    private final long pollInterval;
+    private final long implicit;
+    private final long command;
+
+    @Inject
+    public TimeoutConfiguration(ISettingsFile settingsFile) {
+        this.settingsFile = settingsFile;
+        condition = getTimeout(TIMEOUT.CONDITION);
+        pollInterval = getTimeout(TIMEOUT.POLL_INTERVAL);
+        implicit = getTimeout(TIMEOUT.IMPLICIT);
+        command = getTimeout(TIMEOUT.COMMAND);
+    }
+
+    private long getTimeout(TIMEOUT timeout){
+        return Long.valueOf(settingsFile.getValue(timeout.getKey()).toString());
+    }
+
+    public long getImplicit(){
+        return implicit;
+    }
+
+    public long getCondition(){
+        return condition;
+    }
+
+    public long getPollingInterval(){
+        return pollInterval;
+    }
+
+    public long getCommand(){
+        return command;
+    }
+
+    private enum TIMEOUT {
+        IMPLICIT("/timeouts/timeoutImplicit"),
+        CONDITION("/timeouts/timeoutCondition"),
+        POLL_INTERVAL("/timeouts/timeoutPollingInterval"),
+        COMMAND("/timeouts/timeoutCommand");
+
+        private String key;
+        TIMEOUT(String key){
+            this.key = key;
+        }
+
+        private String getKey(){
+            return key;
+        }
+    }
+}

src/main/java/aquality/selenium/core/utilities/ISettingsFile.java

@@ -39,4 +39,15 @@ public interface ISettingsFile {
      * @return True if exists, false otherwise.
      */
     boolean isValuePresent(String path);
+
+    /**
+     * Gets value from settings file or default value.
+     *
+     * @param path         Path to the values. Depending on file format, it can be jsonPath, xpath etc.
+     * @param defaultValue will be returned if there is no value by path in settings file.
+     * @return Value from settings file or default value.
+     */
+    default Object getValueOrDefault(String path, Object defaultValue) {
+        return this.isValuePresent(path) ? this.getValue(path) : defaultValue;
+    }
 }