�
D�c�] � �
� d Z ddlmZ ddlmZ ddlZej d dk\ reZ G d� de
� Z G d� d e � Z
d
� Zd � Zd � Z G d
� de � Z G d� de� Z G d� de� Z G d� de� Zy# e$ r ddlmZ Y �qw xY w)a� Testing API allows fake data to be used in unit tests.
Testing launchpadlib code is tricky, because it depends so heavily on a
remote, unique webservice: Launchpad. This module helps you write tests for
your launchpadlib application that can be run locally and quickly.
Say you were writing some code that needed to call out to Launchpad and get
the branches owned by the logged-in person, and then do something to them. For
example, something like this::
def collect_unique_names(lp):
names = []
for branch in lp.me.getBranches():
names.append(branch.unique_name)
return names
To test it, you would first prepare a L{FakeLaunchpad} object, and give it
some sample data of your own devising::
lp = FakeLaunchpad()
my_branches = [dict(unique_name='~foo/bar/baz')]
lp.me = dict(getBranches: lambda status: my_branches)
Then, in the test, call your own code and assert that it behaves correctly
given the data.
names = collect_unique_names(lp)
self.assertEqual(['~foo/bar/baz'], names)
And that's it.
The L{FakeLaunchpad} code uses a WADL file to type-check any objects created
or returned. This means you can be sure that you won't accidentally store
sample data with misspelled attribute names.
The WADL file that we use by default is for version 1.0 of the Launchpad API.
If you want to work against a more recent version of the API, download the
WADL yourself (see <https://help.launchpad.net/API/Hacking>) and construct
your C{FakeLaunchpad} like this::
from wadllib.application import Application
lp = FakeLaunchpad(
Application('https://api.launchpad.net/devel/',
'/path/to/wadl.xml'))
Where 'https://api.launchpad.net/devel/' is the URL for the WADL file, found
also in the WADL file itelf.
� )�datetime)�CallableN� c � � e Zd ZdZy)�IntegrityErrorzERaised when bad sample data is used with a L{FakeLaunchpad} instance.N��__name__�
__module__� __qualname__�__doc__� � �@/usr/lib/python3/dist-packages/launchpadlib/testing/launchpad.pyr r P s � �Or r c �~ � e Zd ZdZ d d�Zd� Zd� Ze d
d�� Ze d
d�� Z e d
d�� Z
y) �
FakeLaunchpadz�A fake Launchpad API class for unit tests that depend on L{Launchpad}.
@param application: A C{wadllib.application.Application} instance for a
Launchpad WADL definition file.
Nc �v � |�
ddl m} |� }t |� }| j j |||d�� y )Nr ��get_application)� credentials� _application�
_service_root)� launchpadlib.testing.resourcesr �FakeRoot�__dict__�update) �selfr � service_root�cache�timeout�
proxy_info� applicationr �
root_resources r �__init__zFakeLaunchpad.__init__[ s? � � � � F�)�+�K� ��-�
� �
�
� � � *� +�!.�
�
r c �6 � | j }t |||� y)z�Set sample data.
@param name: The name of the attribute.
@param values: A dict representing an object matching a resource
defined in Launchpad's WADL definition.
N)r �setattr)r �name�valuesr s r � __setattr__zFakeLaunchpad.__setattr__q s � � �)�)� �� �d�F�+r c �. � t | j |� S )�JGet sample data.
@param name: The name of the attribute.
)�getattrr )r r& s r � __getattr__zFakeLaunchpad.__getattr__{ s � �
�t�)�)�4�0�0r c �< � ddl m} | t � |� �� S )z.Convenience for setting up access credentials.r r �r! �r r �object) �cls�
consumer_name� token_string�
access_secretr r r r r s r �loginzFakeLaunchpad.login� s � � C��6�8� �):�;�;r c �< � ddl m} | t � |� �� S )z=Get credentials from Launchpad and log into the service root.r r r. r/ )r1 r2 r r r r r s r �get_token_and_loginz!FakeLaunchpad.get_token_and_login� � � � C��6�8� �):�;�;r c �< � ddl m} | t � |� �� S )z5Log in to Launchpad with possibly cached credentials.r r r. r/ )r1 r2 r �launchpadlib_dirr r r s r �
login_withzFakeLaunchpad.login_with� r8 r )NNNNNN)NNNN) r r
r r r# r( r, � classmethodr5 r7 r; r
r r r r T s� � �� ������
�,,�1� � ����
<� �
<� � ����
<� � <� � � ���
<� � <r r c �V � | D �cg c] }|j |� |k( s�|�� c}S c c}w )z@Find children of element where attribute name is equal to value.)�get)�elementr& �value�childs r �find_by_attributerB � s% � � &� C�e�%�)�)�D�/�U�*B�E� C�C�� Cs �&�&c �F � | j |� r| d t |� S | S �N)�endswith�len)�string�suffixs r � strip_suffixrI � s& � �
���v� ��n��V�� �%�%� �Mr c � � d| z S )z)Scope a tag name with the WADL namespace.z&{http://research.sun.com/wadl/2006/10}r
)�tag_names r �wadl_tagrL � s
� � 3�h� >�>r c � � e Zd ZdZdgZdd�Zd� Z e� fd�Zd� Z d� Z
d � Z d
� Z d � Z
d � Zd
� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Zy)� FakeResourcea�
Represents valid sample data on L{FakeLaunchpad} instances.
@ivar _children: A dictionary of child resources, each of type
C{FakeResource}.
@ivar _values: A dictionary of values associated with this resource. e.g.
"display_name" or "date_created". The values of this dictionary will
never be C{FakeResource}s.
Note that if C{_children} has a key, then C{_values} will not, and vice
versa. That is, they are distinct dicts.
�lp_saveNc �L � |�i }| j j ||i |d�� y)aJ Construct a FakeResource.
@param application: A C{waddlib.application.Application} instance.
@param resource_type: A C{wadllib.application.ResourceType} instance
for this resource.
@param values: Optionally, a dict representing attribute key/value
pairs for this resource.
N)r �_resource_type� _children�_values)r r )r r! �
resource_typer' s r r# zFakeResource.__init__� s1 � � �>��F� �
�
� � � +�"/� �!�
�
r c � � t |t � r | j ||� | j |< yi }|j | j
� |||< | j
| j |� || j d< y)a Set sample data.
C{value} can be a dict representing an object matching a resource
defined in the WADL definition. Alternatively, C{value} could be a
resource itself. Either way, it is checked for type correctness
against the WADL definition.
rS N) �
isinstance�dict�_create_child_resourcerR r rS �_check_resource_typerQ r )r r& r@ r' s r r( zFakeResource.__setattr__� sm � � �e�T� "�#'�#>�#>�t�U�#K�D�N�N�4� ��F� �M�M�$�,�,� '� �F�4�L�
� %� %�d�&9�&9�6� B�'-�D�M�M�)� $r c � � | j j ||� }||u r>| j j ||� }t |t � r| j ||� S || j v rd� S ||u rt | �d|�d�� �|S )r* c � � y)NTr
r
r r �<lambda>z*FakeResource.__getattr__.<locals>.<lambda> s � r z has no attribute '�')rR r> rS rV r � _wrap_method�special_methods�AttributeError)r r& �_marker�results r r, zFakeResource.__getattr__� s� � �
� � �#�#�D�'�2�� �W� ��\�\�%�%�d�G�4�F��&�(�+��(�(��v�6�6� �4�'�'� '� � � �W� � �t�T�!J�K� K��
r c � � ��� ��� fd�}|S )z�Wrapper around methods validates results when it's run.
@param name: The name of the method.
@param method: The callable to run when the method is called.
c �2 �� �j ��g| ��i |��S rD )� _run_method)�args�kwargs�methodr& r s ���r �wrapperz*FakeResource._wrap_method.<locals>.wrapper
s" �� �#�4�#�#�D�&�B�4�B�6�B� Br r
)r r& rh ri s ``` r r^ zFakeResource._wrap_method s �� � C� �r c � � | j | j d� }| j j | }|j |� D �ci c] }|j
|�� }}d}|j
|dz � }|�d}|j
|dz � }|�t |�d�� �| j |� } |r)| j | |� t | j | |� S | j | |� \ }}
t | j | |||
� S c c}w )a�
Ensure that C{values} is a valid object for the C{name} attribute and
return a resource object to represent it as API data.
@param name: The name of the attribute to check the C{values} object
against.
@param values: A dict with key/value pairs representing attributes and
methods of an object matching the C{name} resource's definition.
@return: A L{FakeEntry} for an ordinary resource or a
L{FakeCollection} for a resource that represents a collection.
@raises IntegrityError: Raised if C{name} isn't a valid attribute for
this resource or if C{values} isn't a valid object for the C{name}
attribute.
r> F�_collection_linkT�_linkz isn't a valid property.)
�_find_representation_idrQ r �representation_definitions�paramsr& r> r �_get_resource_typerY � FakeEntry�_check_collection_type�FakeCollection) r r& r' �xml_id�representationrA ro �is_link�paramrT �child_resource_types r rX z#FakeResource._create_child_resource s+ � � �-�-�d�.A�.A�5�I�� �*�*�E�E�f�M�� (�.�.�~�>�
��
�J�J�� �
��
� ���
�
�4�"4�4�5�� �=��G��J�J�t�g�~�.�E� �=� ��!G�H� H� �/�/��6�
� � � %� %�m�V� <� �T� .� .�
�v�F� F�(,�(C�(C� �v�)� %�D�%� "��!�!� ���#� �
��'
s � Dc � � |j j t d� � }|j d� }| j j |� S )z�Get the resource type for C{param}.
@param param: An object representing a C{_link} or C{_collection_link}
parameter.
@return: The resource type for the parameter, or None if one isn't
available.
�linkrT )�tag�findrL r> r �get_resource_type)r rw rz r& s r rp z FakeResource._get_resource_type> s@ � � �y�y�~�~�h�v� .�/���x�x��(��� � �2�2�4�8�8r c � � |j � D ]; \ }}t |t � r| j ||� �)| j |||� �= y)ak
Ensure that attributes and methods defined for C{partial_object} match
attributes and methods defined for C{resource_type}.
@param resource_type: The resource type to check the attributes and
methods against.
@param partial_object: A dict with key/value pairs representing
attributes and methods.
N)�itemsrV r � _get_method�_check_attribute)r rT �partial_objectr& r@ s r rY z!FakeResource._check_resource_typeJ sN � � *�/�/�1� B�K�D�%��%��*�� � � ��5��%�%�m�T�5�A� Br c �� � d}d}|j � D ]V \ }}|dk( r| j ||� \ }}�!t |t � r| j ||� �D| j |||� �X ||fS )aJ
Ensure that attributes and methods defined for C{partial_object} match
attributes and methods defined for C{resource_type}. Collection
entries are treated specially.
@param resource_type: The resource type to check the attributes and
methods against.
@param partial_object: A dict with key/value pairs representing
attributes and methods.
@return: (name, resource_type), where 'name' is the name of the child
resource type and 'resource_type' is the corresponding resource
type.
N�entries)r �_check_entriesrV r r� r� )r rT r� r& rx r@ s r rr z#FakeResource._check_collection_type[ s� � � �� "��)�/�/�1� B�K�D�%��y� �,0�,?�,?�!�5�-�)��)� �E�8�,�� � � ��5��%�%�m�T�5�A� B� �(�(�(r c � � | j ||� }|D ]; }|D ]4 }|j d� }|��| j j |� c c S �= y)z�Find the WADL XML id for the representation of C{resource_type}.
Looks in the WADL for the first representiation associated with the
method for a resource type.
:return: An XML id (a string).
�hrefN)r� r> r �
lookup_xml_id)r rT r& �
get_method�responseru �representation_urls r rm z$FakeResource._find_representation_idw sg � � �%�%�m�T�:�
�"� O�H�"*�
O��%3�%7�%7��%?�"�%�1� �,�,�:�:�;M�N�N�
O� Or c �N � | j |d� }| j |||� y)a�
Ensure that C{value} is a valid C{name} attribute on C{resource_type}.
Does this by finding the representation for the default, canonical GET
method (as opposed to the many "named" GET methods that exist.)
@param resource_type: The resource type to check the attribute
against.
@param name: The name of the attribute.
@param value: The value to check.
r> N)rm � _check_attribute_representation)r rT r& r@ rt s r r� z FakeResource._check_attribute� s( � � �-�-�m�U�C�� �,�,�V�T�5�Ar c �X � | j j | }|j |� D �ci c] }|j |�� }}|dz |v r-| j ||dz � }| j ||� \ }} y|dz |v r*| j ||dz � }| j
||� y|j |� }
|
�t d|z � �|
j �!t |t � st |�d|��� �y|
j dk( r!t |t � st |�d|��� �yyc c}w )a�
Ensure that C{value} is a valid value for C{name} with the
representation definition matching C{xml_id}.
@param xml_id: The XML ID for the representation to check the
attribute against.
@param name: The name of the attribute.
@param value: The value to check.
@raises IntegrityError: Raised if C{name} is not a valid attribute
name or if C{value}'s type is not valid for the attribute.
rk rl Nz %s not foundz is not a str or unicode for z xsd:dateTimez is not a datetime for )
r rn ro r& rp rr rY r> r �typerV �
basestringr ) r rt r& r@ ru rA ro rT �
child_namerx rw s r r� z,FakeResource._check_attribute_representation� s\ � � �*�*�E�E�f�M�� (�.�.�~�>�
��
�J�J�� �
��
� �$� $�� .� � 3� 3��t� 0�0�1� �M� /3�.I�.I� �u�/� +�J�+� �G�^�v�
%� � 3� 3�F�4�'�>�4J� K�M� � %� %�m�U� ;��J�J�t�$�E��}�$�^�d�%:�;�;��z�z�!�!�%��4�(�?D�d�K�� � 5� ���~�-�!�%��2�(�9>��E�� � 3� .��/
s �D'c �� � || j v ry|j j d� }|�d|��} t |j d|� \ }|S # t $ r t |�d|��� �w xY w)aO Get the C{name} method on C{resource_type}.
@param resource_type: The method's resource type.
@param name: The name of the method.
@raises IntegrityError: Raised if a method called C{name} is not
available on C{resource_type}.
@return: The XML element for the method from the WADL.
N�id�-z is not a method of )r_ r{ r> rB �
ValueErrorr )r rT r& �
resource_namert r� s r r� zFakeResource._get_method� s~ � � �4�'�'� '� �%�)�)�-�-�d�3�
� )�4�0�� �,�]�->�->��f�M�L�Z�
��� � � �.2�M�B��
� �s �A �A(c �p � ||i |��}|| j v s|�|S | j | j ||� S )a8 Run a method and convert its result into a L{FakeResource}.
If the result represents an object it is validated against the WADL
definition before being returned.
@param name: The name of the method.
@param method: A callable.
@param args: Arguments to pass to the callable.
@param kwargs: Keyword arguments to pass to the callable.
@return: A L{FakeResource} representing the result if it's an object.
@raises IntegrityError: Raised if the return value from the method
isn't valid.
)r_ �_create_resourcerQ )r r& rh rf rg rb s r re zFakeResource._run_method� sE � � ��(��(�� �4�'�'� '�6�>��M��(�(��)<�)<�d�F�K� Kr c � � |j j d� }||k( rd}| j ||� }|�|S t |d� }|| j j
vr|dz
}| j j
| }|j
d� r.| j ||� \ }}t | j ||||� S | j ||� t | j |� }|j � D ] \ } }
t || |
� � |S )a� Create new L{FakeResource} for C{resource_type} method call result.
@param resource_type: The resource type of the method.
@param name: The name of the method on C{resource_type}.
@param result: The result of calling the method.
@raises IntegrityError: Raised if C{result} is an invalid return value
for the method.
@return: A L{FakeResource} for C{result}, or just C{result} if no
response representation is defined for the method.
r� r> z-fullz -resourcez-page-resource)
r{ r> rm rI r �resource_typesrE rr rs rY rq r r% ) r rT r& rb r� rt �result_resource_typerx �resourcer� � child_values r r� z FakeResource._create_resource� s! � � &�)�)�-�-�d�3�
� �D� ��D��-�-�m�T�B�� �>��M� �f�g�.�� ��*�*�9�9� 9� �k� !�F� #� 0� 0� ?� ?�� G� � �?�?�+� ,�(,�(C�(C�$�f�)� %�D�%� "��!�!�$���#� �
�
� %� %�&:�F� C� ��!2�!2�4H�I�H�+1�<�<�>�
;�'�
�K���*�k�:�
;��Or c �( � | j |d� }| j j | }t |j dd� \ }t |� \ }|j
d� }|j d� d }|| j j |� fS )a7 Get the name and resource type for the entries in a collection.
@param resource_type: The resource type for a collection.
@return: (name, resource_type), where 'name' is the name of the child
resource type and 'resource_type' is the corresponding resource
type.
r> r& � entry_linksrT �#� ) rm r rn rB r{ �listr> �splitr} )r rT rt �representation_definitionr� �resource_type_url�resource_type_names r �_get_child_resource_typez%FakeResource._get_child_resource_type s� � � �-�-�m�U�C�� � � � 8� 8�� @� "� *� %� )� )�6�=�
�
�� �{�+�� � )� -� -�o� >�� .� 4� 4�S� 9�!� <�� � � � � /� /�0A� B�
�
r c �d � | j |� \ }}|D ] }| j ||� � ||fS )a� Ensure that C{entries} are valid for a C{resource_type} collection.
@param resource_type: The resource type of the collection the entries
are in.
@param entries: A list of dicts representing objects in the
collection.
@return: (name, resource_type), where 'name' is the name of the child
resource type and 'resource_type' is the corresponding resource
type.
)r� rY )r rT r� r& rx �entrys r r� zFakeResource._check_entries' sM � � %)�$A�$A� �%
�!��!� � B�E� � %� %�&9�5� A� B��(�(�(r c �* � | j j j d� }d}| j j d|� }| j j d|� }d| j j
�d|�d|�dt
t | � � �d� S )z�
The resource type, identifier if available, and memory address are
used to generate a representation of this fake resource.
r� r0 r& �<� z at �>)rQ r{ r> rS � __class__r �hexr� )r r& �keys r �__repr__zFakeResource.__repr__9 sy � �
�"�"�&�&�*�*�4�0�����l�l� � �t�S�)���l�l� � �v�s�+�� �N�N� #� #� � � ��4��M�
�
r rD )r r
r r r_ r# r( r0 r, r^ rX rp rY rr rm r� r� r� re r� r� r� r� r
r r rN rN � ss � � � !�k�O�
�(.�& )/�� �
�*�X
9�B�")�8
O�
B� (�T�*L�(% �N
�0)�$
r rN c �" � � e Zd ZdZ� fd�Z� xZS )r z$Fake root object for an application.c �j �� |j |j dz � }t t | � ||� y)z�Create a L{FakeResource} for the service root of C{application}.
@param application: A C{wadllib.application.Application} instance.
z
#service-rootN)r} �
markup_url�superr r# )r r! rT r� s �r r# zFakeRoot.__init__M s6 �� �
$�5�5� � "� "�_� 4�
�
� �h��&�{�M�Br )r r
r r r# �
__classcell__�r� s @r r r J s �� �.�C� Cr r c � � e Zd ZdZy)rq z A fake resource for an entry.Nr r
r r rq rq X s � �'r rq c �6 � � e Zd ZdZ d� fd� Zd� Zd� Z� xZS )rs z!A fake resource for a collection.c �l �� t t | � |||� | j j ||d�� y )N)�_name�_child_resource_type)r� rs r# r r )r r! rT r' r& rx r� s �r r# zFakeCollection.__init___ s8 �� � �n�d�,� � ��
�
�
�
� � ��4G� H�
r c # � K � | j j dd� }|D ]+ }| j | j | j |� �� �- y�w)z;Iterate items if this resource has an C{entries} attribute.r� r
N)rS r> r� r� r� )r r� r� s r �__iter__zFakeCollection.__iter__n sO � �� ��,�,�"�"�9�b�1�� � �E��'�'��)�)�4�:�:�u��
� �s �AAc �* � t | � }t |t � rM|j xs d}|j }|dk r t d� �|dk r t d� �|j
|� S t |t � r|j
|� S t d� �)a Look up a slice, or a subordinate resource by index.
@param key: An individual object key or a C{slice}.
@raises IndexError: Raised if an invalid key is provided.
@return: A L{FakeResource} instance for the entry matching C{key}.
r z6Collection slices must have a nonnegative start point.z>Collection slices must have a definite, nonnegative end point.z!Do not support index lookups yet.) r� rV �slice�start�stopr� � __getitem__�int�
IndexError)r r� r� r� r� s r r� zFakeCollection.__getitem__v s� � � �t�*�� �c�5� !��I�I�N��E��8�8�D��q�y� �O�� � �a�x� �-�� � �&�&�s�+� +�
��S�
!��&�&�s�+� +� � @�A� Ar )NNN)r r
r r r# r� r� r� r� s @r rs rs \ s! �� �+� �
� �
� �Br rs )r r �collections.abcr � ImportError� collections�sys� version_info�strr� � Exceptionr r0 r rB rI rL rN r rq rs r
r r �<module>r� s� ��&/�b �%�(� ����A��!���J�P�Y� P�X<�F� X<�vD�
� ?�
H
�6� H
�V C�|� C� (� � (�2B�\� 2B��i � %�$�%�s �A4 �4 B�B |