#1222 Added logic to lookup LBaaS by name instead of the address

Author: ATGE

SoftLayer/CLI/loadbal/detail.py

@@ -3,7 +3,6 @@
 
 import SoftLayer
 from SoftLayer.CLI import environment
-from SoftLayer.CLI import exceptions
 from SoftLayer.CLI import formatting
 from SoftLayer import utils
 
@@ -14,15 +13,8 @@
 def cli(env, identifier):
     """Get Load Balancer as a Service details."""
     mgr = SoftLayer.LoadBalancerManager(env.client)
-
-    if utils.valid_domain(identifier):
-        lbaas = mgr.get_lbaas_by_address(identifier)
-        if not lbaas:
-            raise exceptions.CLIAbort("{} address not found".format(identifier))
-        this_lb = mgr.get_lb(lbaas.get('id'))
-    else:
-        _, lbid = mgr.get_lbaas_uuid_id(identifier)
-        this_lb = mgr.get_lb(lbid)
+    _, lbid = mgr.get_lbaas_uuid_id(identifier)
+    this_lb = mgr.get_lb(lbid)
     if this_lb.get('previousErrorText'):
         print(this_lb.get('previousErrorText'))
     table = lbaas_table(this_lb)

SoftLayer/fixtures/SoftLayer_Network_LBaaS_LoadBalancer.py

@@ -6,7 +6,7 @@
     'isPublic': 0,
     'locationId': 265592,
     'modifyDate': '2019-08-13T16:26:06-06:00',
-    'name': 'dcabero-01',
+    'name': 'test-01',
     'operatingStatus': 'ONLINE',
     'provisioningStatus': 'ACTIVE',
     'type': 0,

SoftLayer/managers/load_balancer.py

@@ -92,28 +92,30 @@ def update_lb_health_monitors(self, uuid, checks):
     def get_lbaas_uuid_id(self, identifier):
         """Gets a LBaaS uuid, id. Since sometimes you need one or the other.
 
-        :param identifier: either the LB Id, or UUID, this function will return both.
+        :param identifier: either the LB Id, UUID or Name, this function will return UUI and LB Id.
         :return (uuid, id):
         """
-        # int objects don't have a len property.
-        if not isinstance(identifier, int) and len(identifier) == 36:
-            this_lb = self.lbaas.getLoadBalancer(identifier, mask="mask[id,uuid]")
+        mask = "mask[id,uuid]"
+        if isinstance(identifier, int):
+            this_lb = self.lbaas.getObject(id=identifier, mask=mask)
+        elif len(identifier) == 36 and utils.UUID_RE.match(identifier):
+            this_lb = self.lbaas.getLoadBalancer(identifier, mask=mask)
         else:
-            this_lb = self.lbaas.getObject(id=identifier, mask="mask[id,uuid]")
+            this_lb = self.get_lbaas_by_name(identifier, mask=mask)
+
         return this_lb.get('uuid'), this_lb.get('id')
 
-    def get_lbaas_by_address(self, address):
-        """Gets a LBaaS by address.
+    def get_lbaas_by_name(self, name, mask=None):
+        """Gets a LBaaS by name.
 
-        :param address: Address of the LBaaS instance
+        :param name: Name of the LBaaS instance
+        :param mask:
+        :returns: SoftLayer_Network_LBaaS_LoadBalancer or an empty dictionary if the name is not found.
         """
-        this_lb = {}
-        this_lbs = self.lbaas.getAllObjects()
-        for lbaas in this_lbs:
-            if lbaas.get('address') == address:
-                this_lb = lbaas
-                break
-        return this_lb
+        object_filter = {'name': {'operation': name}}
+        this_lbs = self.lbaas.getAllObjects(filter=object_filter, mask=mask)
+
+        return this_lbs[0] if this_lbs else {}
 
     def delete_lb_member(self, identifier, member_id):
         """Removes a member from a LBaaS instance
@@ -210,7 +212,7 @@ def order_lbaas(self, datacenter, name, desc, protocols, subnet_id, public=False
             'description': desc,
             'location': datacenter,
             'packageId': package.get('id'),
-            'useHourlyPricing': True,       # Required since LBaaS is an hourly service
+            'useHourlyPricing': True,  # Required since LBaaS is an hourly service
             'prices': [{'id': price_id} for price_id in prices],
             'protocolConfigurations': protocols,
             'subnets': [{'id': subnet_id}],

SoftLayer/utils.py

@@ -11,18 +11,8 @@
 
 # pylint: disable=no-member, invalid-name
 
-UUID_RE = re.compile(r'^[0-9a-f\-]{36}$', re.I)
+UUID_RE = re.compile(r'^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$', re.I)
 KNOWN_OPERATIONS = ['<=', '>=', '<', '>', '~', '!~', '*=', '^=', '$=', '_=']
-DOMAIN_RE = re.compile(r'[-a-zA-Z0-9.]{1,40}\.')
-
-
-def valid_domain(domain_name):
-    """Return whether or not given value is a valid domain.
-
-    :param domain_name: domain string to validate.
-
-    """
-    return DOMAIN_RE.match(domain_name)
 
 
 def lookup(dic, key, *keys):

tests/CLI/modules/loadbal_tests.py

@@ -7,7 +7,6 @@
 
 import SoftLayer
 from SoftLayer.CLI.exceptions import ArgumentError
-from SoftLayer.CLI.exceptions import CLIAbort
 from SoftLayer import exceptions
 from SoftLayer.fixtures import SoftLayer_Network_LBaaS_LoadBalancer
 from SoftLayer.fixtures import SoftLayer_Product_Package
@@ -217,15 +216,15 @@ def test_lb_detail(self):
         result = self.run_command(['lb', 'detail', '1111111'])
         self.assert_no_fail(result)
 
-    def test_lb_detail_by_address(self):
-        address = SoftLayer_Network_LBaaS_LoadBalancer.getObject.get('address')
-        result = self.run_command(['lb', 'detail', address])
+    def test_lb_detail_by_name(self):
+        name = SoftLayer_Network_LBaaS_LoadBalancer.getObject.get('name')
+        result = self.run_command(['lb', 'detail', name])
         self.assert_no_fail(result)
 
-    def test_lb_detail_address_not_found(self):
-        address = 'test-01-ams01.clb.appdomain.cloud'
-        result = self.run_command(['lb', 'detail', address])
-        self.assertIsInstance(result.exception, CLIAbort)
+    def test_lb_detail_uuid(self):
+        uuid = SoftLayer_Network_LBaaS_LoadBalancer.getObject.get('uuid')
+        result = self.run_command(['lb', 'detail', uuid])
+        self.assert_no_fail(result)
 
     def test_order(self):
         result = self.run_command(['loadbal', 'order', '--name', 'test', '--datacenter', 'par01', '--label',

tests/managers/loadbal_tests.py

@@ -79,6 +79,15 @@ def test_get_lbaas_uuid_id_id(self):
         self.assertEqual(lb_uuid, uuid)
         self.assertEqual(lb_id, my_id)
 
+    def test_get_lbaas_uuid_id_name(self):
+        uuid = '1a1aa111-4474-4e16-9f02-4de959229b85'
+        my_id = 1111111
+        name = 'test-01'
+        lb_uuid, lb_id = self.lb_mgr.get_lbaas_uuid_id(name)
+        self.assert_called_with('SoftLayer_Network_LBaaS_LoadBalancer', 'getAllObjects')
+        self.assertEqual(lb_uuid, uuid)
+        self.assertEqual(lb_id, my_id)
+
     def test_delete_lb_member(self):
         uuid = 'aa-bb-cc'
         member_id = 'dd-ee-ff'
@@ -178,8 +187,8 @@ def test_cancel_lbaas(self):
         self.lb_mgr.cancel_lbaas(uuid)
         self.assert_called_with('SoftLayer_Network_LBaaS_LoadBalancer', 'cancelLoadBalancer', args=(uuid,))
 
-    def test_get_lbaas_by_address(self):
-        address = SoftLayer_Network_LBaaS_LoadBalancer.getObject.get('address')
-        load_bal = self.lb_mgr.get_lbaas_by_address(address)
+    def test_get_lbaas_by_name(self):
+        name = SoftLayer_Network_LBaaS_LoadBalancer.getObject.get('name')
+        load_bal = self.lb_mgr.get_lbaas_by_name(name)
         self.assert_called_with('SoftLayer_Network_LBaaS_LoadBalancer', 'getAllObjects')
         self.assertIsNotNone(load_bal)