blob: 6dc924efd67d4539396e15f3aa91b9514fce73a9 [file] [log] [blame]
// 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 <stddef.h>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include "base/command_line.h"
#include "base/files/file_path.h"
#include "base/strings/string16.h"
#include "chrome/test/chromedriver/chrome/device_metrics.h"
#include "chrome/test/chromedriver/chrome/devtools_http_client.h"
#include "chrome/test/chromedriver/chrome/log.h"
#include "chrome/test/chromedriver/net/net_util.h"
#include "chrome/test/chromedriver/session.h"
namespace base {
class CommandLine;
class DictionaryValue;
class ListValue;
class Status;
class Switches {
typedef base::FilePath::StringType NativeString;
Switches(const Switches& other);
void SetSwitch(const std::string& name);
void SetSwitch(const std::string& name, const std::string& value);
void SetSwitch(const std::string& name, const base::string16& value);
void SetSwitch(const std::string& name, const base::FilePath& value);
// In case of same key, |switches| will override.
void SetFromSwitches(const Switches& switches);
// Sets a switch from the capabilities, of the form [--]name[=value].
void SetUnparsedSwitch(const std::string& unparsed_switch);
void RemoveSwitch(const std::string& name);
bool HasSwitch(const std::string& name) const;
std::string GetSwitchValue(const std::string& name) const;
NativeString GetSwitchValueNative(const std::string& name) const;
size_t GetSize() const;
void AppendToCommandLine(base::CommandLine* command) const;
std::string ToString() const;
typedef std::map<std::string, NativeString> SwitchMap;
SwitchMap switch_map_;
typedef std::map<std::string, Log::Level> LoggingPrefs;
struct PerfLoggingPrefs {
// We must distinguish between a log domain being set by default and being
// explicitly set. Otherwise, |PerformanceLogger| could only handle 3 of 4
// possible combinations (tracing enabled/disabled + Timeline on/off).
enum InspectorDomainStatus {
InspectorDomainStatus network;
InspectorDomainStatus page;
std::string trace_categories; // Non-empty string enables tracing.
int buffer_usage_reporting_interval; // ms between trace buffer usage events.
struct Capabilities {
// Return true if remote host:port session is to be used.
bool IsRemoteBrowser() const;
// Return true if android package is specified.
bool IsAndroid() const;
// Accepts all W3C defined capabilities
// and all ChromeDriver-specific extensions.
Status Parse(const base::DictionaryValue& desired_caps,
bool w3c_compliant = true);
// W3C defined capabilities
bool accept_insecure_certs;
std::string browser_name;
std::string browser_version;
std::string platform_name;
std::string page_load_strategy;
// Data from "proxy" capability are stored in "switches" field.
base::TimeDelta script_timeout = Session::kDefaultScriptTimeout;
base::TimeDelta page_load_timeout = Session::kDefaultPageLoadTimeout;
base::TimeDelta implicit_wait_timeout = Session::kDefaultImplicitWaitTimeout;
bool strict_file_interactability;
std::string unhandled_prompt_behavior;
// ChromeDriver specific capabilities
std::string android_activity;
std::string android_device_serial;
std::string android_package;
std::string android_process;
std::string android_device_socket;
std::string android_exec_name;
bool android_use_running_app;
base::FilePath binary;
// If provided, the remote debugging address to connect to.
NetAddress debugger_address;
// Whether the lifetime of the started Chrome browser process should be
// bound to ChromeDriver's process. If true, Chrome will not quit if
// ChromeDriver dies.
bool detach;
// Device metrics for use in Device Emulation.
std::unique_ptr<DeviceMetrics> device_metrics;
// Set of switches which should be removed from default list when launching
// Chrome.
std::set<std::string> exclude_switches;
std::vector<std::string> extensions;
// Time to wait for extension background page to appear. If 0, no waiting.
base::TimeDelta extension_load_timeout;
std::unique_ptr<base::DictionaryValue> local_state;
std::string log_path;
LoggingPrefs logging_prefs;
// If set, enable minidump for chrome crashes and save to this directory.
std::string minidump_path;
bool network_emulation_enabled;
PerfLoggingPrefs perf_logging_prefs;
std::unique_ptr<base::ListValue> devtools_events_logging_prefs;
std::unique_ptr<base::DictionaryValue> prefs;
Switches switches;
std::set<WebViewInfo::Type> window_types;
bool use_automation_extension;
// Temporary capability to enable LaunchApp command
// TODO remove with all LaunchApp code in m84.
// see
bool enable_launch_app;
bool GetChromeOptionsDictionary(const base::DictionaryValue& params,
const base::DictionaryValue** out);