twisted.words.test.test_irc.ClientMsgTests(IRCTestCase) class documentation

Part of twisted.words.test.test_irc (View In Hierarchy)

Tests for messages sent with twisted.words.protocols.irc.IRCClient.

Method setUp Undocumented
Method test_singleLine A message containing no newlines is sent in a single command.
Method test_invalidMaxLength Specifying a length value to IRCClient.msg that is too short to contain the protocol command to send a message raises ValueError.
Method test_multipleLine Messages longer than the length parameter to IRCClient.msg will be split and sent in multiple commands.
Method test_sufficientWidth Messages exactly equal in length to the length parameter to IRCClient.msg are sent in a single command.
Method test_newlinesAtStart An LF at the beginning of the message is ignored.
Method test_newlinesAtEnd An LF at the end of the message is ignored.
Method test_newlinesWithinMessage An LF within a message causes a new line.
Method test_consecutiveNewlines Consecutive LFs do not cause a blank line.
Method assertLongMessageSplitting Assert that messages sent by IRCClient.msg are split into an expected number of commands and the original message is transmitted in its entirety over those commands.
Method test_splitLongMessagesWithDefault No summary
Method test_splitLongMessagesWithOverride No summary
Method test_newlinesBeforeLineBreaking IRCClient breaks on newlines before it breaks long lines.
Method test_lineBreakOnWordBoundaries IRCClient prefers to break long lines at word boundaries.
Method test_splitSanity twisted.words.protocols.irc.split raises ValueError if given a length less than or equal to 0 and returns [] when splitting ''.
Method test_splitDelimiters No summary
Method test_splitValidatesLength twisted.words.protocols.irc.split raises ValueError if given a length less than or equal to 0.
Method test_say IRCClient.say prepends the channel prefix "#" if necessary and then sends the message to the server for delivery to that channel.

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):

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 __init__ Construct an asynchronous test case for methodName.
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 __call__ Run the test. Should always do exactly the same thing as run().
Method deferSetUp Undocumented
Method deferTestMethod Undocumented
Method deferTearDown Undocumented
Method deferRunCleanups Run any scheduled cleanups and report errors (if any to the result object.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method getSuppress Undocumented
Method getTimeout No summary
Method _run Run a single method, either a test method or fixture.
Method _ebDeferSetUp Undocumented
Method _cbDeferTestMethod Undocumented
Method _ebDeferTestMethod Undocumented
Method _ebDeferTearDown Undocumented
Method _cbDeferRunCleanups Undocumented
Method _cleanUp Undocumented
Method _classCleanUp Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
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 _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _runCleanups Run the cleanups added with addCleanup in order.
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 _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via IRCTestCase, TestCase):

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 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.
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.
Method __eq__ No summary
Method __ne__ Undocumented
Method __hash__ Undocumented
Method shortDescription Undocumented
Method getSkip No summary
Method getTodo No summary
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 run Run the test case, storing the results in result.
Method patch Monkey patch an object for the duration of the test.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
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 mktemp Create a new path name which can be used for a new file or directory.
Method _getSuppress No summary
Method _getSkipReason Return the reason to use for skipping a test method.
Method _installObserver Undocumented
Method _removeObserver Undocumented

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

Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method assertFalse Fail the test if condition evaluates to True.
Method assertTrue Fail the test if condition evaluates to False.
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 assertEqual Fail the test if first and second are not equal.
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 assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNotEqual Fail the test if first == second.
Method assertIn Fail the test if containee is not found in container.
Method assertNotIn Fail the test if containee is found in container.
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 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 assertSubstring Fail if substring does not exist within astring.
Method assertNotSubstring Fail if astring contains substring.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method successResultOf Return the current success result of deferred or raise self.failureException.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertRegex Fail the test if a regexp search of text fails.
def setUp(self):
Undocumented
def test_singleLine(self):

A message containing no newlines is sent in a single command.

def test_invalidMaxLength(self):

Specifying a length value to IRCClient.msg that is too short to contain the protocol command to send a message raises ValueError.

def test_multipleLine(self):

Messages longer than the length parameter to IRCClient.msg will be split and sent in multiple commands.

def test_sufficientWidth(self):

Messages exactly equal in length to the length parameter to IRCClient.msg are sent in a single command.

def test_newlinesAtStart(self):

An LF at the beginning of the message is ignored.

def test_newlinesAtEnd(self):

An LF at the end of the message is ignored.

def test_newlinesWithinMessage(self):

An LF within a message causes a new line.

def test_consecutiveNewlines(self):

Consecutive LFs do not cause a blank line.

def assertLongMessageSplitting(self, message, expectedNumCommands, length=None):

Assert that messages sent by IRCClient.msg are split into an expected number of commands and the original message is transmitted in its entirety over those commands.

def test_splitLongMessagesWithDefault(self):

If a maximum message length is not provided to IRCClient.msg a best-guess effort is made to determine a safe maximum, messages longer than this are split into multiple commands with the intent of delivering long messages without losing data due to message truncation when the server relays them.

def test_splitLongMessagesWithOverride(self):

The maximum message length can be specified to IRCClient.msg, messages longer than this are split into multiple commands with the intent of delivering long messages without losing data due to message truncation when the server relays them.

def test_newlinesBeforeLineBreaking(self):

IRCClient breaks on newlines before it breaks long lines.

def test_lineBreakOnWordBoundaries(self):

IRCClient prefers to break long lines at word boundaries.

def test_splitSanity(self):

twisted.words.protocols.irc.split raises ValueError if given a length less than or equal to 0 and returns [] when splitting ''.

def test_splitDelimiters(self):

twisted.words.protocols.irc.split skips any delimiter (space or newline) that it finds at the very beginning of the string segment it is operating on. Nothing should be added to the output list because of it.

def test_splitValidatesLength(self):

twisted.words.protocols.irc.split raises ValueError if given a length less than or equal to 0.

def test_say(self):

IRCClient.say prepends the channel prefix "#" if necessary and then sends the message to the server for delivery to that channel.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.