Standardize response

CHANGELOG.md

@@ -8,8 +8,9 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil
 
 - Added logger class to core SDK [#185](https://github.com/zowe/zowe-client-python-sdk/issues/185)
 - Added classes for handling `Datasets`, `USSFiles`, and `FileSystems` in favor of the single Files class. [#264](https://github.com/zowe/zowe-client-python-sdk/issues/264)
-- Refactored testings into proper folders and files and add more tests [#265](https://github.com/zowe/zowe-client-python-sdk/issues/265)
+- Refactored tests into proper folders and files [#265](https://github.com/zowe/zowe-client-python-sdk/issues/265)
 - Fixed the bug on `upload_file_to_dsn` [#104](https://github.com/zowe/zowe-client-python-sdk/issues/104)
+- Standardize `response` output [#266](https://github.com/zowe/zowe-client-python-sdk/issues/266) 
 
 ### Bug Fixes
 

samples/SampleFiles.py

@@ -29,4 +29,4 @@
 # -----------------------------------------------------
 print("...content of a file\n")
 my_file_content = my_files.get_file_content("/z/tm891807/file.txt")
-print(my_file_content["response"])
+print(my_file_content)

src/core/zowe/core_for_zowe_sdk/request_handler.py

@@ -134,13 +134,12 @@ def __normalize_response(self):
 
         Returns
         -------
-        A bytes object if the response content type is application/octet-stream,
-        a normalized JSON for the request response otherwise
+        A bytes object at the format based on Content-Type header
         """
-        if self.response.headers.get("Content-Type") == "application/octet-stream":
+        contentType = self.response.headers.get("Content-Type")
+        if contentType == "application/octet-stream":
             return self.response.content
+        elif contentType and contentType.startswith("application/json"):
+            return self.response.json()
         else:
-            try:
-                return self.response.json()
-            except:
-                return {"response": self.response.text}
+            return self.response.text

src/core/zowe/core_for_zowe_sdk/zosmf_profile.py

@@ -54,7 +54,6 @@ def __init__(self, profile_name):
         """
         self.profile_name = profile_name
         self.__logger = Log.registerLogger(__name__)
-        self.__logger = Log.registerLogger(__name__)
 
     @property
     def profiles_dir(self):

src/zos_jobs/zowe/zos_jobs_for_zowe_sdk/jobs.py

@@ -402,7 +402,7 @@
         os.makedirs(output_dir, exist_ok=True)
         output_file = os.path.join(output_dir, job_name, job_id, "jcl.txt")
         data_spool_file = self.get_jcl_text(job_correlator)
-        dataset_content = data_spool_file["response"]
+        dataset_content = data_spool_file
         with open(output_file, "w", encoding="utf-8") as out_file:
             out_file.write(dataset_content)
 
@@ -416,7 +416,7 @@
 
             output_file = os.path.join(output_dir, job_name, job_id, stepname, ddname)
             data_spool_file = self.get_spool_file_contents(job_correlator, spoolfile_id)
-            dataset_content = data_spool_file["response"]
+            dataset_content = data_spool_file
             with open(output_file, "w", encoding="utf-8") as out_file:
                 out_file.write(dataset_content)
 

tests/integration/test_zos_files.py

@@ -1,4 +1,5 @@
 """Integration tests for the Zowe Python SDK z/OS Files package."""
+
 import json
 import os
 import unittest
@@ -66,7 +67,7 @@ def test_list_members_should_return_a_list_of_members(self):
     def test_get_dsn_content_should_return_content_from_dataset(self):
         """Executing get_dsn_content should return content from dataset."""
         command_output = self.files.get_dsn_content(self.test_member_jcl)
-        self.assertIsInstance(command_output["response"], str)
+        self.assertIsInstance(command_output, str)
 
     def test_get_dsn_content_streamed_should_return_response_content(self):
         """Executing get_dsn_content_streamed should return response object from the server."""
@@ -86,14 +87,14 @@ def test_get_file_content_streamed_should_return_response_content(self):
     def test_write_to_dsn_should_be_possible(self):
         """Executing write_to_dsn should be possible."""
         command_output = self.files.write_to_dsn(self.test_member_generic, "HELLO WORLD")
-        self.assertTrue(command_output["response"] == "")
+        self.assertTrue(command_output == "")
 
     def test_copy_uss_to_dataset_should_be_possible(self):
         """Executing copy_uss_to_dataset should be possible."""
         command_output = self.files.copy_uss_to_dataset(
             self.files_fixtures["TEST_USS"], self.files_fixtures["TEST_PDS"] + "(TEST2)", replace=True
         )
-        self.assertTrue(command_output["response"] == "")
+        self.assertTrue(command_output == "")
 
     def test_copy_dataset_or_member_should_be_possible(self):
         """Executing copy_dataset_or_member should be possible."""
@@ -105,7 +106,7 @@ def test_copy_dataset_or_member_should_be_possible(self):
             "replace": True,
         }
         command_output = self.files.copy_dataset_or_member(**test_case)
-        self.assertTrue(command_output["response"] == "")
+        self.assertTrue(command_output == "")
 
     def test_mount_unmount_zfs_file_system(self):
         """Mounting a zfs filesystem should be possible"""
@@ -119,19 +120,19 @@ def test_mount_unmount_zfs_file_system(self):
         command_output = self.files.mount_file_system(
             self.test2_zfs_file_system, mount_point, self.mount_zfs_file_system_options
         )
-        self.assertTrue(command_output["response"] == "")
+        self.assertTrue(command_output == "")
 
         # List a zfs file system
         command_output = self.files.list_unix_file_systems(file_system_name=self.test2_zfs_file_system.upper())
         self.assertTrue(len(command_output["items"]) > 0)
 
         # Unmount file system
         command_output = self.files.unmount_file_system(self.test2_zfs_file_system)
-        self.assertTrue(command_output["response"] == "")
+        self.assertTrue(command_output == "")
 
         # Delete file system
         command_output = self.files.delete_zFS_file_system(self.test2_zfs_file_system)
-        self.assertTrue(command_output["response"] == "")
+        self.assertTrue(command_output == "")
 
     def test_upload_download_delete_dataset(self):
         self.files.upload_file_to_dsn(SAMPLE_JCL_FIXTURE_PATH, self.test_ds_upload)