mod to logic concerning allowedValues in restapi.py and entity.py, split out allowedValues tests to separate file

Author: klehman-rally

pyral/entity.py

@@ -674,13 +674,26 @@ def complete(self, context, getCollection):
         """
             This method is used to trigger the complete population of all Attributes,
             in particular the resolution of refs to AllowedValues that are present after
-            the instantation of each Attribute.  
+            the instantiation of each Attribute.
+            There are some standard attributes whose type is COLLECTION that are not to be
+            treated as "allowedValue" eligible; for the reason that the collections may be
+            arbitrarily large and more frequently updated as opposed to more "normal"
+            attributes like 'State', 'Severity', etc.
             Sequence through each Attribute and call resolveAllowedValues for each Attribute.
         """
         if self.completed:
             return True
-        for attribute in sorted([attr for attr in self.Attributes if attr.AttributeType in ['RATING', 'STATE']]):
+        for attribute in sorted([attr for attr in self.Attributes if attr.AttributeType in ['RATING', 'STATE', 'COLLECTION']]):
             # only an attribute whose AttributeType is RATING or STATE will have allowedValues
+            if attribute.ElementName in [ 'Attachments', 'Changesets', 'Children', 'Collaborators',
+                                          'Defects', 'DefectSuites', 'Discussion', 'Duplicates',
+                                          'Release', 'Iteration', 'Milestones',
+                                          'Owner', 'Predecessors', 'Project', 'SubmittedBy',
+                                          'Successors', 'Tasks', 'TestCases', 'TestSets', 'Results',
+                                          'Steps',
+                                          'Tags',
+                                          ]:
+                continue
             attribute.resolveAllowedValues(context, getCollection)
 
         self.completed = True

pyral/restapi.py

@@ -1529,11 +1529,12 @@ def getAllowedValues(self, entityName, attributeName, **kwargs):
             avs = attribute.resolveAllowedValues(context, getCollection)
             if type(avs) not in collection_types:
                 return [avs]
-            return [av.StringValue for av in avs]
+            return [getattr(av, 'LocalizedStringValue', getattr(av, 'StringValue')) for av in avs]
 
         # suggested by Scott Vitale to address issue in Rally WebServices response 
         #   (sometimes value is present, other times StringValue must be used)
-        return [av.StringValue for av in attribute.AllowedValues]
+        avs = attribute.AllowedValues
+        return [getattr(av, 'LocalizedStringValue', getattr(av, 'StringValue')) for av in avs]
 
 
     def addAttachment(self, artifact, filename, mime_type='text/plain'):

test/test_allowed_values.py

@@ -0,0 +1,60 @@
+#!/usr/local/bin/python2.7
+
+import sys, os
+import types
+import py
+
+import pyral
+from pyral import Rally
+
+RallyRESTAPIError = pyral.context.RallyRESTAPIError
+
+##################################################################################################
+
+from rally_targets import AGICEN, AGICEN_USER, AGICEN_PSWD
+from rally_targets import API_KEY
+
+EXAMPLE_ATTACHMENT_CONTENT = "The quck brown fox eluded the lumbering sloth\n"
+
+##################################################################################################
+
+def test_getAllowedValues_query():
+    """
+        Using a known valid Rally server and known valid access credentials,
+        request allowed value information for the State field of the Defect entity.
+    """
+    rally = Rally(server=AGICEN, user=AGICEN_USER, password=AGICEN_PSWD)
+    avs = rally.getAllowedValues('Defect', 'State')
+    assert len(avs) > 0
+    assert len(avs) >= 4
+    assert 'Open' in avs
+    assert 'Closed' in avs
+
+    avs = rally.getAllowedValues('Defect', 'PrimaryColor')
+    assert len(avs) > 0
+    assert len(avs) >= 6 and len(avs) <= 8
+    assert 'Red' in avs
+    assert 'Magenta' in avs
+
+
+def test_getAllowedValues_for_UserStory():
+    """
+        Using a known valid Rally server and known valid access credentials,
+        request allowed value information for the Milestones field of the UserStory entity.
+    """
+    rally = Rally(server=AGICEN, user=AGICEN_USER, password=AGICEN_PSWD)
+    avs = rally.getAllowedValues('Story', 'Milestones')
+    assert len(avs) == 1
+    assert avs == [True]
+
+
+def test_getAllowedValues_for_custom_collections_field_Defect():
+    rally = Rally(server=AGICEN, apikey=API_KEY, workspace='Rally', project='Rally')
+    avs = rally.getAllowedValues('Defect', 'MobileOS')
+    assert len(avs) > 0
+    target_value = 'Android'
+    assert len([v for v in avs if v == target_value]) == 1
+
+##########################################################################################
+
+

test/test_convenience.py

@@ -91,34 +91,6 @@ def test_getAllUsers_query():
     assert len(everybody) > 0
     assert len([user for user in everybody if user.DisplayName == 'da Kipster']) == 1
 
-def test_getAllowedValues_query():
-    """
-        Using a known valid Rally server and known valid access credentials,
-        request allowed value information for the State field of the Defect entity.
-    """
-    rally = Rally(server=AGICEN, user=AGICEN_USER, password=AGICEN_PSWD)
-    avs = rally.getAllowedValues('Defect', 'State')
-    assert len(avs) > 0
-    assert len(avs) >= 4
-    assert 'Open' in avs
-    assert 'Closed' in avs
-
-    avs = rally.getAllowedValues('Defect', 'PrimaryColor')
-    assert len(avs) > 0
-    assert len(avs) >= 6 and len(avs) <= 8
-    assert 'Red' in avs
-    assert 'Magenta' in avs
-
-def test_getAllowedValues_for_UserStory():
-    """
-        Using a known valid Rally server and known valid access credentials,
-        request allowed value information for the Milestones field of the UserStory entity.
-    """
-    rally = Rally(server=AGICEN, user=AGICEN_USER, password=AGICEN_PSWD)
-    avs = rally.getAllowedValues('Story', 'Milestones')
-    assert len(avs) == 1
-    assert avs == [True]
-
 def test_typedef():
     """
         Using a known valid Rally server and known valid access credentials,
@@ -174,7 +146,6 @@ def test_getCollection():
 #test_getProject()
 #test_getUserInfo_query()
 #test_getAllUsers_query()
-#test_getAllowedValues_query()
 #test_typedef
 #test_getStates
 #test_getCollection