Addressing some minor codacy issues. Potentially adding a breaking change for users - TestConfigManager is now called TestConfigHelper

travis-ci · travis-ci · commit 0e6161a95b25 · 2020-03-01T00:02:04.000Z
diff --git a/src/main/java/uk/co/evoco/pageobjects/BasePageObject.java b/src/main/java/uk/co/evoco/pageobjects/BasePageObject.java
@@ -3,7 +3,7 @@
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.support.PageFactory;
 import org.openqa.selenium.support.ui.WebDriverWait;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 /**
  * This class is a base that all page objects can inherit from.  It ensures that we have
@@ -25,6 +25,6 @@ public abstract class BasePageObject {
     public BasePageObject(WebDriver webDriver) {
         PageFactory.initElements(webDriver, this);
         this.webDriver = webDriver;
-        this.wait = new WebDriverWait(this.webDriver, TestConfigManager.get().getWebDriverWaitTimeout());
+        this.wait = new WebDriverWait(this.webDriver, TestConfigHelper.get().getWebDriverWaitTimeout());
      }
 }
diff --git a/src/main/java/uk/co/evoco/tests/BaseAbstractTest.java b/src/main/java/uk/co/evoco/tests/BaseAbstractTest.java
@@ -5,7 +5,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.openqa.selenium.support.events.EventFiringWebDriver;
 import uk.co.evoco.webdriver.WebDriverBuilder;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 import uk.co.evoco.webdriver.results.ResultsManager;
 
 import java.io.IOException;
@@ -40,7 +40,7 @@ public void setUp() throws IOException {
         this.webDriver = new WebDriverBuilder()
                 .setResultsDirectory(this.resultsManager.getScreenshotDirectory())
                 .build();
-        this.webDriver.get(TestConfigManager.get().getBaseUrl());
+        this.webDriver.get(TestConfigHelper.get().getBaseUrl());
         this.webDriver.manage().window().maximize();
     }
 
diff --git a/src/main/java/uk/co/evoco/webdriver/WebDriverBuilder.java b/src/main/java/uk/co/evoco/webdriver/WebDriverBuilder.java
@@ -1,7 +1,7 @@
 package uk.co.evoco.webdriver;
 
 import org.openqa.selenium.support.events.EventFiringWebDriver;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 import uk.co.evoco.webdriver.configuration.driver.ConfiguredChromeDriver;
 import uk.co.evoco.webdriver.configuration.driver.ConfiguredFirefoxDriver;
 import uk.co.evoco.webdriver.configuration.driver.ConfiguredEdgeDriver;
@@ -37,7 +37,7 @@ public WebDriverBuilder setResultsDirectory(File screenshotDirectory) {
      * @throws IOException if log file for browser driver logs cannot be created
      */
     public EventFiringWebDriver build() throws IOException {
-        switch(TestConfigManager.get().getBrowserType()) {
+        switch(TestConfigHelper.get().getBrowserType()) {
             case CHROME:
                 return new ConfiguredChromeDriver().getDriver(this.screenshotDirectory);
             case FIREFOX:
diff --git a/src/main/java/uk/co/evoco/webdriver/WebDriverListener.java b/src/main/java/uk/co/evoco/webdriver/WebDriverListener.java
@@ -11,7 +11,7 @@
 import org.openqa.selenium.support.ui.WebDriverWait;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.io.File;
 import java.util.UUID;
@@ -146,7 +146,7 @@ public void afterNavigateRefresh(WebDriver webDriver) {
      */
     public void beforeFindBy(By by, WebElement webElement, WebDriver webDriver) {
         new WebDriverWait(webDriver,
-                TestConfigManager.get().getWebDriverWaitTimeout()).until(
+                TestConfigHelper.get().getWebDriverWaitTimeout()).until(
                         ExpectedConditions.presenceOfElementLocated(by));
     }
 
@@ -171,7 +171,7 @@ public void afterFindBy(By by, WebElement webElement, WebDriver webDriver) {
      */
     public void beforeClickOn(WebElement webElement, WebDriver webDriver) {
         new WebDriverWait(webDriver,
-                TestConfigManager.get().getWebDriverWaitTimeout()).until(
+                TestConfigHelper.get().getWebDriverWaitTimeout()).until(
                         ExpectedConditions.elementToBeClickable(webElement));
     }
 
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/TestConfigHelper.java b/src/main/java/uk/co/evoco/webdriver/configuration/TestConfigHelper.java
@@ -3,15 +3,15 @@
 /**
  *
  */
-public class TestConfigManager {
+public class TestConfigHelper {
 
-    private static TestConfigManager testConfigManager;
+    private static TestConfigHelper testConfigHelper;
     private static WebDriverConfig webDriverConfig;
 
     /**
      *
      */
-    private TestConfigManager() {
+    private TestConfigHelper() {
         this.webDriverConfig = new ConfigurationLoader()
                 .decideWhichConfigurationToUse()
                 .build();
@@ -22,8 +22,8 @@ private TestConfigManager() {
      * @return TestConfigManager returns the instance of the singleton to access the member methods
      */
     public static WebDriverConfig get() {
-        if(null == testConfigManager) {
-            testConfigManager = new TestConfigManager();
+        if(null == testConfigHelper) {
+            testConfigHelper = new TestConfigHelper();
         }
         return webDriverConfig;
     }
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredChromeDriver.java b/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredChromeDriver.java
@@ -5,7 +5,7 @@
 import org.openqa.selenium.chrome.ChromeDriver;
 import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.io.IOException;
 
@@ -17,7 +17,7 @@ public class ConfiguredChromeDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigHelper.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
@@ -38,7 +38,7 @@ public WebDriver getLocalDriver() throws IOException {
      */
     private ChromeOptions getOptions() {
         ChromeOptions chromeOptions = new ChromeOptions();
-        chromeOptions.setHeadless(TestConfigManager.get().isHeadless());
+        chromeOptions.setHeadless(TestConfigHelper.get().isHeadless());
         return chromeOptions;
     }
 }
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredDriver.java b/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredDriver.java
@@ -5,7 +5,7 @@
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.support.events.EventFiringWebDriver;
 import uk.co.evoco.webdriver.WebDriverListener;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.io.File;
 import java.io.IOException;
@@ -23,7 +23,7 @@ public interface ConfiguredDriver {
      */
     default EventFiringWebDriver getDriver(File screenshotPath) throws IOException {
         WebDriver webDriver;
-        switch(TestConfigManager.get().getRunType()) {
+        switch(TestConfigHelper.get().getRunType()) {
             case LOCAL:
                 webDriver = getLocalDriver();
                 break;
@@ -35,7 +35,7 @@ default EventFiringWebDriver getDriver(File screenshotPath) throws IOException {
         }
         return configureEventFiringWebDriver(
                 webDriver,
-                TestConfigManager.get().getWebDriverWaitTimeout(),
+                TestConfigHelper.get().getWebDriverWaitTimeout(),
                 screenshotPath);
     }
 
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredEdgeDriver.java b/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredEdgeDriver.java
@@ -5,7 +5,7 @@
 import org.openqa.selenium.edge.EdgeDriver;
 import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 public class ConfiguredEdgeDriver implements ConfiguredDriver {
 
@@ -15,7 +15,7 @@ public class ConfiguredEdgeDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigHelper.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredFirefoxDriver.java b/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredFirefoxDriver.java
@@ -3,13 +3,11 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import io.github.bonigarcia.wdm.WebDriverManager;
 import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.chrome.ChromeDriver;
-import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.firefox.FirefoxOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
 import uk.co.evoco.webdriver.configuration.BrowserType;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.io.IOException;
 import java.util.Iterator;
@@ -23,7 +21,7 @@ public class ConfiguredFirefoxDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigHelper.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
@@ -44,7 +42,7 @@ public WebDriver getLocalDriver() throws IOException {
      */
     public FirefoxOptions getOptions() {
         FirefoxOptions firefoxOptions = new FirefoxOptions();
-        Iterator<Map.Entry<String, JsonNode>> firefoxPreferences = TestConfigManager.get()
+        Iterator<Map.Entry<String, JsonNode>> firefoxPreferences = TestConfigHelper.get()
                 .getBrowserPreferences(BrowserType.FIREFOX)
                 .fields();
 
@@ -65,7 +63,7 @@ public FirefoxOptions getOptions() {
             }
         }
 
-        firefoxOptions.setHeadless(TestConfigManager.get().isHeadless());
+        firefoxOptions.setHeadless(TestConfigHelper.get().isHeadless());
         return firefoxOptions;
     }
 }
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredInternetExplorerDriver.java b/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredInternetExplorerDriver.java
@@ -5,7 +5,7 @@
 import org.openqa.selenium.ie.InternetExplorerDriver;
 import org.openqa.selenium.ie.InternetExplorerOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 public class ConfiguredInternetExplorerDriver implements ConfiguredDriver {
 
@@ -15,7 +15,7 @@ public class ConfiguredInternetExplorerDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigHelper.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
diff --git a/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredSafariDriver.java b/src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredSafariDriver.java
@@ -4,7 +4,7 @@
 import org.openqa.selenium.remote.RemoteWebDriver;
 import org.openqa.selenium.safari.SafariDriver;
 import org.openqa.selenium.safari.SafariOptions;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 public class ConfiguredSafariDriver implements ConfiguredDriver {
 
@@ -14,7 +14,7 @@ public class ConfiguredSafariDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigHelper.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
diff --git a/src/main/java/uk/co/evoco/webdriver/utils/ClickUtils.java b/src/main/java/uk/co/evoco/webdriver/utils/ClickUtils.java
@@ -1,7 +1,7 @@
 package uk.co.evoco.webdriver.utils;
 
 import org.openqa.selenium.WebElement;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.util.Optional;
 
@@ -23,6 +23,6 @@ public static void tolerantClick(WebElement webElement, int timeout) throws Thro
 
     public static void tolerantClick(WebElement webElement) throws Throwable {
         new SendKeysUtils().tolerantInteraction(webElement, Optional.empty(),
-                TestConfigManager.get().getTolerantActionWaitTimeoutInSeconds());
+                TestConfigHelper.get().getTolerantActionWaitTimeoutInSeconds());
     }
 }
diff --git a/src/main/java/uk/co/evoco/webdriver/utils/RadioButtonUtils.java b/src/main/java/uk/co/evoco/webdriver/utils/RadioButtonUtils.java
@@ -1,7 +1,7 @@
 package uk.co.evoco.webdriver.utils;
 
 import org.openqa.selenium.WebElement;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.util.List;
 
@@ -40,6 +40,6 @@ public static void tolerantSelectByLabel(List<WebElement> webElements, String vi
     public static void tolerantSelectByLabel(List<WebElement> webElements, String visibleLabelText)
             throws Throwable {
         new RadioButtonUtils().tolerantInteraction(webElements, visibleLabelText,
-                TestConfigManager.get().getTolerantActionWaitTimeoutInSeconds());
+                TestConfigHelper.get().getTolerantActionWaitTimeoutInSeconds());
     }
 }
diff --git a/src/main/java/uk/co/evoco/webdriver/utils/SelectBoxUtils.java b/src/main/java/uk/co/evoco/webdriver/utils/SelectBoxUtils.java
@@ -2,7 +2,7 @@
 
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.support.ui.Select;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.util.Optional;
 
@@ -89,7 +89,7 @@ public static void tolerantItemByVisibleText(WebElement webElement, String visib
         new SendKeysUtils().tolerantInteraction(
                 webElement, SelectBoxInteractionType.BY_VISIBLE_TEXT,
                 Optional.of(visibleText), Optional.empty(),
-                TestConfigManager.get().getTolerantActionWaitTimeoutInSeconds());
+                TestConfigHelper.get().getTolerantActionWaitTimeoutInSeconds());
     }
 
 }
diff --git a/src/main/java/uk/co/evoco/webdriver/utils/SendKeysUtils.java b/src/main/java/uk/co/evoco/webdriver/utils/SendKeysUtils.java
@@ -1,7 +1,7 @@
 package uk.co.evoco.webdriver.utils;
 
 import org.openqa.selenium.WebElement;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.util.Optional;
 
@@ -19,6 +19,6 @@ public static void tolerantType(WebElement webElement, String textToType, int ti
 
     public static void tolerantType(WebElement webElement, String textToType) throws Throwable {
         new SendKeysUtils().tolerantInteraction(webElement, Optional.of(textToType),
-                TestConfigManager.get().getTolerantActionWaitTimeoutInSeconds());
+                TestConfigHelper.get().getTolerantActionWaitTimeoutInSeconds());
     }
 }
diff --git a/src/main/java/uk/co/evoco/webdriver/utils/TolerantInteraction.java b/src/main/java/uk/co/evoco/webdriver/utils/TolerantInteraction.java
@@ -7,7 +7,7 @@
 import org.openqa.selenium.support.ui.Sleeper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import uk.co.evoco.webdriver.configuration.TestConfigManager;
+import uk.co.evoco.webdriver.configuration.TestConfigHelper;
 
 import java.time.Clock;
 import java.time.Duration;
@@ -192,7 +192,7 @@ private void interact(Select selectBox, int index) {
     }
 
     private Throwable propagateIfNotIgnored(Throwable e) throws Throwable {
-        for (String ignoredException : TestConfigManager.get()
+        for (String ignoredException : TestConfigHelper.get()
                 .getTolerantActionExceptions().getExceptionsToHandle()) {
             if (Class.forName(ignoredException).isInstance(e)) {
                 logger.info("Exception {} will be ignored", ignoredException);
diff --git a/src/test/java/uk/co/evoco/testdata/DatesTests.java b/src/test/java/uk/co/evoco/testdata/DatesTests.java
@@ -5,7 +5,10 @@
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static uk.co.evoco.testdata.Dates.*;
+import static uk.co.evoco.testdata.Dates.futureDate;
+import static uk.co.evoco.testdata.Dates.pastDate;
+import static uk.co.evoco.testdata.Dates.futureDateAvoidingWeekends;
+import static uk.co.evoco.testdata.Dates.futureDataAvoidingWeekendsAndBankHolidays;
 
 public class DatesTests {
 
diff --git a/src/test/java/uk/co/evoco/webdriver/configuration/TestConfigHelperTests.java b/src/test/java/uk/co/evoco/webdriver/configuration/TestConfigHelperTests.java
@@ -6,16 +6,16 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.instanceOf;
 
-public class TestConfigManagerTests {
+public class TestConfigHelperTests {
 
     @Test
     public void testCanAccessTestConfigurationIsCorrectType() {
-        assertThat(TestConfigManager.get(), instanceOf(WebDriverConfig.class));
+        assertThat(TestConfigHelper.get(), instanceOf(WebDriverConfig.class));
     }
 
     @Test
     public void testCanAccessTestConfigurationViaSingleton() {
-        assertThat(TestConfigManager.get().getBaseUrl(),
+        assertThat(TestConfigHelper.get().getBaseUrl(),
                 is("https://www.google.com"));
     }
 }
