3 K^#X @s$dZddlmZmZmZyddlmZeWnek 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}jd|djd|djd|dddjd|d d d d d jd|d|d}jd||ddd}tsjd|n jd|ttd}jd|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|}jt|t|S)N log_format)r assertIstyper )Z logFormateventresult)selfC/tmp/pip-unpacked-wheel-k7g0kfns/twisted/logger/test/test_format.pyformat5sz0FormattingTests.test_formatEvent..formatabcz{x})xzno, yes.z{not_called}, {called()}.nocSsdS)NyesrrrrrBsz2FormattingTests.test_formatEvent..)Z not_calledcalleduSánchezsSánchezsSnchezzUnable to format events S{a!s}nchez)az Sb'\xe1'nchezSZnchezs S{a!r}nchezN) assertEqualassertInrr repr)rrZ badResultZ maybeResultZxe1r)rrtest_formatEvent$s$     z FormattingTests.test_formatEventcCs$tddd}t|}|jd|dS)z5 Formatting an event with no format. r )foobarrN)dictr r()rrrrrrtest_formatEventNoFormatUs z(FormattingTests.test_formatEventNoFormatcCs8ttddd}t|}|jd||jt||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*)rrrrrrtest_formatEventWeirdFormat_s z+FormattingTests.test_formatEventWeirdFormatcCs8tdddd}t|}|jd||jt||dS)zF Formatting an event that's just plain out to get us. z{evil()}cSsddS)Nr,rrrrrrr#nsz?FormattingTests.test_formatUnformattableEvent..)revilzUnable to format eventN)r/r r)r*)rrrrrrtest_formatUnformattableEventjs z-FormattingTests.test_formatUnformattableEventcCsFdddddtdi}t|}|jd||jd||jd |d S) zR Formatting an unformattable event that has an unformattable key. rz{evil()}r3cSsddS)Nr,rrrrrrr#{szSFormattingTests.test_formatUnformattableEventWithUnformattableKey..gurkz*MESSAGE LOST: unformattable object logged:zRecoverable data:zException during formatting:N) Unformattabler r))rrrrrr1test_formatUnformattableEventWithUnformattableKeyus   zAFormattingTests.test_formatUnformattableEventWithUnformattableKeycCsDtdddtd}t|}|jd||jd||jd|dS) zT Formatting an unformattable event that has an unformattable value. z{evil()}cSsddS)Nr,rrrrrrr#szUFormattingTests.test_formatUnformattableEventWithUnformattableValue..)rr3r5z*MESSAGE LOST: unformattable object logged:zRecoverable data:zException during formatting:N)r/r6r r))rrrrrr3test_formatUnformattableEventWithUnformattableValues   zCFormattingTests.test_formatUnformattableEventWithUnformattableValuecCsJtddddd}t|t}|jd||jtddtd|d S) zT Formatting an unformattable event that has an unformattable value. z{evil()}cSsddS)Nr,rrrrrrr#szbFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop..okay)rr3 recoverablez*MESSAGE LOST: unformattable object logged:r:z = N)r/r r6r)r*)rrrrrr@test_formatUnformattableEventWithUnformattableErrorOMGWillItStops  zPFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStopN) __name__ __module__ __qualname____doc__r+r0r2r4r7r8r;rrrrrs1   rc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)TimeFormattingTestsz. Tests for time formatting functions. cCs t|dS)N)r)rrrrsetUpszTimeFormattingTests.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. Nz:Platform cannot change timezone; unable to verify offsets.c s<t|td }td }jt||jt||dS) Nrr,r ) rBrCrDrrrrErFr,) rGr,rHrrrr rHr)rrr(r)nameZ expectedDSTZ expectedSTDZlocalDSTZlocalSTD)rrrtestForTimeZones zMTimeFormattingTests.test_formatTimeWithDefaultFormat..testForTimeZonezUTC+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)rrJr)rr test_formatTimeWithDefaultFormats( z4TimeFormattingTests.test_formatTimeWithDefaultFormatcCs(|jtdd|jtdddddS)zL If C{when} argument is L{None}, we get the default output. N-!)default)r(r)rrrrtest_formatTimeWithNoTimesz-TimeFormattingTests.test_formatTimeWithNoTimec Cs6td}|jt|d d d |jt|d d d d d S)zR If C{timeFormat} argument is L{None}, we get the default output.   (/r, N) timeFormatrLrM)rWrN) rPrQrRrSrTrUr,rVr,)rr(r)rtrrrtest_formatTimeWithNoFormatsz/TimeFormattingTests.test_formatTimeWithNoFormatc Cs td }|jt|d d d d S)z2 Alternate time format in output. rQrRrSrTrUr, z%Y/%W)rWz2013/38N) rZrQrRrSrTrUr,r[r,)rr(r)rrXrrr&test_formatTimeWithAlternateTimeFormatsz:TimeFormattingTests.test_formatTimeWithAlternateTimeFormatcCs|jtdddddS)z0 "%f" supported in time format. g?x.Az%f)rWZ234560N)r(r)rrrrtest_formatTimePercentFsz+TimeFormattingTests.test_formatTimePercentFN) r<r=r>r?rArKrOrYr\r]rrrrr@s0 r@c@sheZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdS)ClassicLogFormattingTestsz@ Tests for classic text log event formatting functions. c CsHtdkrtdt|tdtd}td |d }|jt|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. Nz:Platform cannot change timezone; unable to verify offsets.zUTC+00rQrRrSrTrUr, XYZZY)rlog_timez%2013-09-24T11:40:47+0000 [-#-] XYZZY ) r_rQrRrSrTrUr,r`r,)rrrrrr/r(r)rrXrrrrtest_formatTimeDefaults z0ClassicLogFormattingTests.test_formatTimeDefaultcCs,dd}tddd}|jt||dddS) zc Time is first field. Custom formatting function is an optional argument. cSs dj|S)Nz__{0}__)r)rXrrrr#szAClassicLogFormattingTests.test_formatTimeCustom..rai90)rrb)rz__12345__ [-#-] XYZZY N)r/r(r)rrrrrrtest_formatTimeCustoms   z/ClassicLogFormattingTests.test_formatTimeCustomcCs tddd}|jt|ddS)z: Namespace is first part of second field. raz my.namespace)r log_namespacez- [my.namespace#-] XYZZY N)r/r(r)rrrrrtest_formatNamespace%s z.ClassicLogFormattingTests.test_formatNamespacecCs"tdtjd}|jt|ddS)z7 Level is second part of second field. ra)r log_levelz- [-#warn] XYZZY N)r/r warnr(r)rrrrrtest_formatLevel0sz*ClassicLogFormattingTests.test_formatLevelcCs tddd}|jt|ddS)z) System is second field. raz S.Y.S.T.E.M.)r log_systemz- [S.Y.S.T.E.M.] XYZZY N)r/r(r)rrrrrtest_formatSystem;s z+ClassicLogFormattingTests.test_formatSystemcCs&tddtjdd}|jt|ddS)zB System is not supplanted by namespace and level. raz my.namespacez S.Y.S.T.E.M.)rrergrjz- [S.Y.S.T.E.M.] XYZZY N)r/r rhr(r)rrrrrtest_formatSystemRulzFsz/ClassicLogFormattingTests.test_formatSystemRulzcCs"tdtd}|jt|ddS)zB System is not supplanted by namespace and level. ra)rrjz- [UNFORMATTABLE] XYZZY N)r/r6r(r)rrrrrtest_formatSystemUnformattableVsz8ClassicLogFormattingTests.test_formatSystemUnformattablecCs tddd}|jt|ddS)z0 Formatted event is last field. zid:{id}123)ridz- [-#-] id:123 N)r/r(r)rrrrrtest_formatFormatas z+ClassicLogFormattingTests.test_formatFormatcCstdd}|jt|ddS)z# No format string. rn)roN)r/rr)rrrrrtest_formatNoFormatls z-ClassicLogFormattingTests.test_formatNoFormatcCs tddd}|jt|ddS)z& Empty format string. rrn)rroN)r/rr)rrrrrtest_formatEmptyFormatws z0ClassicLogFormattingTests.test_formatEmptyFormatcCstdd}|jt|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" N)r/r(r)rrrrrtest_formatFormatMultiLines z4ClassicLogFormattingTests.test_formatFormatMultiLineN)r<r=r>r?rcrdrfrirkrlrmrprqrrrsrrrrr^s        r^c@seZdZdZddZdS)FormatFieldTestsz+ Tests for format field functions. cCs>|jtdtddddd|jtdtddd 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#sz6FormatFieldTests.test_formatWithCall..)ZworldZcallmezHello, earth. maybe.zHello, {repr()!r}.cSsdS)Nr*rrrrrr#s)r*zHello, 'repr'.N)r(rr/)rrrrtest_formatWithCallsz$FormatFieldTests.test_formatWithCallN)r<r=r>r?rvrrrrrtsrtc@seZdZdZddZdS)r6z> An object that raises an exception from C{__repr__}. cCs tddS)Nr,r)str)rrrr__repr__szUnformattable.__repr__N)r<r=r>r?rxrrrrr6sr6c@seZdZdZdS) CapturedErrorz3 A captured error for use in format tests. N)r<r=r>r?rrrrrysryc@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. c Csjy tdWntk r&t}YnXddi}||d<t|ddd}|jt|j||jd|dS) zT An event with a C{log_failure} key will have a traceback appended. zThis is a fake errorrzThis is a test log message log_failureTF)includeTimestamp includeSystemN)ryrrr)r getTraceback)rfr eventTextrrrtest_eventWithTracebacks  z(EventAsTextTests.test_eventWithTracebackc Csjy tdWntk r&t}YnXddi}||d<t|ddd}|jt|j||jd|dS) zu An event with an empty C{log_format} key appends a traceback from the accompanying failure. zThis is a fake errorrrr{TF)r|r}N)ryrrr)r r~)rrrrrrr"test_formatEmptyEventWithTracebacks  z3EventAsTextTests.test_formatEmptyEventWithTracebackc Cs|y tdWntk r&t}YnXdddd}||d<t|ddd }|j|t|jt|j||jd|d S) zw An event with an unformattable value in the C{log_format} key still has a traceback appended. zThis is a fake errorz{evil()}cSsddS)Nr,rrrrrrr#szHEventAsTextTests.test_formatUnformattableWithTraceback..)rr3r{TF)r|r}N)ryrrassertIsInstancer r)r~)rrrrrrr%test_formatUnformattableWithTracebacks    z6EventAsTextTests.test_formatUnformattableWithTracebackcCsy tdWntk r&t}YnXdddddtdi}||d<t|d d d }|j|t|jd ||jt|j||jd|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. zThis is a fake errorrz{evil()}r3cSsddS)Nr,rrrrrrr#szMEventAsTextTests.test_formatUnformattableErrorWithTraceback..r5r{TF)r|r}z MESSAGE LOSTN)ryrr6rrr r)r~)rrrrrrr*test_formatUnformattableErrorWithTracebacks      z;EventAsTextTests.test_formatUnformattableErrorWithTracebackcCs<ddi}t|d<t|ddd}|j|t|jd|dS) zk If a traceback cannot be appended, a message indicating this is true is appended. rrr{TF)r|r}z'(UNABLE TO OBTAIN TRACEBACK FROM EVENT)N)r1rrr r))rrrrrr&test_formatEventUnformattableTraceback#s  z7EventAsTextTests.test_formatEventUnformattableTracebackcCs2ddi}t|ddd}|j|t|jd|dS)zY An event with no C{log_failure} key will not have a traceback appended. rzThis is a test log messageTF)r|r}N)rrr r))rrrrrrtest_formatEventNonCritical5s z,EventAsTextTests.test_formatEventNonCriticalc Csby tdWntk r&t}YnXddi}||d<t|ddd}|jd||jd|d S) zU An exception message with multibyte characters is properly handled. u€rzThis is a test log messager{TF)r|r} TracebackN)ryrrr))rrrrrrrtest_formatTracebackMultibyteEs   z.EventAsTextTests.test_formatTracebackMultibytec Csty tdWntk r&t}YnXddi}||d<t|ddd}|jd|tsd|jd |n |jd |d S) zj An error raised attempting to decode the UTF still produces a valid log message. s testrzThis is a test log messager{TF)r|r}ru��testz.CapturedError(b'\xff\xfet\x00e\x00s\x00t\x00')N)ryrrr)r)rrrrrrr,test_formatTracebackHandlesUTF8DecodeFailure[s    z=EventAsTextTests.test_formatTracebackHandlesUTF8DecodeFailurecCsdy tdWntk r&t}YnXtd}d d |d }||d <t|dddd}|j|ddS)zq If includeSystem is specified as the only option no timestamp or traceback are printed. zThis is a fake errorrQrRrSrTrUr, ABCD fake_system)rrjrbr{FT)r|includeTracebackr}z[fake_system] ABCDN) rrQrRrSrTrUr,rr,)ryrrrr()rrrXrrrrrtest_eventAsTextSystemOnlyys"  z+EventAsTextTests.test_eventAsTextSystemOnlycCstdkrtdt|tdy tdWntk rFt}YnXtd}d d|d}||d<t|dddd}|j|ddS)zq If includeTimestamp is specified as the only option no system or traceback are printed. Nz:Platform cannot change timezone; unable to verify offsets.zUTC+00zThis is a fake errorrQrRrSrTrUr, rr)rrjrbr{TF)r|rr}z2013-09-24T11:40:47+0000 ABCD) rrQrRrSrTrUr,rr,) rrrrryrrrr()rrrXrrrrrtest_eventAsTextTimestampOnlys,  z.EventAsTextTests.test_eventAsTextTimestampOnlycCsby tdWntk r&t}YnXtd}d |d }||d <t|d d dd}|j|ddS)z\ If includeSystem is specified with a missing system [-#-] is used. zThis is a fake errorrQrRrSrTrUr, r)rrbr{FT)r|rr}z [-#-] ABCDN) rrQrRrSrTrUr,rr,)ryrrrr()rrrXrrrrrtest_eventAsTextSystemMissings   z.EventAsTextTests.test_eventAsTextSystemMissingcCshy tdWntk r&t}YnXtd}d |tjd d }||d <t|dddd}|j|ddS)z If includeSystem is specified with a missing system but namespace and level are present they are used. zThis is a fake errorrQrRrSrTrUr, rtest)rrbrgrer{FT)r|rr}z[test#info] ABCDN) rrQrRrSrTrUr,rr,)ryrrr inforr()rrrXrrrrr.test_eventAsTextSystemMissingNamespaceAndLevels$  z?EventAsTextTests.test_eventAsTextSystemMissingNamespaceAndLevelcCsfy tdWntk r&t}YnXtd}d |tjd }||d <t|d d dd}|j|ddS)zv If includeSystem is specified with a missing system but level is present, level is included. zThis is a fake errorrQrRrSrTrUr, r)rrbrgr{FT)r|rr}z [-#info] ABCDN) rrQrRrSrTrUr,rr,)ryrrr rrr()rrrXrrrrr&test_eventAsTextSystemMissingLevelOnlys"   z7EventAsTextTests.test_eventAsTextSystemMissingLevelOnlyN)r<r=r>r?rrrrrrrrrrrrrrrrrrzs%rz)$r?Z!twisted.python.test.test_tzhelperrrrtimer ImportErrorZ twisted.trialrZtwisted.trial.unittestrZtwisted.python.compatrr Z_levelsr _formatr r rrrrZtwisted.python.failurerZTestCaserr@r^rtr1r6 Exceptionryrzrrrrs*       Z