disqualifed a bunch of standard attributes of type COLLECTION when retrieving allowed values in SchemaItem.complate, modified allowedValues test for Story.Milestone, modified allowedValues.py example script, added zip of online docs into the build_dist.py script.

klehman-rally · klehman-rally · commit 43d7598b0e6e · 2017-04-04T14:41:13.000-06:00
diff --git a/build_dist.py b/build_dist.py
@@ -111,6 +111,11 @@ def main(args):
     store_packages('dist',  [tarball])
     store_packages('dists', [tarball, zipped])
 
+    doc_dir = 'doc/build/html'
+    doc_files = [path.split('/')[-1] for path in DOC_FILES if path.startswith(doc_dir)]
+    webdocs_zip = make_online_docs_zipfile(PACKAGE_NAME, VERSION, doc_dir, doc_files)
+    store_packages('dist', webdocs_zip)
+
 ################################################################################
 
 def store_packages(subdir, files):
@@ -220,6 +225,25 @@ def make_tarball(pkg_name, pkg_version, base_files, example_files, doc_files):
 
 ################################################################################
 
+def make_online_docs_zipfile(pkg_name, pkg_version, doc_dir, doc_files):
+    zf_name = '%s-%s.docs.html.zip' % (pkg_name, pkg_version)
+    cur_dir = os.getcwd()
+    os.chdir(doc_dir)
+    zf = zipfile.ZipFile(zf_name, 'w')
+    for fn in doc_files:
+        zf.write(fn, fn, zipfile.ZIP_DEFLATED)
+    zf.close()
+
+    ##  The following is what has been done before on the command line, when you
+    ## get the recursion opt on the above logic you can drop the os.system call
+    os.system("zip %s -r %s" % (zf_name, " ".join(doc_files)))
+    ##
+
+    os.chdir(cur_dir)
+    return zf_name
+
+################################################################################
+
 def make_zipfile(pkg_name, pkg_version, base_files, example_files, doc_files):
     base_dir = '%s-%s' % (pkg_name, pkg_version)
 
diff --git a/examples/allowedValues.py b/examples/allowedValues.py
@@ -45,7 +45,7 @@ def main(args):
 
     #rally = Rally(server, user, password, apikey=apikey, workspace=workspace, project=project, server_ping=False)
     rally = Rally(server, user, password, apikey=apikey,server_ping=False)
-    rally.enableLogging('rally.hist.avl')  # name of file you want the logging to go to
+    #rally.enableLogging('rally.hist.avl')  # name of file you want the logging to go to
 
     target = entity
     if entity in ['Story', 'User Story', 'UserStory']:
@@ -67,20 +67,22 @@ def main(args):
         print("Warnings: %s" % response.warnings)
     td = response.next()
 
-    for attribute in td.Attributes:
+    std_attributes    = sorted([attr for attr in td.Attributes if attr.ElementName[:2] != 'c_'], key=lambda x: x.ElementName)
+    custom_attributes = sorted([attr for attr in td.Attributes if attr.ElementName[:2] == 'c_'], key=lambda x: x.ElementName)
+    all_attributes = std_attributes + custom_attributes
+    for attribute in all_attributes:
         attr_name = attribute.Name.replace(' ', '')
         if attributes and attr_name not in attributes:
             continue
 
-        if attribute.AttributeType not in ['STATE', 'RATING', 'STRING']:
+        if attribute.AttributeType not in ['STATE', 'RATING', 'STRING', 'COLLECTION']:
             continue
 
         allowed_values = rally.getAllowedValues(target, attr_name)
-        if not allowed_values:
-            continue
-        print("    %-28.28s    (%s)" % (attr_name, attribute.AttributeType))
-        for av in allowed_values:
-            print("        |%s|" % av)
+        if allowed_values:
+            print("    %-28.28s    (%s)" % (attr_name, attribute.AttributeType))
+            for av in allowed_values:
+                print("        |%s|" % av)
 
 #################################################################################################
 #################################################################################################
diff --git a/pyral/entity.py b/pyral/entity.py
@@ -618,7 +618,7 @@ def __setattr__(self, item, value):
 
 for entity_name, entity_class in list(classFor.items()):
     _rally_entity_cache[entity_name] = entity_name
-entity_class = None # reset...
+entity_class = None  # reset...
 
 # now stuff whatever other classes we've defined in this module that aren't already in 
 # _rally_entity_cache
@@ -678,22 +678,25 @@ def complete(self, context, getCollection):
             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.
+            attributes like 'State', 'Severity', etc.,  AND in many cases the values are
+            on a per specific artifact/entity basis rather than values eligible for the
+            artifact/entity on a workspace-wide basis.
             Sequence through each Attribute and call resolveAllowedValues for each Attribute.
         """
+        NON_ELIGIBLE_ALLOWED_VALUES_ATTRIBUTES = \
+            [ 'Artifacts', 'Attachments', 'Changesets', 'Children', 'Collaborators',
+              'Defects', 'DefectSuites', 'Discussion', 'Duplicates', 'Milestone',
+              'Iteration', 'Release', 'Project',
+              'Owner', 'SubmittedBy', 'Predecessors', 'Successors',
+              'Tasks', 'TestCases', 'TestSets', 'Results', 'Steps', 'Tags',
+            ]
+
         if self.completed:
             return True
         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
+            if attribute.ElementName in NON_ELIGIBLE_ALLOWED_VALUES_ATTRIBUTES:
+               continue
             attribute.resolveAllowedValues(context, getCollection)
 
         self.completed = True
@@ -760,8 +763,8 @@ def __init__(self, attr_info):
         self.ElementName   = str(attr_info['ElementName'])
         self.Name          = str(attr_info['Name'])
         self.AttributeType = str(attr_info['AttributeType'])
-        self.Subscription  =     attr_info.get('Subscription', None) # not having 'Subscription' should be rare
-        self.Workspace     =     attr_info.get('Workspace', None) # apparently only custom fields will have a 'Workspace' value
+        self.Subscription  =     attr_info.get('Subscription', None)  # not having 'Subscription' should be rare
+        self.Workspace     =     attr_info.get('Workspace', None)     # apparently only custom fields will have a 'Workspace' value
         self.Custom        =     attr_info['Custom']
         self.Required      =     attr_info['Required']
         self.ReadOnly      =     attr_info['ReadOnly']
diff --git a/test/rally_targets.py b/test/rally_targets.py
@@ -1,49 +1,58 @@
 
-AGICEN = "liart.rallydev.com"
-PROD   = "officialness.rallydev.com"
-
-AGICEN_USER = "usernumbernonei@acme.com"
-AGICEN_PSWD = "B1G^S3Kretz"
-AGICEN_NICKNAME = "Wiley"
-API_KEY = "_ABC123DEF456GHI789JKL012MNO345PQR678STU901VWXZ"
-
-DEFAULT_WORKSPACE    = "Your Default Workspace"
-DEFAULT_PROJECT      = "Your Default Project"
-NON_DEFAULT_PROJECT  = "A non-default Project"
-ALTERNATE_WORKSPACE  = "An Alternate Workspace"
-#ALTERNATE_PROJECT   = "Dynamic"
-ALTERNATE_PROJECT    = "An Alternate Project"
-
-BOONDOCKS_WORKSPACE  = 'Darwin Social Club'
-BOONDOCKS_PROJECT    = 'Linoleum Blast'
-
-PROJECT_SCOPING_TREE = {
-    'TOP_LEVEL_PROJECT' : {'Arctic Elevation' :
-                               [ 'My ship is stuck and I cant get out!',
+AGICEN = "rally1.rallydev.com"
+PROD   = "rally1.rallydev.com"
+
+AGICEN_USER     = "yodel@rallydev.com"
+AGICEN_PSWD     = "Vistabahn"
+AGICEN_NICKNAME = "Yodel"
+API_KEY         = "_x6CZhqQgiist6kTtwthsAAKHtjWE7ivqimQdpP3T4"
+
+YETI_USER    = "yeti@rallydev.com"
+YETI_PSWD    = "Vistabahn"
+YETI_NAME    = "Yeti"
+
+DEFAULT_WORKSPACE = "AC WSAPI Toolkit Python"
+DEFAULT_PROJECT   = "Sample Project"
+
+NON_DEFAULT_PROJECT = "My Project"
+
+ALTERNATE_WORKSPACE = "Kip's Playground"
+ALTERNATE_PROJECT   = "Argonaut"
+
+BOONDOCKS_WORKSPACE = 'Alligators BLD Unigrations'
+BOONDOCKS_PROJECT   = 'Sandbox'
+
+LARGE_WORKSPACE         = 'Rally'
+LARGE_PROJECT_TREE_BASE = 'Rally'
+
+PROD_USER = "kip@closedprojects.com"
+PROD_PSWD = "TwinLakes55"
+
+ACCOUNT_WITH_NO_DEFAULTS_CREDENTIALS = ('nick@denver.com', 'P@$$w0rd')
+
+PROJECT_SCOPING_TREE  = {
+    'TOP_LEVEL_PROJECT' : { 'Arctic Elevation' :
+                                ['My ship is stuck and I cant get out',
                                  'Lurking under the water is 300 megatons of payback',
                                  'Narwhal beaks carry the flag of the GWN tribe',
-                                 'Fear the winter, play in the summer on the floes'
-                               ]
+                                 'Fear the winter, play in the summer on the floes',
+                                ]
                           },
-    'SUB_PROJECTS'     : { 'Aurora Borealis' :
-                               [ 'Wavy Green Noodles', 'Astral Shock Treatment' ],
-                           'Sub Arctic Conditions' :
-                               [ 'Look at the salmon run',
+    'SUB_PROJECTS'      : { 'Aurora Borealis'  :
+                                ['Wavy Green Noodles', 'Astral Shock Treatment'],
+                            'Sub Arctic Conditions' :
+                                ['Look at the salmon run',
                                  'Provide bears with polaroid medicine',
-                                 'The wolf boy needs to howl at the moon',
-                               ]
-                         },
-    'BOTTOM_PROJECT' :   { 'Bristol Bay Barons' :
-                               ['Sealskin lap belt grinder', 'Shiny metal pieces']
-                         }
+                                 'The wolf boy needs to howl at the moon'
+                                ],
+                          },
+    'BOTTOM_PROJECT'    : { 'Bristol Bay Barons' :
+                             ['Sealskin lap belt grinder', 'Shiny metal pieces']
+                          },
 }
 
-ACCOUNT_WITH_NO_DEFAULTS_CREDENTIALS = ('mortel.e.woonded@torso00bam.com', 'T2Y*&9mm409')
-
-
 HTTPS_PROXY = "127.0.0.1:3128"
 
 __all__ = [AGICEN, AGICEN_USER, AGICEN_PSWD, AGICEN_NICKNAME, PROD,
-           DEFAULT_WORKSPACE, DEFAULT_PROJECT, 
-           NON_DEFAULT_PROJECT, ALTERNATE_WORKSPACE, ALTERNATE_PROJECT, 
-           PROJECT_SCOPING_TREE, HTTPS_PROXY]
+           DEFAULT_WORKSPACE, DEFAULT_PROJECT,
+           NON_DEFAULT_PROJECT, ALTERNATE_WORKSPACE, ALTERNATE_PROJECT, HTTPS_PROXY]
diff --git a/test/test_allowed_values.py b/test/test_allowed_values.py
@@ -13,8 +13,7 @@
 
 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"
+from rally_targets import LARGE_WORKSPACE, LARGE_PROJECT_TREE_BASE
 
 ##################################################################################################
 
@@ -27,25 +26,37 @@ def test_getAllowedValues_query():
     avs = rally.getAllowedValues('Defect', 'State')
     assert len(avs) > 0
     assert len(avs) >= 4
-    assert 'Open' in avs
+    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 'Red'     in avs
     assert 'Magenta' in avs
 
 
-def test_getAllowedValues_for_UserStory():
+def test_getAllowedValues_for_UserStory_Milestone():
     """
         Using a known valid Rally server and known valid access credentials,
         request allowed value information for the Milestones field of the UserStory entity.
+        The Milestones field is a standard field of schema type COLLECTION whose value
+        is entirely context dependent on the specific artifact so getting allowed values
+        doesn't really make sense in the same way as an attribute like State or Severity
+        that has a finite set of possible values that are the same for every Story or Defect
+        in the workspace.  Because of that characteristic, we return no allowed values for
+        the Milestones attribute on the Story type.  There are numerous other standard attributes
+        with the same sort of semantic that are excluded from chasing the COLLECTION url and
+        returning some list of values.  (like, Changesets, Discussions, Tags, etc.)
     """
-    rally = Rally(server=AGICEN, user=AGICEN_USER, password=AGICEN_PSWD)
-    avs = rally.getAllowedValues('Story', 'Milestones')
-    assert len(avs) == 1
-    assert avs == [True]
+    rally = Rally(server=AGICEN, apikey=API_KEY)
+    response = rally.get('Milestone', fetch=True, workspace=LARGE_WORKSPACE,
+                           project=LARGE_PROJECT_TREE_BASE, projectScopeDown=True)
+    milestones = [item for item in response]
+    assert len(milestones) > 150
+
+    avs = rally.getAllowedValues('Story', 'Milestone')
+    assert avs is None
 
 
 def test_getAllowedValues_for_custom_collections_field_Defect():
