slcli hw list --search "query"

Author: caberos

SoftLayer/CLI/hardware/list.py

@@ -9,7 +9,6 @@
 from SoftLayer.CLI import formatting
 from SoftLayer.CLI import helpers
 
-
 # pylint: disable=unnecessary-lambda
 
 COLUMNS = [
@@ -47,6 +46,9 @@
 @click.option('--hostname', '-H', help='Filter by hostname')
 @click.option('--memory', '-m', help='Filter by memory in gigabytes')
 @click.option('--network', '-n', help='Filter by network port speed in Mbps')
+@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')
 @click.option('--sortby', help='Column to sort by', default='hostname', show_default=True)
 @click.option('--columns',
@@ -59,19 +61,26 @@
               default=100,
               show_default=True)
 @environment.pass_env
-def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network, tag, columns, limit):
+def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network, search, tag, columns, limit):
     """List hardware servers."""
 
-    manager = SoftLayer.HardwareManager(env.client)
-    servers = manager.list_hardware(hostname=hostname,
-                                    domain=domain,
-                                    cpus=cpu,
-                                    memory=memory,
-                                    datacenter=datacenter,
-                                    nic_speed=network,
-                                    tags=tag,
-                                    mask="mask(SoftLayer_Hardware_Server)[%s]" % columns.mask(),
-                                    limit=limit)
+    if search is not None:
+        object_mask = f"mask[resource(SoftLayer_Hardware)]"
+        search_manager = SoftLayer.SearchManager(env.client)
+        servers = search_manager.search_hadrware_instances(hostname=hostname, domain=domain, datacenter=datacenter,
+                                                           tags=tag, search_string=search, mask=object_mask)
+
+    else:
+        manager = SoftLayer.HardwareManager(env.client)
+        servers = manager.list_hardware(hostname=hostname,
+                                        domain=domain,
+                                        cpus=cpu,
+                                        memory=memory,
+                                        datacenter=datacenter,
+                                        nic_speed=network,
+                                        tags=tag,
+                                        mask="mask(SoftLayer_Hardware_Server)[%s]" % columns.mask(),
+                                        limit=limit)
 
     table = formatting.Table(columns.columns)
     table.sortby = sortby

SoftLayer/managers/search.py

@@ -61,3 +61,37 @@ def search_instances(self, search_string, mask=None, **kwargs):
             guests.append(resource.get('resource'))
 
         return guests
+
+    def search_hadrware_instances(self, search_string, mask=None, **kwargs):
+        """Lists hardwares based in the search_string.
+
+                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
+        # Required but it will do an exact search without them.
+        if search_string:
+            search_string = f"*{search_string}*"
+        search_string = f"_objectType:SoftLayer_Hardware {search_string}"
+        if kwargs.get('hostname'):
+            search_string = f"{search_string} hostname: *{kwargs.get('hostname')}*"
+        if kwargs.get('domain'):
+            search_string = f"{search_string} domain: *{kwargs.get('domain')}*"
+        if kwargs.get('cpu'):
+            search_string = f"{search_string} cpu: *{kwargs.get('cpu')}*"
+        if kwargs.get('network'):
+            search_string = f"{search_string} network: *{kwargs.get('network')}*"
+        if kwargs.get('memory'):
+            search_string = f"{search_string} memory: *{kwargs.get('memory')}*"
+        if kwargs.get('datacenter'):
+            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: {tags}"
+        result = self.search_manager.advancedSearch(search_string, mask=mask)
+        hw = []
+        print(search_string)
+        for resource in result:
+            hw.append(resource.get('resource'))
+
+        return hw

tests/CLI/modules/server_tests.py

@@ -1057,3 +1057,14 @@ def test_create_credential(self):
                                    '--username', 'testslcli', '--password', 'test-123456',
                                    '--notes', 'test slcli', '--system', 'system'])
         self.assert_no_fail(result)
+
+    def test_list_hw_search_noargs(self):
+        result = self.run_command(['hw', 'list', '--search'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch', args=('_objectType:SoftLayer_Hardware ',))
+
+    def test_list_hw_search_noargs_domain(self):
+        result = self.run_command(['hw', 'list', '--search', '-Dtest'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Search', 'advancedSearch',
+                                args=('_objectType:SoftLayer_Hardware  domain: *test*',))