Home | History | Annotate | Download | only in chromedriver 
      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   InspectorDomainStatus timeline;
     80 
     81   std::string trace_categories;  // Non-empty string enables tracing.
     82   int buffer_usage_reporting_interval;  // ms between trace buffer usage events.
     83 };
     84 
     85 struct Capabilities {
     86   Capabilities();
     87   ~Capabilities();
     88 
     89   // Return true if remote host:port session is to be used.
     90   bool IsRemoteBrowser() const;
     91 
     92   // Return true if android package is specified.
     93   bool IsAndroid() const;
     94 
     95   Status Parse(const base::DictionaryValue& desired_caps);
     96 
     97   std::string android_activity;
     98 
     99   std::string android_device_serial;
    100 
    101   std::string android_package;
    102 
    103   std::string android_process;
    104 
    105   bool android_use_running_app;
    106 
    107   base::FilePath binary;
    108 
    109   // If provided, the remote debugging address to connect to.
    110   NetAddress debugger_address;
    111 
    112   // Whether the lifetime of the started Chrome browser process should be
    113   // bound to ChromeDriver's process. If true, Chrome will not quit if
    114   // ChromeDriver dies.
    115   bool detach;
    116 
    117   // Device metrics for use in Device Emulation.
    118   scoped_ptr<DeviceMetrics> device_metrics;
    119 
    120   // Set of switches which should be removed from default list when launching
    121   // Chrome.
    122   std::set<std::string> exclude_switches;
    123 
    124   std::vector<std::string> extensions;
    125 
    126   // True if should always use DevTools for taking screenshots.
    127   // This is experimental and may be removed at a later point.
    128   bool force_devtools_screenshot;
    129 
    130   scoped_ptr<base::DictionaryValue> local_state;
    131 
    132   std::string log_path;
    133 
    134   LoggingPrefs logging_prefs;
    135 
    136   // If set, enable minidump for chrome crashes and save to this directory.
    137   std::string minidump_path;
    138 
    139   PerfLoggingPrefs perf_logging_prefs;
    140 
    141   scoped_ptr<base::DictionaryValue> prefs;
    142 
    143   Switches switches;
    144 };
    145 
    146 #endif  // CHROME_TEST_CHROMEDRIVER_CAPABILITIES_H_
    147