chrome/test/chromedriver/capabilities.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_TEST_CHROMEDRIVER_CAPABILITIES_H_
   6 #define CHROME_TEST_CHROMEDRIVER_CAPABILITIES_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/command_line.h"
  14 #include "base/files/file_path.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/strings/string16.h"
  17 #include "chrome/test/chromedriver/chrome/device_metrics.h"
  18 #include "chrome/test/chromedriver/chrome/log.h"
  19 #include "chrome/test/chromedriver/net/net_util.h"
  20
  21 namespace base {
  22 class CommandLine;
  23 class DictionaryValue;
  24 }
  25
  26 class Status;
  27
  28 class Switches {
  29  public:
  30   typedef base::FilePath::StringType NativeString;
  31   Switches();
  32   ~Switches();
  33
  34   void SetSwitch(const std::string& name);
  35   void SetSwitch(const std::string& name, const std::string& value);
  36   void SetSwitch(const std::string& name, const base::string16& value);
  37   void SetSwitch(const std::string& name, const base::FilePath& value);
  38
  39   // In case of same key, |switches| will override.
  40   void SetFromSwitches(const Switches& switches);
  41
  42   // Sets a switch from the capabilities, of the form [--]name[=value].
  43   void SetUnparsedSwitch(const std::string& unparsed_switch);
  44
  45   void RemoveSwitch(const std::string& name);
  46
  47   bool HasSwitch(const std::string& name) const;
  48   std::string GetSwitchValue(const std::string& name) const;
  49   NativeString GetSwitchValueNative(const std::string& name) const;
  50
  51   size_t GetSize() const;
  52
  53   void AppendToCommandLine(base::CommandLine* command) const;
  54   std::string ToString() const;
  55
  56  private:
  57   typedef std::map<std::string, NativeString> SwitchMap;
  58   SwitchMap switch_map_;
  59 };
  60
  61 typedef std::map<std::string, Log::Level> LoggingPrefs;
  62
  63 struct PerfLoggingPrefs {
  64   PerfLoggingPrefs();
  65   ~PerfLoggingPrefs();
  66
  67   // We must distinguish between a log domain being set by default and being
  68   // explicitly set. Otherwise, |PerformanceLogger| could only handle 3 of 4
  69   // possible combinations (tracing enabled/disabled + Timeline on/off).
  70   enum InspectorDomainStatus {
  71     kDefaultEnabled,
  72     kDefaultDisabled,
  73     kExplicitlyEnabled,
  74     kExplicitlyDisabled
  75   };
  76
  77   InspectorDomainStatus network;
  78   InspectorDomainStatus page;
  79   // TODO(samuong): Timeline was removed in blink 189656 (chromium commit
  80   // position 315092) so remove this option once we stop supporting M41.
  81   InspectorDomainStatus timeline;
  82
  83   std::string trace_categories;  // Non-empty string enables tracing.
  84   int buffer_usage_reporting_interval;  // ms between trace buffer usage events.
  85 };
  86
  87 struct Capabilities {
  88   Capabilities();
  89   ~Capabilities();
  90
  91   // Return true if remote host:port session is to be used.
  92   bool IsRemoteBrowser() const;
  93
  94   // Return true if android package is specified.
  95   bool IsAndroid() const;
  96
  97   Status Parse(const base::DictionaryValue& desired_caps);
  98
  99   std::string android_activity;
 100
 101   std::string android_device_serial;
 102
 103   std::string android_package;
 104
 105   std::string android_process;
 106
 107   bool android_use_running_app;
 108
 109   base::FilePath binary;
 110
 111   // If provided, the remote debugging address to connect to.
 112   NetAddress debugger_address;
 113
 114   // Whether the lifetime of the started Chrome browser process should be
 115   // bound to ChromeDriver's process. If true, Chrome will not quit if
 116   // ChromeDriver dies.
 117   bool detach;
 118
 119   // Device metrics for use in Device Emulation.
 120   scoped_ptr<DeviceMetrics> device_metrics;
 121
 122   // Set of switches which should be removed from default list when launching
 123   // Chrome.
 124   std::set<std::string> exclude_switches;
 125
 126   std::vector<std::string> extensions;
 127
 128   // True if should always use DevTools for taking screenshots.
 129   // This is experimental and may be removed at a later point.
 130   bool force_devtools_screenshot;
 131
 132   scoped_ptr<base::DictionaryValue> local_state;
 133
 134   std::string log_path;
 135
 136   LoggingPrefs logging_prefs;
 137
 138   // If set, enable minidump for chrome crashes and save to this directory.
 139   std::string minidump_path;
 140
 141   PerfLoggingPrefs perf_logging_prefs;
 142
 143   scoped_ptr<base::DictionaryValue> prefs;
 144
 145   Switches switches;
 146 };
 147
 148 #endif  // CHROME_TEST_CHROMEDRIVER_CAPABILITIES_H_