org.jspringbot.keyword.selenium.OmnitureDebugger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jspringbot-selenium Show documentation
There is a newer version: 1.9
package org.jspringbot.keyword.selenium;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.commons.lang.StringEscapeUtils;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;
import org.jsoup.select.Elements;
import org.jspringbot.syntax.HighlightRobotLogger;
import org.springframework.beans.factory.annotation.Autowired;

public class OmnitureDebugger extends SeleniumHelper {
	public static final HighlightRobotLogger LOG = HighlightRobotLogger.getLogger(OmnitureDebugger.class);
	
	@Autowired
	protected SeleniumHelper helper;

	// Values are set using OmnitureDebuggerBean
	private String omnitureDebuggerLocation;
	private int omnitureDebuggerWaitTimeInMillis;
	private int omnitureDebuggerPreviousPageClickEventWaitTimeInMillis;

	private static final String OMNITURE_DEBUGGER_WINDOW_NAME = "stats_debugger";
	private static final String OMNITURE_DEBUGGER_URL_DECODE_CHECKBOX = "url_decode";

	public OmnitureDebugger() {
	}
    
	public ArrayList getListOfSiteCatalystVariables() {
		String htmlSource = helper.getHTMLSourceOfOmnitureDebuggerWindow(
				getStatsDebuggerLocation(), OMNITURE_DEBUGGER_WINDOW_NAME,
				OMNITURE_DEBUGGER_URL_DECODE_CHECKBOX,
				getOmnitureDebuggerWaitTimeInMillis());
		return getSiteCatalystValuesListFromHtml(htmlSource);
	}

	public HashMap getMapOfSiteCatalystVariables() {
		String htmlSource = helper.getHTMLSourceOfOmnitureDebuggerWindow(
				getStatsDebuggerLocation(), OMNITURE_DEBUGGER_WINDOW_NAME,
				OMNITURE_DEBUGGER_URL_DECODE_CHECKBOX,
				getOmnitureDebuggerWaitTimeInMillis());
		return getSiteCatalystMapFromHtmlSource(htmlSource);
	}
	
	public HashMap> getMapOfSiteCatalystEvents() {
		String htmlSource = helper.getHTMLSourceOfOmnitureDebuggerWindow(
				getStatsDebuggerLocation(), OMNITURE_DEBUGGER_WINDOW_NAME,
				OMNITURE_DEBUGGER_URL_DECODE_CHECKBOX,
				getOmnitureDebuggerWaitTimeInMillis());
		return getSiteCatalystEventsListFromHtml(htmlSource);
	}
	
	// same as the getMapOfSiteCatalystEvents() except for a slower wait in in millis
	public HashMap> getMapOfSiteCatalystEventsFromPreviousPage() {
		String htmlSource = helper.getHTMLSourceOfOmnitureDebuggerWindow(
				getStatsDebuggerLocation(), OMNITURE_DEBUGGER_WINDOW_NAME,
				OMNITURE_DEBUGGER_URL_DECODE_CHECKBOX,
				getPreviousPageClickEventWaitTimeInMillis());
		return getSiteCatalystEventsListFromHtml(htmlSource);
	}
	
	public void siteCatalystVariableMapShouldContain(HashMap map, String scVar, String expectedValue){
		try {
			String actualValue = map.get(scVar);
			LOG.createAppender()
					.appendBold("Site Catalyst Variable And Value:")
					.appendProperty("scVar", scVar)
					.appendProperty("Expected Value:", expectedValue)
					.appendProperty("Actual Value:", actualValue)
					.log();
			if (!actualValue.equals(expectedValue)) {
				throw new AssertionError("The value of the variable contained in the map is not as expected.");
			}
		} catch (Exception e) {
			LOG.createAppender()
					.appendBold("No Site Catalyst Variable(s) Found In Map.")
					.log();
			throw new IllegalStateException("No Site Catalyst Variable(s) Found In Map.");
		}
    }
    
    public void siteCatalystVariableListShouldContain(Collection aList, String expectedKeyValuePair){
		try {
			LOG.createAppender()
					.appendBold("Site Catalyst Variable And Value:")
					.appendProperty("Expected Key-Value Pair In List:", expectedKeyValuePair)
					.appendCode(printList((ArrayList) aList))
					.log();
			if (!aList.contains(expectedKeyValuePair)) {
				throw new AssertionError("The expected key-value pair is not present in the list.");
			}
		} catch (Exception e) {
			LOG.createAppender()
					.appendBold("No Site Catalyst Variable(s) Found In List.")
					.log();
			throw new IllegalStateException("No Site Catalyst Variable(s) Found In List.");
		}
    }

    private String getStatsDebuggerLocation() {
		return "javascript:void(window.open(\"\",\""
				+ OMNITURE_DEBUGGER_WINDOW_NAME
				+ "\",\"width=600,height=600,location=0,menubar=0,status=1,toolbar=0,resizable=1,scrollbars=1\").document.write(\"\"));";
	}

    private ArrayList getSiteCatalystValuesListFromHtml(String htmlSource) {   
    	ArrayList scVariables = null;
		try {
			scVariables = (ArrayList) parseAndReturnSiteCatalystVariables(htmlSource);
			LOG.createAppender()
					.appendBold("Site Catalyst Variables And Values:")
					.appendCode(printList(scVariables)).log();
			return (ArrayList) scVariables;
		} catch (Exception e) {
			LOG.createAppender()
					.appendBold("No Site Catalyst Variable(s) Found.").log();
	        return null;
		}
    }
    
    private HashMap> getSiteCatalystEventsListFromHtml(String htmlSource) {
		try {
			Map> events = new HashMap>();
			events = (HashMap>) parseImagesFiredAndReturnSiteCatalystVariables(htmlSource);
			LOG.createAppender()
				.appendBold("Site Catalyst Events:")
				.appendCode(printMap(events)).log();
			return (HashMap>) events;
		} catch (Exception e) {
			LOG.createAppender()
					.appendBold("No Site Catalyst Event(s) Found.").log();
			return null;
		}
    }
    
    private HashMap getSiteCatalystMapFromHtmlSource(String htmlSource) {
		Map scVariables = new HashMap();
		List variables = parseAndReturnSiteCatalystVariables(htmlSource);
		try {
			for (String temp : variables) {
				String[] holder = temp.split("=");
				scVariables.put(holder[0], holder[1]);
			}
			LOG.createAppender()
					.appendBold("Site Catalyst Variables And Values:")
					.appendCode(printMap(sortByKeys(scVariables))).log();
			return (HashMap) scVariables;
		} catch (Exception e) {
			LOG.createAppender()
					.appendBold("No Site Catalyst Variable(s) Found.").log();
			return null;
		}
    }
    
	private  String printMap(Map map) {
		StringBuilder sb = new StringBuilder();
		Iterator> iter = map.entrySet().iterator();
		while (iter.hasNext()) {
			Entry entry = iter.next();
			sb.append(entry.getKey());
			sb.append(" = ");
			sb.append(entry.getValue());
			if (iter.hasNext()) {
				sb.append('\n');
			}
		}
		return sb.toString();
	}

	private String printList(ArrayList list) {
		StringBuilder sb = new StringBuilder();
		ListIterator listIterator = list.listIterator();
		while (listIterator.hasNext()) {
			sb.append(listIterator.next());
			if (listIterator.hasNext()) {
				sb.append('\n');
			}
		}
		return sb.toString();
	}
    
	private List parseAndReturnSiteCatalystVariables(String htmlSource) {
		Document doc = Jsoup.parse(htmlSource);
		Elements tds = doc.select("td");
		String[] tdList = null;
		for (Element td : tds) {
			if (td.text().contains("Image")) {
				tdList = td.html().split("
");
			}
		}
		try {
			// Out of the 'for loop' to only evaluate/parse the last Image triggered.
			List actualList = new ArrayList(Arrays.asList(tdList));			
			actualList.remove(0); // remove from list ---- Image
			List unescapedList = new ArrayList();
			for (String data: actualList) {
				unescapedList.add(StringEscapeUtils.unescapeXml(data));
			}
			return unescapedList;
			
		} catch (NullPointerException npe) {
			// LOG.createAppender().appendBold("No Image Found!").log();
			return null;
		}
	}
	
	private Map> parseImagesFiredAndReturnSiteCatalystVariables(String htmlSource){
    	Map> eventMap = new HashMap>();
    	Document doc = Jsoup.parse(htmlSource);   	
    	Elements tds = doc.select("td");
    	String[] tdList = null;   	
    	int counter = 0;
    	String eventPrefix = "Event";
    	for (Element td : tds) {    		
    		if (td.text().contains("Image")) {
    			tdList = td.html().split("
");   			
    	    	List actualList = new ArrayList(Arrays.asList(tdList));
    	    	actualList.remove(0);   // remove from list ---- Image   	
    	    	List unescapedList = new ArrayList();
    	    	for (String data: actualList) {
    	    		if (!data.contains("table")) {	// Exclude parsed data with html tags like . This is a duplicate data.
    	    			unescapedList.add(StringEscapeUtils.unescapeXml(data));
    	    		}    				
    			}
    	    	eventMap.put(eventPrefix + counter, unescapedList);
    	    	counter = counter + 1;
    		}
    	}
    	eventMap.remove("Event0"); // This contains the first td element that is not needed
    	LOG.createAppender()
			.appendBold("Number Of Events Captured")
			.appendCode(String.format("%s", eventMap.size())).log();
    	return eventMap;
    }
	
	@SuppressWarnings("unchecked")
	private HashMap sortByKeys(Map scVariables) {
		List list = new LinkedList(scVariables.entrySet());
		Collections.sort(list, new Comparator() {
			public int compare(Object o1, Object o2) {
				return ((Comparable) ((Map.Entry) (o1)).getKey()).compareTo(((Map.Entry) (o2)).getKey());
			}
		});
		HashMap sortedHashMap = new LinkedHashMap();
		for (Iterator it = list.iterator(); it.hasNext();) {
			Map.Entry entry = (Map.Entry) it.next();
			sortedHashMap.put(entry.getKey(), entry.getValue());
		}
		return (HashMap) sortedHashMap;
	}

	public void setOmnitureDebuggerLocation(String location) {
		this.omnitureDebuggerLocation = location;
	}

	public void setOmnitureDebuggerWaitTimeInMillis(int waitTime) {
		this.omnitureDebuggerWaitTimeInMillis = waitTime;
	}

	public String getOmnitureDebuggerLocation() {
		return omnitureDebuggerLocation;
	}

	public int getOmnitureDebuggerWaitTimeInMillis() {
		return omnitureDebuggerWaitTimeInMillis;
	}
	
	public int getPreviousPageClickEventWaitTimeInMillis() {
		return omnitureDebuggerPreviousPageClickEventWaitTimeInMillis;
	}

	public void setPreviousPageClickEventWaitTimeInMillis(int previousClickEventWaitTimeInMillis) {
		this.omnitureDebuggerPreviousPageClickEventWaitTimeInMillis = previousClickEventWaitTimeInMillis;
	}

}