Send screenshots back to the client for debugging

chrome/test/webdriver/commands/response.h

 // Copyright (c) 2010 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_COMMANDS_RESPONSE_H_
 #define CHROME_TEST_WEBDRIVER_COMMANDS_RESPONSE_H_
 
 #include <sstream>
 #include <string>
 
 #include "base/values.h"
 #include "chrome/test/webdriver/error_codes.h"
+#include "chrome/test/webdriver/session_manager.h"
 
 namespace webdriver {
 
 // All errors in webdriver must use this macro in order to send back
 // a proper stack trace to the client
 #define SET_WEBDRIVER_ERROR(response, msg, err) \
-  response->SetError(err, msg, __FILE__, __LINE__); \
+  response->SetError(err, msg, __FILE__, __LINE__,""); \
+  LOG(ERROR) << msg
+
+
+// All errors in webdriver must use this macro in order to send back
+// a proper stack trace to the client
+#define SET_WEBDRIVER_ERROR2(response, session, msg, err) \
+  { \
+    std::string __screenshot__ = ""; \
+    webdriver::SessionManager* sm = webdriver::SessionManager::GetInstance(); \
+    if (sm->ScreenshotOnError()) { \

[kkania, 2011/03/07 18:15:17]

why not screenshot_on_error

[Joe, 2011/03/11 22:12:48]

Not every error is a screen shot and since they are large PNG files it puts an
extra unnecessary overhead.

On 2011/03/07 18:15:17, kkania wrote:

+      session->ScreenshotAsBase64(&__screenshot__); \
+      response->SetScreenshotAsBase64(__screenshot__); \
+    } \
+    response->SetError(err, msg, __FILE__, __LINE__, __screenshot__); \
+  } \
   LOG(ERROR) << msg
 
 // A simple class that encapsulates the information describing the response to
 // a |Command|. In Webdriver all responses must be sent back as a JSON value,
 // conforming to the spec found at:
 // http://code.google.com/p/selenium/wiki/JsonWireProtocol#Messages
 class Response {
  public:
   // Creates a new |Response| with a default status of |kSuccess| and a
   // |NullValue|.
   Response();
   ~Response();
 
   ErrorCode GetStatus() const;
   void SetStatus(ErrorCode status);
 
   // Ownership of the returned pointer is kept by this object.
   const Value* GetValue() const;
 
   // Sets the |value| of this response, assuming ownership of the object in the
   // process.
   void SetValue(Value* value);
 
   // Configures this response to report an error. The |file| and |line|
   // parameters, which identify where in the source the error occurred, can be
   // set using the |SET_WEBDRIVER_ERROR| macro above.
-  void SetError(ErrorCode error, const std::string& message,
-                const std::string& file, int line);
+  void SetError(ErrorCode error,
+                const std::string& message,
+                const std::string& file,
+                int line,
+                const std::string& screenshot);
 
   // Sets a JSON field in this response. The |key| may be a "." delimitted
   // string to indicate the value should be set in a nested object. Any
   // previously set value for the |key| will be deleted.
   // This object assumes ownership of |value|.
   void SetField(const std::string& key, Value* value);
 
   // Returns this response as a JSON string.
   std::string ToJSON() const;
 
  private:
   DictionaryValue data_;

[kkania, 2011/03/07 18:15:17]

i don't really care that much, but I think the norm is to have a newline between
variables and DISALLOW..., but not between private: and DISALLOW

[Joe, 2011/03/11 22:12:48]

Done.

-
   DISALLOW_COPY_AND_ASSIGN(Response);
 };
 
 }  // namespace webdriver
 
 #endif  // CHROME_TEST_WEBDRIVER_COMMANDS_RESPONSE_H_