fixed enableLogging in restapi, updated the attachment tests, the conn tests and re-added support for 3.6 after confirming that 3.6, 3.7, 3.8 and 3.9 all pass the test suite

Author: klehman-rally

pyral/config.py

@@ -74,7 +74,7 @@ def rallyWorkset(args):
                                                     or --cfg=<config_file_name>
           3) ENV variable with location of rally-<version>.cfg --> RALLY_CONFIG
           4) current directory with rally-<version>.cfg
-          5) RALLY_SERVER, RALLY_USER_NAME, RALLY_PASSWORD, APIKEY, RALLY_WORKSPACE, RALLY_PROJECT, RALLY_PING env VARS
+          5) RALLY_SERVER, RALLY_USER_NAME, RALLY_PASSWORD, APIKEY, RALLY_WORKSPACE, RALLY_PROJECT env VARS
           6) SERVER, USER_NAME, PASSWORD defined in this module
 
         start by priming the return values with #6 and work your way up the priority ladder
@@ -122,7 +122,6 @@ def snarfSettings(targetFile, server_creds):
     # #5
     # if there are environment vars, use them
     #
-    # purposely excluding RALLY_PING, we'll recognize in the environment later, don't want to make it part of server_creds ...
     for ix, name in enumerate(['RALLY_SERVER', 'RALLY_USER', 'RALLY_PASSWORD', 'APIKEY', 'RALLY_WORKSPACE', 'RALLY_PROJECT']):
         if name in os.environ:
             server_creds[ix] = os.environ[name]

pyral/restapi.py

@@ -350,7 +350,7 @@ def enableLogging(self, dest=sys.stdout, attrget=False, append=False):
         self._log = True
         if hasattr(dest, 'write'):
             self._logDest = dest
-        elif type(dest) == bytes:
+        elif isinstance(dest, (str,bytes)):
             try:
                 mode = 'w'
                 if append:

setup.py

@@ -21,7 +21,7 @@
 desc_file = path.join(path.abspath(path.dirname(__file__)), FULL_DESCRIPTION)
 with open(desc_file, encoding='utf-8') as df: long_description = df.read()
 
-MINIMUM_REQUESTS_VERSION = '2.25.1'  # although 2.25.x is recommended
+MINIMUM_REQUESTS_VERSION = '2.25.1'
 REQUIRES      = ['six', 
                  'requests>=%s' % MINIMUM_REQUESTS_VERSION
                 ]
@@ -33,6 +33,7 @@
                    'License :: OSI Approved :: BSD License',
                    'Operating System :: OS Independent',
                    'Programming Language :: Python',
+                   'Programming Language :: Python :: 3.6',
                    'Programming Language :: Python :: 3.7',
                    'Programming Language :: Python :: 3.8',
                    'Programming Language :: Python :: 3.9',

test/test_attachments.py

@@ -16,14 +16,15 @@
 from rally_targets import DEFAULT_WORKSPACE, DEFAULT_PROJECT
 from rally_targets import YETI_USER, YETI_PSWD, YETI_NAME
 
-EXAMPLE_ATTACHMENT_CONTENT = "The quick brown fox eluded the lumbering sloth\n"
+EXAMPLE_ATTACHMENT_CONTENT = b'SERVER    = trial.rallydev.com\nUSER      = [email protected]\nPASSWORD  = RallyDev\nWORKSPACE = Primavera\nPROJECT   = Sample Project\n'
+EXAMPLE_TEXT_ATTACHMENT_CONTENT = "The quick brown fox eluded the lumbering sloth\n"
 
 ##################################################################################################
 
 def conjureUpAttachmentFile(filename, content=None, mimetype="text/plain"):
     """
     """
-    file_content = content or EXAMPLE_ATTACHMENT_CONTENT
+    file_content = content or EXAMPLE_TEXT_ATTACHMENT_CONTENT
     with open(filename, 'w') as af:
         af.write(file_content)
     return True
@@ -143,25 +144,26 @@ def test_add_attachment():
 def test_get_attachment():
     """
     """
-    #rally = Rally(server=RALLY, user=RALLY_USER, password=RALLY_PSWD)
     rally = Rally(server=RALLY, user=RALLY_USER, apikey=APIKEY)
-    candidate_story = "US2" # was this in trial -> "US80"
+    candidate_story = "US2"
     target = 'FormattedID = "%s"' % candidate_story
     response = rally.get("UserStory", fetch=True, query=target, project=None)
     assert response.resultCount == 1
     story = response.next()
-##
-    assert True == True
-    return True
-##
-    assert len(story.Attachments) == 1
-    attachment = story.Attachments[0]
-    expected_attachment_name = "Addendum.txt"
-    assert attachment.Name   == expected_attachment_name
+
+    atts = story.Attachments
+    assert len(atts) == 2
+    att1 = story.Attachments[0]
+    expected_attachment_name = "buster.cbq"
+    assert att1.Name  == expected_attachment_name
+
+    att2 = story.Attachments[1]
+    expected_attachment_name = 'prima.cfg'
+    assert att2.Name == expected_attachment_name
 
     attachment = rally.getAttachment(candidate_story, expected_attachment_name)
     assert attachment.Name    == expected_attachment_name
-    assert attachment.Content == EXAMPLE_ATTACHMENT_CONTENT
+    assert EXAMPLE_ATTACHMENT_CONTENT == attachment.Content
 
 def test_add_tcr_attachment():
     """
@@ -220,10 +222,10 @@ def test_add_tcr_attachment():
     actual_attachment_content = attachment.Content.decode('UTF-8').replace("\r", '')
     att_content               =        att.Content.decode('UTF-8').replace("\r", '')
 
-    assert actual_attachment_content == EXAMPLE_ATTACHMENT_CONTENT
-    assert               att_content == EXAMPLE_ATTACHMENT_CONTENT
-    #assert attachment.Content.decode('UTF-8') == EXAMPLE_ATTACHMENT_CONTENT
-    #assert att.Content.decode('UTF-8')        == EXAMPLE_ATTACHMENT_CONTENT
+    assert actual_attachment_content == EXAMPLE_TEXT_ATTACHMENT_CONTENT
+    assert               att_content == EXAMPLE_TEXT_ATTACHMENT_CONTENT
+    #assert attachment.Content.decode('UTF-8') == EXAMPLE_TEXT_ATTACHMENT_CONTENT
+    #assert att.Content.decode('UTF-8')        == EXAMPLE_TEXT_ATTACHMENT_CONTENT
     rally.deleteAttachment(tcr, attachment_name)
     rally.delete('TestCaseResult', tcr)
     rally.delete('TestCase', test_case)

test/test_conn.py

@@ -3,6 +3,7 @@
 import sys, os
 import types
 import py
+import pytest
 import time
 import re
 
@@ -101,7 +102,7 @@ def test_basic_connection_with_bad_api_key():
     """
     BOGUS_API_KEY = "_ABC123DEF456GHI789JKL012MNO345PQR678STUVZ"
     expectedErrMsg = 'Invalid credentials'
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(PROD, "[email protected]", "manict0X0", apikey=BOGUS_API_KEY)
     actualErrVerbiage = excinfo.value.args[0]
     assert excinfo.value.__class__.__name__ == 'RallyRESTAPIError'
@@ -117,7 +118,7 @@ def test_basic_connection_with_good_up_and_bad_api_key():
     """
     BOGUS_API_KEY = "_ABC123DEF456GHI789JKL012MNO345PQR678STUVZ"
     expectedErrMsg = 'Invalid credentials'
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(PROD, user=PROD_USER, password=PROD_PSWD, apikey=BOGUS_API_KEY)
     actualErrVerbiage = excinfo.value.args[0]
     assert expectedErrMsg == actualErrVerbiage
@@ -134,7 +135,7 @@ def test_nonexistent_server():
     bogus_server = "bogus.notreally.bug"
     expectedErrMsg = "Target Rally host: '%s' non-existent or unreachable" % bogus_server
     #print expectedErrMsg
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=bogus_server)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
     #print actualErrVerbiage
@@ -155,14 +156,12 @@ def test_non_rally_server():
     non_rally_server = 'www.irs.gov'
     #non_rally_server = 'www.espn.com'
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as exc:
         rally = Rally(server=non_rally_server, timeout=5)
-    print("Exception typename: %s" % excinfo.typename)
-    actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
-    print(actualErrVerbiage)
-    expectedErrMsg = "Target host: '%s' is either not reachable or " % non_rally_server
-    ex_value_mo = re.search(expectedErrMsg, actualErrVerbiage)
-    assert ex_value_mo is not None
+    print("Exception typename: %s" % exc.typename)
+    print(str(exc))
+    expected_error = "404 Target host: 'www.irs.gov' is either not reachable or doesn't support the Rally WSAPI"
+    assert expected_error in str(exc)
     time.sleep(1)
 
 
@@ -175,13 +174,13 @@ def test_bad_server_spec():
         The status_code in the response must indicate a non-success condition.
     """
     bad_server = "ww!w.\fo,o\r\n.c%om"
-    expectedErrMsg = "404 Target host: 'ww!w.\x0co,o\r\n.c%om' is either not reachable or doesn't support the Rally WSAPI"
+    expectedErrMsg = "host: 'ww!w.\x0co,o\r\n.c%om' is either not reachable or doesn't support the Rally WSAPI"
     print("expectedErrMesssage |{0}|".format(expectedErrMsg))
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as exc:
         rally = Rally(server=bad_server, timeout=3)
-    actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
+    actualErrVerbiage = exc.value.args[0]
     print("actualErrVerbiage   |{0}|".format(actualErrVerbiage))
-    assert actualErrVerbiage == expectedErrMsg
+    assert expectedErrMsg in actualErrVerbiage
     time.sleep(1)
 
 
@@ -200,7 +199,7 @@ def test_insuff_credentials():
     """
     expectedErrMsg = 'Invalid credentials'
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=RALLY, user=RALLY_USER, password="")
         response = rally.get('Project', fetch=False, limit=10)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
@@ -209,7 +208,7 @@ def test_insuff_credentials():
     #print "detected valid user, missing password condition"
     time.sleep(1)
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=RALLY, user="", password="doofus")
         response = rally.get('Project', fetch=False, limit=10)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
@@ -218,7 +217,7 @@ def test_insuff_credentials():
     #print "detected blank user, invalid password condition"
     time.sleep(1)
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=RALLY, user="", password="")
         response = rally.get('Project', fetch=False, limit=10)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
@@ -227,7 +226,7 @@ def test_insuff_credentials():
     #print "detected blank user and password condition"
     time.sleep(1)
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=RALLY, user="guest", password="")
         response = rally.get('Project', fetch=False, limit=10)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
@@ -236,7 +235,7 @@ def test_insuff_credentials():
     #print "detected invalid user, blank password condition"
     time.sleep(1)
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=RALLY, user="guest", password="doofus")
         response = rally.get('Project', fetch=False, limit=10)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(
@@ -245,7 +244,7 @@ def test_insuff_credentials():
     #print "detected invalid user, invalid password condition"
     time.sleep(1)
 
-    with py.test.raises(RallyRESTAPIError) as excinfo:
+    with pytest.raises(RallyRESTAPIError) as excinfo:
         rally = Rally(server=RALLY, user="guest")
         response = rally.get('Project', fetch=False, limit=10)
     actualErrVerbiage = excinfo.value.args[0]  # becuz Python2.6 deprecates message :-(

test/test_query.py

@@ -638,7 +638,7 @@ def test_query_between_range_operator():
         Query for CreatedDate between 2016-09-30T00:00:00Z and 2016-10-04T23:59:59.999Z'
         Should get 1 item
     """
-    # Use DEFAULT_WORKSPACE, DEFAULT_WORKSPACE
+    # Uses DEFAULT_WORKSPACE, DEFAULT_PROJECT
     rally = Rally(server=RALLY, user=RALLY_USER, password=RALLY_PSWD)
     response = rally.get('Story', fetch=True, pagesize=100, limit=100)
     all_stories = [item for item in response]
@@ -666,7 +666,7 @@ def test_query_not_between_range_operator():
         #assert result of query is has some elements less than date_1, and
         # has some greater than date_2 and none in the range specified
     """
-    # Use DEFAULT_WORKSPACE, DEFAULT_WORKSPACE
+    # Uses DEFAULT_WORKSPACE, DEFAULT_PROJECT
     rally = Rally(server=RALLY, user=RALLY_USER, password=RALLY_PSWD)
     range_start_date = '2016-09-30T00:00:00Z'
     range_end_date   = '2016-11-01T00:00:00Z'
@@ -680,7 +680,7 @@ def test_query_not_between_range_operator():
     assert after_date_stories
     assert len(prior_date_stories) + len(after_date_stories) == len(target_stories)
     tweener_stories     = [story for story in target_stories
-                           if story.CreationDate >= range_start_date
+                           if  story.CreationDate >= range_start_date
                            and story.CreationDate <= range_end_date]
     assert len(tweener_stories) == 0