com.seleniumtests.core.TestTasks Maven / Gradle / Ivy
/**
* Orignal work: Copyright 2015 www.seleniumtests.com
* Modified work: Copyright 2016 www.infotel.com
* Copyright 2017-2019 B.Hecquet
*
* 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.seleniumtests.core;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.log4j.Logger;
import com.neotys.selenium.proxies.NLWebDriver;
import com.seleniumtests.connectors.selenium.SeleniumGridConnector;
import com.seleniumtests.connectors.selenium.SeleniumRobotVariableServerConnector;
import com.seleniumtests.core.runner.SeleniumRobotTestPlan;
import com.seleniumtests.customexception.ConfigurationException;
import com.seleniumtests.customexception.ScenarioException;
import com.seleniumtests.driver.DriverMode;
import com.seleniumtests.driver.WebUIDriver;
import com.seleniumtests.driver.screenshots.ScreenShot;
import com.seleniumtests.driver.screenshots.ScreenshotUtil;
import com.seleniumtests.driver.screenshots.ScreenshotUtil.Target;
import com.seleniumtests.reporter.logger.TestLogging;
import com.seleniumtests.reporter.logger.TestStep;
import com.seleniumtests.util.logging.SeleniumRobotLogger;
import com.seleniumtests.util.osutility.OSUtilityFactory;
import com.seleniumtests.util.osutility.ProcessInfo;
import net.lightbody.bmp.BrowserMobProxy;
/**
* Class for storing tasks that can be used in test and / or in webpages
* @author s047432
*
*/
public class TestTasks {
private static final Logger logger = SeleniumRobotLogger.getLogger(SeleniumRobotTestPlan.class);
private TestTasks() {
// nothing to do
}
public static void killProcess(String processName) {
if (SeleniumTestsContextManager.getThreadContext().getRunMode() == DriverMode.LOCAL) {
OSUtilityFactory.getInstance().killProcessByName(processName, true);
} else if (SeleniumTestsContextManager.getThreadContext().getRunMode() == DriverMode.GRID) {
SeleniumGridConnector gridConnector = SeleniumTestsContextManager.getThreadContext().getSeleniumGridConnector();
if (gridConnector != null) {
gridConnector.killProcess(processName);
} else {
throw new ScenarioException("No grid connector active");
}
} else {
logger.error("killing a process is only supported in local and grid mode");
}
}
/**
* returns the list of processes, on the node, whose name without extension is the requested one
* e.g: getProcessList("WINWORD")
* Case will be ignored
* @param processName
* @return
*/
public static List getProcessList(String processName) {
if (SeleniumTestsContextManager.getThreadContext().getRunMode() == DriverMode.LOCAL) {
return OSUtilityFactory.getInstance().getRunningProcesses(processName).stream()
.map(ProcessInfo::getPid)
.map(Integer::valueOf)
.collect(Collectors.toList());
} else if (SeleniumTestsContextManager.getThreadContext().getRunMode() == DriverMode.GRID) {
SeleniumGridConnector gridConnector = SeleniumTestsContextManager.getThreadContext().getSeleniumGridConnector();
if (gridConnector != null) {
return gridConnector.getProcessList(processName);
} else {
throw new ScenarioException("No grid connector active");
}
} else {
throw new ScenarioException("killing a process is only supported in local and grid mode");
}
}
/**
* Method for creating or updating a variable on the seleniumRobot server ONLY. This will raise a ScenarioException if variables are get from
* env.ini file
* Moreover, created custom variable is specific to tuple (application, version, test environment)
* @param key
* @param newValue
*/
public static void createOrUpdateParam(String key, String newValue) {
createOrUpdateParam(key, newValue, true);
}
/**
* Method for creating or updating a variable on the seleniumRobot server ONLY. This will raise a ScenarioException if variables are get from
* env.ini file
* Moreover, created custom variable is specific to tuple (application, version, test environment)
* @param key name of the param
* @param newValue value of the parameter (or new value if we update it)
* @param specificToVersion if true, this param will be stored on server with a reference to the application version. This will have no effect if changing a
* current variable.
*/
public static void createOrUpdateParam(String key, String newValue, boolean specificToVersion) {
createOrUpdateParam(key, newValue, specificToVersion, TestVariable.TIME_TO_LIVE_INFINITE, false);
}
/**
* Method for creating or updating a variable on the seleniumRobot server ONLY. This will raise a ScenarioException if variables are get from
* env.ini file
* Moreover, created custom variable is specific to tuple (application, version, test environment)
* @param key name of the param
* @param newValue value of the parameter (or new value if we update it)
* @param specificToVersion if true, this param will be stored on server with a reference to the application version. This will have no effect if changing a
* current variable.
* @param timeToLive if > 0, this variable will be destroyed after some days (defined by variable). A positive value is mandatory if reservable is set to true
* because multiple variable can be created
* @param reservable if true, this variable will be set as reservable in variable server. This means it can be used by only one test at the same time
* True value also means that multiple variables of the same name can be created and a timeToLive > 0 MUST be provided so that server database is regularly purged
*/
public static void createOrUpdateParam(String key, String newValue, boolean specificToVersion, int timeToLive, boolean reservable) {
SeleniumRobotVariableServerConnector variableServer = SeleniumTestsContextManager.getThreadContext().getVariableServer();
if (variableServer == null) {
throw new ScenarioException("Cannot create or update variable if seleniumRobot server is not connected");
}
if (reservable && timeToLive <= 0) {
throw new ScenarioException("When creating a variable as reservable, a positive timeToLive value MUST be provided");
}
// check if we update an existing variable
TestVariable variable = SeleniumTestsContextManager.getThreadContext().getConfiguration().get(key);
if (variable == null || reservable) {
variable = new TestVariable(key, newValue);
} else {
variable.setValue(newValue);
}
variable.setReservable(reservable);
variable.setTimeToLive(timeToLive);
TestVariable newVariable = variableServer.upsertVariable(variable, specificToVersion);
SeleniumTestsContextManager.getThreadContext().getConfiguration().put(newVariable.getName(), newVariable);
}
/**
* Get parameter from configuration
*
* @param key
*
* @return String
*/
public static String param(String key) {
TestVariable value = SeleniumTestsContextManager.getThreadContext().getConfiguration().get(key);
if (value == null) {
TestLogging.warning(String.format("Variable %s is not defined", key));
return "";
}
return value.getValue();
}
/**
* Add step to test and add snapshot to it
* If a previous step exists, store it
* @param stepName name of the step
* If name is null, only previous step is stored, no new step is created
* @param passwordsToMask array of strings that must be replaced by '*****' in reports
*/
public static void addStep(String stepName, String ... passwordsToMask ) {
if (!SeleniumTestsContextManager.getThreadContext().isManualTestSteps()) {
throw new ConfigurationException("manual steps can only be used when automatic steps are disabled ('manualTestSteps' option set to true)");
}
NLWebDriver neoloadDriver = WebUIDriver.getNeoloadDriver();
// log the previous step if it exists and create the new one
TestStep previousStep = TestLogging.getCurrentRootTestStep();
if (previousStep != null) {
previousStep.updateDuration();
TestLogging.logTestStep(previousStep);
if (neoloadDriver != null) {
neoloadDriver.stopTransaction();
}
}
// stepName is null when test is terminating. We don't create a new step
if (stepName != null) {
TestStep step = new TestStep(stepName, TestLogging.getCurrentTestResult(), Arrays.asList(passwordsToMask));
TestLogging.setCurrentRootTestStep(step);
capturePageSnapshot();
// start a new page when using BrowserMobProxy (network capture)
BrowserMobProxy mobProxy = WebUIDriver.getBrowserMobProxy();
if (mobProxy != null) {
mobProxy.newPage(stepName);
}
// start a new transaction when using Neoload
if (neoloadDriver != null) {
neoloadDriver.startTransaction(stepName);
}
}
}
public static void capturePageSnapshot() {
if (WebUIDriver.getWebDriver(false) != null) {
TestLogging.logScreenshot(new ScreenshotUtil().capture(Target.PAGE, ScreenShot.class));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy