GH-211 Fixed issue for datasets with '#' in URL

CHANGELOG.md

@@ -4,5 +4,8 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil
 
 ## Recent Changes
 
+- Bugfix: Fixed issue for datasets and jobs with special characters in URL [#211] (https://github.com/zowe/zowe-client-python-sdk/issues/211)
+
+
 - Feature: Added a CredentialManager class to securely retrieve values from credentials and manage multiple credential entries on Windows [#134](https://github.com/zowe/zowe-client-python-sdk/issues/134)
-- Feature: Added method to load profile properties from environment variables
+- Feature: Added method to load profile properties from environment variables

src/core/zowe/core_for_zowe_sdk/sdk_api.py

@@ -10,6 +10,7 @@
 Copyright Contributors to the Zowe Project.
 """
 
+import urllib
 from .exceptions import UnsupportedAuthType
 from .request_handler import RequestHandler
 from .session import Session, ISession
@@ -60,3 +61,14 @@ def _create_custom_request_arguments(self):
         dictionary creation
         """
         return self.request_arguments.copy()
+
+    def _encode_uri_component(self, str_to_adjust):
+        """Adjust string to be correct in a URL
+
+        Returns
+        -------
+        adjusted_str
+            A string with special characters, acceptable for a URL
+        """
+
+        return urllib.parse.quote(str_to_adjust, safe="!~*'()") if str_to_adjust is not None else None

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py

@@ -117,7 +117,7 @@
             A JSON with a list of dataset names (and attributes if specified) matching the given pattern.
         """
         custom_args = self._create_custom_request_arguments()
-        custom_args["params"] = {"dslevel": name_pattern}
+        custom_args["params"] = {"dslevel": self._encode_uri_component(name_pattern)}
         custom_args["url"] = "{}ds".format(self.request_endpoint)
 
 
@@ -149,7 +149,7 @@
         for k,v in additional_parms.items():
             url = "{}{}{}={}".format(url,separator,k,v)
             separator = '&'
-        custom_args['url'] = url
+        custom_args['url'] = self._encode_uri_component(url)
         custom_args["headers"]["X-IBM-Max-Items"]  = "{}".format(limit)
         custom_args["headers"]["X-IBM-Attributes"] = attributes
         response_json = self.request_handler.perform_request("GET", custom_args)
@@ -190,7 +190,7 @@
         path_to_member = f"{to_dataset_name}({to_member_name})" if to_member_name else to_dataset_name
         custom_args = self._create_custom_request_arguments()
         custom_args['json'] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, path_to_member)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(path_to_member))
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json
 
@@ -224,11 +224,11 @@
 
         data={
             "request":"copy",
-           "from-dataset":{
-               "dsn":from_dataset_name.strip(),
+            "from-dataset":{
+                "dsn":from_dataset_name.strip(),
                 "member":from_member_name
-           },
-           "replace":replace
+            },
+            "replace":replace
         }
 
 
@@ -245,7 +245,7 @@
 
         custom_args = self._create_custom_request_arguments()
         custom_args['json'] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, path_to_member)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(path_to_member))
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json
 
@@ -258,7 +258,7 @@
             A JSON with the contents of a given dataset
         """
         custom_args = self._create_custom_request_arguments()
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         response_json = self.request_handler.perform_request("GET", custom_args)
         return response_json
 
@@ -327,7 +327,7 @@
                         options[opt] = options["lrecl"]
 
         custom_args = self._create_custom_request_arguments()
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         custom_args["json"] = options
         response_json = self.request_handler.perform_request("POST", custom_args, expected_code = [201])
         return response_json
@@ -403,7 +403,7 @@
                 "dirblk": 25
             }
 
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         response_json = self.request_handler.perform_request("POST", custom_args, expected_code=[201])
         return response_json
 
@@ -438,7 +438,7 @@
             A raw socket response
         """
         custom_args = self._create_custom_request_arguments()
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         raw_response = self.request_handler.perform_streamed_request("GET", custom_args)
         return raw_response
 
@@ -457,7 +457,7 @@
             The contents of the dataset with no transformation
         """
         custom_args = self._create_custom_request_arguments()
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         custom_args["headers"]["Accept"] = "application/octet-stream"
         if with_prefixes:
             custom_args["headers"]["X-IBM-Data-Type"] = 'record'
@@ -481,7 +481,7 @@
             The raw socket response
         """
         custom_args = self._create_custom_request_arguments()
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         custom_args["headers"]["Accept"] = "application/octet-stream"
         if with_prefixes:
             custom_args["headers"]["X-IBM-Data-Type"] = 'record'
@@ -499,7 +499,7 @@
             A JSON containing the result of the operation
         """
         custom_args = self._create_custom_request_arguments()
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
         custom_args["data"] = data
         custom_args['headers']['Content-Type'] = 'text/plain; charset={}'.format(encoding)
         response_json = self.request_handler.perform_request(
@@ -573,7 +573,7 @@
         url = "{}ds/{}".format(self.request_endpoint, dataset_name)
         if volume is not None:
             url = "{}ds/-{}/{}".format(self.request_endpoint, volume, dataset_name)
-        custom_args["url"] = url
+        custom_args["url"] = self._encode_uri_component(url)
         response_json = self.request_handler.perform_request(
             "DELETE", custom_args, expected_code=[200, 202, 204])
         return response_json
@@ -700,7 +700,7 @@
 
         custom_args = self._create_custom_request_arguments()
         custom_args["json"] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
 
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json
@@ -733,7 +733,7 @@
 
         custom_args = self._create_custom_request_arguments()
         custom_args["json"] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
 
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json
@@ -762,7 +762,7 @@
 
         custom_args = self._create_custom_request_arguments()
         custom_args["json"] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, dataset_name)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(dataset_name))
 
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json
@@ -793,7 +793,7 @@
 
         custom_args = self._create_custom_request_arguments()
         custom_args["json"] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, after_dataset_name.strip())
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(after_dataset_name).strip())
 
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json
@@ -839,7 +839,7 @@
 
         custom_args = self._create_custom_request_arguments()
         custom_args['json'] = data
-        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, path_to_member)
+        custom_args["url"] = "{}ds/{}".format(self.request_endpoint, self._encode_uri_component(path_to_member))
 
         response_json = self.request_handler.perform_request("PUT", custom_args, expected_code=[200])
         return response_json

src/zos_jobs/zowe/zos_jobs_for_zowe_sdk/jobs.py

@@ -51,7 +51,7 @@
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/{}".format(jobname, jobid)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         response_json = self.request_handler.perform_request("GET", custom_args)
         return response_json
@@ -78,7 +78,7 @@
 
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/{}".format(jobname, jobid)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         custom_args["json"] = {
             "request": "cancel",
@@ -110,7 +110,7 @@
 
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/{}".format(jobname, jobid)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         custom_args["headers"]["X-IBM-Job-Modify-Version"] = modify_version
 
@@ -121,7 +121,7 @@
 
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/{}".format(jobname, jobid)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         custom_args["json"] = {
             **req,
@@ -317,7 +317,7 @@
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/files".format(correlator)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         response_json = self.request_handler.perform_request("GET", custom_args)
         return response_json
@@ -336,7 +336,7 @@
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/files/JCL/records".format(correlator)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         response_json = self.request_handler.perform_request("GET", custom_args)
         return response_json        
@@ -360,7 +360,7 @@
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/files/{}/records".format(correlator, id)
-        request_url = "{}{}".format(self.request_endpoint, job_url)
+        request_url = "{}{}".format(self.request_endpoint, self._encode_uri_component(job_url))
         custom_args["url"] = request_url
         response_json = self.request_handler.perform_request("GET", custom_args)
         return response_json

tests/unit/test_zos_files.py

@@ -1,4 +1,5 @@
 """Unit tests for the Zowe Python SDK z/OS Files package."""
+import re
 from unittest import TestCase, mock
 from zowe.zos_files_for_zowe_sdk import Files, exceptions
 
@@ -74,7 +75,7 @@ def test_unmount_zFS_file_system(self, mock_send_request):
 
     @mock.patch('requests.Session.send')
     def test_list_dsn(self, mock_send_request):
-        """Test creating a zfs sends a request"""
+        """Test list DSN sends request"""
         mock_send_request.return_value = mock.Mock(headers={"Content-Type": "application/json"}, status_code=200)
 
         test_values = [
@@ -311,10 +312,10 @@ def test_rename_dataset_member_raises_exception(self):
     def test_rename_dataset_member_parametrized(self):
         """Test renaming a dataset member with different values"""
         test_values = [
-            (('DSN', "MBROLD", "MBRNEW", "EXCLU"), True),
-            (('DSN', "MBROLD", "MBRNEW", "SHRW"), True),
+            (('DSN', "MBROLD$", "MBRNEW$", "EXCLU"), True),
+            (('DSN', "MBROLD#", "MBRNE#", "SHRW"), True),
             (('DSN', "MBROLD", "MBRNEW", "INVALID"), False),
-            (('DATA.SET.NAME', 'MEMBEROLD', 'MEMBERNEW'), True),
+            (('DATA.SET.@NAME', 'MEMBEROLD', 'MEMBERNEW'), True),
             (('DS.NAME', "MONAME", "MNNAME"), True),
         ]
 
@@ -337,8 +338,11 @@ def test_rename_dataset_member_parametrized(self):
                 files_test_profile.rename_dataset_member(*test_case[0])
                 custom_args = files_test_profile._create_custom_request_arguments()
                 custom_args["json"] = data
-                custom_args["url"] = "https://mock-url.com:443/zosmf/restfiles/ds/{}({})".format(
-                    test_case[0][0], test_case[0][2])
+                ds_path = "{}({})".format(test_case[0][0], test_case[0][2])
+                ds_path_adjusted = files_test_profile._encode_uri_component(ds_path)
+                self.assertNotRegex(ds_path_adjusted, r'[\$\@\#]')
+                self.assertRegex(ds_path_adjusted, r'[\(' + re.escape(test_case[0][2]) + r'\)]')
+                custom_args["url"] = "https://mock-url.com:443/zosmf/restfiles/ds/{}".format(ds_path_adjusted)
                 files_test_profile.request_handler.perform_request.assert_called_once_with("PUT", custom_args,
                                                                                            expected_code=[200])
             else:

tests/unit/test_zos_jobs.py

@@ -81,7 +81,7 @@ def test_modified_version_error(self, mock_send_request):
     def test_cancel_job_modify_version_parameterized(self):
         """Test cancelling a job with different values sends the expected request"""
         test_values = [
-            (("TESTJOB", "JOB00010", "1.0"), True),
+            (("TESTJOB", "JOB$0010", "1.0"), True),
             (("TESTJOBN", "JOB00011", "2.0"), True),
             (("TESTJOB", "JOB00012", "2"), False),
             (("TESTJOBN", "JOB00113", "3.0"), False),
@@ -100,7 +100,10 @@ def test_cancel_job_modify_version_parameterized(self):
                     "request": "cancel",
                     "version": test_case[0][2],
                 }
-                custom_args["url"] = "https://mock-url.com:443/zosmf/restjobs/jobs/{}/{}".format(test_case[0][0], test_case[0][1])
+                job_url = "{}/{}".format(test_case[0][0], test_case[0][1])
+                job_url_adjusted = jobs_test_object._encode_uri_component(job_url)
+                self.assertNotRegex(job_url_adjusted, r'\$')
+                custom_args["url"] = "https://mock-url.com:443/zosmf/restjobs/jobs/{}".format(job_url_adjusted)
                 jobs_test_object.request_handler.perform_request.assert_called_once_with("PUT", custom_args, expected_code=[202, 200])
             else:
                 with self.assertRaises(ValueError) as e_info:

tests/unit/test_zowe_core.py

@@ -125,6 +125,23 @@ def test_should_handle_token_auth(self):
             self.token_props["tokenType"] + "=" + self.token_props["tokenValue"],
         )
 
+    def test_encode_uri_component(self):
+        """Test string is being adjusted to the correct URL parameter"""
+
+        sdk_api = SdkApi(self.basic_props, self.default_url)
+
+        actual_not_empty = sdk_api._encode_uri_component('[email protected]#.$HERE(MBR#NAME)')
+        expected_not_empty = 'MY.STRING%40.TEST%23.%24HERE(MBR%23NAME)'
+        self.assertEqual(actual_not_empty, expected_not_empty)
+
+        actual_wildcard = sdk_api._encode_uri_component('GET.#DS.*')
+        expected_wildcard = 'GET.%23DS.*'
+        self.assertEqual(actual_wildcard, expected_wildcard)
+
+        actual_none = sdk_api._encode_uri_component(None)
+        expected_none = None
+        self.assertEqual(actual_none, expected_none)
+
 
 class TestRequestHandlerClass(unittest.TestCase):
     """RequestHandler class unit tests."""