Limnoria/test/test_ircmsgs.py

351 lines
14 KiB
Python
Raw Normal View History

2005-01-19 14:14:38 +01:00
###
2005-01-24 22:27:34 +01:00
# Copyright (c) 2002-2005, Jeremiah Fincher
# Copyright (c) 2010-2021, The Limnoria Contributors
2005-01-19 14:14:38 +01:00
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# 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.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
from supybot.test import *
2005-01-19 14:14:38 +01:00
2015-08-22 18:36:47 +02:00
import time
2005-01-19 14:14:38 +01:00
import copy
import pickle
import itertools
2005-01-19 14:14:38 +01:00
import supybot.conf as conf
2005-01-19 14:14:38 +01:00
import supybot.ircmsgs as ircmsgs
import supybot.ircutils as ircutils
# The test framework used to provide these, but not it doesn't. We'll add
# messages to as we find bugs (if indeed we find bugs).
msgs = []
rawmsgs = []
2005-01-19 14:14:38 +01:00
class IrcMsgTestCase(SupyTestCase):
def testLen(self):
for msg in msgs:
if msg.prefix:
strmsg = str(msg)
self.assertFalse(len(msg) != len(strmsg) and \
2005-01-19 14:14:38 +01:00
strmsg.replace(':', '') == strmsg)
def testRepr(self):
IrcMsg = ircmsgs.IrcMsg
for msg in msgs:
self.assertEqual(msg, eval(repr(msg)))
def testStr(self):
for (rawmsg, msg) in zip(rawmsgs, msgs):
strmsg = str(msg).strip()
self.assertFalse(rawmsg != strmsg and \
2005-01-19 14:14:38 +01:00
strmsg.replace(':', '') == strmsg)
def testEq(self):
for msg in msgs:
self.assertEqual(msg, msg)
self.assertFalse(msgs and msgs[0] == []) # Comparison to unhashable type.
2005-01-19 14:14:38 +01:00
def testNe(self):
for msg in msgs:
self.assertFalse(msg != msg)
2005-01-19 14:14:38 +01:00
## def testImmutability(self):
## s = 'something else'
## t = ('foo', 'bar', 'baz')
## for msg in msgs:
## self.assertRaises(AttributeError, setattr, msg, 'prefix', s)
## self.assertRaises(AttributeError, setattr, msg, 'nick', s)
## self.assertRaises(AttributeError, setattr, msg, 'user', s)
## self.assertRaises(AttributeError, setattr, msg, 'host', s)
## self.assertRaises(AttributeError, setattr, msg, 'command', s)
## self.assertRaises(AttributeError, setattr, msg, 'args', t)
## if msg.args:
## def setArgs(msg):
## msg.args[0] = s
## self.assertRaises(TypeError, setArgs, msg)
def testInit(self):
for msg in msgs:
self.assertEqual(msg, ircmsgs.IrcMsg(prefix=msg.prefix,
command=msg.command,
args=msg.args))
self.assertEqual(msg, ircmsgs.IrcMsg(msg=msg))
self.assertRaises(ValueError,
ircmsgs.IrcMsg,
args=('foo', 'bar'),
prefix='foo!bar@baz')
2015-08-22 18:36:47 +02:00
m = ircmsgs.IrcMsg(prefix='foo!bar@baz', args=('foo', 'bar'),
command='CMD')
self.assertIs(m.time, None)
m.time = 24
self.assertEqual(ircmsgs.IrcMsg(msg=m).time, 24)
2005-01-19 14:14:38 +01:00
def testPickleCopy(self):
for msg in msgs:
self.assertEqual(msg, pickle.loads(pickle.dumps(msg)))
self.assertEqual(msg, copy.copy(msg))
def testHashNotZero(self):
zeroes = 0
for msg in msgs:
if hash(msg) == 0:
zeroes += 1
self.assertFalse(zeroes > (len(msgs)/10), 'Too many zero hashes.')
2005-01-19 14:14:38 +01:00
def testMsgKeywordHandledProperly(self):
msg = ircmsgs.notice('foo', 'bar')
msg2 = ircmsgs.IrcMsg(msg=msg, command='PRIVMSG')
self.assertEqual(msg2.command, 'PRIVMSG')
self.assertEqual(msg2.args, msg.args)
def testSplit(self):
msg = ircmsgs.IrcMsg(s=':foo bar baz :qux')
self.assertEqual(msg.prefix, 'foo')
self.assertEqual(msg.command, 'bar')
self.assertEqual(msg.args, ('baz', 'qux'))
msg = ircmsgs.IrcMsg(s=':foo\tbar baz')
self.assertEqual(msg.prefix, 'foo\tbar')
self.assertEqual(msg.command, 'baz')
msg = ircmsgs.IrcMsg(s=':foo bar\tbaz')
self.assertEqual(msg.prefix, 'foo')
self.assertEqual(msg.command, 'bar\tbaz')
2005-01-19 14:14:38 +01:00
def testMalformedIrcMsgRaised(self):
self.assertRaises(ircmsgs.MalformedIrcMsg, ircmsgs.IrcMsg, ':foo')
self.assertRaises(ircmsgs.MalformedIrcMsg, ircmsgs.IrcMsg,
args=('biff',), prefix='foo!bar@baz')
def testTags(self):
m = ircmsgs.privmsg('foo', 'bar')
self.assertFalse(m.repliedTo)
2005-01-19 14:14:38 +01:00
m.tag('repliedTo')
self.assertTrue(m.repliedTo)
2005-01-19 14:14:38 +01:00
m.tag('repliedTo')
self.assertTrue(m.repliedTo)
2005-01-19 14:14:38 +01:00
m.tag('repliedTo', 12)
self.assertEqual(m.repliedTo, 12)
2015-05-15 18:08:50 +02:00
def testServerTags(self):
s = r'@aaa=b\:bb;ccc;example.com/ddd=ee\\se ' \
r':nick!ident@host.com PRIVMSG me :Hello'
2015-05-15 18:08:50 +02:00
m = ircmsgs.IrcMsg(s)
self.assertEqual(m.server_tags, {
'aaa': 'b;bb',
'ccc': None,
'example.com/ddd': 'ee\\se'})
self.assertEqual(m.prefix, 'nick!ident@host.com')
self.assertEqual(m.command, 'PRIVMSG')
self.assertEqual(m.args, ('me', 'Hello'))
self.assertEqual(str(m), s + '\n')
m._str = None # Clear the cache (set before parsing)
tag_set = [r'aaa=b\:bb', r'ccc', r'example.com/ddd=ee\\se']
expected = [
'@' + ';'.join(tags)
+ ' :nick!ident@host.com PRIVMSG me :Hello\r\n'
for tags in itertools.permutations(tag_set)]
self.assertIn(str(m), expected)
2015-05-15 18:08:50 +02:00
# bar\1 is equivalent to baz1
s = r'@foo=;bar=baz\1;qux= ' \
r':nick!ident@host.com PRIVMSG me :Hello'
m = ircmsgs.IrcMsg(s)
self.assertEqual(m.server_tags, {
'foo': None,
'bar': 'baz1',
'qux': None})
# bar\ is equivalent to baz
s = r'@foo=;bar=baz\;qux= ' \
r':nick!ident@host.com PRIVMSG me :Hello'
m = ircmsgs.IrcMsg(s)
self.assertEqual(m.server_tags, {
'foo': None,
'bar': 'baz',
'qux': None})
s = r'@foo=;bar=baz;qux= ' \
r':nick!ident@host.com PRIVMSG me :Hello'
m = ircmsgs.IrcMsg(s)
self.assertEqual(m.server_tags, {
'foo': None,
'bar': 'baz',
'qux': None})
2015-08-22 18:36:47 +02:00
def testTime(self):
before = time.time()
msg = ircmsgs.IrcMsg('PRIVMSG #foo :foo')
after = time.time()
self.assertTrue(before <= msg.time <= after)
msg = ircmsgs.IrcMsg('@time=2011-10-19T16:40:51.620Z '
':Angel!angel@example.org PRIVMSG Wiz :Hello')
2015-08-22 20:38:16 +02:00
self.assertEqual(msg.time, 1319042451.62)
2005-01-19 14:14:38 +01:00
class FunctionsTestCase(SupyTestCase):
def testIsAction(self):
L = [':jemfinch!~jfincher@ts26-2.homenet.ohio-state.edu PRIVMSG'
' #sourcereview :ACTION does something',
':supybot!~supybot@underthemain.net PRIVMSG #sourcereview '
':ACTION beats angryman senseless with a Unix manual (#2)',
':supybot!~supybot@underthemain.net PRIVMSG #sourcereview '
':ACTION beats ang senseless with a 50lb Unix manual (#2)',
':supybot!~supybot@underthemain.net PRIVMSG #sourcereview '
':ACTION resizes angryman\'s terminal to 40x24 (#16)']
msgs = list(map(ircmsgs.IrcMsg, L))
2005-01-19 14:14:38 +01:00
for msg in msgs:
self.assertTrue(ircmsgs.isAction(msg))
2005-01-19 14:14:38 +01:00
def testIsActionIsntStupid(self):
m = ircmsgs.privmsg('#x', '\x01NOTANACTION foo\x01')
self.assertFalse(ircmsgs.isAction(m))
2005-01-19 14:14:38 +01:00
m = ircmsgs.privmsg('#x', '\x01ACTION foo bar\x01')
self.assertTrue(ircmsgs.isAction(m))
2005-01-19 14:14:38 +01:00
def testIsCtcp(self):
self.assertTrue(ircmsgs.isCtcp(ircmsgs.privmsg('foo',
2005-01-19 14:14:38 +01:00
'\x01VERSION\x01')))
self.assertFalse(ircmsgs.isCtcp(ircmsgs.privmsg('foo', '\x01')))
2005-01-19 14:14:38 +01:00
def testIsActionFalseWhenNoSpaces(self):
msg = ircmsgs.IrcMsg('PRIVMSG #foo :\x01ACTIONfoobar\x01')
self.assertFalse(ircmsgs.isAction(msg))
2005-01-19 14:14:38 +01:00
def testUnAction(self):
s = 'foo bar baz'
msg = ircmsgs.action('#foo', s)
self.assertEqual(ircmsgs.unAction(msg), s)
def testPrivmsg(self):
self.assertEqual(str(ircmsgs.privmsg('foo', 'bar')),
'PRIVMSG foo :bar\r\n')
self.assertEqual(str(ircmsgs.privmsg('foo,bar', 'baz')),
'PRIVMSG foo,bar :baz\r\n')
def testWhois(self):
with conf.supybot.protocols.irc.strictRfc.context(True):
self.assertEqual(str(ircmsgs.whois('foo')), 'WHOIS :foo\r\n')
self.assertEqual(str(ircmsgs.whois('foo,bar')), 'WHOIS :foo,bar\r\n')
self.assertRaises(AssertionError, ircmsgs.whois, '#foo')
self.assertRaises(AssertionError, ircmsgs.whois, 'foo,#foo')
2005-01-19 14:14:38 +01:00
def testBan(self):
channel = '#osu'
ban = '*!*@*.edu'
exception = '*!*@*ohio-state.edu'
noException = ircmsgs.ban(channel, ban)
self.assertEqual(ircutils.separateModes(noException.args[1:]),
[('+b', ban)])
withException = ircmsgs.ban(channel, ban, exception)
self.assertEqual(ircutils.separateModes(withException.args[1:]),
[('+b', ban), ('+e', exception)])
def testBans(self):
channel = '#osu'
bans = ['*!*@*', 'jemfinch!*@*']
exceptions = ['*!*@*ohio-state.edu']
noException = ircmsgs.bans(channel, bans)
self.assertEqual(ircutils.separateModes(noException.args[1:]),
[('+b', bans[0]), ('+b', bans[1])])
withExceptions = ircmsgs.bans(channel, bans, exceptions)
self.assertEqual(ircutils.separateModes(withExceptions.args[1:]),
[('+b', bans[0]), ('+b', bans[1]),
('+e', exceptions[0])])
def testUnban(self):
channel = '#supybot'
ban = 'foo!bar@baz'
self.assertEqual(str(ircmsgs.unban(channel, ban)),
'MODE %s -b :%s\r\n' % (channel, ban))
def testJoin(self):
channel = '#osu'
key = 'michiganSucks'
self.assertEqual(ircmsgs.join(channel).args, ('#osu',))
self.assertEqual(ircmsgs.join(channel, key).args,
('#osu', 'michiganSucks'))
def testJoins(self):
channels = ['#osu', '#umich']
keys = ['michiganSucks', 'osuSucks']
self.assertEqual(ircmsgs.joins(channels).args, ('#osu,#umich',))
self.assertEqual(ircmsgs.joins(channels, keys).args,
('#osu,#umich', 'michiganSucks,osuSucks'))
keys.pop()
self.assertEqual(ircmsgs.joins(channels, keys).args,
('#osu,#umich', 'michiganSucks'))
def testQuit(self):
self.assertTrue(ircmsgs.quit(prefix='foo!bar@baz'))
2005-01-19 14:14:38 +01:00
def testOps(self):
m = ircmsgs.ops('#foo', ['foo', 'bar', 'baz'])
self.assertEqual(str(m), 'MODE #foo +ooo foo bar :baz\r\n')
def testDeops(self):
m = ircmsgs.deops('#foo', ['foo', 'bar', 'baz'])
self.assertEqual(str(m), 'MODE #foo -ooo foo bar :baz\r\n')
def testVoices(self):
m = ircmsgs.voices('#foo', ['foo', 'bar', 'baz'])
self.assertEqual(str(m), 'MODE #foo +vvv foo bar :baz\r\n')
def testDevoices(self):
m = ircmsgs.devoices('#foo', ['foo', 'bar', 'baz'])
self.assertEqual(str(m), 'MODE #foo -vvv foo bar :baz\r\n')
def testHalfops(self):
m = ircmsgs.halfops('#foo', ['foo', 'bar', 'baz'])
self.assertEqual(str(m), 'MODE #foo +hhh foo bar :baz\r\n')
def testDehalfops(self):
m = ircmsgs.dehalfops('#foo', ['foo', 'bar', 'baz'])
self.assertEqual(str(m), 'MODE #foo -hhh foo bar :baz\r\n')
def testMode(self):
m = ircmsgs.mode('#foo', ('-b', 'foo!bar@baz'))
s = str(m)
self.assertEqual(s, 'MODE #foo -b :foo!bar@baz\r\n')
def testIsSplit(self):
m = ircmsgs.IrcMsg(prefix="caker!~caker@ns.theshore.net",
command="QUIT",
args=('jupiter.oftc.net quasar.oftc.net',))
self.assertTrue(ircmsgs.isSplit(m))
m = ircmsgs.IrcMsg(prefix="bzbot!Brad2901@ACC87473.ipt.aol.com",
command="QUIT",
args=('Read error: 110 (Connection timed out)',))
self.assertFalse(ircmsgs.isSplit(m))
m = ircmsgs.IrcMsg(prefix="JibberJim!~none@8212cl.b0nwbeoe.co.uk",
command="QUIT",
args=('"Bye!"',))
self.assertFalse(ircmsgs.isSplit(m))
2005-01-19 14:14:38 +01:00
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: