@Autowire WebDriver lifecycle not correct

[rwinch]

In Spring Boot 1.4.0.RELEASE the testing support does not invoke WebDriver.quit() between tests. It should also create a new instance for every test method.

The @Autowire WebDriver should add a hook so that after every test WebDriver.quit() is invoked and a new instance is created at the beginning of each tests.

[tomwhoiscontrary]

👍 Thanks!

[alexhutnik]

@philwebb @rwinch:

How might I take advantage of this lifecycle if I'm wiring in my own WebDriver?

I have a bean definition like so:

@Bean
WebDriver getDriver(Environment environment){
    switch (environment.getProperty("driver")){
        case "chrome":
            return new ChromeDriver();
        case "htmldriver":
            return new HtmlUnitDriver();
        case "phantomjs":
            return new PhantomJSDriver();
        default:
            return new HtmlUnitDriver();
    }
}

This allows me to specify from Maven (via profiles) or from my IDE (via args appended in JUnit runner) which WebDriver I want to use.

My web integration tests extend a class like this:

@RunWith(SpringRunner.class)
@SpringBootTest(classes = ApplicationLauncher.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public abstract class AbstractWebIntegrationTest {
    @Autowired
    protected WebDriver driver;
}

And a sample test:

public class EnrollmentIntegrationTest extends AbstractWebIntegrationTest {

    @Autowired
    EnrollmentPage enrollmentPage;

    @Test
    public void should_process_valid_enrollment(){
        enrollmentPage.open(url("/enroll"));
        enrollmentPage.createEnrollment(random(EnrollmentForm.class));
    }

    @Test
    public void should_process_valid_enrollment2(){
        enrollmentPage.open(url("/enroll"));
        enrollmentPage.createEnrollment(random(EnrollmentForm.class));
    }

    @Test
    public void should_process_valid_enrollment3(){
        enrollmentPage.open(url("/enroll"));
        enrollmentPage.createEnrollment(random(EnrollmentForm.class));
    }
}

I'm wondering how the driver can get reset at the end of a test method invocation. I've tried this and it seems like what is happening is WebDriverContextCustomizerFactory is detecting my WebDriver and setting the webDriver scope on it. Then after the first test is run WebDriverTestExecutionListener is resetting the scope (which calls quit() on the driver). But when the next method is invoked, the @Autowired WebDriver is not re-initialized using the bean definition above.

Edit: I think this is because my EnrollmentPage has a stale reference to the injected WebDriver. I'm using the Selenium PageObject pattern. Perhaps I need a custom TestExecutionListener to reset these objects. Any advice?

[philwebb]

@alexhutnik

How is the EnrollmentPage defined? You could either try adding @Scope("webDriver") to it's @Bean method so that it gets cleared out when the scope is reset or perhaps change it's internals to use @Autowired javax.inject.Provider<WebDriver> driver then call driver.get each time you need the driver.

[nkonev]

@philwebb
Hi, I have same "approach" as @alexhutnik: I wrired my own WebDriver bean with my own lifecycle: I want to start and stop "heavy" WebDriver once, at Junit tests startup and stop after all tests done.
All works Ok in 1.4.0, but in Spring Boot 1.4.1 appear WebDriverTestExecutionListener which break my wanted behaviour.
I tried to exclude it with
spring.autoconfigure.exclude: org.springframework.boot.test.autoconfigure.web.servlet.WebDriverTestExecutionListener
but it not excluded.

Expected behaviour: using same instance of webdriver.
Actual behaviour: my SeleniumFactory opens new Chrome/mozilla/... window per test and not close previous.

How I can exclude package-local class WebDriverTestExecutionListener ?

@Configuration
public class IntegrationTestConfiguration {

    @Value(TestConstants.IMPLICITLY_WAIT_TIMEOUT)
    private int implicitlyWaitTimeout;

    @Value(TestConstants.BROWSER)
    private Browser browser;

    @Bean(initMethod = "start", destroyMethod = "stop")
    public SeleniumFactory seleniumComponent() throws Exception {
        return new SeleniumFactory(implicitlyWaitTimeout, browser);
    }
}

public class SeleniumFactory implements FactoryBean<WebDriver> {

    public static final String PROPERTY_BROWSER_PHANTOM_LOG = "phantomjs.log";

    public static final String FIREFOX_DRIVER_VERSION = "0.10.0";
    public static final String CHROME_DRIVER_VERSION = "2.23";
    public static final String PHANTOM_JS_DRIVER_VERSION = "2.1.1";

    private WebDriver driver;

    private static final Logger logger = LoggerFactory.getLogger(SeleniumFactory.class);

    private final int implicitlyWaitTimeout;

    private final Browser browser;

    public SeleniumFactory(int implicitlyWaitTimeout, Browser browser) throws Exception {
        this.implicitlyWaitTimeout = implicitlyWaitTimeout;
        this.browser = browser;

    }

    @Override
    public WebDriver getObject() throws Exception {
        return driver;
    }

    @Override
    public Class<WebDriver> getObjectType() {
        return WebDriver.class;
    }

    @Override
    public boolean isSingleton() {
        return true;
    }

    public void start() {
        // http://www.slf4j.org/legacy.html#jul-to-slf4j
        // http://www.slf4j.org/api/org/slf4j/bridge/SLF4JBridgeHandler.html
        // Optionally remove existing handlers attached to j.u.l root logger
        SLF4JBridgeHandler.removeHandlersForRootLogger();  // (since SLF4J 1.6.5)
        // add SLF4JBridgeHandler to j.u.l's root logger, should be done once during
        // the initialization phase of your application
        SLF4JBridgeHandler.install();

        switch(browser) {
            case PHANTOM:
            {
                PhantomJsDriverManager.getInstance().setup(PHANTOM_JS_DRIVER_VERSION); // download executables if need and set System.properties

                String phantomLogProp = System.getProperty(PROPERTY_BROWSER_PHANTOM_LOG);
                File phantomLog = null;
                if (phantomLogProp != null){
                    phantomLog = new File(phantomLogProp);
                }
                String phantomjspath = System.getProperty(PhantomJSDriverService.PHANTOMJS_EXECUTABLE_PATH_PROPERTY); // setted by PhantomJsDriverManager.getInstance().setup();
                PhantomJSDriverService phantomJSDriverService = new PhantomJSDriverService.Builder()
                        .usingPhantomJSExecutable(new File(phantomjspath))
                        .withLogFile(phantomLog)
                        .usingAnyFreePort()
                        .build();
                driver = new PhantomJSDriver(phantomJSDriverService, DesiredCapabilities.phantomjs());
            }
            break;
            case FIREFOX:
            {
                // firefox
                MarionetteDriverManager.getInstance().setup(FIREFOX_DRIVER_VERSION); // download executables if need and set System.properties
                //Step 1- Driver Instantiation: Instantiate driver object as FirefoxDriver
                driver = new FirefoxDriver();
            }
            break;
            case CHROME:
            {
                ChromeDriverManager.getInstance().setup(CHROME_DRIVER_VERSION); // download executables if need and set System.properties
                driver = new ChromeDriver();
            }
            break;
        }

        driver.manage().window().setSize(new Dimension(1600, 900));
        driver.manage().timeouts().implicitlyWait(implicitlyWaitTimeout, TimeUnit.SECONDS); // wait for #findElement()
    }

    public void stop() {
        if (driver != null) {
            //Step 4- Close Driver
            driver.close();

            //Step 5- Quit Driver
            driver.quit();
        }

    }
}

[philwebb]

@nikit-cpp The exclude won't work in this case because WebDriverTestExecutionListener isn't an auto-configuration class. Could you please raise a new issue and we'll try and find a way to support your use-case.

[nkonev]

@philwebb ok I create new issue