Skip to content

ADD: methods to create/destroy controllers ad hoc #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cstamatis wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

ADD: methods to create/destroy controllers ad hoc #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.persado.oss.quality.stevia</groupId>
<artifactId>stevia-core</artifactId>
<version>1.3.43-SNAPSHOT</version>
<version>1.3.44-SNAPSHOT</version>
<packaging>jar</packaging>

<name>Stevia QA Framework - Core</name>
Expand Down
84 changes: 82 additions & 2 deletions src/main/java/com/persado/oss/quality/stevia/annotations/AnnotationsHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import com.persado.oss.quality.stevia.selenium.core.SteviaContext;
import com.persado.oss.quality.stevia.selenium.core.WebController;
import com.persado.oss.quality.stevia.selenium.core.controllers.SteviaWebControllerFactory;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.WebDriverException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -76,6 +77,13 @@ protected Map<String, WebController> initialValue() {
};
};

private static final ThreadLocal<Map<String, WebController>> namedControllers = new ThreadLocal<Map<String, WebController>>() {
@Override
protected Map<String, WebController> initialValue() {
return new HashMap<String, WebController>();
};
};

public static void disposeControllers() {
for (WebController controller : controllers.get().values()) {
LOG.info("Removing {} in SteviaContext.clean - disposeControllers()", controller);
Expand All @@ -87,6 +95,17 @@ public static void disposeControllers() {

}
controllers.get().clear();

for (Map.Entry<String, WebController> entry : namedControllers.get().entrySet()) {
LOG.info("Removing named controller '{}' in SteviaContext.clean - disposeControllers()", entry.getKey());
try {
entry.getValue().quit();
} catch (WebDriverException wde) {
LOG.warn("Exception caught calling controller.quit(): \"" + wde.getMessage() + "\" additional info: " + wde.getAdditionalInformation());
}
}
namedControllers.get().clear();

Deque<WebController> cache = controllerStack.get();
while (cache.peek() != null) {
LOG.warn("test ends while controllers still masked - will clear the masked controller also");
Expand Down Expand Up @@ -184,8 +203,69 @@ public void controllerUnmask() throws Throwable {
LOG.warn("Controller was not masked. It is optional anyway in @RunsConditionsWithController.");
}
}



/**
* Switches to a named controller, creating it if it doesn't exist yet.
* Named controllers are cached and can be reused across multiple invocations.
* The current controller is pushed onto the stack and can be restored with {@link #popController()}.
* To dispose a named controller, use {@link #disposeNamedController(String)}.
*
* @param name the name to identify this controller
* @return true if a new controller was created, false if an existing one was reused
*/
public static boolean pushNamedController(String name) throws InterruptedException, ExecutionException, TimeoutException, MalformedURLException, NoSuchFieldException, IllegalAccessException {
WebController currentController = SteviaContext.getWebController();
Dimension currentSize = currentController.getDriver().manage().window().getSize();
controllerStack.get().push(currentController);

Map<String, WebController> named = namedControllers.get();
boolean isNew = !named.containsKey(name);
WebController namedController;
if (isNew) {
namedController = SteviaWebControllerFactory.getWebController(SteviaContext.getSpringContext());
namedController.setWindowSize(currentSize);
named.put(name, namedController);
LOG.info("Created new named controller '{}'", name);
} else {
namedController = named.get(name);
LOG.info("Reusing named controller '{}'", name);
}
SteviaContext.setWebController(namedController);
return isNew;
}

/**
* Restores the previous controller from the stack without quitting the current one.
* Use this when the current controller should stay alive (e.g. a named controller with close=false).
*/
public static void popController() {
Deque<WebController> stack = controllerStack.get();
if (stack.peek() != null) {
SteviaContext.setWebController(stack.pop());
LOG.info("Restored previous controller from stack (current controller kept alive)");
} else {
LOG.warn("No controller on stack to restore");
}
}

/**
* Quits and removes a named controller from the cache.
*
* @param name the name of the controller to dispose
*/
public static void disposeNamedController(String name) {
WebController controller = namedControllers.get().remove(name);
if (controller != null) {
try {
controller.quit();
LOG.info("Disposed named controller '{}'", name);
} catch (WebDriverException wde) {
LOG.warn("Exception disposing named controller '{}': \"{}\" additional info: {}", name, wde.getMessage(), wde.getAdditionalInformation());
}
}
}


@Override
public void setApplicationContext(ApplicationContext applicationContext)
throws BeansException {
Expand Down