Merge pull request #621 from watson-developer-cloud/url-creds

chore(all services): Check for incorrect url and credentials

Author: ehdsouza

test/unit/test_watson_service.py

@@ -204,3 +204,16 @@ def test_response_with_no_body():
     assert response is not None
     assert len(responses.calls) == 1
     assert response.get_result() is None
+
+def test_has_bad_first_or_last_char():
+    with pytest.raises(ValueError) as err:
+        AnyServiceV1('2018-11-20', username='{username}', password='password')
+    assert str(err.value) == 'The username shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your username'
+
+    with pytest.raises(ValueError) as err:
+        AnyServiceV1('2018-11-20', iam_apikey='{apikey}')
+    assert str(err.value) == 'The credentials shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your credentials'
+
+    with pytest.raises(ValueError) as err:
+        AnyServiceV1('2018-11-20', iam_apikey='apikey', url='"url"')
+    assert str(err.value) == 'The URL shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your URL'

watson_developer_cloud/watson_service.py

@@ -147,6 +147,9 @@ def _convert_boolean_values(dictionary):
             [(k, _convert_boolean_value(v)) for k, v in dictionary.items()])
     return dictionary
 
+def _has_bad_first_or_last_char(str):
+    return str is not None and (str.startswith('{') or str.startswith('"') or str.endswith('}') or str.endswith('"'))
+
 def get_error_message(response):
     """
     Gets the error message from a JSON response.
@@ -236,6 +239,10 @@ def __init__(self, vcap_services_name, url, username=None, password=None,
         self.token_manager = None
         self.verify = None # Indicates whether to ignore verifying the SSL certification
 
+        if _has_bad_first_or_last_char(self.url):
+            raise ValueError('The URL shouldn\'t start or end with curly brackets or quotes. '
+                             'Be sure to remove any {} and \" characters surrounding your URL')
+
         user_agent_string = 'watson-apis-python-sdk-' + __version__ # SDK version
         user_agent_string += ' ' + platform.system() # OS
         user_agent_string += ' ' + platform.release() # OS version
@@ -281,6 +288,13 @@ def set_username_and_password(self, username=None, password=None):
         if password == 'YOUR SERVICE PASSWORD':
             password = None
 
+        if _has_bad_first_or_last_char(username):
+            raise ValueError('The username shouldn\'t start or end with curly brackets or quotes. '
+                             'Be sure to remove any {} and \" characters surrounding your username')
+        if _has_bad_first_or_last_char(password):
+            raise ValueError('The password shouldn\'t start or end with curly brackets or quotes. '
+                             'Be sure to remove any {} and \" characters surrounding your password')
+
         self.username = username
         self.password = password
         self.jar = CookieJar()
@@ -304,7 +318,9 @@ def set_api_key(self, api_key):
     def set_token_manager(self, iam_apikey=None, iam_access_token=None, iam_url=None):
         if iam_apikey == 'YOUR IAM API KEY':
             return
-
+        if _has_bad_first_or_last_char(iam_apikey):
+            raise ValueError('The credentials shouldn\'t start or end with curly brackets or quotes. '
+                             'Be sure to remove any {} and \" characters surrounding your credentials')
         self.iam_apikey = iam_apikey
         self.iam_access_token = iam_access_token
         self.iam_url = iam_url
@@ -320,6 +336,9 @@ def set_iam_access_token(self, iam_access_token):
         self.jar = CookieJar()
 
     def set_iam_apikey(self, iam_apikey):
+        if _has_bad_first_or_last_char(iam_apikey):
+            raise ValueError('The credentials shouldn\'t start or end with curly brackets or quotes. '
+                             'Be sure to remove any {} and \" characters surrounding your credentials')
         if self.token_manager:
             self.token_manager.set_iam_apikey(iam_apikey)
         else:
@@ -328,6 +347,9 @@ def set_iam_apikey(self, iam_apikey):
         self.jar = CookieJar()
 
     def set_url(self, url):
+        if _has_bad_first_or_last_char(url):
+            raise ValueError('The URL shouldn\'t start or end with curly brackets or quotes. '
+                             'Be sure to remove any {} and \" characters surrounding your URL')
         self.url = url
 
     def set_default_headers(self, headers):