Refactor remote_desktop_browsertest:

remoting/test/remote_desktop_browsertest.h

 // Copyright (c) 2013 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 REMOTE_DESKTOP_BROWSER_TEST_H_
 #define REMOTE_DESKTOP_BROWSER_TEST_H_
 
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/extensions/extension_browsertest.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
@@ skipping 19 matching lines @@
 
 }
 
 namespace remoting {
 
 class RemoteDesktopBrowserTest : public ExtensionBrowserTest {
  public:
   RemoteDesktopBrowserTest();
   virtual ~RemoteDesktopBrowserTest();
 
+  // InProcessBrowserTest Overrides
   virtual void SetUp() OVERRIDE;
 
  protected:
+  // InProcessBrowserTest Overrides
   virtual void SetUpInProcessBrowserTestFixture() OVERRIDE;
+
+  // InProcessBrowserTest Overrides
   virtual void TearDownInProcessBrowserTestFixture() OVERRIDE;
 
+
+  /*                                                    */
+  /* The following helpers each perform a simple task.  */
+  /*                                                    */
+
+  // Verify the test has access to the internet (specifically google.com)
+  void VerifyInternetAccess();
+
   // Install the chromoting extension from a crx file.
   void InstallChromotingApp();
 
   // Uninstall the chromoting extension.
   void UninstallChromotingApp();
 
   // Test whether the chromoting extension is installed.
   void VerifyChromotingLoaded(bool expected);
 
   // Launch the chromoting app.
   void LaunchChromotingApp();
 
-  // Verify the test has access to the internet (specifically google.com)
-  void VerifyInternetAccess();
-
   // Authorize: grant extended access permission to the user's computer.
   void Authorize();
 
   // Authenticate: sign in to google using the credentials provided.
   void Authenticate();
 
   // Approve: grant the chromoting app necessary permissions.
   void Approve();
 
-  // Whether to perform the cleanup tasks (uninstalling chromoting, etc).
-  // This is useful for diagnostic purposes.
-  bool NoCleanup() { return no_cleanup_; }
 
-  // Whether to install the chromoting extension before running the test cases.
-  // This is useful for diagnostic purposes.
-  bool NoInstall() { return no_install_; }
+  /*                                                      */
+  /* The following helpers each perform a composite task. */
+  /*                                                      */
+
+  // Install the chromoting extension
+  void Install();
+
+  // Clean up after the test.
+  void Cleanup();
+
+  // Perform all the auth steps: authorization, authenticattion, etc.
+  // It starts from the chromoting main page unauthenticated and ends up back
+  // on the chromoting main page authenticated and ready to go.
+  void Auth();
 
  private:
-  void ParseCommandLine();
-
   // Change behavior of the default host resolver to allow DNS lookup
   // to proceed instead of being blocked by the test infrastructure.
   void EnableDNSLookupForThisTest(
     net::RuleBasedHostResolverProc* host_resolver);
 
   // We need to reset the DNS lookup when we finish, or the test will fail.
   void DisableDNSLookupForThisTest();
 
+  void ParseCommandLine();
+
+
+  /*                    */
+  /* Accessor methods.  */
+  /*                    */
+
   // Helper to get the path to the crx file of the webapp to be tested.
   base::FilePath WebAppCrxPath() { return webapp_crx_; }
 
   // Helper to get the extension ID of the installed chromoting webapp.
   std::string ChromotingID() { return chromoting_id_; }
 
+  // Whether to perform the cleanup tasks (uninstalling chromoting, etc).
+  // This is useful for diagnostic purposes.
+  bool NoCleanup() { return no_cleanup_; }
+
+  // Whether to install the chromoting extension before running the test cases.
+  // This is useful for diagnostic purposes.
+  bool NoInstall() { return no_install_; }
+
   // Helper to construct the starting URL of the installed chromoting webapp.
   GURL Chromoting_Main_URL() {
     return GURL("chrome-extension://" + ChromotingID() + "/main.html");
   }
 
   // Helper to retrieve the current URL of the active tab in the browser.
   GURL GetCurrentURL() {
     return browser()->tab_strip_model()->GetActiveWebContents()->GetURL();
   }
 
+
+  /*                                                    */
+  /* Helpers to execute javascript code on a web page.  */
+  /*                                                    */
+
   // Helper to execute a javascript code snippet on the current page.
-  void ExecuteScript(const std::string& script) {
-    ASSERT_TRUE(content::ExecuteScript(
-        browser()->tab_strip_model()->GetActiveWebContents(), script));
-  }
+  void ExecuteScript(const std::string& script);
 
   // Helper to execute a javascript code snippet on the current page and
   // wait for page load to complete.
-  void ExecuteScriptAndWait(const std::string& script) {
-    content::WindowedNotificationObserver observer(
-        content::NOTIFICATION_LOAD_STOP,
-        content::Source<content::NavigationController>(
-            &browser()->tab_strip_model()->GetActiveWebContents()->
-                GetController()));
-
-    ExecuteScript(script);
-
-    observer.Wait();
-  }
+  void ExecuteScriptAndWait(const std::string& script);
 
   // Helper to execute a javascript code snippet on the current page and
   // wait until the target url is loaded. This is used when the target page
   // is loaded after multiple redirections.
-  void ExecuteScriptAndWaitUntil(
-      const std::string& script, const GURL& target) {
-    content::WindowedNotificationObserver observer(
-        content::NOTIFICATION_LOAD_STOP,
-        content::Source<content::NavigationController>(
-            &browser()->tab_strip_model()->GetActiveWebContents()->
-                GetController()));
-
-    ExecuteScript(script);
-
-    observer.Wait();
-
-    // TODO: is there a better way to wait for all the redirections to complete?
-    while (GetCurrentURL() != target) {
-      content::WindowedNotificationObserver(
-          content::NOTIFICATION_LOAD_STOP,
-          content::Source<content::NavigationController>(
-              &browser()->tab_strip_model()->GetActiveWebContents()->
-                  GetController())).Wait();
-    }
-  }
+  void ExecuteScriptAndWaitUntil(const std::string& script, const GURL& target);
 
   // Helper to execute a javascript code snippet on the current page and
   // extract the boolean result.
-  bool ExecuteScriptAndExtractBool(const std::string& script) {
-    bool result;
-    // Using a private assert function because ASSERT_TRUE can only be used in
-    // void returning functions.
-    _ASSERT_TRUE(content::ExecuteScriptAndExtractBool(
-        browser()->tab_strip_model()->GetActiveWebContents(),
-        "window.domAutomationController.send(" + script + ");",
-        &result));
+  bool ExecuteScriptAndExtractBool(const std::string& script);
 
-    return result;
-  }
+  // Helper to navigate to a given url.
+  void NavigateToURLAndWait(const GURL& url);
 
   // Helper to check whether a html element with the given name exists on
   // the current page.
   bool HtmlElementExists(const std::string& name) {
     return ExecuteScriptAndExtractBool(
         "document.getElementById(\"" + name + "\") != null");
   }
 
-  // Helper to navigate to a given url.
-  void NavigateToURLAndWait(const GURL& url) {
-    content::WindowedNotificationObserver observer(
-        content::NOTIFICATION_LOAD_STOP,
-        content::Source<content::NavigationController>(
-            &browser()->tab_strip_model()->GetActiveWebContents()->
-                GetController()));
 
-    ui_test_utils::NavigateToURL(browser(), url);
-    observer.Wait();
-  }
+  /*        */
+  /* Fields */
+  /*        */
 
   // This test needs to make live DNS requests for access to
   // GAIA and sync server URLs under google.com. We use a scoped version
   // to override the default resolver while the test is active.
   scoped_ptr<net::ScopedDefaultHostResolverProc> mock_host_resolver_override_;
 
   bool no_cleanup_;
   bool no_install_;
   std::string chromoting_id_;
   base::FilePath webapp_crx_;
   std::string username_;
   std::string password_;
 };
 
 }  // namespace remoting
 
 #endif  // REMOTE_DESKTOP_BROWSER_TEST_H_