com.applitools.eyes.EyesBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eyes-sdk-core-java3 Show documentation
Show all versions of eyes-sdk-core-java3 Show documentation
Applitools Eyes SDK base for Java
The newest version!
package com.applitools.eyes;
import com.applitools.ICheckSettings;
import com.applitools.connectivity.ServerConnector;
import com.applitools.eyes.capture.AppOutputProvider;
import com.applitools.eyes.capture.ScreenshotProvider;
import com.applitools.eyes.config.Configuration;
import com.applitools.eyes.debug.DebugScreenshotsProvider;
import com.applitools.eyes.debug.FileDebugScreenshotsProvider;
import com.applitools.eyes.debug.NullDebugScreenshotProvider;
import com.applitools.eyes.events.ValidationInfo;
import com.applitools.eyes.exceptions.DiffsFoundException;
import com.applitools.eyes.exceptions.NewTestException;
import com.applitools.eyes.exceptions.TestFailedException;
import com.applitools.eyes.fluent.CheckSettings;
import com.applitools.eyes.fluent.ICheckSettingsInternal;
import com.applitools.eyes.locators.BaseOcrRegion;
import com.applitools.eyes.locators.TextRegion;
import com.applitools.eyes.locators.TextRegionSettings;
import com.applitools.eyes.logging.Stage;
import com.applitools.eyes.logging.TraceLevel;
import com.applitools.eyes.logging.Type;
import com.applitools.eyes.positioning.InvalidPositionProvider;
import com.applitools.eyes.positioning.PositionProvider;
import com.applitools.eyes.scaling.FixedScaleProvider;
import com.applitools.eyes.scaling.NullScaleProvider;
import com.applitools.eyes.selenium.ClassicRunner0;
import com.applitools.eyes.triggers.MouseAction;
import com.applitools.eyes.triggers.MouseTrigger;
import com.applitools.eyes.triggers.TextTrigger;
import com.applitools.eyes.visualgrid.model.DeviceSize;
import com.applitools.eyes.visualgrid.model.RenderingInfo;
import com.applitools.utils.*;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.lang3.tuple.Pair;
import java.awt.image.BufferedImage;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.*;
/**
* Applitools Eyes Base for Java API .
*/
public abstract class EyesBase implements IEyesBase {
protected static final int USE_DEFAULT_TIMEOUT = -1;
private boolean shouldMatchWindowRunOnceOnTimeout;
private MatchWindowTask matchWindowTask;
private String testId = UUID.randomUUID().toString();
protected String agentRunId = null;
protected ClassicRunner0 runner;
protected ServerConnector serverConnector;
protected RunningSession runningSession;
protected SessionStartInfo sessionStartInfo;
protected TestResultContainer testResultContainer;
protected EyesScreenshot lastScreenshot;
protected PropertyHandler scaleProviderHandler;
protected PropertyHandler cutProviderHandler;
protected PropertyHandler positionProviderHandler;
private boolean isScaleProviderSetByUser = false;
// Will be checked before any argument validation. If true,
// all method will immediately return without performing any action.
private boolean isDisabled;
protected Logger logger;
protected boolean isOpen;
private final Queue userInputs;
private final List properties = new ArrayList<>();
private boolean isViewportSizeSet;
private int validationId;
protected DebugScreenshotsProvider debugScreenshotsProvider;
public EyesBase() {
this(null);
}
public EyesBase(ClassicRunner0 runner) {
this.runner = runner != null ? runner : new ClassicRunner0();
logger = new Logger();
initProviders();
//setServerConnector(new ServerConnector());
runningSession = null;
userInputs = new ArrayDeque<>();
lastScreenshot = null;
debugScreenshotsProvider = new NullDebugScreenshotProvider();
}
/**
* @param hardReset If false, init providers only if they're not initialized.
*/
private void initProviders(boolean hardReset) {
if (scaleProviderHandler == null || hardReset) {
scaleProviderHandler = new SimplePropertyHandler<>();
scaleProviderHandler.set(new NullScaleProvider(logger));
}
if (cutProviderHandler == null || hardReset) {
cutProviderHandler = new SimplePropertyHandler<>();
cutProviderHandler.set(new NullCutProvider());
}
if (positionProviderHandler == null || hardReset) {
positionProviderHandler = new SimplePropertyHandler<>();
positionProviderHandler.set(new InvalidPositionProvider());
}
}
/**
* Same as {@link #initProviders(boolean)}, setting {@code hardReset} to {@code false}.
*/
private void initProviders() {
initProviders(false);
}
public String getTestId() {
return testId;
}
public void setTestId(String testId) {
this.testId = testId;
}
/**
* Sets the server connector to use. MUST BE SET IN ORDER FOR THE EYES OBJECT TO WORK!
* @param serverConnector The server connector object to use.
*/
public void setServerConnector(ServerConnector serverConnector) {
ArgumentGuard.notNull(serverConnector, "serverConnector");
this.serverConnector = serverConnector;
serverConnector.setLogger(logger);
runner.setServerConnector(serverConnector);
}
public ServerConnector getServerConnector() {
if (serverConnector != null && serverConnector.getAgentId() == null) {
serverConnector.setAgentId(getFullAgentId());
runner.setServerConnector(serverConnector);
logger.setAgentId(serverConnector.getAgentId());
}
return serverConnector;
}
/**
* Sets the API key of your applitools Eyes account.
* @param apiKey The api key to set.
*/
public Configuration setApiKey(String apiKey) {
ArgumentGuard.notNull(apiKey, "apiKey");
getConfigurationInstance().setApiKey(apiKey);
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
getServerConnector().setApiKey(apiKey);
runner.setApiKey(apiKey);
return this.getConfigurationInstance();
}
/**
* @return The currently set API key or {@code null} if no key is set.
*/
public String getApiKey() {
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
return getServerConnector().getApiKey();
}
/**
* Sets the current server URL used by the rest client.
* @param serverUrl The URI of the rest server, or {@code null} to use
* the default server.
*/
public Configuration setServerUrl(String serverUrl) {
setServerUrl(URI.create(serverUrl));
return this.getConfigurationInstance();
}
/**
* Sets the current server URL used by the rest client.
* @param serverUrl The URI of the rest server, or {@code null} to use
* the default server.
*/
public Configuration setServerUrl(URI serverUrl) {
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
if (serverUrl == null) {
getServerConnector().setServerUrl(getDefaultServerUrl());
} else {
getServerConnector().setServerUrl(serverUrl);
}
runner.setServerUrl(getServerConnector().getServerUrl().toString());
return this.getConfigurationInstance();
}
/**
* @return The URI of the eyes server.
*/
public URI getServerUrl() {
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
return getServerConnector().getServerUrl();
}
/**
* Sets the proxy settings to be used by the rest client.
* @param abstractProxySettings The proxy settings to be used by the rest client.
* If {@code null} then no proxy is set.
*/
public Configuration setProxy(AbstractProxySettings abstractProxySettings) {
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
getServerConnector().setProxy(abstractProxySettings);
runner.setProxy(abstractProxySettings);
return getConfigurationInstance();
}
/**
* @return The current proxy settings used by the server connector,
* or {@code null} if no proxy is set.
*/
public AbstractProxySettings getProxy() {
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
return getServerConnector().getProxy();
}
/**
* @param isDisabled If true, all interactions with this API will be
* silently ignored.
*/
public void setIsDisabled(boolean isDisabled) {
this.isDisabled = isDisabled;
}
/**
* @return Whether eyes is disabled.
*/
public Boolean getIsDisabled() {
return isDisabled;
}
/**
* Clears the user inputs list.
*/
protected void clearUserInputs() {
if (isDisabled) {
return;
}
userInputs.clear();
}
/**
* @return User inputs collected between {@code checkWindowBase} invocations.
*/
protected Trigger[] getUserInputs() {
if (isDisabled) {
return null;
}
Trigger[] result = new Trigger[userInputs.size()];
return userInputs.toArray(result);
}
/**
* @return The base agent id of the SDK.
*/
protected abstract String getBaseAgentId();
/**
* @return The full agent id composed of both the base agent id and the
* user given agent id.
*/
public String getFullAgentId() {
String agentId = getConfigurationInstance().getAgentId();
if (agentId == null) {
return getBaseAgentId();
}
return String.format("%s [%s]", agentId, getBaseAgentId());
}
/**
* @return Whether a session is open.
*/
public boolean getIsOpen() {
return isOpen;
}
public static URI getDefaultServerUrl() {
try {
return new URI("https://eyesapi.applitools.com");
} catch (URISyntaxException ex) {
throw new EyesException(ex.getMessage(), ex);
}
}
/**
* Sets a handler of log messages generated by this API.
* @param logHandler Handles log messages generated by this API.
*/
public void setLogHandler(LogHandler logHandler) {
logger.setLogHandler(logHandler);
serverConnector.setLogger(logger);
runner.setLogHandler(logHandler);
}
/**
* @return The currently set log handler.
*/
public LogHandler getLogHandler() {
return logger.getLogHandler();
}
public Logger getLogger() {
return logger;
}
/**
* Manually set the the sizes to cut from an image before it's validated.
* @param cutProvider the provider doing the cut.
*/
public void setImageCut(CutProvider cutProvider) {
if (cutProvider != null) {
cutProvider.setLogger(logger);
cutProviderHandler = new ReadOnlyPropertyHandler<>(
cutProvider);
} else {
cutProviderHandler = new SimplePropertyHandler<>();
cutProviderHandler.set(new NullCutProvider());
}
}
public boolean getIsCutProviderExplicitlySet() {
return cutProviderHandler != null && !(cutProviderHandler.get() instanceof NullCutProvider);
}
public boolean getIsScaleProviderExplicitlySet() {
return isScaleProviderSetByUser;
}
/**
* Manually set the scale ratio for the images being validated.
* @param scaleRatio The scale ratio to use, or {@code null} to reset
* back to automatic scaling.
*/
public void setScaleRatio(Double scaleRatio) {
if (scaleRatio != null) {
isScaleProviderSetByUser = true;
FixedScaleProvider scaleProvider = new FixedScaleProvider(logger, scaleRatio);
scaleProviderHandler = new ReadOnlyPropertyHandler(
scaleProvider);
} else {
isScaleProviderSetByUser = false;
scaleProviderHandler = new SimplePropertyHandler<>();
scaleProviderHandler.set(new NullScaleProvider(logger));
}
}
/**
* @return The ratio used to scale the images being validated.
*/
public double getScaleRatio() {
return scaleProviderHandler.get().getScaleRatio();
}
/**
* Adds a property to be sent to the server.
* @param name The property name.
* @param value The property value.
*/
public void addProperty(String name, String value) {
PropertyData pd = new PropertyData(name, value);
properties.add(pd);
}
protected void addProperty(PropertyData property) {
properties.add(property);
}
/**
* Clears the list of custom properties.
*/
public void clearProperties() {
properties.clear();
}
/**
* @param saveDebugScreenshots If true, will save all screenshots to local directory.
*/
public void setSaveDebugScreenshots(boolean saveDebugScreenshots) {
DebugScreenshotsProvider prev = debugScreenshotsProvider;
if (saveDebugScreenshots) {
debugScreenshotsProvider = new FileDebugScreenshotsProvider(logger);
} else {
debugScreenshotsProvider = new NullDebugScreenshotProvider();
}
debugScreenshotsProvider.setPrefix(prev.getPrefix());
debugScreenshotsProvider.setPath(prev.getPath());
}
/**
* @return True if screenshots saving enabled.
*/
public boolean getSaveDebugScreenshots() {
return !(debugScreenshotsProvider instanceof NullDebugScreenshotProvider);
}
/**
* @param pathToSave Path where you want to save the debug screenshots.
*/
public void setDebugScreenshotsPath(String pathToSave) {
debugScreenshotsProvider.setPath(pathToSave);
}
/**
* @return The path where you want to save the debug screenshots.
*/
public String getDebugScreenshotsPath() {
return debugScreenshotsProvider.getPath();
}
/**
* @param prefix The prefix for the screenshots' names.
*/
public void setDebugScreenshotsPrefix(String prefix) {
debugScreenshotsProvider.setPrefix(prefix);
}
/**
* @return The prefix for the screenshots' names.
*/
public String getDebugScreenshotsPrefix() {
return debugScreenshotsProvider.getPrefix();
}
public DebugScreenshotsProvider getDebugScreenshotsProvider() {
return debugScreenshotsProvider;
}
public SessionStopInfo prepareStopSession(boolean isAborted) {
if (runningSession == null || !isOpen) {
logger.log(getTestId(), Stage.CLOSE, "Tried to close a non opened test");
return null;
}
isOpen = false;
lastScreenshot = null;
clearUserInputs();
initProviders(true);
final boolean isNewSession = runningSession.getIsNew();
boolean save = (isNewSession && getConfigurationInstance().getSaveNewTests())
|| (!isNewSession && getConfigurationInstance().getSaveFailedTests());
return new SessionStopInfo(runningSession, isAborted, save);
}
/**
* See {@link #close(boolean)}.
* {@code throwEx} defaults to {@code true}.
* @return The test results.
*/
public TestResults close() {
return close(true);
}
public TestResults abort() {
return abortIfNotClosed();
}
/**
* Ends the test.
* @param throwEx If true, an exception will be thrown for failed/new tests.
* @return The test results.
* @throws TestFailedException if a mismatch was found and throwEx is true.
* @throws NewTestException if this is a new test was found and throwEx
* is true.
*/
public TestResults close(boolean throwEx) {
TestResults results = stopSession(false);
logSessionResultsAndThrowException(throwEx, results);
return results;
}
public TestResults abortIfNotClosed() {
logger.log(getTestId(), Stage.CLOSE, Type.CALLED);
return stopSession(true);
}
protected TestResults stopSession(boolean isAborted) {
if (isDisabled) {
TestResults testResults = new TestResults();
testResults.setStatus(TestResultsStatus.Disabled);
return testResults;
}
SessionStopInfo sessionStopInfo = prepareStopSession(isAborted);
if (sessionStopInfo == null) {
TestResults testResults = new TestResults();
testResults.setStatus(TestResultsStatus.NotOpened);
return testResults;
}
TestResults testResults = runner.close(getTestId(), sessionStopInfo);
runningSession = null;
if (testResults == null) {
throw new EyesException("Failed stopping session");
}
return testResults;
}
public void logSessionResultsAndThrowException(boolean throwEx, TestResults results) {
TestResultsStatus status = results.getStatus();
String sessionResultsUrl = results.getUrl();
String scenarioIdOrName = results.getName();
String appIdOrName = results.getAppName();
if (status == null) {
throw new EyesException("Status is null in the test results");
}
logger.log(getTestId(), Stage.CLOSE, Type.TEST_RESULTS, Pair.of("status", status), Pair.of("url", sessionResultsUrl));
switch (status) {
case Failed:
if (throwEx) {
throw new TestFailedException(results, scenarioIdOrName, appIdOrName);
}
break;
case Passed:
break;
case NotOpened:
if (throwEx) {
throw new EyesException("Called close before calling open");
}
break;
case Unresolved:
if (results.isNew()) {
if (throwEx) {
throw new NewTestException(results, scenarioIdOrName, appIdOrName);
}
} else {
if (throwEx) {
throw new DiffsFoundException(results, scenarioIdOrName, appIdOrName);
}
}
break;
}
}
protected void openLogger() {
logger.getLogHandler().open();
}
/**
* @return The currently set position provider.
*/
public PositionProvider getPositionProvider() {
return positionProviderHandler.get();
}
/**
* @param positionProvider The position provider to be used.
*/
public void setPositionProvider(PositionProvider positionProvider) {
if (positionProvider != null) {
positionProviderHandler = new ReadOnlyPropertyHandler<>(
positionProvider);
} else {
positionProviderHandler = new SimplePropertyHandler<>();
positionProviderHandler.set(new InvalidPositionProvider());
}
}
public List extractText(BaseOcrRegion... ocrRegions) {
ArgumentGuard.notNull(ocrRegions, "ocrRegions");
ArgumentGuard.notContainsNull(ocrRegions, "ocrRegions");
List result = new ArrayList<>();
for (BaseOcrRegion ocrRegion : ocrRegions) {
logger.log(getTestId(), Stage.OCR, Pair.of("ocrRegion", ocrRegion));
getAppOutputForOcr(ocrRegion);
if (ocrRegion.getAppOutput() == null) {
return Collections.emptyList();
}
debugScreenshotsProvider.save(ocrRegion.getAppOutput().getScreenshot().getImage(), "ocr_regions");
SyncTaskListener listener = new SyncTaskListener<>(logger, "getTextRegions");
serverConnector.uploadImage(listener, ocrRegion.getAppOutput().getScreenshotBytes());
String screenshotUrl = listener.get();
if (screenshotUrl == null) {
throw new EyesException("Failed posting image");
}
logger.log(getTestId(), Stage.OCR, Pair.of("screenshotUrl", screenshotUrl));
ocrRegion.getAppOutput().setScreenshotUrl(screenshotUrl);
SyncTaskListener> postListener = new SyncTaskListener<>(logger, "getText");
serverConnector.postOcrRegions(postListener, ocrRegion);
List serverResult = postListener.get();
if (serverResult == null) {
throw new EyesException("Failed posting ocr region");
}
logger.log(testId, Stage.OCR, Pair.of("result", result));
if (serverResult.isEmpty()) {
result.add(null);
} else {
result.add(serverResult.get(0));
}
}
return result;
}
protected abstract void getAppOutputForOcr(BaseOcrRegion ocrRegion);
public Map> extractTextRegions(TextRegionSettings textRegionSettings) {
ArgumentGuard.notNull(textRegionSettings, "textRegionSettings");
ScreenshotProvider screenshotProvider = getScreenshotProvider();
BufferedImage viewPortScreenshot;
if (textRegionSettings.getImage() != null) {
viewPortScreenshot = textRegionSettings.getImage();
} else if (screenshotProvider != null) {
viewPortScreenshot = screenshotProvider.getViewPortScreenshot(Stage.OCR);
} else {
throw new IllegalArgumentException("No image for the text region settings");
}
logger.log(getTestId(), Stage.OCR,
Pair.of("textRegionSettings", textRegionSettings),
Pair.of("scaledImageSize", new RectangleSize(viewPortScreenshot.getWidth(), viewPortScreenshot.getHeight())));
debugScreenshotsProvider.save(viewPortScreenshot, "text_regions_final");
byte[] image = ImageUtils.encodeAsPng(viewPortScreenshot);
SyncTaskListener listener = new SyncTaskListener<>(logger, "getTextRegions");
serverConnector.uploadImage(listener, image);
String viewportScreenshotUrl = listener.get();
if (viewportScreenshotUrl == null) {
throw new EyesException("Failed posting viewport image");
}
logger.log(getTestId(), Stage.OCR, Pair.of("screenshotUrl", viewportScreenshotUrl));
String domUrl = null;
if (shouldCaptureDom(null)) {
domUrl = tryCaptureAndPostDom();
}
textRegionSettings.setAppOutput(new AppOutput(getTitle(), null, domUrl, viewportScreenshotUrl, null));
SyncTaskListener>> postListener = new SyncTaskListener<>(logger, "getTextRegions");
serverConnector.postTextRegions(postListener, textRegionSettings);
Map> result = postListener.get();
if (result == null) {
throw new EyesException("Failed posting text regions");
}
logger.log(testId, Stage.OCR, Pair.of("result", result));
return result;
}
protected abstract ScreenshotProvider getScreenshotProvider();
/**
* Creates the match model
* @param userInputs The user inputs related to the current appOutput.
* @param appOutput The application output to be matched.
* @param tag Optional tag to be associated with the match (can be {@code null}).
* @param replaceLast Whether to instruct the server to replace the screenshot of the last step.
* @param imageMatchSettings The settings to use.
* @return The match model.
*/
protected MatchWindowData prepareForMatch(ICheckSettingsInternal checkSettingsInternal,
List userInputs,
AppOutput appOutput,
String tag, boolean replaceLast,
ImageMatchSettings imageMatchSettings, String renderId, String source) {
String agentSetupStr = "";
Object agentSetup = logger.createMessageFromLog(Collections.singleton(getTestId()), Stage.CHECK, null,
Pair.of("configuration", getConfiguration()),
Pair.of("checkSettings", checkSettingsInternal));
ObjectMapper jsonMapper = new ObjectMapper();
try {
agentSetupStr = jsonMapper.writeValueAsString(agentSetup);
} catch (JsonProcessingException e) {
GeneralUtils.logExceptionStackTrace(logger, Stage.CHECK, e, getTestId());
}
MatchWindowData.Options options = new MatchWindowData.Options(tag, userInputs.toArray(new Trigger[0]),
replaceLast, false, false, false, false,
imageMatchSettings, source, checkSettingsInternal.getVariationGroupId(), renderId);
return new MatchWindowData(runningSession, userInputs.toArray(new Trigger[0]), appOutput, tag,
false, options, agentSetupStr, renderId);
}
public MatchResult performMatch(MatchWindowData data) {
MatchResult result = runner.check(getTestId(), data);
if (result == null) {
throw new EyesException("Failed performing match with the server");
}
return result;
}
/**
* See {@link #checkWindowBase(Region, String, int, String)}.
* {@code retryTimeout} defaults to {@code USE_DEFAULT_TIMEOUT}.
* @param region The region to check or null for the entire window.
* @param tag An optional tag to be associated with the snapshot.
* @param source A string representing the source of the checkpoint.
* @return The result of matching the output with the expected output.
*/
protected MatchResult checkWindowBase(Region region, String tag, String source) {
return checkWindowBase(region, tag, USE_DEFAULT_TIMEOUT, source);
}
/**
* Takes a snapshot of the application under test and matches it with the
* expected output.
* @param region The region to check or null for the entire window.
* @param tag An optional tag to be associated with the snapshot.
* @param retryTimeout The amount of time to retry matching in milliseconds or a negative
* value to use the default retry timeout.
* @param source A string representing the source of the checkpoint.
* @return The result of matching the output with the expected output.
* @throws TestFailedException Thrown if a mismatch is detected and immediate failure reports are enabled.
*/
protected MatchResult checkWindowBase(Region region, String tag, int retryTimeout, String source) {
return this.checkWindowBase(region, new CheckSettings(retryTimeout).withName(tag), source);
}
protected MatchResult checkWindowBase(Region region, String tag, ICheckSettings checkSettings) {
return checkWindowBase(region, checkSettings.withName(tag), getAppName());
}
/**
* Takes a snapshot of the application under test and matches it with the
* expected output.
* @param region The region to check or null for the entire window.
* @param checkSettings The settings to use.
* @param source A string representing the source of the checkpoint.
* @return The result of matching the output with the expected output.
* @throws TestFailedException Thrown if a mismatch is detected and immediate failure reports are enabled.
*/
protected MatchResult checkWindowBase(Region region, ICheckSettings checkSettings, String source) {
ICheckSettingsInternal checkSettingsInternal = (ICheckSettingsInternal) checkSettings;
return checkWindowBase(region, checkSettingsInternal, source);
}
protected MatchResult checkWindowBase(Region region, ICheckSettingsInternal checkSettingsInternal, String source) {
MatchResult result;
if (getIsDisabled()) {
result = new MatchResult();
result.setAsExpected(true);
return result;
}
String tag = checkSettingsInternal.getName();
if (tag == null) {
tag = "";
}
ArgumentGuard.isValidState(getIsOpen(), "Eyes not open");
if (checkSettingsInternal.getOcrRegion() != null) {
AppOutput appOutput = getAppOutputWithScreenshot(region, checkSettingsInternal);
checkSettingsInternal.getOcrRegion().setAppOutput(appOutput);
result = new MatchResult();
result.setAsExpected(true);
return result;
}
result = matchWindowTask.matchWindow(getUserInputs(), region, tag, shouldMatchWindowRunOnceOnTimeout,
checkSettingsInternal, source);
validateResult(result);
return result;
}
protected abstract String tryCaptureDom();
protected String tryCaptureAndPostDom() {
String domUrl = null;
try {
String domJson = tryCaptureDom();
domUrl = tryPostDomCapture(domJson);
logger.log(getTestId(), Stage.CHECK, Type.DOM_SCRIPT, Pair.of("domUrl", domUrl));
} catch (Exception ex) {
GeneralUtils.logExceptionStackTrace(logger, Stage.CHECK, Type.DOM_SCRIPT, ex, getTestId());
}
return domUrl;
}
protected boolean shouldCaptureDom(Boolean sendDomFromCheckSettings) {
boolean sendDomFromConfig = getConfigurationInstance().isSendDom() == null || getConfigurationInstance().isSendDom();
return (sendDomFromCheckSettings != null && sendDomFromCheckSettings) || (sendDomFromCheckSettings == null && sendDomFromConfig);
}
protected ValidationInfo fireValidationWillStartEvent(String tag) {
ValidationInfo validationInfo = new ValidationInfo();
validationInfo.setValidationId("" + (++validationId));
validationInfo.setTag(tag);
return validationInfo;
}
private String tryPostDomCapture(String domJson) {
if (domJson != null) {
byte[] resultStream = GeneralUtils.getGzipByteArrayOutputStream(domJson);
SyncTaskListener listener = new SyncTaskListener<>(logger, String.format("tryUploadData %s", runningSession));
serverConnector.uploadData(listener, resultStream, "application/octet-stream", "application/json");
return listener.get();
}
return null;
}
protected void validateResult(MatchResult result) {
if (result.getAsExpected()) {
return;
}
shouldMatchWindowRunOnceOnTimeout = true;
if (getConfigurationInstance().getFailureReports() == FailureReports.IMMEDIATE) {
throw new TestFailedException(String.format(
"Mismatch found in '%s' of '%s'",
sessionStartInfo.getScenarioIdOrName(),
sessionStartInfo.getAppIdOrName()));
}
}
public void setIsDisabled(Boolean isDisabled) {
this.isDisabled = isDisabled;
}
public SessionStartInfo prepareForOpen() {
openLogger();
if (isDisabled) {
return null;
}
validateApiKey();
validateSessionOpen();
this.isViewportSizeSet = false;
RectangleSize viewportSize = getViewportSizeForOpen();
if (viewportSize == null) {
viewportSize = RectangleSize.EMPTY;
}
getConfigurationInstance().setViewportSize(viewportSize);
if (getServerConnector() == null) {
throw new EyesException("server connector not set.");
}
ensureViewportSize();
Configuration configGetter = getConfigurationInstance();
BatchInfo testBatch = configGetter.getBatch();
if (testBatch == null) {
getConfigurationInstance().setBatch(new BatchInfo(null));
}
String agentSessionId = UUID.randomUUID().toString();
Object appEnv = getAppEnvironment();
sessionStartInfo = new SessionStartInfo(getTestId(), getFullAgentId(), configGetter.getSessionType(), getAppName(),
null, getTestName(), configGetter.getBatch(), getBaselineEnvName(), configGetter.getEnvironmentName(),
appEnv, configGetter.getDefaultMatchSettings(), configGetter.getBranchName(),
configGetter.getParentBranchName(), configGetter.getBaselineBranchName(), configGetter.getSaveDiffs(),
properties, agentSessionId, agentRunId, configGetter.getAbortIdleTestTimeout());
logger.log(TraceLevel.Info, getTestId(), Stage.OPEN, Pair.of("configuration", getConfiguration()));
return sessionStartInfo;
}
protected void openBase() throws EyesException {
SessionStartInfo startInfo = prepareForOpen();
if (startInfo == null) {
return;
}
RunningSession runningSession = runner.open(getTestId(), startInfo);
if (runningSession == null) {
throw new EyesException("Failed starting session with the server");
}
openCompleted(runningSession);
}
public void openCompleted(RunningSession result) {
runningSession = result;
shouldMatchWindowRunOnceOnTimeout = runningSession.getIsNew();
matchWindowTask = new MatchWindowTask(
logger,
getServerConnector(),
runningSession,
getConfigurationInstance().getMatchTimeout(),
EyesBase.this,
// A callback which will call getAppOutput
new AppOutputProvider() {
@Override
public AppOutput getAppOutput(Region region, ICheckSettingsInternal checkSettingsInternal) {
return getAppOutputWithScreenshot(region, checkSettingsInternal);
}
}
);
validationId = -1;
isOpen = true;
}
protected RectangleSize getViewportSizeForOpen() {
return getConfigurationInstance().getViewportSize();
}
private void validateApiKey() {
if (getApiKey() == null) {
throw new EyesException("API key is missing! Please set it using setApiKey()");
}
}
private void validateSessionOpen() {
if (isOpen || runningSession != null) {
abortIfNotClosed();
throw new EyesException("A test is already running");
}
}
/**
* @return The viewport size of the AUT.
*/
protected abstract RectangleSize getViewportSize();
/**
* @param size The required viewport size.
*/
protected abstract Configuration setViewportSize(RectangleSize size);
protected void setEffectiveViewportSize(RectangleSize size) {
}
/**
* Define the viewport size as {@code size} without doing any actual action on the
* @param explicitViewportSize The size of the viewport. {@code null} disables the explicit size.
*/
public void setExplicitViewportSize(RectangleSize explicitViewportSize) {
if (explicitViewportSize == null) {
return;
}
getConfigurationInstance().setViewportSize(explicitViewportSize);
this.isViewportSizeSet = true;
}
/**
* @return The inferred environment string
* or {@code 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.
*/
protected abstract String getInferredEnvironment();
/**
* @return An updated screenshot.
*/
protected abstract EyesScreenshot getScreenshot(Region targetRegion, ICheckSettingsInternal checkSettingsInternal);
/**
* @return The current title of of the AUT.
*/
protected abstract String getTitle();
/**
* Adds a trigger to the current list of user inputs.
* @param trigger The trigger to add to the user inputs list.
*/
protected void addUserInput(Trigger trigger) {
if (isDisabled) {
return;
}
ArgumentGuard.notNull(trigger, "trigger");
userInputs.add(trigger);
}
/**
* Adds a text trigger.
* @param control The control's position relative to the window.
* @param text The trigger's text.
*/
protected void addTextTriggerBase(Region control, String text) {
if (getIsDisabled()) {
return;
}
ArgumentGuard.notNull(control, "control");
ArgumentGuard.notNull(text, "text");
// We don't want to change the objects we received.
control = new Region(control);
if (lastScreenshot == null) {
return;
}
control = lastScreenshot.getIntersectedRegion(control, CoordinatesType.SCREENSHOT_AS_IS);
if (control.isSizeEmpty()) {
return;
}
Trigger trigger = new TextTrigger(control, text);
addUserInput(trigger);
}
/**
* Adds a mouse trigger.
* @param action Mouse action.
* @param control The control on which the trigger is activated
* (location is relative to the window).
* @param cursor The cursor's position relative to the control.
*/
protected void addMouseTriggerBase(MouseAction action, Region control, Location cursor) {
if (getIsDisabled()) {
return;
}
ArgumentGuard.notNull(action, "action");
ArgumentGuard.notNull(control, "control");
ArgumentGuard.notNull(cursor, "cursor");
// Triggers are actually performed on the previous window.
if (lastScreenshot == null) {
return;
}
// Getting the location of the cursor in the screenshot
Location cursorInScreenshot = new Location(cursor);
// First we need to getting the cursor's coordinates relative to the
// context (and not to the control).
cursorInScreenshot = cursorInScreenshot.offset(control.getLocation());
try {
cursorInScreenshot = lastScreenshot.getLocationInScreenshot(
cursorInScreenshot, CoordinatesType.CONTEXT_RELATIVE);
} catch (OutOfBoundsException e) {
return;
}
Region controlScreenshotIntersect =
lastScreenshot.getIntersectedRegion(control, CoordinatesType.SCREENSHOT_AS_IS);
// If the region is NOT empty, we'll give the coordinates relative to
// the control.
if (!controlScreenshotIntersect.isSizeEmpty()) {
Location l = controlScreenshotIntersect.getLocation();
cursorInScreenshot = cursorInScreenshot.offset(-l.getX(), -l.getY());
}
Trigger trigger = new MouseTrigger(action, controlScreenshotIntersect, cursorInScreenshot);
addUserInput(trigger);
}
/**
* Application environment is the environment (e.g., the host OS) which
* runs the application under test.
* @return The current application environment.
*/
protected Object getAppEnvironment() {
AppEnvironment appEnv = new AppEnvironment();
// If hostOS isn't set, we'll try and extract and OS ourselves.
if (getConfigurationInstance().getHostOS() != null) {
appEnv.setOs(getConfigurationInstance().getHostOS());
}
if (getConfigurationInstance().getHostApp() != null) {
appEnv.setHostingApp(getConfigurationInstance().getHostApp());
}
if (getConfigurationInstance().getHostingAppInfo() != null) {
appEnv.setHostingAppInfo(getConfigurationInstance().getHostingAppInfo());
}
if (getConfigurationInstance().getOsInfo() != null) {
appEnv.setOsInfo(getConfigurationInstance().getOsInfo());
}
if (getConfigurationInstance().getDeviceInfo() != null) {
appEnv.setDeviceInfo(getConfigurationInstance().getDeviceInfo());
}
appEnv.setInferred(getInferredEnvironment());
appEnv.setDisplaySize(getConfigurationInstance().getViewportSize());
return appEnv;
}
protected String getTestName() {
return getConfigurationInstance().getTestName();
}
protected String getAppName() {
return getConfigurationInstance().getAppName();
}
protected String getBaselineEnvName() {
return getConfigurationInstance().getBaselineEnvName();
}
public Object getAgentSetup() {
return null;
}
private void ensureViewportSize() {
if (isViewportSizeSet) {
return;
}
RectangleSize viewportSize = getConfigurationInstance().getViewportSize();
if (viewportSize == null || viewportSize.isEmpty()) {
try {
viewportSize = getViewportSize();
setEffectiveViewportSize(viewportSize);
getConfigurationInstance().setViewportSize(viewportSize);
} catch (NullPointerException e) {
isViewportSizeSet = false;
}
} else {
try {
setViewportSize(viewportSize);
isViewportSizeSet = true;
} catch (Exception ex) {
isViewportSizeSet = false;
throw ex;
}
}
}
/**
* @param region The region of the screenshot which will be set in the application output.
* @return The updated app output and screenshot.
*/
private AppOutput getAppOutputWithScreenshot(Region region, ICheckSettingsInternal checkSettingsInternal) {
// Getting the screenshot (abstract function implemented by each SDK).
EyesScreenshot screenshot = getScreenshot(region, checkSettingsInternal);
String domUrl = null;
if (screenshot != null) {
domUrl = screenshot.domUrl;
}
String title = getTitle();
Location location = region == null ? null : region.getLocation();
if (screenshot != null && screenshot.getOriginalLocation() != null) {
location = screenshot.getOriginalLocation();
}
return new AppOutput(title, screenshot, domUrl, null, location);
}
public Boolean isSendDom() {
return getConfigurationInstance().isSendDom();
}
public Configuration setSendDom(boolean isSendDom) {
this.getConfigurationInstance().setSendDom(isSendDom);
return getConfigurationInstance();
}
public RenderingInfo getRenderingInfo() {
return getServerConnector().getRenderInfo();
}
public Map getDevicesSizes(String path) {
return getServerConnector().getDevicesSizes(path);
}
public Map getUserAgents() {
return getServerConnector().getUserAgents();
}
public Map getMobileDeviceInfo() {
return getServerConnector().getMobileDevicesInfo();
}
/**
* Sets the batch in which context future tests will run or {@code null}
* if tests are to run standalone.
* @param batch The batch info to set.
*/
public Configuration setBatch(BatchInfo batch) {
if (isDisabled) {
return getConfigurationInstance();
}
this.getConfigurationInstance().setBatch(batch);
return getConfigurationInstance();
}
/**
* @return Underlying instance of the configuration for modification
*/
protected abstract Configuration getConfigurationInstance();
/**
* @return Cloned instance of the configuration
*/
public Configuration getConfiguration() {
return new Configuration(getConfigurationInstance());
}
public void closeAsync() {
close(false);
}
public void abortAsync() {
abort();
}
public boolean isCompleted() {
return testResultContainer != null;
}
}