context improvements, attachmennts convenience methods

Author: klehman-rally

build_dist.py

@@ -11,7 +11,7 @@
 import zipfile
 
 PACKAGE_NAME = "pyral"
-VERSION      = "0.8.12"
+VERSION      = "0.9.1"
 
 AUX_FILES  = ['MANIFEST.in', 
               'LICENSE', 
@@ -25,7 +25,14 @@
               'periscope.py', 
               'showdefects.py', 
               'crtask.py', 
-              'uptask.py'
+              'uptask.py',
+              'statecounts.py',
+              'repoitems.py',
+              'typedefs.py',
+              'wkspcounts.py',
+              'builddefs.py',
+              'creattach.py',
+              'get_attachments.py',
              ]
 DOC_FILES  = ['doc/Makefile',
               'doc/source/conf.py',
@@ -47,9 +54,12 @@
 # The TEST_FILES are **NOT** placed into the distribution packages
 #
 TEST_FILES = ['test/test_conn.py',
-              'test/test_query.py',
-              'test/test_inflation.py',
+              'test/test_context.py',
               'test/test_convenience.py',
+              'test/test_inflation.py',
+              'test/test_query.py',
+              'test/test_wksprj_setting.py',
+              'test/test_attachments.py',
              ]
 
 ################################################################################

dists/pyral-0.9.1.tar.gz

@@ -353,6 +353,40 @@ pyral.Rally instance convenience methods
     Given an entityName and and attributeName (assumed to be valid for the entityName)
     issue a request to obtain a list of allowed values for the attribute.
 
+.. method:: addAttachment(artifact, filename, mime_type='text/plain')
+
+    Given an artifact (actual or FormattedID for an artifact), validate that
+    it exists and then attempt to add an Attachment with the name and
+    contents of filename into Rally and associate that Attachment with the
+    Artifact.
+
+.. method:: addAttachments(artifact, attachments)
+
+    Given an artifact (either actual or FormattedID) and a list of dicts with
+    each dict having keys and values for name (or Name), mime_type (or MimeType) and
+    content_type (or ContentType), add an Attachment corresponding to each dict in 
+    the attachments list and associate it with the referenced Artifact.
+
+.. method:: getAttachment(artifact, filename)
+
+    Given a real artifact instance or the FormattedID of an existing artifact,
+    obtain the attachment named by filename.  If there is such an attachment,
+    return an Attachment instance with hydration for  Name, Size, ContentType, Content,
+    CreationDate and the User that supplied the attachment.
+    If no such attachment is present, return None
+
+.. method:: getAttachmentNames(artifact)
+
+    Given a real artifact instance that is hydrated for at least the Attachments attribute,
+    return the names (filenames) of the Attachments associated with the artifact.
+
+.. method:: getAttachments(artifact)
+
+    Given a real artifact instance, return a list of Attachment records.
+    Each Attachment record will look like a Rally WSAPI Attachment with
+    the additional Content attribute that will contain the decoded AttachmentContent.
+
+    
 
 RallyRESTResponse
 =================

dists/pyral-0.9.1.zip

@@ -1,4 +1,4 @@
-__version__ = (0, 8, 12)
+__version__ = (0, 9, 1)
 from .config    import rallySettings
 from .restapi   import Rally, RallyRESTAPIError, RallyUrlBuilder
 from .rallyresp import RallyRESTResponse

doc/source/interface.rst

@@ -6,7 +6,7 @@
 #
 ###################################################################################################
 
-__version__ = (0, 8, 12)
+__version__ = (0, 9, 1)
 
 import datetime
 import os
@@ -19,7 +19,7 @@
 PROTOCOL       = "https"
 SERVER         = "rally1.rallydev.com"
 WEB_SERVICE    = "slm/webservice/%s"
-WS_API_VERSION = "1.29"
+WS_API_VERSION = "1.30"
 JSON_FORMAT    = ".js"
 
 USER_NAME = "wiley@acme.com"

pyral/__init__.py

@@ -8,9 +8,9 @@
 #
 ###################################################################################################
 
-__version__ = (0, 8, 12)
+__version__ = (0, 9, 1)
 
-import sys
+import sys, os
 import time
 import socket
 import json
@@ -117,40 +117,52 @@ def check(self, server):
             and speaks Rally WSAPI, and establishes the default workspace and project for
             the user.
         """
-        target_host = server
+##
+##        print " RallyContextHelper.check starting ..."
+##        sys.stdout.flush()
+##
         socket.setdefaulttimeout(REQUEST_TIME_LIMIT)
-        if IPV4_ADDRESS_PATT.match(server):  # is server an IPV4 address?
+        target_host = server
+
+        big_proxy   = os.environ.get('HTTPS_PROXY', False)
+        small_proxy = os.environ.get('https_proxy', False)
+        proxy = big_proxy if big_proxy else small_proxy if small_proxy else False
+        proxy_host = False
+        if proxy:
+            proxy_host, proxy_port = proxy.split(':')
+        target_host = proxy_host or server
+
+        if IPV4_ADDRESS_PATT.match(target_host):  # is server an IPV4 address?
             try:
-                info = socket.gethostbyaddr(server)
+                info = socket.gethostbyaddr(target_host)
             except socket.herror, msg:
-                problem = "IP v4 address '%s' not valid or unreachable" % server
+                problem = "IP v4 address '%s' not valid or unreachable" % target_host
                 raise RallyRESTAPIError(problem)
             except Exception, msg:
                 print "Exception detected: %s" % msg
-                problem = "Exception detected trying to obtain host info for: %s" % server
+                problem = "Exception detected trying to obtain host info for: %s" % target_host
                 raise RallyRESTAPIError(problem)
 
         # TODO: look for IPV6 type address also?
+
         else:
             try:
-                target_host = socket.gethostbyname(server)
+                target_host = socket.gethostbyname(target_host)
             except socket.gaierror, msg:
-                problem = "hostname '%s' non-existent or unreachable"  % server
+                problem = "hostname: '%s' non-existent or unreachable"  % target_host
                 raise RallyRESTAPIError(problem)
 
-##
-##        print " RallyContextHelper.check starting ..."
-##        sys.stdout.flush()
-##
         # note the use of the _disableAugments keyword arg in the call
         user_name_query = 'UserName = "%s"' % self.user
         try:
             timer_start = time.time()
-            response = self.agent.get('User', fetch=True, query=user_name_query, _disableAugments=True)
+            response = self.agent.get('User', fetch=True, query=user_name_query, 
+                                      _disableAugments=True)
             timer_stop = time.time()
         except Exception, msg:
             if str(msg).startswith('404 Service unavailable'):
-                raise RallyRESTAPIError("hostname '%s' non-existent or unreachable" % server)
+                # TODO: discern whether we should mention server or target_host as the culprit
+                raise RallyRESTAPIError("hostname: '%s' non-existent or unreachable" % server)
             else:
                 raise 
         elapsed = timer_stop - timer_start
@@ -162,6 +174,8 @@ def check(self, server):
             if response.status_code == 404:
                 if elapsed >= float(REQUEST_TIME_LIMIT):
                     problem = "Request timed out on attempt to reach %s" % server
+                elif response.errors and 'Max retries exceeded with url' in response.errors[0]:
+                    problem = "Target Rally host: '%s' non-existent or unreachable" % server
                 elif response.errors and 'NoneType' in response.errors[0]:
                     problem = "Target Rally host: '%s' non-existent or unreachable" % server
                 else:

pyral/config.py

@@ -8,9 +8,10 @@
 #
 ###################################################################################################
 
-__version__ = (0, 8, 12)
+__version__ = (0, 9, 1)
 
 import sys
+import re
 
 from .restapi   import hydrateAnInstance
 from .restapi   import getResourceByOID
@@ -101,9 +102,6 @@ def __getattr__(self, name):
             if response.status_code != 200:
                 raise UnreferenceableOIDError, ("%s OID %s" % (rallyEntityTypeName, self.oid))
             item = response.content[rallyEntityTypeName]
-            #del item[u'Errors']     # this cruft from REST GET not actually part of the entity's attributes
-            #del item[u'Warnings']   # ditto
-
 ##
 ##            print "calling hydrateAnInstance from the __getattr__ of %s for %s" % (name, self._type)
 ##            sys.stdout.flush()
@@ -126,13 +124,14 @@ def __getattr__(self, name):
 
 class Subscription(Persistable):  pass
 
+class AllowedAttributeValue(Persistable):  pass  # only used in an AttributeDefinition
+class AllowedQueryOperator (Persistable):  pass  # only used in an AttributeDefinition 
+                                                 #  (for AllowedQueryOperators)
+
 class DomainObject(Persistable):
     """ This is an Abstract Base class """
     pass
 
-class AllowedAttributeValue(Persistable):  pass  # only used in an AttributeDefinition
-class AllowedQueryOperator (Persistable):  pass  # only used in an AttributeDefinition (for AllowedQueryOperators)
-
 class User            (DomainObject): pass
 class UserProfile     (DomainObject): pass
 class Workspace       (DomainObject): pass
@@ -142,8 +141,75 @@ class WorkspacePermission   (UserPermission): pass
 class ProjectPermission     (UserPermission): pass
 
 class WorkspaceDomainObject(DomainObject):
-    """ This is an Abstract Base class """
-    pass
+    """ 
+        This is an Abstract Base class, with a convenience method (details) that  
+        formats the attrbutes and corresponding values into an easily viewable
+        mulitiline string representation.
+    """
+    COMMON_ATTRIBUTES = ['_type', 
+                         'ObjectID', '_ref', '_CreatedAt', 
+                         'oid', 'ref', '_hydrated', 
+                         'Name', 'Subscription', 'Workspace'
+                        ]
+
+    def details(self):
+        """
+            order we want to have the attributes appear in...
+
+            Class Name (aka _type)
+                oid
+                ref
+                _ref
+                _hydrated
+                _CreatedAt
+                ObjectID
+                Name         ** not all items will have this...
+                Subscription (oid, Name)
+                Workspace    (oid, Name)
+
+                alphabetical from here on out
+        """
+        tank = ['%s' % self._type]
+        for attribute_name in self.COMMON_ATTRIBUTES[1:]:
+            value = getattr(self, attribute_name)
+            if 'pyral.entity.' not in str(type(value)):
+                anv = '    %-16.16s  : %s' % (attribute_name, value)
+            else:
+                mo = re.search(r' \'pyral.entity.(\w+)\'>', str(type(value)))
+                if mo:
+                    cln = mo.group(1)
+                    anv = "    %-16.16s  : %-16.16s   (OID  %s  Name: %s)" % \
+                          (attribute_name, cln + '.ref', value.oid, value.Name)
+                else:
+                    anv = "    %-16.16s  : %s" % value
+            tank.append(anv)
+        tank.append("")
+        other_attributes = set(self.attributes()) - set(self.COMMON_ATTRIBUTES)
+        for attribute_name in sorted(other_attributes):
+            value = getattr(self, attribute_name)
+            if not isinstance(value, Persistable):
+                anv = "    %-16.16s  : %s" % (attribute_name, value)
+            else:
+                mo = re.search(r' \'pyral.entity.(\w+)\'>', str(type(value)))
+                if not mo:
+                    anv = "    %-16.16s : %s" % (attribute_name, value)
+                    continue
+
+                cln = mo.group(1)
+                anv = "    %-16.16s  : %-27.27s" % (attribute_name, cln + '.ref')
+                if   isinstance(value, Artifact):
+                    # also want the OID, FormattedID
+                    anv = "%s (OID  %s  FomattedID  %s)" % (anv, value.oid, value.FormattedID)
+                elif isinstance(value, User):
+                    # also want the className, OID, UserName, DisplayName
+                    anv = "    %-16.16s  : %s.ref  (OID  %s  UserName %s  DisplayName %s)" % \
+                          (attribute_name, cln, value.oid, value.UserName, value.DisplayName)
+                else:
+                    # also want the className, OID, Name)
+                    anv = "%s (OID  %s  Name %s)" % (anv, value.oid, value.Name)
+            tank.append(anv)
+        return "\n".join(tank)
+
 
 class WorkspaceConfiguration(WorkspaceDomainObject): pass
 class Type                  (WorkspaceDomainObject): pass

pyral/context.py

@@ -9,7 +9,7 @@
 #
 ###################################################################################################
 
-__version__ = (0, 8, 12)
+__version__ = (0, 9, 1)
 
 import types
 from pprint import pprint

pyral/entity.py

@@ -10,7 +10,7 @@
 #
 ###################################################################################################
 
-__version__ = (0, 8, 12)
+__version__ = (0, 9, 1)
 
 import sys
 import re