fix(SDK): IBM Cloud SCC Python SDK

Author: Gaurav Goswami

.travis.yml

@@ -30,7 +30,7 @@ script:
 - tox
 
 after_success:
-- build/testScript.sh
+- build/testScript.sh || travis_terminate 1
 
 before_deploy:
 - pip3 install bumpversion pypandoc

README.md

@@ -8,7 +8,7 @@
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 # IBM Cloud Security & Compliance Center Python SDK Version 0.0.3
 
-Python client library to interact with various [IBM Cloud Security & Compliance Center APIs](https://cloud.ibm.com/apidocs/security-and-compliance-center).
+Python client library to interact with various [IBM Cloud Security & Compliance Center APIs](https://cloud.ibm.com/docs?tab=api-docs&category=platform_services%2Csecurity).
 
 Disclaimer: this SDK is being released initially as a **pre-release** version.
 Changes might occur which impact applications that use this SDK.
@@ -46,9 +46,9 @@ IBM Cloud services:
 
 Service Name | Module Name | Imported Class Name
 --- | --- | ---
-[Findings](https://cloud.ibm.com/apidocs/security-and-compliance-center/findings) | findings_v1 | FindingsV1
-[Notifications](https://cloud.ibm.com/apidocs/security-and-compliance-center/notifications) | notifications_v1 | NotificationsV1
-[Configuration Governance](https://cloud.ibm.com/apidocs/security-and-compliance-center/configuration-governance) | configuration_governance_v1 | ConfigurationGovernanceV1
+[Findings](https://cloud.ibm.com/apidocs/security-advisor/findings) | findings_v1 | FindingsV1
+[Notifications](https://cloud.ibm.com/apidocs/security-advisor/notifications) | notifications_v1 | NotificationsV1
+[Configuration Governance](https://cloud.ibm.com/apidocs/security-compliance/config) | configuration_governance_v1 | ConfigurationGovernanceV1
 
 ## Prerequisites
 

package-lock.json

@@ -97,7 +97,7 @@ def teardown_class(cls):
         )
         for provider in list_providers_response.get_result()["providers"]:
             if provider["id"] == provider_id:
-                print(f"seems like account has some resources left even after a successful cleanup, please consider manual cleanup for account: {0} and provider: {1}\n", accountID, providerID)
+                print(f"seems like account has some resources left even after a successful cleanup, please consider manual cleanup for account: {account_id} and provider: {provider_id}\n")
 
     needscredentials = pytest.mark.skipif(
         not os.path.exists(config_file), reason="External configuration not available, skipping..."
@@ -549,7 +549,7 @@ def test_create_occurrence_finding(self):
         create_occurrence_response = self.findings_service.create_occurrence(
             account_id=account_id,
             provider_id=provider_id,
-            note_name="{0}/provider/{1}/notes/finding-note-{2}".format(account_id, provider_id, identifier),
+            note_name="{0}/providers/{1}/notes/finding-note-{2}".format(account_id, provider_id, identifier),
             kind='FINDING',
             id=f'finding-occurrence-{identifier}',
             resource_url=testString,
@@ -628,7 +628,7 @@ def test_create_occurrence_kpi(self):
         create_occurrence_response = self.findings_service.create_occurrence(
             account_id=account_id,
             provider_id=provider_id,
-            note_name="{0}/provider/{1}/notes/kpi-note-{2}".format(account_id, provider_id, identifier),
+            note_name="{0}/providers/{1}/notes/kpi-note-{2}".format(account_id, provider_id, identifier),
             kind='KPI',
             id=f'kpi-occurrence-{identifier}',
             resource_url=testString,
@@ -714,10 +714,10 @@ def test_update_occurrence_finding(self):
         update_occurrence_response = self.findings_service.update_occurrence(
             account_id=account_id,
             provider_id=provider_id,
-            occurrence_id='finding-occurrence',
-            note_name="{0}/provider/{1}/notes/finding-note-{2}".format(account_id, provider_id, identifier),
+            note_name="{0}/providers/{1}/notes/finding-note-{2}".format(account_id, provider_id, identifier),
             kind='FINDING',
             id=f'finding-occurrence-{identifier}',
+            occurrence_id=f'finding-occurrence-{identifier}',
             resource_url=testString,
             remediation=testString,
             create_time=string_to_datetime('2019-01-01T12:00:00.000Z'),
@@ -747,10 +747,10 @@ def test_update_occurrence_kpi(self):
         update_occurrence_response = self.findings_service.update_occurrence(
             account_id=account_id,
             provider_id=provider_id,
-            occurrence_id='kpi-occurrence',
-            note_name="{0}/provider/{1}/notes/kpi-note-{2}".format(account_id, provider_id, identifier),
+            note_name="{0}/providers/{1}/notes/kpi-note-{2}".format(account_id, provider_id, identifier),
             kind='KPI',
             id=f'kpi-occurrence-{identifier}',
+            occurrence_id=f'kpi-occurrence-{identifier}',
             resource_url=testString,
             remediation=testString,
             create_time=string_to_datetime('2019-01-01T12:00:00.000Z'),

test/integration/test_findings_v1.py

@@ -27,6 +27,7 @@
 config_file = 'notifications_v1.env'
 account_id = os.getenv("ACCOUNT_ID")
 testString = "testString"
+channel_id = ""
 identifier = os.getenv("TRAVIS_JOB_ID") or time.time()
 
 class TestNotificationsV1():
@@ -68,12 +69,11 @@ def teardown_class(cls):
             account_id=account_id,
         )
         for channel in list_all_channels_response.get_result()['channels']:
-            if channel['channel_id'] == os.getenv('CHANNEL_ID'):
+            if channel['channel_id'] == channel_id:
                 cls.notifications_service.delete_notification_channel(
                     account_id=account_id,
                     channel_id=channel['channel_id'],
                 )
-        os.environ.pop('CHANNEL_ID')
         print("cleanup was successful\n")
 
     needscredentials = pytest.mark.skipif(
@@ -111,7 +111,8 @@ def test_create_notification_channel(self):
             alert_source=[notification_channel_alert_source_item_model],
         )
 
-        os.environ['CHANNEL_ID'] = create_notification_channel_response.get_result()['channel_id']
+        global channel_id
+        channel_id = create_notification_channel_response.get_result()['channel_id']
 
         assert create_notification_channel_response.get_status_code() == 200
         channel_info = create_notification_channel_response.get_result()
@@ -122,7 +123,7 @@ def test_get_notification_channel(self):
 
         get_notification_channel_response = self.notifications_service.get_notification_channel(
             account_id=account_id,
-            channel_id=os.getenv('CHANNEL_ID'),
+            channel_id=channel_id,
         )
 
         assert get_notification_channel_response.get_status_code() == 200
@@ -140,7 +141,7 @@ def test_update_notification_channel(self):
 
         update_notification_channel_response = self.notifications_service.update_notification_channel(
             account_id=account_id,
-            channel_id=os.getenv('CHANNEL_ID'),
+            channel_id=channel_id,
             name=f'testString-{identifier}',
             type='Webhook',
             endpoint='https://webhook.site/136fe1e2-3c3f-4bff-925f-391fbb202546',
@@ -158,7 +159,7 @@ def test_update_notification_channel(self):
     def test_test_notification_channel(self):
         test_notification_channel_response = self.notifications_service.test_notification_channel(
             account_id=account_id,
-            channel_id=os.getenv('CHANNEL_ID'),
+            channel_id=channel_id,
         )
 
         assert test_notification_channel_response.get_status_code() == 200
@@ -179,7 +180,7 @@ def test_get_public_key(self):
     def test_delete_notification_channel(self):
         delete_notification_channel_response = self.notifications_service.delete_notification_channel(
             account_id=account_id,
-            channel_id=os.getenv('CHANNEL_ID'),
+            channel_id=channel_id,
         )
 
         assert delete_notification_channel_response.get_status_code() == 200