Skip to content

Commit

Permalink
Refactor FluentAdapter for TestNG and JUnit Tests to share more code
Browse files Browse the repository at this point in the history
  • Loading branch information
Toilal committed Apr 1, 2016
1 parent 726ebda commit 87e59cb
Show file tree
Hide file tree
Showing 28 changed files with 235 additions and 221 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ Be aware that when you modified this elements, the webDriver instance will be mo
### Configuration
You can define a default driver configuration using two ways.
First, just override the getDriver method and use the selenium way to configure your driver.
You can also override the setDefaultConfig method and use both selenium and FluentLenium way (withDefaultSearchWait,withDefaultPageWait) to configure your driver.
You can also override the getDefaultConfig method and use both selenium and FluentLenium way (withDefaultSearchWait,withDefaultPageWait) to configure your driver.

## Browser Lifecycle
For JUnit and TestNG, you can define the browser lifecycle.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package org.fluentlenium.core;
package org.fluentlenium.adapter;

import org.fluentlenium.core.Fluent;
import org.fluentlenium.core.FluentPage;
import org.fluentlenium.core.FluentThread;
import org.fluentlenium.core.page.PageInitializerException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
Expand All @@ -16,17 +19,18 @@ public FluentAdapter() {
FluentThread.set(this);
}

protected void initTest() {
protected void init() {
try {
pageInitializer.initContainer(this);
} catch (ClassNotFoundException e) {
throw new PageInitializerException("Class not found", e);
} catch (IllegalAccessException e) {
throw new PageInitializerException("IllegalAccessException", e);
}
getDefaultConfig();
}

protected void cleanUp() {
protected void close() {
pageInitializer.release();
}

Expand Down Expand Up @@ -55,13 +59,4 @@ public String getDefaultBaseUrl() {
*/
public void getDefaultConfig() {
}

/**
* @deprecated use FluentPage.isAt() instead.
*
*/
@Deprecated
public static void assertAt(FluentPage fluent) {
fluent.isAt();
}
}
Original file line number Diff line number Diff line change
@@ -1,125 +1,42 @@
package org.fluentlenium.adapter;

import org.fluentlenium.adapter.util.ShutdownHook;
import org.fluentlenium.core.FluentAdapter;
import org.fluentlenium.core.FluentPage;
import org.junit.AfterClass;
import org.junit.Rule;
import org.junit.rules.TestName;
import org.junit.rules.TestRule;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;
import org.openqa.selenium.WebDriver;

import static org.fluentlenium.adapter.util.SharedDriverHelper.*;

/**
* All Junit Test should extends this class. It provides default parameters.
*/
public abstract class FluentTest extends FluentAdapter {
private static WebDriver sharedDriver;
private static boolean isSharedDriverPerClass;

public abstract class FluentTest extends FluentTestRunnerAdapter {
@Rule
public TestName name = new TestName();
@Rule
public TestRule watchman = new TestWatcher() {
@Override
public void starting(Description description) {
super.starting(description);
//TODO Refactor
if (isSharedDriverOnce(description.getTestClass())) {
synchronized (this) {
if (sharedDriver == null) {
initFluentFromDefaultDriver();
sharedDriver = getDriver();
killTheBrowserOnShutdown();
} else {
initFluentWithExistingDriver();
}
}
} else if (isSharedDriverPerClass(description.getTestClass())) {
synchronized (this) {
if (!isSharedDriverPerClass) {
initFluentFromDefaultDriver();
sharedDriver = getDriver();
isSharedDriverPerClass = true;
} else {
initFluentWithExistingDriver();
}
}
} else {
initFluentFromDefaultDriver();
}

initTest();
setDefaultConfig();
FluentTest.this.starting(description.getTestClass(), description.getDisplayName());
}


@Override
public void finished(Description description) {
super.finished(description);
if (isSharedDriverPerMethod(description.getTestClass()) ||
isDefaultSharedDriver(description.getTestClass())) {
quit();
} else if (isDeleteCookies(description.getTestClass())) {
if (sharedDriver != null) {
sharedDriver.manage().deleteAllCookies();
}
}
FluentTest.this.finished(description.getTestClass(), description.getDisplayName());
}

@Override
public void failed(Throwable e, Description description) {
if (screenshotMode == TriggerMode.ON_FAIL) {
takeScreenShot(description.getTestClass().getSimpleName() + "_" +
description.getMethodName() + ".png");
}
if (htmlDumpMode == TriggerMode.ON_FAIL) {
takeHtmlDump(description.getTestClass().getSimpleName() + "_"
+ description.getMethodName() + ".html");
}
super.failed(e, description);
FluentTest.this.failed(e, description.getTestClass(), description.getDisplayName());
}

};

private void killTheBrowserOnShutdown() {
Runtime.getRuntime().addShutdownHook(new ShutdownHook("fluentlenium", this));
}

private void initFluentWithExistingDriver() {
initFluent(sharedDriver).withDefaultUrl(getDefaultBaseUrl());
}

private void initFluentFromDefaultDriver() {
initFluent(getDefaultDriver()).withDefaultUrl(getDefaultBaseUrl());
}


public FluentTest() {
super();
}


@AfterClass
public static void afterClass() {
if (isSharedDriverPerClass) {
sharedDriver.quit();
sharedDriver = null;
isSharedDriverPerClass = false;
}
FluentTest.releaseSharedDriver();
}

/**
* Override this method to change the default time to wait for a page to be loaded
*/
public void setDefaultConfig() {
}

public static void assertAt(FluentPage fluent) {
fluent.isAt();
}


}
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
package org.fluentlenium.adapter;


import org.fluentlenium.adapter.util.CookieStrategyReader;
import org.fluentlenium.adapter.util.DefaultCookieStrategyReader;
import org.fluentlenium.adapter.util.DefaultSharedDriverStrategyReader;
import org.fluentlenium.adapter.util.SharedDriverStrategyReader;
import org.fluentlenium.adapter.util.SharedDriverStrategy;
import org.fluentlenium.adapter.util.ShutdownHook;
import org.openqa.selenium.WebDriver;

/**
* Adapter used by any class based Test Runners adapters.
*/
public class FluentTestRunnerAdapter extends FluentAdapter {
private static WebDriver sharedDriver;
private static boolean isSharedDriverPerClass;

private final SharedDriverStrategyReader sdsr;
private final CookieStrategyReader csr;

public FluentTestRunnerAdapter() {
this(new DefaultSharedDriverStrategyReader(), new DefaultCookieStrategyReader());
}

public FluentTestRunnerAdapter(SharedDriverStrategyReader sharedDriverExtractor, CookieStrategyReader cookieExtractor) {
this.sdsr = sharedDriverExtractor;
this.csr = cookieExtractor;
}

/**
* Invoked when a test method is starting.
*
* @param testClass Test class
* @param testName Test name
*/
protected void starting(Class<?> testClass, String testName) {
SharedDriverStrategy strategy = sdsr.getSharedDriverStrategy(testClass, testName);

if (strategy == SharedDriverStrategy.ONCE) {
synchronized (this) {
if (sharedDriver == null) {
initFluent(getDefaultDriver()).withDefaultUrl(getDefaultBaseUrl());
sharedDriver = getDriver();
Runtime.getRuntime().addShutdownHook(new ShutdownHook("fluentlenium", this));
} else {
initFluent(sharedDriver).withDefaultUrl(getDefaultBaseUrl());
}
}
} else if (strategy == SharedDriverStrategy.PER_CLASS) {
synchronized (this) {
if (!isSharedDriverPerClass) {
initFluent(getDefaultDriver()).withDefaultUrl(getDefaultBaseUrl());
sharedDriver = getDriver();
isSharedDriverPerClass = true;
} else {
initFluent(sharedDriver).withDefaultUrl(getDefaultBaseUrl());
}
}
} else {
initFluent(getDefaultDriver()).withDefaultUrl(getDefaultBaseUrl());
}

init();
}

/**
* Invoked when a test method has finished (whatever the success of failing status)
*
* @param testClass Test class
* @param testName Test name
*/
protected void finished(Class<?> testClass, String testName) {
close();
SharedDriverStrategy strategy = sdsr.getSharedDriverStrategy(testClass, testName);
if (strategy == SharedDriverStrategy.PER_METHOD) {
quit();
} else if (sharedDriver != null && csr.shouldDeleteCookies(testClass, testName)) {
sharedDriver.manage().deleteAllCookies();
}
}

/**
* Invoked when a test method has failed (before finished)
*
* @param e Throwable thrown by the failing test.
* @param testClass Test class
* @param testName Test name
*/
protected void failed(Throwable e, Class<?> testClass, String testName) {
if (screenshotMode == TriggerMode.ON_FAIL) {
takeScreenShot(testClass.getSimpleName() + "_" +
testName + ".png");
}
if (htmlDumpMode == TriggerMode.ON_FAIL) {
takeHtmlDump(testClass.getSimpleName() + "_"
+ testName + ".html");
}
}

/**
* Invoked when all methods from the class have been runned.
*/
public static void releaseSharedDriver() {
if (isSharedDriverPerClass) {
sharedDriver.quit();
sharedDriver = null;
isSharedDriverPerClass = false;
}
}

}
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package org.fluentlenium.adapter;

import org.fluentlenium.core.FluentAdapter;
import org.openqa.selenium.WebDriver;

/**
Expand All @@ -12,12 +11,12 @@ public class IsolatedTest extends FluentAdapter {

public IsolatedTest() {
initFluent(getDefaultDriver()).withDefaultUrl(getDefaultBaseUrl());
initTest();
init();
}

public IsolatedTest(WebDriver webDriver) {
initFluent(webDriver).withDefaultUrl(getDefaultBaseUrl());
initTest();
init();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package org.fluentlenium.adapter.util;


public interface CookieStrategyReader {
boolean shouldDeleteCookies(Class<?> clazz, String testName);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package org.fluentlenium.adapter.util;

public class DefaultCookieStrategyReader implements CookieStrategyReader {
@Override
public boolean shouldDeleteCookies(Class<?> clazz, String testName) {
SharedDriver sharedBrowser = clazz.getAnnotation(SharedDriver.class);
return (sharedBrowser != null && sharedBrowser.deleteCookies());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package org.fluentlenium.adapter.util;

public class DefaultSharedDriverStrategyReader implements SharedDriverStrategyReader {
@Override
public SharedDriverStrategy getSharedDriverStrategy(Class<?> clazz, String testName) {
SharedDriver sharedDriver = clazz.getAnnotation(SharedDriver.class);

if (sharedDriver == null) {
return SharedDriverStrategy.PER_METHOD;
}

if (sharedDriver.type() == SharedDriver.SharedType.ONCE) {
return SharedDriverStrategy.ONCE;
}

if (sharedDriver.type() == SharedDriver.SharedType.PER_CLASS) {
return SharedDriverStrategy.PER_CLASS;
}

return SharedDriverStrategy.PER_METHOD;
}
}

This file was deleted.

Loading

0 comments on commit 87e59cb

Please sign in to comment.