Merge pull request #499 from dougnoel/498-clear-config

Add ability to clear config

Author: pturchinetz

.github/workflows/maven.yml

@@ -57,10 +57,10 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
       run: mvn -B org.jacoco:jacoco-maven-plugin:prepare-agent verify org.jacoco:jacoco-maven-plugin:report org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dheadless -DrecordTests -Dtimeout=20
-    - name: Attach screen recordings from build
+    - name: Attach reports folder from build
       if: ${{ failure() }}
       continue-on-error: true
       uses: actions/upload-artifact@v2
       with:
-        name: ScreenRecordings
-        path: ${{ github.workspace }}/reports/*.avi
+        name: ReportsFolder
+        path: ${{ github.workspace }}/reports

src/main/java/com/dougnoel/sentinel/configurations/Configuration.java

@@ -36,8 +36,9 @@ public class Configuration {
 	private static final Map<String,YAMLData> YAML_DATA = new ConcurrentHashMap<>();
 
 	private static final String ENV_REPLACE_STRING = "{env}";
-	
-	private static Properties appProps = new Properties();
+	private static final String ENV = "env";
+
+	private static final Properties appProps = new Properties();
 
 	private static ConfigurationData sentinelConfigurations = null;
 
@@ -79,8 +80,8 @@ private static String getOrCreateConfigurationData(String configurationKey) {
 				throw new FileException(errorMessage, e, CONFIGURATION_FILE);
 			}
 		}
-	 
-		return sentinelConfigurations.getConfigurationValue(environment(), configurationKey);	
+
+		return sentinelConfigurations.getConfigurationValue(environment(), configurationKey);
 	}
 
 	/**
@@ -100,20 +101,25 @@ private static String getOrCreateConfigurationData(String configurationKey) {
 	public static String toString(String property) {
 		String propertyValue = appProps.getProperty(property);
 
+		if(propertyValue == null)
+			propertyValue = System.getProperty(property);
+
 		if(propertyValue == null) {
 			try {
-				propertyValue = System.getProperty(property);
-				if(propertyValue == null) {
-					propertyValue = getOrCreateConfigurationData(property);
+				if (property.contentEquals(ENV)) {
+					String warningMessage = "Configuration value 'env' not found in runtime or command-line configuration. Default value will be used.";
+					log.warn(warningMessage);
+					return null;
 				}
-				appProps.setProperty(property, propertyValue);
-				return propertyValue;
+				propertyValue = getOrCreateConfigurationData(property);
 			} catch (FileException e) {
-				log.trace(e.getMessage(),Arrays.toString(e.getStackTrace()));
+				log.trace(e.getMessage(), Arrays.toString(e.getStackTrace()));
 				return null;
 			}
 		}
-		
+
+		if(propertyValue != null)
+			appProps.setProperty(property, propertyValue);
 		return propertyValue;
 	}
 
@@ -136,11 +142,10 @@ public static String toString(String property, String defaultValue) {
 		String propertyValue = toString(property);
 		if (propertyValue == null) {
 			appProps.setProperty(property, defaultValue);
-			if (property.contentEquals("env")) {
-				String warningMessage = SentinelStringUtils.format("localhost env being used by default. {}", 
-						Configuration.configurationNotFoundErrorMessage("env"));
-				log.warn(warningMessage);
-			}
+			String warningMessage = SentinelStringUtils.format("{} being used by default for configuration property {}. {}",
+						defaultValue, property, Configuration.configurationNotFoundErrorMessage(property));
+			log.warn(warningMessage);
+
 			return defaultValue;
 		}
 		return propertyValue; 
@@ -166,6 +171,11 @@ public static void update(String property, String value) {
 	public static void clear(String property) {
 		appProps.remove(property);
 	}
+
+	/**
+	 * Clears all configuration values that have been set since runtime started.
+	 */
+	public static void clearAllSessionAppProps() { appProps.clear(); }
 
 	/**
 	 * Returns the given configuration value stored in the passed property as a Double, or 0.0 if nothing is
@@ -251,7 +261,7 @@ public static void update(String property, long value) {
 	 * @return String text of system env info
 	 */
 	public static String environment() {
-		return toString("env", "localhost");
+		return toString(ENV, "localhost");
 	}
 
 	/**
@@ -547,7 +557,12 @@ public static String[] getPageParts(String pageName) {
 	 * @return String the formatted error message
 	 */
 	private static String configurationNotFoundErrorMessage(String configurtaionValue) {
-		return SentinelStringUtils.format("No {} property set. This can be set in the sentinel.yml config file with a '{}=' property or on the command line with the switch '-D{}='.", configurtaionValue, configurtaionValue, configurtaionValue);
+		if(configurtaionValue.equalsIgnoreCase(ENV))
+			return SentinelStringUtils.format("No {} property set. This can be set on the command line with the switch '-D{}='.",
+					configurtaionValue);
+		else
+			return SentinelStringUtils.format("No {} property set. This can be set in the sentinel.yml config file with a '{}=' property or on the command line with the switch '-D{}='.",
+					configurtaionValue, configurtaionValue, configurtaionValue);
 	}
 
     /**

src/main/java/com/dougnoel/sentinel/elements/Element.java

@@ -115,7 +115,7 @@ private WebElement getElement(final By locator) {
 		try {
 			return driver().findElement(locator);
 		}
-		catch (TimeoutException | StaleElementReferenceException | NoSuchElementException | InvalidArgumentException e) {
+		catch (TimeoutException | StaleElementReferenceException | NoSuchElementException | InvalidArgumentException | NoSuchWindowException e) {
 			return null;
 		}
 	}
@@ -198,7 +198,8 @@ protected WebElement element(final By locator) {
 					.pollingEvery(Time.interval())
 					.ignoring(org.openqa.selenium.NoSuchElementException.class)
 					.ignoring(StaleElementReferenceException.class)
-					.ignoring(InvalidArgumentException.class);
+					.ignoring(InvalidArgumentException.class)
+					.ignoring(NoSuchWindowException.class);
 
 			return wait.until(d -> element().findElement(locator));
 		} catch (org.openqa.selenium.TimeoutException e) {
@@ -231,7 +232,7 @@ protected WebElement findElementInIFrame() {
         			driver().switchTo().parentFrame();
         		}
     		}
-    		catch(StaleElementReferenceException | NoSuchFrameException | InvalidArgumentException e) {
+    		catch(StaleElementReferenceException | NoSuchFrameException | InvalidArgumentException | NoSuchWindowException e) {
     			var errorMessage = SentinelStringUtils.format("Error when searching for {} element named \"{}\" while attempting to search through iFrames. Looping again. Error: {}",
     					elementType, getName(), e);
     			log.trace(errorMessage);
@@ -461,7 +462,8 @@ private FluentWait<WebDriver> constructElementWait(Duration timeout) {
 				.pollingEvery(Time.interval())
 				.ignoring(NoSuchElementException.class)
 				.ignoring(StaleElementReferenceException.class)
-				.ignoring(InvalidArgumentException.class);
+				.ignoring(InvalidArgumentException.class)
+				.ignoring(NoSuchWindowException.class);
 	}
 
 	/**
@@ -635,6 +637,9 @@ public boolean doesNotExist() {
 			} catch (StaleElementReferenceException e) {
 				log.trace("doesNotExist() StaleElementException return result: true");
 				return true;
+			} catch(InvalidArgumentException | NoSuchWindowException e){
+				log.trace("Unable to determine existence of element. Retrying.");
+				return doesNotExist();
 			}
 		}
 		log.trace("doesNotExist() return result: false");
@@ -898,7 +903,7 @@ private Color getBackgroundColor(WebElement element) {
 	 * Get the value of the given attribute of the element. Will return the current value, 
 	 * even if this has been modified after the page has been loaded. <br>
 	 * More exactly, this method will return the value of the property with the given name,
-	 * if it exists. If it does not, then the value of the attribute with the given name is returned. 
+	 * if it exists. If it does not, then the value of the attribute with the given name is returned.
 	 * If neither exists, null is returned. <br>
 	 * The "style" attribute is converted as best can be to a text representation with a trailingsemi-colon. <br>
 	 * The following are deemed to be "boolean" attributes, and will return either "true" or null: 
@@ -946,4 +951,14 @@ public By getBy() {
 		return createByLocator(selectorType, selector);
 	}
 
+	/**
+	 * Performs exactly 1 sweep across the DOM for the element (includes all selectors).
+	 * Does not loop for the full timeout.
+	 * @return boolean true if the element is found. false otherwise.
+	 */
+	public boolean existsAtThisInstant(){
+		driver().switchTo().defaultContent();
+		return findElementInCurrentFrame() != null || findElementInIFrame() != null;
+	}
+
 }

src/main/java/com/dougnoel/sentinel/elements/ElementFunctions.java

@@ -1,5 +1,7 @@
 package com.dougnoel.sentinel.elements;
 
+import com.dougnoel.sentinel.configurations.Time;
+import com.dougnoel.sentinel.webdrivers.WebDriverFactory;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -8,6 +10,8 @@
 import com.dougnoel.sentinel.elements.tables.Table;
 import com.dougnoel.sentinel.pages.PageManager;
 import com.dougnoel.sentinel.strings.SentinelStringUtils;
+import org.openqa.selenium.*;
+import org.openqa.selenium.support.ui.FluentWait;
 
 /**
  * Retrieves as an element as an Element or as a child type.
@@ -100,4 +104,27 @@ private static String buildClassCastExceptionMessage(String elementName, String
     	log.error(errorMessage);
     	return errorMessage;
     }
+
+	/**
+	 * Waits the configured timeout for either of the two elements to be found. Does not take into consideration visibility of elements.
+	 * Does not take into consideration which element is found first.
+	 * @param elementName String an element to search for.
+	 * @param otherElementName String another element to search for.
+	 * @return boolean true if either of the elements are found within the configured timeout. false otherwise.
+	 */
+	public static boolean waitForEitherElementToExist(String elementName, String otherElementName){
+		var wait = new FluentWait<>(WebDriverFactory.getWebDriver())
+				.withTimeout(Time.out())
+				.pollingEvery(Time.interval())
+				.ignoring(WebDriverException.class);
+
+		try{
+			wait.until(x -> getElement(elementName).existsAtThisInstant() || getElement(otherElementName).existsAtThisInstant());
+			return true;
+		}
+		catch(TimeoutException e){
+			log.trace(SentinelStringUtils.format("Timed out waiting for either {} or {} to exist.", elementName, otherElementName), e);
+			return false;
+		}
+	}
 }

src/main/java/com/dougnoel/sentinel/steps/VerificationSteps.java

@@ -4,6 +4,7 @@
 import static org.junit.Assert.*;
 
 import com.dougnoel.sentinel.configurations.Configuration;
+import com.dougnoel.sentinel.elements.ElementFunctions;
 import com.dougnoel.sentinel.math.Decimal;
 import org.apache.commons.lang3.StringUtils;
 
@@ -391,7 +392,23 @@ else if(relativeLocation.contains("right")){
         else{
             assertTrue(expectedResult, element1point.x < element2point.x);
         }
+    }
 
+    /**
+     * Verifies one of two given elements is present on the page. Does not check for visibility of elements.
+     * Useful for when a certain action may produce two different results on a page and either is acceptable for test to continue.
+     * <p>
+     * <b>Gherkin Example:</b>
+     * <ul>
+     * <li>I verify either the client table or the no rows found warning exist</li>
+     * </ul>
+     * @param elementName
+     * @param otherElementName
+     */
+    @Then("^I verify either (?:the|a|an) (.*?) or (?:the|a|an) (.*?) exist$")
+    public static void verifyOneOfTwoElementsIsFound(String elementName, String otherElementName){
+        String expectedResult = SentinelStringUtils.format("Expected either the {} or the {} to exist. Neither was found.", elementName, otherElementName);
+        assertTrue(expectedResult, ElementFunctions.waitForEitherElementToExist(elementName, otherElementName));
     }
 
 }

src/main/java/com/dougnoel/sentinel/system/DownloadManager.java

@@ -401,14 +401,15 @@ public static String createDownloadDirectory() {
     		Path downloadPath = Path.of(parentDirectoryPath, "/downloads/");
     		downloadPath.toFile().mkdir(); //make download directory if it doesn't already exist
     		downloadDirectory = downloadPath.toString();
+            log.trace("Setting download directory to {}", downloadDirectory);
     	}
         return downloadDirectory;
     }
 
     /**
      * Sets given downloadDirectory object
      * 
-     * @param downloadDirectory String the downdloadDirectory to set
+     * @param downloadDirectory String the downloadDirectory to set
      */
     public static void setDownloadDirectory(String downloadDirectory) {
         DownloadManager.downloadDirectory = downloadDirectory;
@@ -419,6 +420,7 @@ public static void setDownloadDirectory(String downloadDirectory) {
      * @throws IOException in the case that an IOException occurs while clearing the directory
      */
     public static void clearDownloadDirectory() throws IOException {
+        log.trace("Clearing download directory at {}", downloadDirectory);
         FileUtils.cleanDirectory(new File(downloadDirectory));
     }
 

src/main/java/com/dougnoel/sentinel/webdrivers/WebDriverFactory.java

@@ -127,11 +127,11 @@ public static boolean exists() {
      * Sets the download directory for chromedriver. Cannot be used with Saucelabs.
      * @param options ChromeOptions object to set
      */
-    private static void setChromeDownloadDirectory(ChromeOptions options) {
+    private static ChromeOptions setChromeDownloadDirectory(ChromeOptions options) {
         HashMap<String, Object> chromePrefs = new HashMap<>();
         chromePrefs.put("download.prompt_for_download", false);
         chromePrefs.put("download.default_directory", DownloadManager.getDownloadDirectory());
-        options.setExperimentalOption("prefs", chromePrefs);
+        return options.setExperimentalOption("prefs", chromePrefs);
     }
 
     /**
@@ -140,13 +140,11 @@ private static void setChromeDownloadDirectory(ChromeOptions options) {
      * @return WebDriver ChromeDrvier
      */
     private static WebDriver createChromeDriver() {
-    	var chromeOptions = new ChromeOptions();
-    	setChromeDownloadDirectory(chromeOptions);
+    	var chromeOptions = setChromeDownloadDirectory(new ChromeOptions());
         String commandlineOptions = Configuration.toString("chromeOptions");
         if (commandlineOptions != null)
             chromeOptions.addArguments(commandlineOptions);
-    	var headless = Configuration.toString("headless");
-    	if (headless != null && !headless.equalsIgnoreCase("false")) {
+    	if (Configuration.toBoolean("headless")) {
     		chromeOptions.addArguments("--no-sandbox");
     		chromeOptions.addArguments("--disable-dev-shm-usage");
     		chromeOptions.addArguments("--headless=new");

src/test/java/com/dougnoel/sentinel/assertions/TableAssertTests.java

@@ -26,7 +26,7 @@ public static void setUpBeforeClass() {
     @AfterClass
     public static void tearDownAfterClass() {
         Time.reset();
-        Configuration.update("timeout", 10);
+        Configuration.clear("timeout");
         Driver.quitAllDrivers();
     }