org.openqa.grid.web.servlet.handler.WebDriverRequestHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-server
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 3.9.1
/*
Copyright 2011 WebDriver committers
Copyright 2011 Software Freedom Conservancy

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 org.openqa.grid.web.servlet.handler;

import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.logging.Logger;

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

import org.json.JSONException;
import org.json.JSONObject;
import org.openqa.grid.internal.ExternalSessionKey;
import org.openqa.grid.common.SeleniumProtocol;
import org.openqa.grid.common.exception.GridException;
import org.openqa.grid.internal.exception.NewSessionException;
import org.openqa.grid.internal.utils.ForwardConfiguration;
import org.openqa.grid.internal.Registry;
import org.openqa.grid.internal.TestSession;
import org.openqa.jetty.jetty.servlet.ServletHttpResponse;

/**
 * Handles an individual request, scope is a single request and hence a single thread.
 */
public class WebDriverRequestHandler extends RequestHandler {

  private static final Logger log = Logger.getLogger(WebDriverRequestHandler.class.getName());

  protected WebDriverRequestHandler(HttpServletRequest request, HttpServletResponse response,
      Registry registry) {
    super(request, response, registry);
  }


  @Override
  public RequestType extractRequestType() {

    if ("/session".equals(getRequest().getPathInfo())) {
      return RequestType.START_SESSION;
    } else if (getRequest().getMethod().equalsIgnoreCase("DELETE")) {
      ExternalSessionKey
          externalKey =  ExternalSessionKey.fromWebDriverRequest(getRequest().getPathInfo());
      if (getRequest().getPathInfo().endsWith("/session/" + externalKey.getKey())) {
        return RequestType.STOP_SESSION;
      }
    }
    return RequestType.REGULAR;
  }

  @Override
  public ExternalSessionKey extractSession() {
    if (getRequestType() == RequestType.START_SESSION) {
      throw new IllegalAccessError("Cannot call that method of a new session request.");
    }
    String path = getRequest().getPathInfo();
    return ExternalSessionKey.fromWebDriverRequest(path);
  }

  // TODO freynaud parsing is so so.
  @SuppressWarnings("unchecked")
  // JSON iterator.
  @Override
  public Map extractDesiredCapability() {
    String json = getRequestBody();
    Map desiredCapability = new HashMap();
    try {
      JSONObject map = new JSONObject(json);
      JSONObject dc = map.getJSONObject("desiredCapabilities");
      for (Iterator iterator = dc.keys(); iterator.hasNext();) {
        String key = (String) iterator.next();
        Object value = dc.get(key);
        if (value == JSONObject.NULL) {
          value = null;
        }
        desiredCapability.put(key, value);
      }
    } catch (JSONException e) {
      throw new GridException("Cannot extract a capabilities from the request " + json);
    }
    return desiredCapability;
  }

  @Override
  public ExternalSessionKey forwardNewSessionRequestAndUpdateRegistry(TestSession session) throws NewSessionException{
    try {
      // here, don't forward the requestBody directly, but read the
      // desiredCapabilities from the session instead.
      // That allow the TestSessionListener.before modification of the
      // capability map to be propagated.
      JSONObject c = new JSONObject();
      c.put("desiredCapabilities", session.getRequestedCapabilities());
      String content = c.toString();
      ForwardConfiguration config = new ForwardConfiguration();
      config.setProtocol(SeleniumProtocol.WebDriver);
      config.setNewSessionRequest(true);
      config.setContentOverWrite(content);
      session.forward(getRequest(), getResponse(), config);
    } catch (IOException e) {
      //log.warning("Error forwarding the request " + e.getMessage());
      throw new NewSessionException("Error forwarding the request " + e.getMessage(),e);
    } catch (JSONException e) {
      //log.warning("Error with the request " + e.getMessage());
      throw new NewSessionException("Error with the request " + e.getMessage(),e);
    }

    if (getResponse().containsHeader("Location")) {
      String location =
          ((ServletHttpResponse) getResponse()).getHttpResponse().getField("Location");
      ExternalSessionKey res =  ExternalSessionKey.fromWebDriverRequest( location);
      if ( res!=null){
        return res;
      }else {
        throw new NewSessionException("couldn't extract the new session from the response header.");
      }
    } else {
      //log.warning("Error, header should contain Location");
      throw new NewSessionException("Error, header should contain Location ");
    }

  }
}