eu.tsystems.mms.tic.testframework.utils.WebDriverKeepAliveSequence Maven / Gradle / Ivy
Show all versions of driver-ui Show documentation
/*
* Testerra
*
* (C) 2020, Eric Kubenka, T-Systems Multimedia Solutions GmbH, Deutsche Telekom AG
*
* Deutsche Telekom AG and all other contributors /
* copyright owners license this file to you 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 eu.tsystems.mms.tic.testframework.utils;
import eu.tsystems.mms.tic.testframework.logging.Loggable;
import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManagerUtils;
import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverSessionsManager;
import org.openqa.selenium.WebDriver;
import java.util.concurrent.CopyOnWriteArrayList;
/**
* WebDriverKeepAliveSequence
*
* Date: 19.09.2019
* Time: 12:50
*
* @author Eric Kubenka
*/
public class WebDriverKeepAliveSequence extends Timer.Sequence implements Loggable {
private static CopyOnWriteArrayList currentKeepAliveSessions = new CopyOnWriteArrayList<>();
static final int GLOBAL_KEEP_ALIVE_TIMEOUT_IN_SECONDS = 3600;
/**
* State list.
*/
public enum KeepAliveState {
REMOVED_BY_USER,
REMOVED_BY_TIMEOUT,
REMOVED_BY_DRIVER_SHUTDOWN
}
private boolean remove = false;
private boolean forceRemove = false;
private final WebDriver driver;
/**
* Initialize an empty {@link WebDriverKeepAliveSequence} - This will not trigger any action.
* Just a helper to avoid static remove-methods.
*/
WebDriverKeepAliveSequence() {
driver = null;
}
/**
* Initialize a WebDriverKeepAliveSequence that can be used by {@link Timer#executeSequence(Timer.Sequence)}
*
* @param driver {@link WebDriver}
*/
WebDriverKeepAliveSequence(final WebDriver driver) {
// store driver
this.driver = driver;
// add ShutDownHandler that kills this Sequence.
WebDriverSessionsManager.registerWebDriverAfterShutdownHandler(webDriver -> {
if (driver == webDriver) {
forceRemove = true;
}
});
// add to active sessions
currentKeepAliveSessions.add(this);
log().info("Initialized a WebDriverKeepAliveSequence for driver with session key {}.",
WebDriverManagerUtils.getSessionKey(this.driver));
}
/**
* Removes active {@link WebDriverKeepAliveSequence} if present
*
* @param driver {@link WebDriver}
*/
void removeKeepAliveForDriver(final WebDriver driver) {
currentKeepAliveSessions
.stream()
.filter(webDriverKeepAliveSequence -> webDriverKeepAliveSequence.driver == driver)
.findAny()
.ifPresent(webDriverKeepAliveSequence -> webDriverKeepAliveSequence.remove = true);
}
@Override
public void run() {
if (remove) {
setPassState(true);
setReturningObject(KeepAliveState.REMOVED_BY_USER);
log().info("WebDriverKeepAliveSequence canceled by user.");
currentKeepAliveSessions.remove(this);
return;
}
if (forceRemove) {
setPassState(true);
setReturningObject(KeepAliveState.REMOVED_BY_DRIVER_SHUTDOWN);
log().info("WebDriverKeepAliveSequence canceled because driver shut down.");
currentKeepAliveSessions.remove(this);
return;
}
driver.getTitle();
setPassState(false);
setReturningObject(KeepAliveState.REMOVED_BY_TIMEOUT);
}
}