com.seleniumtests.browserfactory.IECapabilitiesFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-selenium4 Show documentation
There is a newer version: 5.1.13
/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 * 				Copyright 2017-2019 B.Hecquet
 *
 * 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 com.seleniumtests.browserfactory;

import java.util.List;
import java.util.Map;

import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.ie.InternetExplorerDriver;
import org.openqa.selenium.ie.InternetExplorerDriverService;
import org.openqa.selenium.ie.InternetExplorerOptions;

import com.seleniumtests.customexception.ConfigurationException;
import com.seleniumtests.driver.BrowserType;
import com.seleniumtests.driver.DriverConfig;
import com.seleniumtests.driver.DriverMode;
import com.seleniumtests.util.logging.DebugMode;
import com.seleniumtests.util.osutility.OSUtility;

public class IECapabilitiesFactory extends IDesktopCapabilityFactory {

    public static final String SE_IE_OPTIONS = "se:ieOptions";

	public IECapabilitiesFactory(DriverConfig webDriverConfig) {
		super(webDriverConfig);
	}

	@Override
	protected MutableCapabilities getDriverOptions() {
		InternetExplorerOptions options = new InternetExplorerOptions()
				.introduceFlakinessByIgnoringSecurityDomains()
				.destructivelyEnsureCleanSession()
				.ignoreZoomSettings();
		
        if (Boolean.TRUE.equals(webDriverConfig.getIeMode())) {
        	configureEdgeIeMode(options);
        	
        } else {
        	// initial URL is not set for Edge in IE mode, as about:blank is not a real URL and this prevent driver from finding the IE window
        	options.withInitialBrowserUrl("about:blank");
        }
		
        if (webDriverConfig.getPageLoadStrategy() != null) {
        	options.setPageLoadStrategy(webDriverConfig.getPageLoadStrategy());
        }

        return options;
	}

	/**
	 * @param options
	 */
	private void configureEdgeIeMode(InternetExplorerOptions options) {
		if (webDriverConfig.getMode() == DriverMode.LOCAL) {
			List edgeBrowserInfos = OSUtility.getInstalledBrowsersWithVersion(webDriverConfig.getBetaBrowser()).get(BrowserType.EDGE);
			if (edgeBrowserInfos == null || edgeBrowserInfos.isEmpty()) {
				throw new ConfigurationException("Edge not available");
			}
			
			// put in both location as Selenium3 does not handle edge chromium properly
			options.attachToEdgeChrome()
				.withEdgeExecutablePath(edgeBrowserInfos.get(0).getPath());

		} else {
			options.setCapability(SeleniumRobotCapabilityType.EDGE_IE_MODE, true);
		}

	    options.withInitialBrowserUrl(webDriverConfig.getInitialUrl());
	}

	@Override
	protected String getDriverPath() {
		return webDriverConfig.getIeDriverPath();
	}

	@Override
	protected BrowserType getBrowserType() {
		return BrowserType.INTERNET_EXPLORER;
	}

	@Override
	protected String getDriverExeProperty() {
		return InternetExplorerDriverService.IE_DRIVER_EXE_PROPERTY;
	}

	@Override
	protected String getBrowserBinaryPath() {
		return null;
	}
	
	private void configureAttachExistingBrowser(MutableCapabilities options) {

        if (webDriverConfig.getAttachExistingDriverPort() != null) {
        	
        	// when attaching to an existing Internet Explorer, give the option to driver which will then not create a new Internet Explorer
			((Map) options.getCapability(SE_IE_OPTIONS)).put("ie.attachExistingBrowser", true);
			((Map) options.getCapability(SE_IE_OPTIONS)).put("ie.ignoreprocessmatch", true); // add this option (https://github.com/SeleniumHQ/selenium/pull/12246) because
																											 // without it, driver searches a process ID of -1
        }
	}

	@Override
	protected void updateOptionsWithSelectedBrowserInfo(MutableCapabilities options) {
		configureAttachExistingBrowser(options); // moved here because InternetExplorerOptions.merge removed the option (it's unknown from Selenium)
	}

	@Override
	protected void updateGridOptionsWithSelectedBrowserInfo(MutableCapabilities options) {
		configureAttachExistingBrowser(options); // moved here because InternetExplorerOptions.merge removed the option (it's unknown from Selenium)
	}
}