twisted.words.test.test_irc.ClientImplementationTests(IRCTestCase)
class documentationtwisted.words.test.test_irc
(View In Hierarchy)
Method | setUp | Undocumented |
Method | testYourHost | Undocumented |
Method | testCreated | Undocumented |
Method | testMyInfo | Undocumented |
Method | testLuserClient | Undocumented |
Method | test_ISUPPORT | The client parses ISUPPORT messages sent by the server and calls IRCClient.isupport . |
Method | testBounce | Undocumented |
Method | testLuserChannels | Undocumented |
Method | testLuserOp | Undocumented |
Method | testLuserMe | Undocumented |
Method | test_receivedMOTD | Lines received in RPL_MOTDSTART and RPL_MOTD are delivered
to IRCClient.receivedMOTD
when RPL_ENDOFMOTD is received. |
Method | test_withoutMOTDSTART | If IRCClient
receives RPL_MOTD and RPL_ENDOFMOTD without receiving
RPL_MOTDSTART, IRCClient.receivedMOTD
is still called with a list of MOTD lines. |
Method | testPrivmsg | Undocumented |
Method | test_getChannelModeParams | IRCClient.getChannelModeParams
uses ISUPPORT information, either given by the server or defaults, to
determine which channel modes require arguments when being added or
removed. |
Method | test_getUserModeParams | IRCClient.getUserModeParams
returns a list of user modes (modes that the user sets on themself, outside
of channel modes) that require parameters when added and removed,
respectively. |
Method | test_modeMissingDirection | Mode strings that do not begin with a directional character,
'+' or '-' , have '+' automatically
prepended. |
Method | test_noModeParameters | No parameters are passed to IRCClient.modeChanged
for modes that don't take any parameters. |
Method | test_oneModeParameter | Parameters are passed to IRCClient.modeChanged
for modes that take parameters. |
Method | test_mixedModes | Mixing adding and removing modes that do and don't take parameters
invokes IRCClient.modeChanged
with mode characters and parameters that match up. |
Method | test_tooManyModeParameters | Passing an argument to modes that take no parameters results in IRCClient.modeChanged
not being called and an error being logged. |
Method | test_tooFewModeParameters | Passing no arguments to modes that do take parameters results in
IRCClient.modeChange not being called and an error being
logged. |
Method | test_userMode | A MODE message whose target is our user (the nickname of
our user, to be precise), as opposed to a channel, will be parsed according
to the modes specified by IRCClient.getUserModeParams . |
Method | test_heartbeat | No summary |
Method | test_heartbeatDisabled | If irc.IRCClient.heartbeatInterval
is set to None
then no heartbeat is created. |
Method | _serverTestImpl | Undocumented |
Method | _sendISUPPORT | Undocumented |
Method | _clientTestImpl | Undocumented |
Method | _sendModeChange | Build a MODE string and send it to the client. |
Method | _parseModeChange | Parse the results, do some test and return the data to check. |
Method | _checkModeChange | Compare the expected result with the one returned by the client. |
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.Deferred s.
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. |
The client parses ISUPPORT messages sent by the server and calls IRCClient.isupport
.
Lines received in RPL_MOTDSTART and RPL_MOTD are delivered
to IRCClient.receivedMOTD
when RPL_ENDOFMOTD is received.
If IRCClient
receives RPL_MOTD and RPL_ENDOFMOTD without receiving
RPL_MOTDSTART, IRCClient.receivedMOTD
is still called with a list of MOTD lines.
IRCClient.getChannelModeParams
uses ISUPPORT information, either given by the server or defaults, to
determine which channel modes require arguments when being added or
removed.
IRCClient.getUserModeParams
returns a list of user modes (modes that the user sets on themself, outside
of channel modes) that require parameters when added and removed,
respectively.
Build a MODE string and send it to the client.
Parse the results, do some test and return the data to check.
Compare the expected result with the one returned by the client.
Mode strings that do not begin with a directional character,
'+'
or '-'
, have '+'
automatically
prepended.
No parameters are passed to IRCClient.modeChanged
for modes that don't take any parameters.
Parameters are passed to IRCClient.modeChanged
for modes that take parameters.
Mixing adding and removing modes that do and don't take parameters
invokes IRCClient.modeChanged
with mode characters and parameters that match up.
Passing an argument to modes that take no parameters results in IRCClient.modeChanged
not being called and an error being logged.
Passing no arguments to modes that do take parameters results in
IRCClient.modeChange
not being called and an error being
logged.
A MODE
message whose target is our user (the nickname of
our user, to be precise), as opposed to a channel, will be parsed according
to the modes specified by IRCClient.getUserModeParams
.
When the RPL_WELCOME message is received a heartbeat is started
that will send a PING message to the IRC server every irc.IRCClient.heartbeatInterval
seconds. When the transport is closed the heartbeat looping call is stopped
too.
If irc.IRCClient.heartbeatInterval
is set to None
then no heartbeat is created.