chrome/test/webdriver/webdriver_capabilities_parser.cc

// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/test/webdriver/webdriver_capabilities_parser.h"

#include "base/file_util.h"
#include "base/format_macros.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/values.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/test/webdriver/webdriver_error.h"
#include "chrome/test/webdriver/webdriver_logging.h"
#include "chrome/test/webdriver/webdriver_util.h"

using base::DictionaryValue;
using base::Value;

namespace webdriver {

namespace {

Error* CreateBadInputError(const std::string& name,
                           Value::Type type,
                           const Value* option) {
  return new Error(kBadRequest, base::StringPrintf(
      "%s must be of type %s, not %s. Received: %s",
      name.c_str(), GetJsonTypeName(type),
      GetJsonTypeName(option->GetType()),
      JsonStringifyForDisplay(option).c_str()));
}

}  // namespace

Capabilities::Capabilities()
    : command(CommandLine::NO_PROGRAM),
      detach(false),
      load_async(false),
      local_state(new DictionaryValue()),
      no_website_testing_defaults(false),
      prefs(new DictionaryValue()) {
  log_levels[LogType::kDriver] = kAllLogLevel;
}

Capabilities::~Capabilities() { }

CapabilitiesParser::CapabilitiesParser(
    const DictionaryValue* capabilities_dict,
    const base::FilePath& root_path,
    const Logger& logger,
    Capabilities* capabilities)
    : dict_(capabilities_dict),
      root_(root_path),
      logger_(logger),
      caps_(capabilities) {
}

CapabilitiesParser::~CapabilitiesParser() { }

Error* CapabilitiesParser::Parse() {
  // Parse WebDriver standard capabilities.
  typedef Error* (CapabilitiesParser::*Parser)(const Value*);

  struct NameAndParser {
    const char* name;
    Parser parser;
  };
  NameAndParser name_and_parser[] = {
    { "proxy", &CapabilitiesParser::ParseProxy },
    { "loggingPrefs", &CapabilitiesParser::ParseLoggingPrefs }
  };
  for (size_t i = 0; i < ARRAYSIZE_UNSAFE(name_and_parser); ++i) {
    const Value* value;
    if (dict_->Get(name_and_parser[i].name, &value)) {
      Error* error = (this->*name_and_parser[i].parser)(value);
      if (error)
        return error;
    }
  }

  // Parse Chrome custom capabilities (a.k.a., ChromeOptions).
  const char kOptionsKey[] = "chromeOptions";
  const DictionaryValue* options = dict_;
  bool legacy_options = true;
  const Value* options_value;
  if (dict_->Get(kOptionsKey, &options_value)) {
    legacy_options = false;
    if (options_value->IsType(Value::TYPE_DICTIONARY)) {
      options = static_cast<const DictionaryValue*>(options_value);
    } else {
      return CreateBadInputError(
          kOptionsKey, Value::TYPE_DICTIONARY, options_value);
    }
  }

  std::map<std::string, Parser> parser_map;
  if (legacy_options) {
    parser_map["chrome.binary"] = &CapabilitiesParser::ParseBinary;
    parser_map["chrome.channel"] = &CapabilitiesParser::ParseChannel;
    parser_map["chrome.detach"] = &CapabilitiesParser::ParseDetach;
    parser_map["chrome.extensions"] = &CapabilitiesParser::ParseExtensions;
    parser_map["chrome.loadAsync"] = &CapabilitiesParser::ParseLoadAsync;
    parser_map["chrome.localState"] = &CapabilitiesParser::ParseLocalState;
    parser_map["chrome.nativeEvents"] = &CapabilitiesParser::ParseNativeEvents;
    parser_map["chrome.prefs"] = &CapabilitiesParser::ParsePrefs;
    parser_map["chrome.profile"] = &CapabilitiesParser::ParseProfile;
    parser_map["chrome.switches"] = &CapabilitiesParser::ParseArgs;
    parser_map["chrome.noWebsiteTestingDefaults"] =
        &CapabilitiesParser::ParseNoWebsiteTestingDefaults;
    parser_map["chrome.excludeSwitches"] =
        &CapabilitiesParser::ParseExcludeSwitches;
  } else {
    parser_map["args"] = &CapabilitiesParser::ParseArgs;
    parser_map["binary"] = &CapabilitiesParser::ParseBinary;
    parser_map["channel"] = &CapabilitiesParser::ParseChannel;
    parser_map["detach"] = &CapabilitiesParser::ParseDetach;
    parser_map["extensions"] = &CapabilitiesParser::ParseExtensions;
    parser_map["loadAsync"] = &CapabilitiesParser::ParseLoadAsync;
    parser_map["localState"] = &CapabilitiesParser::ParseLocalState;
    parser_map["nativeEvents"] = &CapabilitiesParser::ParseNativeEvents;
    parser_map["prefs"] = &CapabilitiesParser::ParsePrefs;
    parser_map["profile"] = &CapabilitiesParser::ParseProfile;
    parser_map["noWebsiteTestingDefaults"] =
        &CapabilitiesParser::ParseNoWebsiteTestingDefaults;
    parser_map["excludeSwitches"] =
        &CapabilitiesParser::ParseExcludeSwitches;
  }

  for (DictionaryValue::Iterator iter(*options); !iter.IsAtEnd();
       iter.Advance()) {
    if (parser_map.find(iter.key()) == parser_map.end()) {
      if (!legacy_options)
        return new Error(kBadRequest,
                         "Unrecognized chrome capability: " + iter.key());
      continue;
    }
    const Value* option = &iter.value();
    Error* error = (this->*parser_map[iter.key()])(option);
    if (error) {
      error->AddDetails(base::StringPrintf(
          "Error occurred while processing capability '%s'",
          iter.key().c_str()));
      return error;
    }
  }
  return NULL;
}

Error* CapabilitiesParser::ParseArgs(const Value* option) {
  const base::ListValue* args;
  if (!option->GetAsList(&args))
    return CreateBadInputError("arguments", Value::TYPE_LIST, option);
  for (size_t i = 0; i < args->GetSize(); ++i) {
    std::string arg_string;
    if (!args->GetString(i, &arg_string))
      return CreateBadInputError("argument", Value::TYPE_STRING, option);
    size_t separator_index = arg_string.find("=");
    if (separator_index != std::string::npos) {
      CommandLine::StringType arg_string_native;
      if (!args->GetString(i, &arg_string_native))
        return CreateBadInputError("argument", Value::TYPE_STRING, option);
      caps_->command.AppendSwitchNative(
          arg_string.substr(0, separator_index),
          arg_string_native.substr(separator_index + 1));
    } else {
      caps_->command.AppendSwitch(arg_string);
    }
  }
  return NULL;
}

Error* CapabilitiesParser::ParseBinary(const Value* option) {
  base::FilePath::StringType path;
  if (!option->GetAsString(&path)) {
    return CreateBadInputError("binary path", Value::TYPE_STRING, option);
  }
  caps_->command.SetProgram(base::FilePath(path));
  return NULL;
}

Error* CapabilitiesParser::ParseChannel(const Value* option) {
  if (!option->GetAsString(&caps_->channel))
    return CreateBadInputError("channel", Value::TYPE_STRING, option);
  return NULL;
}

Error* CapabilitiesParser::ParseDetach(const Value* option) {
  if (!option->GetAsBoolean(&caps_->detach))
    return CreateBadInputError("detach", Value::TYPE_BOOLEAN, option);
  return NULL;
}

Error* CapabilitiesParser::ParseExtensions(const Value* option) {
  const base::ListValue* extensions;
  if (!option->GetAsList(&extensions))
    return CreateBadInputError("extensions", Value::TYPE_LIST, option);
  for (size_t i = 0; i < extensions->GetSize(); ++i) {
    std::string extension_base64;
    if (!extensions->GetString(i, &extension_base64)) {
      return new Error(kBadRequest,
                       "Each extension must be a base64 encoded string");
    }
    base::FilePath extension = root_.AppendASCII(
        base::StringPrintf("extension%" PRIuS ".crx", i));
    std::string decoded_extension;
    if (!Base64Decode(extension_base64, &decoded_extension))
      return new Error(kUnknownError, "Failed to base64 decode extension");
    int size = static_cast<int>(decoded_extension.length());
    if (file_util::WriteFile(
            extension, decoded_extension.c_str(), size) != size)
      return new Error(kUnknownError, "Failed to write extension file");
    caps_->extensions.push_back(extension);
  }
  return NULL;
}

Error* CapabilitiesParser::ParseLoadAsync(const Value* option) {
  if (!option->GetAsBoolean(&caps_->load_async))
    return CreateBadInputError("loadAsync", Value::TYPE_BOOLEAN, option);
  return NULL;
}

Error* CapabilitiesParser::ParseLocalState(const Value* option) {
  const base::DictionaryValue* local_state;
  if (!option->GetAsDictionary(&local_state))
    return CreateBadInputError("localState", Value::TYPE_DICTIONARY, option);
  caps_->local_state.reset(local_state->DeepCopy());
  return NULL;
}

Error* CapabilitiesParser::ParseLoggingPrefs(const base::Value* option) {
  const DictionaryValue* logging_prefs;
  if (!option->GetAsDictionary(&logging_prefs))
    return CreateBadInputError("loggingPrefs", Value::TYPE_DICTIONARY, option);

  for (DictionaryValue::Iterator iter(*logging_prefs); !iter.IsAtEnd();
       iter.Advance()) {
    LogType log_type;
    if (!LogType::FromString(iter.key(), &log_type))
      continue;

    std::string level_name;
    if (!iter.value().GetAsString(&level_name)) {
      return CreateBadInputError(
          std::string("loggingPrefs.") + iter.key(),
          Value::TYPE_STRING,
          &iter.value());
    }
    caps_->log_levels[log_type.type()] = LogLevelFromString(level_name);
  }
  return NULL;
}

Error* CapabilitiesParser::ParseNativeEvents(const Value* option) {
  bool native_events;
  if (!option->GetAsBoolean(&native_events))
    return CreateBadInputError("nativeEvents", Value::TYPE_BOOLEAN, option);
  if (native_events)
    return new Error(kUnknownError, "OS-level events are not supported");
  return NULL;
}

Error* CapabilitiesParser::ParsePrefs(const Value* option) {
  const base::DictionaryValue* prefs;
  if (!option->GetAsDictionary(&prefs))
    return CreateBadInputError("prefs", Value::TYPE_DICTIONARY, option);
  caps_->prefs.reset(prefs->DeepCopy());
  return NULL;
}

Error* CapabilitiesParser::ParseProfile(const Value* option) {
  std::string profile_base64;
  if (!option->GetAsString(&profile_base64))
    return CreateBadInputError("profile", Value::TYPE_STRING, option);
  std::string error_msg;
  caps_->profile = root_.AppendASCII("profile");
  if (!Base64DecodeAndUnzip(caps_->profile, profile_base64, &error_msg))
    return new Error(kUnknownError, "unable to unpack profile: " + error_msg);
  return NULL;
}

Error* CapabilitiesParser::ParseProxy(const base::Value* option) {
  const DictionaryValue* options;
  if (!option->GetAsDictionary(&options))
    return CreateBadInputError("proxy", Value::TYPE_DICTIONARY, option);

  // Quick check of proxy capabilities.
  std::set<std::string> proxy_options;
  proxy_options.insert("autodetect");
  proxy_options.insert("ftpProxy");
  proxy_options.insert("httpProxy");
  proxy_options.insert("noProxy");
  proxy_options.insert("proxyType");
  proxy_options.insert("proxyAutoconfigUrl");
  proxy_options.insert("sslProxy");
  proxy_options.insert("class");  // Created by BeanToJSONConverter.

  for (DictionaryValue::Iterator iter(*options); !iter.IsAtEnd();
       iter.Advance()) {
    if (proxy_options.find(iter.key()) == proxy_options.end()) {
      logger_.Log(kInfoLogLevel,
                  "Unrecognized proxy capability: " + iter.key());
    }
  }

  typedef Error* (CapabilitiesParser::*Parser)(const DictionaryValue*);
  std::map<std::string, Parser> proxy_type_parser_map;
  proxy_type_parser_map["autodetect"] =
      &CapabilitiesParser::ParseProxyAutoDetect;
  proxy_type_parser_map["pac"] =
      &CapabilitiesParser::ParseProxyAutoconfigUrl;
  proxy_type_parser_map["manual"] = &CapabilitiesParser::ParseProxyServers;
  proxy_type_parser_map["direct"] = NULL;
  proxy_type_parser_map["system"] = NULL;

  const Value* proxy_type_value;
  if (!options->Get("proxyType", &proxy_type_value))
    return new Error(kBadRequest, "Missing 'proxyType' capability.");

  std::string proxy_type;
  if (!proxy_type_value->GetAsString(&proxy_type))
    return CreateBadInputError("proxyType", Value::TYPE_STRING,
                               proxy_type_value);

  proxy_type = StringToLowerASCII(proxy_type);
  if (proxy_type_parser_map.find(proxy_type) == proxy_type_parser_map.end())
    return new Error(kBadRequest, "Unrecognized 'proxyType': " + proxy_type);

  if (proxy_type == "direct") {
    caps_->command.AppendSwitch(switches::kNoProxyServer);
  } else if (proxy_type == "system") {
    // Chrome default.
  } else {
    Error* error = (this->*proxy_type_parser_map[proxy_type])(options);
    if (error) {
      error->AddDetails("Error occurred while processing 'proxyType': " +
                        proxy_type);
      return error;
    }
  }
  return NULL;
}

Error* CapabilitiesParser::ParseProxyAutoDetect(
    const DictionaryValue* options) {
  const char kProxyAutoDetectKey[] = "autodetect";
  bool proxy_auto_detect = false;
  if (!options->GetBoolean(kProxyAutoDetectKey, &proxy_auto_detect))
    return CreateBadInputError(kProxyAutoDetectKey,
                               Value::TYPE_BOOLEAN, options);
  if (proxy_auto_detect)
    caps_->command.AppendSwitch(switches::kProxyAutoDetect);
  return NULL;
}

Error* CapabilitiesParser::ParseProxyAutoconfigUrl(
    const DictionaryValue* options){
  const char kProxyAutoconfigUrlKey[] = "proxyAutoconfigUrl";
  CommandLine::StringType proxy_pac_url;
  if (!options->GetString(kProxyAutoconfigUrlKey, &proxy_pac_url))
    return CreateBadInputError(kProxyAutoconfigUrlKey,
                               Value::TYPE_STRING, options);
  caps_->command.AppendSwitchNative(switches::kProxyPacUrl, proxy_pac_url);
  return NULL;
}

Error* CapabilitiesParser::ParseProxyServers(
    const DictionaryValue* options) {
  const char kNoProxy[] = "noProxy";
  const char kFtpProxy[] = "ftpProxy";
  const char kHttpProxy[] = "httpProxy";
  const char kSslProxy[] = "sslProxy";

  std::set<std::string> proxy_servers_options;
  proxy_servers_options.insert(kFtpProxy);
  proxy_servers_options.insert(kHttpProxy);
  proxy_servers_options.insert(kSslProxy);

  Error* error = NULL;
  const Value* option = NULL;
  bool has_manual_settings = false;
  if (options->Get(kNoProxy, &option) && !option->IsType(Value::TYPE_NULL)) {
    error = ParseNoProxy(option);
    if (error)
      return error;
    has_manual_settings = true;
  }

  std::vector<std::string> proxy_servers;
  std::set<std::string>::const_iterator iter = proxy_servers_options.begin();
  for (; iter != proxy_servers_options.end(); ++iter) {
    if (options->Get(*iter, &option) && !option->IsType(Value::TYPE_NULL)) {
      std::string value;
      if (!option->GetAsString(&value))
        return CreateBadInputError(*iter, Value::TYPE_STRING, option);
      has_manual_settings = true;
      // Converts into Chrome proxy scheme.
      // Example: "http=localhost:9000;ftp=localhost:8000".
      if (*iter == kFtpProxy)
        value = "ftp=" + value;
      if (*iter == kHttpProxy)
        value = "http=" + value;
      if (*iter == kSslProxy)
        value = "https=" + value;
      proxy_servers.push_back(value);
    }
  }

  if (!has_manual_settings)
    return new Error(kBadRequest, "proxyType is 'manual' but no manual "
                                  "proxy capabilities were found.");

  std::string proxy_server_value = JoinString(proxy_servers, ';');
  caps_->command.AppendSwitchASCII(switches::kProxyServer, proxy_server_value);

  return NULL;
}

Error* CapabilitiesParser::ParseNoProxy(const base::Value* option){
  std::string proxy_bypass_list;
  if (!option->GetAsString(&proxy_bypass_list))
    return CreateBadInputError("noProxy", Value::TYPE_STRING, option);
  if (!proxy_bypass_list.empty())
    caps_->command.AppendSwitchASCII(switches::kProxyBypassList,
                                     proxy_bypass_list);
  return NULL;
}

Error* CapabilitiesParser::ParseNoWebsiteTestingDefaults(const Value* option) {
  if (!option->GetAsBoolean(&caps_->no_website_testing_defaults))
    return CreateBadInputError("noWebsiteTestingDefaults",
                               Value::TYPE_BOOLEAN, option);
  return NULL;
}

Error* CapabilitiesParser::ParseExcludeSwitches(const Value* option) {
  const base::ListValue* switches;
  if (!option->GetAsList(&switches))
    return CreateBadInputError("excludeSwitches", Value::TYPE_LIST,
                               option);
  for (size_t i = 0; i < switches->GetSize(); ++i) {
    std::string switch_name;
    if (!switches->GetString(i, &switch_name)) {
      return new Error(kBadRequest,
                       "Each switch to be removed must be a string");
    }
    caps_->exclude_switches.insert(switch_name);
  }
  return NULL;
}

}  // namespace webdriver