val/irctest
1
0
Fork 0
mirror of https://github.com/progval/irctest.git synced 2025-04-06 07:19:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make the set of tested specifications configurable.

Browse Source
This commit is contained in:
Valentin Lorentz
2015-12-22 19:55:48 +01:00
parent ef8adc7ede
commit 2cc4ad4f0f
13 changed files with 91 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
irctest/__main__.py
View File

@ -6,6 +6,7 @@ import functools
import importlib
from .cases import _IrcTestCase
from .runner import TextTestRunner
from .specifications import Specifications
from .basecontrollers import BaseClientController, BaseServerController
def main(args):
@ -28,6 +29,21 @@ def main(args):
exit(1)
_IrcTestCase.controllerClass = controller_class
_IrcTestCase.show_io = args.show_io
if args.specification:
try:
_IrcTestCase.testedSpecifications = frozenset(
Specifications.of_name(x) for x in args.specification
)
except ValueError:
print('Invalid set of specifications: {}'
.format(', '.join(args.specification)))
exit(1)
else:
_IrcTestCase.testedSpecifications = frozenset(
Specifications)
print('Testing {} on specification(s): {}'.format(
controller_class.software_name,
', '.join(map(lambda x:x.value, _IrcTestCase.testedSpecifications))))
ts = module.discover()
testRunner = TextTestRunner(
verbosity=args.verbose,
@ -45,6 +61,12 @@ parser.add_argument('--show-io', action='store_true',
help='Show input/outputs with the tested program.')
parser.add_argument('-v', '--verbose', action='count', default=1,
help='Verbosity.')
parser.add_argument('-s', '--specification', type=str, action='append',
help=('The set of specifications to test the program with. '
'Valid values: {}. '
'Use this option multiple times to test with multiple '
'specifications. If it is not given, defaults to all.')
.format(list(map(str, Specifications))))
args = parser.parse_args()

22
irctest/cases.py
View File

@ -6,11 +6,12 @@ import collections
import supybot.utils
from . import runner
from . import client_mock
from . import authentication
from . import runner
from .irc_utils import message_parser
from .irc_utils import capabilities
from .irc_utils import message_parser
from .specifications import Specifications
class _IrcTestCase(unittest.TestCase):
"""Base class for test cases."""
@ -334,3 +335,20 @@ class OptionalityHelper:
return f(self)
return newf
class SpecificationSelector:
def requiredBySpecification(*specifications):
specifications = frozenset(
Specifications.of_name(s) if isinstance(s, str) else s
for s in specifications)
if None in specifications:
raise ValueError('Invalid set of specifications: {}'
.format(specifications))
def decorator(f):
@functools.wraps(f)
def newf(self):
if specifications.isdisjoint(self.testedSpecifications):
raise runner.NotRequiredBySpecifications()
return f(self)
return newf
return decorator

2
irctest/client_tests/test_cap.py
View File

@ -2,10 +2,12 @@ from irctest import cases
from irctest.irc_utils.message_parser import Message
class CapTestCase(cases.BaseClientTestCase, cases.ClientNegociationHelper):
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1', 'IRCv3.2')
def testSendCap(self):
"""Send CAP LS 302 and read the result."""
self.readCapLs()
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1', 'IRCv3.2')
def testEmptyCapLs(self):
"""Empty result to CAP LS. Client should send CAP END."""
m = self.negotiateCapabilities([])

1
irctest/controllers/charybdis.py
View File

@ -32,6 +32,7 @@ channel {{
}};
"""
class CharybdisController(BaseServerController, DirectoryBasedController):
software_name = 'Charybdis'
supported_sasl_mechanisms = set()
def create_config(self):
super().create_config()

1
irctest/controllers/inspircd.py
View File

@ -20,6 +20,7 @@ TEMPLATE_CONFIG = """
"""
class InspircdController(BaseServerController, DirectoryBasedController):
software_name = 'InspIRCd'
supported_sasl_mechanisms = set()
def create_config(self):
super().create_config()

1
irctest/controllers/limnoria.py
View File

@ -18,6 +18,7 @@ supybot.networks.testnet.sasl.mechanisms: {mechanisms}
"""
class LimnoriaController(BaseClientController, DirectoryBasedController):
software_name = 'Limnoria'
supported_sasl_mechanisms = {
'PLAIN', 'ECDSA-NIST256P-CHALLENGE', 'EXTERNAL',
}

1
irctest/controllers/mammon.py
View File

@ -56,6 +56,7 @@ server:
"""
class MammonController(BaseServerController, DirectoryBasedController):
software_name = 'Mammon'
supported_sasl_mechanisms = {
'PLAIN', 'ECDSA-NIST256P-CHALLENGE',
}

1
irctest/controllers/sopel.py
View File

@ -19,6 +19,7 @@ auth_password = {password}
"""
class SopelController(BaseClientController):
software_name = 'Sopel'
supported_sasl_mechanisms = {
'PLAIN',
}

6
irctest/runner.py
View File

@ -19,13 +19,17 @@ class OptionalSaslMechanismNotSupported(unittest.SkipTest):
def __str__(self):
return 'Unsupported SASL mechanism: {}'.format(self.args[0])
class NotRequiredBySpecifications(unittest.SkipTest):
def __str__(self):
return 'Tests not required by the set of tested specification(s).'
class TextTestResult(unittest.TextTestResult):
def getDescription(self, test):
if hasattr(test, 'description'):
doc_first_lines = test.description()
else:
doc_first_lines = test.shortDescription()
return '\n'.join((str(test), doc_first_lines))
return '\n'.join((str(test), doc_first_lines or ''))
class TextTestRunner(unittest.TextTestRunner):
"""Small wrapper around unittest.TextTestRunner that reports the

4
irctest/server_tests/test_cap.py
View File

@ -2,6 +2,7 @@ from irctest import cases
from irctest.irc_utils.message_parser import Message
class CapTestCase(cases.BaseServerTestCase):
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
def testNoReq(self):
"""Test the server handles gracefully clients which do not send
REQs.
@ -20,6 +21,7 @@ class CapTestCase(cases.BaseServerTestCase):
self.assertMessageEqual(m, command='001',
fail_msg='Expected 001 after sending CAP END, got {msg}.')
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
def testReqUnavailable(self):
"""Test the server handles gracefully clients which request
capabilities that are not available.
@ -41,6 +43,7 @@ class CapTestCase(cases.BaseServerTestCase):
self.assertMessageEqual(m, command='001',
fail_msg='Expected 001 after sending CAP END, got {msg}.')
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
def testNakExactString(self):
"""“The argument of the NAK subcommand MUST consist of at least the
first 100 characters of the capability list in the REQ subcommand which
@ -59,6 +62,7 @@ class CapTestCase(cases.BaseServerTestCase):
fail_msg='Expected “CAP NAK :foo qux bar baz qux quux” after '
'sending “CAP REQ :foo qux bar baz qux quux”, but got {msg}.')
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
def testNakWhole(self):
"""“The capability identifier set must be accepted as a whole, or
rejected entirely.”

12
irctest/server_tests/test_channel_operations.py
View File

@ -10,6 +10,7 @@ from irctest.irc_utils import ambiguities
from irctest.irc_utils.message_parser import Message
class JoinTestCase(cases.BaseServerTestCase):
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testJoinAllMessages(self):
"""“If a JOIN is successful, the user receives a JOIN message as
confirmation and is then sent the channel's topic (using RPL_TOPIC) and
@ -35,6 +36,7 @@ class JoinTestCase(cases.BaseServerTestCase):
self.assertTrue(received_commands & {'331', '332'} != set(), # RPL_NOTOPIC, RPL_TOPIC
'Server sent neither 331 (RPL_NOTOPIC) or 332 (RPL_TOPIC)')
@cases.SpecificationSelector.requiredBySpecification('RFC2812')
def testJoinNamreply(self):
"""“353 RPL_NAMREPLY
"( "=" / "*" / "@" ) <channel>
@ -63,6 +65,7 @@ class JoinTestCase(cases.BaseServerTestCase):
'{msg}')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testPartNotInEmptyChannel(self):
"""“442 ERR_NOTONCHANNEL
"<channel> :You're not on that channel"
@ -94,6 +97,7 @@ class JoinTestCase(cases.BaseServerTestCase):
'ERR_NOSUCHCHANNEL (403) after PARTing an empty channel '
'one is not on, but got: {msg}')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testPartNotInNonEmptyChannel(self):
self.connectClient('foo')
self.connectClient('bar')
@ -134,6 +138,7 @@ class JoinTestCase(cases.BaseServerTestCase):
'"foo" with an optional "+" or "@" prefix, but got: '
'{msg}')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testTopic(self):
"""“Once a user has joined a channel, he receives information about
all commands his server receives affecting the channel. This
@ -166,6 +171,7 @@ class JoinTestCase(cases.BaseServerTestCase):
m = self.getMessage(2)
self.assertMessageEqual(m, command='TOPIC', params=['#chan', 'T0P1C'])
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testTopicMode(self):
"""“Once a user has joined a channel, he receives information about
all commands his server receives affecting the channel. This
@ -215,6 +221,7 @@ class JoinTestCase(cases.BaseServerTestCase):
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testListEmpty(self):
"""<https://tools.ietf.org/html/rfc1459#section-4.2.6>
<https://tools.ietf.org/html/rfc2812#section-3.2.6>
@ -235,6 +242,7 @@ class JoinTestCase(cases.BaseServerTestCase):
fail_msg='Second reply to LIST is not 322 (RPL_LIST) '
'or 323 (RPL_LISTEND), or but: {msg}')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testListOne(self):
"""When a channel exists, LIST should get it in a reply.
<https://tools.ietf.org/html/rfc1459#section-4.2.6>
@ -264,6 +272,7 @@ class JoinTestCase(cases.BaseServerTestCase):
fail_msg='Third reply to LIST is not 322 (RPL_LIST) '
'or 323 (RPL_LISTEND), or but: {msg}')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testKickSendsMessages(self):
"""“Once a user has joined a channel, he receives information about
all commands his server receives affecting the channel. This
@ -301,6 +310,7 @@ class JoinTestCase(cases.BaseServerTestCase):
self.assertMessageEqual(m, command='KICK',
params=['#chan', 'bar', 'bye'])
@cases.SpecificationSelector.requiredBySpecification('RFC2812')
def testDoubleKickMessages(self):
"""“The server MUST NOT send KICK messages with multiple channels or
users to clients. This is necessarily to maintain backward
@ -347,6 +357,7 @@ class JoinTestCase(cases.BaseServerTestCase):
class testChannelCaseSensitivity(cases.BaseServerTestCase):
def _testChannelsEquivalent(name1, name2):
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def f(self):
self.connectClient('foo')
self.connectClient('bar')
@ -363,6 +374,7 @@ class testChannelCaseSensitivity(cases.BaseServerTestCase):
f.__name__ = 'testEquivalence__{}__{}'.format(name1, name2)
return f
def _testChannelsNotEquivalent(name1, name2):
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def f(self):
self.connectClient('foo')
self.connectClient('bar')

17
irctest/server_tests/test_connection_registration.py
View File

@ -11,6 +11,7 @@ from irctest.client_mock import ConnectionClosed
class PasswordedConnectionRegistrationTestCase(cases.BaseServerTestCase):
password = 'testpassword'
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testPassBeforeNickuser(self):
self.addClient()
self.sendLine(1, 'PASS {}'.format(self.password))
@ -21,6 +22,7 @@ class PasswordedConnectionRegistrationTestCase(cases.BaseServerTestCase):
self.assertMessageEqual(m, command='001',
fail_msg='Did not get 001 after correct PASS+NICK+USER: {msg}')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testNoPassword(self):
self.addClient()
self.sendLine(1, 'NICK foo')
@ -29,6 +31,7 @@ class PasswordedConnectionRegistrationTestCase(cases.BaseServerTestCase):
self.assertNotEqual(m.command, '001',
msg='Got 001 after NICK+USER but missing PASS')
@cases.SpecificationSelector.requiredBySpecification('RFC1459', 'RFC2812')
def testPassAfterNickuser(self):
"""“The password can and must be set before any attempt to register
the connection is made.”
@ -49,6 +52,7 @@ class PasswordedConnectionRegistrationTestCase(cases.BaseServerTestCase):
'Got 001 after PASS sent after NICK+USER')
class ConnectionRegistrationTestCase(cases.BaseServerTestCase):
@cases.SpecificationSelector.requiredBySpecification('RFC1459')
def testQuitDisconnects(self):
"""“The server must close the connection to a client which sends a
QUIT message.”
@ -59,6 +63,19 @@ class ConnectionRegistrationTestCase(cases.BaseServerTestCase):
self.sendLine(1, 'QUIT')
self.assertRaises(ConnectionClosed, self.getMessages, 1) # Connection was not closed after QUIT.
@cases.SpecificationSelector.requiredBySpecification('RFC2812')
def testQuitErrors(self):
"""“The server must close the connection to a client which sends a
QUIT message.”
-- <https://tools.ietf.org/html/rfc1459#section-4.1.3>
"""
self.connectClient('foo')
self.getMessages(1)
self.sendLine(1, 'QUIT')
commands = {m.command for me in self.getMessages(1)}
self.assertIn('ERROR', commands,
fail_msg='Did not receive ERROR as a reply to QUIT.')
def testNickCollision(self):
"""A user connects and requests the same nickname as an already
registered user.

5
irctest/server_tests/test_sasl.py
View File

@ -8,6 +8,7 @@ class RegistrationTestCase(cases.BaseServerTestCase):
self.controller.registerUser(self, 'testuser', 'mypassword')
class SaslTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
@cases.OptionalityHelper.skipUnlessHasMechanism('PLAIN')
def testPlain(self):
"""PLAIN authentication with correct username/password."""
@ -36,7 +37,7 @@ class SaslTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
fail_msg='900 should contain the account name as 3rd argument '
'({expects}), not {got}: {msg}')
@cases.OptionalityHelper.skipUnlessHasSasl
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
def testMechanismNotAvailable(self):
"""“If authentication fails, a 904 or 905 numeric will be sent”
-- <http://ircv3.net/specs/extensions/sasl-3.1.html#the-authenticate-command>
@ -52,6 +53,7 @@ class SaslTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
self.assertMessageEqual(m, command='904',
fail_msg='Did not reply with 904 to “AUTHENTICATE FOO”: {msg}')
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
@cases.OptionalityHelper.skipUnlessHasMechanism('PLAIN')
def testPlainLarge(self):
"""Test the client splits large AUTHENTICATE messages whose payload
@ -92,6 +94,7 @@ class SaslTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
# I don't know how to do it, because it would make the registration
# message's length too big for it to be valid.
@cases.SpecificationSelector.requiredBySpecification('IRCv3.1')
@cases.OptionalityHelper.skipUnlessHasMechanism('PLAIN')
def testPlainLargeEquals400(self):
"""Test the client splits large AUTHENTICATE messages whose payload