com.saucelabs.ci.BrowserFactory Maven / Gradle / Ivy
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package com.saucelabs.ci;
import com.saucelabs.saucerest.SauceREST;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.IOException;
import java.sql.Timestamp;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Handles invoking the Sauce REST API to retrieve the list of valid Browsers. The list of browser is cached for
* an hour.
*
* @author Ross Rowe
*/
public class BrowserFactory {
private static final Logger logger = Logger.getLogger(BrowserFactory.class.getName());
public static final int ONE_HOUR_IN_MILLIS = 1000 * 60 * 60;
private SauceREST sauceREST;
private Map seleniumLookup = new HashMap();
private Map appiumLookup = new HashMap();
private Map webDriverLookup = new HashMap();
protected Timestamp lastLookup = null;
private static final String IEHTA = "iehta";
private static final String CHROME = "chrome";
private static BrowserFactory instance;
public BrowserFactory() {
this(null);
}
public BrowserFactory(SauceREST sauceREST) {
if (sauceREST == null) {
this.sauceREST = new SauceREST(null, null);
} else {
this.sauceREST = sauceREST;
}
try {
initializeSeleniumBrowsers();
initializeWebDriverBrowsers();
initializeAppiumBrowsers();
} catch (IOException e) {
//TODO exception could mean we're behind firewall
logger.log(Level.WARNING, "Error retrieving browsers, attempting to continue", e);
} catch (JSONException e) {
logger.log(Level.WARNING, "Error retrieving browsers, attempting to continue", e);
}
}
public List getSeleniumBrowsers() throws IOException, JSONException {
List browsers;
if (shouldRetrieveBrowsers()) {
browsers = initializeSeleniumBrowsers();
} else {
browsers = new ArrayList(seleniumLookup.values());
}
Collections.sort(browsers);
return browsers;
}
public List getAppiumBrowsers() throws IOException, JSONException {
List browsers;
if (shouldRetrieveBrowsers()) {
browsers = initializeAppiumBrowsers();
} else {
browsers = new ArrayList(appiumLookup.values());
}
Collections.sort(browsers);
return browsers;
}
public List getWebDriverBrowsers() throws IOException, JSONException {
List browsers;
if (shouldRetrieveBrowsers()) {
browsers = initializeWebDriverBrowsers();
} else {
browsers = new ArrayList(webDriverLookup.values());
}
Collections.sort(browsers);
return browsers;
}
public boolean shouldRetrieveBrowsers() {
return lastLookup == null || CacheTimeUtil.pastAcceptableDuration(lastLookup, ONE_HOUR_IN_MILLIS);
}
private List initializeSeleniumBrowsers() throws IOException, JSONException {
List browsers = getSeleniumBrowsersFromSauceLabs();
seleniumLookup = new HashMap();
for (Browser browser : browsers) {
seleniumLookup.put(browser.getKey(), browser);
}
lastLookup = new Timestamp(new Date().getTime());
return browsers;
}
private List initializeAppiumBrowsers() throws IOException, JSONException {
List browsers = getAppiumBrowsersFromSauceLabs();
appiumLookup = new HashMap();
for (Browser browser : browsers) {
appiumLookup.put(browser.getKey(), browser);
}
lastLookup = new Timestamp(new Date().getTime());
return browsers;
}
private List initializeWebDriverBrowsers() throws IOException, JSONException {
List browsers = getWebDriverBrowsersFromSauceLabs();
webDriverLookup = new HashMap();
for (Browser browser : browsers) {
webDriverLookup.put(browser.getKey(), browser);
}
lastLookup = new Timestamp(new Date().getTime());
return browsers;
}
private List getSeleniumBrowsersFromSauceLabs() throws IOException, JSONException {
String response = sauceREST.getSupportedPlatforms("selenium-rc");
if (response.equals("")) {
response = "[]";
}
List browsers = getBrowserListFromJson(response);
List toRemove = new ArrayList();
for (Browser browser : browsers) {
if (browser.getBrowserName().equals(CHROME)) {
toRemove.add(browser);
}
}
for (Browser browser : toRemove) {
browsers.remove(browser);
}
return browsers;
}
private List getWebDriverBrowsersFromSauceLabs() throws IOException, JSONException {
String response = sauceREST.getSupportedPlatforms("webdriver");
if (response.equals("")) {
response = "[]";
}
return getBrowserListFromJson(response);
}
private List getAppiumBrowsersFromSauceLabs() throws IOException, JSONException {
String response = sauceREST.getSupportedPlatforms("appium");
if (response.equals("")) {
response = "[]";
}
return getBrowserListFromJson(response);
}
/**
* Parses the JSON response and constructs a List of {@link Browser} instances.
*
* @param browserListJson JSON response with all browsers
* @return List of browser objects
* @throws JSONException Invalid JSON
*/
public List getBrowserListFromJson(String browserListJson) throws JSONException {
List browsers = new ArrayList();
JSONArray browserArray = new JSONArray(browserListJson);
for (int i = 0; i < browserArray.length(); i++) {
JSONObject browserObject = browserArray.getJSONObject(i);
String seleniumName = browserObject.getString("api_name");
if (seleniumName.equals(IEHTA)) {
//exclude these browsers from the list, as they replicate iexplore and firefox
continue;
}
if (browserObject.has("device")) {
//appium browser
String longName = browserObject.getString("long_name");
String longVersion = browserObject.getString("long_version");
String osName = browserObject.getString("api_name"); //use api_name instead of os, as os was returning Linux/Mac OS
String shortVersion = browserObject.getString("short_version");
//set value used for device to be the long name (ie. if device value is 'Nexus7HD', then actually use 'Google Nexus 7 HD Emulator'
String device = longName;
String deviceType = null;
if (browserObject.has("device-type")) {
deviceType = browserObject.getString("device-type");
}
//iOS devices should include 'Simulator' in the device name (not currently included in the Sauce REST API response. The platform should also be set to iOS (as per instructions at https://docs.saucelabs.com/reference/platforms-configurator
if (device.equalsIgnoreCase("ipad") || device.equalsIgnoreCase("iphone")) {
device = device + " Simulator";
osName = "iOS";
//JENKINS-29047 set the browserName to 'Safari'
seleniumName = "Safari";
}
Browser browser = createBrowser(seleniumName, longName, longVersion, osName, device, deviceType, shortVersion, "portrait");
browsers.add(browser);
browser = createBrowser(seleniumName, longName, longVersion, osName, device, deviceType, shortVersion, "landscape");
browsers.add(browser);
} else {
//webdriver/selenium browser
String longName = browserObject.getString("long_name");
String longVersion = browserObject.getString("long_version");
String osName = browserObject.getString("os");
String shortVersion = browserObject.getString("short_version");
String browserKey = osName + seleniumName + shortVersion;
//replace any spaces with _s
browserKey = browserKey.replaceAll(" ", "_");
//replace any . with _
browserKey = browserKey.replaceAll("\\.", "_");
String label = OperatingSystemDescription.getOperatingSystemName(osName) + " " + longName + " " + shortVersion;
browsers.add(new Browser(browserKey, osName, seleniumName, longName, shortVersion, longVersion, label));
}
}
return browsers;
}
private Browser createBrowser(String seleniumName, String longName, String longVersion, String osName, String device, String deviceType, String shortVersion, String orientation) {
String browserKey = device + orientation + seleniumName + longVersion;
//replace any spaces with _s
browserKey = browserKey.replaceAll(" ", "_");
//replace any . with _
browserKey = browserKey.replaceAll("\\.", "_");
StringBuilder label = new StringBuilder();
label.append(longName).append(' ');
if (deviceType != null) {
label.append(deviceType).append(' ');
}
label.append(shortVersion);
label.append(" (").append(orientation).append(')');
//add browser for both landscape and portrait orientation
Browser browser = new Browser(browserKey, osName, seleniumName, longName, shortVersion, longVersion, label.toString());
browser.setDevice(device);
browser.setDeviceType(deviceType);
browser.setDeviceOrientation(orientation);
return browser;
}
/**
* Return the selenium rc browser which matches the key.
*
* @param key the key
* @return the selenium rc browser which matches the key.
*/
public Browser seleniumBrowserForKey(String key) {
return seleniumLookup.get(key);
}
public Browser seleniumBrowserForKey(String key, boolean useLatestVersion) {
Browser browser = webDriverBrowserForKey(key);
if (useLatestVersion) {
return getLatestSeleniumBrowserVersion(browser);
} else {
return browser;
}
}
private Browser getLatestSeleniumBrowserVersion(Browser originalBrowser) {
Browser candidateBrowser = originalBrowser;
for (Browser browser : seleniumLookup.values()) {
try {
if (browser.getBrowserName().equals(originalBrowser.getBrowserName())
&& browser.getOs().equals(originalBrowser.getOs())
&& Integer.parseInt(browser.getLongVersion()) > Integer.parseInt(candidateBrowser.getLongVersion())) {
candidateBrowser = browser;
}
} catch (NumberFormatException e) {
continue;
}
}
return candidateBrowser;
}
/**
* Return the web driver browser which matches the key.
*
* @param key the key
* @return the web driver browser which matches the key.
*/
public Browser webDriverBrowserForKey(String key) {
return webDriverLookup.get(key);
}
public Browser webDriverBrowserForKey(String key, boolean useLatestVersion) {
Browser browser = webDriverBrowserForKey(key);
if (useLatestVersion) {
return getLatestWebDriverBrowserVersion(browser);
} else {
return browser;
}
}
private Browser getLatestWebDriverBrowserVersion(Browser originalBrowser) {
Browser candidateBrowser = originalBrowser;
for (Browser browser : webDriverLookup.values()) {
try {
if (browser.getBrowserName().equals(originalBrowser.getBrowserName())
&& browser.getOs().equals(originalBrowser.getOs())
&& Integer.parseInt(browser.getLongVersion()) > Integer.parseInt(candidateBrowser.getLongVersion())) {
candidateBrowser = browser;
}
} catch (NumberFormatException e) {
continue;
}
}
return candidateBrowser;
}
/**
* Return the appium browser which matches the key.
*
* @param key the key
* @return the appium browser which matches the key.
*/
public Browser appiumBrowserForKey(String key) {
return appiumLookup.get(key);
}
/**
* Returns a singleton instance of SauceFactory. This is required because
* remote agents don't have the Bamboo component plugin available, so the Spring
* auto-wiring doesn't work.
*
* @return the Browser Factory
*/
public static BrowserFactory getInstance() {
return getInstance(null);
}
public static BrowserFactory getInstance(SauceREST sauceREST) {
if (instance == null) {
instance = new BrowserFactory(sauceREST);
}
return instance;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy