Package com.crawljax.fragmentation

Class FragmentationPlugin

java.lang.Object

com.crawljax.fragmentation.FragmentationPlugin

All Implemented Interfaces:

OnNewStatePlugin, OnRevisitStatePlugin, Plugin, PostCrawlingPlugin

public class FragmentationPlugin
extends Object
implements OnNewStatePlugin, OnRevisitStatePlugin, PostCrawlingPlugin

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	COMPARE_FAST
static boolean	DISABLE_STATE_COMP
private static boolean	exportFragments
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
FragmentationPlugin()

Method Summary

Modifier and Type	Method	Description
static void	addFragments(StateVertex newState, FragmentManager manager)
private static void	exportFragDom(HybridStateVertexImpl state, File outputDir)
static void	fragmentState(StateVertex newState, FragmentManager manager, EmbeddedBrowser browser, File outputDir, boolean exportDom)	Main function that gets called everytime a new state is discovered.
static void	loadFragmentState(StateVertex fragState, FragmentManager manager, Document dom, BufferedImage screenshot)	Loads a statevertex in an offline setting using a previously fragmented and recorded DOM.
void	onNewState(CrawlerContext context, StateVertex newState)	Method that is called when a new state is found.
void	onRevisitState(CrawlerContext context, StateVertex currentState)	Method that is called every time a state is revisited by Crawljax.
void	postCrawling(CrawlSession session, ExitNotifier.ExitStatus exitReason)	Exports the comparison results during crawling.
static void	writeCrawlPath(CrawlSession session, CrawlPath crawlPath, int id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

COMPARE_FAST

public static final boolean COMPARE_FAST

See Also:

Constant Field Values

DISABLE_STATE_COMP

public static final boolean DISABLE_STATE_COMP

See Also:

Constant Field Values

exportFragments

private static final boolean exportFragments

See Also:

Constant Field Values

Constructor Detail

FragmentationPlugin

public FragmentationPlugin()

Method Detail

loadFragmentState

public static void loadFragmentState(StateVertex fragState,
                                     FragmentManager manager,
                                     Document dom,
                                     BufferedImage screenshot)

Loads a statevertex in an offline setting using a previously fragmented and recorded DOM. This is useful to determine the similarity between a previously recorded state and the current browser state in a regression test scenario.

Parameters:

fragState -

manager -

dom -

screenshot -

fragmentState

public static void fragmentState(StateVertex newState,
                                 FragmentManager manager,
                                 EmbeddedBrowser browser,
                                 File outputDir,
                                 boolean exportDom)

Main function that gets called everytime a new state is discovered. Uses VIPS to perform fragmentation and calls fragment manager to analyze fragments

Parameters:

newState -

manager -

browser -

outputDir -

exportDom -

addFragments

public static void addFragments(StateVertex newState,
                                FragmentManager manager)

exportFragDom

private static void exportFragDom(HybridStateVertexImpl state,
                                  File outputDir)

writeCrawlPath

public static void writeCrawlPath(CrawlSession session,
                                  CrawlPath crawlPath,
                                  int id)

onNewState

public void onNewState(CrawlerContext context,
                       StateVertex newState)

Description copied from interface: OnNewStatePlugin

Method that is called when a new state is found. When this method is called the state is already added to the StateFlowGraph.

This method can be called from multiple threads with different CrawlerContext

Specified by:

onNewState in interface OnNewStatePlugin

Parameters:

context - the current context.

newState - The new state. Equivalent to CrawlerContext.getCurrentState().

onRevisitState

public void onRevisitState(CrawlerContext context,
                           StateVertex currentState)

Description copied from interface: OnRevisitStatePlugin

Method that is called every time a state is revisited by Crawljax. Warning: changing the state can influence crawljax, it is not a copy.

This method can be called from multiple threads with different CrawlerContext

Specified by:

onRevisitState in interface OnRevisitStatePlugin

Parameters:

context - the crawlSession

currentState - the state revisited

postCrawling

public void postCrawling(CrawlSession session,
                         ExitNotifier.ExitStatus exitReason)

Exports the comparison results during crawling. Also preserves the information regarding extracted fragments from states.

Specified by:

postCrawling in interface PostCrawlingPlugin

Parameters:

session - the crawl session.

exitReason - The ExitNotifier.ExitStatus Crawljax stopped.