com.testfabrik.webmate.javasdk.WebmateAPISession Maven / Gradle / Ivy
The newest version!
package com.testfabrik.webmate.javasdk;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableList;
import com.testfabrik.webmate.javasdk.artifacts.ArtifactClient;
import com.testfabrik.webmate.javasdk.blobs.BlobClient;
import com.testfabrik.webmate.javasdk.browsersession.BrowserSessionClient;
import com.testfabrik.webmate.javasdk.browsersession.BrowserSessionId;
import com.testfabrik.webmate.javasdk.devices.DeviceClient;
import com.testfabrik.webmate.javasdk.images.ImageClient;
import com.testfabrik.webmate.javasdk.jobs.JobEngine;
import com.testfabrik.webmate.javasdk.mailtest.MailTestClient;
import com.testfabrik.webmate.javasdk.packagemgmt.PackageMgmtClient;
import com.testfabrik.webmate.javasdk.selenium.SeleniumServiceClient;
import com.testfabrik.webmate.javasdk.selenium.WebmateSeleniumSession;
import com.testfabrik.webmate.javasdk.testmgmt.ApplicationModelId;
import com.testfabrik.webmate.javasdk.testmgmt.TestMgmtClient;
import com.testfabrik.webmate.javasdk.testmgmt.TestSessionId;
import org.apache.http.impl.client.HttpClientBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
/**
* WebmateSession
*/
public class WebmateAPISession {
private static final Logger LOG = LoggerFactory.getLogger(WebmateAPISession.class);
public final WebmateAuthInfo authInfo;
public final WebmateEnvironment environment;
/**
* Facade to webmate's JobEngine subsystem.
*/
public final JobEngine jobEngine;
/**
* Facade to webmate's BrowserSession subsystem.
*/
public final BrowserSessionClient browserSession;
/**
* Facade to webmate's Device subsystem.
*/
public final DeviceClient device;
/**
* Facade to webmate's TestMgmt subsystem.
*/
public final TestMgmtClient testMgmt;
/**
* Facade to webmate's MailTest subsystem.
*/
public final MailTestClient mailTest;
/**
* Facade to webmate's Artifact subsystem.
*/
public final ArtifactClient artifact;
/**
* Facade to webmate's Image subsystem.
*/
public final ImageClient image;
/**
* Facade to webmate's Selenium subsystem.
*/
public final SeleniumServiceClient selenium;
/**
* Facade to webmate's Blob subsystem.
*/
public final BlobClient blob;
/**
* Facade to webmate's Package Management (e.g. App) subsystem.
*/
public final PackageMgmtClient packages;
//////////////////////////////
/// Mutable Session state
///////////////////////////////
private List associatedTags = new ArrayList<>();
private List associatedModels = new ArrayList<>();
private List associatedExpeditions = new ArrayList<>();
private List associatedTestSessions = new ArrayList<>();
private Optional projectId = Optional.absent();
public List getAssociatedTags() {
return ImmutableList.copyOf(associatedTags);
}
public List getAssociatedModels() {
return ImmutableList.copyOf(associatedModels);
}
public List getAssociatedExpeditions() {
return ImmutableList.copyOf(associatedExpeditions);
}
/**
* Check if there is only one associated Expedition / BrowserSession and return it.
* If there are none, log a warning and return null.
* If there are more than one, log a warning and return the newest one.
*/
public BrowserSessionId getOnlyAssociatedExpedition() {
switch (associatedExpeditions.size()) {
case 0:
LOG.warn("Expected exactly one active Expedition (e.g. BrowserSession), but there are none; returning null");
return null;
case 1:
return associatedExpeditions.get(0);
default:
LOG.warn("Expected exactly one active Expedition (e.g. BrowserSession), but there are more; returning the newest one");
return associatedExpeditions.get(associatedExpeditions.size() - 1);
}
}
public List getAssociatedTestSessions() {
return ImmutableList.copyOf(associatedTestSessions);
}
public Optional getProjectId() {
return projectId;
}
/**
* Constructor to create a new WebmateAPISession.
* The session is used to access all functionality of webmate.
*
* @param authInfo an instance of WebmateAuthInfo which contains the users credentials
* @param environment an instance of WebmateEnvironment which contains the url of webmate
*/
public WebmateAPISession(WebmateAuthInfo authInfo, WebmateEnvironment environment, ProjectId projectId) {
this.authInfo = authInfo;
this.environment = environment;
this.projectId = Optional.of(projectId);
this.jobEngine = new JobEngine(this);
this.browserSession = new BrowserSessionClient(this);
this.device = new DeviceClient(this);
this.testMgmt = new TestMgmtClient(this);
this.artifact = new ArtifactClient(this);
this.image = new ImageClient(this);
this.mailTest = new MailTestClient(this, artifact);
this.selenium = new SeleniumServiceClient(this);
this.packages = new PackageMgmtClient(this);
this.blob = new BlobClient(this);
}
/**
* Constructor to create a new WebmateAPISession.
* The session is used to access all functionality of webmate.
*
* @param authInfo an instance of WebmateAuthInfo which contains the users credentials
* @param environment an instance of WebmateEnvironment which contains the url of webmate
*/
public WebmateAPISession(WebmateAuthInfo authInfo, WebmateEnvironment environment) {
this.authInfo = authInfo;
this.environment = environment;
this.jobEngine = new JobEngine(this);
this.browserSession = new BrowserSessionClient(this);
this.device = new DeviceClient(this);
this.testMgmt = new TestMgmtClient(this);
this.artifact = new ArtifactClient(this);
this.image = new ImageClient(this);
this.mailTest = new MailTestClient(this, artifact);
this.selenium = new SeleniumServiceClient(this);
this.packages = new PackageMgmtClient(this);
this.blob = new BlobClient(this);
}
/**
* Constructor to create a new WebmateAPISession.
* The session is used to access all functionality of webmate.
*
* @param authInfo an instance of WebmateAuthInfo which contains the users credentials
* @param environment an instance of WebmateEnvironment which contains the url of webmate
* @param httpClientBuilder client builder used to create HTTP connections
*/
public WebmateAPISession(WebmateAuthInfo authInfo, WebmateEnvironment environment, HttpClientBuilder httpClientBuilder) {
this.authInfo = authInfo;
this.environment = environment;
this.jobEngine = new JobEngine(this, httpClientBuilder);
this.browserSession = new BrowserSessionClient(this, httpClientBuilder);
this.device = new DeviceClient(this, httpClientBuilder);
this.testMgmt = new TestMgmtClient(this, httpClientBuilder);
this.artifact = new ArtifactClient(this, httpClientBuilder);
this.image = new ImageClient(this, httpClientBuilder);
this.mailTest = new MailTestClient(this, artifact, httpClientBuilder);
this.selenium = new SeleniumServiceClient(this, httpClientBuilder);
this.packages = new PackageMgmtClient(this, httpClientBuilder);
this.blob = new BlobClient(this, httpClientBuilder);
}
/**
* Constructor to create a new WebmateAPISession.
* The session is used to access all functionality of webmate.
*
* @param authInfo an instance of WebmateAuthInfo which contains the users credentials
* @param environment an instance of WebmateEnvironment which contains the url of webmate
* @param httpClientBuilder client builder used to create HTTP connections
*/
public WebmateAPISession(WebmateAuthInfo authInfo, WebmateEnvironment environment, ProjectId projectId,
HttpClientBuilder httpClientBuilder) {
this.authInfo = authInfo;
this.environment = environment;
this.projectId = Optional.of(projectId);
this.jobEngine = new JobEngine(this, httpClientBuilder);
this.browserSession = new BrowserSessionClient(this, httpClientBuilder);
this.device = new DeviceClient(this, httpClientBuilder);
this.testMgmt = new TestMgmtClient(this, httpClientBuilder);
this.artifact = new ArtifactClient(this, httpClientBuilder);
this.image = new ImageClient(this, httpClientBuilder);
this.mailTest = new MailTestClient(this, artifact, httpClientBuilder);
this.selenium = new SeleniumServiceClient(this, httpClientBuilder);
this.packages = new PackageMgmtClient(this, httpClientBuilder);
this.blob = new BlobClient(this, httpClientBuilder);
}
/**
* Associate BrowserSession with API session.
*/
public void addBrowserSession(BrowserSessionId id) {
this.associatedExpeditions.add(id);
}
/**
* Associate Selenium session with API session.
*/
public WebmateSeleniumSession addSeleniumSession(String opaqueSeleniumSessionIdString) {
// currently the browsersession id is equivalent to the selenium session id (which is scary but comes
// quite handy)
BrowserSessionId browserSessionId = new BrowserSessionId(UUID.fromString(opaqueSeleniumSessionIdString));
addBrowserSession(browserSessionId);
return new WebmateSeleniumSession(this, browserSessionId);
}
/**
* Associate Tag with API session.
*/
public void addTag(Tag tag) {
this.associatedTags.add(tag);
}
/**
* Associate Application Model with API session.
*/
public void addModel(ApplicationModelId modelId) {
this.associatedModels.add(modelId);
}
/**
* Associate this API session with a webmate TestSession. All TestRuns started in this API session will be
* associated with the associated TestSessions. It is possible to associate the API session with
* multiple TestSessions.
*/
public void addToTestSession(TestSessionId session) {
this.associatedTestSessions.add(session);
}
/**
* Start an action for the given expedition with the given name.
*/
public void startAction(BrowserSessionId expeditionId, String actionName) {
this.browserSession.startAction(expeditionId, actionName);
}
/**
* Start an action with the given name.
* The expedition of the action is supplied using {@link WebmateAPISession#getOnlyAssociatedExpedition}.
* If it returns null, log a warning and do nothing.
*/
public void startAction(String actionName) {
this.browserSession.startAction(actionName);
}
/**
* Finish the newest action of the given expedition.
* If there is no active action, log a warning and do nothing.
*/
public void finishAction(BrowserSessionId expeditionId) {
this.browserSession.finishAction(expeditionId);
}
/**
* Finish the newest action of the newest expedition.
* The expedition of the action is supplied using {@link WebmateAPISession#getOnlyAssociatedExpedition}.
* If it returns null, or if there is no active action, log a warning and do nothing.
*/
public void finishAction() {
this.browserSession.finishAction();
}
/**
* Fail the newest action of the given expedition with the given message.
* If there is no active action, log a warning and do nothing.
*/
public void finishActionAsFailure(BrowserSessionId expeditionId, String message) {
this.browserSession.finishActionAsFailure(expeditionId, message);
}
/**
* Fail the newest action of the newest expedition with the given message.
* The expedition of the action is supplied using {@link WebmateAPISession#getOnlyAssociatedExpedition}.
* If it returns null, or if there is no active action, log a warning and do nothing.
*/
public void finishActionAsFailure(String message) {
this.browserSession.finishActionAsFailure(message);
}
}