o brV@sRdZddlZddlZddlZddlmZddlmZddlm Z ddl m Z m Z m Z mZmZmZddlmZddlmZdd lmZmZmZmZmZdd lmZdd lmZdd lm Z dd l!m"Z"m#Z#m$Z$ddl%m&Z&m'Z'm(Z(ddl)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4ddl5m6Z6Gddde6eZ7ddj8j9Z:Gddde Z;dS)zf Tests for the flattening portion of L{twisted.web.template}, implemented in L{twisted.web._flatten}. N) OrderedDictdedent) FunctionType)CallableDictListNoReturnOptionalcast)XML) implementer)CancelledErrorDeferred gatherResultspassthrusucceed)Failure)XMLAssertionMixin)SynchronousTestCase)FlattenerError UnfilledSlotUnsupportedType) IRenderableIRequestITemplateLoader) CDATACharRefCommentElement FlattenableTag TagLoader flattenStringrendererslottags)FlattenTestCasec@szeZdZdZdBddZdBddZdBdd ZdBd d ZdBd d Zde e ge fde e ge fddfddZ dBddZdBddZdBddZdBddZdBddZdBddZde e ge fddfddZdBd d!ZdBd"d#ZdBd$d%ZdBd&d'Zdeeefd(d)ZdBd*d+ZdBd,d-ZdBd.d/ZdBd0d1Z dBd2d3Z!dBd4d5Z"dBd6d7Z#dBd8d9Z$dBd:d;Z%dBdd?Z'dBd@dAZ(dS)CSerializationTestsz. Tests for flattening various things. returnNcCs |tjtdddddS)z: Test that nested tags flatten correctly. 42there)his'42N)assertFlattensImmediatelyr&htmlbodyselfr2?/usr/lib/python3/dist-packages/twisted/web/test/test_flatten.pytest_nestedTags5sz"SerializationTests.test_nestedTagscCs |ddf|ddfdS)zL Test that strings will be flattened and escaped correctly. onesonez 123s<abc&&>123N)r-r0r2r2r3test_serializeString>sz'SerializationTests.test_serializeStringcCs|tddS)zP The serialized form of a self-closing tag is C{''}. sNr-r&imgr0r2r2r3test_serializeSelfClosingTagsEz0SerializationTests.test_serializeSelfClosingTagscCs|tjddddS)zV The serialized form of attribute I{a} with value I{b} is C{'a="b"'}. foosrcsNr7r0r2r2r3test_serializeAttributeKsz*SerializationTests.test_serializeAttributecCs&t}tddg|_||ddS)zg Multiple attributes are separated by a single space in their serialized form. )r=r;)namebarsN)r&r8r attributesr-r1tagr2r2r3!test_serializedMultipleAttributesQsz4SerializationTests.test_serializedMultipleAttributeswrapDatawrapTagcCs ||tj|ddddS)a Common implementation of L{test_serializedAttributeWithSanitization} and L{test_serializedDeferredAttributeWithSanitization}, L{test_serializedAttributeWithTransparentTag}. @param wrapData: A 1-argument callable that wraps around the attribute's value so other tests can customize it. @param wrapTag: A 1-argument callable that wraps around the outer tag so other tests can customize it. <>&"r<s!Nr7)r1rErFr2r2r3checkAttributeSanitizationZsz-SerializationTests.checkAttributeSanitizationcCs|ttdS)z Attribute values containing C{"<"}, C{">"}, C{"&"}, or C{'"'} have C{"<"}, C{">"}, C{"&"}, or C{"""} substituted for those bytes in the serialized output. N)rHrr0r2r2r3(test_serializedAttributeWithSanitizationoz;SerializationTests.test_serializedAttributeWithSanitizationcCs|ttdS)z Like L{test_serializedAttributeWithSanitization}, but when the contents of the attribute are in a L{Deferred }. N)rHrrr0r2r2r30test_serializedDeferredAttributeWithSanitizationwrJzCSerializationTests.test_serializedDeferredAttributeWithSanitizationcs@gdtdtffdd }dtdtffdd }|||dS) zS Like L{test_serializedAttributeWithSanitization} but with a slot. valuer)cs|tdS)Nstuff)appendr%rLtossr2r3 insertSlots zWSerializationTests.test_serializedAttributeWithSlotWithSanitization..insertSlotrCcs|jdS)N)rM) fillSlotspoprCrPr2r3fillSlotszUSerializationTests.test_serializedAttributeWithSlotWithSanitization..fillSlotN)strr r!rH)r1rRrVr2rPr30test_serializedAttributeWithSlotWithSanitizationszCSerializationTests.test_serializedAttributeWithSlotWithSanitizationcCs|tjtdS)z Attribute values which are supplied via the value of a C{t:transparent} tag have the same substitution rules to them as values supplied directly. N)rHr& transparentrr0r2r2r3*test_serializedAttributeWithTransparentTagsz=SerializationTests.test_serializedAttributeWithTransparentTagcsRGdddtgdtdtffdd }dtdtffdd }|||d S) z Like L{test_serializedAttributeWithTransparentTag}, but when the attribute is rendered by a renderer on an element. csHeZdZdedeeffdd Zedeede de fdd Z Z S) z_SerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..WithRendererrLloadercs||_t|dSN)rLsuper__init__)r1rLr[ __class__r2r3r^szhSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..WithRenderer.__init__requestrCr)cS|jSr\rO)r1rarCr2r2r3rMszeSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..WithRenderer.stuff) __name__ __module__ __qualname__rWr rr^r$rr!r rM __classcell__r2r2r_r3 WithRenderers$rgrLr)cs|tjddS)NrMrender)rNr&rYrOrPr2r3insertRenderers  zaSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..insertRendererrCcst|Sr\)rTr"rUrgrQr2r3riszYSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..renderN)rrWr r!rH)r1rjrir2rkr36test_serializedAttributeWithTransparentTagWithRenderers  zISerializationTests.test_serializedAttributeWithTransparentTagWithRenderercCs&ttGddd}||tdS)z Like L{test_serializedAttributeWithTransparentTag}, but when the attribute is a provider of L{IRenderable} rather than a transparent tag. c@sReZdZdefddZdeedefddZdede eee geffd d Z d S) zLSerializationTests.test_serializedAttributeWithRenderable..ArbitraryrLcSs ||_dSr\rO)r1rLr2r2r3r^ zUSerializationTests.test_serializedAttributeWithRenderable..Arbitrary.__init__rar)cSrbr\rOr1rar2r2r3riszSSerializationTests.test_serializedAttributeWithRenderable..Arbitrary.renderr?cStd)NzUnexpected call)NotImplementedErrorr1r?r2r2r3lookupRenderMethodsz_SerializationTests.test_serializedAttributeWithRenderable..Arbitrary.lookupRenderMethodN) rcrdrer r^r rrirWrr!rrr2r2r2r3 ArbitrarysrsN)r rrHr)r1rsr2r2r3&test_serializedAttributeWithRenderables z9SerializationTests.test_serializedAttributeWithRenderablecCsLtd}tj||d}||d}||d}|t|jd|dS)ag Common implementation of L{test_serializedAttributeWithTag} and L{test_serializedAttributeWithDeferredTag}. @param wrapTag: A 1-argument callable that wraps around the attribute's value so other tests can customize it. @type wrapTag: callable taking L{Tag} and returning something flattenable rGr<s@s<>&"r=N)r&ar8r-assertXMLEqualr attrib)r1rFinnerTagouterTagouterinnerr2r2r3checkTagAttributeSerializations  z1SerializationTests.checkTagAttributeSerializationcC|tdS)z L{Tag} objects which are serialized within the context of an attribute are serialized such that the text content of the attribute may be parsed to retrieve the tag. N)r|rr0r2r2r3test_serializedAttributeWithTagsz2SerializationTests.test_serializedAttributeWithTagcCr})z Like L{test_serializedAttributeWithTag}, but when the L{Tag} is in a L{Deferred }. N)r|rr0r2r2r3'test_serializedAttributeWithDeferredTagsz:SerializationTests.test_serializedAttributeWithDeferredTagcCs6|tjtjdddd}|t|jdddS)z Similar to L{test_serializedAttributeWithTag}, but for the additional complexity where the tag which is the attribute value itself has an attribute value which contains bytes which require substitution. rG)hrefr<sVr=s"N)r-r&r8rurvr rw)r1 flattenedr2r2r3,test_serializedAttributeWithTagWithAttributesz?SerializationTests.test_serializedAttributeWithTagWithAttributecC|tdddS)zI Test that comments are correctly flattened and escaped. foo barsN)r-rr0r2r2r3test_serializeCommentr:z(SerializationTests.test_serializeCommentcsNdtddffdd }g}dD]}tdt|}||||qt|S)a The data in a L{Comment} is escaped and mangled in the flattened output so that the result is a legal SGML and XML comment. SGML comment syntax is complicated and hard to use. This rule is more restrictive, and more compatible: Comments start with and never contain -- or >. Also by XML syntax, a comment may not end with '-'. @see: U{http://www.w3.org/TR/REC-xml/#sec-comments} cr)Ncs|d|d|d|dt|dk|d|dd}d |d ||rC|d d dSdS) Nsz% does not end with the comment suffixz# is too short to be a legal comments-->-) assertTrue startswithendswithlen assertNotInassertNotEqual)rcontentr0r2r3 verifyComments   z>SerializationTests.test_commentEscaping..verifyComment)z foo---barz foo---bar-zfoo>barz foo-->barz----------------)bytesr#r addCallbackrNr)r1rresultsrdr2r0r3test_commentEscapings  z'SerializationTests.test_commentEscapingcCs&|tddf|tdddS)zE Test that CDATA is correctly flattened and escaped. rsz foo ]]> bars# bar]]>N)r-rr0r2r2r3test_serializeCDATA6sz&SerializationTests.test_serializeCDATAcCsnd}||d|t|d|t|d|t|d|t|t|td|didtd S) z Test that unicode is encoded correctly in the appropriate places, and raises an error when it occurs in inappropriate place. ☃s☃s

☃

s spr)rAN)r-r&rrrassertFlatteningRaisesr!UnicodeEncodeError)r1snowmanr2r2r3test_serializeUnicode?s z(SerializationTests.test_serializeUnicodecCsttd}||ddS)ze A character reference is flattened to a string using the I{&#NNNN;} syntax. rs☃N)rordr-)r1refr2r2r3test_serializeCharRefNs z(SerializationTests.test_serializeCharRefcCr)zz Test that a deferred is substituted with the current value in the callback chain when flattened. twostwoN)r-rr0r2r2r3test_serializeDeferredVsz)SerializationTests.test_serializeDeferredcCs$td}||d||ddS)zE Test that the same deferred can be flattened twice. threesthreeN)rr-)r1rr2r2r3test_serializeSameDeferredTwice]s z2SerializationTests.test_serializeSameDeferredTwicecCs:ddlm}i}t|d||d}||dddS)zt Test that a coroutine returning a value is substituted with the that value when flattened. rrzE async def coro(x): return x corofourfourN)textwraprexecr-r1r namespacerr2r2r3test_serializeCoroutinees  z*SerializationTests.test_serializeCoroutinecCs@ddlm}ttd}t|d||d}||dddS) z Test that a coroutine returning an awaited deferred value is substituted with that value when flattened. rr)rzT async def coro(x): return await succeed(x) rrrN)rrdictrrr-rr2r2r3 test_serializeCoroutineWithAwaitzs   z3SerializationTests.test_serializeCoroutineWithAwaitcs,ttGfddd}|ddS)zQ Test that flattening respects all of the IRenderable interface. csDeZdZdedefddZdedeee ege fffdd Z dS) zASerializationTests.test_serializeIRenderable..FakeElementoredr)cSs tdtjdddtjddS)Nzhello, testrhz - )r&rrY)ignrr2r2r3ris   zHSerializationTests.test_serializeIRenderable..FakeElement.renderr?cs|dddS)NrcSs|dS)Nworldr2)rnoder2r2r3szfSerializationTests.test_serializeIRenderable..FakeElement.lookupRenderMethod..) assertEqual)rr?r0r2r3rrs zTSerializationTests.test_serializeIRenderable..FakeElement.lookupRenderMethodN) rcrdreobjectr!rirWrr rr rrr2r0r2r3 FakeElementsrs

hello, world - world

N)r rr-)r1rr2r0r3test_serializeIRenderablesz,SerializationTests.test_serializeIRenderablecCs|tjddtdS)z Test that flattening a tag with a C{render} attribute when no render factory is available in the context raises an exception. rrhN)rr&rY ValueErrorr0r2r2r3"test_serializeMissingRenderFactorysz5SerializationTests.test_serializeMissingRenderFactorycCs>ttd}|}|jdd||t||ddS)zS Test that flattening a slot will use the slot value from the tag. rz hello, worldrs

hello, world

N)r&rr%clonerSrrr-)r1t1t2r2r2r3test_serializeSlotss   z&SerializationTests.test_serializeSlotscCs4ttd}|jttdd||ddS)z| Test that a slot with a deferred as its value will be flattened using the value from the deferred. rzfour>rs

four>

N)r&rr%rSremr-)r1tr2r2r3test_serializeDeferredSlotssz.SerializationTests.test_serializeDeferredSlotscCs|dtdS)zT Test that flattening an unknown type of thing raises an exception. N)rrr0r2r2r3test_unknownTypeRaisessz)SerializationTests.test_unknownTypeRaisesr)N))rcrdre__doc__r4r6r9r>rDrrWr r!rHrIrKrXrZrlrtr|r~rrrrrrrrrrrrrrrrrrrr2r2r2r3r(0sT                  /          r(cCdSr\r2r2r2r2r3rsrc@sLeZdZdZdddZdddZddd Zdd d Zdd d ZdddZ dS)FlattenerErrorTestsz& Tests for L{FlattenerError}. r)NcCs:ttGddd}|tttd|ggddS)z If a L{FlattenerError} is created with an L{IRenderable} provider root, the repr of that object is included in the string representation of the exception. c@seZdZdefddZdS)z7FlattenerErrorTests.test_renderable..Renderabler)cSdS)Nzrenderable reprr2r0r2r2r3__repr__z@FlattenerErrorTests.test_renderable..Renderable.__repr__N)rcrdrerWrr2r2r2r3 RenderablesrreasonzCException while flattening: renderable repr RuntimeError: reason N)r rrrWr RuntimeError)r1rr2r2r3test_renderables z#FlattenerErrorTests.test_renderablecCs2tddddd}|tttd|ggddS) z If a L{FlattenerError} is created with a L{Tag} instance with source location information, the source location is included in the string representation of the exception. divz/foo/filename.xhtml )filename lineNumber columnNumberrzlException while flattening: File "/foo/filename.xhtml", line 17, column 12, in "div" RuntimeError: reason N)r!rrWrrrBr2r2r3test_tags zFlattenerErrorTests.test_tagcCs&|tttdtdggddS)z If a L{FlattenerError} is created with a L{Tag} instance without source location information, only the tagName is included in the string representation of the exception. rspanz>Exception while flattening: Tag RuntimeError: reason N)rrWrrr!r0r2r2r3test_tagWithoutLocationsz+FlattenerErrorTests.test_tagWithoutLocationc sd fdd }dtfddz|Wn!ty4}zttddd}|}WYd}~n d}~ww|d |tt |g|d t |j j dt j j dfdS) z If a L{FlattenerError} is created with traceback frames, they are included in the string representation of the exception. r)Ncs dSr\r2r2gr2r3f rmz-FlattenerErrorTests.test_traceback..fcSro)Nr)rr2r2r2r3rsz-FlattenerErrorTests.test_traceback..gzf() must raise RuntimeErrorzException while flattening: File "%s", line %d, in f g() File "%s", line %d, in g raise RuntimeError("reason") RuntimeError: reason r) r r traceback extract_tbsysexc_infofailrrWrHERE__code__co_firstlineno)r1retbinfoexcr2rr3test_tracebacks(    z"FlattenerErrorTests.test_tracebackcstttGfddd}td|g}||td}|||t}| t |j t j tdt jd|tdS)z When flattening a renderer which raises an exception asynchronously, the error is reported when it occurs. csZeZdZdZdefddZdedeeee ge ffddZ deede ffd d Z d S) zPFlattenerErrorTests.test_asynchronousFlattenError..NotActuallyRenderablez#No methods provided; this will failr)cSr)Nzr2r0r2r2r3r6rzYFlattenerErrorTests.test_asynchronousFlattenError..NotActuallyRenderable.__repr__r?cSrr\r2rqr2r2r3rr9szcFlattenerErrorTests.test_asynchronousFlattenError..NotActuallyRenderable.lookupRenderMethodracsSr\r2rnfailingr2r3ri>rzWFlattenerErrorTests.test_asynchronousFlattenError..NotActuallyRenderable.renderN) rcrdrerrWrrr rr!r rrrir2rr2r3NotActuallyRenderable2s rNexamplea@ Exception while flattening: \[\] .* File ".*", line \d*, in _flattenTree element = await element RuntimeError: example )flags)rr rr#assertNoResultrerrbackfailureResultOfr assertRegexrWrLrecompiler MULTILINE)r1r flatteningrfailurer2rr3test_asynchronousFlattenError+s$    z1FlattenerErrorTests.test_asynchronousFlattenErrorcsdddttddffdd }ddtddffdd }t|}td|}|||||||t}| d | || t| t tj t|j jd}| |tdS) z@ The flattening of a Deferred can be cancelled. rN cancelledr)cs|d7dS)Nrr2)r) cancelArg cancelCountr2r3 checkCancelbs z4FlattenerErrorTests.test_cancel..checkCancelrcs|dSr\r2)r)errr2r3saveErrisz0FlattenerErrorTests.test_cancel..saveErrr)rrrr#r addErrbackcancelrrrassertIsassertIsInstancer rLrargs)r1rrrrrrr2)rrrr3 test_cancel[s"        zFlattenerErrorTests.test_cancelr) rcrdrerrrrrrrr2r2r2r3rs    &0r)s0         4  #