o

.&�a!8�@szdd
lZddl
mZ
ddlmZ
ddlmZ
ddlmZm	Z	m
Z
mZ
ddlm
Z

Gdd�de�Ze�ZGd	d
�d
e�Zd
S)�N)
�deque)
�pformat)
�validate_parameters)�ParamValidationError�StubResponseError�StubAssertionError�UnStubbedResponseError)
�AWSResponsec@s(eZ
dZd
Zdd�Zdd�Zdd�ZdS)	�_ANYzZ
    A helper object that compares equal to everything. Copied from
    unittest.mock
    c
C�d
S)NT���self�otherrr�//usr/lib/python3/dist-packages/botocore/stub.py�__eq__�
z_ANY.__eq__c
Cr)NFrr
rrr�__ne__ rz_ANY.__ne__c


Cr)Nz<ANY>r�
rrrr�__repr__#rz
_ANY.__repr__N)�__name__�
__module__�__qualname__�__doc__rrrrrrrr
s

r
c@s�eZ
dZd
Zdd�Zdd�Zdd�Zdd	�Zd
d�Zd!d
d�
Z	dd�Z
				d"dd�
Zdd�Zdd�Z
dd�Zdd�Zdd�Zdd �ZdS)#�Stubbera�

    This class will allow you to stub out requests so you don't have to hit
    an endpoint to write tests. Responses are returned first in, first out.
    If operations are called out of order, or are called with no remaining
    queued responses, an error will be raised.

    **Example:**
    ::
        import datetime
        import botocore.session
        from botocore.stub import Stubber


        s3 = botocore.session.get_session().create_client('s3')
        stubber = Stubber(s3)

        response = {
            'IsTruncated': False,
            'Name': 'test-bucket',
            'MaxKeys': 1000, 'Prefix': '',
            'Contents': [{
                'Key': 'test.txt',
                'ETag': '"abc123"',
                'StorageClass': 'STANDARD',
                'LastModified': datetime.datetime(2016, 1, 20, 22, 9),
                'Owner': {'ID': 'abc123', 'DisplayName': 'myname'},
                'Size': 14814
            }],
            'EncodingType': 'url',
            'ResponseMetadata': {
                'RequestId': 'abc123',
                'HTTPStatusCode': 200,
                'HostId': 'abc123'
            },
            'Marker': ''
        }

        expected_params = {'Bucket': 'test-bucket'}

        stubber.add_response('list_objects', response, expected_params)
        stubber.activate()

        service_response = s3.list_objects(Bucket='test-bucket')
        assert service_response == response


    This class can also be called as a context manager, which will handle
    activation / deactivation for you.

    **Example:**
    ::
        import datetime
        import botocore.session
        from botocore.stub import Stubber


        s3 = botocore.session.get_session().create_client('s3')

        response = {
            "Owner": {
                "ID": "foo",
                "DisplayName": "bar"
            },
            "Buckets": [{
                "CreationDate": datetime.datetime(2016, 1, 20, 22, 9),
                "Name": "baz"
            }]
        }


        with Stubber(s3) as stubber:
            stubber.add_response('list_buckets', response, {})
            service_response = s3.list_buckets()

        assert service_response == response


    If you have an input parameter that is a randomly generated value, or you
    otherwise don't care about its value, you can use ``stub.ANY`` to ignore
    it in validation.

    **Example:**
    ::
        import datetime
        import botocore.session
        from botocore.stub import Stubber, ANY


        s3 = botocore.session.get_session().create_client('s3')
        stubber = Stubber(s3)

        response = {
            'IsTruncated': False,
            'Name': 'test-bucket',
            'MaxKeys': 1000, 'Prefix': '',
            'Contents': [{
                'Key': 'test.txt',
                'ETag': '"abc123"',
                'StorageClass': 'STANDARD',
                'LastModified': datetime.datetime(2016, 1, 20, 22, 9),
                'Owner': {'ID': 'abc123', 'DisplayName': 'myname'},
                'Size': 14814
            }],
            'EncodingType': 'url',
            'ResponseMetadata': {
                'RequestId': 'abc123',
                'HTTPStatusCode': 200,
                'HostId': 'abc123'
            },
            'Marker': ''
        }

        expected_params = {'Bucket': ANY}
        stubber.add_response('list_objects', response, expected_params)

        with stubber:
            service_response = s3.list_objects(Bucket='test-bucket')

        assert service_response == response
    cCs|
|_d
|_
d|_t�|_dS)zA
        :param client: The client to add your stubs to.
        �boto_stubber�boto_stubber_expected_paramsN)�client�	_event_id�_expected_params_event_idr�_queue)rrrrr�__init__�s


zStubber.__init__c

Cs|��
|S�
N)
�activaterrrr�	__enter__�s

zStubber.__enter__cCs|��
dSr")
�
deactivate)r�exception_type�exception_value�	tracebackrrr�__exit__�s
zStubber.__exit__c

Cs8|jj
jjd
|j|jd�
|jj
jjd|j|jd�
dS)z5
        Activates the stubber on the client
        �before-parameter-build.*.*�
�	unique_id�before-call.*.*N)	r�meta�events�register_first�_assert_expected_paramsr�register�_get_response_handlerrrrrrr#��



�




�zStubber.activatec

Cs8|jj
jjd
|j|jd�
|jj
jjd|j|jd�
dS)z7
        Deactivates the stubber on the client
        r*r+r-N)rr.r/�
unregisterr1rr3rrrrrr%�r4zStubber.deactivateNcCs|�|
||�
d
S)ax
        Adds a service response to the response queue. This will be validated
        against the service model to ensure correctness. It should be noted,
        however, that while missing attributes are often considered correct,
        your code may not function properly if you leave them out. Therefore
        you should always fill in every value you see in a typical response for
        your particular request.

        :param method: The name of the client method to stub.
        :type method: str

        :param service_response: A dict response stub. Provided parameters will
            be validated against the service model.
        :type service_response: dict

        :param expected_params: A dictionary of the expected parameters to
            be called for the provided service response. The parameters match
            the names of keyword arguments passed to that client call. If
            any of the parameters differ a ``StubResponseError`` is thrown.
            You can use stub.ANY to indicate a particular parameter to ignore
            in validation. stub.ANY is only valid for top level params.
        N)
�
_add_response)r�method�service_response�expected_paramsrrr�add_response�szStubber.add_responsecCsnt|j
|
�std
|j
jjj|
f�
�
tddid�}|j
jj�|
�
}|�	||�
|||f|d�}|j
�|�

dS)Nz"Client %s does not have method: %s����operation_name�responser9)�hasattrr�
ValueErrorr.�
service_model�service_namer	�method_to_api_mapping�get�_validate_responser �append)rr7r8r9�
http_responser=r>rrrr6�s



��


�zStubber._add_response��
cCs~td
|id
�}d|i
||d�d�}	|d
u
r|	d�
|�

|d
u
r'|	d�
|�

|jjj�|
�
}
|
||	f|d�}|j�|�

d
S)a
        Adds a ``ClientError`` to the response queue.

        :param method: The name of the service method to return the error on.
        :type method: str

        :param service_error_code: The service error code to return,
                                   e.g. ``NoSuchBucket``
        :type service_error_code: str

        :param service_message: The service message to return, e.g.
                        'The specified bucket does not exist.'
        :type service_message: str

        :param http_status_code: The HTTP status code to return, e.g. 404, etc
        :type http_status_code: int

        :param service_error_meta: Additional keys to be added to the
            service Error
        :type service_error_meta: dict

        :param expected_params: A dictionary of the expected parameters to
            be called for the provided service response. The parameters match
            the names of keyword arguments passed to that client call. If
            any of the parameters differ a ``StubResponseError`` is thrown.
            You can use stub.ANY to indicate a particular parameter to ignore
            in validation.

        :param response_meta: Additional keys to be added to the
            response's ResponseMetadata
        :type response_meta: dict

        N�HTTPStatusCode)�Message�Code)�ResponseMetadata�ErrorrNrMr<)r	�updaterr.rCrDr rF)rr7�service_error_code�service_message�http_status_code�service_error_metar9�
response_metarG�parsed_responser=r>rrr�add_client_error�s %
��



�zStubber.add_client_errorc
Cs"t|j
�
}
|
d
krtd|
�
�
dS)z<
        Asserts that all expected calls were made.
        r
z %d responses remaining in queue.N)�lenr �AssertionError)r�	remainingrrr�assert_no_pending_responses<
s



��z#Stubber.assert_no_pending_responsescCsB|js
t
|
jd
d��
|jdd}||
jkrt|
jd|d��
dS)Nz�Unexpected API Call: A call was made but no additional calls expected. Either the API Call was not stubbed or it was called multiple times.�r=�reasonr
r=z*Operation mismatch: found response for %s.)r r�namer)r�model�paramsr]rrr�_assert_expected_call_orderE
s


�	




��z#Stubber._assert_expected_call_ordercKs|�|
|�
|j
��d
S)Nr>)r`r �popleft)rr^r_�context�kwargsrrrr3V
s
zStubber._get_response_handlercKs�|�|�
rdS|�
|
|�
|jd
d}|durdS|��D]\}}||v
s.||||kr=t|
jdt|�
t|�
fd��
qt|���
t|���
krYt|
jdt|�
t|�
fd��
dS)Nr
r9z)Expected parameters:
%s,
but received:
%sr[)	�_should_not_stubr`r �itemsrr]r�sorted�keys)rr^r_rbrcr9�param�valuerrrr1[
s.











���



���zStubber._assert_expected_paramscCs|
r	|
�d
�
rdSdSdS)N�is_presign_requestT)
rD)rrbrrrrdr
s
�zStubber._should_not_stubcCs^|jj
j}|�|
�
}|j}|}d
|vrt�|�
}|d
=|du
r&t||�
dS|r-tdd�
�
dS)NrMz6Service response should only contain ResponseMetadata.)
�report)rr.rA�operation_model�output_shape�copyrr)rr=r8rArlrmr>rrrrEy
s










��zStubber._validate_responser")rHrHrINNN)rrrrr!r$r)r#r%r:r6rVrZr`r3r1rdrErrrrr*s(
x	





�B	r)rn�collectionsr�pprintr�botocore.validater�botocore.exceptionsrrrr�botocore.awsrequestr	�objectr
�ANYrrrrr�<module>
s