fix: Combine multiple ending slashes to one

BREAKING CHANGE: Fixing the request URL like this will break compatibility with previous generator versions

Author: rmkeezer

ibm_cloud_sdk_core/base_service.py

@@ -26,7 +26,13 @@
 from requests.structures import CaseInsensitiveDict
 from ibm_cloud_sdk_core.authenticators import Authenticator
 from .version import __version__
-from .utils import has_bad_first_or_last_char, remove_null_values, cleanup_values, read_external_sources
+from .utils import (
+    has_bad_first_or_last_char,
+    remove_null_values,
+    cleanup_values,
+    read_external_sources,
+    strip_extra_slashes
+)
 from .detailed_response import DetailedResponse
 from .api_exception import ApiException
 from .token_manager import TokenManager
@@ -234,7 +240,6 @@ def send(self, request: requests.Request, **kwargs) -> DetailedResponse:
             logging.exception('Error in service call')
             raise
 
-
     def prepare_request(self,
                         method: str,
                         url: str,
@@ -272,7 +277,7 @@ def prepare_request(self,
         # validate the service url is set
         if not self.service_url:
             raise ValueError('The service_url is required')
-        request['url'] = self.service_url + url
+        request['url'] = strip_extra_slashes(self.service_url + url)
 
         headers = remove_null_values(headers) if headers else {}
         headers = cleanup_values(headers)

ibm_cloud_sdk_core/utils.py

@@ -68,6 +68,12 @@ def cleanup_value(value: any) -> any:
         return 'true' if value else 'false'
     return value
 
+def strip_extra_slashes(value: str) -> str:
+    """Combine multiple trailing slashes to a single slash"""
+    if value.endswith('//'):
+        return value.rstrip('/') + '/'
+    return value
+
 def datetime_to_string(val: datetime.datetime) -> str:
     """Convert a datetime object to string.
 

test/test_base_service.py

@@ -14,6 +14,7 @@
 from ibm_cloud_sdk_core.authenticators import (IAMAuthenticator, NoAuthAuthenticator, Authenticator,
                                                BasicAuthenticator, CloudPakForDataAuthenticator)
 from ibm_cloud_sdk_core import get_authenticator_from_environment
+from ibm_cloud_sdk_core.utils import strip_extra_slashes
 
 
 class IncludeExternalConfigService(BaseService):
@@ -518,27 +519,37 @@ def test_json():
     req = service.prepare_request('POST', url='', headers={'X-opt-out': True}, data={'hello': 'world'})
     assert req.get('data') == "{\"hello\": \"world\"}"
 
-# For v2.x this test expects to see trailing slashes, this should be changed in v3.x
 def test_trailing_slash():
-    service = AnyServiceV1('2018-11-20', service_url='https://trailingSlash.com/', authenticator=NoAuthAuthenticator())
-    assert service.service_url == 'https://trailingSlash.com/'
-    service.set_service_url('https://trailingSlash.com/')
-    assert service.service_url == 'https://trailingSlash.com/'
+    assert strip_extra_slashes('') == ''
+    assert strip_extra_slashes('//') == '/'
+    assert strip_extra_slashes('/////') == '/'
+    assert strip_extra_slashes('https://host') == 'https://host'
+    assert strip_extra_slashes('https://host/') == 'https://host/'
+    assert strip_extra_slashes('https://host//') == 'https://host/'
+    assert strip_extra_slashes('https://host/path') == 'https://host/path'
+    assert strip_extra_slashes('https://host/path/') == 'https://host/path/'
+    assert strip_extra_slashes('https://host/path//') == 'https://host/path/'
+    assert strip_extra_slashes('https://host//path//') == 'https://host//path/'
+
+    service = AnyServiceV1('2018-11-20', service_url='https://host/', authenticator=NoAuthAuthenticator())
+    assert service.service_url == 'https://host/'
+    service.set_service_url('https://host/')
+    assert service.service_url == 'https://host/'
     req = service.prepare_request('POST',
-                                  url='/trailingSlashPath/',
+                                  url='/path/',
                                   headers={'X-opt-out': True},
                                   data={'hello': 'world'})
-    assert req.get('url') == 'https://trailingSlash.com//trailingSlashPath/'
+    assert req.get('url') == 'https://host//path/'
 
-    service = AnyServiceV1('2018-11-20', service_url='https://trailingSlash.com/', authenticator=NoAuthAuthenticator())
-    assert service.service_url == 'https://trailingSlash.com/'
-    service.set_service_url('https://trailingSlash.com/')
-    assert service.service_url == 'https://trailingSlash.com/'
+    service = AnyServiceV1('2018-11-20', service_url='https://host/', authenticator=NoAuthAuthenticator())
+    assert service.service_url == 'https://host/'
+    service.set_service_url('https://host/')
+    assert service.service_url == 'https://host/'
     req = service.prepare_request('POST',
                                   url='/',
                                   headers={'X-opt-out': True},
                                   data={'hello': 'world'})
-    assert req.get('url') == 'https://trailingSlash.com//'
+    assert req.get('url') == 'https://host/'
 
     service.set_service_url(None)
     assert service.service_url is None
@@ -551,7 +562,7 @@ def test_trailing_slash():
                                   url='/',
                                   headers={'X-opt-out': True},
                                   data={'hello': 'world'})
-    assert req.get('url') == '//'
+    assert req.get('url') == '/'
 
 def test_service_url_not_set():
     service = BaseService(service_url='', authenticator=NoAuthAuthenticator())