���Z�> � @ s� d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z m
Z
d d l m Z d d l m
Z
d d l m Z d d l Z d d l m Z m Z d d l m Z m Z d d
l m Z d d l m Z m Z d d l m Z d d
l m Z m Z m! Z! m" Z" m# Z# m$ Z$ d d � Z% Gd d � d e � Z& Gd d � d e& � Z' Gd d � d e& � Z( Gd d � d � Z) Gd d � d e j* � Z+ d d � Z, e j- e j. d d d � � Z/ e j. d d � Z0 d d! d" � Z1 d# d$ � Z2 d d% d& � Z3 d d' e d( e d d � d) d d* d d+ e d, e d- e d. e d/ e d0 d d1 d: d4 d5 d6 d7 � Z4 e e d8 d9 � Z5 d S);zUtilities shared by tests.� N)�ABC�abstractmethod)�mock)� CIMultiDict)�URL)�_RequestContextManager�_WSRequestContextManager� )�
ClientSession�hdrs)�sentinel)� HttpVersion�RawRequestMessage)�Signal)� AppRunner�Request�Server� ServerRunner�TCPSite�UrlMappingMatchInfoc
C sA t j t j t j � �" } | j d � | j � d SWd QRXd S)z1Return a port that is unused on the current host.� 127.0.0.1r r N)r r )�socket�AF_INET� SOCK_STREAM�bind� getsockname)�s� r �/test_utils.py� unused_port s
r c @ s� e Z d Z d e d d d d d d d d d d
� Z d d d � Z e d
d � � Z d d � Z e d d � � Z
e d d � � Z e d d � � Z d d � Z
d d � Z d d � Z d d � Z d d � Z d S)!�BaseTestServer�scheme�loopN�hostz 127.0.0.1�port�skip_url_assertsFc K sL | | _ d | _ d | _ | | _ | | _ d | _ | | _ | | _ d S)NF)�_loop�runner�_rootr# r$ �_closedr! r% )�selfr! r" r# r$ r% �kwargsr r r �__init__# s zBaseTestServer.__init__c � s� | j r
d S| | _ | j d d � | _ | j | � Id H| _ | j j � Id H| j si t � | _ t | j d | j d | j d | j �} | j
� Id H| j t k r� | j r� d } n d } | | _ t
d j | j | j | j � � | _ d S)NZsslr# r$ Z ssl_contextZhttps�httpz
{}://{}:{})r' r& �popZ_ssl� _make_runnerZsetupr$ r r r# �startr! r r �formatr( )r* r" r+ Zsiter! r r r � start_server/ s& zBaseTestServer.start_serverc � s d S)Nr )r* r+ r r r r/ E s zBaseTestServer._make_runnerc C sS t | � } | j s8 | j � s( t � | j j | � St t | j � | � Sd S)N)r r% Z is_absolute�AssertionErrorr( �join�str)r* �pathZurlr r r �make_urlI s
zBaseTestServer.make_urlc C s
| j d k S)N)r' )r* r r r �startedQ s zBaseTestServer.startedc C s | j S)N)r) )r* r r r �closedU s zBaseTestServer.closedc C s
| j j S)N)r' �server)r* r r r �handlerY s zBaseTestServer.handlerc � sD | j r@ | j r@ | j j � Id Hd | _ d | _ d | _ d S)a` Close all fixtures created by the test client.
After that point, the TestClient is no longer usable.
This is an idempotent function: running close multiple times
will not have any additional effects.
close is also run when the object is garbage collected, and on
exit when used as a context manager.
NT)r8 r9 r' �cleanupr( r$ r) )r* r r r �close_ s
zBaseTestServer.closec C s t d � � d S)NzUse async with instead)� TypeError)r* r r r � __enter__q s zBaseTestServer.__enter__c C s d S)Nr )r* �exc_type� exc_value� tracebackr r r �__exit__t s zBaseTestServer.__exit__c � s | j d | j � Id H| S)Nr" )r2 r& )r* r r r �
__aenter__x s zBaseTestServer.__aenter__c � s | j � Id Hd S)N)r= )r* r@ rA rB r r r � __aexit__| s zBaseTestServer.__aexit__)�__name__�
__module__� __qualname__r r, r2 r r/ r7 �propertyr8 r9 r; r= r? rC rD rE r r r r r " s r c s@ e Z d Z d e d d d d � f d d � Z d d � Z � S)
�
TestServerr! r# z 127.0.0.1r$ Nc s/ | | _ t � j d | d | d | | � d S)Nr! r# r$ )�app�superr, )r* rK r! r# r$ r+ )� __class__r r r, � s zTestServer.__init__c � s t | j | � S)N)r rK )r* r+ r r r r/ � s zTestServer._make_runner)rF rG rH r r, r/ r r )rM r rJ � s !rJ c sC e Z d Z d e d d d d � f d d � Z d d d
� Z � S) �
RawTestServerr! r# z 127.0.0.1r$ Nc s/ | | _ t � j d | d | d | | � d S)Nr! r# r$ )�_handlerrL r, )r* r; r! r# r$ r+ )rM r r r, � s zRawTestServer.__init__Tc � s4 t | j d | j d d | �} t | d | | �S)Nr" �debugT)r rO r& r )r* rP r+ Zsrvr r r r/ � s zRawTestServer._make_runner)rF rG rH r r, r/ r r )rM r rN � s !rN c @ sB e Z d Z d Z d d d d d d � Z d d � Z e d d
� � Z e d d � � Z e d
d � � Z e d d � � Z
d d � Z d d � Z d d � Z
d d � Z d d � Z d d � Z d d � Z d d � Z d! d" � Z d# d$ � Z d% d& � Z d' d( � Z d) d* � Z d+ d, � Z d- d. � Z d/ d0 � Z d S)1�
TestClientzb
A test client implementation.
To write functional tests for aiohttp based servers.
�
cookie_jarNr" c K s� t | t � s% t d t | � � � | | _ | | _ | d k r[ t j d d d | � } t d | d | | � | _ d | _
g | _ g | _ d S)NzBserver must be web.Application TestServer instance, found type: %rZunsafeTr" rR F)
�
isinstancer r> �type�_serverr& �aiohttpZ CookieJarr
�_sessionr) �
_responses� _websockets)r* r: rR r" r+ r r r r, � s zTestClient.__init__c � s | j j d | j � Id Hd S)Nr" )rU r2 r& )r* r r r r2 � s zTestClient.start_serverc C s
| j j S)N)rU r# )r* r r r r# � s zTestClient.hostc C s
| j j S)N)rU r$ )r* r r r r$ � s zTestClient.portc C s | j S)N)rU )r* r r r r: � s zTestClient.serverc C s | j S)z�An internal aiohttp.ClientSession.
Unlike the methods on the TestClient, client session requests
do not automatically include the host in the url queried, and
will require an absolute path to the resource.
)rW )r* r r r �session� s zTestClient.sessionc C s | j j | � S)N)rU r7 )r* r6 r r r r7 � s zTestClient.make_urlc � s= | j j | | j | � | | � Id H} | j j | � | S)z�Routes a request to tested http server.
The interface is identical to asyncio.ClientSession.request,
except the loop kwarg is overridden by the instance used by the
test server.
N)rW �requestr7 rX �append)r* �methodr6 �argsr+ �respr r r r[ � s zTestClient.requestc O s t | j t j | | | � � S)z Perform an HTTP GET request.)r r[ r ZMETH_GET)r* r6 r^ r+ r r r �get� s zTestClient.getc O s t | j t j | | | � � S)z Perform an HTTP POST request.)r r[ r Z METH_POST)r* r6 r^ r+ r r r �post� s zTestClient.postc O s t | j t j | | | � � S)z Perform an HTTP OPTIONS request.)r r[ r Z METH_OPTIONS)r* r6 r^ r+ r r r �options� s zTestClient.optionsc O s t | j t j | | | � � S)z Perform an HTTP HEAD request.)r r[ r Z METH_HEAD)r* r6 r^ r+ r r r �head� s zTestClient.headc O s t | j t j | | | � � S)z Perform an HTTP PUT request.)r r[ r ZMETH_PUT)r* r6 r^ r+ r r r �put� s zTestClient.putc O s t | j t j | | | � � S)z Perform an HTTP PATCH request.)r r[ r Z
METH_PATCH)r* r6 r^ r+ r r r �patch� s zTestClient.patchc O s t | j t j | | | � � S)z Perform an HTTP PATCH request.)r r[ r Z METH_DELETE)r* r6 r^ r+ r r r �delete� s zTestClient.deletec O s t | j | | | � � S)zjInitiate websocket connection.
The api corresponds to aiohttp.ClientSession.ws_connect.
)r � _ws_connect)r* r6 r^ r+ r r r �
ws_connect s zTestClient.ws_connectc � s: | j j | j | � | | � Id H} | j j | � | S)N)rW rh r7 rY r\ )r* r6 r^ r+ �wsr r r rg s zTestClient._ws_connectc � s{ | j sw x | j D] } | j � q Wx | j D] } | j � Id Hq1 W| j j � Id H| j j � Id Hd | _ d S)aH Close all fixtures created by the test client.
After that point, the TestClient is no longer usable.
This is an idempotent function: running close multiple times
will not have any additional effects.
close is also run on exit when used as a(n) (asynchronous)
context manager.
NT)r) rX r= rY rW rU )r* r_ ri r r r r= s zTestClient.closec C s t d � � d S)NzUse async with instead)r> )r* r r r r? * s zTestClient.__enter__c C s d S)Nr )r* r@ rA rB r r r rC - s zTestClient.__exit__c � s | j � Id H| S)N)r2 )r* r r r rD 1 s zTestClient.__aenter__c � s | j � Id Hd S)N)r= )r* r@ rA rB r r r rE 5 s zTestClient.__aexit__)rF rG rH �__doc__r, r2 rI r# r$ r: rZ r7 r[ r` ra rb rc rd re rf rh rg r= r? rC rD rE r r r r rQ � s.
rQ c @ sv e Z d Z d Z d d � Z d d � Z d d � Z d d � Z d
d � Z d d
� Z d d � Z
d d � Z d S)�AioHTTPTestCasea A base class to allow for unittest web applications using
aiohttp.
Provides the following:
* self.client (aiohttp.test_utils.TestClient): an aiohttp test client.
* self.loop (asyncio.BaseEventLoop): the event loop in which the
application and server are running.
* self.app (aiohttp.web.Application): the application returned by
self.get_application()
Note that the TestClient's methods are asynchronous: you have to
execute function on the test client using asynchronous methods.
c � s
| j � S)zy
This method should be overridden
to return the aiohttp.web.Application
object to test.
)�get_app)r* r r r �get_applicationI s z AioHTTPTestCase.get_applicationc C s t d � � d S)zqObsolete method used to constructing web application.
Use .get_application() coroutine instead
z+Did you forget to define get_application()?N)� RuntimeError)r* r r r rl R s zAioHTTPTestCase.get_appc C s� t � | _ | j j | j � � | _ | j j | j | j � � | _ | j j | j | j � � | _ | j j | j j � � | j j | j
� � d S)N) �setup_test_loopr" �run_until_completerm rK �
get_serverr: �
get_client�clientr2 �
setUpAsync)r* r r r �setUpZ s ! zAioHTTPTestCase.setUpc � s d S)Nr )r* r r r rt f s zAioHTTPTestCase.setUpAsyncc C s@ | j j | j � � | j j | j j � � t | j � d S)N)r" rp �
tearDownAsyncrs r= �teardown_test_loop)r* r r r �tearDowni s zAioHTTPTestCase.tearDownc � s d S)Nr )r* r r r rv n s z AioHTTPTestCase.tearDownAsyncc � s t | d | j �S)z Return a TestServer instance.r" )rJ r" )r* rK r r r rq q s zAioHTTPTestCase.get_serverc � s t | d | j �S)z Return a TestClient instance.r" )rQ r" )r* r: r r r rr u s zAioHTTPTestCase.get_clientN) rF rG rH rj rm rl ru rt rx rv rq rr r r r r rk 9 s rk c s+ t j � | | � � f d d � � } | S)z�A decorator dedicated to use with asynchronous methods of an
AioHTTPTestCase.
Handles executing an asynchronous function, using
the self.loop of the AioHTTPTestCase.
c s | j j � | | | � � S)N)r" rp )r* Z
inner_argsZ inner_kwargs)�funcr r �new_func� s z#unittest_run_loop.<locals>.new_func)� functools�wraps)ry r^ r+ rz r )ry r �unittest_run_loopz s 'r} Fc c s% t | � } | Vt | d | �d S)zzA contextmanager that creates an event_loop, for test purposes.
Handles the creation and cleanup of a test loop.
�fastN)ro rw )� loop_factoryr~ r" r r r � loop_context� s r� c C sr | � } t j d � t j d k rn t j � } t j � } | j | � t j t � � | j
| � Wd QRX| S)z�Create and return an asyncio.BaseEventLoop
instance.
The caller should also call teardown_test_loop,
once they are done with the loop.
N�win32) �asyncio�set_event_loop�sys�platformZget_event_loop_policyZSafeChildWatcherZ attach_loop�
contextlib�suppress�NotImplementedErrorZset_child_watcher)r r" ZpolicyZwatcherr r r ro � s
ro c C sW | j � } | s6 | j | j � | j � | j � | sF t j � t j d � d S)zHTeardown and cleanup an event_loop created
by setup_test_loop.
N) Z is_closedZ call_soon�stopZ run_foreverr= �gcZcollectr� r� )r" r~ r9 r r r rw � s
rw c C s5 t j � } d | _ t | � | _ | j j � | S)NF)r �MockZ_debugr Zon_response_prepareZfreeze)rK r r r �_create_app_mock� s
r� c s. t j � } � f d d � } | | j _ | S)Nc s | d k r � Sd Sd S)N�
sslcontextr )�key)r� r r �get_extra_info� s z)_create_transport.<locals>.get_extra_info)r r� r� Z side_effect)r� � transportr� r )r� r �_create_transport� s r� �
match_info�version�closingrK �writer�payload_writer�protocolr� �payloadr� �client_max_sizei � r" .c C s t j � } | d k r0 t j � } f | j _ | t d d � k rK d } | r t | � } t d d � | j � D� � } n t � } f } d | j t j
d � j � k } t | | | | | | d d | t
| � �
} | d k r� t � } | t k r t j � } |
t k r!t | � }
| t k rBt j � } |
| _ | t k r�t j � } t d � | _ t d � | _ t d � | _ |
| _ | | _ | t k r�t j � } t | | | | | | d
|
�} t | t k r�i n | t j � � } | j | � | | _ | S) z�Creates mocked web.Request testing purposes.
Useful in unit tests, when spinning full web server is overkill or
specific conditions and errors are hard to trigger.
.r Tc s s3 | ]) \ } } | j d � | j d � f Vq d S)zutf-8N)�encode)�.0�k�vr r r � <genexpr>� s z&make_mocked_request.<locals>.<genexpr>�chunked� FNr� )r r� Z
create_future� return_valuer
r �tuple�itemsr` r ZTRANSFER_ENCODING�lowerr r r� r r� r� �make_mocked_coro�writeZ write_eofZdrainr� r r Zadd_appZ _match_info)r] r6 Zheadersr� r� r� rK r� r� r� r� r� r� r� r" ZtaskZraw_hdrsr� �messageZreqr r r �make_mocked_request� sT ! $
r� c s. t j � � f d d � � } t j d | � S)zCreates a coroutine mock.c s � t k r � � � S)N)r )r^ r+ )�raise_exceptionr� r r � mock_coro s z#make_mocked_coro.<locals>.mock_coror| )r� � coroutiner r� )r� r� r� r )r� r� r r� s r� i )6rj r� r� r{ r� r r� Zunittest�abcr r r Z multidictr Zyarlr rV Zaiohttp.clientr r r� r
r Zhelpersr r- r
r Zsignalsr Zwebr r r r r r r r rJ rN rQ ZTestCaserk r} �contextmanagerZnew_event_loopr� ro rw r� r� r� r� r r r r �<module> sX . ^
�A
B