Merge branch 'release-v5.6.0'

Author: qrkourier

.github/workflows/main.yml

@@ -26,7 +26,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: '3.6'
+        python-version: '3.7'
 
     - name: Install dependencies
       run: |

netfoundry/ctl.py

@@ -7,8 +7,8 @@
 import time
 from unicodedata import name  # enforce a timeout; sleep
 
-from .utility import (DC_PROVIDERS, EXCLUDED_PATCH_PROPERTIES,
-                      MAJOR_REGIONS, NETWORK_RESOURCES, STATUS_CODES, VALID_SEPARATORS,
+from .utility import (DC_PROVIDERS, EXCLUDED_PATCH_PROPERTIES, MAJOR_REGIONS,
+                      NETWORK_RESOURCES, STATUS_CODES, VALID_SEPARATORS,
                       VALID_SERVICE_PROTOCOLS, Utility, docstring_parameters,
                       eprint, http, is_uuidv4, plural, singular)
 
@@ -337,9 +337,9 @@ def get_edge_router_data_centers(self, provider: str=None, location_code: str=No
 
         if response_code == STATUS_CODES.codes.OK: # HTTP 200
             try:
-                data_centers = json.loads(response.text)['_embedded']['dataCenters']
+                data_centers = response.json()['_embedded'][NETWORK_RESOURCES['data-centers']._embedded]
             except ValueError as e:
-                eprint('ERROR getting data centers')
+                logging.error('failed to load data centers response as object from JSON')
                 raise(e)
         else:
             raise Exception(
@@ -531,11 +531,11 @@ def get_resources(self, type: str, accept: str=None, deleted: bool=False, **kwar
             return([])
         # if there is one page of resources
         elif total_pages == 1:
-            all_entities = resources['_embedded'][NETWORK_RESOURCES[type]['embedded']]
+            all_entities = resources['_embedded'][NETWORK_RESOURCES[type]._embedded]
         # if there are multiple pages of resources
         else:
             # initialize the list with the first page of resources
-            all_entities = resources['_embedded'][NETWORK_RESOURCES[type]['embedded']]
+            all_entities = resources['_embedded'][NETWORK_RESOURCES[type]._embedded]
             # append the remaining pages of resources
             for page in range(1,total_pages):
                 try:
@@ -554,7 +554,7 @@ def get_resources(self, type: str, accept: str=None, deleted: bool=False, **kwar
                 if response_code == STATUS_CODES.codes.OK: # HTTP 200
                     try:
                         resources = json.loads(response.text)
-                        all_entities.extend(resources['_embedded'][NETWORK_RESOURCES[type]['embedded']])
+                        all_entities.extend(resources['_embedded'][NETWORK_RESOURCES[type]._embedded])
                     except ValueError as e:
                         eprint('ERROR: failed to load resources object from GET response')
                         raise(e)
@@ -909,7 +909,7 @@ def create_endpoint(self, name: str, attributes: list=[], session_identity: str=
         started = None
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['endpoints']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['endpoints'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1016,7 +1016,7 @@ def create_edge_router(self, name: str, attributes: list=[], link_listener: bool
             raise
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['edge-routers']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['edge-routers'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1095,7 +1095,7 @@ def create_edge_router_policy(self, name: str, endpoint_attributes: list=[], edg
             raise
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['edge-router-policies']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['edge-router-policies'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1249,7 +1249,7 @@ def create_service_simple(self, name: str, client_host_name: str, client_port: i
             raise
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['services']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['services'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1346,7 +1346,7 @@ def create_service_policy(self, name: str, services: list, endpoints: list, type
 
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['service-policies']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['service-policies'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1435,7 +1435,7 @@ def create_service_edge_router_policy(self, name: str, services: list, edge_rout
 
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['service-edge-router-policies']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['service-edge-router-policies'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1539,7 +1539,7 @@ def create_service_with_configs(self, name: str, intercept_config_data: dict, ho
 
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['services']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['services'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1857,7 +1857,7 @@ def create_service_advanced(self, name: str, endpoints: list, client_hosts: list
 
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['services']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['services'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -1937,7 +1937,7 @@ def create_app_wan(self, name: str, endpoint_attributes: list=[], service_attrib
             raise
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, NETWORK_RESOURCES['app-wans']['create_responses']):
+        if any_in(response_code_symbols, NETWORK_RESOURCES['app-wans'].create_responses):
             try:
                 started = json.loads(response.text)
             except ValueError as e:
@@ -2002,7 +2002,7 @@ def get_network_by_name(self,name: str,group: str=None):
             )
         hits = networks['page']['totalElements']
         if hits == 1:
-            network = networks['_embedded'][NETWORK_RESOURCES['networks']['embedded']][0]
+            network = networks['_embedded'][NETWORK_RESOURCES['networks']._embedded][0]
             return(network)
         else:
             raise Exception("ERROR: failed to find exactly one match for {}".format(name))
@@ -2210,7 +2210,6 @@ def wait_for_entity_name_exists(self, entity_name: str, entity_type: str, wait:
         :param: sleep SECONDS polling interval
         :param: progress print a horizontal progress meter as dots, default false
         """
-
         now = time.time()
 
         if not wait >= sleep:

netfoundry/network.py

@@ -199,7 +199,7 @@ def find_latest_product_version(self, product_versions: list=[]):
         from distutils.version import LooseVersion
         return sorted(product_versions, key=LooseVersion)[-1]
 
-    def create_network(self, name: str, network_group_id: str=None, location: str="us-east-1", version: str=None, size: str="small"):
+    def create_network(self, name: str, network_group_id: str=None, location: str="us-east-1", version: str=None, size: str="small", **kwargs):
         """
         Create a network in this network group.
 
@@ -213,11 +213,29 @@ def create_network(self, name: str, network_group_id: str=None, location: str="u
         if not location in my_nc_data_centers_by_location.keys():
             raise Exception("ERROR: unexpected Network location '{:s}'. Valid locations include: {}.".format(location, 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():
+            if param == 'networkGroupId':
+                if network_group_id:
+                    logging.debug("clobbering param 'network_group_id' with kwarg 'networkGroupId'")
+                network_group_id = value
+            elif param == 'locationCode':
+                if location:
+                    logging.debug("clobbering param 'location' with kwarg 'locationCode'")
+                location = value
+            elif param == 'productVersion':
+                if version:
+                    logging.debug("clobbering param 'version' with kwarg 'productVersion'")
+                version == value
+            else:
+                logging.warn("ignoring unexpected keyword argument '%s'", param)
+
         request = {
             "name": name,
             "locationCode": location,
             "size": size,
         }
+
         if network_group_id:
             request["networkGroupId"] = network_group_id
         else:
@@ -255,7 +273,7 @@ def create_network(self, name: str, network_group_id: str=None, location: str="u
 
         any_in = lambda a, b: any(i in b for i in a)
         response_code_symbols = [s.upper() for s in STATUS_CODES._codes[response_code]]
-        if any_in(response_code_symbols, RESOURCES['networks']['create_responses']):
+        if any_in(response_code_symbols, RESOURCES['networks'].create_responses):
             try:
                 network = json.loads(response.text)
             except ValueError as e:

netfoundry/network_group.py

@@ -8,11 +8,12 @@
 import time  # enforce a timeout; sleep
 from pathlib import Path
 
-import jwt
 from platformdirs import user_cache_path, user_config_path
 
-from .utility import RESOURCES, STATUS_CODES, Utility, eprint, http, is_uuidv4
 from .exceptions import NFAPINoCredentials
+from .utility import (MUTABLE_NETWORK_RESOURCES, NETWORK_RESOURCES,
+                      RESOURCES, STATUS_CODES, Utility, eprint, http,
+                      is_uuidv4)
 
 utility = Utility()
 
@@ -39,6 +40,7 @@ def __init__(self,
         organization_label: str=None,
         profile: str="default",
         token: str=None,
+        authorization: dict=dict(),
         expiry_minimum: int=600,
         proxy: str=None):
         """Initialize an instance of organization."""
@@ -108,9 +110,8 @@ def __init__(self,
         # if the token was found then extract the expiry
         if self.token:
             try:
-                claim = jwt.decode(jwt=self.token, algorithms=["RS256"], options={"verify_signature": False})
-            except jwt.exceptions.PyJWTError:
-                logging.error("failed to parse bearer token as JWT")
+                claim = utility.jwt_decode(self.token)
+            except:
                 raise
             else:
                 self.expiry = claim['exp']
@@ -204,10 +205,10 @@ def __init__(self,
         # renew token if not existing or imminent expiry, else continue
         if not self.token or self.expiry_seconds < expiry_minimum:
             if self.token and self.expiry_seconds < expiry_minimum:
-                logging.warn("token expiry %ds is less than configured minimum %ds", self.expiry_seconds, expiry_minimum)
+                logging.debug("token expiry %ds is less than configured minimum %ds", self.expiry_seconds, expiry_minimum)
             if not credentials_configured:
-                logging.error("credentials needed to renew token")
-                raise NFAPINoCredentials
+                logging.debug("credentials needed to renew token")
+                raise NFAPINoCredentials("credentials needed to renew token")
             else:
                 logging.debug("renewing token")
 
@@ -243,6 +244,7 @@ def __init__(self,
                 try:
                     token_text = json.loads(response.text)
                     self.token = token_text['access_token']
+                    self.expiry = token_text['expires_in']
                 except:
                     raise Exception(
                         'ERROR: failed to find an access_token in the response and instead got: {}'.format(
@@ -260,7 +262,7 @@ def __init__(self,
 
         # learn about the environment from the token
         try:
-            claim = jwt.decode(jwt=self.token, algorithms=["RS256"], options={"verify_signature": False})
+            claim = utility.jwt_decode(self.token)
             iss = claim['iss']
             if re.match(r'https://cognito-', iss):
                 self.environment = re.sub(r'https://gateway\.([^.]+)\.netfoundry\.io.*',r'\1',claim['scope'])
@@ -465,7 +467,6 @@ def get_organizations(self, **kwargs):
         params = dict()
         for param in kwargs.keys():
             params[param] = kwargs[param]
-
         try:
             headers = { "authorization": "Bearer " + self.token }
             response = http.get(
@@ -580,13 +581,13 @@ def get_network(self, network_id: str, embed: str=None, accept: str=None):
         headers["authorization"] = "Bearer " + self.token
         params = dict()
         if embed == "all":
-            params['embed'] = ','.join([type for type in RESOURCES.keys() if RESOURCES[type]['domain'] == "network"])
+            params['embed'] = ','.join(MUTABLE_NETWORK_RESOURCES)
             logging.debug("requesting embed all resource types in network domain: {:s}".format(params['embed']))
         elif embed:
             params['embed'] = ','.join([type for type in embed.split(',') if RESOURCES[type]['domain'] == "network"])
             logging.debug("requesting embed some resource types in network domain: {:s}".format(params['embed']))
             for type in embed.split(','):
-                if not type in [type for type in RESOURCES.keys() if RESOURCES[type]['domain'] == "network"]:
+                if not type in NETWORK_RESOURCES.keys():
                     logging.debug("not requesting embed of resource type '{:s}' because not a valid resource type or not in network domain".format(type))
         try:
             response = http.get(
@@ -664,7 +665,7 @@ def get_network_groups_by_organization(self, **kwargs):
         if total_elements == 0:
             return([])
         else:
-            network_groups = response_object['_embedded'][RESOURCES['network-groups']['embedded']]
+            network_groups = response_object['_embedded'][RESOURCES['network-groups']._embedded]
 
         # if there is one page of resources
         if total_pages == 1:
@@ -688,7 +689,7 @@ def get_network_groups_by_organization(self, **kwargs):
                 if response_code == STATUS_CODES.codes.OK: # HTTP 200
                     try:
                         response_object = response.json()
-                        network_groups.extend(response_object['_embedded'][RESOURCES['network-groups']['embedded']])
+                        network_groups.extend(response_object['_embedded'][RESOURCES['network-groups']._embedded])
                     except ValueError:
                         logging.error('failed loading list of network groups as object')
                         raise ValueError("response is not JSON")
@@ -761,11 +762,11 @@ def get_networks_by_organization(self, name: str=None, deleted: bool=False, **kw
             return([])
         # if there is one page of resources
         elif total_pages == 1:
-            all_entities = resources['_embedded'][RESOURCES['networks']['embedded']]
+            all_entities = resources['_embedded'][RESOURCES['networks']._embedded]
         # if there are multiple pages of resources
         else:
             # initialize the list with the first page of resources
-            all_entities = resources['_embedded'][RESOURCES['networks']['embedded']]
+            all_entities = resources['_embedded'][RESOURCES['networks']._embedded]
             # append the remaining pages of resources
             for page in range(1,total_pages):
                 try:
@@ -784,7 +785,7 @@ def get_networks_by_organization(self, name: str=None, deleted: bool=False, **kw
                 if response_code == STATUS_CODES.codes.OK: # HTTP 200
                     try:
                         resources = json.loads(response.text)
-                        all_entities.extend(resources['_embedded'][RESOURCES['networks']['embedded']])
+                        all_entities.extend(resources['_embedded'][RESOURCES['networks']._embedded])
                     except ValueError as e:
                         eprint('ERROR: failed to load resources object from GET response')
                         raise(e)
@@ -864,7 +865,7 @@ def get_networks_by_group(self,network_group_id: str, deleted: bool=False, **kwa
                 logging.error("response is not JSON")
                 raise ValueError("response is not JSON")
             try:
-                networks = embedded['_embedded'][RESOURCES['networks']['embedded']]
+                networks = embedded['_embedded'][RESOURCES['networks']._embedded]
             except KeyError:
                 networks = list()
         else: