com.applitools.eyes

Class EyesBase

java.lang.Object

com.applitools.eyes.EyesBase

public abstract class EyesBase
extends Object

Applitools Eyes Java API.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.applitools.eyes.AgentConnector	agentConnector
static String	DEFAULT_CHARSET_NAME
protected static MatchLevel	DEFAULT_MATCH_LEVEL
protected EyesScreenshot	lastScreenshot
protected com.applitools.eyes.RunningSession	runningSession
protected com.applitools.eyes.SessionStartInfo	sessionStartInfo
protected RectangleSize	viewportSize

Constructor Summary

Constructors

Constructor and Description
EyesBase(URI serverUrl, boolean isDisabled) Creates a new (possibly disabled) EyesBase instance that interacts with the Eyes Server at the specified url.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortIfNotClosed() If a test is running, aborts it.
protected void	addMouseTrigger(MouseAction action, Region control, Location cursor) Adds a mouse trigger.
protected void	addTextTrigger(Region control, String text) Adds a keyboard trigger.
protected void	addUserInput(com.applitools.eyes.Trigger trigger) Adds a trigger to the current list of user inputs.
protected void	checkWindow(BufferedImage image, String tag, boolean ignoreMismatch)
protected void	clearUserInputs() Clears the user inputs list.
TestResults	close() Ends the test.
abstract String	getAgentId()
protected static String	getApiKey() Gets the currently set API key or null if no key is set.
static URI	getDefaultServerUrl()
protected com.applitools.eyes.AppEnvironment	getEnvironment()
FailureReports	getFailureReports()
protected abstract String	getInferredEnvironment()
boolean	getIsDisabled()
boolean	getIsOpen()
protected EyesScreenshot	getLastScreenshot()
boolean	getSaveFailedTests()
boolean	getSaveNewTests()
protected abstract String	getTitle()
protected com.applitools.eyes.Trigger[]	getUserInputs() Returns all user inputs.
protected RectangleSize	getViewportSize()
void	open(String appName, String testName, RectangleSize viewportSize, MatchLevel matchLevel, FailureReports failureReports) Starts a test.
protected static void	setApiKey(String apiKey) Sets the API key of your applitools Eyes account.
void	setAppEnvironment(String hostOS, String hostApp) Sets the OS (e.g., Windows) and application (e.g., Chrome) that host the application under test.
void	setBatch(BatchInfo batch) Sets the batch in which context future tests will run or null if tests are to run standalone.
void	setBranchName(String branchName) Sets the branch in which the baseline for subsequent test runs resides.
protected void	setLastScreenshot(EyesScreenshot screenshot)
protected static void	setLogHandler(LogHandler logHandler) Sets a handler of log messages generated by this API.
void	setParentBranchName(String branchName) Sets the branch under which new branches are created.
void	setSaveFailedTests(boolean saveFailedTests) Set whether or not failed tests are saved by default.
void	setSaveNewTests(boolean saveNewTests) Set whether or not new tests are saved by default.
protected void	setViewportSize(RectangleSize size)
protected void	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MATCH_LEVEL

protected static final MatchLevel DEFAULT_MATCH_LEVEL

DEFAULT_CHARSET_NAME

public static final String DEFAULT_CHARSET_NAME

See Also:

Constant Field Values

agentConnector

protected com.applitools.eyes.AgentConnector agentConnector

runningSession

protected com.applitools.eyes.RunningSession runningSession

sessionStartInfo

protected com.applitools.eyes.SessionStartInfo sessionStartInfo

viewportSize

protected RectangleSize viewportSize

lastScreenshot

protected EyesScreenshot lastScreenshot

Constructor Detail

EyesBase

public EyesBase(URI serverUrl,
        boolean isDisabled)

Creates a new (possibly disabled) EyesBase instance that interacts with the Eyes Server at the specified url.

Parameters:

serverUrl - The Eyes server URL.

isDisabled - If true, all interactions with this API will be silently ignored.

Method Detail

getAgentId

public abstract String getAgentId()

setLogHandler

protected static void setLogHandler(LogHandler logHandler)

Sets a handler of log messages generated by this API.

Parameters:

logHandler - Handles log messages generated by this API.

setApiKey

protected static void setApiKey(String apiKey)

Sets the API key of your applitools Eyes account.

getApiKey

protected static String getApiKey()

Gets the currently set API key or null if no key is set.

getIsDisabled

public boolean getIsDisabled()

Returns:

Whether eyes is disabled.

getIsOpen

public boolean getIsOpen()

Returns:

Whether a session is open.

getFailureReports

public FailureReports getFailureReports()

Returns:

the failure reports setting.

getSaveNewTests

public boolean getSaveNewTests()

Returns:

True if new tests are saved by default.

setSaveNewTests

public void setSaveNewTests(boolean saveNewTests)

Set whether or not new tests are saved by default.

Parameters:

saveNewTests - True if new tests should be saved by default. False otherwise.

getSaveFailedTests

public boolean getSaveFailedTests()

Returns:

True if failed tests are saved by default.

setSaveFailedTests

public void setSaveFailedTests(boolean saveFailedTests)

Set whether or not failed tests are saved by default.

Parameters:

saveFailedTests - True if failed tests should be saved by default, false otherwise.

open

public void open(String appName,
        String testName,
        RectangleSize viewportSize,
        MatchLevel matchLevel,
        FailureReports failureReports)

Starts a test.

Parameters:

appName - The name of the application under test.

testName - The test name.

viewportSize - The client's viewport size (i.e., the visible part of the document's body) or null to allow any viewport size.

matchLevel - The test-wide match level to use when comparing actual application outputs with expected outputs (overrides stricter step-specific match levels).

failureReports - Specifies how detected failures are reported.

close

public TestResults close()

Ends the test.

Returns:

The test results.

Throws:

TestFailedException - Thrown if mismatches were found.

abortIfNotClosed

public void abortIfNotClosed()

If a test is running, aborts it. Otherwise, does nothing.

setBranchName

public void setBranchName(String branchName)

Sets the branch in which the baseline for subsequent test runs resides. If the branch does not already exist it will be created under the specified parent branch (see setParentBranchName(java.lang.String)). Changes to the baseline or model of a branch do not propagate to other branches.

Parameters:

branchName - Branch name or null to specify the default branch.

setParentBranchName

public void setParentBranchName(String branchName)

Sets the branch under which new branches are created.

Parameters:

branchName - Branch name or null to specify the default branch.

setAppEnvironment

public void setAppEnvironment(String hostOS,
                     String hostApp)

Sets the OS (e.g., Windows) and application (e.g., Chrome) that host the application under test.

Parameters:

hostOS - The name of the OS hosting the application under test or null to auto-detect.

hostApp - The name of the application hosting the application under test or null to auto-detect.

setBatch

public void setBatch(BatchInfo batch)

Sets the batch in which context future tests will run or null if tests are to run standalone.

getDefaultServerUrl

public static URI getDefaultServerUrl()

setLastScreenshot

protected void setLastScreenshot(EyesScreenshot screenshot)

getLastScreenshot

protected EyesScreenshot getLastScreenshot()

checkWindow

protected void checkWindow(BufferedImage image,
               String tag,
               boolean ignoreMismatch)

addUserInput

protected void addUserInput(com.applitools.eyes.Trigger trigger)

Adds a trigger to the current list of user inputs.

clearUserInputs

protected void clearUserInputs()

Clears the user inputs list.

getUserInputs

protected com.applitools.eyes.Trigger[] getUserInputs()

Returns all user inputs.

addMouseTrigger

protected void addMouseTrigger(MouseAction action,
                   Region control,
                   Location cursor)

Adds a mouse trigger.

Parameters:

action - Mouse action.

control - The control on which the trigger is activated (location is relative to the window).

cursor - The cursor's position relative to the control.

addTextTrigger

protected void addTextTrigger(Region control,
                  String text)

Adds a keyboard trigger.

Parameters:

control - The control's position relative to the window.

text - The trigger's text.

getViewportSize

protected RectangleSize getViewportSize()

setViewportSize

protected void setViewportSize(RectangleSize size)

getInferredEnvironment

protected abstract String getInferredEnvironment()

Returns:

The inferred environment string or null if none is available. The inferred string is in the format "source:info" where source is either "useragent" or "pos". Information associated with a "useragent" source is a valid browser user agent string. Information associated with a "pos" source is a string of the format "process-name;os-name" where "process-name" is the name of the main module of the executed process and "os-name" is the OS name.

getTitle

protected abstract String getTitle()

getEnvironment

protected com.applitools.eyes.AppEnvironment getEnvironment()

startSession

protected void startSession()