Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.shaft.api.BrowserStack Maven / Gradle / Ivy
SHAFT is a unified test automation engine. Powered by best-in-class frameworks, SHAFT provides a
wizard-like syntax to drive your automation efficiently, maximize your ROI, and minimize your learning curve.
Stop reinventing the wheel. Upgrade now!
package com.shaft.api;
import com.shaft.cli.FileActions;
import com.shaft.driver.SHAFT;
import com.shaft.tools.io.ReportManager;
import com.shaft.tools.io.internal.FailureReporter;
import com.shaft.tools.io.internal.ReportManagerHelper;
import org.openqa.selenium.MutableCapabilities;
import java.io.File;
import java.util.*;
@SuppressWarnings("SpellCheckingInspection")
public class BrowserStack {
private static final String hubUrl = "hub-cloud.browserstack.com";
private static final String serviceUri = "https://api-cloud.browserstack.com/";
private static final String appUploadServiceName = "app-automate/upload";
private BrowserStack() {
throw new IllegalStateException("Utility class");
}
/**
* Use this method to set up all the needed capabilities to be able to upload and test the latest version of your native application.
* You can refer to the getting started guide for BrowserStack App Automate to get all the needed information here BrowserStack: Getting Started
*
* @param username Your BrowserStack username
* @param password Your BrowserStack password
* @param deviceName Name of the Target device
* @param osVersion Version of the Target operating system
* @param relativePathToAppFile Relative path to your app file inside the project directory
* @param appName Name of your APK (excluding version number). This will be used as your CustomID so that you can keep uploading new versions of the same app and run your tests against them.
* @return appURL for the newly uploaded app file on BrowserStack to be used for future tests
*/
public static MutableCapabilities setupNativeAppExecution(String username, String password, String deviceName, String osVersion, String relativePathToAppFile, String appName) {
SHAFT.Properties.timeouts.set().apiSocketTimeout(600); //increasing socket timeout to 10 minutes to upload a new app file
ReportManager.logDiscrete("Setting up BrowserStack configuration for new native app version...");
String testData = "Username: " + username + ", Password: " + "•".repeat(password.length()) + ", Device Name: " + deviceName + ", OS Version: " + osVersion + ", Relative Path to App File: " + relativePathToAppFile + ", App Name: " + appName;
// upload app to browserstack api
List apkFile = new ArrayList<>();
apkFile.add("file");
String appPath = FileActions.getInstance().getAbsolutePath(relativePathToAppFile);
apkFile.add(new File(appPath));
ReportManager.logDiscrete("BrowserStack appPath: " + appPath);
List customID = new ArrayList<>();
customID.add("custom_id");
String userProvidedCustomID = SHAFT.Properties.browserStack.customID();
String custom_id = "".equals(userProvidedCustomID) ? "SHAFT_Engine_" + appName.replaceAll(" ", "_") : userProvidedCustomID;
customID.add(custom_id);
ReportManager.logDiscrete("BrowserStack custom_id: " + custom_id);
List> parameters = new ArrayList<>();
parameters.add(apkFile);
parameters.add(customID);
var appUrl = "";
try {
appUrl = Objects.requireNonNull(RestActions.getResponseJSONValue(new RestActions(serviceUri).buildNewRequest(appUploadServiceName, RestActions.RequestType.POST)
.setParameters(parameters, RestActions.ParametersType.FORM)
.setAuthentication(username, password, RequestBuilder.AuthenticationType.BASIC)
.performRequest(),
"app_url"));
ReportManager.logDiscrete("BrowserStack app_url: " + appUrl);
} catch (NullPointerException exception) {
failAction(testData, exception);
}
// set properties
MutableCapabilities browserStackCapabilities = setBrowserStackProperties(username, password, deviceName, osVersion, appUrl);
testData = testData + ", App URL: " + appUrl;
passAction(testData);
return browserStackCapabilities;
}
/**
* Use this method to set up all the needed capabilities to be able to test an already uploaded version of your native application.
* You can refer to the getting started guide for BrowserStack App Automate to get all the needed information here BrowserStack: Getting Started
*
* @param username Your BrowserStack username
* @param password Your BrowserStack password
* @param deviceName Name of the Target device
* @param osVersion Version of the Target operating system
* @param appUrl Url of the target app that was previously uploaded to be tested via BrowserStack
* @return native app capabilities
*/
public static MutableCapabilities setupNativeAppExecution(String username, String password, String deviceName, String osVersion, String appUrl) {
ReportManager.logDiscrete("Setting up BrowserStack configuration for existing native app version...");
String testData = "Username: " + username + ", Password: " + password + ", Device Name: " + deviceName + ", OS Version: " + osVersion + ", App URL: " + appUrl;
// set properties
MutableCapabilities browserStackCapabilities = setBrowserStackProperties(username, password, deviceName, osVersion, appUrl);
passAction(testData);
return browserStackCapabilities;
}
public static MutableCapabilities setupMobileWebExecution() {
ReportManager.logDiscrete("Setting up BrowserStack configuration for mobile web execution...");
String username = SHAFT.Properties.browserStack.username();
String password = SHAFT.Properties.browserStack.accessKey();
String os = SHAFT.Properties.platform.targetPlatform();
String osVersion = SHAFT.Properties.browserStack.osVersion();
String testData = "Username: " + username + ", Password: " + password + ", Operating System: " + os + ", Operating System Version: " + osVersion;
// set properties
SHAFT.Properties.platform.set().executionAddress(username + ":" + password + "@" + hubUrl);
MutableCapabilities browserStackCapabilities = new MutableCapabilities();
HashMap browserstackOptions = new HashMap<>();
browserstackOptions.put("osVersion", osVersion);
browserstackOptions.put("local", SHAFT.Properties.browserStack.local());
browserstackOptions.put("appiumVersion", SHAFT.Properties.browserStack.appiumVersion());
browserstackOptions.put("deviceName", SHAFT.Properties.browserStack.deviceName());
browserStackCapabilities.setCapability("bstack:options", browserstackOptions);
passAction(testData);
return browserStackCapabilities;
}
public static MutableCapabilities setupDesktopWebExecution() {
ReportManager.logDiscrete("Setting up BrowserStack configuration for desktop web execution...");
String username = SHAFT.Properties.browserStack.username();
String password = SHAFT.Properties.browserStack.accessKey();
String os = SHAFT.Properties.platform.targetPlatform();
String osVersion = SHAFT.Properties.browserStack.osVersion();
String testData = "Username: " + username + ", Password: " + password + ", Operating System: " + os + ", Operating System Version: " + osVersion;
// set properties
SHAFT.Properties.platform.set().executionAddress(username + ":" + password + "@" + hubUrl);
SHAFT.Properties.mobile.set().browserName(SHAFT.Properties.web.targetBrowserName());
// System.setProperty("browserName", SHAFT.Properties.web.targetBrowserName());
MutableCapabilities browserStackCapabilities = new MutableCapabilities();
var browserVersion = SHAFT.Properties.browserStack.browserVersion();
if (browserVersion != null && !"".equals(browserVersion.trim())) {
browserStackCapabilities.setCapability("browserVersion", SHAFT.Properties.browserStack.browserVersion());
}
HashMap browserstackOptions = new HashMap<>();
if (os.toLowerCase().contains("mac")) {
browserstackOptions.put("os", "OS X");
} else if (os.toLowerCase().contains("windows")) {
browserstackOptions.put("os", "Windows");
}
browserstackOptions.put("osVersion", osVersion);
browserstackOptions.put("local", SHAFT.Properties.browserStack.local());
browserstackOptions.put("seleniumVersion", SHAFT.Properties.browserStack.seleniumVersion());
String geoLocation = SHAFT.Properties.browserStack.geoLocation();
if (geoLocation != null && !"".equals(geoLocation)) {
browserstackOptions.put("geoLocation", SHAFT.Properties.browserStack.geoLocation());
}
browserStackCapabilities.setCapability("bstack:options", browserstackOptions);
passAction(testData);
return browserStackCapabilities;
}
private static MutableCapabilities setBrowserStackProperties(String username, String password, String deviceName, String osVersion, String appUrl) {
SHAFT.Properties.platform.set().executionAddress(username + ":" + password + "@" + hubUrl);
SHAFT.Properties.mobile.set().deviceName(deviceName);
SHAFT.Properties.mobile.set().platformVersion(osVersion);
SHAFT.Properties.mobile.set().app(appUrl);
MutableCapabilities browserStackCapabilities = new MutableCapabilities();
HashMap browserstackOptions = new HashMap<>();
browserstackOptions.put("appiumVersion", SHAFT.Properties.browserStack.appiumVersion());
browserstackOptions.put("acceptInsecureCerts", SHAFT.Properties.browserStack.acceptInsecureCerts());
browserstackOptions.put("debug", SHAFT.Properties.browserStack.debug());
browserstackOptions.put("networkLogs", SHAFT.Properties.browserStack.networkLogs());
// browserstackOptions.put("projectName", System.getProperty("project.artifactId"));
// browserstackOptions.put("buildName", !SHAFT.Properties.browserStack.appName().equals("") ? SHAFT.Properties.browserStack.appName() : System.getProperty("project.artifactId") + "_" + System.currentTimeMillis());
browserStackCapabilities.setCapability("bstack:options", browserstackOptions);
return browserStackCapabilities;
}
private static void passAction(String testData) {
reportActionResult(Thread.currentThread().getStackTrace()[2].getMethodName(), testData, true);
}
private static void failAction(String testData, Throwable... rootCauseException) {
String message = reportActionResult(Thread.currentThread().getStackTrace()[2].getMethodName(), testData, false, rootCauseException);
FailureReporter.fail(BrowserStack.class, message, rootCauseException[0]);
}
private static String reportActionResult(String actionName, String testData, Boolean passFailStatus, Throwable... rootCauseException) {
actionName = actionName.substring(0, 1).toUpperCase() + actionName.substring(1);
String message;
if (Boolean.TRUE.equals(passFailStatus)) {
message = "BrowserStack API Action \"" + actionName + "\" successfully performed.";
} else {
message = "BrowserStack API Action \"" + actionName + "\" failed.";
}
if (testData != null && !testData.isEmpty()) {
message = message + " With the following test data \"" + testData + "\".";
}
if (rootCauseException != null && rootCauseException.length >= 1) {
List> attachments = new ArrayList<>();
List actualValueAttachment = Arrays.asList("BrowserStack Action Exception - " + actionName,
"Stacktrace", ReportManagerHelper.formatStackTraceToLogEntry(rootCauseException[0]));
attachments.add(actualValueAttachment);
ReportManagerHelper.log(message, attachments);
} else {
ReportManager.logDiscrete(message);
}
return message;
}
}
