twisted.mail.test.test_imap.IMAP4HelperTests

class documentation

class IMAP4HelperTests(TestCase): (source)

View In Hierarchy

Tests for various helper utilities in the IMAP4 module.

Method test_commandRepr imap4.Command's repr does not raise an exception.
Method test_fetchParserBody Undocumented
Method test_fetchParserDotlessPartial Parsing a BODY with a range that lacks a period (.) raises an Exception.
Method test_fetchParserEmptyString Parsing an empty string results in no data.
Method test_fetchParserExpectedWhitespace Parsing a string that contains an unexpected character rather than whitespace raises an Exception.
Method test_fetchParserHeaderMissingParentheses Parsing a BODY whose HEADER.FIELDS list does not begin with an open parenthesis (() or end with a close parenthesis ()) raises an Exception.
Method test_fetchParserIncompleteStringEndsInWhitespace Parsing a string that prematurely ends in whitespace raises an Exception.
Method test_fetchParserMacros Undocumented
Method test_fetchParserMissingSectionClose Parsing a BODY with an unterminated section list raises an Exception.
Method test_fetchParserQuotedHeader Parsing a BODY whose HEADER values require quoting results in a object that perserves that quoting when serialized.
Method test_fetchParserSimple Undocumented
Method test_fetchParserTextSection A BODY can contain a TEXT section.
Method test_fetchParserUnclosedPartial Parsing a BODY with a partial range that's missing its closing greater than sign (>) raises an EXCEPTION.
Method test_fetchParserUnknownAttribute Parsing a string with an unknown attribute raises an Exception.
Method test_fetchParserUnknownSection Parsing a BODY with an unknown section raises an Exception.
Method test_fileProducer Undocumented
Method test_files Undocumented
Method test_headerFormatter imap4._formatHeaders accepts a dict of header name/value pairs and returns a string representing those headers in the standard multiline, ":"-separated format.
Method test_invalidIdListParser Trying to parse an invalid representation of a sequence range raises an IllegalIdentifierError.
Method test_invalidIdListParserNonPositive Zeroes and negative values are not accepted in id range expressions. RFC 3501 states that sequence numbers and sequence ranges consist of non-negative numbers (RFC 3501 section 9, the seq-number grammar item).
Method test_literals Undocumented
Method test_parenParser Undocumented
Method test_parseIdList The function to parse sequence ranges yields appropriate MessageSet objects.
Method test_parseTimeInvalidFormat imap4.parseTime raises ValueError when given a a time string whose format is invalid.
Method test_parseTimeInvalidValues imap4.parseTime raises ValueError when given a time string composed of invalid values.
Method test_queryBuilder Undocumented
Method test_queryKeywordFlag No summary
Method test_queryKeywordFlagWithQuotes When passed the keyword argument, imap4.Query returns an unquoted string.
Method test_queryOrIllegalQuery An imap4.Or query with less than two arguments raises an imap4.IllegalQueryError.
Method test_queryUnkeywordFlag No summary
Method test_queryUnkeywordFlagWithQuotes When passed the unkeyword argument, imap4.Query returns an unquoted string.
Method test_queryWithInteger When passed an int, imap4.Query returns a query containing a quoted integer.
Method test_queryWithMesssageSet When passed a MessageSet, imap4.Query returns a query containing a quoted string representing the ID sequence.
Method test_quoteAvoider Undocumented
Method test_quotedSplitter Undocumented
Method test_statusRequestHelper imap4.statusRequestHelper builds a dict mapping the requested status names to values extracted from the provided IMailboxIMAP's.
Method test_stringCollapser Undocumented
Method test_wildcard Undocumented
Method test_wildcardNoDelim Undocumented
Method _keywordFilteringTest Helper to implement tests for value filtering of KEYWORD and UNKEYWORD queries.

Inherited from TestCase:

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 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 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_commandRepr(self): (source)

imap4.Command's repr does not raise an exception.

def test_fetchParserBody(self): (source)

Undocumented

def test_fetchParserDotlessPartial(self): (source)

Parsing a BODY with a range that lacks a period (.) raises an Exception.

def test_fetchParserEmptyString(self): (source)

Parsing an empty string results in no data.

def test_fetchParserExpectedWhitespace(self): (source)

Parsing a string that contains an unexpected character rather than whitespace raises an Exception.

def test_fetchParserHeaderMissingParentheses(self): (source)

Parsing a BODY whose HEADER.FIELDS list does not begin with an open parenthesis (() or end with a close parenthesis ()) raises an Exception.

def test_fetchParserIncompleteStringEndsInWhitespace(self): (source)

Parsing a string that prematurely ends in whitespace raises an Exception.

def test_fetchParserMacros(self): (source)

Undocumented

def test_fetchParserMissingSectionClose(self): (source)

Parsing a BODY with an unterminated section list raises an Exception.

def test_fetchParserQuotedHeader(self): (source)

Parsing a BODY whose HEADER values require quoting results in a object that perserves that quoting when serialized.

def test_fetchParserSimple(self): (source)

Undocumented

def test_fetchParserTextSection(self): (source)

A BODY can contain a TEXT section.

def test_fetchParserUnclosedPartial(self): (source)

Parsing a BODY with a partial range that's missing its closing greater than sign (>) raises an EXCEPTION.

def test_fetchParserUnknownAttribute(self): (source)

Parsing a string with an unknown attribute raises an Exception.

def test_fetchParserUnknownSection(self): (source)

Parsing a BODY with an unknown section raises an Exception.

def test_fileProducer(self): (source)

Undocumented

def test_files(self): (source)

Undocumented

def test_headerFormatter(self): (source)

imap4._formatHeaders accepts a dict of header name/value pairs and returns a string representing those headers in the standard multiline, ":"-separated format.

def test_invalidIdListParser(self): (source)

Trying to parse an invalid representation of a sequence range raises an IllegalIdentifierError.

def test_invalidIdListParserNonPositive(self): (source)

Zeroes and negative values are not accepted in id range expressions. RFC 3501 states that sequence numbers and sequence ranges consist of non-negative numbers (RFC 3501 section 9, the seq-number grammar item).

def test_literals(self): (source)

Undocumented

def test_parenParser(self): (source)

Undocumented

def test_parseIdList(self): (source)

The function to parse sequence ranges yields appropriate MessageSet objects.

def test_parseTimeInvalidFormat(self): (source)

imap4.parseTime raises ValueError when given a a time string whose format is invalid.

def test_parseTimeInvalidValues(self): (source)

imap4.parseTime raises ValueError when given a time string composed of invalid values.

def test_queryBuilder(self): (source)

Undocumented

def test_queryKeywordFlag(self): (source)
def test_queryKeywordFlagWithQuotes(self): (source)

When passed the keyword argument, imap4.Query returns an unquoted string.

See Also
http://tools.ietf.org/html/rfc3501#section-9
http://tools.ietf.org/html/rfc3501#section-6.4.4
def test_queryOrIllegalQuery(self): (source)

An imap4.Or query with less than two arguments raises an imap4.IllegalQueryError.

def test_queryUnkeywordFlag(self): (source)
def test_queryUnkeywordFlagWithQuotes(self): (source)

When passed the unkeyword argument, imap4.Query returns an unquoted string.

See Also
http://tools.ietf.org/html/rfc3501#section-9
http://tools.ietf.org/html/rfc3501#section-6.4.4
def test_queryWithInteger(self): (source)

When passed an int, imap4.Query returns a query containing a quoted integer.

def test_queryWithMesssageSet(self): (source)

When passed a MessageSet, imap4.Query returns a query containing a quoted string representing the ID sequence.

def test_quoteAvoider(self): (source)

Undocumented

def test_quotedSplitter(self): (source)

Undocumented

def test_statusRequestHelper(self): (source)

imap4.statusRequestHelper builds a dict mapping the requested status names to values extracted from the provided IMailboxIMAP's.

def test_stringCollapser(self): (source)

Undocumented

def test_wildcard(self): (source)

Undocumented

def test_wildcardNoDelim(self): (source)

Undocumented

def _keywordFilteringTest(self, keyword): (source)

Helper to implement tests for value filtering of KEYWORD and UNKEYWORD queries.

Parameters
keywordA native string giving the name of the imap4.Query keyword argument to test.