twisted.test.test_logfile.LogFileTests(unittest.TestCase) class documentation

Part of twisted.test.test_logfile (View In Hierarchy)

Test the rotating log file.

Method setUp Undocumented
Method tearDown Restore back write rights on created paths: if tests modified the rights, that will allow the paths to be removed easily afterwards.
Method test_abstractShouldRotate BaseLogFile.shouldRotate is abstract and must be implemented by subclass.
Method test_writing Log files can be written to, flushed and closed. Closing a log file also flushes it.
Method test_rotation Rotating log files autorotate after a period of time, and can also be manually rotated.
Method test_append No summary
Method test_logReader Various tests for log readers.
Method test_LogReaderReadsZeroLine LogReader.readLines supports reading no line.
Method test_modePreservation Check rotated files have same permissions as original.
Method test_noPermission Check it keeps working when permission on dir changes.
Method test_maxNumberOfLog Test it respect the limit on the number of files when maxRotatedFiles is not None.
Method test_fromFullPath Test the fromFullPath method.
Method test_defaultPermissions Test the default permission of the log file: if the file exist, it should keep the permission.
Method test_specifiedPermissions Test specifying the permissions used on the log file.
Method test_reopen logfile.LogFile.reopen allows to rename the currently used file and make logfile.LogFile create a new file.
Method test_nonExistentDir Specifying an invalid directory to LogFile raises IOError.
Method test_cantChangeFileMode Opening a LogFile which can be read and write but whose mode can't be changed doesn't trigger an error.
Method test_listLogsWithBadlyNamedFiles LogFile.listLogs doesn't choke if it encounters a file with an unexpected name.
Method test_listLogsIgnoresZeroSuffixedFiles LogFile.listLogs ignores log files which rotated suffix is 0.

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):
Undocumented
def tearDown(self):

Restore back write rights on created paths: if tests modified the rights, that will allow the paths to be removed easily afterwards.

def test_abstractShouldRotate(self):

BaseLogFile.shouldRotate is abstract and must be implemented by subclass.

def test_writing(self):

Log files can be written to, flushed and closed. Closing a log file also flushes it.

def test_rotation(self):

Rotating log files autorotate after a period of time, and can also be manually rotated.

def test_append(self):

Log files can be written to, closed. Their size is the number of bytes written to them. Everything that was written to them can be read, even if the writing happened on separate occasions, and even if the log file was closed in between.

def test_logReader(self):

Various tests for log readers.

First of all, log readers can get logs by number and read what was written to those log files. Getting nonexistent log files raises ValueError. Using anything other than an integer index raises TypeError. As logs get older, their log numbers increase.

def test_LogReaderReadsZeroLine(self):

LogReader.readLines supports reading no line.

def test_modePreservation(self):

Check rotated files have same permissions as original.

def test_noPermission(self):

Check it keeps working when permission on dir changes.

def test_maxNumberOfLog(self):

Test it respect the limit on the number of files when maxRotatedFiles is not None.

def test_fromFullPath(self):

Test the fromFullPath method.

def test_defaultPermissions(self):

Test the default permission of the log file: if the file exist, it should keep the permission.

def test_specifiedPermissions(self):

Test specifying the permissions used on the log file.

def test_reopen(self):

logfile.LogFile.reopen allows to rename the currently used file and make logfile.LogFile create a new file.

def test_nonExistentDir(self):

Specifying an invalid directory to LogFile raises IOError.

def test_cantChangeFileMode(self):

Opening a LogFile which can be read and write but whose mode can't be changed doesn't trigger an error.

def test_listLogsWithBadlyNamedFiles(self):

LogFile.listLogs doesn't choke if it encounters a file with an unexpected name.

def test_listLogsIgnoresZeroSuffixedFiles(self):

LogFile.listLogs ignores log files which rotated suffix is 0.

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