com.infotel.seleniumrobot.grid.servlets.server.MobileNodeServlet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of seleniumRobot-grid Show documentation
Selenium grid extension for mobile testing
The newest version!
/**
 * Copyright 2017 www.infotel.com
 *
 * 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.infotel.seleniumrobot.grid.servlets.server;

import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;
import org.json.JSONObject;
import org.openqa.grid.internal.GridRegistry;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.remote.CapabilityType;
import org.openqa.selenium.remote.DesiredCapabilities;

import com.infotel.seleniumrobot.grid.utils.Utils;
import com.seleniumtests.browserfactory.mobile.MobileDeviceSelector;
import com.seleniumtests.customexception.ConfigurationException;
import com.seleniumtests.driver.DriverMode;
import com.seleniumtests.util.osutility.OSUtilityFactory;

import io.appium.java_client.remote.AndroidMobileCapabilityType;

/**
 * Servlet for getting all mobile devices information
 * This helps the hub to update capabilities with information on the connected device
 * @author behe
 *
 */
public class MobileNodeServlet extends GenericServlet {
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 216473127866019518L;

	private transient MobileDeviceSelector deviceSelector = new MobileDeviceSelector();

	private static final Logger logger = Logger.getLogger(MobileNodeServlet.class);
	
	public MobileNodeServlet() {
		super(null);
	}
	
	public MobileNodeServlet(GridRegistry registry) {
		super(registry);
	}
	
	@Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//		updateDrivers();
		Map parameters = req.getParameterMap();
		DesiredCapabilities caps = new DesiredCapabilities(new JSONObject(parameters.get("caps")[0]).toMap());
		
		// update capabilities from real device properties (e.g: deviceName value is changed to the ID on android)
		deviceSelector.initialize();
		
		MutableCapabilities updatedCaps = new MutableCapabilities();
		try {
			updatedCaps = deviceSelector.updateCapabilitiesWithSelectedDevice(caps, DriverMode.LOCAL);
		} catch (ConfigurationException e) {
			sendError(resp, e.getMessage());
			return;
		}
		
		// chrome driver is given as name only, add path
		if (updatedCaps.getCapability(AndroidMobileCapabilityType.CHROMEDRIVER_EXECUTABLE) != null) {
			String driverPath = Utils.getDriverDir().toString().replace(File.separator, "/") + "/";
			String ext = OSUtilityFactory.getInstance().getProgramExtension();
			updatedCaps.setCapability(AndroidMobileCapabilityType.CHROMEDRIVER_EXECUTABLE, driverPath + updatedCaps.getCapability(AndroidMobileCapabilityType.CHROMEDRIVER_EXECUTABLE) + ext);
		}

		resp.setContentType("application/json");
		try (
            ServletOutputStream outputStream = resp.getOutputStream()) {
			Map capsMap = new HashMap<>(updatedCaps.asMap());
			
			// prevent "plaform" key to be serialized by sending string value
			if (capsMap.get(CapabilityType.PLATFORM) != null) {
				capsMap.put(CapabilityType.PLATFORM, updatedCaps.getCapability(CapabilityType.PLATFORM).toString());
			}
			
			resp.getOutputStream().print(new JSONObject(capsMap).toString());
        } catch (IOException e) {
        	logger.error("Error sending reply", e);
        }
    }
	
	private void sendError(HttpServletResponse resp, String msg) throws IOException {
		try {
	        resp.setStatus(HttpServletResponse.SC_NOT_FOUND);
	        resp.getOutputStream().print(msg);
		} catch (Exception e) {
			e.printStackTrace();
		}
    }
	
//	private void updateDrivers() {
//		
//		DesiredCapabilities androidCaps = new DesiredCapabilities();
//		androidCaps.setCapability(MobileCapabilityType.PLATFORM_NAME, "android");
//		
//		DesiredCapabilities androidChromeCaps = new DesiredCapabilities(androidCaps);
//		androidChromeCaps.setCapability(CapabilityType.BROWSER_NAME, "chrome");
//		
//		DesiredCapabilities iosCaps = new DesiredCapabilities();
//		androidCaps.setCapability(MobileCapabilityType.PLATFORM_NAME, "ios");
//		
//		DesiredCapabilities iosSafariCaps = new DesiredCapabilities(androidCaps);
//		androidChromeCaps.setCapability(CapabilityType.BROWSER_NAME, "safari");
//		
//		DriverProvider appiumAndroidProvider = new DefaultDriverProvider(androidCaps, AndroidDriver.class);
//		DriverProvider appiumAndroidChromeProvider = new DefaultDriverProvider(androidChromeCaps, AndroidDriver.class);
//		DriverProvider appiumIosProvider = new DefaultDriverProvider(iosCaps, IOSDriver.class);
//		DriverProvider appiumIosSafariProvider = new DefaultDriverProvider(iosSafariCaps, IOSDriver.class);
//		
//		try {
//			Field driverProvidersField = DefaultDriverSessions.class.getDeclaredField("defaultDriverProviders");
//			driverProvidersField.setAccessible(true);
//			List driverList = (List)driverProvidersField.get(DefaultDriverSessions.class);
//			List newDriverList = new ArrayList<>(driverList);
//			newDriverList.add(appiumAndroidChromeProvider);
//			newDriverList.add(appiumAndroidProvider);
//			newDriverList.add(appiumIosProvider);
//			newDriverList.add(appiumIosSafariProvider);
//		} catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
//			// TODO Auto-generated catch block
//			e.printStackTrace();
//		}
//	}
}