Changeset 56658 in webkit

Timestamp:

Mar 26, 2010 10:44:59 PM (14 years ago)

Author:

abarth@webkit.org

Message:

2010-03-26 Adam Barth <​abarth@webkit.org>

Reviewed by Eric Seidel.

Add some basic IRC commands to sheriffbot
​https://bugs.webkit.org/show_bug.cgi?id=36684

Adds support for sheriffbot to respond to a "hi" command and a
"last-green-revision" command. It's lame that we're rebuilding
MultiCommandTool, but as discussed in person we'll intergrate the two
once we see what the requirements are.

• Scripts/webkitpy/tool/bot/irc_command.py: Added.
• Scripts/webkitpy/tool/bot/queueengine.py:
• Scripts/webkitpy/tool/bot/queueengine_unittest.py:
• Scripts/webkitpy/tool/bot/sheriffircbot.py:
• Scripts/webkitpy/tool/bot/sheriffircbot_unittest.py: Added.
• Scripts/webkitpy/tool/commands/queues.py:
• Scripts/webkitpy/tool/commands/queuestest.py:
• Scripts/webkitpy/tool/commands/sheriffbot.py:
• Scripts/webkitpy/tool/main.py:
• Scripts/webkitpy/tool/mocktool.py:
• Scripts/webkitpy/tool/unittests.py:

Location:

trunk/WebKitTools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/webkitpy/tool/bot/irc_command.py (copied) (copied from trunk/WebKitTools/Scripts/webkitpy/tool/bot/sheriffircbot.py) (1 diff)
• Scripts/webkitpy/tool/bot/queueengine.py (modified) (2 diffs)
• Scripts/webkitpy/tool/bot/queueengine_unittest.py (modified) (5 diffs)
• Scripts/webkitpy/tool/bot/sheriffircbot.py (modified) (2 diffs)
• Scripts/webkitpy/tool/bot/sheriffircbot_unittest.py (copied) (copied from trunk/WebKitTools/Scripts/webkitpy/tool/bot/sheriffircbot.py) (3 diffs)
• Scripts/webkitpy/tool/commands/queues.py (modified) (1 diff)
• Scripts/webkitpy/tool/commands/queuestest.py (modified) (1 diff)
• Scripts/webkitpy/tool/commands/sheriffbot.py (modified) (1 diff)
• Scripts/webkitpy/tool/main.py (modified) (2 diffs)
• Scripts/webkitpy/tool/mocktool.py (modified) (4 diffs)
• Scripts/webkitpy/tool/unittests.py (modified) (1 diff)

trunk/WebKitTools/ChangeLog

@@ +1 @@
+2010-03-26  Adam Barth  <abarth@webkit.org>
+
+        Reviewed by Eric Seidel.
+
+        Add some basic IRC commands to sheriffbot
+        https://bugs.webkit.org/show_bug.cgi?id=36684
+
+        Adds support for sheriffbot to respond to a "hi" command and a
+        "last-green-revision" command.  It's lame that we're rebuilding
+        MultiCommandTool, but as discussed in person we'll intergrate the two
+        once we see what the requirements are.
+
+        * Scripts/webkitpy/tool/bot/irc_command.py: Added.
+        * Scripts/webkitpy/tool/bot/queueengine.py:
+        * Scripts/webkitpy/tool/bot/queueengine_unittest.py:
+        * Scripts/webkitpy/tool/bot/sheriffircbot.py:
+        * Scripts/webkitpy/tool/bot/sheriffircbot_unittest.py: Added.
+        * Scripts/webkitpy/tool/commands/queues.py:
+        * Scripts/webkitpy/tool/commands/queuestest.py:
+        * Scripts/webkitpy/tool/commands/sheriffbot.py:
+        * Scripts/webkitpy/tool/main.py:
+        * Scripts/webkitpy/tool/mocktool.py:
+        * Scripts/webkitpy/tool/unittests.py:
+
 2010-03-26  Adam Barth  <abarth@webkit.org>
 

trunk/WebKitTools/Scripts/webkitpy/tool/bot/irc_command.py

@@ -27 +27 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from webkitpy.common.net.irc.ircbot import IRCBotDelegate
+# FIXME: Merge with Command?
+class IRCCommand(object):
+    def execute(self, args, tool):
+        raise NotImplementedError, "subclasses must implement"
 
-class SheriffIRCBot(IRCBotDelegate):
-    def __init__(self, password):
-        self._password = password
 
-    # IRCBotDelegate methods
+class LastGreenRevision(IRCCommand):
+    def execute(self, args, tool):
+        return tool.buildbot.last_green_revision()
 
-    def irc_message_received(self, message):
+
+class Hi(IRCCommand):
+    def execute(self, args, tool):
         return '"Only you can prevent forest fires." -- Smokey the Bear'
-
-    def irc_nickname(self):
-        return "sheriffbot"
-
-    def irc_password(self):
-        return self._password

trunk/WebKitTools/Scripts/webkitpy/tool/bot/queueengine.py

@@ -66 +66 @@
 
 class QueueEngine:
-    def __init__(self, name, delegate, message_queue=None):
+    def __init__(self, name, delegate, wakeup_event):
         self._name = name
         self._delegate = delegate
-        self._message_queue = message_queue
+        self._wakeup_event = wakeup_event
         self._output_tee = OutputTee()
 
@@ -140 +140 @@
     def _sleep(self, message):
         log(self._sleep_message(message))
-        if self._message_queue:
-            self._message_queue.wait(self.seconds_to_sleep)
-        else:
-            time.sleep(self.seconds_to_sleep)
+        if self._wakeup_event.wait(self.seconds_to_sleep):
+            self._wakeup_event.clear()

trunk/WebKitTools/Scripts/webkitpy/tool/bot/queueengine_unittest.py

@@ -30 +30 @@
 import shutil
 import tempfile
+import threading
 import unittest
 
@@ -111 +112 @@
 class FastQueueEngine(QueueEngine):
     def __init__(self, delegate):
-        QueueEngine.__init__(self, "fast-queue", delegate)
+        QueueEngine.__init__(self, "fast-queue", delegate, threading.Event())
 
     # No sleep for the wicked.
@@ -123 +124 @@
     def test_trivial(self):
         delegate = LoggingDelegate(self)
-        work_queue = QueueEngine("trivial-queue", delegate)
+        work_queue = QueueEngine("trivial-queue", delegate, threading.Event())
         work_queue.run()
         self.assertEquals(delegate._callbacks, LoggingDelegate.expected_callbacks)
@@ -131 +132 @@
     def test_unexpected_error(self):
         delegate = ThrowErrorDelegate(self, 3)
-        work_queue = QueueEngine("error-queue", delegate)
+        work_queue = QueueEngine("error-queue", delegate, threading.Event())
         work_queue.run()
         expected_callbacks = LoggingDelegate.expected_callbacks[:]
@@ -142 +143 @@
     def test_handled_error(self):
         delegate = ThrowErrorDelegate(self, QueueEngine.handled_error_code)
-        work_queue = QueueEngine("handled-error-queue", delegate)
+        work_queue = QueueEngine("handled-error-queue", delegate, threading.Event())
         work_queue.run()
         self.assertEquals(delegate._callbacks, LoggingDelegate.expected_callbacks)

trunk/WebKitTools/Scripts/webkitpy/tool/bot/sheriffircbot.py

@@ -27 +27 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+import webkitpy.tool.bot.irc_command as irc_command
+
 from webkitpy.common.net.irc.ircbot import IRCBotDelegate
+from webkitpy.common.thread.threadedmessagequeue import ThreadedMessageQueue
 
-class SheriffIRCBot(IRCBotDelegate):
-    def __init__(self, password):
+
+class _IRCThreadTearoff(object):
+    def __init__(self, password, message_queue, wakeup_event):
         self._password = password
+        self._message_queue = message_queue
+        self._wakeup_event = wakeup_event
 
     # IRCBotDelegate methods
 
     def irc_message_received(self, message):
-        return '"Only you can prevent forest fires." -- Smokey the Bear'
+        self._message_queue.post(message)
+        self._wakeup_event.set()
 
     def irc_nickname(self):
@@ -43 +50 @@
     def irc_password(self):
         return self._password
+
+
+class SheriffIRCBot(IRCBotDelegate):
+    # FIXME: Lame.  We should have an auto-registering CommandCenter.
+    commands = {
+        "last-green-revision": irc_command.LastGreenRevision,
+        "hi": irc_command.Hi,
+    }
+
+    def __init__(self, tool):
+        self._tool = tool
+        self._message_queue = ThreadedMessageQueue()
+
+    def irc_delegate(self):
+        return _IRCThreadTearoff(self._tool.irc_password, self._message_queue, self._tool.wakeup_event)
+
+    def process_message(self, message):
+        tokenized_message = message.strip().split(" ")
+        if not tokenized_message:
+            return
+        command = self.commands.get(tokenized_message[0])
+        if not command:
+            self._tool.irc().post("Available commands: %s" % ", ".join(self.commands.keys()))
+            return
+        response = command().execute(tokenized_message[1:], self._tool)
+        if response:
+            self._tool.irc().post(response)
+
+    def process_pending_messages(self):
+        (messages, is_running) = self._message_queue.take_all()
+        for message in messages:
+            self.process_message(message)

trunk/WebKitTools/Scripts/webkitpy/tool/bot/sheriffircbot_unittest.py

@@ -4 +4 @@
 # modification, are permitted provided that the following conditions are
 # met:
-#
+# 
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
@@ -14 +14 @@
 # contributors may be used to endorse or promote products derived from
 # this software without specific prior written permission.
-#
+# 
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
@@ -27 +27 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from webkitpy.common.net.irc.ircbot import IRCBotDelegate
+import unittest
 
-class SheriffIRCBot(IRCBotDelegate):
-    def __init__(self, password):
-        self._password = password
+from webkitpy.common.system.outputcapture import OutputCapture
+from webkitpy.tool.bot.sheriffircbot import SheriffIRCBot
+from webkitpy.tool.mocktool import MockTool
 
-    # IRCBotDelegate methods
+def run(message):
+    tool = MockTool()
+    tool.ensure_irc_connected(None)
+    bot = SheriffIRCBot(tool)
+    bot._message_queue.post(message)
+    bot.process_pending_messages()
 
-    def irc_message_received(self, message):
-        return '"Only you can prevent forest fires." -- Smokey the Bear'
 
-    def irc_nickname(self):
-        return "sheriffbot"
+class SheriffIRCBotTest(unittest.TestCase):
+    def test_hi(self):
+        expected_stderr = 'MOCK: irc.post: "Only you can prevent forest fires." -- Smokey the Bear\n'
+        OutputCapture().assert_outputs(self, run, args=["hi"], expected_stderr=expected_stderr)
 
-    def irc_password(self):
-        return self._password
+    def test_bogus(self):
+        expected_stderr = "MOCK: irc.post: Available commands: hi, last-green-revision\n"
+        OutputCapture().assert_outputs(self, run, args=["bogus"], expected_stderr=expected_stderr)
+
+    def test_lgr(self):
+        expected_stderr = "MOCK: irc.post: 9479\n"
+        OutputCapture().assert_outputs(self, run, args=["last-green-revision"], expected_stderr=expected_stderr)

trunk/WebKitTools/Scripts/webkitpy/tool/commands/queues.py

@@ -113 +113 @@
         self.options = options
         self.tool = tool
-        return engine(self.name, self).run()
+        return engine(self.name, self, self.tool.wakeup_event).run()
 
     @classmethod

trunk/WebKitTools/Scripts/webkitpy/tool/commands/queuestest.py

@@ -36 +36 @@
 
 class MockQueueEngine(object):
-    def __init__(self, name, queue):
+    def __init__(self, name, queue, wakeup_event):
         pass
 

trunk/WebKitTools/Scripts/webkitpy/tool/commands/sheriffbot.py

@@ -44 +44 @@
     def begin_work_queue(self):
         AbstractQueue.begin_work_queue(self)
-        self._irc_delegate = SheriffIRCBot(self.tool.irc_password)
-        self.tool.ensure_irc_connected(self._irc_delegate)
+        self._irc_bot = SheriffIRCBot(self.tool)
+        self.tool.ensure_irc_connected(self._irc_bot.irc_delegate())
 
     def work_item_log_path(self, failure_info):

trunk/WebKitTools/Scripts/webkitpy/tool/main.py

@@ -31 +31 @@
 
 import os
+import threading
 
 from webkitpy.common.checkout.api import Checkout
@@ -61 +62 @@
 
         self._path = path
+        self.wakeup_event = threading.Event()
         self.bugs = Bugzilla()
         self.buildbot = BuildBot()

trunk/WebKitTools/Scripts/webkitpy/tool/mocktool.py

@@ -28 +28 @@
 
 import os
+import threading
 
 from webkitpy.common.config.committers import CommitterList, Reviewer
@@ -311 +312 @@
         return []
 
+    def last_green_revision(self):
+        return 9479
+
     def light_tree_on_fire(self):
         self._tree_is_on_fire = True
@@ -318 +322 @@
             "29837": [mock_builder]
         }
+
 
 class MockSCM(Mock):
@@ -438 +443 @@
 
     def __init__(self):
+        self.wakeup_event = threading.Event()
         self.bugs = MockBugzilla()
         self.buildbot = MockBuildBot()

trunk/WebKitTools/Scripts/webkitpy/tool/unittests.py

@@ -27 +27 @@
 from webkitpy.tool.bot.patchcollection_unittest import *
 from webkitpy.tool.bot.queueengine_unittest import *
+from webkitpy.tool.bot.sheriffircbot_unittest import *
 from webkitpy.tool.commands.download_unittest import *
 from webkitpy.tool.commands.earlywarningsystem_unittest import *