Add named testing interface

chrome/browser/automation/automation_provider.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.
 
 // This implements a browser-side endpoint for UI automation activity.
 // The client-side endpoint is implemented by AutomationProxy.
 // The entire lifetime of this object should be contained within that of
 // the BrowserProcess, and in particular the NotificationService that's
 // hung off of it.
 
 #ifndef CHROME_BROWSER_AUTOMATION_AUTOMATION_PROVIDER_H_
 #define CHROME_BROWSER_AUTOMATION_AUTOMATION_PROVIDER_H_
 #pragma once
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
+#include "base/compiler_specific.h"
 #include "base/observer_list.h"
 #include "base/scoped_ptr.h"
 #include "base/string16.h"
 #include "chrome/browser/autofill/field_types.h"
 #include "chrome/browser/cancelable_request.h"
 #include "chrome/browser/tab_contents/navigation_entry.h"
 #include "chrome/common/automation_constants.h"
 #include "chrome/common/content_settings.h"
 #include "chrome/common/notification_observer.h"
 #include "ipc/ipc_message.h"
@@ skipping 45 matching lines @@
 }
 
 class AutomationProvider : public base::RefCounted<AutomationProvider>,
                            public IPC::Channel::Listener,
                            public IPC::Message::Sender {
  public:
   explicit AutomationProvider(Profile* profile);
 
   Profile* profile() const { return profile_; }
 
-  // Establishes a connection to an automation client, if present.
-  // An AutomationProxy should be established (probably in a different process)
-  // before calling this.
-  void ConnectToChannel(const std::string& channel_id);
+  // Initializes a channel for a connection to an AutomationProxy.
+  // If channel_id starts with kNamedInterfacePrefix, it will act
+  // as a server, create a named IPC socket with channel_id as its
+  // path, and will listen on the socket for incoming connections.
+  // If channel_id does not, it will act as a client and establish
+  // a connection on its primary IPC channel. See ipc/ipc_channel_posix.cc
+  // for more information about kPrimaryIPCChannel.
+  bool InitializeChannel(const std::string& channel_id) WARN_UNUSED_RESULT;
 
   // Sets the number of tabs that we expect; when this number of tabs has
   // loaded, an AutomationMsg_InitialLoadsComplete message is sent.
   void SetExpectedTabCount(size_t expected_tabs);
 
+  // Called when the inital set of tabs has finished loading.
+  void OnInitialLoadsComplete();
+
   // Add a listener for navigation status notification. Currently only
   // navigation completion is observed; when the |number_of_navigations|
   // complete, the completed_response object is sent; if the server requires
   // authentication, we instead send the auth_needed_response object.  A pointer
   // to the added navigation observer is returned. This object should NOT be
   // deleted and should be released by calling the corresponding
   // RemoveNavigationStatusListener method.
   NotificationObserver* AddNavigationStatusListener(
       NavigationController* tab, IPC::Message* reply_message,
       int number_of_navigations, bool include_current_navigation);
@@ skipping 27 matching lines @@
   // Add an extension port container.
   // Takes ownership of the container.
   void AddPortContainer(ExtensionPortContainer* port);
   // Remove and delete the port container.
   void RemovePortContainer(ExtensionPortContainer* port);
   // Get the port container for the given port id.
   ExtensionPortContainer* GetPortContainer(int port_id) const;
 
   // IPC implementations
   virtual bool Send(IPC::Message* msg);
+  virtual void OnChannelConnected(int pid);
   virtual void OnMessageReceived(const IPC::Message& msg);
   virtual void OnChannelError();
 
   IPC::Message* reply_message_release() {
     IPC::Message* reply_message = reply_message_;
     reply_message_ = NULL;
     return reply_message;
   }
 
   // Adds the extension passed in to the extension tracker, and returns
@@ skipping 248 matching lines @@
   scoped_ptr<IPC::ChannelProxy> channel_;
   scoped_ptr<NotificationObserver> new_tab_ui_load_observer_;
   scoped_ptr<NotificationObserver> find_in_page_observer_;
   scoped_ptr<NotificationObserver> dom_operation_observer_;
   scoped_ptr<NotificationObserver> dom_inspector_observer_;
   scoped_ptr<ExtensionTestResultNotificationObserver>
       extension_test_result_observer_;
   scoped_ptr<AutomationExtensionTracker> extension_tracker_;
   PortContainerMap port_containers_;
 
+  // True iff connected to an AutomationProxy.
+  bool is_connected_;
+
+  // True iff browser finished loading initial set of tabs.
+  bool initial_loads_complete_;

[John Grabowski, 2010/11/12 23:32:53]

Document that caller can use SetExpectedTabCount(0) to set this to true
immediately.

[dtu, 2010/11/16 01:30:40]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(AutomationProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOMATION_AUTOMATION_PROVIDER_H_