net.jawr.web.test.AbstractPageTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jawr-integration-test-utils Show documentation
Utilities for Jawr integration tests
There is a newer version: 3.9
Show newest version
/**
 * 
 */
package net.jawr.web.test;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.List;

import net.jawr.web.test.utils.Utils;

import org.apache.commons.io.IOUtils;
import org.apache.log4j.Logger;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;

import com.gargoylesoftware.htmlunit.BrowserVersion;
import com.gargoylesoftware.htmlunit.CollectingAlertHandler;
import com.gargoylesoftware.htmlunit.JavaScriptPage;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.TextPage;
import com.gargoylesoftware.htmlunit.WebClient;
import com.gargoylesoftware.htmlunit.html.HtmlImage;
import com.gargoylesoftware.htmlunit.html.HtmlImageInput;
import com.gargoylesoftware.htmlunit.html.HtmlLink;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlScript;

/**
 * The base class for integration tests in Jawr. This class is responsible of
 * creating the Jetty server at the beginning of the tests defined in the
 * current class. The configuration files (Web.xml and jawr.properties) are
 * updated before the start of the tests.
 * 
 * To launch the tests, we use the maven command : mvn integration-test The root
 * folder of the application is defined in "target/jawr-integration-test".
 * 
 * @author Ibrahim Chaehoi
 */
public abstract class AbstractPageTest {

	/** The logger */
	private static Logger LOGGER = Logger.getLogger(AbstractPageTest.class);

	/** The web client */
	protected WebClient webClient;

	/** The list of alerts collected */
	protected List collectedAlerts;

	/** The HTML page */
	protected HtmlPage page;

	@BeforeClass
	public static void setInitFlag() throws IOException {
		
		LOGGER.debug("****** Start Test case *********");
		JawrIntegrationServer.getInstance().initBeforeTestCase();
	}

	@Before
	public void setup() throws Exception {

		LOGGER.debug("****** Start Test "+getClass()+" *********");
		initConfigFile();
		JawrIntegrationServer.getInstance().setup();

		webClient = createWebClient();
		collectedAlerts = new ArrayList();
		webClient.setAlertHandler(new CollectingAlertHandler(collectedAlerts));
		page = webClient.getPage(getPageUrl());

	}
	
	/**
	 * Initialize the web app config files
	 */
	protected void initConfigFile(){
	
		JawrTestConfigFiles annotationConfig = (JawrTestConfigFiles) getClass()
				.getAnnotation(JawrTestConfigFiles.class);
		try{
			String currentJawrConfigPath = annotationConfig.jawrConfig();
			String webappRootDir = JawrIntegrationServer.getInstance().getWebAppRootDir();
			
			OutputStream outFile = new FileOutputStream(new File(webappRootDir, "/WEB-INF/classes/jawr.properties"));
			IOUtils.copy(getClass().getClassLoader().getResourceAsStream(
					currentJawrConfigPath), outFile);
			IOUtils.closeQuietly(outFile);
			
			String currentWebXmlPath = annotationConfig.webXml();
			outFile = new FileOutputStream(new File(webappRootDir, "/WEB-INF/web.xml"));
			IOUtils.copy(getClass().getClassLoader().getResourceAsStream(
					currentWebXmlPath), outFile);
			IOUtils.closeQuietly(outFile);	
		}catch(IOException e){
			throw new RuntimeException(e);
		}
	}

	@After
	public void teardown(){
		LOGGER.debug("****** End Test "+getClass()+" *********");
	}
	
	/**
	 * Returns the webapp context path
	 * @return the webapp context path
	 */
	protected String getUrlPrefix(){
		return JawrIntegrationServer.getInstance().getContextPath();
	}
	
	/**
	 * Returns the server url prefix
	 * @return the server url prefix
	 */
	protected String getServerUrlPrefix() {
		return JawrIntegrationServer.getInstance().getServerUrlPrefix();
	}
	
	/**
	 * Creates the web client
	 * 
	 * @return the web client
	 */
	protected WebClient createWebClient() {
		
		WebClient webClient = new WebClient(BrowserVersion.FIREFOX_3);
		// Defines the accepted language for the web client.
		webClient.addRequestHeader("Accept-Language", getAcceptedLanguage());
		return webClient;
	}
	
	

	/**
	 * Resets the test configuration.
	 * 
	 * @throws Exception
	 *             if an exception occurs
	 */
	@AfterClass
	public static void resetTestConfiguration() throws Exception {

		JawrIntegrationServer.getInstance().resetTestConfiguration();
		LOGGER.debug("****** End Test case *********");
		
	}

	/**
	 * Returns the locale used for the test
	 * 
	 * @return the locale used for the test
	 */
	public String getAcceptedLanguage() {
		return "en-us";
	}

	/**
	 * Returns the url of the page to test
	 * 
	 * @return the url of the page to test
	 */
	protected abstract String getPageUrl();

	/**
	 * Assert that the content of the file name equals to the response of the
	 * page.
	 * 
	 * @param fileName
	 *            the file name
	 * @param page
	 *            the web page
	 * @throws Exception
	 *             if an exception occurs.
	 */
	protected void assertContentEquals(String fileName, Page page)
			throws Exception {
		Utils.assertContentEquals(getClass(), fileName, page);
	}

	/**
	 * Returns the list of HTML script tags which have an src attribute.
	 * 
	 * @return the list of HTML script tag.
	 */
	@SuppressWarnings("unchecked")
	protected List getJsScriptTags() {
		return (List) page.getByXPath("html/head/script[@src]");
	}

	/**
	 * Returns the list of HTML link tags.
	 * 
	 * @return the list of HTML script tags.
	 */
	@SuppressWarnings("unchecked")
	protected List getHtmlLinkTags() {
		return (List) page.getByXPath("html/head/link");
	}

	/**
	 * Returns the list of HTML link tags.
	 * 
	 * @return the list of HTML script tags.
	 */
	@SuppressWarnings("unchecked")
	protected List getHtmlImageTags() {
		return (List) page.getByXPath("//img");
	}

	/**
	 * Returns the list of HTML link tags.
	 * 
	 * @return the list of HTML script tags.
	 */
	@SuppressWarnings("unchecked")
	protected List getHtmlImageInputTags() {
		return (List) page.getByXPath("//input[@type='image']");
	}

	/**
	 * Call the webserver to retrieve the javascript page associated to the Html
	 * script object.
	 * 
	 * @param script
	 *            the Html script
	 * @return the javascript page
	 * @throws IOException
	 *             if an IOException occurs
	 * @throws MalformedURLException
	 *             if a MalformedURLException occurs
	 */
	protected JavaScriptPage getJavascriptPage(final HtmlScript script)
			throws IOException, MalformedURLException {
		return webClient.getPage(JawrIntegrationServer.SERVER_URL + script.getSrcAttribute());
	}

	/**
	 * Call the webserver to retrieve the css page associated to the Html link
	 * object.
	 * 
	 * @param css
	 *            the Html link
	 * @return the css page
	 * @throws IOException
	 *             if an IOException occurs
	 * @throws MalformedURLException
	 *             if a MalformedURLException occurs
	 */
	protected TextPage getCssPage(final HtmlLink css) throws IOException,
			MalformedURLException {
		return webClient.getPage(JawrIntegrationServer.SERVER_URL + css.getHrefAttribute());
	}

}