�
�w�g�\ � � � S r SSKJr SSKJr " S S\5 r " S S5 rS rS rS
r " S S 5 r
" S
S\
5 r " S S\
5 r " S S\
5 r
g)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.
� )�Callable)�datetimec � � \ rS rSrSrSrg)�IntegrityError�H zERaised when bad sample data is used with a L{FakeLaunchpad} instance.� N��__name__�
__module__� __qualname__�__firstlineno__�__doc__�__static_attributes__r � �@/usr/lib/python3/dist-packages/launchpadlib/testing/launchpad.pyr r H s � �Or r c � � \ rS rSrSr S S jrS rS r\ S S j5 r \ S S j5 r
\ S S j5 r S
r g)
�
FakeLaunchpad�L z�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 �x � Uc
SSK Jn U" 5 n[ U5 nU R R UUUS.5 g )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__�FakeLaunchpad.__init__S s? � � � � F�)�+�K� ��-�
� �
�
� � � *� +�!.�
�
r c �4 � U R n[ X1U5 g)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__�FakeLaunchpad.__setattr__i s � � �)�)� �� �F�+r c �. � [ U R U5 $ )�:Get sample data.
@param name: The name of the attribute.
)�getattrr )r r* s r � __getattr__�FakeLaunchpad.__getattr__s s � �
�t�)�)�4�0�0r c �6 � SSK Jn U " [ 5 U" 5 S9$ )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 �login�FakeLaunchpad.loginz s � � C��6�8� �):�;�;r c �6 � SSK Jn U " [ 5 U" 5 S9$ )z=Get credentials from Launchpad and log into the service root.r r r4 r5 )r7 r8 r r! r" r# r s r �get_token_and_login�!FakeLaunchpad.get_token_and_login� � � � C��6�8� �):�;�;r c �6 � SSK Jn U " [ 5 U" 5 S9$ )z5Log in to Launchpad with possibly cached credentials.r r r4 r5 )r7 r8 r �launchpadlib_dirr" r# r s r �
login_with�FakeLaunchpad.login_with� r@ r r )NNNNNN)NNNN)
r
r r r
r r& r, r1 � classmethodr; r> rC r r r r r r L s� � �� ������
�,,�1� � ����
<� �
<� � ����
<� � <� � � ���
<� � <r r c �^ � U Vs/ s H o3R U5 U:X d M UPM sn$ s snf )z@Find children of element where attribute name is equal to value.)�get)�elementr* �value�childs r �find_by_attributerK � s' � � &� C�w�e�)�)�D�/�U�*B�E�w� C�C�� Cs �*�*c �P � U R U5 ( a U S [ U5 * $ U $ �N)�endswith�len)�string�suffixs r � strip_suffixrR � s) � �
���v� � ��n��V�� �%�%� �Mr c � � SU - $ )z)Scope a tag name with the WADL namespace.z&{http://research.sun.com/wadl/2006/10}r )�tag_names r �wadl_tagrU � s
� � 3�h� >�>r c � � \ rS rSrSrS/rSS jrS r\" 5 4S jr S r
S r S
r S r
S rS
rS rS rS rS rS rS rS rS rSrg)� FakeResource� a�
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 �N � Uc 0 nU R R UU0 US.5 g)a 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& �FakeResource.__init__� s1 � � �>��F� �
�
� � � +�"/� �!�
�
r c � � [ U[ 5 ( a U R X5 U R U' g0 nUR U R
5 X#U' U R
U R U5 X0R S' g)z�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.
r] N) �
isinstance�dict�_create_child_resourcer\ r r] �_check_resource_typer[ r )r r* rI r+ s r r, �FakeResource.__setattr__� sj � � �e�T� "� "�#'�#>�#>�t�#K�D�N�N�4� ��F� �M�M�$�,�,� '� �4�L�
� %� %�d�&9�&9�6� B�'-�M�M�)� $r c � � U R R X5 nX2L aA U R R X5 n[ U[ 5 ( a U R X5 $ XR ; a S $ X2L a [ U < SU< S35 eU$ )r/ c � � g)NTr r r r �<lambda>�*FakeResource.__getattr__.<locals>.<lambda>� s � �4r z has no attribute '�')r\ rG r] ra r � _wrap_method�special_methods�AttributeError)r r* �_marker�results r r1 �FakeResource.__getattr__� s} � �
� � �#�#�D�2�� � ��\�\�%�%�d�4�F��&�(�+�+��(�(��6�6� �'�'� '� � � � � �t�T�!J�K� K��
r c � ^ ^^� UUU 4S jnU$ )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 >� TR " TT/U Q70 UD6$ rM )� _run_method)�args�kwargs�methodr* r s ���r �wrapper�*FakeResource._wrap_method.<locals>.wrapper s �� ��#�#�D�&�B�4�B�6�B� Br r )r r* rv rw s ``` r rk �FakeResource._wrap_method� s �� � C� �r c �& � U R U R S5 nU R R U nUR U5 Vs0 s H nUR
U_M nnSnUR
US- 5 nUc SnUR
US- 5 nUc [ U< S35 eU R U5 n U( a' U R X�5 [ U R X�5 $ U R X�5 u p[ U R U UUU
5 $ s snf )aq
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.
rG F�_collection_linkT�_linkz isn't a valid property.)
�_find_representation_idr[ r �representation_definitions�paramsr* rG r �_get_resource_typerd � FakeEntry�_check_collection_type�FakeCollection) r r* r+ �xml_id�representationrJ r �is_link�paramr^ �child_resource_types r rc �#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� <� �T� .� .�
�F� F�(,�(C�(C� �)� %�D� "��!�!� ���#� �
��'
s � Dc � � UR R [ S5 5 nUR S5 nU R R U5 $ )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.
�linkr^ )�tag�findrU rG r �get_resource_type)r r� r� r* s r r� � FakeResource._get_resource_type6 s@ � � �y�y�~�~�h�v� .�/���x�x��(��� � �2�2�4�8�8r c � � UR 5 H? u p4[ U[ 5 ( a U R X5 M- U R XU5 MA g)a3
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)�itemsra r � _get_method�_check_attribute)r r^ �partial_objectr* rI s r rd �!FakeResource._check_resource_typeB sD � � *�/�/�1�K�D��%��*�*�� � � �5��%�%�m�5�A� 2r c �� � SnSnUR 5 HZ u p5US:X a U R X5 u p4M [ U[ 5 ( a U R X5 MH U R XU5 M\ X44$ )a�
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_entriesra r r� r� )r r^ r� r* r� rI s r r� �#FakeResource._check_collection_typeS s} � � �� "��)�/�/�1�K�D��y� �,0�,?�,?�!�-�)��)� �E�8�,�,�� � � �5��%�%�m�5�A� 2� �(�(r c � � U R X5 nU H? nU H6 nUR S5 nUc M U R R U5 s s $ MA g)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� rG r �
lookup_xml_id)r r^ r* �
get_method�responser� �representation_urls r r} �$FakeResource._find_representation_ido sW � � �%�%�m�:�
�"�H�"*��%3�%7�%7��%?�"�%�1� �,�,�:�:�;M�N�N� #+� #r c �L � U R US5 nU R XBU5 g)ag
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.
rG N)r} � _check_attribute_representation)r r^ r* rI r� s r r� � FakeResource._check_attribute~ s& � � �-�-�m�U�C�� �,�,�V�5�Ar c �~ � U R R U nUR U5 Vs0 s H nUR U_M nnUS- U; a* U R XbS- 5 nU R Xs5 u p�gUS- U; a( U R XbS- 5 nU R
Xs5 gUR U5 n
U
c [ SU- 5 eU
R c( [ U[ 5 ( d [ U< SU< 35 egU
R S:X a( [ U[ 5 ( d [ U< SU< 35 eggs snf )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.
r{ r| Nz %s not foundz is not a str or unicode for z xsd:dateTimez is not a datetime for )
r r~ r r* r� r� rd rG r �typera �strr ) r r� r* rI r� rJ r r^ �
child_namer� r� s r r� �,FakeResource._check_attribute_representation� s] � � �*�*�E�E�f�M�� (�.�.�~�>�
�>��
�J�J�� �>� �
� �$� $�� .� � 3� 3�� 0�0�1� �M� /3�.I�.I� �/� +�J�+� �G�^�v�
%� � 3� 3�F�'�>�4J� K�M� � %� %�m� ;��J�J�t�$�E��}�$�^�d�%:�;�;��z�z�!�!�%��-�-�(�?D�d�K�� � .� ���~�-�!�%��2�2�(�9>��E�� � 3� .��/
s �D:c �� � X R ; a gUR R S5 nU< SU< 3n [ UR SU5 u nU$ ! [ a [ U< SU< 35 ef = f)a 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 )rl r� rG rK �
ValueErrorr )r r^ r* �
resource_namer� r� s r r� �FakeResource._get_method� s| � � �'�'� '� �%�)�)�-�-�d�3�
� )�4�0�� �,�]�->�->��f�M�L�Z�
��� � � �.2�M�B��
� �s �A � A.c �r � U" U0 UD6nXR ; d Uc U$ U R U R X5 $ )a� 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.
)rl �_create_resourcer[ )r r* rv rt ru ro s r rs �FakeResource._run_method� sA � � ��(��(�� �'�'� '�6�>��M��(�(��)<�)<�d�K� Kr c � � UR R S5 nXB:X a SnU R X5 nUc U$ [ US5 nXPR R
; a US-
nU R R
U nUR
S5 ( a, U R Xc5 u p'[ U R UUUU5 $ U R Xc5 [ U R U5 nUR 5 H u p�[ X�U
5 M U$ )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� rG z-fullz -resourcez-page-resource)
r� rG r} rR r �resource_typesrN r� r� rd r� r� r) ) r r^ r* ro r� r� �result_resource_typer� �resourcer� � child_values r r� � FakeResource._create_resource� s � � &�)�)�-�-�d�3�
� � ��D��-�-�m�B�� �>��M� �f�g�.�� �*�*�9�9� 9� �k� !�F� #� 0� 0� ?� ?�� G� � �?�?�+� ,� ,�(,�(C�(C�$�)� %�D� "��!�!�$���#� �
�
� %� %�&:� C� ��!2�!2�4H�I�H�+1�<�<�>�'�
���k�:� ,:��Or c �( � U R US5 nU R R U n[ UR SS5 u n[ U5 u nUR
S5 nUR S5 S nUU R R U5 4$ )a 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.
rG r* � entry_linksr^ �#� ) r} r r~ rK r� �listrG �splitr� )r r^ r� �representation_definitionr� �resource_type_url�resource_type_names r �_get_child_resource_type�%FakeResource._get_child_resource_type s� � � �-�-�m�U�C�� � � � 8� 8�� @� "� *� %� )� )�6�=�
�
�� �{�+�� � )� -� -�o� >�� .� 4� 4�S� 9�!� <�� � � � � /� /�0A� B�
�
r c �b � U R U5 u p4U H nU R XE5 M X44$ )aw 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� rd )r r^ r� r* r� �entrys r r� �FakeResource._check_entries s> � � %)�$A�$A� �%
�!�� �E� � %� %�&9� A� ��(�(r c �2 � U R R R S5 nSnU R R SU5 nU R R SU5 nSU R R
< SU< SU< S[
[ U 5 5 < S3 $ )z}
The resource type, identifier if available, and memory address are
used to generate a representation of this fake resource.
r� r6 r* �<� z at �>)r[ r� rG r] � __class__r
�hexr� )r r* �keys r �__repr__�FakeResource.__repr__1 sy � �
�"�"�&�&�*�*�4�0�����l�l� � �t�S�)���l�l� � �v�s�+�� �N�N� #� #� � � ��4��M�
�
r r rM )r
r r r
r rl r& r, r6 r1 rk rc r� rd r� r} r� r� r� rs r� r� r� r� r r r r rW rW � ss � � � !�k�O�
�(.�& )/�� �
�*�X
9�B�")�8
O�
B� (�T�*L�(% �N
�0)�$
r rW c �, ^ � \ rS rSrSrU 4S jrSrU =r$ )r iB z$Fake root object for an application.c �` >� UR UR S- 5 n[ TU ]
X5 g)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^ r� s �r r& �FakeRoot.__init__E s2 �� �
$�5�5� � "� "�_� 4�
�
� ����4r r )r
r r r
r r& r �
__classcell__�r� s @r r r B s �� �.�5� 5r r c � � \ rS rSrSrSrg)r� iP z A fake resource for an entry.r Nr r r r r� r� P s � �'r r� c �B ^ � \ rS rSrSr SU 4S jjrS rS rSrU =r $ )r� iT z!A fake resource for a collection.c �` >� [ TU ] XU5 U R R XES.5 g )N)�_name�_child_resource_type)r� r& r r )r r$ r^ r+ r* r� r� s �r r& �FakeCollection.__init__W s, �� � ����V�<� �
�
� � �� H�
r c # � # � U R R SS5 nU H, nU R U R U R U5 v � M. g7f)z;Iterate items if this resource has an C{entries} attribute.r� r N)r] rG r� r� r� )r r� r� s r �__iter__�FakeCollection.__iter__d sI � � ��,�,�"�"�9�b�1�� �E��'�'��)�)�4�:�:�u��
� �s �AAc �L � [ U 5 n[ U[ 5 ( aT UR =( d SnUR nUS: a [ S5 eUS: a [ S5 eUR
U5 $ [ U[ 5 ( a UR
U5 $ [ S5 e)z�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� ra �slice�start�stopr� � __getitem__�int�
IndexError)r r� r� r� r� s r r� �FakeCollection.__getitem__l s� � � �t�*�� �c�5� !� !��I�I�N��E��8�8�D��q�y� �O�� � �a�x� �-�� � �&�&�s�+� +�
��S�
!�
!��&�&�s�+� +� � @�A� Ar r )NNN)
r
r r r
r r& r� r� r r� r� s @r r� r� T s' �� �+� �
� �
��B� Br r� N)r �collections.abcr r � Exceptionr r rK rR rU rW r r� r� r r r �<module>r� sq ��&/�b %� �P�Y� P�X<� X<�vD�
� ?�
H
� H
�V 5�|� 5� (� � (�0B�\� 0Br