Adding first unit tests with mocks

chrome/browser/resources/google_now/background_unittest.gtestjs

 // Copyright 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.
 
 /**
  * Test fixture for ../background.js.
  * @constructor
  * @extends {testing.Test}
  */
 function GoogleNowBackgroundUnitTest () {
@@ skipping 22 matching lines @@
 
   testTaskPair(DISMISS_CARD_TASK_NAME, UPDATE_CARDS_TASK_NAME, false);
   testTaskPair(DISMISS_CARD_TASK_NAME, DISMISS_CARD_TASK_NAME, false);
   testTaskPair(DISMISS_CARD_TASK_NAME, RETRY_DISMISS_TASK_NAME, false);
 
   testTaskPair(RETRY_DISMISS_TASK_NAME, UPDATE_CARDS_TASK_NAME, true);
   testTaskPair(RETRY_DISMISS_TASK_NAME, DISMISS_CARD_TASK_NAME, true);
   testTaskPair(RETRY_DISMISS_TASK_NAME, RETRY_DISMISS_TASK_NAME, true);
 });
 
+/**
+ * Mocks global functions and APIs that initialize() depends upon.
+ * @param {Test} fixture Test fixture.
+ */
+function mockInitializeDependencies(fixture) {
+  fixture.makeAndRegisterMockGlobals([
+      'recordEvent',
+      'showWelcomeToast',
+      'startPollingCards']);
+  fixture.makeAndRegisterMockApis(
+      ['storage.get', 'chrome.identity.getAuthToken']);
+}
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'Initialize_ToastStateEmpty1',
+    function() {
+      // Tests the case when toast state is empty and NOTIFICATION_CARDS_URL is
+      // not set. In this case, the function should quietly exit after finding
+      // out that NOTIFICATION_CARDS_URL is empty.
+
+      // Setup and expectations.
+      var testToastState = {};
+      NOTIFICATION_CARDS_URL = undefined;
+
+      mockInitializeDependencies(this);
+
+      this.mockGlobals.expects(once()).recordEvent(
+          DiagnosticEvent.EXTENSION_START);
+      var storage_get_SavedArgs = new SaveMockArguments();

[arv (Not doing code reviews), 2013/07/12 14:18:34]

This still makes no sense. storage_get_SavedArgs is a local variable.

Are you saying that there is some preprocessor involved?

[vadimt, 2013/07/12 18:22:35]

No preprocessing.
The reason is that I want this variable name to match the call that it's getting
arguments for. The call itself is automatically generated and includes
underscores.

I could camel-case it as storageGetSavedArgs, but then it would be harder to
read the code.
Also, consider a call chrome.identity.getAuthToken. If we call the corresponding
saved args 'chromeIdentityGetAuthTokenSavedArgs', all parts will lump together,
and it will be hard to comprehend the code. Better it will be
chrome_identity_getAuthToken_SavedArgs.

+      this.mockApis.expects(once()).
+          storage_get(

[arv (Not doing code reviews), 2013/07/12 14:18:34]

this one I understand why it is using storage_get. I think it is a bad design
but I think it is out of scope for this CL.

[vadimt, 2013/07/12 18:22:35]

Alternatively, it could be
   this.mockApis.expects(once())
       ['storage.get'](
but this is harder to write. Also, in this case, how to call corresponding saved
args? We cannot include dots there.

Another alternative in theory could be:

this.mockApis.expects(once()).
       storage.get(

But unfortunately, the mocking itself is done by a 3rd party library mock4js.js.
(test_api.js is build as a sugar on top of it). It generates only a flat object
with a list of same-level methods. I could probably hack around it, but I feel
that this would create more problems than solve.

+              storage_get_SavedArgs.match(eq('toastState')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testToastState));
+
+      // Invoking the tested function.
+      initialize();
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'Initialize_ToastStateEmpty2',
+    function() {
+      // Tests the case when toast state is empty and NOTIFICATION_CARDS_URL is
+      // set, but getAuthToken fails most likely because the user is not signed
+      // in. In this case, the function should quietly exit after finding out
+      // that getAuthToken fails.
+
+      // Setup and expectations.
+      var testToastState = {};
+      NOTIFICATION_CARDS_URL = 'https://some.server.url.com';
+      var testIdentityToken = undefined;
+
+      mockInitializeDependencies(this);
+
+      this.mockGlobals.expects(once()).recordEvent(
+          DiagnosticEvent.EXTENSION_START);
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('toastState')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testToastState));
+      var chrome_identity_getAuthToken_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          chrome_identity_getAuthToken(
+              chrome_identity_getAuthToken_SavedArgs.match(
+                  eqJSON({interactive: false})),
+              chrome_identity_getAuthToken_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(
+              chrome_identity_getAuthToken_SavedArgs, 1, testIdentityToken));
+
+      // Invoking the tested function.
+      initialize();
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'Initialize_ToastStateEmpty3',
+    function() {
+      // Tests the case when toast state is empty and NOTIFICATION_CARDS_URL is
+      // set, and getAuthToken succeeds. In this case, the function should
+      // invoke showWelcomeToast().
+
+      // Setup and expectations.
+      var testToastState = {};
+      NOTIFICATION_CARDS_URL = 'https://some.server.url.com';
+      var testIdentityToken = 'some identity token';
+
+      mockInitializeDependencies(this);
+
+      this.mockGlobals.expects(once()).recordEvent(
+          DiagnosticEvent.EXTENSION_START);
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('toastState')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testToastState));
+      var chrome_identity_getAuthToken_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          chrome_identity_getAuthToken(
+              chrome_identity_getAuthToken_SavedArgs.match(
+                  eqJSON({interactive: false})),
+              chrome_identity_getAuthToken_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(
+              chrome_identity_getAuthToken_SavedArgs, 1, testIdentityToken));
+      this.mockGlobals.expects(once()).showWelcomeToast();
+
+      // Invoking the tested function.
+      initialize();
+    });
+
+TEST_F('GoogleNowBackgroundUnitTest', 'Initialize_ToastStateYes', function() {
+  // Tests the case when the user has answered "yes" to the toast in the past.
+  // In this case, the function should invoke startPollingCards().
+
+  // Setup and expectations.
+  var testToastState = {toastState: ToastOptionResponse.CHOSE_YES};
+
+  mockInitializeDependencies(this);
+
+  this.mockGlobals.expects(once()).recordEvent(DiagnosticEvent.EXTENSION_START);
+  var storage_get_SavedArgs = new SaveMockArguments();
+  this.mockApis.expects(once()).
+      storage_get(
+          storage_get_SavedArgs.match(eq('toastState')),
+          storage_get_SavedArgs.match(ANYTHING)).
+      will(invokeCallback(storage_get_SavedArgs, 1, testToastState));
+  this.mockGlobals.expects(once()).startPollingCards();
+
+  // Invoking the tested function.
+  initialize();
+});
+
+TEST_F('GoogleNowBackgroundUnitTest', 'Initialize_ToastStateNo', function() {
+  // Tests the case when the user has answered "no" to the toast in the past.
+  // In this case, the function should do nothing.
+
+  // Setup and expectations.
+  var testToastState = {toastState: ToastOptionResponse.CHOSE_NO};
+
+  mockInitializeDependencies(this);
+
+  this.mockGlobals.expects(once()).recordEvent(DiagnosticEvent.EXTENSION_START);
+  var storage_get_SavedArgs = new SaveMockArguments();
+  this.mockApis.expects(once()).
+      storage_get(
+          storage_get_SavedArgs.match(eq('toastState')),
+          storage_get_SavedArgs.match(ANYTHING)).
+      will(invokeCallback(storage_get_SavedArgs, 1, testToastState));
+
+  // Invoking the tested function.
+  initialize();
+});
+
+/**
+ * Mocks global functions and APIs that onNotificationClicked() depends upon.
+ * @param {Test} fixture Test fixture.
+ */
+function mockOnNotificationClickedDependencies(fixture) {
+  fixture.makeAndRegisterMockApis([
+      'storage.get',
+      'chrome.tabs.create',
+      'chrome.windows.create']);
+}
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'OnNotificationClicked_NoData',
+    function() {
+      // Tests the case when there is no data associated with notification id.
+      // In this case, the function should do nothing.
+
+      // Setup and expectations.
+      var testNotificationId = 'TEST_ID';
+      var testNotificationData = {};
+
+      mockOnNotificationClickedDependencies(this);
+      this.makeMockLocalFunctions(['selector']);
+
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('notificationsData')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testNotificationData));
+
+      // Invoking the tested function.
+      onNotificationClicked(
+          testNotificationId, this.mockLocalFunctions.functions().selector);
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'OnNotificationClicked_ActionUrlsNotObject',
+    function() {
+      // Tests the case when the data associated with notification id is not an
+      // object, probably because of a malformed server response.
+      // In this case, the function should do nothing.
+
+      // Setup and expectations.
+      var testActionUrls = 'string, not object';
+      var testNotificationId = 'TEST_ID';
+      var testNotificationData = {
+          notificationsData: {'TEST_ID': {actionUrls: testActionUrls}}
+      };
+
+      mockOnNotificationClickedDependencies(this);
+      this.makeMockLocalFunctions(['selector']);
+
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('notificationsData')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testNotificationData));
+
+      // Invoking the tested function.
+      onNotificationClicked(
+          testNotificationId, this.mockLocalFunctions.functions().selector);
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'OnNotificationClicked_UrlNotString',
+    function() {
+      // Tests the case when selector returns a non-string, probably because of
+      // a malformed server response.
+      // In this case, the function should do nothing.
+
+      // Setup and expectations.
+      var testActionUrls = {testField: 'TEST VALUE'};
+      var testNotificationId = 'TEST_ID';
+      var testNotificationData = {
+          notificationsData: {'TEST_ID': {actionUrls: testActionUrls}}
+      };
+      var testActionUrl = {};
+
+      mockOnNotificationClickedDependencies(this);
+      this.makeMockLocalFunctions(['selector']);
+
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('notificationsData')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testNotificationData));
+      this.mockLocalFunctions.expects(once()).selector(testActionUrls).will(
+          returnValue(testActionUrl));
+
+      // Invoking the tested function.
+      onNotificationClicked(
+          testNotificationId, this.mockLocalFunctions.functions().selector);
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'OnNotificationClicked_TabCreateSuccess',
+    function() {
+      // Tests the selected URL is OK and crome.tabs.create suceeds.
+
+      // Setup and expectations.
+      var testActionUrls = {testField: 'TEST VALUE'};
+      var testNotificationId = 'TEST_ID';
+      var testNotificationData = {
+          notificationsData: {'TEST_ID': {actionUrls: testActionUrls}}
+      };
+      var testActionUrl = 'http://testurl.com';
+      var testCreatedTab = {};
+
+      mockOnNotificationClickedDependencies(this);
+      this.makeMockLocalFunctions(['selector']);
+
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('notificationsData')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testNotificationData));
+      this.mockLocalFunctions.expects(once()).selector(testActionUrls).will(
+          returnValue(testActionUrl));
+      var chrome_tabs_create_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          chrome_tabs_create(
+              chrome_tabs_create_SavedArgs.match(eqJSON({url: testActionUrl})),
+              chrome_tabs_create_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(chrome_tabs_create_SavedArgs, 1, testCreatedTab));
+
+      // Invoking the tested function.
+      onNotificationClicked(
+          testNotificationId, this.mockLocalFunctions.functions().selector);
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'OnNotificationClicked_TabCreateFail',
+    function() {
+      // Tests the selected URL is OK and crome.tabs.create fails.
+      // In this case, the function should invoke chrome.windows.create as a
+      // second attempt.
+
+      // Setup and expectations.
+      var testActionUrls = {testField: 'TEST VALUE'};
+      var testNotificationId = 'TEST_ID';
+      var testNotificationData = {
+        notificationsData: {'TEST_ID': {actionUrls: testActionUrls}}
+      };
+      var testActionUrl = 'http://testurl.com';
+      var testCreatedTab = undefined; // chrome.tabs.create fails
+
+      mockOnNotificationClickedDependencies(this);
+      this.makeMockLocalFunctions(['selector']);
+
+      var storage_get_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          storage_get(
+              storage_get_SavedArgs.match(eq('notificationsData')),
+              storage_get_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(storage_get_SavedArgs, 1, testNotificationData));
+      this.mockLocalFunctions.expects(once()).selector(testActionUrls).will(
+          returnValue(testActionUrl));
+      var chrome_tabs_create_SavedArgs = new SaveMockArguments();
+      this.mockApis.expects(once()).
+          chrome_tabs_create(
+              chrome_tabs_create_SavedArgs.match(eqJSON({url: testActionUrl})),
+              chrome_tabs_create_SavedArgs.match(ANYTHING)).
+          will(invokeCallback(chrome_tabs_create_SavedArgs, 1, testCreatedTab));
+      this.mockApis.expects(once()).chrome_windows_create(
+          eqJSON({url: testActionUrl}));
+
+      // Invoking the tested function.
+      onNotificationClicked(
+          testNotificationId, this.mockLocalFunctions.functions().selector);
+    });