a )(bU@s0dZddlmZmZmZzddlmZeWneyBdZYn0ddlm 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@sreZdZdZddddZddddZdddd Zddd d Zddd d ZddddZ ddddZ dS)FormattingTestsz5 Tests for basic event formatting functions. Nreturncstttdfdd }d|dd|dd|dddd |d d d d dd|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)rrresultself>lib/python3.9/site-packages/twisted/logger/test/test_format.pyformat9sz0FormattingTests.test_formatEvent..formatabcz{x})xzno, yes.z{not_called}, {called()}.ZnocSsdS)NZyesr!r!r!r!r"Dr%z2FormattingTests.test_formatEvent..)Z not_calledZcalleduSánchezsSánchezUnable to format eventsSnchezs S{a!s}nchez)az Sb'\xe1'nchezSZnchezs S{a!r}nchezN)robjectr assertEqualassertInrepr)r r#Z maybeResultZxe1r!rr"test_formatEvent's   z FormattingTests.test_formatEventcCs$tddd}t|}|d|dS)z5 Formatting an event with no format. r )foobarr$N)dictrr.r rrr!r!r"test_formatEventNoFormatNs z(FormattingTests.test_formatEventNoFormatcCs8ttddd}t|}|d||t||dS)z: Formatting an event with a bogus format. r2r )rr3r4zLog format must be strN)r5r-rr/r0r6r!r!r"test_formatEventWeirdFormatWs z+FormattingTests.test_formatEventWeirdFormatcCs8tdddd}t|}|d||t||dS)zF Formatting an event that's just plain out to get us. {evil()}cSsddSNr2rr!r!r!r!r"r(er%z?FormattingTests.test_formatUnformattableEvent..revilr)N)r5rr/r0r6r!r!r"test_formatUnformattableEventas z-FormattingTests.test_formatUnformattableEventcCsLdddddtttdi}t|}|d||d||d |d S) zR Formatting an unformattable event that has an unformattable key. rr9r<cSsddSr:r!r!r!r!r"r(qr%zSFormattingTests.test_formatUnformattableEventWithUnformattableKey..gurk*MESSAGE LOST: unformattable object logged:Recoverable data:Exception during formatting:N)rr Unformattablerr/r6r!r!r"1test_formatUnformattableEventWithUnformattableKeyks   zAFormattingTests.test_formatUnformattableEventWithUnformattableKeycCsDtdddtd}t|}|d||d||d|dS) T Formatting an unformattable event that has an unformattable value. r9cSsddSr:r!r!r!r!r"r(r%zUFormattingTests.test_formatUnformattableEventWithUnformattableValue..)rr<r>r?r@rAN)r5rBrr/r6r!r!r"3test_formatUnformattableEventWithUnformattableValueys  zCFormattingTests.test_formatUnformattableEventWithUnformattableValuecCsPtddddd}t|ttt}|d||tddtd|d S) rDr9cSsddSr:r!r!r!r!r"r(r%zbFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop..Zokay)rr< recoverabler?rFz = N)r5rr BaseExceptionrBr/r0r6r!r!r"@test_formatUnformattableEventWithUnformattableErrorOMGWillItStops zPFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop) __name__ __module__ __qualname____doc__r1r7r8r=rCrErHr!r!r!r"r"s'   rc@sdeZdZdZddddZddddZdddd Zddd d Zddd d ZddddZ dS)TimeFormattingTestsz. Tests for time formatting functions. NrcCs t|dS)N)rrr!r!r"setUpszTimeFormattingTests.setUpcs\tdurtdtttddfdd }|ddd|d d 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.)name expectedDST expectedSTDrcs<t|td}td}t||t||dS)N) irrrr2) ir2rrrr rWr)r rr.r)rPrQrRZlocalDSTZlocalSTDrr!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)r rXr!rr" test_formatTimeWithDefaultFormats. z4TimeFormattingTests.test_formatTimeWithDefaultFormatcCs(|tdd|tdddddS)zL If C{when} argument is L{None}, we get the default output. N-!)defaultr.rrr!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  (/r2i r2N timeFormatr[r\)rgr]rr.rr tr!r!r"test_formatTimeWithNoFormatsz/TimeFormattingTests.test_formatTimeWithNoFormatcCs td}|t|ddddS)z2 Alternate time format in output. r`z%Y/%Wrfz2013/38Nrhrir!r!r"&test_formatTimeWithAlternateTimeFormatsz:TimeFormattingTests.test_formatTimeWithAlternateTimeFormatcCs|tdddddS)z0 "%f" supported in time format. g?x.Az%frfZ234560Nr^rr!r!r"test_formatTimePercentFsz+TimeFormattingTests.test_formatTimePercentF) rIrJrKrLrNrZr_rkrlrmr!r!r!r"rMs-rMc@seZdZdZddddZddddZdddd Zddd d Zddd d ZddddZ ddddZ ddddZ ddddZ ddddZ ddddZdS)ClassicLogFormattingTestsz@ Tests for classic text log event formatting functions. NrcCsHtdurtdt|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. NrOrYr`XYZZYrlog_timez%2013-09-24T11:40:47+0000 [-#-] XYZZY )rr rr rr5r.r)r rjrr!r!r"test_formatTimeDefaults z0ClassicLogFormattingTests.test_formatTimeDefaultcCs8tttddd}tddd}|t||ddd S) zc Time is first field. Custom formatting function is an optional argument. )rjrcSs d|dS)N__r!)rjr!r!r"rszCClassicLogFormattingTests.test_formatTimeCustom..formatTimeroi90rp)rz__12345__ [-#-] XYZZY N)rfloatrr5r.r)r rrr!r!r"test_formatTimeCustoms   z/ClassicLogFormattingTests.test_formatTimeCustomcCs tddd}|t|ddS)z: Namespace is first part of second field. ro my.namespace)r log_namespacez- [my.namespace#-] XYZZY Nr5r.rr rr!r!r"test_formatNamespaces  z.ClassicLogFormattingTests.test_formatNamespacecCs"tdtjd}|t|ddS)z7 Level is second part of second field. ro)r log_levelz- [-#warn] XYZZY Nr5rwarnr.rryr!r!r"test_formatLevels z*ClassicLogFormattingTests.test_formatLevelcCs tddd}|t|ddS)z) System is second field. ro S.Y.S.T.E.M.r log_system- [S.Y.S.T.E.M.] XYZZY Nrxryr!r!r"test_formatSystem#s  z+ClassicLogFormattingTests.test_formatSystemcCs&tddtjdd}|t|ddS)B System is not supplanted by namespace and level. rorvr)rrwr{rrNr|ryr!r!r"test_formatSystemRulz-sz/ClassicLogFormattingTests.test_formatSystemRulzcCs"tdtd}|t|ddS)rrorz- [UNFORMATTABLE] XYZZY N)r5rBr.rryr!r!r"test_formatSystemUnformattable<s z8ClassicLogFormattingTests.test_formatSystemUnformattablecCs tddd}|t|ddS)z0 Formatted event is last field. zid:{id}123ridz- [-#-] id:123 Nrxryr!r!r"test_formatFormatFs  z+ClassicLogFormattingTests.test_formatFormatcCstdd}|t|ddS)z# No format string. r)rNr5rrryr!r!r"test_formatNoFormatPs z-ClassicLogFormattingTests.test_formatNoFormatcCs tddd}|t|ddS)z& Empty format string. r$rrNrryr!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" Nrxryr!r!r"test_formatFormatMultiLine^s  z4ClassicLogFormattingTests.test_formatFormatMultiLine)rIrJrKrLrrrurzr~rrrrrrrr!r!r!r"rns     rnc@seZdZdZddddZdS)FormatFieldTestsz+ Tests for format field functions. NrcCs>|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()}.ZearthcSsdS)Nmayber!r!r!r!r"r(xr%z6FormatFieldTests.test_formatWithCall..)ZworldZcallmezHello, earth. maybe.zHello, {repr()!r}.cSsdS)Nr0r!r!r!r!r"r(}r%)r0zHello, 'repr'.N)r.rr5rr!r!r"test_formatWithCallnsz$FormatFieldTests.test_formatWithCall)rIrJrKrLrr!r!r!r"risrc@seZdZdZedddZdS)rBz> An object that raises an exception from C{__repr__}. rcCs tddSr:)rrr!r!r"__repr__szUnformattable.__repr__N)rIrJrKrLrrr!r!r!r"rBsrBc@seZdZdZdS) CapturedErrorz3 A captured error for use in format tests. N)rIrJrKrLr!r!r!r"rsrc@seZdZdZddddZddddZdddd Zddd d Zddd d ZddddZ ddddZ ddddZ ddddZ ddddZ ddddZddddZddddZdS)EventAsTextTestszi Tests for L{eventAsText}, all of which ensure that the returned type is UTF-8 decoded text. NrcCshz tdWnty$t}Yn0ddi}||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 r/r getTracebackr fr eventTextr!r!r"test_eventWithTracebacks   z(EventAsTextTests.test_eventWithTracebackcCshz tdWnty$t}Yn0ddi}||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_formatEmptyEventWithTracebackcCszz tdWnty$t}Yn0dddd}||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. rr9cSsddSr:r!r!r!r!r"r(r%zHEventAsTextTests.test_formatUnformattableWithTraceback..r;rTFrN)rrr assertIsInstancerr/rrr!r!r"%test_formatUnformattableWithTracebacks    z6EventAsTextTests.test_formatUnformattableWithTracebackcCsz tdWnty$t}Yn0dddddtttdi}||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. rrr9r<cSsddSr:r!r!r!r!r"r(r%zMEventAsTextTests.test_formatUnformattableErrorWithTraceback..r>rTFrz MESSAGE LOSTN) rrrrrBr rr/rrr!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)r-r rrr/r rrr!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 rrr/rr!r!r"test_formatEventNonCriticals z,EventAsTextTests.test_formatEventNonCriticalcCs`z tdWnty$t}Yn0ddi}||d<t|ddd}|d||d|d S) zU An exception message with multibyte characters is properly handled. u€rrrTFr TracebackNrrr r/rr!r!r"test_formatTracebackMultibytes    z.EventAsTextTests.test_formatTracebackMultibytecCs`z tdWnty$t}Yn0ddi}||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_formatTracebackHandlesUTF8DecodeFailurecCsbz tdWnty$t}Yn0td}dd|d}||d<t|dddd }||d d S) zq If includeSystem is specified as the only option no timestamp or traceback are printed. rr`ABCD fake_systemrrrqrFTrZincludeTracebackrz[fake_system] ABCDNrrrr r.r rrjrrr!r!r"test_eventAsTextSystemOnlys(   z+EventAsTextTests.test_eventAsTextSystemOnlycCstdurtdt|tdz tdWntyDt}Yn0td}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. NrOrYrr`rrrrTFrz2013-09-24T11:40:47+0000 ABCD) rr rr rrrr r.rr!r!r"test_eventAsTextTimestampOnly0s0   z.EventAsTextTests.test_eventAsTextTimestampOnlycCs`z tdWnty$t}Yn0td}d|d}||d<t|dddd}||d d S) z\ If includeSystem is specified with a missing system [-#-] is used. rr`rrprFTrz [-#-] ABCDNrrr!r!r"test_eventAsTextSystemMissingRs&   z.EventAsTextTests.test_eventAsTextSystemMissingcCsfz tdWnty$t}Yn0td}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. rr`rtest)rrqr{rwrFTrz[test#info] ABCDNrrrrinfor r.rr!r!r".test_eventAsTextSystemMissingNamespaceAndLevelms*   z?EventAsTextTests.test_eventAsTextSystemMissingNamespaceAndLevelcCsdz tdWnty$t}Yn0td}d|tjd}||d<t|dddd}||d d S) zv If includeSystem is specified with a missing system but level is present, level is included. rr`r)rrqr{rFTrz [-#info] ABCDNrrr!r!r"&test_eventAsTextSystemMissingLevelOnlys(   z7EventAsTextTests.test_eventAsTextSystemMissingLevelOnly)rIrJrKrLrrrrrrrrrrrrrr!r!r!r"rs  "r)&rLtypingrrrtimer ImportErrorZtwisted.python.failurerZ!twisted.python.test.test_tzhelperrrr Z twisted.trialr Ztwisted.trial.unittestr Z_formatr rrrrrZ _interfacesrZ_levelsrZTestCaserrMrnrrB Exceptionrrr!r!r!r"s*         tR