Commit 997275a7 authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

NBI Component - IETF Network plugin: 

- Extended implementation of get network method
- Added sort_data() method to properly compare in unitary test
- Corrected test case descriptors
- Added missing Python requirements
parent 7f99c921

src/nbi/requirements.in

+3 −1
Original line number Diff line number Diff line
@@ -17,5 +17,7 @@ Flask==2.1.3 
Flask-HTTPAuth==4.5.0

Flask-RESTful==0.3.9

jsonschema==4.4.0

pyang

git+https://github.com/robshakir/pyangbind.git

requests==2.27.1

werkzeug==2.3.7

src/nbi/service/rest_server/nbi_plugins/ietf_network/Networks.py

+93 −19
Original line number Diff line number Diff line
@@ -12,20 +12,28 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



import json, logging

import json, logging, re

from typing import Dict, Tuple

from flask import request

from flask.json import jsonify

from flask_restful import Resource

#from common.tools.context_queries.Slice import get_slice_by_uuid

import pyangbind.lib.pybindJSON as pybindJSON

from common.Constants import DEFAULT_CONTEXT_NAME, DEFAULT_TOPOLOGY_NAME

from common.proto.context_pb2 import ContextId

from common.tools.context_queries.Topology import get_topology_details

from common.tools.object_factory.Context import json_context_id

from context.client.ContextClient import ContextClient

from nbi.service.rest_server.nbi_plugins.ietf_network.Constants import CLIENT_ID, PROVIDER_ID

from nbi.service.rest_server.nbi_plugins.tools.Authentication import HTTP_AUTH

from nbi.service.rest_server.nbi_plugins.tools.HttpStatusCodes import HTTP_OK, HTTP_SERVERERROR

from .bindings import ietf_network, ietf_otn_topology

from .bindings import ietf_network



LOGGER = logging.getLogger(__name__)



ADMIN_CONTEXT_UUIDS  = {DEFAULT_CONTEXT_NAME}

ADMIN_TOPOLOGY_UUIDS = {DEFAULT_TOPOLOGY_NAME}



class Networks(Resource):

    @HTTP_AUTH.login_required

    def get(self):
@@ -37,29 +45,95 @@ class Networks(Resource): 
            #if target is None:

            #    raise Exception('VPN({:s}) not found in database'.format(str(vpn_id)))



            ietf_net = ietf_network()

            ietf_nets = ietf_network()



            topology_ids = context_client.ListTopologyIds(ContextId(**json_context_id(DEFAULT_CONTEXT_NAME)))

            for topology_id in topology_ids.topology_ids:

                context_uuid  = topology_id.context_id.context_uuid.uuid

                topology_uuid = topology_id.topology_uuid.uuid

                if context_uuid in ADMIN_CONTEXT_UUIDS and topology_uuid in ADMIN_TOPOLOGY_UUIDS: continue



                topology_details = get_topology_details(

                    context_client, topology_uuid, context_uuid=context_uuid, rw_copy=True

                )

                if topology_details is None:

                    MSG = 'Topology({:s}/{:s}) not found'

                    LOGGER.warning(MSG.format(context_uuid, topology_uuid))

                    continue



                topology_name = topology_details.name

                ietf_net = ietf_nets.networks.network.add(topology_name)

                ietf_net.te.name = 'Huawei-Network'



                match = re.match(r'providerId\-([^\-]*)-clientId-([^\-]*)-topologyId-([^\-]*)', topology_name)

                if match is not None:

                    provider_id, client_id, topology_id = match.groups()

                    ietf_net.te_topology_identifier.provider_id = int(provider_id)

                    ietf_net.te_topology_identifier.client_id   = int(client_id)

                    ietf_net.te_topology_identifier.topology_id = str(topology_id)



                ietf_net.network_types.te_topology._set_present()

                # TODO: resolve setting of otn_topology/eth_tran_topology network type; not working in bindings.

                # See below.

                # ietf_net.network_types.te_topology.otn_topology._set_present()

                # ietf_net.network_types.te_topology.eth_tran_topology._set_present()



                device_uuid_to_name   : Dict[str,             str] = dict()

                endpoint_uuid_to_name : Dict[Tuple[str, str], str] = dict()

                for device in topology_details.devices:

                    device_uuid = device.device_id.device_uuid.uuid

                    device_name = device.name

                    device_uuid_to_name[device_uuid] = device_name

                    device_uuid_to_name[device_name] = device_name

                    ietf_node = ietf_net.node.add(device_name)

                    ietf_node.te_node_id = device_name



                    for endpoint in device.device_endpoints:

                        endpoint_uuid = endpoint.endpoint_id.endpoint_uuid.uuid

                        endpoint_name = endpoint.name

                        if endpoint_name == 'mgmt': continue

                        endpoint_uuid_to_name[(device_uuid, endpoint_uuid)] = endpoint_name

                        endpoint_uuid_to_name[(device_name, endpoint_uuid)] = endpoint_name

                        endpoint_uuid_to_name[(device_uuid, endpoint_name)] = endpoint_name

                        endpoint_uuid_to_name[(device_name, endpoint_name)] = endpoint_name

                        ietf_node.termination_point.add(endpoint_name)



            ietf_otn = ietf_otn_topology()

            ietf_otn.

                for link in topology_details.links:

                    link_name = link.name

                    ietf_link = ietf_net.link.add(link_name)

                    #ietf_link.link_id = link_name

                    

            net1 = ietf_net.networks.network.add('providerId-10-clientId-0-topologyId-1')

            net1.te.name = 'Huawei-Network'

            net1.te_topology_identifier.provider_id = PROVIDER_ID

            net1.te_topology_identifier.client_id   = CLIENT_ID

            net1.te_topology_identifier.topology_id = '1'

            net1.network_types.te_topology._set_presence()

            net1.network_types.te_topology.otn_topology._set_presence()

                    src_dev_uuid = link.link_endpoint_ids[ 0].device_id.device_uuid.uuid

                    src_ep_uuid  = link.link_endpoint_ids[ 0].endpoint_uuid.uuid

                    ietf_link.source.source_node = device_uuid_to_name.get(

                        src_dev_uuid, src_dev_uuid

                    )

                    ietf_link.source.source_tp   = endpoint_uuid_to_name.get(

                        (src_dev_uuid, src_ep_uuid), src_ep_uuid

                    )



            net2 = ietf_net.networks.network.add('providerId-10-clientId-0-topologyId-2')

            net2.te.name = 'Huawei-Network'

            net2.te_topology_identifier.provider_id = PROVIDER_ID

            net2.te_topology_identifier.client_id   = CLIENT_ID

            net2.te_topology_identifier.topology_id = '2'

                    dst_dev_uuid = link.link_endpoint_ids[-1].device_id.device_uuid.uuid

                    dst_ep_uuid  = link.link_endpoint_ids[-1].endpoint_uuid.uuid

                    ietf_link.destination.dest_node = device_uuid_to_name.get(

                        dst_dev_uuid, dst_dev_uuid

                    )

                    ietf_link.destination.dest_tp   = endpoint_uuid_to_name.get(

                        (dst_dev_uuid, dst_ep_uuid), dst_ep_uuid

                    )



            # TODO: improve these workarounds to enhance performance

            json_response = json.loads(pybindJSON.dumps(ietf_nets, mode='ietf'))



            # TODO: workaround to set network types manually. Currently does not work; refine bindings.

            # Seems limitation of pyangbind using multiple augmentations and nested empty containers.

            for json_network in json_response['ietf-network:networks']['network']:

                net_te_topo_id = json_network.get('ietf-te-topology:te-topology-identifier', {}).get('topology-id')

                if net_te_topo_id is None: continue

                net_te_topo_type = json_network['network-types']['ietf-te-topology:te-topology']

                if net_te_topo_id == '1': net_te_topo_type['ietf-otn-topology:otn-topology'] = {}

                if net_te_topo_id == '2': net_te_topo_type['ietf-eth-te-topology:eth-tran-topology'] = {}



            # TODO: improve this workaround to enhance performance

            response = jsonify(json.loads(pybindJSON.dumps(ietf_net, mode='ietf')))

            response = jsonify(json_response)

            response.status_code = HTTP_OK

        except Exception as e: # pylint: disable=broad-except

            LOGGER.exception('Something went wrong Retrieving Topology({:s})'.format(str(topology_id)))

src/nbi/tests/data/descriptor-topology.json

deleted100644 → 0
+0 −201

File deleted.

Preview size limit exceeded, changes collapsed.

src/nbi/tests/data/topology-real.json

0 → 100644
+123 −0
Original line number Diff line number Diff line 
{

    "contexts": [

        {"context_id": {"context_uuid": {"uuid": "admin"}}, "name": "admin"}

    ],



    "topologies": [

        {"topology_id": {"topology_uuid": {"uuid": "admin"                                }, "context_id": {"context_uuid": {"uuid": "admin"}}}, "name": "admin"                                },

        {"topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}, "name": "providerId-10-clientId-0-topologyId-1"},

        {"topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-2"}, "context_id": {"context_uuid": {"uuid": "admin"}}}, "name": "providerId-10-clientId-0-topologyId-2"}

    ],



    "devices": [

        {"device_id": {"device_uuid": {"uuid": "nce-t"}}, "name": "nce-t", "device_type": "emu-open-line-system",

         "device_operational_status": 1, "device_drivers": [0], "device_config": {"config_rules": [

            {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "127.0.0.1"}},

            {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "0"}},

            {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {"endpoints": [

                {"uuid": "mgmt", "name": "mgmt", "context_uuid": "admin", "topology_uuid": "admin", "type": "mgmt"}

            ]}}}

        ]}},



        {"device_id": {"device_uuid": {"uuid": "10.0.10.1"}}, "name": "OA (PE)", "device_type": "emu-packet-router",

         "device_operational_status": 1, "device_drivers": [0], "device_config": {"config_rules": [

            {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "127.0.0.1"}},

            {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "0"}},

            {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {"endpoints": [

                {"uuid": "mgmt",     "name": "mgmt", "context_uuid": "admin", "topology_uuid": "admin",                                 "type": "mgmt"   },

                {"uuid": "uuid-200", "name": "200",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-2", "type": "copper" },

                {"uuid": "uuid-500", "name": "500",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"},

                {"uuid": "uuid-501", "name": "501",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"}

            ]}}}

        ]}},



        {"device_id": {"device_uuid": {"uuid": "10.0.20.1"}}, "name": "P 1", "device_type": "emu-optical-roadm",

         "device_operational_status": 1, "device_drivers": [0], "device_config": {"config_rules": [

            {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "127.0.0.1"}},

            {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "0"}},

            {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {"endpoints": [

                {"uuid": "mgmt",     "name": "mgmt", "context_uuid": "admin", "topology_uuid": "admin",                                 "type": "mgmt"   },

                {"uuid": "uuid-500", "name": "500",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"},

                {"uuid": "uuid-501", "name": "501",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"}

            ]}}}

        ]}},



        {"device_id": {"device_uuid": {"uuid": "10.0.30.1"}}, "name": "OE (PE)", "device_type": "emu-packet-router",

        "device_operational_status": 1, "device_drivers": [0], "device_config": {"config_rules": [

            {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "127.0.0.1"}},

            {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "0"}},

            {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {"endpoints": [

                {"uuid": "mgmt",     "name": "mgmt", "context_uuid": "admin", "topology_uuid": "admin",                                 "type": "mgmt"   },

                {"uuid": "uuid-200", "name": "200",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-2", "type": "copper" },

                {"uuid": "uuid-500", "name": "500",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"},

                {"uuid": "uuid-501", "name": "501",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"}

            ]}}}

       ]}},



       {"device_id": {"device_uuid": {"uuid": "10.0.40.1"}}, "name": "P 2", "device_type": "emu-optical-roadm",

       "device_operational_status": 1, "device_drivers": [0], "device_config": {"config_rules": [

          {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "127.0.0.1"}},

          {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "0"}},

          {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {"endpoints": [

              {"uuid": "mgmt",     "name": "mgmt", "context_uuid": "admin", "topology_uuid": "admin",                                 "type": "mgmt"   },

              {"uuid": "uuid-500", "name": "500",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"},

              {"uuid": "uuid-501", "name": "501",  "context_uuid": "admin", "topology_uuid": "providerId-10-clientId-0-topologyId-1", "type": "optical"}

          ]}}}

      ]}}

    ],



    "links": [

        {"link_id": {"link_uuid": {"uuid": "nce-t/mgmt==10.0.10.1/mgmt"}}, "name": "nce-t/mgmt==10.0.10.1/mgmt", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "nce-t"    }}, "endpoint_uuid": {"uuid": "mgmt"}},

            {"device_id": {"device_uuid": {"uuid": "10.0.10.1"}}, "endpoint_uuid": {"uuid": "mgmt"}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "nce-t/mgmt==10.0.20.1/mgmt"}}, "name": "nce-t/mgmt==10.0.20.1/mgmt", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "nce-t"    }}, "endpoint_uuid": {"uuid": "mgmt"}},

            {"device_id": {"device_uuid": {"uuid": "10.0.20.1"}}, "endpoint_uuid": {"uuid": "mgmt"}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "nce-t/mgmt==10.0.30.1/mgmt"}}, "name": "nce-t/mgmt==10.0.30.1/mgmt", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "nce-t"    }}, "endpoint_uuid": {"uuid": "mgmt"}},

            {"device_id": {"device_uuid": {"uuid": "10.0.30.1"}}, "endpoint_uuid": {"uuid": "mgmt"}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "nce-t/mgmt==10.0.40.1/mgmt"}}, "name": "nce-t/mgmt==10.0.40.1/mgmt", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "nce-t"    }}, "endpoint_uuid": {"uuid": "mgmt"}},

            {"device_id": {"device_uuid": {"uuid": "10.0.40.1"}}, "endpoint_uuid": {"uuid": "mgmt"}}

        ]},



        {"link_id": {"link_uuid": {"uuid": "10.0.10.1/501==10.0.20.1/501"}}, "name": "10.0.10.1/501==10.0.20.1/501", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.10.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.20.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "10.0.20.1/501==10.0.10.1/501"}}, "name": "10.0.20.1/501==10.0.10.1/501", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.20.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.10.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},



        {"link_id": {"link_uuid": {"uuid": "10.0.10.1/500==10.0.40.1/500"}}, "name": "10.0.10.1/500==10.0.40.1/500", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.10.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.40.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "10.0.40.1/500==10.0.10.1/500"}}, "name": "10.0.40.1/500==10.0.10.1/500", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.40.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.10.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},



        {"link_id": {"link_uuid": {"uuid": "10.0.20.1/500==10.0.30.1/500"}}, "name": "10.0.20.1/500==10.0.30.1/500", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.20.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.30.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "10.0.30.1/500==10.0.20.1/500"}}, "name": "10.0.30.1/500==10.0.20.1/500", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.30.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.20.1"}}, "endpoint_uuid": {"uuid": "uuid-500"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},



        {"link_id": {"link_uuid": {"uuid": "10.0.40.1/501==10.0.30.1/501"}}, "name": "10.0.40.1/501==10.0.30.1/501", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.40.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.30.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]},

        {"link_id": {"link_uuid": {"uuid": "10.0.30.1/501==10.0.40.1/501"}}, "name": "10.0.30.1/501==10.0.40.1/501", "link_endpoint_ids": [

            {"device_id": {"device_uuid": {"uuid": "10.0.30.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}},

            {"device_id": {"device_uuid": {"uuid": "10.0.40.1"}}, "endpoint_uuid": {"uuid": "uuid-501"}, "topology_id": {"topology_uuid": {"uuid": "providerId-10-clientId-0-topologyId-1"}, "context_id": {"context_uuid": {"uuid": "admin"}}}}

        ]}

    ]

}

src/nbi/tests/data/topology_dummy.json

0 → 100644
+335 −0

File added.

Preview size limit exceeded, changes collapsed.