|
| 1 | +import time, re, six, threading, logging, sys, json |
| 2 | +from six.moves import _thread |
| 3 | +from mattermost_bot.bot import Bot, PluginsManager |
| 4 | +from mattermost_bot.mattermost_v4 import MattermostClientv4 |
| 5 | +from mattermost_bot.dispatcher import MessageDispatcher |
| 6 | +import driver_settings, bot_settings |
| 7 | + |
| 8 | +logger = logging.getLogger(__name__) |
| 9 | +logging.basicConfig(stream=sys.stdout, level=logging.DEBUG) |
| 10 | + |
| 11 | +class DriverBot(Bot): |
| 12 | + |
| 13 | + def __init__(self): |
| 14 | + self._client = MattermostClientv4( |
| 15 | + driver_settings.BOT_URL, driver_settings.BOT_TEAM, |
| 16 | + driver_settings.BOT_LOGIN, driver_settings.BOT_PASSWORD, |
| 17 | + driver_settings.SSL_VERIFY |
| 18 | + ) |
| 19 | + self._plugins = PluginsManager() |
| 20 | + self._plugins.init_plugins() |
| 21 | + self._dispatcher = MessageDispatcher(self._client, self._plugins) |
| 22 | + |
| 23 | + |
| 24 | +class Driver(object): |
| 25 | + |
| 26 | + def __init__(self): |
| 27 | + self.bot = DriverBot() |
| 28 | + self.bot_username = driver_settings.BOT_NAME |
| 29 | + self.bot_userid = None |
| 30 | + self.testbot_username = bot_settings.BOT_NAME |
| 31 | + self.testbot_userid = None |
| 32 | + self.dm_chan = None # direct message channel |
| 33 | + self.team_name = driver_settings.BOT_TEAM |
| 34 | + self.cm_name = driver_settings.BOT_CHANNEL |
| 35 | + self.cm_chan = None # common public channel |
| 36 | + self.gm_name = driver_settings.BOT_PRIVATE_CHANNEL |
| 37 | + self.gm_chan = None # private channel |
| 38 | + self.events = [] |
| 39 | + self._events_lock = threading.Lock() |
| 40 | + |
| 41 | + def start(self): |
| 42 | + self._rtm_connect() |
| 43 | + self._retrieve_bot_user_ids() |
| 44 | + self._create_dm_channel() |
| 45 | + self._retrieve_cm_channel() |
| 46 | + self._retrieve_gm_channel() |
| 47 | + |
| 48 | + def _rtm_connect(self): |
| 49 | + self.bot._client.connect_websocket() |
| 50 | + self._websocket = self.bot._client.websocket |
| 51 | + self._websocket.sock.setblocking(0) |
| 52 | + _thread.start_new_thread(self._rtm_read_forever, tuple()) |
| 53 | + |
| 54 | + def _websocket_safe_read(self): |
| 55 | + """Returns data if available, otherwise ''. Newlines indicate multiple messages """ |
| 56 | + data = '' |
| 57 | + while True: |
| 58 | + # accumulated received data until no more events received |
| 59 | + # then exception triggered, then returns the accumulated data |
| 60 | + try: |
| 61 | + data += '{0}\n'.format(self._websocket.recv()) |
| 62 | + except: |
| 63 | + return data.rstrip() |
| 64 | + |
| 65 | + def _rtm_read_forever(self): |
| 66 | + while True: |
| 67 | + json_data = self._websocket_safe_read() |
| 68 | + if json_data != '': |
| 69 | + with self._events_lock: |
| 70 | + self.events.extend([json.loads(d) for d in json_data.split('\n')]) |
| 71 | + time.sleep(1) |
| 72 | + |
| 73 | + def _retrieve_bot_user_ids(self): |
| 74 | + # get bot user info |
| 75 | + self.users_info = self.bot._client.api.post('/users/usernames', |
| 76 | + [driver_settings.BOT_NAME, bot_settings.BOT_NAME]) |
| 77 | + # get user ids |
| 78 | + for user in self.users_info: |
| 79 | + if user['username'] == self.bot_username: |
| 80 | + self.bot_userid = user['id'] |
| 81 | + elif user['username'] == self.testbot_username: |
| 82 | + self.testbot_userid = user['id'] |
| 83 | + |
| 84 | + def _create_dm_channel(self): |
| 85 | + """create direct channel and get id""" |
| 86 | + response = self.bot._client.api.post('/channels/direct', |
| 87 | + [self.bot_userid, self.testbot_userid]) |
| 88 | + self.dm_chan = response['id'] |
| 89 | + |
| 90 | + def _retrieve_cm_channel(self): |
| 91 | + """create direct channel and get id""" |
| 92 | + response = self.bot._client.api.get('/teams/name/%s/channels/name/%s' % (self.team_name, self.cm_name)) |
| 93 | + self.cm_chan = response['id'] |
| 94 | + |
| 95 | + def _retrieve_gm_channel(self): |
| 96 | + """create direct channel and get id""" |
| 97 | + response = self.bot._client.api.get('/teams/name/%s/channels/name/%s' % (self.team_name, self.gm_name)) |
| 98 | + self.gm_chan = response['id'] |
| 99 | + |
| 100 | + def _format_message(self, msg, tobot=True, colon=True, space=True): |
| 101 | + colon = ':' if colon else '' |
| 102 | + space = ' ' if space else '' |
| 103 | + if tobot: |
| 104 | + msg = u'@{}{}{}{}'.format(self.testbot_username, colon, space, msg) |
| 105 | + return msg |
| 106 | + |
| 107 | + def _send_message_to_bot(self, channel, msg): |
| 108 | + self.clear_events() |
| 109 | + self._start_ts = time.time() |
| 110 | + self.bot._client.channel_msg(channel, msg) |
| 111 | + |
| 112 | + def send_direct_message(self, msg, tobot=False, colon=True): |
| 113 | + msg = self._format_message(msg, tobot=tobot, colon=colon) |
| 114 | + self._send_message_to_bot(self.dm_chan, msg) |
| 115 | + |
| 116 | + def validate_bot_direct_message(self, match): |
| 117 | + posts = self.bot._client.api.get('/channels/%s/posts' % self.dm_chan) |
| 118 | + last_response = posts['posts'][posts['order'][0]] |
| 119 | + if re.search(match, last_response['message']): |
| 120 | + return |
| 121 | + else: |
| 122 | + raise AssertionError('expected to get message like "{}", but got nothing'.format(match)) |
| 123 | + |
| 124 | + def wait_for_bot_direct_message(self, match): |
| 125 | + self._wait_for_bot_message(self.dm_chan, match, tosender=False) |
| 126 | + |
| 127 | + def _wait_for_bot_message(self, channel, match, maxwait=10, tosender=True, thread=False): |
| 128 | + for _ in range(maxwait): |
| 129 | + time.sleep(1) |
| 130 | + if self._has_got_message_rtm(channel, match, tosender, thread=thread): |
| 131 | + break |
| 132 | + else: |
| 133 | + raise AssertionError('expected to get message like "{}", but got nothing'.format(match)) |
| 134 | + |
| 135 | + def _has_got_message_rtm(self, channel, match, tosender=True, thread=False): |
| 136 | + if tosender is True: |
| 137 | + match = six.text_type(r'@{}: {}').format(self.bot_username, match) |
| 138 | + with self._events_lock: |
| 139 | + for event in self.events: |
| 140 | + if 'event' not in event or (event['event'] == 'posted' and 'data' not in event): |
| 141 | + print('Unusual event received: ' + repr(event)) |
| 142 | + if event['event'] == 'posted': |
| 143 | + post_data = json.loads(event['data']['post']) |
| 144 | + if re.match(match, post_data['message'], re.DOTALL): |
| 145 | + return True |
| 146 | + return False |
| 147 | + |
| 148 | + def _send_channel_message(self, chan, msg, **kwargs): |
| 149 | + msg = self._format_message(msg, **kwargs) |
| 150 | + self._send_message_to_bot(chan, msg) |
| 151 | + |
| 152 | + def send_channel_message(self, msg, **kwargs): |
| 153 | + self._send_channel_message(self.cm_chan, msg, **kwargs) |
| 154 | + |
| 155 | + def validate_bot_channel_message(self, match): |
| 156 | + posts = self.bot._client.api.get('/channels/%s/posts' % self.cm_chan) |
| 157 | + last_response = posts['posts'][posts['order'][0]] |
| 158 | + if re.search(match, last_response['message']): |
| 159 | + return |
| 160 | + else: |
| 161 | + raise AssertionError('expected to get message like "{}", but got nothing'.format(match)) |
| 162 | + |
| 163 | + def wait_for_bot_channel_message(self, match, tosender=True): |
| 164 | + self._wait_for_bot_message(self.cm_chan, match, tosender=tosender) |
| 165 | + |
| 166 | + def send_private_channel_message(self, msg, **kwargs): |
| 167 | + self._send_channel_message(self.gm_chan, msg, **kwargs) |
| 168 | + |
| 169 | + def wait_for_bot_private_channel_message(self, match, tosender=True): |
| 170 | + self._wait_for_bot_message(self.gm_chan, match, tosender=tosender) |
| 171 | + |
| 172 | + def wait_for_bot_online(self): |
| 173 | + self._wait_for_bot_presense(True) |
| 174 | + # sleep to allow bot connection to stabilize |
| 175 | + time.sleep(2) |
| 176 | + |
| 177 | + def _wait_for_bot_presense(self, online): |
| 178 | + for _ in range(10): |
| 179 | + time.sleep(2) |
| 180 | + if online and self._is_testbot_online(): |
| 181 | + break |
| 182 | + if not online and not self._is_testbot_online(): |
| 183 | + break |
| 184 | + else: |
| 185 | + raise AssertionError('test bot is still {}'.format('offline' if online else 'online')) |
| 186 | + |
| 187 | + # [ToDo] implement this method by checking via MM API |
| 188 | + def _is_testbot_online(self): |
| 189 | + # check by asking MM through API |
| 190 | + return True |
| 191 | + |
| 192 | + def clear_events(self): |
| 193 | + with self._events_lock: |
| 194 | + self.events = [] |
0 commit comments