twisted.mail.test.test_imap.DefaultSearchTests

class documentation

class DefaultSearchTests(IMAP4HelperMixin, TestCase): (source)

View In Hierarchy

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

Method fetch Pretend to be a mailbox and let self.server lookup messages on me.
Method setUp Undocumented
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 test_searchMessageSet Test that a search which starts with a message set properly limits the search results to messages in that set.
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_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_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_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_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_searchNot If the search filter contains a NOT term, all messages which do not match the subexpression are returned.
Method test_searchNotMessageSet 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.
Method test_searchOr If the search filter contains an OR term, all messages which match either subexpression are returned.
Method test_searchOrMessageSet 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.
Instance Variable client Undocumented
Instance Variable connected Undocumented
Instance Variable msgObjs Undocumented
Instance Variable server Undocumented
Method _messageSetSearchTest Issue a search with given query and verify that the returned messages match the given expected messages.

Inherited from IMAP4HelperMixin:

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

Inherited from TestCase (via IMAP4HelperMixin):

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 IMAP4HelperMixin, 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 IMAP4HelperMixin, 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 fetch(self, messages, uid): (source)

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

def setUp(self): (source)
overrides twisted.mail.test.test_imap.IMAP4HelperMixin.setUp

Undocumented

def test_searchAndMessageSet(self): (source)

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

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.

def test_searchMessageSet(self): (source)

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

def test_searchMessageSetUIDWithStar(self): (source)

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

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

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

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

def test_searchMessageSetWithStar(self): (source)

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

def test_searchMessageSetWithStarFirst(self): (source)

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

def test_searchNot(self): (source)

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

def test_searchNotMessageSet(self): (source)

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

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

def test_searchOrMessageSet(self): (source)

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.

client = (source)
overrides twisted.mail.test.test_imap.IMAP4HelperMixin.client

Undocumented

connected = (source)
overrides twisted.mail.test.test_imap.IMAP4HelperMixin.connected

Undocumented

msgObjs = (source)

Undocumented

server = (source)
overrides twisted.mail.test.test_imap.IMAP4HelperMixin.server

Undocumented

def _messageSetSearchTest(self, queryTerms, expectedMessages): (source)

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

Parameters
queryTermsA string giving the search query.
expectedMessagesA list of the message sequence numbers expected as the result of the search.
Returns
A Deferred which fires when the test is complete.