fix(Global Search): re-gen service and add examples

padamstx · padamstx · commit d9983a802460 · 2020-12-09T19:18:15.000-06:00
diff --git a/examples/test_global_search_v2_examples.py b/examples/test_global_search_v2_examples.py
@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+# (C) Copyright IBM Corp. 2020.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""
+Examples for GlobalSearchV2
+"""
+
+import os
+import pytest
+from ibm_cloud_sdk_core import ApiException, read_external_sources
+from ibm_platform_services.global_search_v2 import *
+
+# This file provides an example of how to use the Global Tagging service.
+#
+# The following configuration properties are assumed to be defined in the external configuration file:
+# GLOBAL_TAGGING_URL=<service url>
+# GLOBAL_TAGGING_AUTHTYPE=iam
+# GLOBAL_TAGGING_APIKEY=<IAM api key>
+# GLOBAL_TAGGING_AUTH_URL=<IAM token service URL - omit this if using the production environment>
+# GLOBAL_TAGGING_RESOURCE_CRN=<the crn of the resource to be used in the examples>
+
+# Config file name
+config_file = 'global_search.env'
+
+global_search_service = None
+
+
+##############################################################################
+# Start of Examples for Service: GlobalSearchV2
+##############################################################################
+# region
+class TestGlobalSearchV2Examples():
+    """
+    Example Test Class for GlobalSearchV2
+    """
+    @classmethod
+    def setup_class(cls):
+        global global_search_service
+        if os.path.exists(config_file):
+            os.environ['IBM_CREDENTIALS_FILE'] = config_file
+
+            # begin-common
+
+            global_search_service = GlobalSearchV2.new_instance()
+
+            # end-common
+            assert global_search_service is not None
+
+        print('Setup complete.')
+
+    needscredentials = pytest.mark.skipif(
+        not os.path.exists(config_file),
+        reason="External configuration not available, skipping...")
+
+    @needscredentials
+    def test_search_example(self):
+        """
+        search request example
+        """
+        try:
+            # begin-search
+
+            response = global_search_service.search(query='GST-sdk-*',
+                                                    fields=['*'])
+            scan_result = response.get_result()
+
+            print(json.dumps(scan_result, indent=2))
+
+            # end-search
+
+        except ApiException as e:
+            pytest.fail(str(e))
+
+    @needscredentials
+    def test_get_supported_types_example(self):
+        """
+        get_supported_types request example
+        """
+        try:
+            # begin-get_supported_types
+
+            supported_types_list = global_search_service.get_supported_types(
+            ).get_result()
+
+            print(json.dumps(supported_types_list, indent=2))
+
+            # end-get_supported_types
+
+        except ApiException as e:
+            pytest.fail(str(e))
+
+
+# endregion
+##############################################################################
+# End of Examples for Service: GlobalSearchV2
+##############################################################################
diff --git a/ibm_platform_services/global_search_v2.py b/ibm_platform_services/global_search_v2.py
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-8d569e8f-20201030-111043
+# IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-d753183b-20201209-163011
  
 """
 Search for resources with the global and shared resource properties repository integrated
@@ -79,7 +79,7 @@ def __init__(self,
 
 
     #########################
-    # resourceFinder
+    # Search
     #########################
 
 
@@ -98,7 +98,7 @@ def search(self,
         """
         Find instances of resources.
 
-        'Find cloud foundry resources, resource controlled enabled resources, or storage
+        Find cloud foundry resources, resource controller-enabled resources, or storage
         and network resources running on classic infrastructure in a specific account ID.
         You can apply query strings if necessary. To filter results, you can insert a
         string using the Lucene syntax and the query string is parsed into a series of
@@ -112,7 +112,7 @@ def search(self,
         data that you must use on all the subsequent calls to get the next batch of
         results until you get the empty result set. By default, the fields returned for
         every resources are: "crn", "name", "family", "type", "account_id". You can
-        specify the subset of the fields you want in your request.''.
+        specify the subset of the fields you want in your request.
 
         :param str query: (optional) The Lucene-formatted query string. Default to
                '*' if not set.
@@ -176,7 +176,7 @@ def search(self,
         return response
 
     #########################
-    # resourceTypes
+    # Resource Types
     #########################
 
 
@@ -289,8 +289,7 @@ class ScanResult():
 
     :attr str search_cursor: The search cursor to use on all calls after the first
           one.
-    :attr float limit: (optional) Value of the limit parameter specified by the
-          user.
+    :attr int limit: (optional) Value of the limit parameter specified by the user.
     :attr List[ResultItem] items: The array of results. Each item represents a
           resource. An empty array signals the end of the result set, there are no more
           hits to fetch.
@@ -300,7 +299,7 @@ def __init__(self,
                  search_cursor: str,
                  items: List['ResultItem'],
                  *,
-                 limit: float = None) -> None:
+                 limit: int = None) -> None:
         """
         Initialize a ScanResult object.
 
@@ -309,8 +308,8 @@ def __init__(self,
         :param List[ResultItem] items: The array of results. Each item represents a
                resource. An empty array signals the end of the result set, there are no
                more hits to fetch.
-        :param float limit: (optional) Value of the limit parameter specified by
-               the user.
+        :param int limit: (optional) Value of the limit parameter specified by the
+               user.
         """
         self.search_cursor = search_cursor
         self.limit = limit
diff --git a/test/integration/test_global_search_v2.py b/test/integration/test_global_search_v2.py
@@ -12,113 +12,78 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
 """
-Test the platform service Global Search API operations
+Integration Tests for GlobalSearchV2
 """
 
-import unittest
 import os
-from ibm_platform_services import GlobalSearchV2
-from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
-from jproperties import Properties
-
-# Read config file
-configFile = 'ghost.env'
-config = {}
-configLoaded = None
-
-try:
-    with open(configFile, "rb") as f:
-        p = Properties()
-        p.load(f, "utf-8")
-        config['GST_API_URL'] = p['GST_API_URL'].data
-        config['GST_TAGS_URL'] = p['GST_TAGS_URL'].data
-        config['GST_RESOURCE_NAMES'] = p['GST_RESOURCE_NAMES'].data
-        config['GST_IINTERNA_APIKEY'] = p['GST_IINTERNA_APIKEY'].data
-        config['GST_IAM_URL'] = p['GST_IAM_URL'].data
-        config['GST_QUERY'] = p['GST_QUERY'].data
-        config['GST_RESOURCE_CRN'] = p['GST_RESOURCE_CRN'].data
-        configLoaded = True
-except:
-    print('External configuration was not found, skipping tests...')
-    
-# Test class
-class TestGlobalSearchV2(unittest.TestCase):
+import pytest
+import uuid
+from ibm_cloud_sdk_core import *
+from ibm_platform_services.global_search_v2 import *
+
+# Config file name
+config_file = 'global_search.env'
+
+transaction_id = str(uuid.uuid4())
+
+
+class TestGlobalSearchV2():
     """
     Integration Test Class for GlobalSearchV2
     """
+    @classmethod
+    def setup_class(cls):
+        if os.path.exists(config_file):
+            os.environ['IBM_CREDENTIALS_FILE'] = config_file
+
+            cls.global_search_service = GlobalSearchV2.new_instance()
+            assert cls.global_search_service is not None
+
+        print('Setup complete.')
 
-    def setUp(self):
-        if not configLoaded:
-          self.skipTest("External configuration not available, skipping...")
-        
-        # Create authenticator with IAM API key (it generates bearer token automatically)
-        apikey = config['GST_IINTERNA_APIKEY']
-        iam_url = config['GST_IAM_URL']
-        assert apikey is not None
-        assert iam_url is not None
-        authenticator = IAMAuthenticator(apikey, url=iam_url)
-        
-        self.global_search = GlobalSearchV2(authenticator=authenticator)
-        self.global_search.set_service_url(config['GST_API_URL'])
-        self.items = set(config['GST_RESOURCE_NAMES'].split(','))
-
-    def tearDown(self):
-        # Delete the resources
-        print("Clean up complete")
-
-    def test_search_1(self):
-        # It makes the query
-        env = self.global_search.search(query='name:gst-sdk*', search_cursor=None, transaction_id=None)
-        assert env is not None
-        results = env.get_result()
-        items = results.get('items')
-        assert items is not None
-        assert len(items) == 2
-        items_name_set = set()
-        for item in items:
-            items_name_set.add(item.get('name'))
-        # It checks if the resultset and expected set are equal
-        assert items_name_set == self.items
-
-    def test_search_2(self):
-        items_to_check = set(self.items)  # Make a copy of the items in memory
-        fields_to_search = ['crn', 'name']
-        # It makes the first query
-        env = self.global_search.search(query='name:gst-sdk*', search_cursor=None, transaction_id=None,
-                                        fields=fields_to_search,
-                                        limit=1)
-        assert env is not None
-        results = env.get_result()
-        items = results.get('items')
-        assert items is not None
-        assert len(items) == 1
-        items_to_check.remove(items[0]['name'])
-        assert len(items_to_check) == 1
-
-        # It makes the second query with cursor
-        search_cursor_str = results.get('search_cursor')
-        env = self.global_search.search(query='name:gst-sdk*', search_cursor=search_cursor_str, transaction_id=None,
-                                        fields=fields_to_search,
-                                        limit=1)
-        assert env is not None
-        results = env.get_result()
-        items = results.get('items')
-        assert items is not None
-        assert len(items) == 1
-        items_to_check.remove(items[0]['name'])
-        assert len(items_to_check) == 0
+    needscredentials = pytest.mark.skipif(
+        not os.path.exists(config_file),
+        reason="External configuration not available, skipping...")
 
+    @needscredentials
+    def test_search(self):
+
+        search_results = []
+        more_results = True
+        search_cursor = None
+
+        while more_results:
+            search_response = self.global_search_service.search(
+                query='GST-sdk-*',
+                fields=['*'],
+                search_cursor=search_cursor,
+                transaction_id=transaction_id,
+                limit=1)
+
+            assert search_response.get_status_code() == 200
+            scan_result = search_response.get_result()
+            assert scan_result is not None
+            print('\nsearch() result: ', json.dumps(scan_result, indent=2))
+
+            if len(scan_result['items']) > 0:
+                for elem in scan_result['items']:
+                    search_results.append(elem)
+                search_cursor = scan_result['search_cursor']
+            else:
+                more_results = False
+
+        print('Total items returned by search(): ', len(search_results))
+
+    @needscredentials
     def test_get_supported_types(self):
-        # It makes the query
-        env = self.global_search.get_supported_types()
-        assert env is not None
-        results = env.get_result()
-        supported_types = results.get('supported_types')
-        assert supported_types is not None
-        assert len(supported_types) > 0
 
+        get_supported_types_response = self.global_search_service.get_supported_types(
+        )
+
+        assert get_supported_types_response.get_status_code() == 200
+        supported_types_list = get_supported_types_response.get_result()
+        assert supported_types_list is not None
 
-if __name__ == '__main__':
-    unittest.main()
+        print('get_supported_types() result: ',
+              json.dumps(supported_types_list, indent=2))
diff --git a/test/unit/test_global_search_v2.py b/test/unit/test_global_search_v2.py
@@ -36,7 +36,7 @@
 service.set_service_url(base_url)
 
 ##############################################################################
-# Start of Service: ResourceFinder
+# Start of Service: Search
 ##############################################################################
 # region
 
@@ -147,7 +147,7 @@ def test_search_required_params(self):
 
 # endregion
 ##############################################################################
-# End of Service: ResourceFinder
+# End of Service: Search
 ##############################################################################
 
 ##############################################################################
@@ -251,7 +251,7 @@ def test_scan_result_serialization(self):
         # Construct a json representation of a ScanResult model
         scan_result_model_json = {}
         scan_result_model_json['search_cursor'] = 'testString'
-        scan_result_model_json['limit'] = 72.5
+        scan_result_model_json['limit'] = 38
         scan_result_model_json['items'] = [result_item_model]
 
         # Construct a model instance of ScanResult by calling from_dict on the json representation
