Fixed waitFor to ensure it retries correctly and that html match strings will ignore white space discrepancies with the page source.

Author: Danny Stevens

madcow-webdriver/src/main/groovy/au/com/ps4impact/madcow/runner/webdriver/blade/WaitFor.groovy

@@ -26,42 +26,69 @@ import au.com.ps4impact.madcow.step.MadcowStep
 import org.apache.commons.lang3.StringUtils
 import au.com.ps4impact.madcow.step.MadcowStepResult
 import au.com.ps4impact.madcow.runner.webdriver.WebDriverBladeRunner
+import org.apache.log4j.Logger
 
 /**
- * Blade runner to wait for a specific element/text to appear
+ * Blade runner to wait for a specific element/text to appear.
+ * Time out after 30 seconds.
  *
  * @author: Gavin Bunney
  */
 class WaitFor extends WebDriverBladeRunner {
 
-    public void execute(WebDriverStepRunner stepRunner, MadcowStep step) {
+    private static final int maxSeconds = 30;
 
-        final boolean found = (1..30).any {
 
-            try {
-                if (StringUtils.isEmpty(step.blade.mappingSelectorValue)) {
-                    if (step.blade.parameters ?: '' == '' || stepRunner.driver.pageSource.contains(step.blade.parameters as String)) {
-                        step.testCase.logInfo("Waiting for: $step.blade.parameters");
-                        return true;
-                    } else {
-                        throw new NoSuchElementException();
-                    }
-                } else {
-                    def element = findElement(stepRunner, step);
-                    if (StringUtils.isNotEmpty((step.blade.parameters ?: '')))
-                        return element.text == step.blade.parameters as String || element.getAttribute('value')==step.blade.parameters as String;
-                    else
-                        return true;
-                }
-            } catch (Exception ignored) { }
+    public void execute(WebDriverStepRunner stepRunner, MadcowStep step) {
+        boolean found = false;
+        for (count in 1..maxSeconds) {
+            found = isDesiredConditionFound(count, step, stepRunner, found)
+            if (found) break;
             Thread.sleep(1000);
-            return false;
         }
 
         if (found)
             step.result = MadcowStepResult.PASS();
         else
             step.result = MadcowStepResult.FAIL('Element didn\'t appear within the timeout');
+
+    }
+
+    private boolean isDesiredConditionFound(int count, MadcowStep step, WebDriverStepRunner stepRunner, boolean found) {
+        try {
+            step.testCase.logInfo("Waiting ("+count+") for: $step.blade.parameters");
+            if (StringUtils.isEmpty(step.blade.mappingSelectorValue)) {
+                if (StringUtils.isBlank(step.blade.parameters)) {
+                    found = true; // request has no pattern to match
+                } else {
+                    def pageSource = stepRunner.getDriver().getPageSource();
+                    if (StringUtils.isNotBlank(pageSource)) {
+                        pageSource = trimWhiteSpace(pageSource);
+                        def targetString = trimWhiteSpace(step.blade.parameters as String);
+                        if (pageSource.contains(targetString)) {
+                            found = true;
+                        }
+                    }
+                }
+            } else {
+                def element = findElement(stepRunner, step);
+                if (StringUtils.isNotEmpty((step.blade.parameters ?: '')))
+                    found = element.text == step.blade.parameters as String || element.getAttribute('value') == step.blade.parameters as String;
+                else
+                    found = true;
+            }
+        } catch (Exception ignored) {
+        }
+        found
+    }
+
+    private String trimWhiteSpace(String aStr) {
+        aStr = aStr.trim();
+        aStr = StringUtils.remove(aStr,"  ");
+        aStr = StringUtils.remove(aStr,"\n");
+        aStr = StringUtils.remove(aStr,"\r");
+        aStr = StringUtils.remove(aStr,"\t");
+        return aStr;
     }
 
     /**

madcow-webdriver/src/test/groovy/au/com/ps4impact/madcow/runner/webdriver/blade/WaitForTest.groovy

@@ -70,11 +70,18 @@ class WaitForTest extends AbstractBladeTestCase {
         verifyWaitFor(blade, true);
     }
 
+    @Test
+    void testWaitForHTMLNoMatch() {
+        GrassBlade blade = new GrassBlade('waitFor = <BUGEDDYBUGGEDY />', testCase.grassParser);
+        verifyWaitFor(blade, false);
+    }
+
     @Test
     void testWaitForHTML() {
-        GrassBlade blade = new GrassBlade('waitFor = <button id="enabledButton" name="enabledButton">enabledButton</button>', testCase.grassParser);
+        GrassBlade blade = new GrassBlade('waitFor =<button id="enabledButton" name="enabledButton">\n' +
+                '                enabledButton\n' +
+                '              </button>', testCase.grassParser);
         verifyWaitFor(blade, true);
-        assertEquals(blade.parameters, "<button id=\"enabledButton\" name=\"enabledButton\">enabledButton</button>")
     }
 
     @Test