add a constant NETWORK_RESOURCES to describe the types of resources in the network domain

Author: qrkourier

netfoundry/ctl.py

@@ -31,7 +31,7 @@
 from .network import Network
 from .network_group import NetworkGroup
 from .organization import Organization
-from .utility import RESOURCES, Utility, plural, singular
+from .utility import NETWORK_RESOURCES, RESOURCES, Utility, plural, singular
 from packaging import version
 
 set_metadata(version="v"+get_versions()['version']) # must precend import milc.cli
@@ -129,13 +129,13 @@ def login(cli, api: str=None, shell: bool=None):
         # configure the current shell)
         if not cli.args.shell and cli.config.general.output == "text":
             summary_table = [['domain', 'summary']]
-            summary_table.append(['organization', '"{org_name}" ({org_label}@{env}) logged in as {fullname} ({email}) until {expiry_timestamp} ({expiry_seconds}s)'.format(
+            summary_table.append(['organization', '"{org_name}" ({org_label}@{env}) logged in as {fullname} ({email}) until {expiry_timestamp} (T-{expiry_seconds}s)'.format(
                     fullname=summary_object['caller']['name'],
                     email=summary_object['caller']['email'],
                     org_label=organization.label,
                     org_name=organization.name,
                     env=organization.environment,
-                    expiry_timestamp=time.strftime('%Y-%m-%d %H:%M:%S GMT%z', time.localtime(organization.expiry)),
+                    expiry_timestamp=time.strftime('%H:%M GMT%z', time.localtime(organization.expiry)),
                     expiry_seconds=int(organization.expiry_seconds)
                 )])
             if network_group:
@@ -281,7 +281,7 @@ def whoami(cli, echo: bool=True, organization: object=None):
 
 @cli.argument('-f', '--file', help='JSON or YAML file', type=argparse.FileType('r', encoding='UTF-8'))
 @cli.argument('-w','--wait', help='seconds to wait for process execution to finish', default=0)
-@cli.argument('resource_type', arg_only=True, help='type of resource', choices=[singular(type) for type in RESOURCES.keys()])
+@cli.argument('resource_type', arg_only=True, help='type of resource', choices=[singular(type) for type in NETWORK_RESOURCES.keys()])
 @cli.subcommand('create a resource from stdin or file')
 def create(cli):
     """Create a resource.
@@ -293,8 +293,8 @@ def create(cli):
     # get the input object if available, else get the lines (serialized YAML or JSON) and try to deserialize
     create_input_object, create_input_lines, create_object = None, str(), None
     if sys.stdin.isatty() and not cli.args.file:
-        if 'create_template' in RESOURCES[plural(cli.args.resource_type)].keys():
-            create_input_object = RESOURCES[plural(cli.args.resource_type)]['create_template']
+        if 'create_template' in NETWORK_RESOURCES[plural(cli.args.resource_type)].keys():
+            create_input_object = NETWORK_RESOURCES[plural(cli.args.resource_type)]['create_template']
         else:
             create_input_object = {"hint": "No template was found for resource type {type}. Replace the contents of this buffer with the request body as YAML or JSON to create a resource. networkId will be added automatically.".format(type=cli.args.resource_type)}
     elif cli.args.file:
@@ -348,7 +348,7 @@ def create(cli):
         resource = network.create_resource(type=cli.args.resource_type, properties=create_object, wait=cli.config.create.wait)
 
 @cli.argument('query', arg_only=True, action=StoreDictKeyPair, nargs='?', help="id=UUIDv4 or query params as k=v,k=v comma-separated pairs")
-@cli.argument('resource_type', arg_only=True, help='type of resource', choices=[singular(type_name) for type_name, type_props in RESOURCES.items() if type_props['domain'] == "network"])
+@cli.argument('resource_type', arg_only=True, help='type of resource', choices=NETWORK_RESOURCES.keys())
 # this allows us to pass the edit subcommand's cli object to function get without further modifying that functions params
 @cli.argument('-a', '--accept', arg_only=True, default='update', help=argparse.SUPPRESS)
 @cli.subcommand('edit a single resource selected by query with editor defined in NETFOUNDRY_EDITOR or EDITOR')
@@ -407,7 +407,7 @@ def get(cli, echo: bool=True):
                     organization=organization,
                     network=cli.config.general.network,
                 )
-                match = network.describe
+                match = organization.get_network(network_id=network.id, embed="all", accept=cli.args.accept)
             else:
                 matches = organization.get_networks_by_organization(**cli.args.query)
             if len(matches) == 1:
@@ -552,7 +552,7 @@ def list(cli):
         cli.echo(json_dumps(filtered_matches, indent=4))
 
 @cli.argument('query', arg_only=True, action=StoreDictKeyPair, nargs='?', help="query params as k=v,k=v comma-separated pairs")
-@cli.argument('resource_type', arg_only=True, help='type of resource', choices=[singular(type) for type in RESOURCES.keys()])
+@cli.argument('resource_type', arg_only=True, help='type of resource', choices=[singular(type) for type in NETWORK_RESOURCES.keys()])
 @cli.argument('-w','--wait', help='seconds to wait for confirmation of delete', default=0)
 @cli.subcommand('delete a resource in the network domain')
 def delete(cli):

netfoundry/network.py

@@ -8,7 +8,7 @@
 from unicodedata import name  # enforce a timeout; sleep
 
 from .utility import (DC_PROVIDERS, EXCLUDED_PATCH_PROPERTIES,
-                      MAJOR_REGIONS, RESOURCES, STATUS_CODES, VALID_SEPARATORS,
+                      MAJOR_REGIONS, NETWORK_RESOURCES, STATUS_CODES, VALID_SEPARATORS,
                       VALID_SERVICE_PROTOCOLS, Utility, docstring_parameters,
                       eprint, http, is_uuidv4, plural, singular)
 
@@ -224,7 +224,7 @@ def validate_port_ranges(self, ports: list):
 
         return(valid_port_ranges)
 
-    @docstring_parameters(resource_entity_types=str(RESOURCES.keys()))
+    @docstring_parameters(resource_entity_types=str(NETWORK_RESOURCES.keys()))
     def validate_entity_roles(self, entities: list, type: str):
         """Return a list of valid, existing entities and hashtag role attributes.
         
@@ -418,11 +418,11 @@ def get_resource_by_id(self, type: str, id: str, accept: str=None):
             # if singular(type) == "service": 
             #     params["beta"] = ''
 
-            if not plural(type) in RESOURCES.keys():
+            if not plural(type) in NETWORK_RESOURCES.keys():
                 raise Exception("ERROR: unknown type \"{singular}\" as plural \"{plural}\". Choices: {choices}".format(
                     singular=type,
                     plural=plural(type),
-                    choices=RESOURCES.keys()
+                    choices=NETWORK_RESOURCES.keys()
                 ))
             elif plural(type) in ["edge-routers","network-controllers"]:
                 params['embed'] = "host"
@@ -456,7 +456,7 @@ def get_resource_by_id(self, type: str, id: str, accept: str=None):
 
     get_resource = get_resource_by_id
 
-    def get_resources(self, type: str, accept: str=None, deleted: bool=False, typeId: str=None, **kwargs):
+    def get_resources(self, type: str, accept: str=None, deleted: bool=False, **kwargs):
         """Find resources by type.
 
         :param str type: plural of an entity type e.g. networks, endpoints, services, posture-checks, etc...
@@ -465,7 +465,6 @@ def get_resources(self, type: str, accept: str=None, deleted: bool=False, typeId
                 "create" is useful for comparing an existing entity to a set of properties that are used to create the same type of
                 entity in a POST request, and "update" may be used in the same way for a PUT update.
         :param bool deleted: include resource entities that have a non-null property deletedAt
-        :param str typeId: filter results by typeId
         """
         # pluralize if singular
         if not type[-1] == "s":
@@ -491,13 +490,11 @@ def get_resources(self, type: str, accept: str=None, deleted: bool=False, typeId
                 params["sort"] = "name,asc"
             for param in kwargs.keys():
                 params[param] = kwargs[param]
-            if typeId is not None:
-                params['typeId'] = typeId
             if deleted:
                 params['status'] = "DELETED"
 
-            if not type in RESOURCES.keys():
-                raise Exception("ERROR: unknown type \"{}\". Choices: {}".format(type, RESOURCES.keys()))
+            if not type in NETWORK_RESOURCES.keys():
+                raise Exception("ERROR: unknown type \"{}\". Choices: {}".format(type, NETWORK_RESOURCES.keys()))
             elif type == "edge-routers":
                 params['embed'] = "host"
 
@@ -2202,7 +2199,7 @@ def wait_for_property_defined(self, property_name: str, property_type: object=st
                 )
             )
 
-    @docstring_parameters(resource_entity_types=str(RESOURCES.keys()))
+    @docstring_parameters(resource_entity_types=str(NETWORK_RESOURCES.keys()))
     def wait_for_entity_name_exists(self, entity_name: str, entity_type: str, wait: int=60, sleep: int=3, progress: bool=False):
         """Continuously poll until expiry for the expected entity name to exist.
 
@@ -2222,10 +2219,10 @@ def wait_for_entity_name_exists(self, entity_name: str, entity_type: str, wait:
                 )
             )
 
-        if not plural(entity_type) in RESOURCES.keys():
+        if not plural(entity_type) in NETWORK_RESOURCES.keys():
             raise Exception("ERROR: unknown type \"{type}\". Choices: {choices}".format(
                 type=entity_type,
-                choices=str(RESOURCES.keys())
+                choices=str(NETWORK_RESOURCES.keys())
             ))
 
         # poll for status until expiry

netfoundry/utility.py

@@ -193,6 +193,8 @@ def singular(plural):
     }
 }
 
+NETWORK_RESOURCES = {key: RESOURCES[key] for key in RESOURCES.keys() if RESOURCES[key]['domain'] == "network"}
+
 # TODO: [MOP-13441] associate locations with a short list of major geographic regions / continents
 MAJOR_REGIONS = {
     "AWS" : {