Bug 1184406 - Add tests for NOTICE handling in ircNonStandard. r=aleth

--HG--
extra : rebase_source : 141342ef982163c857e017df7842956a076643ff

chat/protocols/irc/ircNonStandard.jsm

@@ -36,12 +36,11 @@ var ircNonStandard = {
       // AUTH); in this case, check if the user's nickname is not auth, or the
       // the message starts with ***.
       let target = aMessage.params[0].toLowerCase();
-      let nickname = aMessage.origin ? aMessage.origin.toLowerCase() : "";
       let isAuth = target == "*" ||
-        (target == "auth" && (nickname != "auth" ||
+        (target == "auth" && (this._nickname.toLowerCase() != "auth" ||
                               aMessage.params[1].startsWith("***")));
 
-      // Some servers , e.g. irc.umich.edu, use NOTICE before connection to give
+      // Some servers, e.g. irc.umich.edu, use NOTICE before connection to give
       // directions to users.
       if (!this.connected && !isAuth) {
         this.getConversation(aMessage.origin)

chat/protocols/irc/test/test_ircNonStandard.js

@@ -0,0 +1,177 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+Components.utils.import("resource://gre/modules/Services.jsm");
+let irc = {};
+Services.scriptloader.loadSubScript("resource:///components/irc.js", irc);
+Components.utils.import("resource:///modules/ircNonStandard.jsm");
+
+// The function that is under test here.
+var NOTICE = ircNonStandard.commands["NOTICE"]
+
+function FakeConversation() {}
+FakeConversation.prototype = {
+  writeMessage: function(aSender, aTarget, aOpts) {}
+};
+
+function FakeAccount(aPassword) {
+  this.imAccount = {
+    password: aPassword
+  };
+  this.buffer = [];
+  this.convs = [];
+}
+FakeAccount.prototype = {
+  connected: true,
+  shouldAuthenticate: undefined,
+  _nickname: 'nick', // Can be anything except "auth" for most tests.
+  sendMessage: function(aCommand, aParams) {
+    this.buffer.push([aCommand, aParams]);
+  },
+  gotDisconnected: function(aReason, aMsg) {
+    this.connected = false;
+  },
+  getConversation: function(aName) {
+    this.convs.push(aName);
+    return new FakeConversation();
+  }
+};
+
+function run_test() {
+  add_test(testSecureList);
+  add_test(testZncAuth);
+  add_test(testUMich);
+  add_test(testAuthNick);
+
+  run_next_test();
+}
+
+/*
+ * Test that SECURELIST properly sets the timer such that another LIST call can
+ * happen soon. See bug 1082501.
+ */
+function testSecureList() {
+  const kSecureListMsg =
+    ':fripp.mozilla.org NOTICE aleth-build :*** You cannot list within the first 60 seconds of connecting. Please try again later.';
+
+  let message = irc.ircMessage(kSecureListMsg, "");
+  let account = new FakeAccount();
+  let result = NOTICE.call(account, message);
+
+  // Yes, it was handled.
+  do_check_true(result);
+
+  // Undo the expected calculation, this should be near 0.
+  let value = account._lastListTime - Date.now() - 60000 + 12 * 60 * 60 * 1000;
+  // Give some wiggle room.
+  do_check_true(Math.abs(value) < 5 * 1000);
+
+  run_next_test();
+}
+
+/*
+ * ZNC allows a client to send PASS after connection has occurred if it has not
+ * yet been provided. See bug 955244.
+ */
+function testZncAuth() {
+  const kZncMsg =
+    ':irc.znc.in NOTICE AUTH :*** You need to send your password. Try /quote PASS <username>:<password>';
+
+  let message = irc.ircMessage(kZncMsg, "");
+  // No provided password.
+  let account = new FakeAccount();
+  let result = NOTICE.call(account, message);
+
+  // Yes, it was handled.
+  do_check_true(result);
+
+  // No sent data and parameters should be unchanged.
+  do_check_true(account.buffer.length == 0);
+  do_check_true(account.shouldAuthenticate === undefined);
+  do_check_false(account.connected);
+
+  // With a password.
+  account = new FakeAccount("password");
+  result = NOTICE.call(account, message);
+
+  // Yes, it was handled.
+  do_check_true(result);
+
+  // Check if the proper message was sent.
+  let sent = account.buffer[0];
+  do_check_true(sent[0] == "PASS");
+  do_check_true(sent[1] == "password");
+  do_check_true(account.buffer.length == 1);
+
+  // Don't try to authenticate with NickServ.
+  do_check_true(account.shouldAuthenticate === false);
+
+  // Finally, check if the message is wrong.
+  account = new FakeAccount("password");
+  message.params[1] = "";
+  result = NOTICE.call(account, message);
+
+  // Unhandled.
+  do_check_false(result);
+
+  run_next_test();
+}
+
+/*
+ * irc.umich.edu sends a lot of garbage and has a non-standard captcha. See bug
+ * 954350.
+ */
+function testUMich() {
+  // The above should not print out.
+  const kMsgs = [
+    'NOTICE AUTH :*** Processing connection to irc.umich.edu',
+    'NOTICE AUTH :*** Looking up your hostname...',
+    'NOTICE AUTH :*** Checking Ident',
+    'NOTICE AUTH :*** Found your hostname',
+    'NOTICE AUTH :*** No Ident response'
+  ];
+
+  const kFinalMsg =
+    ':irc.umich.edu NOTICE clokep :To complete your connection to this server, type "/QUOTE PONG :cookie", where cookie is the following ascii.';
+
+  let account = new FakeAccount();
+  account.connected = false;
+  for (let msg of kMsgs) {
+    let message = irc.ircMessage(msg, "");
+    let result = NOTICE.call(account, message);
+
+    // These initial notices are not handled (i.e. they'll be subject to
+    // _showServerTab).
+    do_check_false(result);
+  }
+
+  // And finally the last one should be printed out, always. It contains the
+  // directions of what to do next.
+  let message = irc.ircMessage(kFinalMsg, "");
+  let result = NOTICE.call(account, message);
+  do_check_true(result);
+  do_check_eq(account.convs.length, 1);
+  do_check_eq(account.convs[0], "irc.umich.edu");
+
+  run_next_test();
+}
+
+/*
+ * Test an edge-case of the user having the nickname of auth. See bug 1083768.
+ */
+function testAuthNick() {
+  const kMsg =
+    ':irc.umich.edu NOTICE AUTH :To complete your connection to this server, type "/QUOTE PONG :cookie", where cookie is the following ascii.';
+
+  let account = new FakeAccount();
+  account._nickname = "AUTH";
+
+  let message = irc.ircMessage(kMsg, "");
+  let result = NOTICE.call(account, message);
+
+  // Since it is ambiguous if it was an authentication message or a message
+  // directed at the user, let it go through the normal NOTICE handling.
+  do_check_false(result);
+
+  run_next_test();
+}

chat/protocols/irc/test/xpcshell.ini

@@ -7,6 +7,7 @@ tail =
 [test_ctcpDequote.js]
 [test_ctcpQuote.js]
 [test_ircMessage.js]
+[test_ircNonStandard.js]
 [test_sendBufferedCommand.js]
 [test_setMode.js]
 [test_splitLongMessages.js]