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/log.h"
  18 #include "chrome/test/chromedriver/net/net_util.h"
  19
  20 namespace base {
  21 class DictionaryValue;
  22 }
  23
  24 class CommandLine;
  25 class Status;
  26
  27 class Switches {
  28  public:
  29   typedef base::FilePath::StringType NativeString;
  30   Switches();
  31   ~Switches();
  32
  33   void SetSwitch(const std::string& name);
  34   void SetSwitch(const std::string& name, const std::string& value);
  35   void SetSwitch(const std::string& name, const base::string16& value);
  36   void SetSwitch(const std::string& name, const base::FilePath& value);
  37
  38   // In case of same key, |switches| will override.
  39   void SetFromSwitches(const Switches& switches);
  40
  41   // Sets a switch from the capabilities, of the form [--]name[=value].
  42   void SetUnparsedSwitch(const std::string& unparsed_switch);
  43
  44   void RemoveSwitch(const std::string& name);
  45
  46   bool HasSwitch(const std::string& name) const;
  47   std::string GetSwitchValue(const std::string& name) const;
  48   NativeString GetSwitchValueNative(const std::string& name) const;
  49
  50   size_t GetSize() const;
  51
  52   void AppendToCommandLine(CommandLine* command) const;
  53   std::string ToString() const;
  54
  55  private:
  56   typedef std::map<std::string, NativeString> SwitchMap;
  57   SwitchMap switch_map_;
  58 };
  59
  60 typedef std::map<std::string, Log::Level> LoggingPrefs;
  61
  62 struct Capabilities {
  63   Capabilities();
  64   ~Capabilities();
  65
  66   // Return true if existing host:port session is to be used.
  67   bool IsExistingBrowser() const;
  68
  69   // Return true if android package is specified.
  70   bool IsAndroid() const;
  71
  72   Status Parse(const base::DictionaryValue& desired_caps);
  73
  74   std::string android_activity;
  75
  76   std::string android_device_serial;
  77
  78   std::string android_package;
  79
  80   std::string android_process;
  81
  82   bool android_use_running_app;
  83
  84   base::FilePath binary;
  85
  86   // If provided, the remote debugging address to connect to.
  87   NetAddress debugger_address;
  88
  89   // Whether the lifetime of the started Chrome browser process should be
  90   // bound to ChromeDriver's process. If true, Chrome will not quit if
  91   // ChromeDriver dies.
  92   bool detach;
  93
  94   // Set of switches which should be removed from default list when launching
  95   // Chrome.
  96   std::set<std::string> exclude_switches;
  97
  98   std::vector<std::string> extensions;
  99
 100   // True if should always use DevTools for taking screenshots.
 101   // This is experimental and may be removed at a later point.
 102   bool force_devtools_screenshot;
 103
 104   scoped_ptr<base::DictionaryValue> local_state;
 105
 106   std::string log_path;
 107
 108   LoggingPrefs logging_prefs;
 109
 110   // If set, enable minidump for chrome crashes and save to this directory.
 111   std::string minidump_path;
 112
 113   scoped_ptr<base::DictionaryValue> prefs;
 114
 115   Switches switches;
 116 };
 117
 118 #endif  // CHROME_TEST_CHROMEDRIVER_CAPABILITIES_H_