Send screenshots back to the client for debugging

chrome/browser/automation/testing_automation_provider.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/browser/automation/testing_automation_provider.h"
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/command_line.h"
+#include "base/file_path.h"
 #include "base/json/json_reader.h"
 #include "base/json/json_writer.h"
 #include "base/json/string_escape.h"
 #include "base/path_service.h"
 #include "base/process.h"
 #include "base/process_util.h"
 #include "base/stringprintf.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
@@ skipping 1964 matching lines @@
       }
   }
 }
 
 void TestingAutomationProvider::CaptureEntirePageAsPNG(
     int tab_handle, const FilePath& path, IPC::Message* reply_message) {
   RenderViewHost* render_view = GetViewForTab(tab_handle);
   if (render_view) {
     // This will delete itself when finished.
     PageSnapshotTaker* snapshot_taker = new PageSnapshotTaker(
-        this, reply_message, render_view, path);
+        this, reply_message, render_view, path, false);
     snapshot_taker->Start();
   } else {
     LOG(ERROR) << "Could not get render view for tab handle";
     AutomationMsg_CaptureEntirePageAsPNG::WriteReplyParams(reply_message,
                                                            false);
     Send(reply_message);
   }
 }
 
 void TestingAutomationProvider::SendJSONRequest(int handle,
@@ skipping 36 matching lines @@
   handler_map["GoForward"] =
       &TestingAutomationProvider::GoForward;
   handler_map["GoBack"] =
       &TestingAutomationProvider::GoBack;
   handler_map["Reload"] =
       &TestingAutomationProvider::ReloadJSON;
   handler_map["GetTabURL"] =
       &TestingAutomationProvider::GetTabURLJSON;
   handler_map["GetTabTitle"] =
       &TestingAutomationProvider::GetTabTitleJSON;
+  handler_map["GetScreenShot"] =

[kkania, 2011/03/17 18:35:11]

change this

[Joe, 2011/03/18 00:33:32]

Done.

+      &TestingAutomationProvider::CaptureEntirePageJSON;
   handler_map["GetCookies"] =
       &TestingAutomationProvider::GetCookiesJSON;
   handler_map["DeleteCookie"] =
       &TestingAutomationProvider::DeleteCookieJSON;
   handler_map["SetCookie"] =
       &TestingAutomationProvider::SetCookieJSON;
   handler_map["GetTabIds"] =
       &TestingAutomationProvider::GetTabIds;
   handler_map["IsTabIdValid"] =
       &TestingAutomationProvider::IsTabIdValid;
@@ skipping 2884 matching lines @@
   std::string error;
   if (!GetTabFromJSONArgs(args, &tab_contents, &error)) {
     reply.SendError(error);
     return;
   }
   DictionaryValue dict;
   dict.SetString("title", tab_contents->GetTitle());
   reply.SendSuccess(&dict);
 }
 
+void TestingAutomationProvider::CaptureEntirePageJSON(
+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  TabContents* tab_contents;
+  std::string error;
+
+  if (!GetTabFromJSONArgs(args, &tab_contents, &error)) {
+    AutomationJSONReply(this, reply_message).SendError(error);
+    return;
+  }
+
+  FilePath::StringType path_str;
+  if (!args->GetString("path", &path_str)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'path' missing or invalid");
+    return;
+  }
+
+  RenderViewHost* render_view = tab_contents->render_view_host();
+  if (render_view) {
+    FilePath path(path_str);
+    // This will delete itself when finished.
+    PageSnapshotTaker* snapshot_taker = new PageSnapshotTaker(
+        this, reply_message, render_view, path, true);
+    snapshot_taker->Start();
+  } else {
+    AutomationJSONReply(this,reply_message)

[kkania, 2011/03/17 18:35:11]

space after comma

[Joe, 2011/03/18 00:33:32]

Done.

[kkania, 2011/03/18 19:18:22]

hmm, for some reason there are now two spaces after the comma; just 1 please

+        .SendError("Could not get render view for tab handle");
+    AutomationMsg_CaptureEntirePageAsPNG::WriteReplyParams(reply_message,

[kkania, 2011/03/17 18:35:11]

remove this and the following Send. We are already sending the error above, so
this is not needed. Take a look at how SendError in AutomationJSONReply is
implemented.

[Joe, 2011/03/18 00:33:32]

Is there any documentation with instructions on how to add a command and how all
of this message passing works.  To be honest I can't follow it at all, I am just
hacking from the example code.  What would be the proper way to handle this
particular condition.

On 2011/03/17 18:35:11, kkania wrote:

[kkania, 2011/03/18 19:18:22]

you can take a look at what Nirnimesh wrote a while back
(http://www.chromium.org/developers/testing/pyauto/contributing). Feel free to
read the code and ask me questions.

Take a look at AutomationJSONReply::SendError. There are two things we need to
do in the automation provider: write the message, and send it.
AutomationMsg_....::WriteReplyParams is generated from the chrome IPC macro, and
it will write the message. Send of course sends it back.

Now there is one IPC message called SendJSONRequest, with the associated
AutomationMsg_SendJSONRequest::WriteReply func.  We want to write the correctly
formatted JSON string, so Nirnimesh added AUtomationJSONReply to easily write
and send an error or a success value.

You do need to remove the lines I told you too though.

+                                                           false);
+    Send(reply_message);
+  }
+}
+
 void TestingAutomationProvider::GetCookiesJSON(
     DictionaryValue* args, IPC::Message* reply_message) {
   automation_util::GetCookiesJSON(this, args, reply_message);
 }
 
 void TestingAutomationProvider::DeleteCookieJSON(
     DictionaryValue* args, IPC::Message* reply_message) {
   automation_util::DeleteCookieJSON(this, args, reply_message);
 }
 
@@ skipping 231 matching lines @@
     // If you change this, update Observer for NotificationType::SESSION_END
     // below.
     MessageLoop::current()->PostTask(FROM_HERE,
         NewRunnableMethod(this, &TestingAutomationProvider::OnRemoveProvider));
   }
 }
 
 void TestingAutomationProvider::OnRemoveProvider() {
   AutomationProviderList::GetInstance()->RemoveProvider(this);
 }