Seed test for SyncUI: sign in successfully with mocks.

chrome/browser/ui/webui/sync_setup_browsertest.js

+// 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.
+
+// TODO(scr) remove this debugging tool.

[Sheridan Rawlins, 2011/11/08 06:58:14]

I plan on removing this before commit, but it is useful in case we need to
adjust this test.

+var runMessageLoop = false;
+if (runMessageLoop)
+  GEN('#include "chrome/test/base/ui_test_utils.h"');
+
+/**
+ * Test fixture for sync setup WebUI testing.
+ * @constructor
+ * @extends {testing.Test}
+ */
+function SyncSetupWebUITest() {}
+
+SyncSetupWebUITest.prototype = {
+  __proto__: testing.Test.prototype,
+
+  /**
+   * Browse to personal options.
+   **/
+  browsePreload: 'chrome://settings/personal',
+
+  /** @inheritDoc */
+  preLoad: function() {
+

[James Hawkins, 2011/11/08 17:08:37]

Inconsistency: Blank line at beginning of method but not at the end; I prefer no
blank lines.

[Sheridan Rawlins, 2011/11/08 21:32:04]

Done.

+    function MockSyncSetupHandler() {}
+
+    MockSyncSetupHandler.prototype = {
+      stopSyncing: function() {},
+      SyncSetupDidClosePage: function() {},
+      SyncSetupSubmitAuth: function() {},
+      SyncSetupConfigure: function() {},
+      SyncSetupPassphrase: function() {},
+      SyncSetupPassphraseCancel: function() {},
+      SyncSetupAttachHandler: function() {},
+      SyncSetupShowErrorUI: function() {},
+      SyncSetupShowSetupUI: function() {},

[Dan Beam, 2011/11/08 21:54:48]

Do we do this alot?  Seems like we would.  If we do, seems like it'd be nice to
have a stub(), emptyStub(), or noop() to mix in key names, i.e.

  stub(MockSetupHandler.prototype, ['stopSyncing', 'SyncSetupDidClosePage']);

Also, it's not a big deal, but if you just make one blank function and re-use it
everywhere, i.e.

  function blank() {}

  MockSetupHandler.prototype = {
    stopSyncing: blank,
    // ...
  };

supposedly that'll save memory as each function(){} is a different instance of a
Function object (which has some memory, construction, and parse time associated
with it).  In theory v8 would be smart enough to combine Functions with the same
function body with the same scope chain, but dunno.

[Sheridan Rawlins, 2011/11/09 02:44:22]

Thanks - cool suggestion to make it easier (& memory efficient) to stub these
up.

Done.

+    };
+    var mockHandler = this.mockHandler = mock(MockSyncSetupHandler);

[James Hawkins, 2011/11/08 17:08:37]

What's with this construct?

var mockHandler = this.mockHandler =...

?

[Sheridan Rawlins, 2011/11/08 21:32:04]

It's useful in other tests which set up several stubs() calls against the
mockHandler in the preLoad.  For this one, it's not needed.

Done.

On 2011/11/08 17:08:37, James Hawkins wrote:

+
+    // Register mock as a handler of the chrome.send messages.
+    registerMockMessageCallbacks(mockHandler, MockSyncSetupHandler);
+  },
+
+  /**
+   * Debugging tool to see what's going on.
+   * TODO(scr) remove this code.
+   */
+  testGenPostamble: function() {
+    if (runMessageLoop)
+      GEN('ui_test_utils::RunMessageLoop();');
+  },
+
+  /**
+   * Verify starting point is not synced.
+   */
+  verifyUnsynced: function() {
+    var customizeSyncButton = $('customize-sync');
+    assertNotEquals(null, customizeSyncButton);
+    assertTrue(customizeSyncButton.hidden);

[James Hawkins, 2011/11/08 17:08:37]

Testing wether elemenets are hidden or not (i.e., testing the presentation)
seems extremely flaky. Perhaps there's not a better way to test though.

[Sheridan Rawlins, 2011/11/08 21:32:04]

How 'bout checking syncSetupCompleted is false?

Done.

On 2011/11/08 17:08:37, James Hawkins wrote:

+  },
+
+  /**
+   * Click the "Sign in to Chrome" button.
+   */
+  startSyncing: function() {
+    var startStopSyncButton = $('start-stop-sync');

[James Hawkins, 2011/11/08 17:08:37]

I'm also hesitant to have tests reference element IDs directly. Abstracting this
into the SyncSetupOverlay class would be better, e.g.,

SyncSetupOverlay.getSigninButton()

etc.

[Sheridan Rawlins, 2011/11/08 21:32:04]

Done.

+    assertNotEquals(null, startStopSyncButton);
+    this.mockHandler.expects(once()).SyncSetupShowSetupUI().
+        will(callFunction(function() {
+                              OptionsPage.navigateToPage('syncSetup');
+                          }));
+
+    this.mockHandler.expects(once()).SyncSetupAttachHandler().
+        will(callFunction(function() {
+                            SyncSetupOverlay.showSyncSetupPage(
+                                'login', {
+                                  user: '',
+                                  error: 0,
+                                  editable_user: true,
+                                });
+                          }));
+    startStopSyncButton.click();
+  },
+
+  gaiaLogin: function() {
+    // Find the DOM objects on the page.
+    var gaiaEmail = $('gaia-email');
+    assertNotEquals(null, gaiaEmail);
+    var gaiaPasswd = $('gaia-passwd');
+    assertNotEquals(null, gaiaPasswd);
+    var signIn = $('sign-in');
+    assertNotEquals(null, signIn);
+
+    // Set up mock expectations
+    this.mockHandler.expects(once()).SyncSetupSubmitAuth(NOT_NULL).
+        will(callFunction(function() {
+                            SyncSetupOverlay.showSuccessAndClose();
+                          }));
+    this.mockHandler.expects(once()).SyncSetupDidClosePage();
+
+    // set the email & password, then sign in.
+    gaiaEmail.value = 'foo@bar.baz';
+    gaiaPasswd.value = 'foo@bar.baz';
+    signIn.click();
+  },
+};
+
+// Verify that initial state is unsynced, start syncing, then login.
+TEST_F('SyncSetupWebUITest', 'VerifySignIn', function() {
+  this.verifyUnsynced();
+  this.startSyncing();
+  this.gaiaLogin();
+});
+