twisted.mail.test.test_imap.DefaultSearchTests(IMAP4HelperMixin, unittest.TestCase) class documentation

Part of twisted.mail.test.test_imap (View In Hierarchy)

Test the behavior of the server's SEARCH implementation, particularly in the face of unhandled search terms.

Method setUp Undocumented
Method fetch Pretend to be a mailbox and let self.server lookup messages on me.
Method test_searchMessageSet Test that a search which starts with a message set properly limits the search results to messages in that set.
Method test_searchMessageSetWithStar If the search filter ends with a star, all the message from the starting point are returned.
Method test_searchMessageSetWithStarFirst If the search filter starts with a star, the result should be identical with if the filter would end with a star.
Method test_searchMessageSetUIDWithStar If the search filter ends with a star, all the message from the starting point are returned (also for the SEARCH UID case).
Method test_searchMessageSetUIDWithStarFirst If the search filter starts with a star, the result should be identical with if the filter would end with a star (also for the SEARCH UID case).
Method test_searchMessageSetUIDWithStarAndHighStart A search filter of 1234:* should include the UID of the last message in the mailbox, even if its UID is less than 1234.
Method test_searchMessageSetWithList If the search filter contains nesting terms, one of which includes a message sequence set with a wildcard, IT ALL WORKS GOOD.
Method test_searchOr If the search filter contains an OR term, all messages which match either subexpression are returned.
Method test_searchOrMessageSet No summary
Method test_searchNot If the search filter contains a NOT term, all messages which do not match the subexpression are returned.
Method test_searchNotMessageSet No summary
Method test_searchAndMessageSet If the search filter contains multiple terms implicitly conjoined with a message sequence set wildcard, only the intersection of the results of each term are returned.
Method test_searchInvalidCriteria If the search criteria is not a valid key, a NO result is returned to the client (resulting in an error callback), and an IllegalQueryError is logged on the server side.
Method _messageSetSearchTest Issue a search with given query and verify that the returned messages match the given expected messages.

Inherited from IMAP4HelperMixin:

Method tearDown Undocumented
Method loopback Undocumented
Method assertClientFailureMessage Assert that the provided failure is an IMAP4Exception with the given message.
Method _cbStopClient Undocumented
Method _ebGeneral Undocumented

Inherited from TestCase:

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 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 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):
overrides twisted.mail.test.test_imap.IMAP4HelperMixin.setUp
Undocumented
def fetch(self, messages, uid):

Pretend to be a mailbox and let self.server lookup messages on me.

def _messageSetSearchTest(self, queryTerms, expectedMessages):

Issue a search with given query and verify that the returned messages match the given expected messages.

ParametersqueryTermsA string giving the search query.
expectedMessagesA list of the message sequence numbers expected as the result of the search.
ReturnsA Deferred which fires when the test is complete.
def test_searchMessageSet(self):

Test that a search which starts with a message set properly limits the search results to messages in that set.

def test_searchMessageSetWithStar(self):

If the search filter ends with a star, all the message from the starting point are returned.

def test_searchMessageSetWithStarFirst(self):

If the search filter starts with a star, the result should be identical with if the filter would end with a star.

def test_searchMessageSetUIDWithStar(self):

If the search filter ends with a star, all the message from the starting point are returned (also for the SEARCH UID case).

def test_searchMessageSetUIDWithStarFirst(self):

If the search filter starts with a star, the result should be identical with if the filter would end with a star (also for the SEARCH UID case).

def test_searchMessageSetUIDWithStarAndHighStart(self):

A search filter of 1234:* should include the UID of the last message in the mailbox, even if its UID is less than 1234.

def test_searchMessageSetWithList(self):

If the search filter contains nesting terms, one of which includes a message sequence set with a wildcard, IT ALL WORKS GOOD.

def test_searchOr(self):

If the search filter contains an OR term, all messages which match either subexpression are returned.

def test_searchOrMessageSet(self):

If the search filter contains an OR term with a subexpression which includes a message sequence set wildcard, all messages in that set are considered for inclusion in the results.

def test_searchNot(self):

If the search filter contains a NOT term, all messages which do not match the subexpression are returned.

def test_searchNotMessageSet(self):

If the search filter contains a NOT term with a subexpression which includes a message sequence set wildcard, no messages in that set are considered for inclusion in the result.

def test_searchAndMessageSet(self):

If the search filter contains multiple terms implicitly conjoined with a message sequence set wildcard, only the intersection of the results of each term are returned.

def test_searchInvalidCriteria(self):

If the search criteria is not a valid key, a NO result is returned to the client (resulting in an error callback), and an IllegalQueryError is logged on the server side.

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