twisted.words.test.test_irc.ServerSupportedFeatureTests

class documentation

class ServerSupportedFeatureTests(IRCTestCase): (source)

View In Hierarchy

Tests for ServerSupportedFeatures and related functions.

Method test_intOrDefault _intOrDefault converts values to int if possible, otherwise returns a default value.
Method test_parse ServerSupportedFeatures.parse changes the internal state of the instance to reflect the features indicated by the parsed ISUPPORT parameters, including unknown parameters and unsetting previously set parameters.
Method test_parseChanModesParam ServerSupportedFeatures._parseChanModesParam parses the ISUPPORT CHANMODES parameter into a mapping from mode categories to mode characters. Passing fewer than 4 parameters results in the empty string for the relevant categories...
Method test_parsePrefixParam ServerSupportedFeatures._parsePrefixParam parses the ISUPPORT PREFIX parameter into a mapping from modes to prefix symbols, returns None if there is no parseable prefix parameter or raises ValueError if the prefix parameter is malformed.
Method test_splitParam ServerSupportedFeatures._splitParam splits ISUPPORT parameters into key and values. Parameters without a separator are split into a key and a list containing only the empty string. Escaped parameters are unescaped.
Method test_splitParamArgs ServerSupportedFeatures._splitParamArgs splits ISUPPORT parameter arguments into key and value. Arguments without a separator are split into a key and an empty string.
Method test_splitParamArgsProcessor ServerSupportedFeatures._splitParamArgs uses the argument processor passed to convert ISUPPORT argument values to some more suitable form.
Method test_support_CHANMODES The CHANMODES ISUPPORT parameter is parsed into a dict giving the four mode categories, 'addressModes', 'param', 'setParam', and 'noParam'.
Method test_support_CHANNELLEN The CHANNELLEN support parameter is parsed into an integer value indicating the maximum channel name length, otherwise, if the parameter is missing or invalid, the default value (as specified by RFC 1459) is used.
Method test_support_CHANTYPES The CHANTYPES support parameter is parsed into a tuple of valid channel prefix characters.
Method test_support_EXCEPTS The EXCEPTS support parameter is parsed into the mode character to be used for "ban exception" modes. If no parameter is specified then the character e is assumed.
Method test_support_IDCHAN The IDCHAN support parameter is parsed into a sequence of two-tuples giving channel prefix and ID length pairs.
Method test_support_INVEX The INVEX support parameter is parsed into the mode character to be used for "invite exception" modes. If no parameter is specified then the character I is assumed.
Method test_support_KICKLEN The KICKLEN support parameter is parsed into an integer value indicating the maximum length of a kick message a client may use.
Method test_support_MAXLIST The MAXLIST support parameter is parsed into a sequence of two-tuples giving modes and their limits.
Method test_support_MODES The MODES support parameter is parsed into an integer value indicating the maximum number of "variable" modes (defined as being modes from addressModes, param or setParam categories for the CHANMODES ISUPPORT parameter) which may by set on a channel by a single MODE command from a client.
Method test_support_NETWORK The NETWORK support parameter is parsed as the network name, as specified by the server.
Method test_support_NICKLEN The NICKLEN support parameter is parsed into an integer value indicating the maximum length of a nickname the client may use, otherwise, if the parameter is missing or invalid, the default value (as specified by RFC 1459) is used.
Method test_support_PREFIX The PREFIX support parameter is parsed into a dictionary mapping modes to two-tuples of status symbol and priority.
Method test_support_SAFELIST The SAFELIST support parameter is parsed into a boolean indicating whether the safe "list" command is supported or not.
Method test_support_STATUSMSG The STATUSMSG support parameter is parsed into a string of channel status that support the exclusive channel notice method.
Method test_support_TARGMAX The TARGMAX support parameter is parsed into a dictionary, mapping strings to integers, of the maximum number of targets for a particular command.
Method test_support_TOPICLEN The TOPICLEN support parameter is parsed into an integer value indicating the maximum length of a topic a client may set.
Method _parse Parse all specified features according to the ISUPPORT specifications.
Method _parseFeature Parse a feature, with the given name and value, according to the ISUPPORT specifications and return the parsed value.
Method _testFeatureDefault Features known to have default values are reported as being present by irc.ServerSupportedFeatures.hasFeature, and their value defaults correctly, when they don't appear in an ISUPPORT message.
Method _testIntOrDefaultFeature Perform some common tests on a feature known to use _intOrDefault.

Inherited from IRCTestCase:

Method assertEqualBufferValue A buffer is always bytes, but sometimes we need to compare it to a utf-8 unicode string

Inherited from TestCase (via IRCTestCase):

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method assertFailure Fail if deferred does not errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
Instance Variable timeout A real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
Method _deprecateReactor Deprecate iterate, crash and stop on reactor. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
Method _runFixturesAndTest Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via IRCTestCase, TestCase):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
Method callDeprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method shortDescription Undocumented
Instance Variable failureException An exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable skip None or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
Instance Variable suppress None or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
Instance Variable todo None, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via IRCTestCase, TestCase, SynchronousTestCase):

Method assertAlmostEqual Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertApproximates Fail if first - second > tolerance
Method assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
Method assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertNotAlmostEqual Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
Method assertRaises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
Method assertWarns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def test_intOrDefault(self): (source)

_intOrDefault converts values to int if possible, otherwise returns a default value.

def test_parse(self): (source)

ServerSupportedFeatures.parse changes the internal state of the instance to reflect the features indicated by the parsed ISUPPORT parameters, including unknown parameters and unsetting previously set parameters.

def test_parseChanModesParam(self): (source)

ServerSupportedFeatures._parseChanModesParam parses the ISUPPORT CHANMODES parameter into a mapping from mode categories to mode characters. Passing fewer than 4 parameters results in the empty string for the relevant categories. Passing more than 4 parameters raises ValueError.

def test_parsePrefixParam(self): (source)

ServerSupportedFeatures._parsePrefixParam parses the ISUPPORT PREFIX parameter into a mapping from modes to prefix symbols, returns None if there is no parseable prefix parameter or raises ValueError if the prefix parameter is malformed.

def test_splitParam(self): (source)

ServerSupportedFeatures._splitParam splits ISUPPORT parameters into key and values. Parameters without a separator are split into a key and a list containing only the empty string. Escaped parameters are unescaped.

def test_splitParamArgs(self): (source)

ServerSupportedFeatures._splitParamArgs splits ISUPPORT parameter arguments into key and value. Arguments without a separator are split into a key and an empty string.

def test_splitParamArgsProcessor(self): (source)

ServerSupportedFeatures._splitParamArgs uses the argument processor passed to convert ISUPPORT argument values to some more suitable form.

def test_support_CHANMODES(self): (source)

The CHANMODES ISUPPORT parameter is parsed into a dict giving the four mode categories, 'addressModes', 'param', 'setParam', and 'noParam'.

def test_support_CHANNELLEN(self): (source)

The CHANNELLEN support parameter is parsed into an integer value indicating the maximum channel name length, otherwise, if the parameter is missing or invalid, the default value (as specified by RFC 1459) is used.

def test_support_CHANTYPES(self): (source)

The CHANTYPES support parameter is parsed into a tuple of valid channel prefix characters.

def test_support_EXCEPTS(self): (source)

The EXCEPTS support parameter is parsed into the mode character to be used for "ban exception" modes. If no parameter is specified then the character e is assumed.

def test_support_IDCHAN(self): (source)

The IDCHAN support parameter is parsed into a sequence of two-tuples giving channel prefix and ID length pairs.

def test_support_INVEX(self): (source)

The INVEX support parameter is parsed into the mode character to be used for "invite exception" modes. If no parameter is specified then the character I is assumed.

def test_support_KICKLEN(self): (source)

The KICKLEN support parameter is parsed into an integer value indicating the maximum length of a kick message a client may use.

def test_support_MAXLIST(self): (source)

The MAXLIST support parameter is parsed into a sequence of two-tuples giving modes and their limits.

def test_support_MODES(self): (source)

The MODES support parameter is parsed into an integer value indicating the maximum number of "variable" modes (defined as being modes from addressModes, param or setParam categories for the CHANMODES ISUPPORT parameter) which may by set on a channel by a single MODE command from a client.

def test_support_NETWORK(self): (source)

The NETWORK support parameter is parsed as the network name, as specified by the server.

def test_support_NICKLEN(self): (source)

The NICKLEN support parameter is parsed into an integer value indicating the maximum length of a nickname the client may use, otherwise, if the parameter is missing or invalid, the default value (as specified by RFC 1459) is used.

def test_support_PREFIX(self): (source)

The PREFIX support parameter is parsed into a dictionary mapping modes to two-tuples of status symbol and priority.

def test_support_SAFELIST(self): (source)

The SAFELIST support parameter is parsed into a boolean indicating whether the safe "list" command is supported or not.

def test_support_STATUSMSG(self): (source)

The STATUSMSG support parameter is parsed into a string of channel status that support the exclusive channel notice method.

def test_support_TARGMAX(self): (source)

The TARGMAX support parameter is parsed into a dictionary, mapping strings to integers, of the maximum number of targets for a particular command.

def test_support_TOPICLEN(self): (source)

The TOPICLEN support parameter is parsed into an integer value indicating the maximum length of a topic a client may set.

def _parse(self, features): (source)

Parse all specified features according to the ISUPPORT specifications.

Parameters
features:list of (featureName, value)Feature names and values to parse
Returns
irc.ServerSupportedFeaturesUndocumented
def _parseFeature(self, name, value=None): (source)

Parse a feature, with the given name and value, according to the ISUPPORT specifications and return the parsed value.

def _testFeatureDefault(self, name, features=None): (source)

Features known to have default values are reported as being present by irc.ServerSupportedFeatures.hasFeature, and their value defaults correctly, when they don't appear in an ISUPPORT message.

def _testIntOrDefaultFeature(self, name, default=None): (source)

Perform some common tests on a feature known to use _intOrDefault.