[142] Added unit tests for AdminMessenger

Author: 8r2y5

.gitignore

@@ -51,4 +51,5 @@ nosetests.xml
 # Mac cleanup
 .DS_Store
 
-cover
+cover
+.noseids

base_plugin.py

@@ -59,11 +59,13 @@ class BasePlugin(object):
     active = False
 
     def __init__(self, *args, **kwargs):
+        self.overridden_methods = {}
         super(BasePlugin, self).__init__(*args, **kwargs)
         if self.__class__.__name__ != 'BasePlugin':
             for packet, when_dict in self.overridden_packets.iteritems():
+                self.overridden_methods.setdefault(packet, {})
                 for when, packet_name in when_dict.iteritems():
-                    self.overridden_packets[packet][when] = getattr(
+                    self.overridden_methods[packet][when] = getattr(
                         self, packet_name
                     )
 

plugin_manager.py

@@ -275,7 +275,7 @@ def map_plugin_packets(self, plugin):
         """
         Maps plugin overridden packets ready to use in do method.
         """
-        for packet_id, when_dict in plugin.overridden_packets.iteritems():
+        for packet_id, when_dict in plugin.overridden_methods.iteritems():
             for when, packet_method in when_dict.iteritems():
                 self.packets.setdefault(
                     packet_id, {}

plugins/admin_messenger/test_admin_messenger.py

@@ -0,0 +1,75 @@
+from unittest import TestCase
+
+from mock import Mock, patch
+
+from plugins.admin_messenger.admin_messenger import AdminMessenger
+
+
+class AdminMessengerTestCase(TestCase):
+    def test_activate(self):
+        plugin = AdminMessenger()
+        plugin.config = Mock(chat_prefix='test prefix')
+
+        with self.assertRaises(AttributeError):
+            self.plugin.prefix
+
+        plugin.activate()
+        self.assertEqual(plugin.prefix, 'test prefix')
+
+    @patch.object(AdminMessenger, 'message_admins')
+    @patch.object(AdminMessenger, 'broadcast_message')
+    @patch('plugins.admin_messenger.admin_messenger.packets')
+    def test_on_chat_sent_broadcast(
+        self, mock_packets, mock_broadcast, mock_admins
+    ):
+        mock_parse = Mock()
+        message = Mock(message='###broadcast message')
+        mock_parse.parse.return_value = message
+        mock_packets.chat_sent.return_value = mock_parse
+        mock_data = Mock(data='test data')
+        plugin = AdminMessenger()
+        plugin.config = Mock()
+        plugin.activate()
+        plugin.prefix = '#'
+
+        self.assertFalse(plugin.on_chat_sent(mock_data))
+        mock_parse.parse.assert_called_with('test data')
+        mock_broadcast.assert_called_with(message)
+
+    @patch.object(AdminMessenger, 'message_admins')
+    @patch.object(AdminMessenger, 'broadcast_message')
+    @patch('plugins.admin_messenger.admin_messenger.packets')
+    def test_on_chat_sent_message_admins(
+        self, mock_packets, mock_broadcast, mock_admins
+    ):
+        plugin = AdminMessenger()
+        plugin.config = Mock()
+        plugin.activate()
+        plugin.prefix = '#'
+        mock_parse = Mock()
+        mock_data = Mock(data='test data')
+        message = Mock(message='##admin message')
+        mock_parse.parse.return_value = message
+        mock_packets.chat_sent.return_value = mock_parse
+
+        self.assertFalse(plugin.on_chat_sent(mock_data))
+        mock_admins.assert_called_with(message)
+
+    @patch.object(AdminMessenger, 'message_admins')
+    @patch.object(AdminMessenger, 'broadcast_message')
+    @patch('plugins.admin_messenger.admin_messenger.packets')
+    def test_on_chat_sent_normal_message(
+        self, mock_packets, mock_broadcast, mock_admins
+    ):
+        mock_parse = Mock()
+        mock_data = Mock(data='test data')
+        plugin = AdminMessenger()
+        plugin.config = Mock()
+        plugin.activate()
+        plugin.prefix = '#'
+        message = Mock(message='test message')
+        mock_parse.parse.return_value = message
+
+        self.assertTrue(plugin.on_chat_sent(mock_data))
+        self.assertFalse(mock_admins.called)
+        self.assertFalse(mock_broadcast.called)

requirements.txt

@@ -3,4 +3,5 @@ twisted
 enum34
 construct
 tornado
-nose
+nose
+mock

tests/test_base_plugin.py

@@ -38,8 +38,9 @@ def after_burn_container(self, data):
 
         test_plugin2 = TestPlugin2()
         test_plugin = TestPlugin()
+        self.maxDiff = None
         self.assertDictEqual(
-            test_plugin.overridden_packets,
+            test_plugin.overridden_methods,
             {
                 5: {
                     'on': test_plugin.on_chat_received
@@ -50,7 +51,7 @@ def after_burn_container(self, data):
             }
         )
         self.assertDictEqual(
-            test_plugin2.overridden_packets,
+            test_plugin2.overridden_methods,
             {
                 44: {
                     'on': test_plugin2.on_burn_container,

tests/test_plugin_manager.py

@@ -153,15 +153,15 @@ def test_de_map_plugin_packets(self, mock_config, mock_path, mock_sys):
     def test_map_plugin_packets(self, mock_config, mock_path, mock_sys):
         mock_plugin = Mock()
         mock_plugin.name = 'Test'
-        mock_plugin.overridden_packets = {
+        mock_plugin.overridden_methods = {
             1: {
                 'on': 'add me on 1',
                 'after': 'add me after 1'
             }
         }
         mock_plugin2 = Mock()
         mock_plugin2.name = 'Test2'
-        mock_plugin2.overridden_packets = {
+        mock_plugin2.overridden_methods = {
             2: {
                 'on': 'add me on 2'
             },