U T‚g8ã@s´UdZddlZddlZddlmZmZddlmZddlm Z ddl m Z m Z ddl mZddlmZmZdd lmZmZmZe d ƒZgZeded <eejƒGd d „d eƒƒZdS)zP Things likely to be used by writers of unit tests. Maintainer: Jonathan Lange éN)ÚCallableÚList)Ú implementer)Ú ParamSpec)ÚdeferÚutils)Úfailure)ÚitrialÚutil)ÚFailTestÚSkipTestÚSynchronousTestCaseÚ_PÚ_wait_is_runningcsôeZdZdZd1‡fdd„ Zdd„ZeZdd„Zd d „Zd d „Z d d„Z dd„Z dd„Z dd„Z dd„Zdd„Zejdd„ƒZdd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„Zeeefejejd'd(œ‡fd)d*„ Zd+d,„Zd-d.„Z e!fd/d0„Z"‡Z#S)2ÚTestCasea= 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__©ú._cbcs.|jˆŽr|jSd ˆt|ƒ¡}ˆ |¡‚dS)Nz Expected: {!r} Got: {})ÚcheckÚvalueÚformatÚstrr)rÚoutput©ÚexpectedFailuresrrrÚ_ebIs ÿz#TestCase.assertFailure.._eb)Ú addCallbacks)rÚdeferredr$rr%rr#rÚ assertFailure=s  zTestCase.assertFailurecs ddlm‰ˆ ¡‰‡‡‡‡‡fdd„}t |tjtd¡}tˆˆƒ}t   |¡rht d  |¡ƒ}t  |¡St  tjˆ ¡|¡}ˆ ˆ||¡‰| ‡fdd„¡|S) Nr©Úreactorcs”t ˆ›dˆ›dˆ›d¡}t |¡}z| |¡WnZtjk rŽˆ ¡dˆ_ˆ ¡}|dk r~|  |¡r~ˆ  ˆ||¡n ˆ  ˆ|¡YnXdS)Nz (z) still running at z secsT) rÚ TimeoutErrorrÚFailureZerrbackZAlreadyCalledErrorÚcrashÚ _timedOutÚgetTodoÚexpectedÚaddExpectedFailureÚaddError)ÚdÚeÚfÚtodo)rr*ÚresultrÚtimeoutrrÚ onTimeout[sÿ z TestCase._run..onTimeout©Úcategoryz9{!r} is a generator function and therefore will never runcsˆ ¡rˆ ¡p|S©N)ÚactiveÚcancel)Úx)ÚcallrrÚ€ózTestCase._run..)Útwisted.internetr*Ú getTimeoutrÚsuppressWarningsr ÚsuppressÚDeprecationWarningÚgetattrÚinspectÚisgeneratorfunctionÚ TypeErrorr rZfailZ maybeDeferredZrunWithWarningsSuppressedÚ _getSuppressZ callLaterÚaddBoth)rrr7r9ÚmethodÚexcr3r)r@rr*r7rr8rÚ_runVs.  ÿ  ÿÿ ÿz TestCase._runcOs |j||ŽSr<)Úrun)rÚargsÚkwargsrrrÚ__call__ƒszTestCase.__call__cCs*| d|¡}|j|j|j|f|fd|S)NÚsetUp©Z callbackArgsZ errbackArgs)rPr&ÚdeferTestMethodÚ _ebDeferSetUp©rÚignoredr7r3rrrÚ deferSetUp†s üzTestCase.deferSetUpcCsN| t¡r$| || |j|j¡¡n| ||¡| t¡rB| ¡|  d|¡Sr<) rr ÚaddSkipÚ_getSkipReasonrUrr2ÚKeyboardInterruptÚstopÚdeferRunCleanups©rrr7rrrrXs    zTestCase._ebDeferSetUpcCsH| |j|¡}|j|j|j|f|fd| |j|¡| |j|¡|S)NrV)rPÚ_testMethodNamer&Ú_cbDeferTestMethodÚ_ebDeferTestMethodrMr`Ú deferTearDownrYrrrrW™süzTestCase.deferTestMethodcCs(| ¡dk r| || ¡¡nd|_|S)NT)r/ZaddUnexpectedSuccessÚ_passed)rrZr7rrrrc¥s zTestCase._cbDeferTestMethodcCs | ¡}|dk r*| |¡r*| |||¡nr| |jt¡rF| ||¡nV| t¡rf| ||¡|  ¡n6| t ¡r|  ||  t ||jƒ|j¡¡n | ||¡dSr<)r/r0r1rrr Z addFailurer^r2r_r r\r]rHrbr)rr5r7r6rrrrd¬s    ÿzTestCase._ebDeferTestMethodcCs| d|¡}| |j|¡|S)NZtearDown)rPZ addErrbackÚ_ebDeferTearDownrYrrrre¼s zTestCase.deferTearDowncCs(| ||¡| t¡r| ¡d|_dS©NF)r2rr^r_rfrarrrrgÁs  zTestCase._ebDeferTearDownccsxg}t|jƒdkrX|j ¡\}}}z|||ŽVWqtk rT| t ¡¡YqXq|D]}| ||¡d|_q\dS)zf Run any scheduled cleanups and report errors (if any) to the result. object. rFN) ÚlenÚ _cleanupsÚpopÚ ExceptionÚappendrr,r2rf)rrZr7ZfailuresÚfuncrRrSr5rrrr`Çs zTestCase.deferRunCleanupscCszt ||¡ ¡}|sd|_Wn*tk rH| |t ¡¡d|_YnX|j  ¡D]}| ||¡d|_qT|  ¡|  ¡|jrŒ|  |¡dSrh) r Ú_JanitorZpostCaseCleanuprfÚ BaseExceptionr2rr,Z _observerZ getErrorsZflushLoggedErrorsZ_removeObserverZ addSuccess)rr7ÚcleanÚerrorrrrÚ_cleanUpÙs   zTestCase._cleanUpcCs>zt ||¡ ¡Wn$tk r8| |t ¡¡YnXdSr<)r roZpostClassCleanuprpr2rr,)rr7rrrÚ _classCleanUpészTestCase._classCleanUpcs‡‡fdd„}|S)z• Create a method which wraps the reactor method C{name}. The new method issues a deprecation warning and calls the original. cs(tjdˆˆfdtdˆjˆ||Ž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;)ÚwarningsÚwarnrGÚ_reactorMethods)ÚaÚkw©ÚnamerrrÚ_õsþûz&TestCase._makeReactorMethod.._r)rr}r~rr|rÚ_makeReactorMethodïs zTestCase._makeReactorMethodcCs6i|_dD]&}t||ƒ|j|<t||| |¡ƒq dS)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-Ziterater_N)ryrHÚsetattrr)rr*r}rrrÚ_deprecateReactorszTestCase._deprecateReactorcCs*|j ¡D]\}}t|||ƒq i|_dS)z• Restore the deprecated reactor methods. Undoes what L{_deprecateReactor} did. @param reactor: The Twisted reactor. N)ryÚitemsr€)rr*r}rNrrrÚ_undeprecateReactorszTestCase._undeprecateReactorc Csdddlm}| |¡d|_z6| d|¡}z| |¡W5| |¡| |¡XW5| |¡XdS)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) rCr*rr.rƒr[rsrtÚ_wait)rr7r*r3rrrÚ_runFixturesAndTests    zTestCase._runFixturesAndTestN)r5rRrSÚreturncstƒj|f|ž|Ž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)rr5rRrSrrrr‡0s zTestCase.addCleanupcCs| ¡Sr<)rLrrrrÚ getSuppress<szTestCase.getSuppressc CsNt |jdtj¡}z t|ƒWSttfk rHtjdt dtjYSXdS)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. r8z)'timeout' attribute needs to be a number.r:N) r ZacquireAttributeÚ_parentsZDEFAULT_TIMEOUT_DURATIONÚfloatÚ ValueErrorrKrwrxrG)rr8rrrrD?sÿ ÿzTestCase.getTimeoutcsâ|r tdƒ‚ddlm‰g‰‡fdd„}‡‡fdd„}t |tjdtd ¡}‡fd d „}t |tjdtd ¡}| d ¡zV|  |¡ˆrW¢Dd S|  |¡|ˆ_ z ˆ  ¡W5ˆ` Xˆs¾|j rÆW¢d Stƒ‚W5d ‰|  ¡Xd S) zATake a Deferred that only ever callbacks. Block until it happens.z_wait is not reentrantrr)csˆdk rˆ |¡dSr<)rm)Úany)Úresultsrrrm_szTestCase._wait..appendcsˆdk rˆ ¡dSr<©r-)Zign©r*rrrr-cszTestCase._wait..crashzreactor\.crash cannot be used.*)Úmessager;cs ˆ ¡dSr<rŽrr)rrr_nszTestCase._wait..stopN)Ú RuntimeErrorrCr*rrEr rFrGrmrkrMr_rQr.r^)rr3Zrunningrmr-r_rrrr„VsH  ÿþ ÿþ      zTestCase._wait)r)$Ú__name__Ú __module__Ú __qualname__Ú__doc__rr(ZfailUnlessFailurerPrTr[rXrWrcrdrergrZinlineCallbacksr`rsrtrrrƒr…rrÚobjectrRrSr‡rˆrDrr„Ú __classcell__rrrrr!s: -       þ r)r•rIrwÚtypingrrZzope.interfacerZtyping_extensionsrrCrrZtwisted.pythonrZ twisted.trialr r Ztwisted.trial._synctestr r r rrÚ__annotations__Z ITestCaserrrrrÚs