twisted.protocols.test.test_basic.NetstringReceiverTests

class documentation

class NetstringReceiverTests(unittest.SynchronousTestCase, LPTestCaseMixin): (source)

View In Hierarchy

Tests for twisted.protocols.basic.NetstringReceiver.

Method setUp Undocumented
Method test_buffer Strings can be received in chunks of different lengths.
Method test_consumeLength _consumeLength returns the expected length of the netstring, including the trailing comma.
Method test_consumeLengthBorderCase1 _consumeLength works as expected if the length specification contains the value of MAX_LENGTH (border case).
Method test_consumeLengthBorderCase2 _consumeLength raises a basic.NetstringParseError if the length specification exceeds the value of MAX_LENGTH by 1 (border case).
Method test_consumeLengthBorderCase3 _consumeLength raises a basic.NetstringParseError if the length specification exceeds the value of MAX_LENGTH by more than 1.
Method test_maxReceiveLimit Netstrings with a length specification exceeding the specified MAX_LENGTH are refused.
Method test_missingColon Netstrings without a colon between length specification and data are refused.
Method test_missingNumber Netstrings without leading digits that specify the length are refused.
Method test_missingNumberAndColon Netstrings that have no leading digits nor a colon are refused.
Method test_moreDataThanSpecified Netstrings containing more data than expected are refused.
Method test_moreDataThanSpecifiedBorderCase Netstrings that should be empty according to their length specification are refused if they contain data.
Method test_onlyData Netstrings consisting only of data are refused.
Method test_receiveEmptyNetstring Empty netstrings (with length '0') can be received.
Method test_receiveNestedNetstring Netstrings with embedded netstrings. This test makes sure that the parser does not become confused about the ',' and ':' characters appearing inside the data portion of the netstring.
Method test_receiveNetstringPortions_1 Netstrings can be received in two portions.
Method test_receiveNetstringPortions_2 Netstrings can be received in more than two portions, even if the length specification is split across two portions.
Method test_receiveNetstringPortions_3 Netstrings can be received one character at a time.
Method test_receiveOneCharacter One-character netstrings can be received.
Method test_receiveTwoCharacters Two-character netstrings can be received.
Method test_receiveTwoNetstrings A stream of two netstrings can be received in two portions, where the first portion contains the complete first netstring and the length specification of the second netstring.
Method test_stringReceivedNotImplemented When NetstringReceiver.stringReceived is not overridden in a subclass, calling it raises NotImplementedError.
Class Variable illegalStrings Undocumented
Class Variable strings Undocumented
Instance Variable netstringReceiver Undocumented
Instance Variable transport Undocumented

Inherited from SynchronousTestCase:

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 __init__ Undocumented
Method addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
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 _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _passed Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via 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.

Inherited from LPTestCaseMixin (via SynchronousTestCase, _Assertions):

Method getProtocol Return a new instance of self.protocol connected to a new instance of proto_helpers.StringTransport.
Method test_illegal Assert that illegal strings cause the transport to be closed.
Class Variable protocol Undocumented
def setUp(self): (source)

Undocumented

def test_buffer(self): (source)

Strings can be received in chunks of different lengths.

def test_consumeLength(self): (source)

_consumeLength returns the expected length of the netstring, including the trailing comma.

def test_consumeLengthBorderCase1(self): (source)

_consumeLength works as expected if the length specification contains the value of MAX_LENGTH (border case).

def test_consumeLengthBorderCase2(self): (source)

_consumeLength raises a basic.NetstringParseError if the length specification exceeds the value of MAX_LENGTH by 1 (border case).

def test_consumeLengthBorderCase3(self): (source)

_consumeLength raises a basic.NetstringParseError if the length specification exceeds the value of MAX_LENGTH by more than 1.

def test_maxReceiveLimit(self): (source)

Netstrings with a length specification exceeding the specified MAX_LENGTH are refused.

def test_missingColon(self): (source)

Netstrings without a colon between length specification and data are refused.

def test_missingNumber(self): (source)

Netstrings without leading digits that specify the length are refused.

def test_missingNumberAndColon(self): (source)

Netstrings that have no leading digits nor a colon are refused.

def test_moreDataThanSpecified(self): (source)

Netstrings containing more data than expected are refused.

def test_moreDataThanSpecifiedBorderCase(self): (source)

Netstrings that should be empty according to their length specification are refused if they contain data.

def test_onlyData(self): (source)

Netstrings consisting only of data are refused.

def test_receiveEmptyNetstring(self): (source)

Empty netstrings (with length '0') can be received.

def test_receiveNestedNetstring(self): (source)

Netstrings with embedded netstrings. This test makes sure that the parser does not become confused about the ',' and ':' characters appearing inside the data portion of the netstring.

def test_receiveNetstringPortions_1(self): (source)

Netstrings can be received in two portions.

def test_receiveNetstringPortions_2(self): (source)

Netstrings can be received in more than two portions, even if the length specification is split across two portions.

def test_receiveNetstringPortions_3(self): (source)

Netstrings can be received one character at a time.

def test_receiveOneCharacter(self): (source)

One-character netstrings can be received.

def test_receiveTwoCharacters(self): (source)

Two-character netstrings can be received.

def test_receiveTwoNetstrings(self): (source)

A stream of two netstrings can be received in two portions, where the first portion contains the complete first netstring and the length specification of the second netstring.

def test_stringReceivedNotImplemented(self): (source)

When NetstringReceiver.stringReceived is not overridden in a subclass, calling it raises NotImplementedError.

illegalStrings: list[bytes] = (source)
overrides twisted.protocols.test.test_basic.LPTestCaseMixin.illegalStrings

Undocumented

strings = (source)

Undocumented

netstringReceiver = (source)

Undocumented

transport = (source)

Undocumented