Send screenshots back to the client for debugging

chrome/test/webdriver/session.h

 // Copyright (c) 2011 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.
 
 #ifndef CHROME_TEST_WEBDRIVER_SESSION_H_
 #define CHROME_TEST_WEBDRIVER_SESSION_H_
 
 #include <map>
 #include <string>
 #include <vector>
@@ skipping 85 matching lines @@
   bool GoBack();
   bool Reload();
   bool GetURL(GURL* url);
   bool GetURL(std::string* url);
   bool GetTabTitle(std::string* tab_title);
   bool GetCookies(const GURL& url, std::string* cookies);
   bool GetCookieByName(const GURL& url, const std::string& cookie_name,
              std::string* cookie);
   bool DeleteCookie(const GURL& url, const std::string& cookie_name);
   bool SetCookie(const GURL& url, const std::string& cookie);
+  bool CaptureEntirePageAsPNG(std::string* png);

[kkania, 2011/03/16 18:19:10]

I see you didn't change this one to GetScreenShot. The idea with the naming is
as following:

Session methods can follow webdriver naming conventions, all Automation methods
do not. That is why Session passes around window_id's everywhere and Automation
passes around tab_id's.

So, it would be ok to use GetScreenshot here, because that is what Webdriver
uses, but better to use CaptureEntirePage in Automation, because that is what
Chrome automation is really doing.

[Joe, 2011/03/17 00:15:25]

Renamed functions
On 2011/03/16 18:19:10, kkania wrote:

 
   // Gets all the currently existing window IDs. Returns true on success.
   bool GetWindowIds(std::vector<int>* window_ids);
 
   // Switches the window used by default. |name| is either an ID returned by
   // |GetWindowIds| or the name attribute of a DOM window.
   ErrorCode SwitchToWindow(const std::string& name);
 
   // Switches the frame used by default. |name_or_id| is either the name or id
   // of a frame element.
@@ skipping 50 matching lines @@
 
   // Gets the top and left element border widths for the given frame.
   ErrorCode GetElementBorder(const FrameId& frame_id,
                              const WebElementId& element,
                              int* border_left,
                              int* border_top);
 
   // Waits for all tabs to stop loading. Returns true on success.
   bool WaitForAllTabsToStopLoading();
 
-  inline const std::string& id() const { return id_; }
+  const std::string& id() const;
 
-  inline int implicit_wait() const { return implicit_wait_; }
-  inline void set_implicit_wait(const int& timeout) {
-    implicit_wait_ = timeout > 0 ? timeout : 0;
-  }
+  int implicit_wait() const;
+  void set_implicit_wait(const int& timeout);
 
   enum Speed { kSlow, kMedium, kFast, kUnknown };
-  inline Speed speed() { return speed_; }
-  inline void set_speed(Speed speed) {
-    speed_ = speed;
-  }
+  Speed speed();
+  void set_speed(Speed speed);
+
+  // Since screenshots can be very large when in base64 PNG format; the
+  // client is allowed to dyamically enable/disable screenshots on error
+  // during the lifetime of the session.
+  bool get_screenshot_on_error() const;
+  void set_screenshot_on_error(const bool error);

[kkania, 2011/03/16 18:19:10]

get rid of const before bool here.

[Joe, 2011/03/17 00:15:25]

Done.

 
   const FrameId& current_target() const;
 
  private:
   void RunSessionTask(Task* task);
   void RunSessionTaskOnSessionThread(
       Task* task,
       base::WaitableEvent* done_event);
   void InitOnSessionThread(const FilePath& browser_dir, bool* success);
   void TerminateOnSessionThread();
@@ skipping 11 matching lines @@
                                     const WebElementId& element,
                                     const gfx::Rect& region,
                                     gfx::Point* location);
 
   const std::string id_;
 
   scoped_ptr<Automation> automation_;
   base::Thread thread_;
 
   int implicit_wait_;
+  bool screenshot_on_error_;
   Speed speed_;
 
   FrameId current_target_;
 
   DISALLOW_COPY_AND_ASSIGN(Session);
 };
 
 }  // namespace webdriver
 
 DISABLE_RUNNABLE_METHOD_REFCOUNT(webdriver::Session);
 
 #endif  // CHROME_TEST_WEBDRIVER_SESSION_H_