fix: update __init__.py and working examples (#108)

Co-authored-by: Phil Adams <[email protected]>

Author: Andras-Csanyi

examples/test_case_management_v1_examples.py

@@ -90,6 +90,7 @@ def test_create_case_example(self):
         create_case request example
         """
         try:
+            print('\ncreate_case() result:')
             # begin-createCase
 
             offering_type = OfferingType(
@@ -109,7 +110,7 @@ def test_create_case_example(self):
                 severity=4,
             ).get_result()
 
-            print('\ncreate_case() result:\n' + json.dumps(case, indent=2))
+            print(json.dumps(case, indent=2))
 
             # end-createCase
 
@@ -130,6 +131,7 @@ def test_get_case_example(self):
         assert case_number is not None
 
         try:
+            print('\nget_case() result:')
             # begin-getCase
 
             fields_to_return = [
@@ -144,7 +146,7 @@ def test_get_case_example(self):
                 fields=fields_to_return
             ).get_result()
 
-            print('\nget_case() result:\n' + json.dumps(case, indent=2))
+            print(json.dumps(case, indent=2))
 
             # end-getCase
 
@@ -157,6 +159,7 @@ def test_get_cases_example(self):
         get_cases request example
         """
         try:
+            print('\nget_cases() result:')
             # begin-getCases
 
             case_list = case_management_service.get_cases(
@@ -166,7 +169,7 @@ def test_get_cases_example(self):
                 sort=GetCasesEnums.Fields.UPDATED_AT,
             ).get_result()
 
-            print('\nget_cases() result:\n' + json.dumps(case_list, indent=2))
+            print(json.dumps(case_list, indent=2))
 
             # end-getCases
 
@@ -181,14 +184,15 @@ def test_add_comment_example(self):
         assert case_number is not None
 
         try:
+            print('\nadd_comment() result:')
             # begin-addComment
 
             comment = case_management_service.add_comment(
                 case_number=case_number,
                 comment='This is an example comment.'
             ).get_result()
 
-            print('\nadd_comment() result:\n' + json.dumps(comment, indent=2))
+            print(json.dumps(comment, indent=2))
 
             # end-addComment
 
@@ -203,6 +207,7 @@ def test_add_watchlist_example(self):
         assert case_number is not None
 
         try:
+            print('\nadd_watchlist() result:')
             # begin-addWatchlist
 
             watchlist_users = [
@@ -214,7 +219,7 @@ def test_add_watchlist_example(self):
                 watchlist=watchlist_users,
             ).get_result()
 
-            print('\nadd_watchlist() result:\n' + json.dumps(watchlist_add_response, indent=2))
+            print(json.dumps(watchlist_add_response, indent=2))
 
             # end-addWatchlist
 
@@ -229,6 +234,7 @@ def test_remove_watchlist_example(self):
         assert case_number is not None
 
         try:
+            print('\nremove_watchlist() result:')
             # begin-removeWatchlist
 
             watchlist_users = [
@@ -240,7 +246,7 @@ def test_remove_watchlist_example(self):
                 watchlist=watchlist_users,
             ).get_result()
 
-            print('\nremove_watchlist() result:\n' + json.dumps(watchlist, indent=2))
+            print(json.dumps(watchlist, indent=2))
 
             # end-removeWatchlist
 
@@ -256,6 +262,7 @@ def test_add_resource_example(self):
         assert resource_crn is not None
 
         try:
+            print('\nadd_resource() result:')
             # begin-addResource
 
             resource = case_management_service.add_resource(
@@ -264,7 +271,7 @@ def test_add_resource_example(self):
                 note='This resource is the service that is having the problem.',
             ).get_result()
 
-            print('\nadd_resource() result:\n' + json.dumps(resource, indent=2))
+            print(json.dumps(resource, indent=2))
 
             # end-addResource
 
@@ -279,6 +286,7 @@ def test_upload_file_example(self):
         assert case_number is not None
 
         try:
+            print('\nupload_file() result:')
             # begin-uploadFile
 
             example_file_content = b'This is the content of the file to upload.'
@@ -296,7 +304,7 @@ def test_upload_file_example(self):
                 file=files_to_upload,
             ).get_result()
 
-            print('\nupload_file() result:\n' + json.dumps(attachment, indent=2))
+            print(json.dumps(attachment, indent=2))
 
             # end-uploadFile
 
@@ -318,6 +326,7 @@ def test_download_file_example(self):
         assert attachment_id is not None
 
         try:
+            print('\ndownload_file() result:')
             # begin-downloadFile
 
             response = case_management_service.download_file(
@@ -327,9 +336,7 @@ def test_download_file_example(self):
 
             file = response.get_result()
 
-            print('\ndownload_file() result:\n')
-            print('Attachment content-type:', response.get_headers()['content-type'])
-            print('Attachment contents:', file.content)
+            print(file.content)
 
             # end-downloadFile
 
@@ -345,14 +352,15 @@ def test_delete_file_example(self):
         assert attachment_id is not None
 
         try:
+            print('\ndelete_file() result:')
             # begin-deleteFile
 
             attachment_list = case_management_service.delete_file(
                 case_number=case_number,
                 file_id=attachment_id
             ).get_result()
 
-            print('\ndelete_file() result:\n' + json.dumps(attachment_list, indent=2))
+            print(json.dumps(attachment_list, indent=2))
 
             # end-deleteFile
 
@@ -367,6 +375,7 @@ def test_update_case_status_example(self):
         assert case_number is not None
 
         try:
+            print('\nupdate_case_status() result:')
             # begin-updateCaseStatus
 
             status_payload_model = {
@@ -380,7 +389,7 @@ def test_update_case_status_example(self):
                 status_payload=status_payload_model
             ).get_result()
 
-            print('\nupdate_case_status() result:\n' + json.dumps(case, indent=2))
+            print(json.dumps(case, indent=2))
 
             # end-updateCaseStatus
 

examples/test_configuration_governance_v1_examples.py

@@ -106,6 +106,7 @@ def test_create_rules_example(self):
         create_rules request example
         """
         try:
+            print('\ncreate_rules() result:')
             # begin-create_rules
 
             target_resource_model = {
@@ -182,7 +183,7 @@ def test_create_rules_example(self):
                             code=responseEntry['errors'][0]['code'],
                             message=responseEntry['errors'][0]['message'])
 
-            print('\ncreate_rules() result:\n' + json.dumps(create_rules_response, indent=2))
+            print(json.dumps(create_rules_response, indent=2))
 
             # end-create_rules
 
@@ -197,6 +198,7 @@ def test_create_attachments_example(self):
         create_attachments request example
         """
         try:
+            print('\ncreate_attachments() result:')
             # begin-create_attachments
 
             excluded_scope_model = {
@@ -219,7 +221,7 @@ def test_create_attachments_example(self):
                 rule_id=rule_id_link,
                 attachments=[attachment_request_model]).get_result()
 
-            print('\ncreate_attachments() result:\n' + json.dumps(create_attachments_response, indent=2))
+            print(json.dumps(create_attachments_response, indent=2))
 
             # end-create_attachments
 
@@ -235,13 +237,14 @@ def test_get_attachment_example(self):
         get_attachment request example
         """
         try:
+            print('\nget_attachment() result:')
             # begin-get_attachment
 
             attachment = configuration_governance_service.get_attachment(
                 rule_id=rule_id_link,
                 attachment_id=attachment_id_link).get_result()
 
-            print('\nget_attachment() result:\n' + json.dumps(attachment, indent=2))
+            print(json.dumps(attachment, indent=2))
 
             # end-get_attachment
 
@@ -258,12 +261,13 @@ def test_get_rule_example(self):
         get_rule request example
         """
         try:
+            print('\nget_rule() result:')
             # begin-get_rule
 
             rule = configuration_governance_service.get_rule(
                 rule_id=rule_id_link).get_result()
 
-            print('\nget_rule() result:\n' + json.dumps(rule, indent=2))
+            print(json.dumps(rule, indent=2))
 
             # end-get_rule
 
@@ -279,12 +283,13 @@ def test_list_rules_example(self):
         list_rules request example
         """
         try:
+            print('\nlist_rules() result:')
             # begin-list_rules
 
             rule_list = configuration_governance_service.list_rules(
                 account_id=account_id).get_result()
 
-            print('\nlist_rules() result:\n' + json.dumps(rule_list, indent=2))
+            print(json.dumps(rule_list, indent=2))
 
             # end-list_rules
 
@@ -297,6 +302,7 @@ def test_update_rule_example(self):
         update_rule request example
         """
         try:
+            print('\nupdate_rule() result:')
             # begin-update_rule
 
             rule_target_attribute_model = {
@@ -337,7 +343,7 @@ def test_update_rule_example(self):
                 rule_type='user_defined',
                 labels=['testString']).get_result()
 
-            print('\nupdate_rule() result:\n' + json.dumps(rule, indent=2))
+            print(json.dumps(rule, indent=2))
 
             # end-update_rule
 
@@ -350,12 +356,13 @@ def test_list_attachments_example(self):
         list_attachments request example
         """
         try:
+            print('\nlist_attachments() result:')
             # begin-list_attachments
 
             attachment_list = configuration_governance_service.list_attachments(
                 rule_id=rule_id_link).get_result()
 
-            print('\nlist_attachments() result:\n' + json.dumps(attachment_list, indent=2))
+            print(json.dumps(attachment_list, indent=2))
 
             # end-list_attachments
 
@@ -368,6 +375,7 @@ def test_update_attachment_example(self):
         update_attachment request example
         """
         try:
+            print('\nupdate_attachment() result:')
             # begin-update_attachment
 
             excluded_scope_model = {
@@ -388,7 +396,7 @@ def test_update_attachment_example(self):
                 },
                 excluded_scopes=[excluded_scope_model]).get_result()
 
-            print('\nupdate_attachment() result:\n' + json.dumps(attachment, indent=2))
+            print(json.dumps(attachment, indent=2))
 
             # end-update_attachment
 
@@ -407,10 +415,11 @@ def test_delete_attachment_example(self):
                 rule_id=rule_id_link,
                 attachment_id=attachment_id_link).get_result()
 
-            print('\ndelete_attachment() result:\n' + json.dumps(response, indent=2))
-
             # end-delete_attachment
 
+            print('\ndelete_attachment() response status code: ',
+                  response.get_status_code())
+
         except ApiException as e:
             pytest.fail(str(e))
 
@@ -425,10 +434,11 @@ def test_delete_rule_example(self):
             response = configuration_governance_service.delete_rule(
                 rule_id=rule_id_link).get_result()
 
-            print('\ndelete_rule() result:\n' + json.dumps(response, indent=2))
-
             # end-delete_rule
 
+            print('\ndelete_rule() response status code: ',
+                  response.get_status_code())
+
         except ApiException as e:
             pytest.fail(str(e))