o bU@s0dZddlmZmZmZz ddlmZeWn ey!dZYnwddlm Z ddl m Z m Z m Z ddlmZddlmZd d lmZmZmZmZmZmZd d lmZd d lmZGd ddejZGdddejZGdddejZ GdddejZ!GdddZ"Gddde#Z$GdddejZ%dS)z+ Test cases for L{twisted.logger._format}. )AnyStrOptionalcast)tzsetN)Failure) addTZCleanupmktimesetTZ)unittest)SkipTest) eventAsText formatEventformatEventAsClassicLogText formatTimeformatUnformattableEventformatWithCall)LogEvent)LogLevelc@sVeZdZdZdddZdddZddd Zdd d Zdd d ZdddZ dddZ dS)FormattingTestsz5 Tests for basic event formatting functions. returnNcsdtdtdtffdd }d|dd|dd|d dd d |d d dddd|dd|d|ddd}d|ttd}d|d|ddddS)ac 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{str}, and if given bytes, will always treat its format string as UTF-8 encoded. logFormateventrcs$||d<t|}t|t|S)N log_format)rassertIstypestr)rrresultselfA/usr/lib/python3/dist-packages/twisted/logger/test/test_format.pyformat9sz0FormattingTests.test_formatEvent..formatabcz{x})xzno, yes.z{not_called}, {called()}.nocSdS)Nyesr r r r r!Dz2FormattingTests.test_formatEvent..) not_calledcalleduSánchezsSánchezUnable to format eventsSnchezs S{a!s}nchez)az Sb'\xe1'nchezSnchezs S{a!r}nchezN)robjectr assertEqualassertInrepr)rr" maybeResultxe1r rr!test_formatEvent's    z FormattingTests.test_formatEventcCs$tddd}t|}|d|dS)z5 Formatting an event with no format. r )foobarr#N)dictrr4rrrr r r!test_formatEventNoFormatNs z(FormattingTests.test_formatEventNoFormatcCs8ttddd}t|}|d||t||dS)z: Formatting an event with a bogus format. r:r )rr;r<zLog format must be strN)r=r3rr5r6r>r r r!test_formatEventWeirdFormatW z+FormattingTests.test_formatEventWeirdFormatcCs8tdddd}t|}|d||t||dS)zF Formatting an event that's just plain out to get us. {evil()}cSddSNr:rr r r r r!r*ez?FormattingTests.test_formatUnformattableEvent..revilr.N)r=rr5r6r>r r r!test_formatUnformattableEventarAz-FormattingTests.test_formatUnformattableEventcCsLdddddtttdi}t|}|d||d||d |d S) zR Formatting an unformattable event that has an unformattable key. rrBrGcSrCrDr r r r r!r*qrEzSFormattingTests.test_formatUnformattableEventWithUnformattableKey..gurk*MESSAGE LOST: unformattable object logged:Recoverable data:Exception during formatting:N)rr Unformattablerr5r>r r r!1test_formatUnformattableEventWithUnformattableKeyks   zAFormattingTests.test_formatUnformattableEventWithUnformattableKeycCsDtdddtd}t|}|d||d||d|dS) T Formatting an unformattable event that has an unformattable value. rBcSrCrDr r r r r!r*rEzUFormattingTests.test_formatUnformattableEventWithUnformattableValue..)rrGrIrJrKrLN)r=rMrr5r>r r r!3test_formatUnformattableEventWithUnformattableValueys  zCFormattingTests.test_formatUnformattableEventWithUnformattableValuecCsPtddddd}t|ttt}|d||tddtd|d S) rOrBcSrCrDr r r r r!r*rEzbFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop..okay)rrG recoverablerJrRz = N)r=rr BaseExceptionrMr5r6r>r r r!@test_formatUnformattableEventWithUnformattableErrorOMGWillItStops  zPFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStoprN) __name__ __module__ __qualname____doc__r9r?r@rHrNrPrTr r r r!r"s  ' rc@sLeZdZdZdddZdddZddd Zdd d Zdd d ZdddZ dS)TimeFormattingTestsz. Tests for time formatting functions. rNcCs t|dS)N)rrr r r!setUp zTimeFormattingTests.setUpcsbtdurtddtdtdtddffdd }|d d d |d d d|ddd|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.name expectedDST expectedSTDrcs<t|td}td}t||t||dS)N) irrrr:) ir:rrrr rer)r rr4r)r^r_r`localDSTlocalSTDrr r!testForTimeZones 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 r)rrhr rr! test_formatTimeWithDefaultFormats. z4TimeFormattingTests.test_formatTimeWithDefaultFormatcCs(|tdd|tdddddS)zL If C{when} argument is L{None}, we get the default output. N-!)defaultr4rrr r r!test_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 timeFormatrkrl)rwrmrr4rrtr r r!test_formatTimeWithNoFormatsz/TimeFormattingTests.test_formatTimeWithNoFormatcCs td}|t|ddddS)z2 Alternate time format in output. rpz%Y/%Wrvz2013/38Nrxryr r r!&test_formatTimeWithAlternateTimeFormatsz:TimeFormattingTests.test_formatTimeWithAlternateTimeFormatcCs|tdddddS)z0 "%f" supported in time format. g?x.Az%frv234560Nrnrr r r!test_formatTimePercentFsz+TimeFormattingTests.test_formatTimePercentFrU) rVrWrXrYr[rjror{r|r~r r r r!rZs   -  rZc@s~eZdZdZdddZdddZddd Zdd d Zdd d ZdddZ dddZ dddZ dddZ dddZ dddZdS)ClassicLogFormattingTestsz@ Tests for classic text log event formatting functions. rNcCsHtdurtdt|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. Nr]rirpXYZZYrlog_timez%2013-09-24T11:40:47+0000 [-#-] XYZZY )rr rr rr=r4r)rrzrr r r!test_formatTimeDefaults z0ClassicLogFormattingTests.test_formatTimeDefaultcCs:dttdtfdd}tddd}|t||dd d S) zc Time is first field. Custom formatting function is an optional argument. rzrcSs d|dS)N__r )rzr r r!rr\zCClassicLogFormattingTests.test_formatTimeCustom..formatTimeri90r)rz__12345__ [-#-] XYZZY N)rfloatrr=r4r)rrrr r r!test_formatTimeCustoms   z/ClassicLogFormattingTests.test_formatTimeCustomcC tddd}|t|ddS)z: Namespace is first part of second field. r my.namespace)r log_namespacez- [my.namespace#-] XYZZY Nr=r4rrrr r r!test_formatNamespace z.ClassicLogFormattingTests.test_formatNamespacecCs"tdtjd}|t|ddS)z7 Level is second part of second field. r)r log_levelz- [-#warn] XYZZY Nr=rwarnr4rrr r r!test_formatLevel z*ClassicLogFormattingTests.test_formatLevelcCr)z) System is second field. r S.Y.S.T.E.M.r log_system- [S.Y.S.T.E.M.] XYZZY Nrrr r r!test_formatSystem#rz+ClassicLogFormattingTests.test_formatSystemcCs&tddtjdd}|t|ddS)B System is not supplanted by namespace and level. rrr)rrrrrNrrr r r!test_formatSystemRulz-sz/ClassicLogFormattingTests.test_formatSystemRulzcCs"tdtd}|t|ddS)rrrz- [UNFORMATTABLE] XYZZY N)r=rMr4rrr r r!test_formatSystemUnformattable<rz8ClassicLogFormattingTests.test_formatSystemUnformattablecCr)z0 Formatted event is last field. zid:{id}123ridz- [-#-] id:123 Nrrr r r!test_formatFormatFrz+ClassicLogFormattingTests.test_formatFormatcCstdd}|t|ddS)z# No format string. r)rNr=rrrr r r!test_formatNoFormatPs z-ClassicLogFormattingTests.test_formatNoFormatcCs tddd}|t|ddS)z& Empty format string. r#rrNrrr r r!test_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" Nrrr r r!test_formatFormatMultiLine^s z4ClassicLogFormattingTests.test_formatFormatMultiLinerU)rVrWrXrYrrrrrrrrrrrr r r r!rs     rc@seZdZdZdddZdS)FormatFieldTestsz+ Tests for format field functions. rNcCs>|tdtddddd|tdtddd d d S) z L{formatWithCall} is an extended version of L{str.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()}.earthcSr()Nmayber r r r r!r*xr+z6FormatFieldTests.test_formatWithCall..)worldcallmezHello, earth. maybe.zHello, {repr()!r}.cSr()Nr6r r r r r!r*}r+)r6zHello, 'repr'.N)r4rr=rr r r!test_formatWithCallnsz$FormatFieldTests.test_formatWithCallrU)rVrWrXrYrr r r r!risrc@seZdZdZdefddZdS)rMz> An object that raises an exception from C{__repr__}. rcCs tddSrD)rrr r r!__repr__r\zUnformattable.__repr__N)rVrWrXrYrrr r r r!rMsrMc@seZdZdZdS) CapturedErrorz3 A captured error for use in format tests. N)rVrWrXrYr r r r!rsrc@seZdZdZdddZdddZddd Zdd d Zdd d ZdddZ dddZ dddZ dddZ dddZ dddZdddZdddZdS)EventAsTextTestszi Tests for L{eventAsText}, all of which ensure that the returned type is UTF-8 decoded text. rNcCsdztdtyt}Ynwddi}||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 includeSystemNrrr r5r getTracebackrfr eventTextr r r!test_eventWithTracebacks  z(EventAsTextTests.test_eventWithTracebackcCsdztdtyt}Ynwddi}||d<t|ddd}|t|||d|dS) zu An event with an empty C{log_format} key appends a traceback from the accompanying failure. rrr#rTFrNrrr r r!"test_formatEmptyEventWithTracebacks  z3EventAsTextTests.test_formatEmptyEventWithTracebackcCsvztdtyt}Ynwdddd}||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. rrBcSrCrDr r r r r!r*rEzHEventAsTextTests.test_formatUnformattableWithTraceback..rFrTFrN)rrr assertIsInstancerr5rrr r r!%test_formatUnformattableWithTracebacks   z6EventAsTextTests.test_formatUnformattableWithTracebackcCsztdtyt}Ynwdddddtttdi}||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. rrrBrGcSrCrDr r r r r!r*rEzMEventAsTextTests.test_formatUnformattableErrorWithTraceback..rIrTFrz MESSAGE LOSTN) rrrrrMr rr5rrr r r!*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. rr#rTFrz'(UNABLE TO OBTAIN TRACEBACK FROM EVENT)N)r3r rrr5rrrr r r!&test_formatEventUnformattableTracebacks   z7EventAsTextTests.test_formatEventUnformattableTracebackcCs2ddi}t|ddd}||t|d|dS)zY An event with no C{log_failure} key will not have a traceback appended. rrTFrN)r rrr5rr r r!test_formatEventNonCriticals z,EventAsTextTests.test_formatEventNonCriticalcCs\ztdtyt}Ynwddi}||d<t|ddd}|d||d|d S) zU An exception message with multibyte characters is properly handled. u€rrrTFr TracebackNrrr r5rr r r!test_formatTracebackMultibytes   z.EventAsTextTests.test_formatTracebackMultibytecCs\ztdtyt}Ynwddi}||d<t|ddd}|d||d |d S) zj An error raised attempting to decode the UTF still produces a valid log message. s testrrrTFrrz.CapturedError(b"\xff\xfet\x00e\x00s\x00t\x00")Nrrr r r!,test_formatTracebackHandlesUTF8DecodeFailures   z=EventAsTextTests.test_formatTracebackHandlesUTF8DecodeFailurecCs^ztdtyt}Ynwtd}dd|d}||d<t|dddd }||d d S) zq If includeSystem is specified as the only option no timestamp or traceback are printed. rrpABCD fake_systemrrrrFTrincludeTracebackrz[fake_system] ABCDNrrrr r4rrrzrrr r r!test_eventAsTextSystemOnlys*  z+EventAsTextTests.test_eventAsTextSystemOnlycCs~tdurtdt|tdztdty t}Ynwtd}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. Nr]rirrprrrrTFrz2013-09-24T11:40:47+0000 ABCD) rr rr rrrr r4rr r r!test_eventAsTextTimestampOnly0s2  z.EventAsTextTests.test_eventAsTextTimestampOnlycCs\ztdtyt}Ynwtd}d|d}||d<t|dddd}||d d S) z\ If includeSystem is specified with a missing system [-#-] is used. rrprrrFTrz [-#-] ABCDNrrr r r!test_eventAsTextSystemMissingRs(  z.EventAsTextTests.test_eventAsTextSystemMissingcCsbztdtyt}Ynwtd}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. rrprtest)rrrrrFTrz[test#info] ABCDNrrrrinfor r4rr r r!.test_eventAsTextSystemMissingNamespaceAndLevelms,  z?EventAsTextTests.test_eventAsTextSystemMissingNamespaceAndLevelcCs`ztdtyt}Ynwtd}d|tjd}||d<t|dddd}||d d S) zv If includeSystem is specified with a missing system but level is present, level is included. rrpr)rrrrFTrz [-#info] ABCDNrrr r r!&test_eventAsTextSystemMissingLevelOnlys*  z7EventAsTextTests.test_eventAsTextSystemMissingLevelOnlyrU)rVrWrXrYrrrrrrrrrrrrrr r r r!rs         " r)&rYtypingrrrtimer ImportErrortwisted.python.failurer!twisted.python.test.test_tzhelperrrr twisted.trialr twisted.trial.unittestr _formatr rrrrr _interfacesr_levelsrTestCaserrZrrrM Exceptionrrr r r r!s.        tR