File: //lib/python3/dist-packages/botocore/__pycache__/stub.cpython-312.pyc
�
P��e0; � � � d dl Z d dlmZ d dlmZ d dlmZ d dlmZm Z m
Z
m Z d dl m
Z
G d� d� Z e� Z G d � d
� Zy) � N)�deque)�pformat)� AWSResponse)�ParamValidationError�StubAssertionError�StubResponseError�UnStubbedResponseError)�validate_parametersc �" � e Zd ZdZd� Zd� Zd� Zy)�_ANYzZ
A helper object that compares equal to everything. Copied from
unittest.mock
c � � y)NT� ��self�others �//usr/lib/python3/dist-packages/botocore/stub.py�__eq__z _ANY.__eq__! s � �� c � � y)NFr r s r �__ne__z _ANY.__ne__$ s � �r c � � y)Nz<ANY>r �r s r �__repr__z
_ANY.__repr__' s � �r N)�__name__�
__module__� __qualname__�__doc__r r r r r r r r s � ��
��r r c �| � e Zd ZdZd� Zd� Zd� Zd� Zd� Zdd�Z d � Z
dd
�Z d � Z d � Z
d
� Zd� Zd� Zd� Zd� Zy)�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
c �L � || _ d| _ d| _ t � | _ y)zA
:param client: The client to add your stubs to.
� boto_stubber� boto_stubber_expected_paramsN)�client� _event_id�_expected_params_event_idr �_queue)r r# s r �__init__zStubber.__init__� s# � � �� �'���)G��&��g�� r c �& � | j � | S �N)�activater s r � __enter__zStubber.__enter__� s � � �
�
��� r c �$ � | j � y r) )�
deactivate)r �exception_type�exception_value� tracebacks r �__exit__zStubber.__exit__� s � � ���r c � � | j j j j d| j | j
�� | j j j j
d| j | j �� y)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_handlerr$ r s r r* zStubber.activate� st � �
� � ��� � �.�.� (� � (� (��4�4� /�
�
� � ��� � �(�(� � � &� &��n�n� )�
r c � � | j j j j d| j | j
�� | j j j j d| j | j �� y)z7
Deactivates the stubber on the client
r3 r4 r6 N)r# r7 r8 �
unregisterr: r% r< r$ r s r r- zStubber.deactivate� st � �
� � ��� � �*�*� (� � (� (��4�4� +�
�
� � ��� � �*�*� � � &� &��n�n� +�
r Nc �* � | j |||� y)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_paramss r � add_responsezStubber.add_response� s � �.
���6�#3�_�Er c � � t | j |� s9t d| j j j j
�d|��� �t
d di d � }| j j j j |� }| j ||� |||f|d�}| j j |� y )NzClient z does not have method: �� ��operation_name�responserC ) �hasattrr# �
ValueErrorr7 �
service_model� service_namer �method_to_api_mapping�get� _validate_operation_responser& �append)r rA rB rC �
http_responserH rI s r r@ zStubber._add_response� s� � ��t�{�{�F�+� ��;�;�#�#�1�1�>�>��H��
� $�D�#�r�4�8�
� ���)�)�?�?�C�C�F�K�� �)�)�.�:J�K� -�&�(8�9� .�
��
� � ���8�$r c �� � t d|i d� } d|i||d�d�}
|�|
d j |� |�|
d j |� |�T| j j j } | j |� } | j
| |� |
j |� | j j j j |� }
|
| |
f|d�}| j j |� y)aG
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
:param modeled_fields: Additional keys to be added to the response
based on fields that are modeled for the particular error code.
These keys will be validated against the particular error shape
designated by the error code.
:type modeled_fields: dict
N�HTTPStatusCode)�Message�Code)�ResponseMetadata�ErrorrX rW rG ) r �updater# r7 rL �shape_for_error_code�_validate_responserN rO r& rQ )r rA �service_error_code�service_message�http_status_code�service_error_metarC �
response_meta�modeled_fieldsrR �parsed_responserL �shaperH rI s r �add_client_errorzStubber.add_client_error s� � �d $�D�*:�B��E�
� "2�3C� D�!0�:L�M�
��
� )� �G� $� +� +�,>� ?� � $� � .� /� 6� 6�}� E� � %� �K�K� ,� ,� :� :�M�!�6�6�7I�J�E� � #� #�E�>� :� � "� "�>� 2� ���)�)�?�?�C�C�F�K�� -�&��8� .�
��
� � ���8�$r c �T � t | j � }|dk7 rt |� d�� �y)z<
Asserts that all expected calls were made.
r z responses remaining in queue.N)�lenr& �AssertionError)r � remainings r �assert_no_pending_responsesz#Stubber.assert_no_pending_responsesV s1 � � �� � �$� � ��>� �I�;�.L�!M�N� N� r c �� � | j st |j d�� �| j d d }||j k7 rt |j d|� d��� �y )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.�rH �reasonr rH z'Operation mismatch: found response for �.)r& r �namer )r �model�paramsrn s r �_assert_expected_call_orderz#Stubber._assert_expected_call_order^ sh � ��{�{�(� $�z�z�4��
� �{�{�1�~� .�/�� �5�:�:� �#� $�z�z�@���a�H��
� r c �` � | j ||� | j j � d S )NrI )rq r& �popleft)r ro rp �context�kwargss r r< z Stubber._get_response_handlerp s* � � �(�(���7��{�{�"�"�$�Z�0�0r c
�� � | j |� ry | j ||� | j d d }|�y |j � D ]C \ }}||vs || || k7 s�t |j
dt
|� �dt
|� ���� � t |j � � t |j � � k7 r/t |j
dt
|� �dt
|� ���� �y )Nr rC zExpected parameters:
z,
but received:
rk ) �_should_not_stubrq r& �itemsr rn r �sorted�keys)r ro rp rt ru rC �param�values r r: z Stubber._assert_expected_paramsu s� � � � � �� )� � �(�(���7� �+�+�a�.�):�;�� � "� � ,� 1� 1� 3� �L�E�5��F�"�o�e�&<��u�
�&M�(�#(�:�:� ��/��� � B�� � � �/�&�&�(� )�V�F�K�K�M�-B� B�$� $�z�z��?�+�W�V�_�>��
� Cr c �. � |r|j d� ryy y )N�is_presign_requestT)rO )r rt s r rw zStubber._should_not_stub� s � � �w�{�{�#7�8�� 9�7r c �� � | j j j }|j |� }|j }|}d|v rt j
|� }|d= | j
||� y )NrW )r# r7 rL �operation_model� output_shape�copyr[ )r rH rB rL r� r� rI s r rP z$Stubber._validate_operation_response� si � � � � �(�(�6�6�
�'�7�7��G��&�3�3� � $�� �� )��y�y�!1�2�H��+�,� � � � �h�7r c �> � |�
t ||� y |r t d�� �y )Nz6Service response should only contain ResponseMetadata.)�report)r
r )r rc rI s r r[ zStubber._validate_response� s, � � � � ��%� 0�
� '�L��
� r r) )� r� i� NNNN)r r r r r' r+ r1 r* r- rD r@ rd ri rq r< r: rw rP r[ r r r r r . so � �w�r ���
�
� F�2%�0 �� � � ���P%�dO��$1�
�2� 8�
r r )r� � collectionsr �pprintr �botocore.awsrequestr �botocore.exceptionsr r r r �botocore.validater
r �ANYr r r r �<module>r� sA �� � � � +�� � 2�
�
� �f��� r