o b@7@sUdZddlZddlZddlmZddlmZddlmZm Z ddl m Z ddl m Z mZddlmZmZmZgZeded <ee jGd d d eZdS) zP Things likely to be used by writers of unit tests. Maintainer: Jonathan Lange N)List) implementer)deferutils)failure)itrialutil)FailTestSkipTestSynchronousTestCase_wait_is_runningcseZdZdZd/fdd ZddZeZddZd d Zd d Z d dZ ddZ ddZ ddZ ddZddZejddZddZddZdd Zd!d"Zd#d$Zd%d&Zfd'd(Zd)d*Zd+d,Zefd-d.ZZS)0TestCasea= A unit test. The atom of the unit testing universe. This class extends L{SynchronousTestCase} which extends C{unittest.TestCase} from the standard library. The main feature is the ability to return C{Deferred}s from tests and fixture methods and to have the suite wait for those C{Deferred}s to fire. Also provides new assertions such as L{assertFailure}. @ivar timeout: A real number of seconds. If set, the test will raise an error if it takes longer than C{timeout} seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used. runTestcst|dS)a Construct an asynchronous test case for C{methodName}. @param methodName: The name of a method on C{self}. This method should be a unit test. That is, it should be a short method that calls some of the assert* methods. If C{methodName} is unspecified, L{SynchronousTestCase.runTest} will be used as the test method. This is mostly useful for testing Trial. N)super__init__)self methodName __class__:/usr/lib/python3/dist-packages/twisted/trial/_asynctest.pyr-s zTestCase.__init__cs&fdd}fdd}|||S)z Fail if C{deferred} does not errback with one of C{expectedFailures}. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case. csd|)Nz$did not catch an error, instead got )failureException)ignorerrr_cb@sz#TestCase.assertFailure.._cbcs*|jr|jSdt|}|)Nz Expected: {!r} Got: {})checkvalueformatstrr)routputexpectedFailuresrrr_ebEs  z#TestCase.assertFailure.._eb) addCallbacks)rdeferredr!rr"rr r assertFailure9s  zTestCase.assertFailurecsddlmfdd}t|tjtd}t}t |r4t d |}t |St tj|}|||fdd|S) Nrreactorcstddd}t|}z||WdStjyJd_}|durA| |rA ||YdS |YdSw)Nz (z) still running at z secsT) r TimeoutErrorrFailureerrbackAlreadyCalledErrorcrash _timedOutgetTodoexpectedaddExpectedFailureaddError)deftodo)rr'resultrtimeoutrr onTimeoutWs z TestCase._run..onTimeoutcategoryz9{!r} is a generator function and therefore will never runcsrp |SN)activecancel)x)callrr|szTestCase._run..)twisted.internetr' getTimeoutrsuppressWarningsrsuppressDeprecationWarninggetattrinspectisgeneratorfunction TypeErrorrrfail maybeDeferredrunWithWarningsSuppressed _getSuppress callLateraddBoth)rrr6r8methodexcr2r)r?rr'r6rr7r_runRs(      z TestCase._runcOs|j|i|Sr;)run)rargskwargsrrr__call__szTestCase.__call__cCs*|d|}|j|j|j|f|fd|S)NsetUp callbackArgs errbackArgs)rRr#deferTestMethod _ebDeferSetUprignoredr6r2rrr deferSetUps zTestCase.deferSetUpcCsN|tr||||j|jn||||tr!|| d|Sr;) rr addSkip_getSkipReasonrWrr1KeyboardInterruptstopdeferRunCleanupsrrr6rrrr\s    zTestCase._ebDeferSetUpcCsH||j|}|j|j|j|f|fd||j|||j||S)NrX)rR_testMethodNamer#_cbDeferTestMethod_ebDeferTestMethodrOrd deferTearDownr]rrrr[szTestCase.deferTestMethodcCs*|dur||||Sd|_|S)NT)r.addUnexpectedSuccess_passed)rr^r6rrrrgs zTestCase._cbDeferTestMethodcCs|}|dur||r||||dS||jtr%|||dS|tr6|||| dS|t rL| || t ||j|jdS|||dSr;)r.r/r0rrr addFailurerbr1rcr r`rarFrfr)rr4r6r5rrrrhs    zTestCase._ebDeferTestMethodcCs|d|}||j||S)NtearDown)rR addErrback_ebDeferTearDownr]rrrris zTestCase.deferTearDowncCs(||||tr|d|_dSNF)r1rrbrcrkrerrrros   zTestCase._ebDeferTearDownc csvg}|jdddD]\}}}z ||i|VWq ty*|tYq w|D] }|||d|_q-dS)zf Run any scheduled cleanups and report errors (if any) to the result. object. NF) _cleanups Exceptionappendrr)r1rk)rr^r6failuresfuncrTrUr4rrrrds  zTestCase.deferRunCleanupscCszt||}|sd|_Wnty#||td|_Ynw|j D] }|||d|_q)| | |jrG| |dSdSrp) r_JanitorpostCaseCleanuprk BaseExceptionr1rr) _observer getErrorsflushLoggedErrors_removeObserver addSuccess)rr6cleanerrorrrr_cleanUps"   zTestCase._cleanUpcCs<z t||WdSty||tYdSwr;)rrwpostClassCleanupryr1rr))rr6rrr _classCleanUps  zTestCase._classCleanUpcsfdd}|S)z Create a method which wraps the reactor method C{name}. The new method issues a deprecation warning and calls the original. cs,tjdfdtdj|i|S)Nz{reactor.%s cannot be used inside unit tests. In the future, using %s will fail the test and may crash or hang the test run.) stacklevelr:)warningswarnrE_reactorMethods)akwnamerrr_sz&TestCase._makeReactorMethod.._r)rrrrrr_makeReactorMethods zTestCase._makeReactorMethodcCs6i|_dD]}t|||j|<t||||qdS)z Deprecate C{iterate}, C{crash} and C{stop} on C{reactor}. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original. @param reactor: The Twisted reactor. )r,iteratercN)rrFsetattrr)rr'rrrr_deprecateReactors zTestCase._deprecateReactorcCs*|jD] \}}t|||qi|_dS)z Restore the deprecated reactor methods. Undoes what L{_deprecateReactor} did. @param reactor: The Twisted reactor. N)ritemsr)rr'rrPrrr_undeprecateReactor s zTestCase._undeprecateReactorc Csddlm}||d|_z+|d|}z||W||||n ||||wW||dS||w)z Really run C{setUp}, the test method, and C{tearDown}. Any of these may return L{defer.Deferred}s. After they complete, do some reactor cleanup. @param result: A L{TestResult} object. rr&FN) rAr'rr-r__waitrrr)rr6r'r2rrr_runFixturesAndTests       zTestCase._runFixturesAndTestcstj|g|Ri|S)a  Extend the base cleanup feature with support for cleanup functions which return Deferreds. If the function C{f} returns a Deferred, C{TestCase} will wait until the Deferred has fired before proceeding to the next function. )r addCleanup)rr4rTrUrrrr)szTestCase.addCleanupcCs|Sr;)rMrrrr getSuppress3szTestCase.getSuppressc CsHt|jdtj}zt|WSttfy#tjdt dtjYSw)ae 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 C{timeout} attribute, returns that. Returns L{util.DEFAULT_TIMEOUT_DURATION} if it cannot find anything. See L{TestCase} docstring for more details. r7z)'timeout' attribute needs to be a number.r9) racquireAttribute_parentsDEFAULT_TIMEOUT_DURATIONfloat ValueErrorrIrrrE)rr7rrrrB6s   zTestCase.getTimeoutcs|rtdddlmgfdd}fdd}t|tjdtd }fd d }t|tjdtd }|d z5| |rMWd | d S| ||_ z W` n` wsf|j roWd | d Std | w) zATake a Deferred that only ever callbacks. Block until it happens.z_wait is not reentrantrr&csdur |dSdSr;)rt)any)resultsrrrtVszTestCase._wait..appendcsdur dSdSr;r,)ignr'rrrr,Zs zTestCase._wait..crashzreactor\.crash cannot be used.*)messager:cs dSr;rrr&rrrces zTestCase._wait..stopN) RuntimeErrorrAr'rrCrrDrErtrOpoprcrSr-rb)rr2runningrtr,rcrrrrMsL            zTestCase._wait)r)__name__ __module__ __qualname____doc__rr%failUnlessFailurerRrVr_r\r[rgrhrirorinlineCallbacksrdrrrrrrrrrBr r __classcell__rrrrr s4 -       r )rrGrtypingrzope.interfacerrArrtwisted.pythonr twisted.trialrrtwisted.trial._synctestr r r r __annotations__ ITestCaser rrrrs