U `[#X@s$dZddlmZmZmZzddlmZeWnek rDdZYnXddlm Z ddl m Z ddl m Z mZdd lmZdd lmZmZmZmZmZmZdd lmZGd d d e jZGddde jZGddde jZGddde jZGdddeZ Gddde!Z"Gddde jZ#dS)z+ Test cases for L{twisted.logger._format}. )mktime addTZCleanupsetTZ)tzsetN)unittest)SkipTest)_PY3unicode)LogLevel) formatEventformatUnformattableEvent formatTimeformatEventAsClassicLogTextformatWithCall eventAsText)Failurec@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)FormattingTestsz5 Tests for basic event formatting functions. csfdd}d|dd|dd|dddd|d d d d d d|d|d}d||ddd}tsd|n d|ttd}d|d|ddddS)ag L{formatEvent} will format an event according to several rules: - A string with no formatting instructions will be passed straight through. - PEP 3101 strings will be formatted using the keys and values of the event as named fields. - PEP 3101 keys ending with C{()} will be treated as instructions to call that key (which ought to be a callable) before formatting. L{formatEvent} will always return L{unicode}, and if given bytes, will always treat its format string as UTF-8 encoded. cs$||d<t|}t|t|S)N log_format)r assertIstyper )Z logFormateventresultselfA/usr/lib/python3/dist-packages/twisted/logger/test/test_format.pyformat5sz0FormattingTests.test_formatEvent..formatabcz{x})xzno, yes.z{not_called}, {called()}.ZnocSsdS)NZyesrrrrrBrz2FormattingTests.test_formatEvent..)Z not_calledZcalleduSánchezsSánchezsSnchezUnable to format events S{a!s}nchez)az Sb'\xe1'nchezSZnchezs S{a!r}nchezN) assertEqualassertInrr repr)rrZ badResultZ maybeResultZxe1rrrtest_formatEvent$s*     z FormattingTests.test_formatEventcCs$tddd}t|}|d|dS)z5 Formatting an event with no format. r )foobarrN)dictr r'rrrrrrtest_formatEventNoFormatUs z(FormattingTests.test_formatEventNoFormatcCs8ttddd}t|}|d||t||dS)z: Formatting an event with a bogus format. r+r )rr,r-z#Log format must be unicode or bytesN)r.objectr r(r)r/rrrtest_formatEventWeirdFormat_s z+FormattingTests.test_formatEventWeirdFormatcCs8tdddd}t|}|d||t||dS)zF Formatting an event that's just plain out to get us. {evil()}cSsddSNr+rrrrrrr"nrz?FormattingTests.test_formatUnformattableEvent..revilr#N)r.r r(r)r/rrrtest_formatUnformattableEventjs z-FormattingTests.test_formatUnformattableEventcCsFdddddtdi}t|}|d||d||d |d S) zR Formatting an unformattable event that has an unformattable key. rr3r6cSsddSr4rrrrrr"{rzSFormattingTests.test_formatUnformattableEventWithUnformattableKey..gurk*MESSAGE LOST: unformattable object logged:Recoverable data:Exception during formatting:N) Unformattabler r(r/rrr1test_formatUnformattableEventWithUnformattableKeyus  zAFormattingTests.test_formatUnformattableEventWithUnformattableKeycCsDtdddtd}t|}|d||d||d|dS) T Formatting an unformattable event that has an unformattable value. r3cSsddSr4rrrrrr"rzUFormattingTests.test_formatUnformattableEventWithUnformattableValue..)rr6r8r9r:r;N)r.r<r r(r/rrr3test_formatUnformattableEventWithUnformattableValues  zCFormattingTests.test_formatUnformattableEventWithUnformattableValuecCsJtddddd}t|t}|d||tddtd|d S) r>r3cSsddSr4rrrrrr"rzbFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop..Zokay)rr6 recoverabler9r@z = N)r.r r<r(r)r/rrr@test_formatUnformattableEventWithUnformattableErrorOMGWillItStops  zPFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStopN) __name__ __module__ __qualname____doc__r*r0r2r7r=r?rArrrrrs1   rc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)TimeFormattingTestsz. Tests for time formatting functions. cCs t|dS)N)rrrrrsetUpszTimeFormattingTests.setUpcsPtdkrtdfdd}|ddd|dd d |d d d |ddddS)z Default time stamp format is RFC 3339 and offset respects the timezone as set by the standard C{TZ} environment variable and L{tzset} API. N:Platform cannot change timezone; unable to verify offsets.cs<t|td}td}t||t||dS)N) irrrr+) ir+rrrr rMr)rrr'r)nameZ expectedDSTZ expectedSTDZlocalDSTZlocalSTDrrrtestForTimeZones zMTimeFormattingTests.test_formatTimeWithDefaultFormat..testForTimeZoneUTC+00z2006-06-30T00:00:00+0000z2007-01-31T00:00:00+0000zEST+05EDT,M4.1.0,M10.5.0z2006-06-30T00:00:00-0400z2007-01-31T00:00:00-0500zCEST-01CEDT,M4.1.0,M10.5.0z2006-06-30T00:00:00+0200z2007-01-31T00:00:00+0100zCST+06z2006-06-30T00:00:00-0600z2007-01-31T00:00:00-0600)rr)rrOrrr test_formatTimeWithDefaultFormats2 z4TimeFormattingTests.test_formatTimeWithDefaultFormatcCs(|tdd|tdddddS)zL If C{when} argument is L{None}, we get the default output. N-!)defaultr'rrrrrtest_formatTimeWithNoTimesz-TimeFormattingTests.test_formatTimeWithNoTimecCs6td}|t|ddd|t|dddddS)zR If C{timeFormat} argument is L{None}, we get the default output. i  (/r+i r+N timeFormatrRrS)r^rTrr'rrtrrrtest_formatTimeWithNoFormatsz/TimeFormattingTests.test_formatTimeWithNoFormatcCs td}|t|ddddS)z2 Alternate time format in output. rWz%Y/%Wr]z2013/38Nr_r`rrr&test_formatTimeWithAlternateTimeFormatsz:TimeFormattingTests.test_formatTimeWithAlternateTimeFormatcCs|tdddddS)z0 "%f" supported in time format. g?x.Az%fr]Z234560NrUrrrrtest_formatTimePercentFsz+TimeFormattingTests.test_formatTimePercentFN) rBrCrDrErGrQrVrbrcrdrrrrrFs0 rFc@sheZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdS)ClassicLogFormattingTestsz@ Tests for classic text log event formatting functions. cCsHtdkrtdt|tdtd}td|d}|t|ddS)z Time is first field. Default time stamp format is RFC 3339 and offset respects the timezone as set by the standard C{TZ} environment variable and L{tzset} API. NrHrPrWXYZZYrlog_timez%2013-09-24T11:40:47+0000 [-#-] XYZZY )rrrrrr.r'r)rrarrrrtest_formatTimeDefaults z0ClassicLogFormattingTests.test_formatTimeDefaultcCs,dd}tddd}|t||dddS) zc Time is first field. Custom formatting function is an optional argument. cSs d|S)Nz__{0}__)r)rarrrr"rzAClassicLogFormattingTests.test_formatTimeCustom..rfi90rg)rz__12345__ [-#-] XYZZY Nr.r'r)rrrrrrtest_formatTimeCustoms   z/ClassicLogFormattingTests.test_formatTimeCustomcCs tddd}|t|ddS)z: Namespace is first part of second field. rf my.namespace)r log_namespacez- [my.namespace#-] XYZZY Nrjrrrrrtest_formatNamespace%s  z.ClassicLogFormattingTests.test_formatNamespacecCs"tdtjd}|t|ddS)z7 Level is second part of second field. rf)r log_levelz- [-#warn] XYZZY Nr.r warnr'rrnrrrtest_formatLevel0s z*ClassicLogFormattingTests.test_formatLevelcCs tddd}|t|ddS)z) System is second field. rf S.Y.S.T.E.M.r log_system- [S.Y.S.T.E.M.] XYZZY Nrjrnrrrtest_formatSystem;s  z+ClassicLogFormattingTests.test_formatSystemcCs&tddtjdd}|t|ddS)B System is not supplanted by namespace and level. rfrlrt)rrmrprvrwNrqrnrrrtest_formatSystemRulzFsz/ClassicLogFormattingTests.test_formatSystemRulzcCs"tdtd}|t|ddS)ryrfruz- [UNFORMATTABLE] XYZZY N)r.r<r'rrnrrrtest_formatSystemUnformattableVs z8ClassicLogFormattingTests.test_formatSystemUnformattablecCs tddd}|t|ddS)z0 Formatted event is last field. zid:{id}123ridz- [-#-] id:123 Nrjrnrrrtest_formatFormatas  z+ClassicLogFormattingTests.test_formatFormatcCstdd}|t|ddS)z# No format string. r|)r~Nr.rrrnrrrtest_formatNoFormatls  z-ClassicLogFormattingTests.test_formatNoFormatcCs tddd}|t|ddS)z& Empty format string. rr|r}Nrrnrrrtest_formatEmptyFormatws  z0ClassicLogFormattingTests.test_formatEmptyFormatcCstdd}|t|ddS)zO If the formatted event has newlines, indent additional lines. z"XYZZY A hollow voice says: "Plugh")rz-- [-#-] XYZZY A hollow voice says: "Plugh" Nrjrnrrrtest_formatFormatMultiLines  z4ClassicLogFormattingTests.test_formatFormatMultiLineN)rBrCrDrErirkrorsrxrzr{rrrrrrrrres        rec@seZdZdZddZdS)FormatFieldTestsz+ Tests for format field functions. cCs>|tdtddddd|tdtddd d d S) z L{formatWithCall} is an extended version of L{unicode.format} that will interpret a set of parentheses "C{()}" at the end of a format key to mean that the format key ought to be I{called} rather than stringified. zHello, {world}. {callme()}.ZearthcSsdS)Nmayberrrrrr"rz6FormatFieldTests.test_formatWithCall..)ZworldZcallmezHello, earth. maybe.zHello, {repr()!r}.cSsdS)Nr)rrrrrr"r)r)zHello, 'repr'.N)r'rr.rrrrtest_formatWithCalls z$FormatFieldTests.test_formatWithCallN)rBrCrDrErrrrrrsrc@seZdZdZddZdS)r<z> An object that raises an exception from C{__repr__}. cCs tddSr4)strrrrr__repr__szUnformattable.__repr__N)rBrCrDrErrrrrr<sr<c@seZdZdZdS) CapturedErrorz3 A captured error for use in format tests. N)rBrCrDrErrrrrsrc@sxeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZdS)EventAsTextTestszi Tests for L{eventAsText}, all of which ensure that the returned type is UTF-8 decoded text. cCsjz tdWntk r&t}YnXddi}||d<t|ddd}|t|||d|dS) zT An event with a C{log_failure} key will have a traceback appended. This is a fake errorrThis is a test log message log_failureTFincludeTimestamp includeSystemNrrrr(r getTracebackrfr eventTextrrrtest_eventWithTracebacks  z(EventAsTextTests.test_eventWithTracebackcCsjz tdWntk r&t}YnXddi}||d<t|ddd}|t|||d|dS) zu An event with an empty C{log_format} key appends a traceback from the accompanying failure. rrrrTFrNrrrrr"test_formatEmptyEventWithTracebacks  z3EventAsTextTests.test_formatEmptyEventWithTracebackcCs|z tdWntk r&t}YnXdddd}||d<t|ddd }||t|t|||d|d S) zw An event with an unformattable value in the C{log_format} key still has a traceback appended. rr3cSsddSr4rrrrrr"rzHEventAsTextTests.test_formatUnformattableWithTraceback..r5rTFrN)rrrassertIsInstancer r(rrrrr%test_formatUnformattableWithTracebacks    z6EventAsTextTests.test_formatUnformattableWithTracebackcCsz tdWntk r&t}YnXdddddtdi}||d<t|d d d }||t|d ||t|||d|d S)z An event with an unformattable value in the C{log_format} key, that throws an exception when __repr__ is invoked still has a traceback appended. rrr3r6cSsddSr4rrrrrr"rzMEventAsTextTests.test_formatUnformattableErrorWithTraceback..r8rTFrz MESSAGE LOSTN)rrr<rrr r(rrrrr*test_formatUnformattableErrorWithTracebacks*    z;EventAsTextTests.test_formatUnformattableErrorWithTracebackcCs<ddi}t|d<t|ddd}||t|d|dS) zk If a traceback cannot be appended, a message indicating this is true is appended. rrrTFrz'(UNABLE TO OBTAIN TRACEBACK FROM EVENT)N)r1rrr r(rrrrrr&test_formatEventUnformattableTraceback#s  z7EventAsTextTests.test_formatEventUnformattableTracebackcCs2ddi}t|ddd}||t|d|dS)zY An event with no C{log_failure} key will not have a traceback appended. rrTFrN)rrr r(rrrrtest_formatEventNonCritical5s z,EventAsTextTests.test_formatEventNonCriticalcCsbz tdWntk r&t}YnXddi}||d<t|ddd}|d||d|d S) zU An exception message with multibyte characters is properly handled. u€rrrTFr TracebackN)rrrr(rrrrtest_formatTracebackMultibyteEs   z.EventAsTextTests.test_formatTracebackMultibytecCstz tdWntk r&t}YnXddi}||d<t|ddd}|d|tsd|d |n |d |d S) zj An error raised attempting to decode the UTF still produces a valid log message. s testrrrTFrru��testz.CapturedError(b'\xff\xfet\x00e\x00s\x00t\x00')N)rrrr(rrrrr,test_formatTracebackHandlesUTF8DecodeFailure[s(   z=EventAsTextTests.test_formatTracebackHandlesUTF8DecodeFailurecCsdz tdWntk r&t}YnXtd}dd|d}||d<t|dddd }||d d S) zq If includeSystem is specified as the only option no timestamp or traceback are printed. rrWABCD fake_systemrrvrhrFTrZincludeTracebackrz[fake_system] ABCDNrrrrr'rrrarrrrrtest_eventAsTextSystemOnlyys(  z+EventAsTextTests.test_eventAsTextSystemOnlycCstdkrtdt|tdz tdWntk rFt}YnXtd}dd|d}||d <t|d d d d }||d dS)zq If includeTimestamp is specified as the only option no system or traceback are printed. NrHrPrrWrrrrTFrz2013-09-24T11:40:47+0000 ABCD) rrrrrrrrr'rrrrtest_eventAsTextTimestampOnlys4  z.EventAsTextTests.test_eventAsTextTimestampOnlycCsbz tdWntk r&t}YnXtd}d|d}||d<t|dddd}||d d S) z\ If includeSystem is specified with a missing system [-#-] is used. rrWrrgrFTrz [-#-] ABCDNrrrrrtest_eventAsTextSystemMissings&  z.EventAsTextTests.test_eventAsTextSystemMissingcCshz tdWntk r&t}YnXtd}d|tjdd}||d<t|dddd }||d d S) z If includeSystem is specified with a missing system but namespace and level are present they are used. rrWrZtest)rrhrprmrFTrz[test#info] ABCDNrrrr inforr'rrrr.test_eventAsTextSystemMissingNamespaceAndLevels*  z?EventAsTextTests.test_eventAsTextSystemMissingNamespaceAndLevelcCsfz tdWntk r&t}YnXtd}d|tjd}||d<t|dddd}||d d S) zv If includeSystem is specified with a missing system but level is present, level is included. rrWr)rrhrprFTrz [-#info] ABCDNrrrrr&test_eventAsTextSystemMissingLevelOnlys(  z7EventAsTextTests.test_eventAsTextSystemMissingLevelOnlyN)rBrCrDrErrrrrrrrrrrrrrrrrrs%r)$rEZ!twisted.python.test.test_tzhelperrrrtimer ImportErrorZ twisted.trialrZtwisted.trial.unittestrZtwisted.python.compatrr Z_levelsr Z_formatr r rrrrZtwisted.python.failurerZTestCaserrFrerr1r< Exceptionrrrrrrs*       Z