| // Copyright (c) 2013 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/chromedriver/capabilities.h" |
| |
| #include <map> |
| #include <utility> |
| |
| #include "base/bind.h" |
| #include "base/callback.h" |
| #include "base/json/string_escape.h" |
| #include "base/logging.h" |
| #include "base/stl_util.h" |
| #include "base/strings/string_number_conversions.h" |
| #include "base/strings/string_split.h" |
| #include "base/strings/string_tokenizer.h" |
| #include "base/strings/string_util.h" |
| #include "base/strings/stringprintf.h" |
| #include "base/strings/utf_string_conversions.h" |
| #include "base/values.h" |
| #include "build/build_config.h" |
| #include "chrome/test/chromedriver/chrome/mobile_device.h" |
| #include "chrome/test/chromedriver/chrome/page_load_strategy.h" |
| #include "chrome/test/chromedriver/chrome/status.h" |
| #include "chrome/test/chromedriver/chrome/version.h" |
| #include "chrome/test/chromedriver/constants/version.h" |
| #include "chrome/test/chromedriver/logging.h" |
| #include "chrome/test/chromedriver/session.h" |
| #include "chrome/test/chromedriver/util.h" |
| |
| namespace { |
| |
| typedef base::RepeatingCallback<Status(const base::Value&, Capabilities*)> |
| Parser; |
| |
| Status ParseBoolean( |
| bool* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| if (!option.GetAsBoolean(to_set)) |
| return Status(kInvalidArgument, "must be a boolean"); |
| return Status(kOk); |
| } |
| |
| Status ParseString(std::string* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| std::string str; |
| if (!option.GetAsString(&str)) |
| return Status(kInvalidArgument, "must be a string"); |
| if (str.empty()) |
| return Status(kInvalidArgument, "cannot be empty"); |
| *to_set = str; |
| return Status(kOk); |
| } |
| |
| Status ParseInterval(int* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| int parsed_int = 0; |
| if (!option.GetAsInteger(&parsed_int)) |
| return Status(kInvalidArgument, "must be an integer"); |
| if (parsed_int <= 0) |
| return Status(kInvalidArgument, "must be positive"); |
| *to_set = parsed_int; |
| return Status(kOk); |
| } |
| |
| Status ParseTimeDelta(base::TimeDelta* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| int milliseconds = 0; |
| if (!option.GetAsInteger(&milliseconds)) |
| return Status(kInvalidArgument, "must be an integer"); |
| if (milliseconds < 0) |
| return Status(kInvalidArgument, "must be positive or zero"); |
| *to_set = base::TimeDelta::FromMilliseconds(milliseconds); |
| return Status(kOk); |
| } |
| |
| Status ParseFilePath(base::FilePath* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| base::FilePath::StringType str; |
| if (!option.GetAsString(&str)) |
| return Status(kInvalidArgument, "must be a string"); |
| *to_set = base::FilePath(str); |
| return Status(kOk); |
| } |
| |
| Status ParseDict(std::unique_ptr<base::DictionaryValue>* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* dict = NULL; |
| if (!option.GetAsDictionary(&dict)) |
| return Status(kInvalidArgument, "must be a dictionary"); |
| to_set->reset(dict->DeepCopy()); |
| return Status(kOk); |
| } |
| |
| Status IgnoreDeprecatedOption( |
| const char* option_name, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| LOG(WARNING) << "Deprecated " << base::ToLowerASCII(kBrowserShortName) |
| << " option is ignored: " << option_name; |
| return Status(kOk); |
| } |
| |
| Status IgnoreCapability(const base::Value& option, Capabilities* capabilities) { |
| return Status(kOk); |
| } |
| |
| Status ParseLogPath(const base::Value& option, Capabilities* capabilities) { |
| if (!option.GetAsString(&capabilities->log_path)) |
| return Status(kInvalidArgument, "must be a string"); |
| return Status(kOk); |
| } |
| |
| Status ParseDeviceName(const std::string& device_name, |
| Capabilities* capabilities) { |
| std::unique_ptr<MobileDevice> device; |
| Status status = FindMobileDevice(device_name, &device); |
| |
| if (status.IsError()) { |
| return Status(kInvalidArgument, |
| "'" + device_name + "' must be a valid device", status); |
| } |
| |
| capabilities->device_metrics = std::move(device->device_metrics); |
| // Don't override the user agent if blank (like for notebooks). |
| if (!device->user_agent.empty()) |
| capabilities->switches.SetSwitch("user-agent", device->user_agent); |
| |
| return Status(kOk); |
| } |
| |
| Status ParseMobileEmulation(const base::Value& option, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* mobile_emulation; |
| if (!option.GetAsDictionary(&mobile_emulation)) |
| return Status(kInvalidArgument, "'mobileEmulation' must be a dictionary"); |
| |
| if (mobile_emulation->HasKey("deviceName")) { |
| // Cannot use any other options with deviceName. |
| if (mobile_emulation->size() > 1) |
| return Status(kInvalidArgument, "'deviceName' must be used alone"); |
| |
| std::string device_name; |
| if (!mobile_emulation->GetString("deviceName", &device_name)) |
| return Status(kInvalidArgument, "'deviceName' must be a string"); |
| |
| return ParseDeviceName(device_name, capabilities); |
| } |
| |
| if (mobile_emulation->HasKey("deviceMetrics")) { |
| const base::DictionaryValue* metrics; |
| if (!mobile_emulation->GetDictionary("deviceMetrics", &metrics)) |
| return Status(kInvalidArgument, "'deviceMetrics' must be a dictionary"); |
| |
| int width = 0; |
| int height = 0; |
| double device_scale_factor = 0; |
| bool touch = true; |
| bool mobile = true; |
| |
| if (metrics->HasKey("width") && !metrics->GetInteger("width", &width)) |
| return Status(kInvalidArgument, "'width' must be an integer"); |
| |
| if (metrics->HasKey("height") && !metrics->GetInteger("height", &height)) |
| return Status(kInvalidArgument, "'height' must be an integer"); |
| |
| if (metrics->HasKey("pixelRatio") && |
| !metrics->GetDouble("pixelRatio", &device_scale_factor)) |
| return Status(kInvalidArgument, "'pixelRatio' must be a double"); |
| |
| if (metrics->HasKey("touch") && !metrics->GetBoolean("touch", &touch)) |
| return Status(kInvalidArgument, "'touch' must be a boolean"); |
| |
| if (metrics->HasKey("mobile") && !metrics->GetBoolean("mobile", &mobile)) |
| return Status(kInvalidArgument, "'mobile' must be a boolean"); |
| |
| DeviceMetrics* device_metrics = |
| new DeviceMetrics(width, height, device_scale_factor, touch, mobile); |
| capabilities->device_metrics = |
| std::unique_ptr<DeviceMetrics>(device_metrics); |
| } |
| |
| if (mobile_emulation->HasKey("userAgent")) { |
| std::string user_agent; |
| if (!mobile_emulation->GetString("userAgent", &user_agent)) |
| return Status(kInvalidArgument, "'userAgent' must be a string"); |
| |
| capabilities->switches.SetSwitch("user-agent", user_agent); |
| } |
| |
| return Status(kOk); |
| } |
| |
| Status ParsePageLoadStrategy(const base::Value& option, |
| Capabilities* capabilities) { |
| if (!option.GetAsString(&capabilities->page_load_strategy)) |
| return Status(kInvalidArgument, "'pageLoadStrategy' must be a string"); |
| if (capabilities->page_load_strategy == PageLoadStrategy::kNone || |
| capabilities->page_load_strategy == PageLoadStrategy::kEager || |
| capabilities->page_load_strategy == PageLoadStrategy::kNormal) |
| return Status(kOk); |
| return Status(kInvalidArgument, "invalid 'pageLoadStrategy'"); |
| } |
| |
| Status ParseUnhandledPromptBehavior(const base::Value& option, |
| Capabilities* capabilities) { |
| if (!option.GetAsString(&capabilities->unhandled_prompt_behavior)) |
| return Status(kInvalidArgument, |
| "'unhandledPromptBehavior' must be a string"); |
| if (capabilities->unhandled_prompt_behavior == kDismiss || |
| capabilities->unhandled_prompt_behavior == kAccept || |
| capabilities->unhandled_prompt_behavior == kDismissAndNotify || |
| capabilities->unhandled_prompt_behavior == kAcceptAndNotify || |
| capabilities->unhandled_prompt_behavior == kIgnore) |
| return Status(kOk); |
| return Status(kInvalidArgument, "invalid 'unhandledPromptBehavior'"); |
| } |
| |
| Status ParseTimeouts(const base::Value& option, Capabilities* capabilities) { |
| const base::DictionaryValue* timeouts; |
| if (!option.GetAsDictionary(&timeouts)) |
| return Status(kInvalidArgument, "'timeouts' must be a JSON object"); |
| for (const auto& it : timeouts->DictItems()) { |
| int64_t timeout_ms_int64 = -1; |
| base::TimeDelta timeout; |
| const std::string& type = it.first; |
| if (it.second.is_none()) { |
| if (type == "script") |
| timeout = base::TimeDelta::Max(); |
| else |
| return Status(kInvalidArgument, "timeout can not be null"); |
| } else { |
| if (!GetOptionalSafeInt(timeouts, it.first, &timeout_ms_int64) || |
| timeout_ms_int64 < 0) |
| return Status(kInvalidArgument, "value must be a non-negative integer"); |
| else |
| timeout = base::TimeDelta::FromMilliseconds(timeout_ms_int64); |
| } |
| if (type == "script") { |
| capabilities->script_timeout = timeout; |
| } else if (type == "pageLoad") { |
| capabilities->page_load_timeout = timeout; |
| } else if (type == "implicit") { |
| capabilities->implicit_wait_timeout = timeout; |
| } else { |
| return Status(kInvalidArgument, |
| "unrecognized 'timeouts' option: " + type); |
| } |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseSwitches(const base::Value& option, |
| Capabilities* capabilities) { |
| const base::ListValue* switches_list = NULL; |
| if (!option.GetAsList(&switches_list)) |
| return Status(kInvalidArgument, "must be a list"); |
| for (size_t i = 0; i < switches_list->GetSize(); ++i) { |
| std::string arg_string; |
| if (!switches_list->GetString(i, &arg_string)) |
| return Status(kInvalidArgument, "each argument must be a string"); |
| base::TrimWhitespaceASCII(arg_string, base::TRIM_ALL, &arg_string); |
| if (arg_string.empty() || arg_string == "--") |
| return Status(kInvalidArgument, "argument is empty"); |
| capabilities->switches.SetUnparsedSwitch(arg_string); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseExtensions(const base::Value& option, Capabilities* capabilities) { |
| const base::ListValue* extensions = NULL; |
| if (!option.GetAsList(&extensions)) |
| return Status(kInvalidArgument, "must be a list"); |
| for (size_t i = 0; i < extensions->GetSize(); ++i) { |
| std::string extension; |
| if (!extensions->GetString(i, &extension)) { |
| return Status(kInvalidArgument, |
| "each extension must be a base64 encoded string"); |
| } |
| capabilities->extensions.push_back(extension); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseProxy(bool w3c_compliant, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* proxy_dict; |
| if (!option.GetAsDictionary(&proxy_dict)) |
| return Status(kInvalidArgument, "must be a dictionary"); |
| std::string proxy_type; |
| if (!proxy_dict->GetString("proxyType", &proxy_type)) |
| return Status(kInvalidArgument, "'proxyType' must be a string"); |
| if (!w3c_compliant) |
| proxy_type = base::ToLowerASCII(proxy_type); |
| if (proxy_type == "direct") { |
| capabilities->switches.SetSwitch("no-proxy-server"); |
| } else if (proxy_type == "system") { |
| // Chrome default. |
| } else if (proxy_type == "pac") { |
| base::CommandLine::StringType proxy_pac_url; |
| if (!proxy_dict->GetString("proxyAutoconfigUrl", &proxy_pac_url)) |
| return Status(kInvalidArgument, "'proxyAutoconfigUrl' must be a string"); |
| capabilities->switches.SetSwitch("proxy-pac-url", proxy_pac_url); |
| } else if (proxy_type == "autodetect") { |
| capabilities->switches.SetSwitch("proxy-auto-detect"); |
| } else if (proxy_type == "manual") { |
| const char* const proxy_servers_options[][2] = { |
| {"ftpProxy", "ftp"}, {"httpProxy", "http"}, {"sslProxy", "https"}, |
| {"socksProxy", "socks"}}; |
| const std::string kSocksProxy = "socksProxy"; |
| const base::Value* option_value = NULL; |
| std::string proxy_servers; |
| for (size_t i = 0; i < base::size(proxy_servers_options); ++i) { |
| if (!proxy_dict->Get(proxy_servers_options[i][0], &option_value) || |
| option_value->is_none()) { |
| continue; |
| } |
| std::string value; |
| if (!option_value->GetAsString(&value)) { |
| return Status( |
| kInvalidArgument, |
| base::StringPrintf("'%s' must be a string", |
| proxy_servers_options[i][0])); |
| } |
| if (proxy_servers_options[i][0] == kSocksProxy) { |
| int socksVersion; |
| if (!proxy_dict->GetInteger("socksVersion", &socksVersion)) |
| return Status( |
| kInvalidArgument, |
| "Specifying 'socksProxy' requires an integer for 'socksVersion'"); |
| if (socksVersion < 0 || socksVersion > 255) |
| return Status( |
| kInvalidArgument, |
| "'socksVersion' must be between 0 and 255"); |
| value = base::StringPrintf("socks%d://%s", socksVersion, value.c_str()); |
| } |
| // Converts into Chrome proxy scheme. |
| // Example: "http=localhost:9000;ftp=localhost:8000". |
| if (!proxy_servers.empty()) |
| proxy_servers += ";"; |
| proxy_servers += base::StringPrintf( |
| "%s=%s", proxy_servers_options[i][1], value.c_str()); |
| } |
| |
| std::string proxy_bypass_list; |
| if (proxy_dict->Get("noProxy", &option_value) && !option_value->is_none()) { |
| // W3C requires noProxy to be a list of strings, while legacy protocol |
| // requires noProxy to be a string of comma-separated items. |
| // In practice, library implementations are not always consistent, |
| // so we accept both formats regardless of the W3C mode setting. |
| if (option_value->is_list()) { |
| for (const base::Value& item : option_value->GetList()) { |
| if (!item.is_string()) |
| return Status(kInvalidArgument, |
| "'noProxy' must be a list of strings"); |
| if (!proxy_bypass_list.empty()) |
| proxy_bypass_list += ","; |
| proxy_bypass_list += item.GetString(); |
| } |
| } else if (option_value->is_string()) { |
| proxy_bypass_list = option_value->GetString(); |
| } else { |
| return Status(kInvalidArgument, "'noProxy' must be a list or a string"); |
| } |
| } |
| |
| // W3C doesn't require specifying any proxy servers even when proxyType is |
| // manual, even though such a setting would be useless. |
| if (!proxy_servers.empty()) |
| capabilities->switches.SetSwitch("proxy-server", proxy_servers); |
| if (!proxy_bypass_list.empty()) { |
| capabilities->switches.SetSwitch("proxy-bypass-list", |
| proxy_bypass_list); |
| } |
| } else { |
| return Status(kInvalidArgument, "unrecognized proxy type: " + proxy_type); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseExcludeSwitches(const base::Value& option, |
| Capabilities* capabilities) { |
| const base::ListValue* switches = NULL; |
| if (!option.GetAsList(&switches)) |
| return Status(kInvalidArgument, "must be a list"); |
| for (size_t i = 0; i < switches->GetSize(); ++i) { |
| std::string switch_name; |
| if (!switches->GetString(i, &switch_name)) { |
| return Status(kInvalidArgument, |
| "each switch to be removed must be a string"); |
| } |
| if (switch_name.substr(0, 2) == "--") |
| switch_name = switch_name.substr(2); |
| capabilities->exclude_switches.insert(switch_name); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseNetAddress(NetAddress* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| std::string server_addr; |
| if (!option.GetAsString(&server_addr)) |
| return Status(kInvalidArgument, "must be 'host:port'"); |
| |
| std::vector<std::string> values = base::SplitString( |
| server_addr, ":", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL); |
| if (values.size() != 2) |
| return Status(kInvalidArgument, "must be 'host:port'"); |
| |
| int port = 0; |
| base::StringToInt(values[1], &port); |
| if (port <= 0) |
| return Status(kInvalidArgument, "port must be > 0"); |
| |
| *to_set = NetAddress(values[0], port); |
| return Status(kOk); |
| } |
| |
| Status ParseLoggingPrefs(const base::Value& option, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* logging_prefs = NULL; |
| if (!option.GetAsDictionary(&logging_prefs)) |
| return Status(kInvalidArgument, "must be a dictionary"); |
| |
| for (base::DictionaryValue::Iterator pref(*logging_prefs); |
| !pref.IsAtEnd(); pref.Advance()) { |
| std::string type = pref.key(); |
| Log::Level level; |
| std::string level_name; |
| if (!pref.value().GetAsString(&level_name) || |
| !WebDriverLog::NameToLevel(level_name, &level)) { |
| return Status(kInvalidArgument, |
| "invalid log level for '" + type + "' log"); |
| } |
| capabilities->logging_prefs.insert(std::make_pair(type, level)); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseInspectorDomainStatus( |
| PerfLoggingPrefs::InspectorDomainStatus* to_set, |
| const base::Value& option, |
| Capabilities* capabilities) { |
| bool desired_value; |
| if (!option.GetAsBoolean(&desired_value)) |
| return Status(kInvalidArgument, "must be a boolean"); |
| if (desired_value) |
| *to_set = PerfLoggingPrefs::InspectorDomainStatus::kExplicitlyEnabled; |
| else |
| *to_set = PerfLoggingPrefs::InspectorDomainStatus::kExplicitlyDisabled; |
| return Status(kOk); |
| } |
| |
| Status ParsePerfLoggingPrefs(const base::Value& option, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* perf_logging_prefs = NULL; |
| if (!option.GetAsDictionary(&perf_logging_prefs)) |
| return Status(kInvalidArgument, "must be a dictionary"); |
| |
| std::map<std::string, Parser> parser_map; |
| parser_map["bufferUsageReportingInterval"] = base::BindRepeating( |
| &ParseInterval, |
| &capabilities->perf_logging_prefs.buffer_usage_reporting_interval); |
| parser_map["enableNetwork"] = base::BindRepeating( |
| &ParseInspectorDomainStatus, &capabilities->perf_logging_prefs.network); |
| parser_map["enablePage"] = base::BindRepeating( |
| &ParseInspectorDomainStatus, &capabilities->perf_logging_prefs.page); |
| parser_map["traceCategories"] = base::BindRepeating( |
| &ParseString, &capabilities->perf_logging_prefs.trace_categories); |
| |
| for (base::DictionaryValue::Iterator it(*perf_logging_prefs); !it.IsAtEnd(); |
| it.Advance()) { |
| if (parser_map.find(it.key()) == parser_map.end()) |
| return Status(kInvalidArgument, |
| "unrecognized performance logging option: " + it.key()); |
| Status status = parser_map[it.key()].Run(it.value(), capabilities); |
| if (status.IsError()) |
| return Status(kInvalidArgument, "cannot parse " + it.key(), status); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseDevToolsEventsLoggingPrefs(const base::Value& option, |
| Capabilities* capabilities) { |
| const base::ListValue* devtools_events_logging_prefs = nullptr; |
| if (!option.GetAsList(&devtools_events_logging_prefs)) |
| return Status(kInvalidArgument, "must be a list"); |
| if (devtools_events_logging_prefs->empty()) |
| return Status(kInvalidArgument, "list must contain values"); |
| capabilities->devtools_events_logging_prefs.reset( |
| devtools_events_logging_prefs->DeepCopy()); |
| return Status(kOk); |
| } |
| |
| Status ParseWindowTypes(const base::Value& option, Capabilities* capabilities) { |
| const base::ListValue* window_types = NULL; |
| if (!option.GetAsList(&window_types)) |
| return Status(kInvalidArgument, "must be a list"); |
| std::set<WebViewInfo::Type> window_types_tmp; |
| for (size_t i = 0; i < window_types->GetSize(); ++i) { |
| std::string window_type; |
| if (!window_types->GetString(i, &window_type)) { |
| return Status(kInvalidArgument, "each window type must be a string"); |
| } |
| WebViewInfo::Type type; |
| Status status = ParseType(window_type, &type); |
| if (status.IsError()) |
| return status; |
| window_types_tmp.insert(type); |
| } |
| capabilities->window_types.swap(window_types_tmp); |
| return Status(kOk); |
| } |
| |
| Status ParseChromeOptions( |
| const base::Value& capability, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* chrome_options = NULL; |
| if (!capability.GetAsDictionary(&chrome_options)) |
| return Status(kInvalidArgument, "must be a dictionary"); |
| |
| bool is_android = chrome_options->HasKey("androidPackage"); |
| bool is_remote = chrome_options->HasKey("debuggerAddress"); |
| |
| std::map<std::string, Parser> parser_map; |
| // Ignore 'args', 'binary' and 'extensions' capabilities by default, since the |
| // Java client always passes them. |
| parser_map["args"] = base::BindRepeating(&IgnoreCapability); |
| parser_map["binary"] = base::BindRepeating(&IgnoreCapability); |
| parser_map["extensions"] = base::BindRepeating(&IgnoreCapability); |
| |
| parser_map["perfLoggingPrefs"] = base::BindRepeating(&ParsePerfLoggingPrefs); |
| parser_map["devToolsEventsToLog"] = |
| base::BindRepeating(&ParseDevToolsEventsLoggingPrefs); |
| parser_map["windowTypes"] = base::BindRepeating(&ParseWindowTypes); |
| // Compliance is read when session is initialized and correct response is |
| // sent if not parsed correctly. |
| parser_map["w3c"] = base::BindRepeating(&IgnoreCapability); |
| |
| parser_map["useUnsupportedLaunchAppDeprecationWorkaround"] = |
| base::BindRepeating(&ParseBoolean, &capabilities->enable_launch_app); |
| |
| if (is_android) { |
| parser_map["androidActivity"] = |
| base::BindRepeating(&ParseString, &capabilities->android_activity); |
| parser_map["androidDeviceSerial"] = |
| base::BindRepeating(&ParseString, &capabilities->android_device_serial); |
| parser_map["androidPackage"] = |
| base::BindRepeating(&ParseString, &capabilities->android_package); |
| parser_map["androidProcess"] = |
| base::BindRepeating(&ParseString, &capabilities->android_process); |
| parser_map["androidExecName"] = |
| base::BindRepeating(&ParseString, &capabilities->android_exec_name); |
| parser_map["androidDeviceSocket"] = |
| base::BindRepeating(&ParseString, &capabilities->android_device_socket); |
| parser_map["androidUseRunningApp"] = base::BindRepeating( |
| &ParseBoolean, &capabilities->android_use_running_app); |
| parser_map["args"] = base::BindRepeating(&ParseSwitches); |
| parser_map["excludeSwitches"] = base::BindRepeating(&ParseExcludeSwitches); |
| parser_map["loadAsync"] = |
| base::BindRepeating(&IgnoreDeprecatedOption, "loadAsync"); |
| } else if (is_remote) { |
| parser_map["debuggerAddress"] = |
| base::BindRepeating(&ParseNetAddress, &capabilities->debugger_address); |
| } else { |
| parser_map["args"] = base::BindRepeating(&ParseSwitches); |
| parser_map["binary"] = |
| base::BindRepeating(&ParseFilePath, &capabilities->binary); |
| parser_map["detach"] = |
| base::BindRepeating(&ParseBoolean, &capabilities->detach); |
| parser_map["excludeSwitches"] = base::BindRepeating(&ParseExcludeSwitches); |
| parser_map["extensions"] = base::BindRepeating(&ParseExtensions); |
| parser_map["extensionLoadTimeout"] = base::BindRepeating( |
| &ParseTimeDelta, &capabilities->extension_load_timeout); |
| parser_map["loadAsync"] = |
| base::BindRepeating(&IgnoreDeprecatedOption, "loadAsync"); |
| parser_map["localState"] = |
| base::BindRepeating(&ParseDict, &capabilities->local_state); |
| parser_map["logPath"] = base::BindRepeating(&ParseLogPath); |
| parser_map["minidumpPath"] = |
| base::BindRepeating(&ParseString, &capabilities->minidump_path); |
| parser_map["mobileEmulation"] = base::BindRepeating(&ParseMobileEmulation); |
| parser_map["prefs"] = base::BindRepeating(&ParseDict, &capabilities->prefs); |
| parser_map["useAutomationExtension"] = base::BindRepeating( |
| &ParseBoolean, &capabilities->use_automation_extension); |
| } |
| |
| for (base::DictionaryValue::Iterator it(*chrome_options); !it.IsAtEnd(); |
| it.Advance()) { |
| if (parser_map.find(it.key()) == parser_map.end()) { |
| return Status( |
| kInvalidArgument, |
| base::StringPrintf("unrecognized %s option: %s", |
| base::ToLowerASCII(kBrowserShortName).c_str(), |
| it.key().c_str())); |
| } |
| Status status = parser_map[it.key()].Run(it.value(), capabilities); |
| if (status.IsError()) |
| return Status(kInvalidArgument, "cannot parse " + it.key(), status); |
| } |
| return Status(kOk); |
| } |
| |
| Status ParseSeleniumOptions( |
| const base::Value& capability, |
| Capabilities* capabilities) { |
| const base::DictionaryValue* selenium_options = NULL; |
| if (!capability.GetAsDictionary(&selenium_options)) |
| return Status(kInvalidArgument, "must be a dictionary"); |
| std::map<std::string, Parser> parser_map; |
| parser_map["loggingPrefs"] = base::BindRepeating(&ParseLoggingPrefs); |
| |
| for (base::DictionaryValue::Iterator it(*selenium_options); !it.IsAtEnd(); |
| it.Advance()) { |
| if (parser_map.find(it.key()) == parser_map.end()) |
| continue; |
| Status status = parser_map[it.key()].Run(it.value(), capabilities); |
| if (status.IsError()) |
| return Status(kInvalidArgument, "cannot parse " + it.key(), status); |
| } |
| return Status(kOk); |
| } |
| } // namespace |
| |
| bool GetChromeOptionsDictionary(const base::DictionaryValue& params, |
| const base::DictionaryValue** out) { |
| if (params.GetDictionary(kChromeDriverOptionsKeyPrefixed, out)) { |
| return true; |
| } |
| return params.GetDictionary(kChromeDriverOptionsKey, out); |
| } |
| |
| Switches::Switches() {} |
| |
| Switches::Switches(const Switches& other) = default; |
| |
| Switches::~Switches() {} |
| |
| void Switches::SetSwitch(const std::string& name) { |
| SetSwitch(name, NativeString()); |
| } |
| |
| void Switches::SetSwitch(const std::string& name, const std::string& value) { |
| #if defined(OS_WIN) |
| SetSwitch(name, base::UTF8ToUTF16(value)); |
| #else |
| switch_map_[name] = value; |
| #endif |
| } |
| |
| void Switches::SetSwitch(const std::string& name, const base::string16& value) { |
| #if defined(OS_WIN) |
| switch_map_[name] = value; |
| #else |
| SetSwitch(name, base::UTF16ToUTF8(value)); |
| #endif |
| } |
| |
| void Switches::SetSwitch(const std::string& name, const base::FilePath& value) { |
| SetSwitch(name, value.value()); |
| } |
| |
| void Switches::SetFromSwitches(const Switches& switches) { |
| for (auto iter = switches.switch_map_.begin(); |
| iter != switches.switch_map_.end(); ++iter) { |
| switch_map_[iter->first] = iter->second; |
| } |
| } |
| |
| void Switches::SetUnparsedSwitch(const std::string& unparsed_switch) { |
| std::string value; |
| size_t equals_index = unparsed_switch.find('='); |
| if (equals_index != std::string::npos) |
| value = unparsed_switch.substr(equals_index + 1); |
| |
| std::string name; |
| size_t start_index = 0; |
| if (unparsed_switch.substr(0, 2) == "--") |
| start_index = 2; |
| name = unparsed_switch.substr(start_index, equals_index - start_index); |
| |
| SetSwitch(name, value); |
| } |
| |
| void Switches::RemoveSwitch(const std::string& name) { |
| switch_map_.erase(name); |
| } |
| |
| bool Switches::HasSwitch(const std::string& name) const { |
| return switch_map_.count(name) > 0; |
| } |
| |
| std::string Switches::GetSwitchValue(const std::string& name) const { |
| NativeString value = GetSwitchValueNative(name); |
| #if defined(OS_WIN) |
| return base::UTF16ToUTF8(value); |
| #else |
| return value; |
| #endif |
| } |
| |
| Switches::NativeString Switches::GetSwitchValueNative( |
| const std::string& name) const { |
| auto iter = switch_map_.find(name); |
| if (iter == switch_map_.end()) |
| return NativeString(); |
| return iter->second; |
| } |
| |
| size_t Switches::GetSize() const { |
| return switch_map_.size(); |
| } |
| |
| void Switches::AppendToCommandLine(base::CommandLine* command) const { |
| for (auto iter = switch_map_.begin(); iter != switch_map_.end(); ++iter) { |
| command->AppendSwitchNative(iter->first, iter->second); |
| } |
| } |
| |
| std::string Switches::ToString() const { |
| std::string str; |
| auto iter = switch_map_.begin(); |
| while (iter != switch_map_.end()) { |
| str += "--" + iter->first; |
| std::string value = GetSwitchValue(iter->first); |
| if (value.length()) { |
| if (value.find(' ') != std::string::npos) |
| value = base::GetQuotedJSONString(value); |
| str += "=" + value; |
| } |
| ++iter; |
| if (iter == switch_map_.end()) |
| break; |
| str += " "; |
| } |
| return str; |
| } |
| |
| PerfLoggingPrefs::PerfLoggingPrefs() |
| : network(InspectorDomainStatus::kDefaultEnabled), |
| page(InspectorDomainStatus::kDefaultEnabled), |
| trace_categories(), |
| buffer_usage_reporting_interval(1000) {} |
| |
| PerfLoggingPrefs::~PerfLoggingPrefs() {} |
| |
| Capabilities::Capabilities() |
| : accept_insecure_certs(false), |
| page_load_strategy(PageLoadStrategy::kNormal), |
| strict_file_interactability(false), |
| android_use_running_app(false), |
| detach(false), |
| extension_load_timeout(base::TimeDelta::FromSeconds(10)), |
| network_emulation_enabled(false), |
| use_automation_extension(true), |
| enable_launch_app(false) {} |
| |
| Capabilities::~Capabilities() {} |
| |
| bool Capabilities::IsAndroid() const { |
| return !android_package.empty(); |
| } |
| |
| bool Capabilities::IsRemoteBrowser() const { |
| return debugger_address.IsValid(); |
| } |
| |
| Status Capabilities::Parse(const base::DictionaryValue& desired_caps, |
| bool w3c_compliant) { |
| std::map<std::string, Parser> parser_map; |
| |
| // W3C defined capabilities. |
| parser_map["acceptInsecureCerts"] = |
| base::BindRepeating(&ParseBoolean, &accept_insecure_certs); |
| parser_map["browserName"] = base::BindRepeating(&ParseString, &browser_name); |
| parser_map["browserVersion"] = |
| base::BindRepeating(&ParseString, &browser_version); |
| parser_map["platformName"] = |
| base::BindRepeating(&ParseString, &platform_name); |
| parser_map["pageLoadStrategy"] = base::BindRepeating(&ParsePageLoadStrategy); |
| parser_map["proxy"] = base::BindRepeating(&ParseProxy, w3c_compliant); |
| parser_map["timeouts"] = base::BindRepeating(&ParseTimeouts); |
| parser_map["strictFileInteractability"] = |
| base::BindRepeating(&ParseBoolean, &strict_file_interactability); |
| if (!w3c_compliant) { |
| // TODO(https://crbug.com/chromedriver/2596): "unexpectedAlertBehaviour" is |
| // legacy name of "unhandledPromptBehavior", remove when we stop supporting |
| // legacy mode. |
| parser_map["unexpectedAlertBehaviour"] = |
| base::BindRepeating(&ParseUnhandledPromptBehavior); |
| } |
| parser_map["unhandledPromptBehavior"] = |
| base::BindRepeating(&ParseUnhandledPromptBehavior); |
| |
| // W3C defined extension capabilities. |
| // See https://w3c.github.io/webauthn/#sctn-automation-webdriver-capability |
| parser_map["webauthn:virtualAuthenticators"] = |
| base::BindRepeating(&ParseBoolean, nullptr); |
| |
| // ChromeDriver specific capabilities. |
| // Vendor-prefixed is the current spec conformance, but unprefixed is |
| // still supported in legacy mode. |
| if (w3c_compliant || |
| desired_caps.GetDictionary(kChromeDriverOptionsKeyPrefixed, nullptr)) { |
| parser_map[kChromeDriverOptionsKeyPrefixed] = |
| base::BindRepeating(&ParseChromeOptions); |
| } else { |
| parser_map[kChromeDriverOptionsKey] = |
| base::BindRepeating(&ParseChromeOptions); |
| } |
| // se:options.loggingPrefs and goog:loggingPrefs is spec-compliant name, |
| // but loggingPrefs is still supported in legacy mode. |
| const std::string prefixedLoggingPrefsKey = |
| base::StringPrintf("%s:loggingPrefs", kChromeDriverCompanyPrefix); |
| if (desired_caps.GetDictionary("se:options.loggingPrefs", nullptr)) { |
| parser_map["se:options"] = base::BindRepeating(&ParseSeleniumOptions); |
| } else if (w3c_compliant || |
| desired_caps.GetDictionary(prefixedLoggingPrefsKey, nullptr)) { |
| parser_map[prefixedLoggingPrefsKey] = |
| base::BindRepeating(&ParseLoggingPrefs); |
| } else { |
| parser_map["loggingPrefs"] = base::BindRepeating(&ParseLoggingPrefs); |
| } |
| // Network emulation requires device mode, which is only enabled when |
| // mobile emulation is on. |
| |
| const base::DictionaryValue* chrome_options = nullptr; |
| if (GetChromeOptionsDictionary(desired_caps, &chrome_options) && |
| chrome_options->GetDictionary("mobileEmulation", nullptr)) { |
| parser_map["networkConnectionEnabled"] = |
| base::BindRepeating(&ParseBoolean, &network_emulation_enabled); |
| } |
| |
| for (base::DictionaryValue::Iterator it(desired_caps); !it.IsAtEnd(); |
| it.Advance()) { |
| if (it.value().is_none()) |
| continue; |
| if (parser_map.find(it.key()) == parser_map.end()) { |
| // The specified capability is unrecognized. W3C spec requires us to |
| // return an error if capability does not contain ":". |
| // In legacy mode, for backward compatibility reasons, |
| // we ignore unrecognized capabilities. |
| if (w3c_compliant && it.key().find(':') == std::string::npos) |
| return Status(kInvalidArgument, "unrecognized capability: " + it.key()); |
| else |
| continue; |
| } |
| Status status = parser_map[it.key()].Run(it.value(), this); |
| if (status.IsError()) { |
| return Status(kInvalidArgument, "cannot parse capability: " + it.key(), |
| status); |
| } |
| } |
| // Perf log must be enabled if perf log prefs are specified; otherwise, error. |
| LoggingPrefs::const_iterator iter = logging_prefs.find( |
| WebDriverLog::kPerformanceType); |
| if (iter == logging_prefs.end() || iter->second == Log::kOff) { |
| const base::DictionaryValue* chrome_options = nullptr; |
| if (GetChromeOptionsDictionary(desired_caps, &chrome_options) && |
| chrome_options->HasKey("perfLoggingPrefs")) { |
| return Status(kInvalidArgument, |
| "perfLoggingPrefs specified, " |
| "but performance logging was not enabled"); |
| } |
| } |
| LoggingPrefs::const_iterator dt_events_logging_iter = logging_prefs.find( |
| WebDriverLog::kDevToolsType); |
| if (dt_events_logging_iter == logging_prefs.end() |
| || dt_events_logging_iter->second == Log::kOff) { |
| const base::DictionaryValue* chrome_options = nullptr; |
| if (GetChromeOptionsDictionary(desired_caps, &chrome_options) && |
| chrome_options->HasKey("devToolsEventsToLog")) { |
| return Status(kInvalidArgument, |
| "devToolsEventsToLog specified, " |
| "but devtools events logging was not enabled"); |
| } |
| } |
| return Status(kOk); |
| } |
