#1862 added search features to vs list, and unit tests

Author: allmightyspiff

SoftLayer/CLI/virt/list.py

@@ -9,7 +9,6 @@
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
 from SoftLayer.CLI import helpers
-from SoftLayer import utils
 
 # pylint: disable=unnecessary-lambda
 
@@ -45,12 +44,6 @@
     'action',
 ]
 
-def search_callback(ctx, param, value):
-    print(f"SEARCH_CALLBACK: value: {value}")
-    if not value:
-        print("Value is true now")
-        value = True
-    return value
 
 @click.command(cls=SLCommand, short_help="List virtual servers.")
 @click.option('--cpu', '-c', help='Number of CPU cores', type=click.INT)
@@ -62,7 +55,7 @@ def search_callback(ctx, param, value):
 @click.option('--hourly', is_flag=True, help='Show only hourly instances')
 @click.option('--monthly', is_flag=True, help='Show only monthly instances')
 @click.option('--transient', help='Filter by transient instances', type=click.BOOL)
-@click.option('--search', is_flag=False, flag_value="", default=None, 
+@click.option('--search', is_flag=False, flag_value="", default=None,
               help="Use the more flexible Search API to list instances. See `slcli search --types` for list " +
               "of searchable fields.")
 @helpers.multi_option('--tag', help='Filter by tags')
@@ -82,9 +75,9 @@ def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network,
 
     guests = []
     if search is not None:
-        sm = SoftLayer.SearchManager(env.client)
-        guests = sm.search_instances(hostname=hostname, domain=domain, datacenter=datacenter,
-                                     tags=tag, search_string=search, mask=columns.mask())
+        search_manager = SoftLayer.SearchManager(env.client)
+        guests = search_manager.search_instances(hostname=hostname, domain=domain, datacenter=datacenter,
+                                                 tags=tag, search_string=search, mask=columns.mask())
     else:
         vsi = SoftLayer.VSManager(env.client)
         guests = vsi.list_instances(hourly=hourly, monthly=monthly, hostname=hostname, domain=domain,
@@ -99,4 +92,3 @@ def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network,
                        for value in columns.row(guest)])
 
     env.fout(table)
-

SoftLayer/managers/search.py

@@ -41,7 +41,7 @@ def search_instances(self, search_string, mask=None, **kwargs):
         Also takes in a few search terms as **kwargs. such as hostname, datacenter, domain and tags
         """
 
-        # This forces the Search API to do a fuzzy search on our term, kinda. Not sure why the ** are 
+        # This forces the Search API to do a fuzzy search on our term, kinda. Not sure why the ** are
         # Required but it will do an exact search without them.
         if search_string:
             search_string = f"*{search_string}*"
@@ -54,11 +54,10 @@ def search_instances(self, search_string, mask=None, **kwargs):
             search_string = f"{search_string} datacenter.longName: *{kwargs.get('datacenter')}*"
         if kwargs.get('tags'):
             tags = " ".join(kwargs.get("tags", []))
-            search_string = f"{search_string} internalTagReferences.tag.name: {kwargs.get('tags')}"
-        result = self.search_manager.advancedSearch(search_string)
+            search_string = f"{search_string} internalTagReferences.tag.name: {tags}"
+        result = self.search_manager.advancedSearch(search_string, mask=mask)
         guests = []
-        for x in result:
-            guests.append(x.get('resource'))
+        for resource in result:
+            guests.append(resource.get('resource'))
 
         return guests
-

tests/CLI/modules/vs/vs_tests.py

@@ -145,6 +145,23 @@ def test_list_vs(self):
 
         self.assert_no_fail(result)
 
+    def test_list_vs_search_noargs(self):
+        result = self.run_command(['vs', 'list', '--search'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch', args=('_objectType:SoftLayer_Virtual_Guest ',))
+
+    def test_list_vs_search_noargs_domain(self):
+        result = self.run_command(['vs', 'list', '--search', '-Dtest'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=('_objectType:SoftLayer_Virtual_Guest  domain: *test*',))
+
+    def test_list_vs_search_args(self):
+        result = self.run_command(['vs', 'list', '--search=thisTerm'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=('_objectType:SoftLayer_Virtual_Guest *thisTerm*',))
+
     @mock.patch('SoftLayer.utils.lookup')
     def test_detail_vs_empty_billing(self, mock_lookup):
         def mock_lookup_func(dic, key, *keys):
@@ -919,10 +936,6 @@ def test_vs_migrate_exception(self):
         self.assert_called_with('SoftLayer_Virtual_Guest', 'migrate', identifier=100)
         self.assert_not_called_with('SoftLayer_Virtual_Guest', 'migrateDedicatedHost', args=(999), identifier=100)
 
-    def test_list_vsi(self):
-        result = self.run_command(['vs', 'list', '--hardware'])
-        self.assert_no_fail(result)
-
     def test_credentail(self):
         result = self.run_command(['vs', 'credentials', '100'])
         self.assert_no_fail(result)

tests/managers/search_tests.py

@@ -25,3 +25,22 @@ def test_search(self):
     def test_search_advanced(self):
         self.search.advanced('SoftLayer_Hardware')
         self.assert_called_with('SoftLayer_Search', 'advancedSearch')
+
+    def test_search_instances_basic(self):
+        search_string = "TEST_STRING"
+        expected = f"_objectType:SoftLayer_Virtual_Guest *{search_string}*"
+        self.search.search_instances(search_string)
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=(expected,))
+        self.search.search_instances(search_string, hostname="thisHostname")
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=(f"{expected} hostname: *thisHostname*",))
+        self.search.search_instances(search_string, domain="thisDomain")
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=(f"{expected} domain: *thisDomain*",))
+        self.search.search_instances(search_string, datacenter="dal13")
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=(f"{expected} datacenter.longName: *dal13*",))
+        self.search.search_instances(search_string, tags=["thisTag"])
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=(f"{expected} internalTagReferences.tag.name: thisTag",))

tests/managers/vs/vs_tests.py

@@ -1278,38 +1278,6 @@ def test_migrate_dedicated(self):
         self.assertTrue(result)
         self.assert_called_with('SoftLayer_Virtual_Guest', 'migrateDedicatedHost', args=(5555,), identifier=1234)
 
-    def test_get_hardware_guests(self):
-        mock = self.set_mock('SoftLayer_Account', 'getHardware')
-        mock.return_value = [{
-            "accountId": 11111,
-            "domain": "vmware.chechu.com",
-            "hostname": "host14",
-            "id": 22222,
-            "virtualHost": {
-                "accountId": 11111,
-                "id": 33333,
-                "name": "host14.vmware.chechu.com",
-                "guests": [
-                    {
-                        "accountId": 11111,
-                        "hostname": "NSX-T Manager",
-                        "id": 44444,
-                        "maxCpu": 16,
-                        "maxCpuUnits": "CORE",
-                        "maxMemory": 49152,
-                        "powerState": {
-                            "keyName": "RUNNING",
-                            "name": "Running"
-                        },
-                        "status": {
-                            "keyName": "ACTIVE",
-                            "name": "Active"
-                        }
-                    }]}}]
-
-        result = self.vs.get_hardware_guests()
-        self.assertEqual("NSX-T Manager", result[0]['virtualHost']['guests'][0]['hostname'])
-
     def test_authorize_storage(self):
         options = self.vs.authorize_storage(1234, "SL01SEL301234-11")