U W[H@sdZddlmZmZddlmZmZddlmZddl m Z ddl m Z ddl mZmZdd lmZdd lmZdd lmZdd lmZdd lmZmZmZmZmZddlm Z ddZ!Gddde Z"Gddde Z#Gddde Z$dS)z$ Tests for L{twisted.logger._json}. )StringIOBytesIO) verifyObjectBrokenMethodImplementation)unicode)TestCase)Failure) ILogObserver LogPublisher) formatEvent)LogLevel) extractField)globalLogPublisher) eventAsJSON eventFromJSONjsonFileLogObservereventsFromJSONLogFilelog)LoggercCs"||t||dd|S)a Assert a few things about the result of L{eventAsJSON}, then return it. @param testCase: The L{TestCase} with which to perform the assertions. @type testCase: L{TestCase} @param savedJSON: The result of L{eventAsJSON}. @type savedJSON: L{unicode} (we hope) @return: C{savedJSON} @rtype: L{unicode} @raise AssertionError: If any of the preconditions fail.  r)assertIsInstancer assertEqualcount)ZtestCaseZ savedJSONr?/usr/lib/python3/dist-packages/twisted/logger/test/test_json.pysavedJSONInvariantss rc@sheZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdS) SaveLoadTestsz2 Tests for loading and saving log events. cCst|t|S)z Serialize some an events, assert some things about it, and return the JSON. @param event: An event. @type event: L{dict} @return: JSON. )rr)selfeventrrrsavedEventJSON8s zSaveLoadTests.savedEventJSONcCs|t|iidS)zX Saving and loading an empty dictionary results in an empty dictionary. Nrrr rrrrtest_simpleSaveLoadEsz!SaveLoadTests.test_simpleSaveLoadcCs&|t|dddddddS)a Saving and loading a dictionary with some simple values in it results in those same simple values in the output; according to JSON's rules, though, all dictionary keys must be L{unicode} and any non-L{unicode} keys will be converted. r 4)31r&Nr!r"rrr test_saveLoadLszSaveLoadTests.test_saveLoadcCs,|t|dtddddiddS)zx Saving and loading an object which cannot be represented in JSON will result in a placeholder. r r' unpersistableTNrrr objectr"rrrtest_saveUnPersistableYs z$SaveLoadTests.test_saveUnPersistablecCs,|t|dtddddiddS)zD Non-ASCII keys and values can be saved and loaded. u䌡)uሴr&r*TNr+r"rrrtest_saveNonASCIIds   zSaveLoadTests.test_saveNonASCIIcCsZdd}d|tdi}ttk r.|ddi|t||d|tddidS) zx Any L{bytes} objects will be saved as if they are latin-1 so they can be faithfully re-loaded. cSs$ttkrdtt|St|SdS)N)bytesstrjoinmapchrxrrrasbytesusz-SaveLoadTests.test_saveBytes..asbytesZhellosskippedZokaycharmapN)ranger0r1updaterrr decode)rr7 inputEventrrrtest_saveBytesps zSaveLoadTests.test_saveBytescCs@Gdddt}d|dd}t||}|t|ddS)a  Saving and loading an object which cannot be represented in JSON, but has a string representation which I{can} be saved as JSON, will result in the same string formatting; any extractable fields will retain their data types. c@seZdZddZddZdS)z@SaveLoadTests.test_saveUnPersistableThenFormat..ReprablecSs ||_dSNvalue)rrArrr__init__szISaveLoadTests.test_saveUnPersistableThenFormat..Reprable.__init__cSsdS)NZreprablerr"rrr__repr__szISaveLoadTests.test_saveUnPersistableThenFormat..Reprable.__repr__N)__name__ __module__ __qualname__rBrCrrrrReprablesrGz{object} {object.value} log_formatr,z reprable 7N)r,rr rr )rrGr=Z outputEventrrr test_saveUnPersistableThenFormats z.SaveLoadTests.test_saveUnPersistableThenFormatcCsbGdddt}td|d}t||}|td|d|ttd||ttd|dS) zs L{extractField} can extract fields from an object that's been saved and loaded from JSON. c@seZdZddZdS)z8SaveLoadTests.test_extractingFieldsPostLoad..ObjcSs d|_dS)NYr@r"rrrrBszASaveLoadTests.test_extractingFieldsPostLoad..Obj.__init__N)rDrErFrBrrrrObjsrMz{object.value}rIz object.valuerLr,N)r,dictrr rr assertRaisesKeyError)rrMr= loadedEventrrrtest_extractingFieldsPostLoads z+SaveLoadTests.test_extractingFieldsPostLoadcCsg}t|jd}z ddWn&tk rBt}|d|YnXddl}|ddk rd||t |dt | |dd}| |t| |t| |tdS)zl Round-tripping a failure through L{eventAsJSON} preserves its class and structure. observerr%rza message about failureN log_failure)rappendZeroDivisionErrorrfailuresysexc_infoZ exc_clearrlenrr rZ assertTrueZcheckZ getTracebackr1)reventsrfrYZloadedrrrtest_failureStructurePreserveds   z,SaveLoadTests.test_failureStructurePreservedcCs0ttjd}t||}||dtjdS)zo It's important that the C{log_level} key remain a L{constantly.NamedConstant} object.  log_levelr`N)rNr warnrr ZassertIs)rr=rQrrrtest_saveLoadLevels z SaveLoadTests.test_saveLoadLevelcCstd}||tdddS)z If a saved bit of JSON (let's say, from a future version of Twisted) were to persist a different log_level, it will resolve as None. zZ{"log_level": {"name": "other", "__class_uuid__": "02E59486-F24D-46AD-8224-3ACDF2A5732A"}}Nr_)rrrN)rrQrrrtest_saveLoadUnknownLevelsz'SaveLoadTests.test_saveLoadUnknownLevelN)rDrErF__doc__r r#r)r-r.r>rKrRr^rbrcrrrrr3s     rc@s8eZdZdZddZddZddZdd Zd d Zd S) FileLogObserverTestsz+ Tests for L{jsonFileLogObserver}. c CsZtJ}t|}ztt|Wn,tk rJ}z||W5d}~XYnXW5QRXdS)zh A L{FileLogObserver} returned by L{jsonFileLogObserver} is an L{ILogObserver}. N)rrrr rZfail)r fileHandlerTerrrtest_interfaces z#FileLogObserverTests.test_interfacec KsV|dd}t:}t|f|}tdd}||||d|W5QRXdS)a Asserts that an observer created by L{jsonFileLogObserver} with the given arguments writes events serialized as JSON text, using the given record separator. @param recordSeparator: A record separator. @type recordSeparator: L{unicode} @param kwargs: Keyword arguments to pass to L{jsonFileLogObserver}. @type kwargs: L{dict} recordSeparatorr%r5z{0}{{"x": 1}} N)getrrrNrgetvalueformat)rkwargsrirfrTrrrrassertObserverWritesJSONs   z-FileLogObserverTests.assertObserverWritesJSONcCs |dS)z A L{FileLogObserver} created by L{jsonFileLogObserver} writes events serialzed as JSON text to a file when it observes events. By default, the record separator is C{u"\x1e"}. Nror"rrr(test_observeWritesDefaultRecordSeparator sz=FileLogObserverTests.test_observeWritesDefaultRecordSeparatorcCs|jdddS)z A L{FileLogObserver} created by L{jsonFileLogObserver} writes events serialzed as JSON text to a file when it observes events. This test sets the record separator to C{u""}. riNrpr"rrr&test_observeWritesEmptyRecordSeparatorsz;FileLogObserverTests.test_observeWritesEmptyRecordSeparatorcst}t}g}||j|t|t|d}z ddWn|dYnXt|}tt |}fdd}||||dS)z A L{FileLogObserver} created by L{jsonFileLogObserver} writes failures serialized as JSON text to a file when it observes events. rSr%rzfailed as expectedcs`t|d|\}d||d}|t|}|jjj dt ddS)Nr%rUco) rr[ZassertInrrZgetTracebackObjecttb_framef_code co_filenamerstrip__file__)Z logEventsZ failureEventZ failureObjectZtracebackObjectr"rr checkEvents,s  z@FileLogObserverTests.test_failureFormatting..checkEventsN) rr addObserverrVrrrXrllistr)rioZ publisherZloggedZloggerreaderZ deserializedr{rr"rtest_failureFormattings      z+FileLogObserverTests.test_failureFormattingN) rDrErFrdrhrorqrtrrrrrres    rec@seZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZddZddZd S)!LogFileReaderTestsz- Tests for L{eventsFromJSONLogFile}. cs&g_fdd}|_t|dS)Ncs&|dtjkr"d|kr"j|dS)NZ log_namespacerecord)jsonLog namespace errorEventsrV)rr"rrrTDs  z*LogFileReaderTests.setUp..observer)r logObserverrr|)rrTrr"rsetUpAs zLogFileReaderTests.setUpcCst|jdSr?)rZremoveObserverrr"rrrtearDownPszLogFileReaderTests.tearDowncKsFt|f|}|t|ddi|t|ddi|tt|dS)a Test that L{eventsFromJSONLogFile} reads two pre-defined events from a file: C{{u"x": 1}} and C{{u"y": 2}}. @param fileHandle: The file to read from. @param kwargs: Keyword arguments to pass to L{eventsFromJSONLogFile}. r6r%yr N)rrnextrO StopIteration)rrfrnr\rrr _readEventsTs zLogFileReaderTests._readEventsc Cs4td"}|||t|jdW5QRXdS)z L{eventsFromJSONLogFile} reads events from a file and automatically detects use of C{u"\x1e"} as the record separator. {"x": 1} {"y": 2} rNrrrr[rrrfrrr&test_readEventsAutoWithRecordSeparatords  z9LogFileReaderTests.test_readEventsAutoWithRecordSeparatorc Cs4td"}|||t|jdW5QRXdS)z L{eventsFromJSONLogFile} reads events from a file and automatically detects use of C{u""} as the record separator. z{"x": 1} {"y": 2} rNrrrrr'test_readEventsAutoEmptyRecordSeparatorqs  z:LogFileReaderTests.test_readEventsAutoEmptyRecordSeparatorc Cs8td&}|j|dd|t|jdW5QRXdS)z{ L{eventsFromJSONLogFile} reads events from a file and is told to use a specific record separator. z{"x": 1} {"y": 2} rsrNrrrrr&test_readEventsExplicitRecordSeparator~s z9LogFileReaderTests.test_readEventsExplicitRecordSeparatorc Cs8td&}|j|dd|t|jdW5QRXdS)zM L{eventsFromJSONLogFile} handles buffering a partial event. rr%Z bufferSizerNrrrrrtest_readEventsPartialBuffers z/LogFileReaderTests.test_readEventsPartialBufferc Cstdn}t|}|t|ddi|tt||t|jd||jddd||jddd W5QRXd S) zF If the JSON text for a record is truncated, skip it. z{"x": 1{"y": 2} rr r%rrJz0Unable to read truncated JSON record: {record!r}rs{"x": 1NrrrrrOrr[rrrfr\rrrtest_readTruncateds z%LogFileReaderTests.test_readTruncatedc CsTtdB}t|}|t|ddi|tt||t|jdW5QRXdS)zg If the file being read from vends L{unicode}, strings decode from JSON as-is. u{"currency": "€"} currency€rNrrrrrtest_readUnicodes  z#LogFileReaderTests.test_readUnicodec CsTtdB}t|}|t|ddi|tt||t|jdW5QRXdS)zh If the file being read from vends L{bytes}, strings decode from JSON as UTF-8. s{"currency": "€"} rrrNrrrrrOrr[rrrrrtest_readUTF8Bytess  z%LogFileReaderTests.test_readUTF8Bytesc CsXtdF}t|dd}|t|ddi|tt||t|jdW5QRXdS)z If the JSON text for a record is truncated in the middle of a two-byte Unicode codepoint, we don't want to see a codec exception and the stream is read properly when the additional data arrives. s{"x": "€"} rr6rrNrrrrrtest_readTruncatedUTF8Bytess   z.LogFileReaderTests.test_readTruncatedUTF8Bytesc Cstdn}t|}|t|ddi|tt||t|jd||jddd||jddd W5QRXd S) zh If the JSON text for a record contains invalid UTF-8 text, ignore that record. s{"x": ""} {"y": 2} rr r%rrJz2Unable to decode UTF-8 for JSON record: {record!r}rs {"x": ""} Nrrrrrtest_readInvalidUTF8Bytess   z,LogFileReaderTests.test_readInvalidUTF8Bytesc Cstdn}t|}|t|ddi|tt||t|jd||jddd||jddd W5QRXd S) zD If the JSON text for a record is invalid, skip it. z{"x": } {"y": 2} rr r%rrJ&Unable to read JSON record: {record!r}rs{"x": } Nrrrrrtest_readInvalidJSONs z'LogFileReaderTests.test_readInvalidJSONc CsltdZ}t|}|tt||t|jd||jddd||jdddW5QRXdS) zI Multiple events without a record separator are skipped. z{"x": 1} {"y": 2} r%rrJrrs{"x": 1} {"y": 2} N)rrrOrrrr[rrrrrtest_readUnseparated s  z'LogFileReaderTests.test_readUnseparatedc Csftdd}tL}t|}|||dt|}|t||f|t|jdW5QRXdS)z Data written by a L{FileLogObserver} returned by L{jsonFileLogObserver} and read by L{eventsFromJSONLogFile} is reconstructed properly. r%r5rN) rNrrseekrrtupler[r)rrrfrTr\rrrtest_roundTrip%s  z!LogFileReaderTests.test_roundTripN)rDrErFrdrrrrrrrrrrrrrrrrrrrr<s    rN)%rdr~rrZzope.interface.verifyrrZtwisted.python.compatrZtwisted.trial.unittestrZtwisted.python.failurerZ _observerr r Z_formatr Z_levelsr Z_flattenrZ_globalrZ_jsonrrrrrrZ_loggerrrrrerrrrrs"        -]