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.
/*
* Copyright 2019 Coveros, Inc.
*
* This file is part of Selenified.
*
* Selenified is licensed under the Apache License, Version
* 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.coveros.selenified.utilities;
import com.coveros.selenified.Browser;
import com.coveros.selenified.exceptions.InvalidBrowserOptionsException;
import com.coveros.selenified.exceptions.InvalidHTTPException;
import com.coveros.selenified.exceptions.InvalidHubException;
import com.coveros.selenified.exceptions.InvalidProxyException;
import org.testng.ITestContext;
import org.testng.log4testng.Logger;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
/**
* Reads in properties files provided by the user in order to execute tests. These
* files can be passed in via commandline, or set in a selenified.properties file.
* This file should reside in src/test/resources. If the property exists in the
* system properties, that is returned, overridding anything in the
* selenified.properties file.
*
* @author Max Saperstone
* @version 3.2.0
* @lastupdate 5/13/2019
*/
public class Property {
private static final String PROXY_ISNT_SET = "Proxy isn't set";
private static final double WAIT = 5; //in seconds
private static final long POLL = 50; //in milliseconds
private Property() {
}
private static final Logger log = Logger.getLogger(Property.class);
private static final String SELENIFIED = "src/test/resources/selenified.properties";
private static final String DEFAULT_WAIT = "defaultWait";
private static final String DEFAULT_POLL = "defaultPoll";
private static final String GENERATE_PDF = "generatePDF";
private static final String PACKAGE_RESULTS = "packageResults";
private static final String HUB = "hub";
private static final String PROXY = "proxy";
public static final String APP_URL = "appURL";
public static final String BROWSER = "browser";
public static final String HEADLESS = "headless";
public static final String OPTIONS = "options";
/**
* Retrieves the specified program property. if it exists from the system properties, that is returned, overridding
* all other values. Otherwise, if it exists from the properties file, that is returned, otherwise, null is returned
*
* @param property - what property value to return
* @return String: the property value, null if unset
*/
private static String getProgramProperty(String property) {
if (System.getProperty(property) != null) {
return System.getProperty(property).trim();
}
Properties prop = new Properties();
try (InputStream input = new FileInputStream(SELENIFIED)) {
prop.load(input);
} catch (IOException e) {
log.info(e);
}
String fullProperty = prop.getProperty(property);
if (fullProperty != null) {
fullProperty = fullProperty.trim();
}
return fullProperty;
}
/**
* Determines if we are supposed to generate a pdf of the results or not
*
* @return boolean: generate a pdf or not
*/
public static boolean generatePDF() {
String generatePDF = getProgramProperty(GENERATE_PDF);
if (generatePDF == null) {
return false;
}
if ("".equals(generatePDF)) {
return true;
}
return "true".equalsIgnoreCase(generatePDF);
}
/**
* Determines if we are supposed to zip up the results or not
*
* @return boolean: zip up the results or not
*/
public static boolean packageResults() {
String packageResults = getProgramProperty(PACKAGE_RESULTS);
if (packageResults == null) {
return false;
}
if ("".equals(packageResults)) {
return true;
}
return "true".equalsIgnoreCase(packageResults);
}
/**
* Determines if a hub property is set. This could be to sauce, grid, or any other cloud tool.
* This should be provided with the protocol and address, but leaving out the /wd/hub
*
* @return boolean: is a hub location set
*/
public static boolean isHubSet() {
String hub = getProgramProperty(HUB);
return hub != null && !"".equals(hub);
}
/**
* Retrieves the hub property if it is set. This could be to sauce, grid, or any other cloud tool.
* This should be provided with the protocol and address, but leaving out the /wd/hub
*
* @return String: the set hub address, null if none are set
*/
public static String getHub() throws InvalidHubException {
String hub = getProgramProperty(HUB);
if (hub == null || "".equals(hub)) {
throw new InvalidHubException("Hub isn't set");
}
return hub;
}
/**
* Determines if a proxy property is set. This could be to something local, or in the cloud.
* Provide the protocol, address, and port
*
* @return boolean: is a proxy set
*/
public static boolean isProxySet() {
String proxy = getProgramProperty(PROXY);
return proxy != null && !"".equals(proxy);
}
/**
* Retrieves the proxy property if it is set. This could be to something local, or in the cloud.
* Provide the protocol, address, and port
*
* @return String: the set proxy address, null if none are set
*/
public static String getProxy() throws InvalidProxyException {
String proxy = getProgramProperty(PROXY);
if (proxy == null) {
throw new InvalidProxyException(PROXY_ISNT_SET);
}
String[] proxyParts = proxy.split(":");
if (proxyParts.length != 2) {
throw new InvalidProxyException("Proxy '" + proxy + "' isn't valid. Must contain address and port, without protocol");
}
try {
Integer.parseInt(proxyParts[1]);
} catch (NumberFormatException e) {
throw new InvalidProxyException("Proxy '" + proxy + "' isn't valid. Must contain address and port, without protocol. Invalid port provided. " + e);
}
return proxy;
}
public static String getProxyHost() throws InvalidProxyException {
return getProxy().split(":")[0];
}
public static int getProxyPort() throws InvalidProxyException {
return Integer.parseInt(getProxy().split(":")[1]);
}
/**
* Obtains the application under test, as a URL. If the site was provided as
* a system property, that value will override whatever was set in the
* particular test suite. If no site was set, null will be returned, which
* will causes the tests to error out
*
* @param clazz - the test suite class, used for making threadsafe storage of
* application, allowing suites to have independent applications
* under test, run at the same time
* @param context - the TestNG context associated with the test suite, used for
* storing app url information
* @return String: the URL of the application under test
*/
public static String getAppURL(String clazz, ITestContext context) throws InvalidHTTPException {
String appURL = checkAppURL(null, (String) context.getAttribute(clazz + APP_URL), "The provided app via test case setup '");
Properties prop = new Properties();
try (InputStream input = new FileInputStream(SELENIFIED)) {
prop.load(input);
} catch (IOException e) {
log.info(e);
}
appURL = checkAppURL(appURL, prop.getProperty(APP_URL), "The provided app via Properties file '");
appURL = checkAppURL(appURL, System.getProperty(APP_URL), "The provided app via System Properties '");
if (appURL != null) {
return appURL;
}
throw new InvalidHTTPException("There was not a valid app provided to test. Please properly set the 'appURL'");
}
/**
* A helper method to getAppURL, which checks the provided URL, and if it is valid, overrides the initially
* provided one.
*
* @param originalAppURL - the original and currently set app url
* @param newAppURL - the new app url to check
* @param s - the location being checked (for reporting)
* @return String: the most valid URL, new if it is valid, original if not
*/
private static String checkAppURL(String originalAppURL, String newAppURL, String s) {
if (newAppURL != null && !"".equals(newAppURL)) {
if (!newAppURL.toLowerCase().startsWith("http") && !newAppURL.toLowerCase().startsWith("file")) {
newAppURL = "http://" + newAppURL;
}
try {
new URL(newAppURL);
return newAppURL;
} catch (MalformedURLException e) {
log.error(s + newAppURL + "' is not a valud URL.");
}
}
return originalAppURL;
}
/**
* Retrieves the browser property if it is set. This can be a single browser name, or browser details. If it is
* not set, HTMLUnit will be returned as the default browser to use
*
* @return String: the set browser
*/
public static String getBrowser() {
String browser = getProgramProperty(BROWSER);
if (browser == null || "".equals(browser)) {
browser = Browser.BrowserName.HTMLUNIT.toString();
}
return browser;
}
/**
* Determines if the headless parameter was set, to have the browser run in headless mode. This only
* can be used for Chrome and Firefox.
*
* @return boolean: is headless set or not
*/
public static boolean runHeadless() {
String headless = getProgramProperty(HEADLESS);
if (headless == null) {
return false;
}
if ("".equals(headless)) {
return true;
}
return "true".equalsIgnoreCase(headless);
}
/**
* Determines if options are set.
*
* @return boolean: are options set or not
*/
public static boolean areOptionsSet() {
String options = getProgramProperty(OPTIONS);
return options != null && !"".equals(options);
}
/**
* Retrieves the set options
*
* @return String: the options, null if none are set
*/
public static String getOptions() throws InvalidBrowserOptionsException {
String options = getProgramProperty(OPTIONS);
if (options == null || "".equals(options)) {
throw new InvalidBrowserOptionsException("Browser options aren't set");
}
return options;
}
public static long getDefaultPoll() {
String defaultPoll = getProgramProperty(DEFAULT_POLL);
if (defaultPoll == null || "".equals(defaultPoll)) {
return POLL;
}
try {
return Long.valueOf(defaultPoll);
} catch (Exception e) {
log.error("Provided default poll needs to be a long. " + e);
return POLL;
}
}
public static double getDefaultWait() {
String defaultWait = getProgramProperty(DEFAULT_WAIT);
if (defaultWait == null || "".equals(defaultWait)) {
return WAIT;
}
try {
return Double.valueOf(defaultWait);
} catch (Exception e) {
log.error("Provided default wait needs to be a double. " + e);
return WAIT;
}
}
}
