endtoend.browser.driver.builders.ChromeDriverBuilderTest.java Source code

Introduction

Here is the source code for endtoend.browser.driver.builders.ChromeDriverBuilderTest.java

Source

/*
 * Copyright (c) 2017 seleniumQuery authors
 *
 * 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 endtoend.browser.driver.builders;

import static io.github.seleniumquery.SeleniumQuery.$;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertEquals;
import static org.junit.Assume.assumeTrue;
import static testinfrastructure.testutils.EnvironmentTestUtils.isNotWindowsOS;

import java.util.HashMap;
import java.util.Map;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.chrome.ChromeOptions;
import org.openqa.selenium.remote.DesiredCapabilities;

import endtoend.browser.util.BrowserAgentTestUtils;
import io.github.bonigarcia.wdm.ChromeDriverManager;
import testinfrastructure.junitrule.SetUpAndTearDownDriver;

public class ChromeDriverBuilderTest {

    // https://code.google.com/p/chromium/codesearch#chromium/src/chrome/test/chromedriver/chrome/mobile_device_list.cc
    private static final String CHROME_MOBILE_EMULATION_DEVICE = "iPad";
    private static final String WINDOWS_TEST_CHROMEDRIVER_LOCATION = "D:\\usr\\local\\bin\\chromedriver.exe";
    private static final String LINUX_TEST_CHROMEDRIVER_LOCATION = "/usr/local/bin/chromedriver";

    @Before
    public void setUp() {
        assumeTrue(
                "To run the tests in this class, EndToEndTestConfig#whatDriversShouldTestsRun() should return DriverToRunTestsIn.CHROME.",
                SetUpAndTearDownDriver.driverToRunTestsIn.canRunChrome());
    }

    @After
    public void tearDown() {
        $.quit();
    }

    @Test
    public void withOptions() {
        // given
        ChromeOptions options = createChromeOptionsWithMobileEmulation();
        // when
        $.driver().useChrome().withOptions(options);
        // then
        BrowserAgentTestUtils.assertBrowserAgent(containsString(CHROME_MOBILE_EMULATION_DEVICE));
    }

    private static class MergeWasCalled extends RuntimeException {
    }

    @Test(expected = MergeWasCalled.class)
    public void withCapabilities() {
        // given
        DesiredCapabilities desiredCapabilities = new DesiredCapabilities() {
            @Override
            public Map<String, Object> asMap() { // .merge() uses this method. if the code stops calling .merge(), this test fails
                throw new MergeWasCalled();
            }
        };
        // when
        $.driver().useChrome().withCapabilities(desiredCapabilities);
        // then
        // should throw exception
    }

    private ChromeOptions createChromeOptionsWithMobileEmulation() {
        Map<String, String> mobileEmulation = new HashMap<>();
        mobileEmulation.put("deviceName", CHROME_MOBILE_EMULATION_DEVICE);

        ChromeOptions options = new ChromeOptions();
        options.setExperimentalOption("mobileEmulation", mobileEmulation);
        return options;
    }

    @Test
    public void withoutCapabilities() {
        // given
        // when
        $.driver().useChrome();
        // then
        BrowserAgentTestUtils.assertBrowserAgent(not(containsString(CHROME_MOBILE_EMULATION_DEVICE)));
    }

    @Test
    @SuppressWarnings({ "deprecation", "ConstantConditions" })
    public void withCapabilities__should_return_the_current_ChromeDriverBuilder_instance_to_allow_further_chaining() {
        ChromeOptions chromeOptions = null;
        $.driver().useChrome().withCapabilities(null).withOptions(chromeOptions); // should compile
    }

    @Test
    public void withPathToChromeDriver() {
        // given
        // so this test is really effective, the chromedriver executable shouldnt be in $PATH
        $.driver().useChrome().withPathToChromeDriver(getChromeDriverExecutablePath());
        // when
        BrowserAgentTestUtils.openBrowserAgentTestHelperUrl();
        // then
        // no exception is thrown while opening a page
    }

    private String getChromeDriverExecutablePath() {
        if (isNotWindowsOS()) {
            return LINUX_TEST_CHROMEDRIVER_LOCATION;
        } else {
            return WINDOWS_TEST_CHROMEDRIVER_LOCATION;
        }
    }

    @Test
    public void useChrome__should_fall_back_to_systemProperty_when_executable_not_found_in_classpath() {
        // given
        // so this test is really effective, the chromedriver executable shouldnt be in $PATH
        System.setProperty("webdriver.chrome.driver", getChromeDriverExecutablePath());
        // when
        $.driver().useChrome();
        BrowserAgentTestUtils.openBrowserAgentTestHelperUrl();
        // then
        // no exception is thrown while opening a page
    }

    @Test
    public void headless() {
        // when
        $.driver().useChrome().headless();
        // then
        BrowserAgentTestUtils.assertBrowserAgent(containsString("HeadlessChrome"));
    }

    @Test
    public void autoDriverDownload() {
        // when
        $.driver().useChrome().autoDriverDownload();
        // then
        BrowserAgentTestUtils.assertBrowserAgent(containsString("Chrome"));
    }

    @Test
    public void autoDriverDownload__lambda() {
        // when
        $.driver().useChrome().autoDriverDownload(x -> x.version("2.32")).headless();
        // then
        BrowserAgentTestUtils.assertBrowserAgent(containsString("Chrome"));
        // some day, when the version below is too old, this test will fail. Replace the number below with latestVersion - 0.01
        assertEquals("2.32", ChromeDriverManager.getInstance().getDownloadedVersion());
    }

}