9dZddlZddlZddlZddlmZddlmZddlmZddlm Z Gdde Z d Z Gd d e Z Gd d e ZGddeZGddeZdZGddeZy)aThe mock module allows easy mocking of apitools clients. This module allows you to mock out the constructor of a particular apitools client, for a specific API and version. Then, when the client is created, it will be run against an expected session that you define. This way code that is not aware of the testing framework can construct new clients as normal, as long as it's all done within the context of a mock. N)messages)base_api)encoding) exceptionsceZdZdZy)ErrorzExceptions for this module.N)__name__ __module__ __qualname____doc__0lib/third_party/apitools/base/py/testing/mock.pyrr$s%rrct|trDt|tr4t|t|k7rytdt ||DSt|t j rt|t j s||k(S|jD]<}t||j}t||j}t||r<yy)aCompare two protorpc messages for equality. Using python's == operator does not work in all cases, specifically when there is a list involved. Args: msg1: protorpc.messages.Message or [protorpc.messages.Message] or number or string, One of the messages to compare. msg2: protorpc.messages.Message or [protorpc.messages.Message] or number or string, One of the messages to compare. Returns: If the messages are isomorphic. Fc3:K|]\}}t||ywN)_MessagesEqual).0xys r z!_MessagesEqual..;sDODAq>!Q'OsT) isinstancelistlenallziprMessage all_fieldsgetattrnamer)msg1msg2fieldfield1field2s rrr)s$*T4"8 t9D !DCdODDD tX-- .4!1!12t|"uzz*uzz*ff- # rceZdZfdZxZS)UnexpectedRequestExceptionc|\}}|\}}tj|d}tj|d}|j} |j} tj| | } dj | } ||k7r8dj dj ||||} tt|'| ydj dj |||| } tt|'| y)NT multiline )z,expected: {expected_key}({expected_request})z,received: {received_key}({received_request})) expected_keyexpected_request received_keyreceived_request)zfor request to {key},zexpected: {expected_request}zreceived: {received_request}z diff: {diff}r,)keyr.r0diff) r MessageToRepr splitlinesdifflib unified_diffjoinformatsuperr'__init__)self received_call expected_callr-r.r/r0 expected_repr received_reprexpected_linesreceived_lines diff_linesr2msg __class__s rr:z#UnexpectedRequestException.__init__Js)6& &)6& & .. .  .. . '113&113))..I yy$ < '))v)!.)!. 0  ,d eZdZdZddZedZedZdZy)_ExpectedRequestResponsez@Encapsulation of an expected request and corresponding response.Nc2||_||_|r|rtjd|r/t |tj rtjd|r/t |tj stjd||_||_y)Nz4Should specify at most one of response and exceptionz,Responses should not be an instance of Errorz%Exceptions must be instances of Error)_ExpectedRequestResponse__key!_ExpectedRequestResponse__requestrConfigurationValueErrorrr"_ExpectedRequestResponse__response#_ExpectedRequestResponse__exception)r;r1rKresponse exceptions rr:z!_ExpectedRequestResponse.__init__s    44FH H  8Z-=-=>44>@ @ Z :3C3CD4479 9#$rc|jSr)rPr;s rr1z_ExpectedRequestResponse.keys zzrc|jSr)rQrXs rrKz _ExpectedRequestResponse.requests ~~rc||jk7s%|j|k(s:t||js$t||f|j|jf|jr |j|j S)aTValidate that key and request match expectations, and respond if so. Args: key: str, Actual key to compare against expectations. request: protorpc.messages.Message or [protorpc.messages.Message] or number or string, Actual request to compare againt expectations Raises: UnexpectedRequestException: If key or request dont match expectations. apitools_base.Error: If a non-None exception is specified to be thrown. Returns: The response that was specified to be returned. )rPrQrr'rTrS)r;r1rKs rValidateAndRespondz+_ExpectedRequestResponse.ValidateAndRespondso$ $** T^^w%>%3GT^^%L,c7^.2jj$..-IK K   "" "rNN) r r r r r:propertyr1rKr[r rrrNrN~s7J%"rrNc.eZdZdZdZdZ ddZdZy) _MockedMethodzA mocked API service method.cN|j|_||_||_||_|j|_|j }t |jj |j|_t |jj |j|_ yr) r _MockedMethod__key_MockedMethod__mocked_client_MockedMethod__real_method method_configrMESSAGES_MODULErequest_type_name_MockedMethod__request_typeresponse_type_name_MockedMethod__response_type)r;r1 mocked_client real_methodconfigs rr:z_MockedMethod.__init__s#,,  ,((66##%%d&:&:&J&J&,&>&>@&t';';'K'K'-'@'@ Brc |rd}|j}nd}|j}t||s:tjdj ||j |t|y)aEnsure the given message is of the expected type of this method. Args: msg: The message instance to check. is_request: True to validate against the expected request type, False to validate against the expected response type. Raises: exceptions.ConfigurationValueError: If the type of the message was not correct. rKrUz[Expected {} is not of the correct type for method [{}]. Required: [{}] Given: [{}]N)rgrirrrRr8ratype)r;rC is_requestmode real_types r _TypeCheckz_MockedMethod._TypeChecksi D++ID,,I#y)44$$*F$**ic%<= =*rNc |r(|j|d|r|j|d|jjjt |j |||y)a#Add an expectation on the mocked method. Exactly one of response and exception should be specified. Args: request: The request that should be expected response: The response that should be returned or None if exception is provided. exception: An exception that should be thrown, or None. enable_type_checking: When true, the message type of the request and response (if provided) will be checked against the types required by this method. T)roF)rUrVN)rrrb_request_responsesappendrNra)r;rKrUrVenable_type_checking unused_kwargss rExpectz_MockedMethod.Expects]* OOGO 5U; //66 $TZZ%,.6/8 : ;rc j|jjr&|jjjd}nt|j|fd|j |j|}|@|j r4|j |}ttj|dd|S|S)Nrr\T)r* shortstrings) rbrtpopr'rar[rcprintrr3)r;rKrwrequest_responserUs r__call__z_MockedMethod.__call__s    2 2#33FFJJ1M ,W%|5 5$66tzz7K   2 2))'2H (((Dt= >Or)NNT)r r r r r:rrrxr~r rrr_r_s#& B=48<$( ;Frr_c Gddtj}|jD]6}d}|r t||}t ||t |dz|zdz|z||8|S)Nc eZdZy))_MakeMockedService..MockedServiceNr r r r rr MockedServicer"s rr.)rBaseApiServiceGetMethodsListrsetattrr_)api_namecollection_name mock_clientservice real_servicermethodrks r_MakeMockedServicer su // ((* !,7K hn>DvM))+ , + rc8eZdZdZd dZdZdZdZd dZdZ y) ClientzMock an apitools client.Nc|s |d}|j|_||_i|_||_g|_d|_y)aMock an apitools API, given its class. Args: client_class: The class for the API. eg, if you from apis.sqladmin import v1beta3 then you can pass v1beta3.SqladminV1beta3 to this class and anything within its context will use your mocked version. real_client: apitools Client, The client to make requests against when the expected response is None. Fget_credentialsN)rD_Client__orig_class_Client__client_class_Client__real_service_classes_Client__real_clientrt_Client__real_include_fields)r; client_class real_clients rr:zClient.__init__5sE&u=K NN*&(#("$%)"rc"|jSr)MockrXs r __enter__zClient.__enter__Nsyy{rc *|jxs|jd}Gdd|j|j}||_t|jD]}t |j|}t |t s*t|tjsE||j|<|j}|jjd|jj}t|||||jr||nd}t|j||t|||||jj |_|j |j_|j$|_|j&|_|S)z/Stub out the client class with mocked services.Frc eZdZy)Client.Mock..PatchedNrr rrPatchedrVs rr_N)rrrDdirrrrn issubclassrrr_NAME_PACKAGE _URL_VERSIONrr IncludeFieldsr_url_http)r;clientrr service_classrrmocked_service_classs rrz Client.MockQsd###t':':!(;(# dnnd&9&9  ++,D#D$7$7>MmT2mX-D-DE0=D ' ' -+11O"&"5"5">">"&"5"5"B"BDH#5/4)-);); f%$G D''/C D D/+?+E F'-*&*%8%8%F%F",0,>,>)KK \\  rcb|du}|j||rtj|||y)N)suppressT)Unmocksixreraise)r;exc_typevalue tracebackis_active_exceptions r__exit__zClient.__exit__xs2#4/ 0 1  KK% 3rc|j|_|jjD]2\}}t |j ||t ||j4i|_|`|` |j|j _ d|_ |jDcgc]}|j|jf}}g|_ |r&|s#tj d t#|yyycc}w)N)rrDritemsrrdelattrrrrrrrtr1rKsysexc_inforI)r;rr rrq_rsrequestss rrz Client.Unmocks**#'#>#>#D#D#F D- D''} = D--- .$G')# I J,0,F,F)%)""&!8!8:!8YY .!8 :"$ H):)B+H5 5*CH8 :sC-cT|jr|j|j|Syr)rr)r;include_fieldss rrzClient.IncludeFieldss.   --d.@.@.<> > rr)F) r r r r r:rrrrrr rrrr1s$"*2%N6&>rr)r r5rrapitools.base.protorpcliterapitools.base.pyrrr Exceptionrrr'rIobjectrNr_rrr rrrs|  /%%'&I& >(B(BV==8v8vdFdN"d>Vd>r