o b1@sdZddlZddlmZmZmZmZmZmZm Z m Z ddl m Z ddl mZddlmZddlmZmZdd lmZmZdd lmZdd lmZdd lmZdd lmZdejdeedeeddfddZ GdddejZ!dS)z+ Test cases for L{twisted.logger._global}. N)IOAnyListOptionalTextIOTupleTypecast)Failure)unittest)textFileLogObserver)MORE_THAN_ONCE_WARNING LogBeginner) ILogObserverLogEvent)LogLevel)Logger) LogPublisher)nextLinetest actualEventsexpectedEventsreturncstt|t|kr|||t|D] }t|Oqdtdtffdd fdd|D}|||dS)a7 Compare two sequences of log events, examining only the the keys which are present in both. @param test: a test case doing the comparison @param actualEvents: A list of log events that were emitted by a logger. @param expectedEvents: A list of log events that were expected by a test. eventrcs,|}|D] }|vr||q|SN)copykeyspop)rrkey) allMergedKeysA/usr/lib/python3/dist-packages/twisted/logger/test/test_global.pysimplify*s   zcompareEvents..simplifycsg|]}|qSr!r!.0r)r#r!r" 1sz!compareEvents..N)len assertEqualsetrr)rrrrsimplifiedActualr!)r r#r" compareEventss r+c@seZdZdZd"ddZd"ddZd"dd Zd ed eddfd d Z d"ddZ d"ddZ d"ddZ d"ddZ d"ddZd"ddZd"ddZd"ddZd"ddZd"d d!ZdS)#LogBeginnerTestsz# Tests for L{LogBeginner}. rNcCsZt|_t|_Gddd}Gddd}||_||_t|j|j|j|j|_dS)Nc@seZdZeZeZdS)z&LogBeginnerTests.setUp..NotSysN)__name__ __module__ __qualname__objectstdoutstderrr!r!r!r"NotSys>s r3c@sReZdZd ddZ  ddedeededed ee e d eeddfd d Z dS)z+LogBeginnerTests.setUp..NotWarningsrNcSs g|_dSr)warnings)selfr!r!r"__init__Csz4LogBeginnerTests.setUp..NotWarnings.__init__messagecategoryfilenamelinenofilelinecSs|j||||||fdS)a Emulate warnings.showwarning. @param message: A warning message to emit. @param category: A warning category to associate with C{message}. @param filename: A file name for the source code file issuing the warning. @param lineno: A line number in the source file where the warning was issued. @param file: A file to write the warning message to. If L{None}, write to L{sys.stderr}. @param line: A line of source code to include with the warning message. If L{None}, attempt to read the line from C{filename} and C{lineno}. N)r4append)r5r7r8r9r:r;r<r!r!r" showwarningJsz7LogBeginnerTests.setUp..NotWarnings.showwarningrN)NN) r-r.r/r6strrWarningintrrrr>r!r!r!r" NotWarningsBs&   rC) r publisherioStringIO errorStream sysModulewarningsModulerbeginner)r5r3rCr!r!r"setUp:s # zLogBeginnerTests.setUpcsrtddd}ggttfdd}ttfdd}|j||f||||g||gdS)z? Test that C{beginLoggingTo()} adds observers. r foobarc |Srr=eevents1r!r"t zBLogBeginnerTests.test_beginLoggingToAddObservers..crPrrQrRevents2r!r"rVurWN)dictr rrJbeginLoggingTorDr(r5ro1o2r!rUrYr"test_beginLoggingToAddObserversks  z0LogBeginnerTests.test_beginLoggingToAddObserverscsrtddd}ggttfdd}ttfdd}|||j||f||g||gdS)z\ Test that events are buffered until C{beginLoggingTo()} is called. rLr rMcrPrrQrRrTr!r"rVrWzDLogBeginnerTests.test_beginLoggingToBufferedEvents..crPrrQrRrXr!r"rVrWN)rZr rrDrJr[r(r\r!r_r"!test_beginLoggingToBufferedEvents}s  z2LogBeginnerTests.test_beginLoggingToBufferedEventslimitrJcCsft|dD] }|t|dqg}|tt|jg|ttd|dtdd|DdS)a Verify that when more than C{limit} events are logged to L{LogBeginner}, only the last C{limit} are replayed by L{LogBeginner.beginLoggingTo}. @param limit: The maximum number of events the log beginner should buffer. @param beginner: The L{LogBeginner} against which to verify. @raise: C{self.failureException} if the wrong events are replayed by C{beginner}. rL)countcss|]}|dVqdS)rcNr!r$r!r!r" sz4LogBeginnerTests._bufferLimitTest..N) rangerDrZr[r rr=r(list)r5rbrJrceventsr!r!r"_bufferLimitTests z!LogBeginnerTests._bufferLimitTestcCstj}|||jdS)z Up to C{LogBeginner._DEFAULT_BUFFER_SIZE} log events are buffered for replay by L{LogBeginner.beginLoggingTo}. N)r_DEFAULT_BUFFER_SIZErhrJ)r5rbr!r!r"test_defaultBufferLimitsz(LogBeginnerTests.test_defaultBufferLimitcCs.d}t|j|j|j|j|d}|||dS)z The size of the L{LogBeginner} event buffer can be overridden with the C{initialBufferSize} initilizer argument. )initialBufferSizeN)rrDrGrHrIrh)r5rbrJr!r!r"test_overrideBufferLimitsz)LogBeginnerTests.test_overrideBufferLimitc Cs$g}g}t}t|}|tddt\}}|jtt |j |g|tddt\}}|jtt |j |g|tddtt t j ||||d} d|_t||tddtdd| tddgt||| tddg|} |d|d|d | |d|d|d | dS) z When invoked twice, L{LogBeginner.beginLoggingTo} will emit a log message warning the user that they previously began logging, and add the new log observers. prebuffer)r postbufferpostwarn) log_format log_levelfileNowlineNowfileThenlineThenN<:>)rErFr rDrZrrJr[r rr=rrwarnmaxDiffr+getvalueassertIn) r5rUrY fileHandle textObserver firstFilename firstLinesecondFilename secondLinewarningoutputr!r!r"test_beginLoggingToTwicesB    z)LogBeginnerTests.test_beginLoggingToTwicecCs:t|jd}|d|jddd||jddS)zP Critical messages will be written as text to the error stream. observerz ignore thisza critical {message}r7)r7za critical message N)rrDinfocriticalr(rGr|r5logr!r!r"test_criticalLoggings  z%LogBeginnerTests.test_criticalLoggingcCs8t|jd}|jd|d||jddS)z Once logging has begun with C{beginLoggingTo}, critical messages are no longer written to the output stream. rr!zanother critical messageN)rrDrJr[rr(rGr|rr!r!r"test_criticalLoggingStopss   z*LogBeginnerTests.test_criticalLoggingStopscCsg}|jtt|jgtdtt|jjdt ||t dddg|dd=tdtt|jj dt ||t dddgdS)z L{LogBeginner.beginLoggingTo} will re-direct the standard output and error streams by setting the C{stdio} and C{stderr} attributes on its sys module object. z Hello, world.r;r1) log_namespacelog_ioNz Error, world.r2) rJr[r rr=printrrHr1r+rZr2)r5rgr!r!r"%test_beginLoggingToRedirectStandardIOs z6LogBeginnerTests.test_beginLoggingToRedirectStandardIOcCsD|jj}|jj}|jjddd||jj|||jj|dS)z L{LogBeginner.beginLoggingTo} will leave the existing stdout/stderr in place if it has been told not to replace them. r!F)redirectStandardION)rHr1r2rJr[assertIs)r5oldOutoldErrr!r!r"test_beginLoggingToDontRedirect s z0LogBeginnerTests.test_beginLoggingToDontRedirectcCsttd}ttd}||j_||j_g}|jtt |j gtt |jj}tt |jj}| |j d| |j d|d|dt||tddtddgdS) z When L{LogBeginner.beginLoggingTo} redirects stdout/stderr streams, the replacement streams will preserve the encoding of the replaced streams, to minimally disrupt any application relying on a specific encoding. z shift-JISbig5s s u李)ru瑩N)rE TextIOWrapperBytesIOrHr1r2rJr[r rr=rr(encodingwriter+rZ)r5weirdweirderrrgr1r2r!r!r"$test_beginLoggingToPreservesEncodings   z5LogBeginnerTests.test_beginLoggingToPreservesEncodingc Cs|jdttdg}|jtt|jg|jdttdt }|jjdttd|d| |jj dttdddfdttd|dfgt ||tdtjd tjtdd gdS) z L{LogBeginner.beginLoggingTo} will redirect the warnings of its warnings module into the logging system. z a messagerLzanother messager z yet anotherrkrN.)rr8r9r:)rIr>DeprecationWarning__file__rJr[r rr=rErFr(r4r+rZr.r-)r5rgfr!r!r"test_warningsModule/s> z$LogBeginnerTests.test_warningsModulecCsXttd}t|jd}|jd|d|j}|d||d||d|dS)zR The string resulting from a logged failure contains a traceback. z,this is not the behavior you are looking forrz a failure)failure TracebackN)r ExceptionrrDrrGr|r})r5rrmsgr!r!r"test_failuresAppendTracebacksVs     z.LogBeginnerTests.test_failuresAppendTracebacksr?)r-r.r/__doc__rKr`rarBrrhrjrmrrrrrrrrr!r!r!r"r,5s   1     +  'r,)"rrEtypingrrrrrrrr twisted.python.failurer twisted.trialr _filer _globalrr _interfacesrr_levelsr_loggerr _observerrtest.test_stdlibrTestCaser+r,r!r!r!r"s,(