geb.js.AlertAndConfirmSupport.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geb-core Show documentation

Geb (pronounced "jeb") is a browser automation solution. It brings together the power of WebDriver, the elegance of jQuery content selection, the robustness of Page Object modelling and the expressiveness of the Groovy language.

There is a newer version: 0.7.2

Show newest version

/* Copyright 2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package geb.js

class AlertAndConfirmSupport {

	private final static UNKNOWN = -1
	private final Closure javascriptInterfaceFactory
	
	AlertAndConfirmSupport(Closure javascriptInterfaceFactory) {
		this.javascriptInterfaceFactory = javascriptInterfaceFactory
	}
	
	private JavascriptInterface getJavascriptInterface() {
		def js = javascriptInterfaceFactory()
		if (js == null) {
			throw new IllegalStateException("javascriptInterfaceFactory returned null")
		} else if (!(js instanceof JavascriptInterface)) {
			throw new IllegalStateException("javascriptInterfaceFactory did not return a JavascriptInterface")
		}
		
		js
	}

	private getInstallGebStorageScript() {
		"""
			if (!window.geb) {
				window.geb = {};
			} 
		"""
	}
	
	private getInstallDialogStorageScript() {
		"""
			$installGebStorageScript
			
			if (!window.geb.dialogFunctions) {
				window.geb.dialogFunctions = new Array();
			}
			if (!window.geb.dialogMessages) {
				window.geb.dialogMessages = new Array();
			}
		"""
	}
	
	private popLastDialogMessage(JavascriptInterface js) {
		js.exec """
			if (window.geb) {
				return window.geb.dialogMessages.pop();
			} else {
				return $UNKNOWN;
			}
		"""
	}

	private popLastDialogFunctionOnto(JavascriptInterface js, String onto) {
		js.exec """
			if (window.geb) {
				window.$onto = window.geb.dialogFunctions.pop();
			}
		"""
	}
	
	private installAlert(JavascriptInterface js) {
		js.exec """
			$installDialogStorageScript
			
			window.geb.dialogFunctions.push(window.alert);
			window.geb.dialogMessages.push(null);
			
			window.alert = function(msg) {
				window.geb.dialogMessages.pop();
				window.geb.dialogMessages.push(msg);
				return true;
			};
		"""
	}
	
	private installConfirm(boolean ok, JavascriptInterface js) {
		js.exec """
			$installDialogStorageScript
			
			window.geb.dialogFunctions.push(window.confirm);
			window.geb.dialogMessages.push(null);
			
			window.confirm = function(msg) {
				window.geb.dialogMessages.pop();
				window.geb.dialogMessages.push(msg);
				return $ok;
			};
		"""
	}

	private captureDialog(Closure installer, String function, Closure actions) {
		def js = getJavascriptInterface()
		
		installer(js)
		
		def actionsError = null
		try {
			actions()
		} catch (Throwable e) {
			actionsError = e
		}
		
		// Need to do this even if actions raised exception
		def message = popLastDialogMessage(js)
		popLastDialogFunctionOnto(js, function)
		
		if (actionsError) {
			throw actionsError
		} else {
			message
		}
	}
	
	private captureAlert(Closure actions) {
		captureDialog(this.&installAlert, 'alert', actions)
	}

	private captureConfirm(boolean ok, Closure actions) {
		captureDialog(this.&installConfirm.curry(ok), 'confirm', actions)
	}

	def withAlert(Closure actions) {
		def message = captureAlert(actions)
		if (message == null) {
			throw new AssertionError("no browser alert() was raised")
		} else if (message == UNKNOWN) {
			true
		} else {
			message.toString()
		}
	}

	void withNoAlert(Closure actions) {
		def message = captureAlert(actions)
		if (message != null && message != UNKNOWN) {
			throw new AssertionError("an unexpected browser alert() was raised (message: $message)")
		}
	}

	def withConfirm(Closure actions) {
		withConfirm(true, actions)
	}
	
	def withConfirm(boolean ok, Closure actions) {
		def message = captureConfirm(ok, actions)
		if (message == null) {
			throw new AssertionError("no browser confirm() was raised")
		} else if (message == UNKNOWN) {
			true
		} else {
			message.toString()
		}
	}

	void withNoConfirm(Closure actions) {
		def message = captureConfirm(false, actions)
		if (message != null && message != UNKNOWN) {
			throw new AssertionError("an unexpected browser confirm() was raised (message: $message)")
		}
	}
}