U  W[SG@sdZddlZddlZddlmZddlmZddlmZddl m Z ddl m Z ddl mZdd lmZmZmZdd lmZdd lmZmZmZdd lmZmZmZmZmZmZdd lm Z m!Z!m"Z"m#Z#ddl$m%Z%Gddde%eZ&ddj'j(Z)Gddde Z*dS)zf Tests for the flattening portion of L{twisted.web.template}, implemented in L{twisted.web._flatten}. N)XML) OrderedDict) implementer) _PY35PLUS)TestCase)XMLAssertionMixin)passthrusucceed gatherResults) IRenderable) UnfilledSlotUnsupportedTypeFlattenerError)tagsTagCommentCDATACharRefslot)Elementrenderer TagLoader flattenString)FlattenTestCasec@s eZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zesd2e_d3d4Zesd2e_d5d6Zd7d8Z d9d:Z!d;d<Z"d=S)>SerializationTestsz. Tests for flattening various things. cCs|tjtddddS)z: Test that nested tags flatten correctly. Z42Zthere)his'42)assertFlattensTorZhtmlZbodyselfr?/usr/lib/python3/dist-packages/twisted/web/test/test_flatten.pytest_nestedTags'sz"SerializationTests.test_nestedTagscCst|dd|ddgS)zL Test that strings will be flattened and escaped correctly. Zonesonez 123s<abc&&>123)r rrrrr test_serializeString0s  z'SerializationTests.test_serializeStringcCs|tdS)zP The serialized form of a self-closing tag is C{''}. s)rrimgrrrr test_serializeSelfClosingTags:sz0SerializationTests.test_serializeSelfClosingTagscCs|tjddddS)zV The serialized form of attribute I{a} with value I{b} is C{'a="b"'}. foosrcsNassertFlattensImmediatelyrr#rrrr test_serializeAttributeAsz*SerializationTests.test_serializeAttributecCs&t}tddg|_||ddS)zg Multiple attributes are separated by a single space in their serialized form. )r'r%)nameZbarsN)rr#r attributesr)rtagrrr !test_serializedMultipleAttributesIsz4SerializationTests.test_serializedMultipleAttributescCs ||tj|ddddS)au 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 wrapData: callable taking L{bytes} and returning something flattenable @param wrapTag: A 1-argument callable that wraps around the outer tag so other tests can customize it. @type wrapTag: callable taking L{Tag} and returning L{Tag}. <>&"r&s!Nr()rZwrapDatawrapTagrrr checkAttributeSanitizationSsz-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)r2rrrrr (test_serializedAttributeWithSanitizationgsz;SerializationTests.test_serializedAttributeWithSanitizationcCs|ttdS)z Like L{test_serializedAttributeWithSanitization}, but when the contents of the attribute are in a L{Deferred }. N)r2r rrrrr 0test_serializedDeferredAttributeWithSanitizationpszCSerializationTests.test_serializedDeferredAttributeWithSanitizationcs$g|fddfdddS)zS Like L{test_serializedAttributeWithSanitization} but with a slot. cs|ptdS)Nstuff)appendrvaluetossrr zUSerializationTests.test_serializedAttributeWithSlotWithSanitization..cs|jdS)N)r5) fillSlotspopr.r9rr r;r<N)r2rrr9r 0test_serializedAttributeWithSlotWithSanitizationys   zCSerializationTests.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)r2r transparentrrrrr *test_serializedAttributeWithTransparentTagsz=SerializationTests.test_serializedAttributeWithTransparentTagcs:Gfdddtg|fddfdddS)z Like L{test_serializedAttributeWithTransparentTag}, but when the attribute is rendered by a renderer on an element. cs*eZdZfddZeddZZS)z_SerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..WithRenderercs||_t||dSN)r8super__init__)rr8loader) WithRenderer __class__rr rEszhSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..WithRenderer.__init__cSs|jSrCr7)rrequestr.rrr r5szeSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..WithRenderer.stuff)__name__ __module__ __qualname__rErr5 __classcell__r)rG)rHr rGsrGcs|ptjddS)Nr5render)r6rrAr7r9rr r;s z[SerializationTests.test_serializedAttributeWithTransparentTagWithRenderer..cst|SrC)r>rr?rGr:rr r;r<N)rr2rrrPr 6test_serializedAttributeWithTransparentTagWithRenderers   zISerializationTests.test_serializedAttributeWithTransparentTagWithRenderercCs(ttGdddt}||tdS)z Like L{test_serializedAttributeWithTransparentTag}, but when the attribute is a provider of L{IRenderable} rather than a transparent tag. c@seZdZddZddZdS)zLSerializationTests.test_serializedAttributeWithRenderable..ArbitrarycSs ||_dSrCr7)rr8rrr rEszUSerializationTests.test_serializedAttributeWithRenderable..Arbitrary.__init__cSs|jSrCr7)rrIrrr rOszSSerializationTests.test_serializedAttributeWithRenderable..Arbitrary.renderN)rJrKrLrErOrrrr ArbitrarysrRN)rr objectr2r)rrRrrr &test_serializedAttributeWithRenderablesz9SerializationTests.test_serializedAttributeWithRenderablecCsLtd}tj||d}||d}||d}|t|jd|dS)ah 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. @param wrapTag: callable taking L{Tag} and returning something flattenable r0r&s@s<>&"r'N)rar#r)assertXMLEqualrattrib)rr1ZinnerTagZouterTagZouterinnerrrr checkTagAttributeSerializations z1SerializationTests.checkTagAttributeSerializationcCs|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)rYrrrrr test_serializedAttributeWithTagsz2SerializationTests.test_serializedAttributeWithTagcCs|tdS)z Like L{test_serializedAttributeWithTag}, but when the L{Tag} is in a L{Deferred }. N)rYr rrrr '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. r0)Zhrefr&sVr's"N)r)rr#rUrVrrW)rZ flattenedrrr ,test_serializedAttributeWithTagWithAttributesz?SerializationTests.test_serializedAttributeWithTagWithAttributecCs|tddfS)zI Test that comments are correctly flattened and escaped. foo bars)rrrrrr test_serializeCommentsz(SerializationTests.test_serializeCommentcsDfdd}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} cs|dd|f|dd|ft|dkd|f|dd}d |d ||r|d d dS) Nsz'%r does not end with the comment suffixz%%r is too short to be a legal comments-->-)Z assertTrue startswithendswithlenZ assertNotInZassertNotEqual)cZcontentrrr verifyComments"    z>SerializationTests.test_commentEscaping..verifyComment)z foo---barz foo---bar-zfoo>barz foo-->barz----------------N)rrZ addCallbackr6r )rriZresultsrhdrrr test_commentEscapings   z'SerializationTests.test_commentEscapingcCs$t|tdd|tddgS)zE Test that CDATA is correctly flattened and escaped. r]sz foo ]]> bars# bar]]>)r rrrrrr test_serializeCDATA!sz&SerializationTests.test_serializeCDATAc Csfd}t||d|t|d|t|d|t|d|t|t|td|didtgS) z Test that unicode is encoded correctly in the appropriate places, and raises an error when it occurs in inappropriate place. ☃s☃s

☃

s sprj)r,) r rrrorrassertFlatteningRaisesrUnicodeEncodeError)rZsnowmanrrr test_serializeUnicode-s z(SerializationTests.test_serializeUnicodecCsttd}||dS)ze A character reference is flattened to a string using the I{&#NNNN;} syntax. rns☃)rordr)rrefrrr test_serializeCharRef?s z(SerializationTests.test_serializeCharRefcCs|tddS)zz Test that a deferred is substituted with the current value in the callback chain when flattened. Ztwostwo)rr rrrr test_serializeDeferredHsz)SerializationTests.test_serializeDeferredcCs$td}t||d||dgS)zE Test that the same deferred can be flattened twice. Zthreesthree)r r r)rrkrrr test_serializeSameDeferredTwicePs   z2SerializationTests.test_serializeSameDeferredTwicecCs6ddlm}i}t|d||d}||ddS)zt Test that a coroutine returning a value is substituted with the that value when flattened. rdedentzE async def coro(x): return x corofourfour)textwrapryexecrrry namespacerzrrr test_serializeCoroutine[s z*SerializationTests.test_serializeCoroutinez*coroutines not available before Python 3.5cCs<ddlm}ttd}t|d||d}||ddS)z Test that a coroutine returning an awaited deferred value is substituted with that value when flattened. rrx)r zT async def coro(x): return await succeed(x) rzr{r|)r}rydictr r~rrrrr test_serializeCoroutineWithAwaitrs  z3SerializationTests.test_serializeCoroutineWithAwaitcs0ttGfdddt}t|dgS)zQ Test that flattening respects all of the IRenderable interface. cs eZdZddZfddZdS)zASerializationTests.test_serializeIRenderable..FakeElementcSs tdtjdddtjddS)Nzhello, testrNz - )rrorA)ignZoredrrr rOs   zHSerializationTests.test_serializeIRenderable..FakeElement.rendercs|dddS)NrcSs|dS)NZworldr)rZnoderrr r;r<zfSerializationTests.test_serializeIRenderable..FakeElement.lookupRenderMethod..) assertEqual)rr+rrr lookupRenderMethods zTSerializationTests.test_serializeIRenderable..FakeElement.lookupRenderMethodN)rJrKrLrOrrrrr FakeElementsrs

hello, world - world

)rr rSr r)rrrrr test_serializeIRenderables   z,SerializationTests.test_serializeIRenderablecCs>ttd}|}|jddt||t||dgS)zS Test that flattening a slot will use the slot value from the tag. rz hello, worldrs

hello, world

) rrorZcloner=r rpr r)rt1t2rrr test_serializeSlotss   z&SerializationTests.test_serializeSlotscCs0ttd}|jttdd||dS)z| Test that a slot with a deferred as its value will be flattened using the value from the deferred. rzfour>rs

four>

)rrorr=r Zemr)rtrrr test_serializeDeferredSlotssz.SerializationTests.test_serializeDeferredSlotscCs |dtS)zT Test that flattening an unknown type of thing raises an exception. N)rpr rrrr test_unknownTypeRaisessz)SerializationTests.test_unknownTypeRaisesN)#rJrKrL__doc__r!r"r$r*r/r2r3r4r@rBrQrTrYrZr[r\r^rlrmrrrurvrwrrskiprrrrrrrrr r#sH        /     rcCsdSrCrrrrr r;r<r;c@s0eZdZdZddZddZddZdd Zd S) FlattenerErrorTestsz& Tests for L{FlattenerError}. cCs<ttGdddt}|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@seZdZddZdS)z7FlattenerErrorTests.test_renderable..RenderablecSsdS)Nzrenderable reprrrrrr __repr__sz@FlattenerErrorTests.test_renderable..Renderable.__repr__N)rJrKrLrrrrr RenderablesrreasonzCException while flattening: renderable repr RuntimeError: reason N)rr rSrstrr RuntimeError)rrrrr test_renderablesz#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. Zdivz/foo/filename.xhtml )filenameZ lineNumberZ columnNumberrzlException while flattening: File "/foo/filename.xhtml", line 17, column 12, in "div" RuntimeError: reason N)rrrrrr-rrr test_tagszFlattenerErrorTests.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)rrrrrrrrr test_tagWithoutLocationsz+FlattenerErrorTests.test_tagWithoutLocationc sfdd}ddz |Wn@tk r^}z"ttddd}|}W5d}~XYn X|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. cs dSrCrrgrr fsz-FlattenerErrorTests.test_traceback..fcSs tddS)Nr)rrrrr rsz-FlattenerErrorTests.test_traceback..gNzf() must raise RuntimeErrorzException while flattening: File "%s", line %d, in f g() File "%s", line %d, in g raise RuntimeError("reason") RuntimeError: reason ) r traceback extract_tbsysexc_infoZfailrrrHERE__code__co_firstlineno)rreZtbinfoexcrrr test_tracebacks$     z"FlattenerErrorTests.test_tracebackN)rJrKrLrrrrrrrrr rs  r)+rrrZxml.etree.cElementTreer collectionsrZzope.interfacerZtwisted.python.compatrZtwisted.trial.unittestrZtwisted.test.testutilsrZtwisted.internet.deferrr r Ztwisted.web.iwebr Ztwisted.web.errorr r rZtwisted.web.templaterrrrrrrrrrZtwisted.web.test._utilrrr co_filenamerrrrrr s(         #