finish adopting the regions endpoint

Author: qrkourier

netfoundry/ctl.py

@@ -487,6 +487,14 @@ def get(cli, echo: bool = True, spinner: object = None):
                 matches = organization.find_roles(**cli.args.query)
                 if len(matches) == 1:
                     match = matches[0]
+        elif cli.args.resource_type == "region":
+            if 'id' in query_keys:
+                cli.log.error("regions do not have an ID property, try provider and location_code params")
+                sysexit(1)
+            else:
+                matches = networks.find_regions(**cli.args.query)
+                if len(matches) == 1:
+                    match = matches[0]
         elif cli.args.resource_type == "network":
             if 'id' in query_keys:
                 if len(query_keys) > 1:
@@ -524,27 +532,15 @@ def get(cli, echo: bool = True, spinner: object = None):
             else:
                 cli.log.error("need --network=ACMENet")
                 sysexit(1)
-            if cli.args.resource_type == "region":
-                if 'id' in query_keys:
-                    cli.log.warn("regions fetched by ID may not support this network's product version, try provider or locationCode params for safety")
-                    if len(query_keys) > 1:
-                        query_keys.remove('id')
-                        cli.log.warn(f"using 'id' only, ignoring params: '{', '.join(query_keys)}'")
-                    match = network.get_region_by_id(id=cli.args.query['id'])
-                else:
-                    matches = networks.find_regions(**cli.args.query)
-                    if len(matches) == 1:
-                        match = network.get_region_by_id(id=matches[0]['id'])
+            if 'id' in query_keys:
+                if len(query_keys) > 1:
+                    query_keys.remove('id')
+                    cli.log.warn(f"using 'id' only, ignoring params: '{', '.join(query_keys)}'")
+                match = network.get_resource_by_id(type=cli.args.resource_type, id=cli.args.query['id'], accept=cli.args.accept)
             else:
-                if 'id' in query_keys:
-                    if len(query_keys) > 1:
-                        query_keys.remove('id')
-                        cli.log.warn(f"using 'id' only, ignoring params: '{', '.join(query_keys)}'")
-                    match = network.get_resource_by_id(type=cli.args.resource_type, id=cli.args.query['id'], accept=cli.args.accept)
-                else:
-                    matches = network.find_resources(type=cli.args.resource_type, accept=cli.args.accept, params=cli.args.query)
-                    if len(matches) == 1:
-                        match = matches[0]
+                matches = network.find_resources(type=cli.args.resource_type, accept=cli.args.accept, params=cli.args.query)
+                if len(matches) == 1:
+                    match = matches[0]
 
     if match:
         cli.log.debug(f"found exactly one {cli.args.resource_type} by '{', '.join(query_keys)}'")
@@ -686,6 +682,7 @@ def list(cli, echo: bool = True, spinner: object = None):
 
     valid_keys = set()
     for match in matches:
+        # cli.log.debug(match)
         valid_keys = valid_keys.union(match.keys())
 
     # intersection of the set of valid, observed keys in the first match
@@ -973,7 +970,7 @@ def demo(cli):
     # a list of locations to place a hosted router
     fabric_placements = []
     for region in cli.config.demo.regions:
-        region_matches = networks.find_regions(provider=cli.config.demo.provider, location_code=region)
+        region_matches = networks.find_regions(providers=[cli.config.demo.provider], location_code=region)
         if not len(region_matches) == 1:
             raise RuntimeError(f"invalid region '{region}'")
         else:

netfoundry/network.py

@@ -267,16 +267,6 @@ def validate_entity_roles(self, entities: list, type: str):
 
         return(valid_entities)
 
-    def get_region_by_id(self, id: str):
-        """Get data center region by UUIDv4.
-
-        :param id:        required UUIDv4 of data center
-        """
-        url = self.audience+'core/v2/regions/'+id
-        data_center, status_symbol = get_generic_resource_by_url(setup=self, url=url)
-        return(data_center)
-    get_data_center_by_id = get_region_by_id
-
     @docstring_parameters(providers=str(DC_PROVIDERS))
     def find_regions(self, **kwargs):
         """Find regions for hosted router placement.
@@ -632,15 +622,9 @@ def create_edge_router(self, name: str, attributes: list = list(), link_listener
             "linkListener": link_listener,
             "tunnelerEnabled": tunneler_enabled
         }
-        if data_center_id:
-            self.logger.warning('data_center_id is deprecated by provider, location_code. ')
-            data_center = self.get_data_center_by_id(id=data_center_id)
-            body['provider'] = data_center['provider']
-            body['locationCode'] = data_center['locationCode']
-            body['linkListener'] = True
-        elif provider or location_code:
+        if provider or location_code:
             if provider and location_code:
-                data_centers = self.get_edge_router_data_centers(provider=provider, location_code=location_code)
+                data_centers = self.find_regions(provider=provider, location_code=location_code)
                 if len(data_centers) == 1:
                     body['provider'] = provider
                     body['locationCode'] = location_code
@@ -1642,18 +1626,39 @@ def get_network_domain_resource(self,  resource_type: str, id: str, **kwargs):
         resource = get_generic_resource_by_url(setup=self, url=url, **params)
         return(resource)
 
-    def find_regions(self, **kwargs):
-        """Find regions."""
-        # data centers returns a list of dicts (data center objects)
-        params = dict()
-        for param in kwargs.keys():
-            params[param] = kwargs[param]
+    def find_regions(self, providers: list = [], provider: str = None, location_code: str = None):
+        """
+        Find regions.
 
-        if params.get('provider') and not params['provider'] in DC_PROVIDERS:
-                raise RuntimeError(f"unknown cloud provider '{params['provider']}'. Need one of {str(DC_PROVIDERS)}")
+        Optionally filter by provider, and optionally get exactly one region by sending both a single element for providers and a location_code
+
+        :param providers: optional list of providers from DC_PROVIDERS
+        :param provider: optional string matching one provider from DC_PROVIDERS
+        :param location_code: optional string that uniquely identifies a region for some provider
+        """
+        # regions returns a list of dicts (data center objects)
+
+        if provider:
+            providers.append(provider)
+
+        if providers:
+            for provider in providers:
+                if provider not in DC_PROVIDERS:
+                    raise RuntimeError(f"unknown cloud provider '{provider}'. Need one of {str(DC_PROVIDERS)}")
 
         url = self.audience+NET_RESOURCES['regions'].find_url
-        regions = list()
-        for i in find_generic_resources(setup=self, url=url, embedded=NET_RESOURCES['regions']._embedded, **params):
-            regions.extend(i)
-        return(regions)
+
+        if len(providers) == 1 and location_code:
+            url = f"{url}/{providers[0]}/{location_code}"
+            region, status = get_generic_resource_by_url(setup=self, url=url)
+            return([region])
+        else:
+            regions = list()
+            for i in find_generic_resources(setup=self, url=url, embedded=NET_RESOURCES['regions']._embedded, providers=providers):
+                regions.extend(i)
+
+            if location_code and len(regions) > 0:
+                regions = [r for r in regions if r['locationCode'] == location_code]
+                return(regions)
+            else:
+                return(regions)

netfoundry/network_group.py

@@ -1,5 +1,6 @@
 """Use a network group and find its networks."""
 
+# from .organization import Organization
 from .network import Networks
 from .utility import NET_RESOURCES, STATUS_CODES, caseless_equal, create_generic_resource, find_generic_resources, get_generic_resource_by_url, http, is_uuidv4, normalize_caseless
 
@@ -12,6 +13,7 @@ class NetworkGroup:
 
     def __init__(self, Organization: object, network_group_id: str = None, network_group_name: str = None, group: str = None):
         """Initialize the network group class with a group name or ID."""
+        # self.organization = Organization
         self.logger = Organization.logger
         self.network_groups = Organization.find_network_groups_by_organization()
         if (not network_group_id and not network_group_name) and group:
@@ -72,9 +74,9 @@ def __init__(self, Organization: object, network_group_id: str = None, network_g
     def map_region_id_by_location_code(self):
         """Map all region ids by their location code e.g. us-west-1: id."""
         region_map = dict()
-        for region in Networks.find_regions(provider='OCP') + Networks.find_regions(provider='AWS'):
-            region_map[region['locationCode']] = region['id']
-            # e.g. { us-east-1: 02f0eb51-fb7a-4d2e-8463-32bd9f6fa4d7 }
+        for region in Networks.find_regions(providers=['OCI', 'AWS']):
+            region_map[region['provider']-region['locationCode']] = region['name']
+            # e.g. { AWS-us-east-1: 02f0eb51-fb7a-4d2e-8463-32bd9f6fa4d7 }
         return(region_map)
     nc_data_centers_by_location = map_region_id_by_location_code
 
@@ -147,7 +149,7 @@ def find_latest_network_version(self, network_versions: list = list(), is_active
 
     find_latest_product_version = find_latest_network_version
 
-    def create_network(self, name: str, network_group_id: str = None, location: str = "us-east-1", version: str = None, size: str = "medium", wait: int = 1200, sleep: int = 10, **kwargs):
+    def create_network(self, name: str, network_group_id: str = None, location: str = "us-ashburn-1", provider: str = "OCI", version: str = None, size: str = "medium", wait: int = 1200, sleep: int = 10, **kwargs):
         """
         Create a network in this network group.
 
@@ -159,7 +161,7 @@ def create_network(self, name: str, network_group_id: str = None, location: str
         """
         # my_nc_data_centers_by_location = self.nc_data_centers_by_location()
         # if not my_nc_data_centers_by_location.get(location):
-            # raise RuntimeError(f"unexpected network location '{location}'. Valid locations include: {', '.join(my_nc_data_centers_by_location.keys())}.")
+        # raise RuntimeError(f"unexpected network location '{location}'. Valid locations include: {', '.join(my_nc_data_centers_by_location.keys())}.")
 
         # map incongruent api keys from kwargs to function params ("name", "size" are congruent)
         for param, value in kwargs.items():
@@ -178,13 +180,15 @@ def create_network(self, name: str, network_group_id: str = None, location: str
             else:
                 self.logger.warn(f"ignoring unexpected keyword argument '{param}'")
 
-        matching_regions = Networks.find_regions(region=location)
+        networks = Networks(setup=self)
+        matching_regions = networks.find_regions(provider=provider, location_code=location)
         if not len(matching_regions) == 1:
             raise RuntimeError(f"failed to find exactly one match for requested controller region '{location}'")
 
         body = {
             "name": name.strip('"'),
-            "locationCode": location,
+            "provider": provider,
+            "region": location,
             "size": size,
         }
 

netfoundry/utility.py

@@ -885,7 +885,7 @@ def __post_init__(self):
     }
 }
 
-DC_PROVIDERS = ["AWS", "AZURE", "GCP", "OCP"]
+DC_PROVIDERS = ["AWS", "AZURE", "GCP", "OCP", "OCI", "ALICLOUD", "NETFOUNDRY"]
 VALID_SERVICE_PROTOCOLS = ["tcp", "udp"]
 VALID_SEPARATORS = '[:-]'  # : or - will match regex pattern