/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.arquillian.ajocado.waiting.ajax;
import static org.jboss.arquillian.ajocado.utils.SimplifiedFormat.format;
import static org.jboss.arquillian.ajocado.encapsulated.JavaScript.js;
import org.jboss.arquillian.ajocado.encapsulated.JavaScript;
import org.jboss.arquillian.ajocado.framework.AjaxSelenium;
import org.jboss.arquillian.ajocado.framework.AjaxSeleniumContext;
import org.jboss.arquillian.ajocado.waiting.DefaultWaiting;
import com.thoughtworks.selenium.SeleniumException;
/**
* <p>
* Implementation of waiting for satisfaction of conditions on page after the Ajax request.
* </p>
*
* <p>
* It uses custom JavaScript and {@link com.thoughtworks.selenium.Selenium.Selenium#waitForCondition(String, String)} to
* wait for satisfying given condition.
* </p>
*
* @author <a href="mailto:lfryc@redhat.com">Lukas Fryc</a>
* @version $Revision$
*/
public class AjaxWaiting extends DefaultWaiting<AjaxWaiting> {
/**
* Proxy to local selenium instance
*/
private AjaxSelenium selenium = AjaxSeleniumContext.getProxy();
/**
* Stars loop waiting to satisfy condition.
*
* @param condition
* what wait for to be satisfied
*/
public void until(JavaScriptCondition condition) {
waitExpectingTimeout(condition.getJavaScriptCondition());
}
/**
* Waits until Retrieve's implementation doesn't retrieve value other than oldValue.
*
* @param <T>
* type of value what we are waiting for change
* @param oldValue
* value that we are waiting for change
* @param retriever
* implementation of retrieving actual value
*/
public <T> void waitForChange(T oldValue, JavaScriptRetriever<T> retriever) {
final JavaScript condition = prepareCondition(oldValue, retriever);
waitExpectingTimeout(condition);
}
/**
* <p>
* Waits until Retrieve's implementation doesn't retrieve value other than value stored by initialization in
* retriever.
* </p>
*
* <p>
* After retrieving, new value will be associated with given Retriever.
* </p>
*
*
* <p>
* Note that Retriever needs to be initialized first by one of methods {@link Retriever#initializeValue()} or
* {@link Retriever#setValue(Object)}.
* </p>
*
* @param <T>
* type of value what we are waiting for change
* @param retriever
* implementation of retrieving actual value
*/
public <T> void waitForChange(JavaScriptRetriever<T> retriever) {
T retrieved = waitForChangeAndReturn(retriever.getValue(), retriever);
retriever.setValue(retrieved);
}
/**
* Waits until Retrieve's implementation doesn't retrieve value other than oldValue and this new value returns.
*
* @param <T>
* type of value what we are waiting for change
* @param oldValue
* value that we are waiting for change
* @param retriever
* implementation of retrieving actual value
* @return new retrieved value
*/
public <T> T waitForChangeAndReturn(T oldValue, JavaScriptRetriever<T> retriever) {
final JavaScript script = retriever.getJavaScriptRetrieve();
final JavaScript condition = prepareCondition(oldValue, retriever);
waitExpectingTimeout(condition);
String retrieved = selenium.getEval(script);
T converted = retriever.getConvertor().backwardConversion(retrieved);
return converted;
}
/**
* <p>
* Waits until Retrieve's implementation doesn't retrieve value other than value stored by initialization in
* retriever.
* </p>
*
* <p>
* After retrieving, new value will be associated with given Retriever.
* </p>
*
*
* <p>
* Note that Retriever needs to be initialized first by one of methods {@link Retriever#initializeValue()} or
* {@link Retriever#setValue(Object)}.
* </p>
*
* @param <T>
* type of value what we are waiting for change
* @param retriever
* implementation of retrieving actual value
* @return new retrieved value
*/
public <T> T waitForChangeAndReturn(JavaScriptRetriever<T> retriever) {
T retrieved = waitForChangeAndReturn(retriever.getValue(), retriever);
retriever.setValue(retrieved);
return retrieved;
}
private <T> JavaScript prepareCondition(T oldValue, JavaScriptRetriever<T> retriever) {
final String scriptString = retriever.getJavaScriptRetrieve().getAsString();
final String oldValueString = retriever.getConvertor().forwardConversion(oldValue);
return js(format("{0} != '{1}'", scriptString, oldValueString));
}
private void waitExpectingTimeout(JavaScript condition) {
try {
selenium.waitForCondition(condition, this.getTimeout());
} catch (SeleniumException e) {
if (isTimeoutException(e)) {
fail();
}
throw e;
}
}
private boolean isTimeoutException(SeleniumException e) {
return e.getMessage().startsWith("Timed out after");
}
}