U P|j 9@sdZddlZddlmZddlmZmZddlmZddl m Z ddl m Z ddl mZmZdd lmZdd lmZd d lmZd d lmZmZd dlmZmZd dlmZGdddejZ GdddejZ!dS)z+ Test cases for L{twisted.logger._legacy}. N)time)Listcast) implementer)BrokenMethodImplementation) verifyObject)contextlog)Failure)unittest) formatEvent) ILogObserverLogEvent)LegacyLogObserverWrapperpublishToNewObserver)LogLevelc@sXeZdZdZddddZddddZeedd d Zeedd d Zddd dZ ddddZ ddddZ ddddZ ddddZ ddddZddddZddddZddddZdddd Zddd!d"Zddd#d$Zddd%d&Zddd'd(Zeed)d*d+Zddd,d-Zddd.d/Zddd0d1Zddd2d3ZdS)4LegacyLogObserverWrapperTestsz0 Tests for L{LegacyLogObserverWrapper}. Nreturnc CsXttjdd}t|}ztt|Wn,tk rR}z||W5d}~XYnXdS)zD L{LegacyLogObserverWrapper} is an L{ILogObserver}. cSsdSNerrC/tmp/pip-unpacked-wheel-audpp6lv/twisted/logger/test/test_legacy.py"z>LegacyLogObserverWrapperTests.test_interface..N)r legacyLogrrrrZfail)selflegacyObserverobserverrrrrtest_interfaces z,LegacyLogObserverWrapperTests.test_interfacecCs6ttjGddd}t|}|t|ddS)zJ L{LegacyLogObserverWrapper} returns the expected string. c@s,eZdZedddZejddddZdS)z?LegacyLogObserverWrapperTests.test_repr..LegacyObserverrcSsdS)Nzrrrrr__repr__0szHLegacyLogObserverWrapperTests.test_repr..LegacyObserver.__repr__N) eventDictrcSsdSrr)rr$rrr__call__3szHLegacyLogObserverWrapperTests.test_repr..LegacyObserver.__call__)__name__ __module__ __qualname__strr#r EventDictr%rrrrLegacyObserver.sr+z+LegacyLogObserverWrapper()N)rrrr assertEqualrepr)rr+r rrr test_repr)s z'LegacyLogObserverWrapperTests.test_repreventrcs@gttjfdd}t|}|||tddS)z Send an event to a wrapped legacy observer and capture the event as seen by that observer. @param event: an event @return: the event as observed by the legacy wrapper cs |Sr)appendreventsrrrErz7LegacyLogObserverWrapperTests.observe..r)rrrrr,len)rr0rr rr2robserve:s z%LegacyLogObserverWrapperTests.observecCsX|dt|dd|dtj|t|}|D]\}}|||q>|S)z Send an event to a wrapped legacy observer and verify that its data is preserved. @param event: an event @return: the event as observed by the legacy wrapper log_time log_system- log_level) setdefaultrrinfor6dictitemsZassertIn)rr0observedkeyvaluerrrforwardAndVerifyLs  z.LegacyLogObserverWrapperTests.forwardAndVerifycCs|tddddS)ze Basic forwarding: event keys as observed by a legacy observer are the same. r4r foobarN)rBr=r"rrr test_forwardcsz*LegacyLogObserverWrapperTests.test_forwardcCs*t}|t|d}||d|dS)zc The new-style C{"log_time"} key is copied to the old-style C{"time"} key. )r7rNrrBr=r,rZstampr0rrr test_timejsz'LegacyLogObserverWrapperTests.test_timecCs0t}|t|d|d}||d|dS)zr The new-style C{"log_time"} key does not step on a pre-existing old-style C{"time"} key. r4)r7rrNrGrHrrrtest_timeAlreadySetssz1LegacyLogObserverWrapperTests.test_timeAlreadySetcCs$|tdd}||dddS)zg The new-style C{"log_system"} key is copied to the old-style C{"system"} key. rD)r8systemNrBr=r,rr0rrr test_system|sz)LegacyLogObserverWrapperTests.test_systemcCs&|tddd}||dddS)zv The new-style C{"log_system"} key does not step on a pre-existing old-style C{"system"} key. rDrE)r8rKrKNrLrMrrrtest_systemAlreadySetsz3LegacyLogObserverWrapperTests.test_systemAlreadySetcCs2tttjd}|t|}||dddS)zy If the new-style C{"log_system"} key is absent, the old-style C{"system"} key is set to C{"-"}. )r7r:rKr9N)r=rrr<r6r,)rr0r?rrr test_noSystemsz+LegacyLogObserverWrapperTests.test_noSystemcCsT|ttjdd|ttjdd|ttjdd|ttjdddS)z If explicitly set, the C{isError} key will be preserved when forwarding from a new-style logging emitter to a legacy logging observer, regardless of log level. r4)r:isErrorrN)rBr=rr<warnerrorcriticalr"rrrtest_levelNotChangesz1LegacyLogObserverWrapperTests.test_levelNotChangecCs"|ttjd}|d|dS)a) The new-style C{"log_level"} key is not translated to the old-style C{"logLevel"} key. Events are forwarded from the old module from to new module and are then seen by old-style observers. We don't want to add unexpected keys to old-style events. )r:logLevelN)rBr=rr< assertNotInrMrrrtest_pythonLogLevelNotSets z7LegacyLogObserverWrapperTests.test_pythonLogLevelNotSetcCs$|tdd}||dddS)a If a stdlib log level was provided as a string (eg. C{"WARNING"}) in the legacy "logLevel" key, it does not get converted to a number. The documentation suggested that numerical values should be used but this was not a requirement. WARNINGrVrVNrLrMrrrtest_stringPythonLogLevels z7LegacyLogObserverWrapperTests.test_stringPythonLogLevelcCs |t}||dddS)z The old-style C{"message"} key is added, even if no new-style C{"log_format"} is given, as it is required, but may be empty. messagerNrLrMrrr test_messages z*LegacyLogObserverWrapperTests.test_messagecCs$|tdd}||dddS)zV The old-style C{"message"} key is not modified if it already exists. rC)r\r\NrLrMrrrtest_messageAlreadySetsz4LegacyLogObserverWrapperTests.test_messageAlreadySetcCs(|tddd}|t|ddS)z Formatting is translated such that text is rendered correctly, even though old-style logging doesn't use PEP 3101 formatting. z Hello, {who}!world) log_formatZwho Hello, world!NrBr=r,rtextFromEventDictrMrrr test_formatsz)LegacyLogObserverWrapperTests.test_formatcCs(|tddd}|t|ddS)zo Using the message key, which is special in old-style, works for new-style formatting. zHello, {message}!r_)r`r\raNrbrMrrrtest_formatMessages z0LegacyLogObserverWrapperTests.test_formatMessagecCs(|tddd}|t|ddS)zd Formatting is not altered if the old-style C{"format"} key already exists. zHello!zHowdy!)r`formatNrbrMrrrtest_formatAlreadySetsz3LegacyLogObserverWrapperTests.test_formatAlreadySet)valuesrcKs&ttd}|tf|dd|S)z Create a new-style event with a captured failure. @param values: Additional values to include in the event. @return: the new event znyargh! oopsie...) log_failurer`)r RuntimeErrorrBr=)rrhfailurerrreventWithFailures z.LegacyLogObserverWrapperTests.eventWithFailurecCs>|}||d|d||d||dddS)z} Captured failures in the new style set the old-style C{"failure"}, C{"isError"}, and C{"why"} keys. rlrjrQwhyriN)rmassertIs assertTruer,rMrrr test_failuresz*LegacyLogObserverWrapperTests.test_failurecCs,ttd}|j|d}||d|dS)v Captured failures in the new style do not step on a pre-existing old-style C{"failure"} key. z Weak salsa!)rlrlN)r rkrmro)rrlr0rrrtest_failureAlreadySets  z4LegacyLogObserverWrapperTests.test_failureAlreadySetcCs |jdd}||dddS)zv Captured failures in the new style do not step on a pre-existing old-style C{"isError"} key. rrQrQNrmr,rMrrrtest_isErrorAlreadySets z4LegacyLogObserverWrapperTests.test_isErrorAlreadySetcCs |jdd}||dddS)rrZblah)rnrnNrurMrrrtest_whyAlreadySet s z0LegacyLogObserverWrapperTests.test_whyAlreadySet)r&r'r(__doc__r!r.rr6rBrFrIrJrNrOrPrUrXr[r]r^rdrergobjectrmrqrsrvrwrrrrrs0          rc@seZdZdZddddZeeejdddZ ddd d Z ddd d Z ddd dZ ddddZ ddddZddddZddddZddddZddddZddddZdS)PublishToNewObserverTestsz, Tests for L{publishToNewObserver}. NrcCsg|_tt|jj|_dSr)r3rrr1r r"rrrsetUpszPublishToNewObserverTests.setUp)r\rhrcOsDttjpi}||||d<t|d<d|kr@d|d<|S)a Return a basic old-style event as would be created by L{legacyLog.msg}. @param message: a message event value in the legacy event format @param values: additional event values in the legacy event format @return: a legacy event r\rrQr)rgetrZ ILogContextcopyupdater)rr\rhr0rrr legacyEvents   z%PublishToNewObserverTests.legacyEventcCs*t|j|tj|t|jddS)z6 The observer is called exactly once. r4N)rr rrrcr,r5r3r"rrr test_observed/s z'PublishToNewObserverTests.test_observedcCs8t|j|tj||jdd|jdddS)zc The old-style C{"time"} key is copied to the new-style C{"log_time"} key. rr7rNrr rrrcr,r3r"rrrrI8s z#PublishToNewObserverTests.test_timecCsLttddd}|dd}||}t|j|||t|jd|dS)z A published old-style event should format as text in the same way as the given C{textFromEventDict} callable would format it. r/cSsdtd|dS)N r\)joinreversed)r0rrrrcHszAPublishToNewObserverTests.test_message..textFromEventDictzHello,zworld!rN)rr)rrr r,r r3)rrcr0textrrrr]Bs  z&PublishToNewObserverTests.test_messagecCs0t|j|tj||jddtjdS)zL Published event should have log level of L{LogLevel.info}. rr:N) rr rrrcr,r3rr<r"rrrtest_defaultLogLevelQs z.PublishToNewObserverTests.test_defaultLogLevelcCs4t|j|jddtj||jddtjdS)z If C{"isError"} is set to C{1} (true) on the legacy event, the C{"log_level"} key should get set to L{LogLevel.critical}. r4rtrr:N) rr rrrcr,r3rrTr"rrr test_isErrorZs  z&PublishToNewObserverTests.test_isErrorcCs6t|j|jtjdtj||jddt j dS)z If the old-style C{"logLevel"} key is set to a standard library logging level, using a predefined (L{int}) constant, the new-style C{"log_level"} key should get set to the corresponding log level. rZrr:N) rr r py_loggingrYrrcr,r3rrRr"rrrtest_stdlibLogLevelds  z-PublishToNewObserverTests.test_stdlibLogLevelcCs4t|j|jddtj||jddtjdS)z If the old-style C{"logLevel"} key is set to a standard library logging level, using a string value, the new-style C{"log_level"} key should get set to the corresponding log level. rYrZrr:N) rr rrrcr,r3rrRr"rrrtest_stdlibLogLevelWithStringqs  z7PublishToNewObserverTests.test_stdlibLogLevelWithStringcCs.t|j|jddtj|d|jddS)z If the old-style C{"logLevel"} key is set to a standard library logging level, using an unknown value, the new-style C{"log_level"} key should not get set. zFoo!!!!!rZr:rN)rr rrrcrWr3r"rrrtest_stdlibLogLevelWithGarbage~s  z8PublishToNewObserverTests.test_stdlibLogLevelWithGarbagecCs.t|j|tj||jddddS)z Published event should have a namespace of C{"log_legacy"} to indicate that it was forwarded from legacy logging. rZ log_namespaceZ log_legacyNrr"rrrtest_defaultNamespaces z/PublishToNewObserverTests.test_defaultNamespacecCs8t|j|tj||jdd|jdddS)zg The old-style C{"system"} key is copied to the new-style C{"log_system"} key. rr8rKNrr"rrrrNs z%PublishToNewObserverTests.test_system)r&r'r(rxr{r)ryrr*rrrIr]rrrrrrrNrrrrrzs        rz)"rxloggingrrtypingrrZzope.interfacerZzope.interface.exceptionsrZzope.interface.verifyrZtwisted.pythonrr rZtwisted.python.failurer Z twisted.trialr _formatr Z _interfacesrrZ_legacyrrZ_levelsrZTestCaserrzrrrrs         }