Send screenshots back to the client for debugging

chrome/test/webdriver/commands/response.cc

 // 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.
 
 #include "chrome/test/webdriver/commands/response.h"
 
 #include "base/json/json_writer.h"
 #include "base/logging.h"
 #include "base/values.h"
 
 namespace webdriver {
 
 namespace {
 
 // Error message taken from:
 // http://code.google.com/p/selenium/wiki/JsonWireProtocol#Response_Status_Codes
 const char* const kStatusKey = "status";
 const char* const kValueKey = "value";
 const char* const kMessageKey = "message";
 const char* const kScreenKey = "screen";
 const char* const kClassKey = "class";
 const char* const kStackTraceFileNameKey = "stackTrace.fileName";
 const char* const kStackTraceLineNumberKey = "stackTrace.lineNumber";
 
 }  // namespace
 
 Response::Response() {
   SetStatus(kSuccess);
   SetValue(Value::CreateNullValue());
+  screenshot_ = "";
 }
 
 Response::~Response() {}
 
 ErrorCode Response::GetStatus() const {
   int status;
   if (!data_.GetInteger(kStatusKey, &status))
     NOTREACHED();
   return static_cast<ErrorCode>(status);
 }
 
 void Response::SetStatus(ErrorCode status) {
   data_.SetInteger(kStatusKey, status);
 }
 
 const Value* Response::GetValue() const {
   Value* out = NULL;
   LOG_IF(WARNING, !data_.Get(kValueKey, &out))
       << "Accessing unset response value.";  // Should never happen.
   return out;
 }
 
 void Response::SetValue(Value* value) {
   data_.Set(kValueKey, value);
 }
 
 void Response::SetError(ErrorCode error_code, const std::string& message,
                         const std::string& file, int line) {

[kkania, 2011/02/24 22:05:02]

add a 'const std::string& screenshot' as another arg to this func. If it is not
empty, set it.  Remove the special SetScreenshot func

[Joe, 2011/03/02 02:21:25]

Done.

   DictionaryValue* error = new DictionaryValue;
   error->SetString(kMessageKey, message);
   error->SetString(kStackTraceFileNameKey, file);
   error->SetInteger(kStackTraceLineNumberKey, line);
 
+  if (!screenshot_.empty()) {
+    error->SetString(kScreenKey, screenshot_);
+  }
+
   SetStatus(error_code);
   SetValue(error);
 }
 
 void Response::SetField(const std::string& key, Value* value) {
   data_.Set(key, value);
 }
 
+void Response::SetScreenshot(const std::string& screenshot) {
+  screenshot_ = screenshot;
+}
+
 std::string Response::ToJSON() const {
   std::string json;
   base::JSONWriter::Write(&data_, false, &json);
   return json;
 }
 
 }  // namespace webdriver