twisted.pair.test.test_tuntap.TunTests(TunnelTestsMixin, SynchronousTestCase) class documentationtwisted.pair.test.test_tuntap
          
          (View In Hierarchy)
        
      Tests for TuntapPort when
used to open a Linux tun tunnel.
Inherited from TunnelTestsMixin:
| Method | setUp | Create an in-memory I/O system and set up a TuntapPortagainst it. | 
| Method | test_startListeningOpensDevice | TuntapPort.startListeningopens the tunnel factory character special device"/dev/net/tun"and configures it as a tun 
tunnel. | 
| Method | test_startListeningSetsConnected | TuntapPort.startListeningsetsconnectedon the port object toTrue. | 
| Method | test_startListeningConnectsProtocol | TuntapPort.startListeningcallsmakeConnectionon the protocol the port was initialized 
with, passing the port as an argument. | 
| Method | test_startListeningStartsReading | TuntapPort.startListeningpasses the port instance to the reactor'saddReadermethod to 
begin watching the port's file descriptor for data to read. | 
| Method | test_startListeningHandlesOpenFailure | TuntapPort.startListeningraisesCannotListenErrorif opening the tunnel factory character special device fails. | 
| Method | test_startListeningHandlesConfigureFailure | TuntapPort.startListeningraisesCannotListenErrorif theioctlcall to configure the tunnel device fails. | 
| Method | test_stopListeningStopsReading | TuntapPort.stopListeningreturns aDeferredwhich
fires after the port has been removed from the reactor's reader list by 
passing it to the reactor'sremoveReadermethod. | 
| Method | test_stopListeningUnsetsConnected | After the Deferredreturned byTuntapPort.stopListeningfires, theconnectedattribute of the port object is set toFalse. | 
| Method | test_stopListeningStopsProtocol | TuntapPort.stopListeningcallsdoStopon the protocol the port was initialized 
with. | 
| Method | test_stopListeningWhenStopped | TuntapPort.stopListeningreturns aDeferredwhich
succeeds immediately if it is called when the port is not listening. | 
| Method | test_multipleStopListening | It is safe and a no-op to call TuntapPort.stopListeningmore than once with no interveningTuntapPort.startListeningcall. | 
| Method | test_loseConnection | TuntapPort.loseConnectionstops the port and is deprecated. | 
| Method | test_eagainStopsReading | Once TuntapPort.doReadencounters an EAGAIN errno from areadcall, it 
returns. | 
| Method | test_ewouldblockStopsReading | Once TuntapPort.doReadencounters an EWOULDBLOCK errno from areadcall, it 
returns. | 
| Method | test_eintrblockStopsReading | Once TuntapPort.doReadencounters an EINTR errno from areadcall, it 
returns. | 
| Method | test_unhandledReadError | If Tuntap.doReadencounters any exception other than one 
explicitly handled by the code, the exception propagates to the caller. | 
| Method | test_unhandledEnvironmentReadError | Just like test_unhandledReadError, but for the case where 
the exception that is not explicitly handled happens to be of typeEnvironmentError(OSErrororIOError). | 
| Method | test_doReadSmallDatagram | TuntapPort.doReadreads a datagram of fewer thanTuntapPort.maxPacketSizefrom 
the port's file descriptor and passes it to its protocol'sdatagramReceivedmethod. | 
| Method | test_doReadLargeDatagram | TuntapPort.doReadreads the first part of a datagram of more thanTuntapPort.maxPacketSizefrom the port's file descriptor and 
passes the truncated data to its protocol'sdatagramReceivedmethod. | 
| Method | test_doReadSeveralDatagrams | TuntapPort.doReadreads several datagrams, of up toTuntapPort.maxThroughputbytes total, before returning. | 
| Method | test_datagramReceivedException | If the protocol's datagramReceivedmethod raises an 
exception, the exception is logged. | 
| Method | test_datagramReceivedExceptionIdentifiesProtocol | The exception raised by datagramReceivedis logged with a 
message identifying the offending protocol. | 
| Method | test_write | TuntapPort.writesends a datagram into the tunnel. | 
| Method | test_interruptedWrite | If the platform write call is interrupted (causing the Python wrapper to
raise IOErrorwith errno set toEINTR), the write
is re-tried. | 
| Method | test_unhandledWriteError | Any exception raised by the underlying write call, except for EINTR, is propagated to the caller. | 
| Method | test_writeSequence | TuntapPort.writeSequencesends a datagram into the tunnel by concatenating the byte strings in the 
list passed to it. | 
| Method | test_getHost | TuntapPort.getHostreturns aTunnelAddressincluding the tunnel's type and name. | 
| Method | test_listeningString | The string representation of a TuntapPortinstance includes the tunnel type and interface and the protocol associated
with the port. | 
| Method | test_unlisteningString | The string representation of a TuntapPortinstance includes the tunnel type and interface and the protocol associated
with the port. | 
| Method | test_logPrefix | TuntapPort.logPrefixreturns a string identifying the application protocol and the type of 
tunnel. | 
| Method | _tunnelTypeOnly | Mask off any flags except for TunnelType.IFF_TUNandTunnelType.IFF_TAP. | 
| Method | _stopPort | Verify that the stopListeningmethod of anIListeningPortremoves that port from the reactor's "readers" set and also that 
theDeferredreturned by that method fires withNone. | 
| Method | _stopsReadingTest | Test that TuntapPort.doReadhas no side-effects under a certain exception condition. | 
| Method | _datagramReceivedException | Deliver some data to a TuntapPorthooked up to an application protocol that raises an exception from itsdatagramReceivedmethod. | 
Inherited from SynchronousTestCase:
| 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 | Noneor 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 theTestResultsupports skipping). | 
| Instance Variable | todo | None,
a string or a tuple of(errors, reason)whereerrorsis either an exception class or an iterable of 
exception classes, andreasonis a string. SeeTodoormakeTodofor 
more information. | 
| Instance Variable | suppress | Noneor a list of tuples of(args, kwargs)to be passed towarnings.filterwarnings. Use these to suppress warnings raised
in a test. Useful for testing deprecated code. See alsoutil.suppress. | 
| Method | __init__ | Undocumented | 
| 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 methodNameargument is passed to the constructor,runwill treat this method as the thing with the actual test inside. | 
| Method | run | Run the test case, storing the results in result. | 
| Method | addCleanup | Add the given function to a list of functions to be called after the 
test has run, but before tearDown. | 
| 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 | _run | Run a single method, either a test method or fixture. | 
| Method | _runFixturesAndTest | Run setUp, a test method, test cleanups, andtearDown. | 
| Method | _runCleanups | Synchronously run any cleanups which have been added. | 
| Method | _installObserver | Undocumented | 
| Method | _removeObserver | Undocumented | 
Inherited from _Assertions (via SynchronousTestCase):
| Method | fail | Absolutely fail the test. Do not pass go, do not collect $200. | 
| Method | assertFalse | Fail the test if conditionevaluates to True. | 
| Method | assertTrue | Fail the test if conditionevaluates to False. | 
| Method | assertRaises | Fail the test unless calling the function fwith the givenargsandkwargsraisesexception. 
The failure will report the traceback and call stack of the unexpected 
exception. | 
| Method | assertEqual | Fail the test if firstandsecondare not 
equal. | 
| Method | assertIs | Fail the test if firstis notsecond.  This is
an obect-identity-equality test, not an object equality (i.e.__eq__) test. | 
| Method | assertIsNot | Fail the test if firstissecond.  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 containeeis not found incontainer. | 
| Method | assertNotIn | Fail the test if containeeis found incontainer. | 
| 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 substringdoes not exist withinastring. | 
| Method | assertNotSubstring | Fail if astringcontainssubstring. | 
| 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 instanceis not an instance of the given class or 
of one of the given classes. | 
| Method | assertNotIsInstance | Fail if instanceis an instance of the given class or of 
one of the given classes. | 
| Method | successResultOf | Return the current success result of deferredor raiseself.failureException. | 
| Method | failureResultOf | Return the current failure result of deferredor raiseself.failureException. | 
| Method | assertNoResult | Assert that deferreddoes not have a result at this 
point. | 
| Method | assertRegex | Fail the test if a regexpsearch oftextfails. |