U Acjhw@sdZddlZddlmZmZddlmZddlmZm Z ddl m Z ddl m Z mZddlmZmZmZmZdd lmZdd lmZmZdd lmZdd lmZdd lmZmZmZm Z m!Z!ddl"m#Z#ddl$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*z edWne+k rdZ,YnXdZ,Gdddej-Z.Gddde/Z0Gddde1Z2Gddde%Z3Gddde%Z4Gddde%Z5Gdd d e3Z6Gd!d"d"e!j7Z8Gd#d$d$e!j&Z9Gd%d&d&e!j&Z:Gd'd(d(ej-Z;Gd)d*d*e;ZGd/d0d0e>ej-Z?Gd1d2d2e>ej-Z@Gd3d4d4e;ZAGd5d6d6e;ZBGd7d8d8ej-ZCGd9d:d:ej-ZDGd;d<d.AsyncResourcecsSNr#selfresultr#@/tmp/pip-unpacked-wheel-nrvc_22y/twisted/web/test/test_xmlrpc.py xmlrpc_async=sz:AsyncXMLRPCTests.setUp..AsyncResource.xmlrpc_asyncN)__name__ __module__ __qualname__r*r#r'r#r) AsyncResource<sr.) rrequestmethodrrrdumpscontentrZDeferredr(rresource)r&r.r#r'r)setUp3s zAsyncXMLRPCTests.setUpcCs^|j|j||jjg|jdtd |jj}||d||jj ddS)z If an L{XMLRPC} C{xmlrpc_*} method returns a L{defer.Deferred}, the response to the request is the result of that L{defer.Deferred}. r()r'NN) r3renderr/ assertEqualwrittenr(callbackrloadsjoinfinished)r&respr#r#r)test_deferredResponseBs   z&AsyncXMLRPCTests.test_deferredResponsecCsT|j|j|jttd|jd| |jj g| |jj ddS)a While waiting for the L{Deferred} returned by an L{XMLRPC} C{xmlrpc_*} method to fire, the connection the request was issued over may close. If this happens, neither C{write} nor C{finish} is called on the request. Z Simulatedr(rN) r3r7r/ZprocessingFailedrFailurerr(r:r8r9r=r%r#r#r) test_interruptedDeferredResponsePs  z1AsyncXMLRPCTests.test_interruptedDeferredResponseN)r+r,r-__doc__r4r?rAr#r#r#r)r.src@s eZdZdS)TestRuntimeErrorNr+r,r-r#r#r#r)rC^srCc@s eZdZdS)TestValueErrorNrDr#r#r#r)rEbsrEc@seZdZdZdZdZddZddZdddgd d d gge_d d Z d d dgge _ddZ ddZ ddZ ddZ ddZddZddZddZde_edd Zd!d"Zd#S)$Test*cCs|Sr$r#)r&argr#r#r) xmlrpc_echonszTest.xmlrpc_echocCs||S)z0 This function add two numbers. r#)r&abr#r#r) xmlrpc_addrszTest.xmlrpc_addintdoublecCs||gS)zC This function puts the two arguments in an array. r#)r&stringnumr#r#r) xmlrpc_pair~szTest.xmlrpc_pairarrayrQcCs t|S)Help for defer.)rZsucceedr&xr#r#r) xmlrpc_deferszTest.xmlrpc_defercCs ttSr$)rfailrEr%r#r#r)xmlrpc_deferFailszTest.xmlrpc_deferFailcCstdSr$)rCr%r#r#r) xmlrpc_failszTest.xmlrpc_failcCs tddS)N hellorFaultr%r#r#r) xmlrpc_faultszTest.xmlrpc_faultcCsttddS)Nhi)rrYrr_r%r#r#r)xmlrpc_deferFaultszTest.xmlrpc_deferFaultcCsd}||krtddS|S)z8 Used to test that we can pass Unicode. ☃ zPayload not unicode snowmanr^)r&payloadsnowmanr#r#r)xmlrpc_snowmans zTest.xmlrpc_snowmancCsdddggddS)NrMcr\foorLDr#r%r#r#r)xmlrpc_complexszTest.xmlrpc_complexcCs||Sr$r#)r&mapkeyr#r#r) xmlrpc_dictszTest.xmlrpc_dictHelp for dict.cCs|jd|S)z A method decorated with L{withRequest} which can be called by a test to verify that the request object really is passed as an argument.  )r0)r&r/otherr#r#r)xmlrpc_withRequests zTest.xmlrpc_withRequestcCsFzt||WStjk r@|dr:t|jdnYnXdS)NZSESSIONzSession non-existent/expired.)rlookupProcedurerNoSuchFunction startswithr_SESSION_EXPIRED)r&Z procedurePathr#r#r)rus zTest.lookupProcedureN)r+r,r-FAILURE NOT_FOUNDrxrKrN signaturerSrXrZr[r`rcrhrmrphelprrtrur#r#r#r)rFfs,  rFc@s eZdZdZddZddZdS)TestLookupProcedurez} This is a resource which customizes procedure lookup to be used by the tests of support for this customization. cCs|Sr$r#rVr#r#r)echoszTestLookupProcedure.echocCs(|dkr|jSt|jd|ddS)zs Lookup a procedure from a fixed set of choices, either I{echo} or I{system.listeMethods}. r~z procedure z not foundN)r~rrvrz)r&Z procedureNamer#r#r)rus  z#TestLookupProcedure.lookupProcedureN)r+r,r-rBr~rur#r#r#r)r}sr}c@seZdZdZddZdS)TestListProceduresz This is a resource which customizes procedure enumeration to be used by the tests of support for this customization. cCsdgS)zW Return a list of a single method this resource will claim to support. rjr#r%r#r#r)listProceduressz!TestListProcedures.listProceduresN)r+r,r-rBrr#r#r#r)rsrc@s(eZdZdZddZddZddZdS) TestAuthHeaderzU This is used to get the header info so that we can test authentication. cCst|d|_dSr$)rF__init__r/r%r#r#r)rs zTestAuthHeader.__init__cCs||_t||Sr$)r/rFr7)r&r/r#r#r)r7szTestAuthHeader.rendercCs|j|jfSr$)r/ZgetUserZ getPasswordr%r#r#r)xmlrpc_authinfoszTestAuthHeader.xmlrpc_authinfoN)r+r,r-rBrr7rr#r#r#r)rsrc@s(eZdZdZddZddZddZdS) TestQueryProtocolz_ QueryProtocol for tests that saves headers received and sent, inside the factory. cCs|j|j_tj|dSr$) transportfactoryr QueryProtocolconnectionMader%r#r#r)rs z TestQueryProtocol.connectionMadecCs||jj|<dSr$)rheaderslowerr&rovalr#r#r) handleHeaderszTestQueryProtocol.handleHeadercCs$||jj|<tj|||dS)zA Keep sent headers so we can inspect them later. N)r sent_headersrrr sendHeaderrr#r#r)rszTestQueryProtocol.sendHeaderN)r+r,r-rBrrrr#r#r#r)rsrc@seZdZdZeZddZdS)TestQueryFactoryzE QueryFactory using L{TestQueryProtocol} for saving headers. cOs$i|_i|_tjj|f||dSr$)rrrrr)r&argskwargsr#r#r)rszTestQueryFactory.__init__N)r+r,r-rBrprotocolrr#r#r#r)rsrc@seZdZdZddZdS)TestQueryFactoryCancelz{ QueryFactory that saves a reference to the L{twisted.internet.interfaces.IConnector} to test connection lost. cCs ||_dSr$) connector)r&rr#r#r)startedConnecting!sz(TestQueryFactoryCancel.startedConnectingN)r+r,r-rBrr#r#r#r)rsrc@seZdZddZddZddZd!dd Zd d Zd d ZddZ ddZ ddZ ddZ ddZ ddZddZddZeeddd ZdS)" XMLRPCTestscCs2tjdttdd|_|jj|_g|_dSNr 127.0.0.1Z interface) r listenTCPrSiterFpgetHostport factoriesr%r#r#r)r4&szXMLRPCTests.setUpcCsg|_|jSr$)rr stopListeningr%r#r#r)tearDown+szXMLRPCTests.tearDowncOst||}|j||S)zw Specific queryFactory for proxy that uses our custom L{TestQueryFactory}, and save factories. )rrappend)r&rrrr#r#r) queryFactory/s  zXMLRPCTests.queryFactoryNcCs0ttd|j}|dkr&|j|_n||_|S)z Return a new xmlrpc.Proxy for the test site created in setUp(), using the given factory as the queryFactory, or self.queryFactory if no factory is provided. http://127.0.0.1:%d/NrProxyrrrr&rrr#r#r)proxy8s  zXMLRPCTests.proxyc Csdddddidfdfddddgfdd d d d d ggddfg}g}|D]6\}}}|j|f|}||j|||qDtj|ddS)N)add))r)rLrLdictrLr6pair)rLr6)rgrdrdcomplexr#rMrir\rjrkTZfireOnOneErrbackr callRemote addCallbackr8rr DeferredList)r&Z inputOutputdlmethrZoutpdr#r#r) test_resultsEs   zXMLRPCTests.test_resultscs@dd}fdd}fdd}|||||S)z Verify that headers sent from the client side and the ones we get back from the server side are correct. rgrdcs4jdjddjdjdddS)Nr content-typetext/xml; charset=utf-8content-lengths129)r8rr)Zingr%r#r)check_server_headers^s z6XMLRPCTests.test_headers..check_server_headerscsLjdjddjdjddjdjdddS)Nrs user-agentsTwisted/XMLRPClibrrrs155)r8rr)ignr%r#r)check_client_headersdsz6XMLRPCTests.test_headers..check_client_headersrrr)r&rrrr#r%r) test_headersVs    zXMLRPCTests.test_headerscsttttjdgtfddg}dD]D\}} |} |t j }| |ffdd ||q>tj|dd}fdd }| ||S) z Verify that for each way a method exposed via XML-RPC can fail, the correct 'Content-type' header is set in the response and that the client-side Deferred is errbacked with an appropriate C{Fault} instance. ZdefaultLogLevelcs tSr$r ZremoveObserverr#filteredr#r)~r5z)XMLRPCTests.test_errors..))rGrY)rG deferFail)r\fault)rHZ noSuchMethod)ra deferFault)rIZ SESSION_TESTcs|j|Sr$)r8 faultCode)exccoder%r#r)rr5TrcsjD]}|jddqdtddj}ddj}t|trb|t n|t |t t tdS)Nrrrr log_failurer6) rr8r assertEqualslenvalue isinstancerEassertIsInstancerCflushLoggedErrors)rrf1f2 logObserverr&r#r)cbs    z#XMLRPCTests.test_errors..cb)rr r r criticalr addObserver addCleanuprr assertFailurerr_rrrr)r&rr methodNamerrr#rrr&r) test_errorsrs"     zXMLRPCTests.test_errorscs^fdd|ddd}|jjjd||jjjd||t j }|S)z A deferred from the Proxy can be cancelled, disconnecting the L{twisted.internet.interfaces.IConnector}. cst||_jSr$)rf)rkwrr#r)rs z(XMLRPCTests.test_cancel..factoryrrr disconnected) rrZassertNotEqualrrstatecancelr8rrZCancelledErrorr&rr#rr) test_cancels zXMLRPCTests.test_cancelcs<tt}|dtdjf}fdd}|||S)zN A classic GET on the xml server should return a NOT_ALLOWED. sGETrcs|jtjdSr$)r8rr NOT_ALLOWED)responser%r#r) checkResponsesz0XMLRPCTests.test_errorGet..checkResponse)rAgentrr/rrr)r&agentrrr#r%r) test_errorGets    zXMLRPCTests.test_errorGetcsVtt}|jtdjfdttdd}|tj fdd}|||S)zL Test that an invalid XML input returns an L{xmlrpc.Fault}. rsPOSTsfoo)urir0Z bodyProducercstjtj|dSr$) assertRaisesrr_rr;r'r%r#r)rsz,XMLRPCTests.test_errorXMLContent..cb) rrrr/rrZFileBodyProducerrrZreadBody)r&rrrr#r%r)test_errorXMLContents     z XMLRPCTests.test_errorXMLContentcCs*t}|d|}||j||S)z If an L{xmlrpclib.DateTime} is passed as an argument to an XML-RPC call and then returned by the server unmodified, the result should be equal to the original object. r~)rDateTimerrrr8)r&whenrr#r#r)test_datetimeRoundtripsz"XMLRPCTests.test_datetimeRoundtripcsttttjdgtfdd dd}dd} t d| |t }fd d }|||S) a. If it is not possible to encode a response to the request (for example, because L{xmlrpclib.dumps} raises an exception when encoding a L{Fault}) the exception which prevents the response from being generated is logged and the request object is finished anyway. rcs tSr$rr#rr#r)rr5z6XMLRPCTests.test_doubleEncodingError..r~r c_s tddS)NzCannot encode anything at all!) RuntimeError)rrr#r#r) fakeDumpssz7XMLRPCTests.test_doubleEncodingError..fakeDumpsr1cs@dtddjtttddS)Nr6rr)rrrrrr8r)ignoredrr#r)cbFailedsz6XMLRPCTests.test_doubleEncodingError..cbFailed)rr r r rr rrrrpatchrr Exceptionr)r&rrrr#rr)test_doubleEncodingErrors    z$XMLRPCTests.test_doubleEncodingErrorcs&dd}fdd}||S)zV The connection to the web server is closed when the request is done. r~r cs(j\}|jj|jjdSr$)rZ assertFalser connected assertTruer)rrr%r#r) responseDoneszBXMLRPCTests.test_closeConnectionAfterRequest..responseDoner)r&rrr#r%r) test_closeConnectionAfterRequests z,XMLRPCTests.test_closeConnectionAfterRequestcCs:t}tjdd|d}|d||jddddS)z For I{HTTP} URIs, L{xmlrpc.Proxy.callRemote} passes the value it received for the C{connectTimeout} parameter as the C{timeout} argument to the underlying connectTCP call. shttp://127.0.0.1:69g@ZconnectTimeoutr someMethodrrN)r rrrr8Z tcpClientsr&rrr#r#r)test_tcpTimeout s zXMLRPCTests.test_tcpTimeoutzOpenSSL not presentcCs:t}tjdd|d}|d||jddddS)z For I{HTTPS} URIs, L{xmlrpc.Proxy.callRemote} passes the value it received for the C{connectTimeout} parameter as the C{timeout} argument to the underlying connectSSL call. shttps://127.0.0.1:69g@rrrN)r rrrr8Z sslClientsrr#r#r)test_sslTimeouts zXMLRPCTests.test_sslTimeout)N)r+r,r-r4rrrrrrrrrrrrrrsslSkiprr#r#r#r)r%s  0  #  rc@seZdZdZdddZdS)XMLRPCProxyWithoutSlashTestsz3 Test with proxy that doesn't add a slash. NcCs0ttd|j}|dkr&|j|_n||_|S)Nhttp://127.0.0.1:%drrr#r#r)r.s  z"XMLRPCProxyWithoutSlashTests.proxy)N)r+r,r-rBrr#r#r#r)r)src@s0eZdZdZddZddZddZdd Zd S) XMLRPCPublicLookupProcedureTestszr Tests for L{XMLRPC}'s support of subclasses which override C{lookupProcedure} and C{listProcedures}. cCsNtjdt|dd|_||jj|jj|_t t d|j|_ dS)Nrrrr) rrrrrrrrrrrrr)r&r3r#r#r) createServer=sz-XMLRPCPublicLookupProcedureTests.createServercCs0|td}|jd|}||j||S)z A subclass of L{XMLRPC} can override C{lookupProcedure} to find procedures that are not defined using a C{xmlrpc_}-prefixed method name. r]r~)r r}rrrr8)r&whatrr#r#r)test_lookupProcedureCs  z5XMLRPCPublicLookupProcedureTests.test_lookupProcedurecCs,|t|jdd}||tj}|S)z A subclass of L{XMLRPC} can override C{lookupProcedure} to raise L{NoSuchFunction} to indicate that a requested method is not available to be called, signalling a fault to the XML-RPC client. Zxxxxr])r r}rrrrr_rr#r#r)rNs z,XMLRPCPublicLookupProcedureTests.test_errorscs>t}t||jd}fdd}|||S)z A subclass of L{XMLRPC} can override C{listProcedures} to define Overriding listProcedures should prevent introspection from being broken. system.listMethodscsd|dS)Nrj)ZassertIn)Z proceduresr%r#r)listeddszAXMLRPCPublicLookupProcedureTests.test_listMethods..listed)rrr rrr)r&r3rr r#r%r)test_listMethodsYs    z1XMLRPCPublicLookupProcedureTests.test_listMethodsN)r+r,r-rBr r rrr#r#r#r)r7s   rc@s(eZdZdZddZddZddZdS) SerializationConfigMixinas Mixin which defines a couple tests which should pass when a particular flag is passed to L{XMLRPC}. These are not meant to be exhaustive serialization tests, since L{xmlrpclib} does all of the actual serialization work. They are just meant to exercise a few codepaths to make sure we are calling into xmlrpclib correctly. @ivar flagName: A C{str} giving the name of the flag which must be passed to L{XMLRPC} to allow the tests to pass. Subclasses should set this. @ivar value: A value which the specified flag will allow the serialization of. Subclasses should set this. cCsd|jdi}tjdttf|dd|_||jj|j j |_ t j t d|j ff||_dS)zO Create a new XML-RPC server with C{allowNone} set to C{True}. TrrrrN)flagNamerrrrrFrrrrrrrrr)r&rr#r#r)r4~s zSerializationConfigMixin.setUpcCs$|jd|j}||j|j|S)zY C{self.value} can be round-tripped over an XMLRPC method call/response. rrrrrr8rr#r#r)test_roundtripValuesz,SerializationConfigMixin.test_roundtripValuecCs,|jdd|ji}||jd|ji|S)zz A C{dict} which contains C{self.value} can be round-tripped over an XMLRPC method call/response. rrLrrr#r#r)test_roundtripNestedValuesz2SerializationConfigMixin.test_roundtripNestedValueN)r+r,r-rBr4rrr#r#r#r)rnsrc@seZdZdZdZdZdS)XMLRPCAllowNoneTestszF Tests for passing L{None} when the C{allowNone} flag is set. allowNoneN)r+r,r-rBrrr#r#r#r)rsrc@s(eZdZdZdZeddddddZd S) XMLRPCUseDateTimeTestszd Tests for passing a C{datetime.datetime} instance when the C{useDateTime} flag is set. Z useDateTimeir\r-;N)r+r,r-rBrdatetimerr#r#r#r)rsrc@s@eZdZdZdZdZddZddZdd Zd d Z d d Z dS)XMLRPCAuthenticatedTestsz] Test with authenticated proxy. We run this with the same input/output as above. susernamesasecretcCs2tjdttdd|_|jj|_g|_dSr) rrrrrrrrrr%r#r#r)r4s zXMLRPCAuthenticatedTests.setUpcCsNdt|jt|j|jf}tt|}|d}||j |j|jg|S)Nzhttp://%s:%s@127.0.0.1:%d/authinfo) ruserpasswordrrrrrrr8)r&urlrrr#r#r)test_authInfoInURLs z+XMLRPCAuthenticatedTests.test_authInfoInURLcCsBttd|jf|j|j}|d}||j|j|jg|S)Nrr rrrrrrrrr8r&rrr#r#r)test_explicitAuthInfos z.XMLRPCAuthenticatedTests.test_explicitAuthInfocCsH|jd}ttd|jf|j|}|d}||j|j|g|S)z C{QueryProtocol} uses the C{base64.b64encode} function to encode user name and password in the I{Authorization} header, so that it doesn't embed new lines when using long inputs. (rr) rrrrrrrrr8)r&Z longPasswordrrr#r#r)test_longPasswords  z*XMLRPCAuthenticatedTests.test_longPasswordcCsBttd|jf|j|j}|d}||j|j|jg|S)Nzhttp://wrong:info@127.0.0.1:%d/rr!r"r#r#r)test_explicitAuthInfoOverrides z6XMLRPCAuthenticatedTests.test_explicitAuthInfoOverrideN) r+r,r-rBrrr4r r#r%r&r#r#r#r)rs  rc@s,eZdZddZddZddZddZd S) XMLRPCIntrospectionTestscCs>t}t|tjdt|dd|_|jj|_g|_ dSr) rFrrrrrrrrr)r&rr#r#r)r4s zXMLRPCIntrospectionTests.setUpcs(fdd}d}|||S)Ncs6||ddddddddd d d d d ddgdS)Nrrrrrrr~rYrrrgr system.methodHelpsystem.methodSignaturer)sortr8)Zmethsr%r#r) cbMethodss(z.cbMethodsr r)r&r+rr#r%r)rs  z)XMLRPCIntrospectionTests.test_listMethodscCsRdddg}g}|D]0\}}|d|}||j|||qtj|ddS)N)rrU)rYr )rrqr(Trrr&Z inputOutputsrrexpectedrr#r#r)test_methodHelps  z(XMLRPCIntrospectionTests.test_methodHelpcCsrdddddgdddggfddddggfg}g}|D]0\}}|d|}||j|||q2tj|d d S) N)rr rrOrPrrTrQr)Trrr,r#r#r)test_methodSignature#s  z-XMLRPCIntrospectionTests.test_methodSignatureN)r+r,r-r4rr.r/r#r#r#r)r'sr'c@s(eZdZdZddZddZddZdS) XMLRPCClientErrorHandlingTestsz3 Test error handling on the xmlrpc client. cCs4tdd|_d|j_tjdt|jdd|_dS)Ns*This text is not a valid XML-RPC response.s text/plainTrrr) rDatar3ZisLeafrrrrrr%r#r#r)r47s z$XMLRPCClientErrorHandlingTests.setUpcCs |jSr$)rrr%r#r#r)rAsz'XMLRPCClientErrorHandlingTests.tearDowncCs.ttd|jjf}||dtS)zj Test that calling the xmlrpc client on a static http server raises an exception. rr)rrrrrrr ValueError)r&rr#r#r)test_erroneousResponseDsz5XMLRPCClientErrorHandlingTests.test_erroneousResponseN)r+r,r-rBr4rr3r#r#r#r)r02s r0c@s8eZdZdZddZddZddZdd Zd d Zd S) QueryFactoryParseResponseTestsz> Test the behaviour of L{QueryFactory.parseResponse}. c Cs<tdddddddd|_td|_d|_tt|_ dS)Nr!Fr#)pathhostr0rrrr)r z invalid xml) rrrr1 goodContents badContentsrr@rreasonr%r#r#r)r4Ts z$QueryFactoryParseResponseTests.setUpcCs,|jj}||jj|j|j|j|S)z We can safely call L{QueryFactory.clientConnectionLost} as a callback of L{QueryFactory.parseResponse}. )rdeferredrclientConnectionLostr9 parseResponser7rr#r#r) test_parseResponseCallbackSafetyhsz?QueryFactoryParseResponseTests.test_parseResponseCallbackSafetycCs,|jj}||jj|j|j|j|S)z We can safely call L{QueryFactory.clientConnectionLost} as an errback of L{QueryFactory.parseResponse}. )rr: addErrbackr;r9r<r8rr#r#r)test_parseResponseErrbackSafetyusz>QueryFactoryParseResponseTests.test_parseResponseErrbackSafetycCs,|jj}||jj|j|jdd|S)z} We can safely call L{QueryFactory.clientConnectionLost} as an errback of L{QueryFactory.badStatus}. statusmessage)rr:r>r;r9Z badStatusrr#r#r)test_badStatusErrbackSafetysz:QueryFactoryParseResponseTests.test_badStatusErrbackSafetycCs$d}|jj}|j|||tS)z Some server can send a response without any data: L{QueryFactory.parseResponse} should catch the error and call the result errback. zM )rr:r<r IndexError)r&r2rr#r#r)test_parseResponseWithoutDatas z.valid) rr0rrr1r2Z notifyFinishrr3Z render_POST)r&r/rHrr#r%r)test_withRequests  z'XMLRPCWithRequestTests.test_withRequestN)r+r,r-r4rIr#r#r#r)rEsrE)FrBriorrrrZtwisted.internetrrZtwisted.internet.errorrZtwisted.internet.testingrr Ztwisted.loggerr r r r Ztwisted.pythonrZtwisted.python.compatrrZtwisted.python.reflectrZ twisted.trialZ twisted.webrrrrrZtwisted.web.test.test_webrZtwisted.web.xmlrpcrrrrrr ImportErrorrZTestCaserrrCr2rErFr}rrrrrrrrrrrrrr'r0r4rEr#r#r#r)sT         0_   70  @AR