Merge lp:~mconley/messagingmenu-extension/init_tests into lp:messagingmenu-extension

[Mike Conley]

Just a simple set of tests to get the ball rolling here.

Unmerged revisions

87. By Mike Conley on 2011-09-20

Adding testing README.

86. By Mike Conley on 2011-09-20

Merging with 0.9

85. By Mike Conley on 2011-09-19

Added some hooks for testing and some really, really basic tests.

=== modified file 'modules/MessagingMenu.jsm'
--- modules/MessagingMenu.jsm	2011-09-15 00:01:36 +0000
+++ modules/MessagingMenu.jsm	2011-09-20 15:36:23 +0000
@@ -345,6 +345,7 @@
   if (!shouldRequestAtt) {
     let recipients = aItemHeader.recipients.split(",");
     let re = /.*<([^>]*)>/; // Convert "Foo <bar>" in to "bar"
+
     for (let i in recipients) {
       let recipient = recipients[i].replace(re, "$1");
       if (shouldRequestAtt) {
@@ -435,6 +436,8 @@
     indicate.indicate_indicator_set_property(this.indicator,
                                              indicate.INDICATOR_MESSAGES_PROP_ATTENTION,
                                              "true");
+    Services.obs.notifyObservers(this, "messagingmenu-request-attention", this.newCount);
+    LOG("All done.");
   },
 
   cancelAttention: function MMIE_cancelAttention() {
@@ -447,6 +450,7 @@
     indicate.indicate_indicator_set_property(this.indicator,
                                              indicate.INDICATOR_MESSAGES_PROP_ATTENTION,
                                              "false");
+    Services.obs.notifyObservers(this, "messagingmenu-cancel-attention", null);
   },
 
   set label(aName) {

=== added file 'tests/README'
--- tests/README	1970-01-01 00:00:00 +0000
+++ tests/README	2011-09-20 15:36:23 +0000
@@ -0,0 +1,13 @@
+= How to run the Messaging Menu / Unity Launcher tests =
+
+1.  Symbolically link the folder with this README in it, to [Thunderbird source dir]/mail/test/mozmill/[e-mail]
+
+2.  Build this add-on, using:
+
+    sh build.sh
+
+3.  Build Thunderbird, and then switch into your objdir directory.
+
+4.  From the Thunderbird objdir directory, run the tests via:
+
+    SOLO_TEST=[e-mail] MOZMILL_EXTRA="--addons=[absolute path to edsintegration.xpi]" make mozmill-one

=== modified file 'tests/test-messaging-menu.js'
--- tests/test-messaging-menu.js	2011-06-06 14:48:46 +0000
+++ tests/test-messaging-menu.js	2011-09-20 15:36:23 +0000
@@ -15,11 +15,11 @@
  *
  * The Initial Developer of the Original Code is
  * the Mozilla Foundation.
- * Portions created by the Initial Developer are Copyright (C) 2010
+ * Portions created by the Initial Developer are Copyright (C) 2011
  * the Initial Developer. All Rights Reserved.
  *
  * Contributor(s):
- *   Mike Conley <[e-mail]>
+ *   Mike Conley <[e-mail]>
  *
  * Alternatively, the contents of this file may be used under the terms of
  * either the GNU General Public License Version 2 or later (the "GPL"), or
@@ -35,123 +35,82 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
-/*
- * Test that message reloads happen properly when the message pane is hidden,
- * and then made visible again.
- */
 var MODULE_NAME = "test-messaging-menu";
 
 var RELATIVE_ROOT = "../shared-modules";
 var MODULE_REQUIRES = ["folder-display-helpers"];
 
-var Indicator = null;
-var msg = null;
-var folder = null;
-var msgSets = [];
-
-var IndicatorMock = function()
-{
-  this.doIndications = [];
-  this.stopIndications = [];
-};
-
-var doIndication = function(folderURL, label, messageURL, count,
-                            dateInSeconds)
-{
-  Indicator.doIndications.push({folderURL: folderURL,
-                                label: label,
-                                count: count,
-                                messageURL: messageURL,
-                                dateInSeconds: dateInSeconds});
-};
-
-var stopIndication = function(folderURL)
-{
-  Indicator.stopIndications.push({folderURL: folderURL});
-}
+var Cc = Components.classes;
+var Ci = Components.interfaces;
+var Cu = Components.utils;
+
+var gFolder;
+
+var IndicatorHelper = {
+  _sawIndicatorAttention: false,
+  _seenIndicator: null,
+
+  plan_for_indicator_attention: function(aController) {
+    this._sawIndicatorAttention = false;
+    this._seenIndicator = null;
+    Services.obs.addObserver(this, "messagingmenu-request-attention", false);
+  },
+
+  wait_for_indicator_attention: function(aController) {
+    aController.waitFor(function() this._sawIndicatorAttention,
+                        "Timed out waiting for indicator attention",
+                        5000, 100, this);
+    Services.obs.removeObserver(this, "messagingmenu-request-attention");
+    assert_not_equals(this._seenIndicator, null,
+                      "Indication was observed, but could not get Indicator.");
+    return this._seenIndicator;
+  },
+
+  check_for_no_indicator_attention: function(aController) {
+    Services.obs.removeObserver(this, "messagingmenu-request-attention");
+    assert_equals(null, this._seenIndicator,
+                  "Indicator attention was observed.");
+  },
+
+  observe: function IH_observe(aSubject, aTopic, aData) {
+    if (aTopic == "messagingmenu-request-attention") {
+      this._seenIndicator = aSubject;
+      this._sawIndicatorAttention = true;
+    }
+  },
+
+};
 
 
 function setupModule(module)
 {
   let fdh = collector.getModule('folder-display-helpers');
   fdh.installInto(module);
-  folder = create_folder("Test folder");
-}
-
-function setupTest(test)
-{
-  if(Indicator)
-    delete Indicator;
-  Indicator = new IndicatorMock();
-  mc.window.uMessagingMenu._doIndicationHook = doIndication;
-  mc.window.uMessagingMenu._stopIndicationHook = stopIndication;
-  be_in_folder(inboxFolder);
-}
-
-function teardownTest(test)
-{
-  for each (let msgSet in msgSets) {
-    delete_message_set(msgSet);
-  }
-  msgSets = [];
-}
-
-function add_message_set_to_folder(aFolder, aNumToAdd)
-{
-  let [msgSet] = make_new_sets_in_folder(aFolder, [{count:aNumToAdd}]);
-  msgSets.push(msgSet);
-  return msgSet;
-}
-
-function test_new_inbox_mail_causes_indicate()
-{
-  add_message_set_to_folder(inboxFolder, 1);
-  assert_equals(1, Indicator.doIndications.length);
-}
-
-function test_uninteresting_folders_do_not_indicate()
+  gFolder = create_folder("Test folder");
+}
+
+function test_new_inbox_mail_causes_indication_and_attention()
+{
+  IndicatorHelper.plan_for_indicator_attention(mc);
+  make_new_sets_in_folder(gFolder, [{count: 1,
+                                     to: [["Tinderbox", "[e-mail]"]]}]);
+  IndicatorHelper.wait_for_indicator_attention(mc);
+}
+
+
+function test_uninteresting_folders_do_not_get_attention()
 {
   let uninteresting = [Ci.nsMsgFolderFlags.Trash, Ci.nsMsgFolderFlags.Junk,
                        Ci.nsMsgFolderFlags.SentMail, Ci.nsMsgFolderFlags.Drafts,
-                       Ci.nsMsgFolderFlags.Templates, Ci.nsMsgFolderFlags.Queue];
+                       Ci.nsMsgFolderFlags.Templates, Ci.nsMsgFolderFlags.Queue,
+                       Ci.nsMsgFolderFlags.Archive];
 
   for each (let folder_type in uninteresting) {
-    folder.setFlag(folder_type);
-    add_message_set_to_folder(folder, 1);
-    assert_equals(0, Indicator.doIndications.length);
-    folder.clearFlag(folder_type);
+    gFolder.setFlag(folder_type);
+    IndicatorHelper.plan_for_indicator_attention(mc);
+    make_new_sets_in_folder(gFolder, [{count: 1}]);
+    IndicatorHelper.check_for_no_indicator_attention(mc);
+    gFolder.clearFlag(folder_type);
   }
 
 }
-
-function test_clicking_new_message_hides_indicator()
-{
-  add_message_set_to_folder(inboxFolder, 1);
-  let msgHdr = select_click_row(0);
-  open_selected_message();
-  wait_for_message_display_completion(mc);
-  assert_equals(1, Indicator.stopIndications.length);
-}
-
-function test_show_oldest_new_unread_message()
-{
-  let firstMsgSet = add_message_set_to_folder(inboxFolder, 1);
-  let firstMsgURL = firstMsgSet.getMsgURI(0);
-  add_message_set_to_folder(inboxFolder, 2);
-  assert_equals(3, Indicator.doIndications.length);
-  assert_equals(firstMsgURL, Indicator.doIndications[2].messageURL);
-}
-
-function test_indicates_new_unread_after_previous_indication()
-{
-  add_message_set_to_folder(inboxFolder, 1);
-  select_click_row(0);
-  let secondMsgSet = add_message_set_to_folder(inboxFolder, 1);
-  let secondMsgURL = secondMsgSet.getMsgURI(0);
-
-  assert_equals(2, Indicator.doIndications.length);
-  assert_equals(1, Indicator.stopIndications.length);
-  assert_equals(secondMsgURL, Indicator.doIndications[1].messageURL);
-}
-
-