build.main.Main._get_data() - Code Metrics - Inspection of "Enable/disable all interfaces from a switch" - kytos/topology - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#80)

unknown

created 2020-01-09 13:10 UTC

build.main.Main._get_data() A

↳ Parent: build.main

Complexity

Conditions

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	5
ccs	1
cts	1
cp	1
rs	10
c	0
b	0
f	0
cc	1
nop	1
crap	1

"""Main module of kytos/topology Kytos Network Application.

Manage the network topology
"""
from flask import jsonify, request
from kytos.core import KytosEvent, KytosNApp, log, rest
from kytos.core.helpers import listen_to
from kytos.core.interface import Interface
from kytos.core.link import Link
from kytos.core.switch import Switch

# from napps.kytos.topology import settings
from napps.kytos.topology.models import Topology


class Main(KytosNApp):  # pylint: disable=too-many-public-methods
    """Main class of kytos/topology NApp.

    This class is the entry point for this napp.
    """

    def setup(self):
        """Initialize the NApp's links list."""
        self.links = {}
        self.store_items = {}

        self.verify_storehouse('switches')
        self.verify_storehouse('interfaces')
        self.verify_storehouse('links')

    def execute(self):
        """Do nothing."""

    def shutdown(self):
        """Do nothing."""
        log.info('NApp kytos/topology shutting down.')

    def _get_link_or_create(self, endpoint_a, endpoint_b):
        new_link = Link(endpoint_a, endpoint_b)

        for link in self.links.values():
            if new_link == link:
                return link

        self.links[new_link.id] = new_link
        return new_link

    def _get_switches_dict(self):
        """Return a dictionary with the known switches."""
        return {'switches': {s.id: s.as_dict() for s in
                             self.controller.switches.values()}}

    def _get_links_dict(self):
        """Return a dictionary with the known links."""
        return {'links': {l.id: l.as_dict() for l in
                          self.links.values()}}

    def _get_topology_dict(self):
        """Return a dictionary with the known topology."""
        return {'topology': {**self._get_switches_dict(),
                             **self._get_links_dict()}}

    def _get_topology(self):
        """Return an object representing the topology."""
        return Topology(self.controller.switches, self.links)

    def _get_link_from_interface(self, interface):
        """Return the link of the interface, or None if it does not exist."""
        for link in self.links.values():
            if interface in (link.endpoint_a, link.endpoint_b):
                return link
        return None

    @staticmethod
    def _get_data(req):
        """Get request data."""
        data = req.get_json() or {}  # Valid format { "interfaces": [...] }
        return data.get('interfaces', [])

    @rest('v3/')
    def get_topology(self):
        """Return the latest known topology.

        This topology is updated when there are network events.
        """
        return jsonify(self._get_topology_dict())

    # Switch related methods
    @rest('v3/switches')
    def get_switches(self):
        """Return a json with all the switches in the topology."""
        return jsonify(self._get_switches_dict())

    @rest('v3/switches/<dpid>/enable', methods=['POST'])
    def enable_switch(self, dpid):
        """Administratively enable a switch in the topology."""
        try:
            self.controller.switches[dpid].enable()
            return jsonify("Operation successful"), 201
        except KeyError:
            return jsonify("Switch not found"), 404

    @rest('v3/switches/<dpid>/disable', methods=['POST'])
    def disable_switch(self, dpid):
        """Administratively disable a switch in the topology."""
        try:
            self.controller.switches[dpid].disable()
            return jsonify("Operation successful"), 201
        except KeyError:
            return jsonify("Switch not found"), 404

    @rest('v3/switches/<dpid>/metadata')
    def get_switch_metadata(self, dpid):
        """Get metadata from a switch."""
        try:
            return jsonify({"metadata":
                            self.controller.switches[dpid].metadata}), 200
        except KeyError:
            return jsonify("Switch not found"), 404

    @rest('v3/switches/<dpid>/metadata', methods=['POST'])
    def add_switch_metadata(self, dpid):
        """Add metadata to a switch."""
        metadata = request.get_json()
        try:
            switch = self.controller.switches[dpid]
        except KeyError:
            return jsonify("Switch not found"), 404

        switch.extend_metadata(metadata)
        self.notify_metadata_changes(switch, 'added')
        return jsonify("Operation successful"), 201

    @rest('v3/switches/<dpid>/metadata/<key>', methods=['DELETE'])
    def delete_switch_metadata(self, dpid, key):
        """Delete metadata from a switch."""
        try:
            switch = self.controller.switches[dpid]
        except KeyError:
            return jsonify("Switch not found"), 404

        switch.remove_metadata(key)
        self.notify_metadata_changes(switch, 'removed')
        return jsonify("Operation successful"), 200

    # Interface related methods
    @rest('v3/interfaces')
    def get_interfaces(self):
        """Return a json with all the interfaces in the topology."""
        interfaces = {}
        switches = self._get_switches_dict()
        for switch in switches['switches'].values():
            for interface_id, interface in switch['interfaces'].items():
                interfaces[interface_id] = interface

        return jsonify({'interfaces': interfaces})

    @rest('v3/interfaces/<interface_enable_id>/enable', methods=['POST'])

    @rest('v3/interfaces/enable', methods=['POST'])
    def enable_interface(self, interface_enable_id):
        """Administratively enable a list of interfaces in the topology"""
        error_list = []  # List of interfaces that were not activated.
        interface_ids = self._get_data(request)
        if interface_enable_id:
            interface_ids.append(interface_enable_id)
        for interface_id in interface_ids:
            switch_id = ":".join(interface_id.split(":")[:-1])
            interface_number = int(interface_id.split(":")[-1])

            try:
                switch = self.controller.switches[switch_id]
            except KeyError:
                return jsonify("Switch not found"), 404

            try:
                switch.interfaces[interface_number].enable()
            except KeyError:
                error_list.append(interface_id)

        if not error_list:
            return jsonify("Operation successful"), 201
        msg_error = "Some interfaces couldn't be found and activated: "
        return jsonify({msg_error:
                        error_list}), 409

    @rest('v3/interfaces/<interface_disable_id>/disable', methods=['POST'])

    @rest('v3/interfaces/disable', methods=['POST'])
    def disable_interface(self, interface_disable_id):
        """Administratively disable a list of interfaces in the topology"""
        error_list = []  # List of interfaces that were not deactivated.
        interface_ids = self._get_data(request)
        if interface_disable_id:
            interface_ids.append(interface_disable_id)
        for interface_id in interface_ids:
            switch_id = ":".join(interface_id.split(":")[:-1])
            interface_number = int(interface_id.split(":")[-1])

            try:
                switch = self.controller.switches[switch_id]
            except KeyError:
                return jsonify("Switch not found"), 404

            try:
                switch.interfaces[interface_number].disable()
            except KeyError:
                error_list.append(interface_id)

        if not error_list:
            return jsonify("Operation successful"), 201
        msg_error = "Some interfaces couldn't be found and deactivated:"
        return jsonify({msg_error:
                        error_list}), 409

    @rest('v3/interfaces/<interface_id>/metadata')
    def get_interface_metadata(self, interface_id):
        """Get metadata from an interface."""
        switch_id = ":".join(interface_id.split(":")[:-1])
        interface_number = int(interface_id.split(":")[-1])
        try:
            switch = self.controller.switches[switch_id]
        except KeyError:
            return jsonify("Switch not found"), 404

        try:
            interface = switch.interfaces[interface_number]
        except KeyError:
            return jsonify("Interface not found"), 404

        return jsonify({"metadata": interface.metadata}), 200

    @rest('v3/interfaces/<interface_id>/metadata', methods=['POST'])
    def add_interface_metadata(self, interface_id):
        """Add metadata to an interface."""
        metadata = request.get_json()

        switch_id = ":".join(interface_id.split(":")[:-1])
        interface_number = int(interface_id.split(":")[-1])
        try:
            switch = self.controller.switches[switch_id]
        except KeyError:
            return jsonify("Switch not found"), 404

        try:
            interface = switch.interfaces[interface_number]
        except KeyError:
            return jsonify("Interface not found"), 404

        interface.extend_metadata(metadata)
        self.notify_metadata_changes(interface, 'added')
        return jsonify("Operation successful"), 201

    @rest('v3/interfaces/<interface_id>/metadata/<key>', methods=['DELETE'])
    def delete_interface_metadata(self, interface_id, key):
        """Delete metadata from an interface."""
        switch_id = ":".join(interface_id.split(":")[:-1])
        interface_number = int(interface_id.split(":")[-1])

        try:
            switch = self.controller.switches[switch_id]
        except KeyError:
            return jsonify("Switch not found"), 404

        try:
            interface = switch.interfaces[interface_number]
        except KeyError:
            return jsonify("Interface not found"), 404

        if interface.remove_metadata(key) is False:
            return jsonify("Metadata not found"), 404

        self.notify_metadata_changes(interface, 'removed')
        return jsonify("Operation successful"), 200

    # Link related methods
    @rest('v3/links')
    def get_links(self):
        """Return a json with all the links in the topology.

        Links are connections between interfaces.
        """
        return jsonify(self._get_links_dict()), 200

    @rest('v3/links/<link_id>/enable', methods=['POST'])
    def enable_link(self, link_id):
        """Administratively enable a link in the topology."""
        try:
            self.links[link_id].enable()
        except KeyError:
            return jsonify("Link not found"), 404

        return jsonify("Operation successful"), 201

    @rest('v3/links/<link_id>/disable', methods=['POST'])
    def disable_link(self, link_id):
        """Administratively disable a link in the topology."""
        try:
            self.links[link_id].disable()
        except KeyError:
            return jsonify("Link not found"), 404

        return jsonify("Operation successful"), 201

    @rest('v3/links/<link_id>/metadata')
    def get_link_metadata(self, link_id):
        """Get metadata from a link."""
        try:
            return jsonify({"metadata": self.links[link_id].metadata}), 200
        except KeyError:
            return jsonify("Link not found"), 404

    @rest('v3/links/<link_id>/metadata', methods=['POST'])
    def add_link_metadata(self, link_id):
        """Add metadata to a link."""
        metadata = request.get_json()
        try:
            link = self.links[link_id]
        except KeyError:
            return jsonify("Link not found"), 404

        link.extend_metadata(metadata)
        self.notify_metadata_changes(link, 'added')
        return jsonify("Operation successful"), 201

    @rest('v3/links/<link_id>/metadata/<key>', methods=['DELETE'])
    def delete_link_metadata(self, link_id, key):
        """Delete metadata from a link."""
        try:
            link = self.links[link_id]
        except KeyError:
            return jsonify("Link not found"), 404

        if link.remove_metadata(key) is False:
            return jsonify("Metadata not found"), 404

        self.notify_metadata_changes(link, 'removed')
        return jsonify("Operation successful"), 200

    @listen_to('.*.switch.(new|reconnected)')
    def handle_new_switch(self, event):
        """Create a new Device on the Topology.

        Handle the event of a new created switch and update the topology with
        this new device.
        """
        switch = event.content['switch']
        switch.activate()
        log.debug('Switch %s added to the Topology.', switch.id)
        self.notify_topology_update()
        self.update_instance_metadata(switch)

    @listen_to('.*.connection.lost')
    def handle_connection_lost(self, event):
        """Remove a Device from the topology.

        Remove the disconnected Device and every link that has one of its
        interfaces.
        """
        switch = event.content['source'].switch
        if switch:
            switch.deactivate()
            log.debug('Switch %s removed from the Topology.', switch.id)
            self.notify_topology_update()

    def handle_interface_up(self, event):
        """Update the topology based on a Port Modify event.

        The event notifies that an interface was changed to 'up'.
        """
        interface = event.content['interface']
        interface.activate()
        self.notify_topology_update()
        self.update_instance_metadata(interface)

    @listen_to('.*.switch.interface.created')
    def handle_interface_created(self, event):
        """Update the topology based on a Port Create event."""
        self.handle_interface_up(event)

    def handle_interface_down(self, event):
        """Update the topology based on a Port Modify event.

        The event notifies that an interface was changed to 'down'.
        """
        interface = event.content['interface']
        interface.deactivate()
        self.handle_interface_link_down(event)
        self.notify_topology_update()

    @listen_to('.*.switch.interface.deleted')
    def handle_interface_deleted(self, event):
        """Update the topology based on a Port Delete event."""
        self.handle_interface_down(event)

    @listen_to('.*.switch.interface.link_up')
    def handle_interface_link_up(self, event):
        """Update the topology based on a Port Modify event.

        The event notifies that an interface's link was changed to 'up'.
        """
        interface = event.content['interface']
        link = self._get_link_from_interface(interface)
        if link and not link.is_active():
            link.activate()
            self.notify_topology_update()
            self.update_instance_metadata(interface.link)
            self.notify_link_status_change(link)

    @listen_to('.*.switch.interface.link_down')
    def handle_interface_link_down(self, event):
        """Update the topology based on a Port Modify event.

        The event notifies that an interface's link was changed to 'down'.
        """
        interface = event.content['interface']
        link = self._get_link_from_interface(interface)
        if link and link.is_active():
            link.deactivate()
            self.notify_topology_update()
            self.notify_link_status_change(link)

    @listen_to('.*.interface.is.nni')
    def add_links(self, event):
        """Update the topology with links related to the NNI interfaces."""
        interface_a = event.content['interface_a']
        interface_b = event.content['interface_b']

        link = self._get_link_or_create(interface_a, interface_b)
        interface_a.update_link(link)
        interface_b.update_link(link)

        interface_a.nni = True
        interface_b.nni = True

        self.notify_topology_update()

    # def add_host(self, event):
    #    """Update the topology with a new Host."""

    #    interface = event.content['port']
    #    mac = event.content['reachable_mac']

    #    host = Host(mac)
    #    link = self.topology.get_link(interface.id)
    #    if link is not None:
    #        return

    #    self.topology.add_link(interface.id, host.id)
    #    self.topology.add_device(host)

    #    if settings.DISPLAY_FULL_DUPLEX_LINKS:
    #        self.topology.add_link(host.id, interface.id)

    def notify_topology_update(self):
        """Send an event to notify about updates on the topology."""
        name = 'kytos/topology.updated'
        event = KytosEvent(name=name, content={'topology':
                                               self._get_topology()})
        self.controller.buffers.app.put(event)

    def notify_link_status_change(self, link):
        """Send an event to notify about a status change on a link."""
        name = 'kytos/topology.'
        if link.is_active():
            status = 'link_up'
        else:
            status = 'link_down'
        event = KytosEvent(name=name+status, content={'link': link})
        self.controller.buffers.app.put(event)

    def notify_metadata_changes(self, obj, action):
        """Send an event to notify about metadata changes."""
        if isinstance(obj, Switch):
            entity = 'switch'
            entities = 'switches'
        elif isinstance(obj, Interface):
            entity = 'interface'
            entities = 'interfaces'
        elif isinstance(obj, Link):
            entity = 'link'
            entities = 'links'

        name = f'kytos/topology.{entities}.metadata.{action}'
        event = KytosEvent(name=name, content={entity: obj,

                                               'metadata': obj.metadata})
        self.controller.buffers.app.put(event)
        log.debug(f'Metadata from {obj.id} was {action}.')

    @listen_to('.*.switch.port.created')
    def notify_port_created(self, original_event):
        """Notify when a port is created."""
        name = f'kytos/topology.port.created'
        event = KytosEvent(name=name, content=original_event.content)
        self.controller.buffers.app.put(event)

    @listen_to('kytos/topology.*.metadata.*')
    def save_metadata_on_store(self, event):
        """Send to storehouse the data updated."""
        name = 'kytos.storehouse.update'
        if 'switch' in event.content:
            store = self.store_items.get('switches')
            obj = event.content.get('switch')
            namespace = 'kytos.topology.switches.metadata'
        elif 'interface' in event.content:
            store = self.store_items.get('interfaces')
            obj = event.content.get('interface')
            namespace = 'kytos.topology.iterfaces.metadata'
        elif 'link' in event.content:
            store = self.store_items.get('links')
            obj = event.content.get('link')
            namespace = 'kytos.topology.links.metadata'

        store.data[obj.id] = obj.metadata

        content = {'namespace': namespace,

                   'box_id': store.box_id,
                   'data': store.data,
                   'callback': self.update_instance}

        event = KytosEvent(name=name, content=content)
        self.controller.buffers.app.put(event)

    @staticmethod
    def update_instance(event, _data, error):
        """Display in Kytos console if the data was updated."""
        entities = event.content.get('namespace', '').split('.')[-2]
        if error:
            log.error(f'Error trying to update storehouse {entities}.')
        else:
            log.debug(f'Storehouse update to entities: {entities}.')

    def verify_storehouse(self, entities):
        """Request a list of box saved by specific entity."""
        name = 'kytos.storehouse.list'
        content = {'namespace': f'kytos.topology.{entities}.metadata',
                   'callback': self.request_retrieve_entities}
        event = KytosEvent(name=name, content=content)
        self.controller.buffers.app.put(event)
        log.info(f'verify data in storehouse for {entities}.')

    def request_retrieve_entities(self, event, data, _error):
        """Create a box or retrieve an existent box from storehouse."""
        msg = ''
        content = {'namespace': event.content.get('namespace'),
                   'callback': self.load_from_store,
                   'data': {}}

        if not data:
            name = 'kytos.storehouse.create'
            msg = 'Create new box in storehouse'
        else:
            name = 'kytos.storehouse.retrieve'
            content['box_id'] = data[0]
            msg = 'Retrieve data from storeohouse.'

        event = KytosEvent(name=name, content=content)
        self.controller.buffers.app.put(event)
        log.debug(msg)

    def load_from_store(self, event, box, error):
        """Save the data retrived from storehouse."""
        entities = event.content.get('namespace', '').split('.')[-2]
        if error:
            log.error('Error while get a box from storehouse.')
        else:
            self.store_items[entities] = box
            log.debug('Data updated')

    def update_instance_metadata(self, obj):
        """Update object instance with saved metadata."""
        metadata = None
        if isinstance(obj, Interface):
            all_metadata = self.store_items.get('interfaces', None)
            if all_metadata:
                metadata = all_metadata.data.get(obj.id)
        elif isinstance(obj, Switch):
            all_metadata = self.store_items.get('switches', None)
            if all_metadata:
                metadata = all_metadata.data.get(obj.id)
        elif isinstance(obj, Link):
            all_metadata = self.store_items.get('links', None)
            if all_metadata:
                metadata = all_metadata.data.get(obj.id)

        if metadata:
            obj.extend_metadata(metadata)
            log.debug(f'Metadata to {obj.id} was updated')


1			"""Main module of kytos/topology Kytos Network Application.
2
3			Manage the network topology
4			"""
5	1		from flask import jsonify, request
6	1		from kytos.core import KytosEvent, KytosNApp, log, rest
7	1		from kytos.core.helpers import listen_to
8	1		from kytos.core.interface import Interface
9	1		from kytos.core.link import Link
10	1		from kytos.core.switch import Switch
11
12			# from napps.kytos.topology import settings
13	1		from napps.kytos.topology.models import Topology
14
15
16	1		class Main(KytosNApp): # pylint: disable=too-many-public-methods
17			"""Main class of kytos/topology NApp.
18
19			This class is the entry point for this napp.
20			"""
21
22	1		def setup(self):
23			"""Initialize the NApp's links list."""
24	1		self.links = {}
25	1		self.store_items = {}
26
27	1		self.verify_storehouse('switches')
28	1		self.verify_storehouse('interfaces')
29	1		self.verify_storehouse('links')
30
31	1		def execute(self):
32			"""Do nothing."""
33
34	1		def shutdown(self):
35			"""Do nothing."""
36			log.info('NApp kytos/topology shutting down.')
37
38	1		def _get_link_or_create(self, endpoint_a, endpoint_b):
39			new_link = Link(endpoint_a, endpoint_b)
40
41			for link in self.links.values():
42			if new_link == link:
43			return link
44
45			self.links[new_link.id] = new_link
46			return new_link
47
48	1		def _get_switches_dict(self):
49			"""Return a dictionary with the known switches."""
50			return {'switches': {s.id: s.as_dict() for s in
51			self.controller.switches.values()}}
52
53	1		def _get_links_dict(self):
54			"""Return a dictionary with the known links."""
55			return {'links': {l.id: l.as_dict() for l in
56			self.links.values()}}
57
58	1		def _get_topology_dict(self):
59			"""Return a dictionary with the known topology."""
60			return {'topology': {**self._get_switches_dict(),
61			**self._get_links_dict()}}
62
63	1		def _get_topology(self):
64			"""Return an object representing the topology."""
65			return Topology(self.controller.switches, self.links)
66
67	1		def _get_link_from_interface(self, interface):
68			"""Return the link of the interface, or None if it does not exist."""
69			for link in self.links.values():
70			if interface in (link.endpoint_a, link.endpoint_b):
71			return link
72			return None
73
74	1		@staticmethod
75			def _get_data(req):
76			"""Get request data."""
77			data = req.get_json() or {} # Valid format { "interfaces": [...] }
78			return data.get('interfaces', [])
79
80			@rest('v3/')
81			def get_topology(self):
82			"""Return the latest known topology.
83	1
84			This topology is updated when there are network events.
85			"""
86			return jsonify(self._get_topology_dict())
87
88	1		# Switch related methods
89			@rest('v3/switches')
90			def get_switches(self):
91			"""Return a json with all the switches in the topology."""
92			return jsonify(self._get_switches_dict())
93
94			@rest('v3/switches/<dpid>/enable', methods=['POST'])
95			def enable_switch(self, dpid):
96			"""Administratively enable a switch in the topology."""
97	1		try:
98			self.controller.switches[dpid].enable()
99			return jsonify("Operation successful"), 201
100			except KeyError:
101			return jsonify("Switch not found"), 404
102
103			@rest('v3/switches/<dpid>/disable', methods=['POST'])
104			def disable_switch(self, dpid):
105			"""Administratively disable a switch in the topology."""
106	1		try:
107			self.controller.switches[dpid].disable()
108			return jsonify("Operation successful"), 201
109			except KeyError:
110			return jsonify("Switch not found"), 404
111
112			@rest('v3/switches/<dpid>/metadata')
113			def get_switch_metadata(self, dpid):
114			"""Get metadata from a switch."""
115	1		try:
116			return jsonify({"metadata":
117			self.controller.switches[dpid].metadata}), 200
118			except KeyError:
119			return jsonify("Switch not found"), 404
120
121			@rest('v3/switches/<dpid>/metadata', methods=['POST'])
122			def add_switch_metadata(self, dpid):
123			"""Add metadata to a switch."""
124			metadata = request.get_json()
125			try:
126			switch = self.controller.switches[dpid]
127			except KeyError:
128	1		return jsonify("Switch not found"), 404
129
130			switch.extend_metadata(metadata)
131			self.notify_metadata_changes(switch, 'added')
132			return jsonify("Operation successful"), 201
133
134			@rest('v3/switches/<dpid>/metadata/<key>', methods=['DELETE'])
135			def delete_switch_metadata(self, dpid, key):
136			"""Delete metadata from a switch."""
137			try:
138			switch = self.controller.switches[dpid]
139			except KeyError:
140			return jsonify("Switch not found"), 404
141	1
142			switch.remove_metadata(key)
143			self.notify_metadata_changes(switch, 'removed')
144			return jsonify("Operation successful"), 200
145
146			# Interface related methods
147			@rest('v3/interfaces')
148			def get_interfaces(self):
149			"""Return a json with all the interfaces in the topology."""
150			interfaces = {}
151			switches = self._get_switches_dict()
152	1		for switch in switches['switches'].values():
153			for interface_id, interface in switch['interfaces'].items():
154			interfaces[interface_id] = interface
155
156			return jsonify({'interfaces': interfaces})
157
158		View Code Duplication	@rest('v3/interfaces/<interface_enable_id>/enable', methods=['POST'])
			0 ignored issues – show Duplication introduced 2019-02-27 14:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
159			@rest('v3/interfaces/enable', methods=['POST'])
160			def enable_interface(self, interface_enable_id):
161			"""Administratively enable a list of interfaces in the topology"""
162			error_list = [] # List of interfaces that were not activated.
163			interface_ids = self._get_data(request)
164			if interface_enable_id:
165			interface_ids.append(interface_enable_id)
166			for interface_id in interface_ids:
167			switch_id = ":".join(interface_id.split(":")[:-1])
168			interface_number = int(interface_id.split(":")[-1])
169
170	1		try:
171			switch = self.controller.switches[switch_id]
172			except KeyError:
173			return jsonify("Switch not found"), 404
174
175			try:
176			switch.interfaces[interface_number].enable()
177			except KeyError:
178			error_list.append(interface_id)
179
180			if not error_list:
181			return jsonify("Operation successful"), 201
182			msg_error = "Some interfaces couldn't be found and activated: "
183			return jsonify({msg_error:
184			error_list}), 409
185
186		View Code Duplication	@rest('v3/interfaces/<interface_disable_id>/disable', methods=['POST'])
			0 ignored issues – show Duplication introduced 2019-02-27 14:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
187			@rest('v3/interfaces/disable', methods=['POST'])
188	1		def disable_interface(self, interface_disable_id):
189			"""Administratively disable a list of interfaces in the topology"""
190			error_list = [] # List of interfaces that were not deactivated.
191			interface_ids = self._get_data(request)
192			if interface_disable_id:
193			interface_ids.append(interface_disable_id)
194			for interface_id in interface_ids:
195			switch_id = ":".join(interface_id.split(":")[:-1])
196			interface_number = int(interface_id.split(":")[-1])
197
198			try:
199			switch = self.controller.switches[switch_id]
200			except KeyError:
201			return jsonify("Switch not found"), 404
202
203			try:
204			switch.interfaces[interface_number].disable()
205	1		except KeyError:
206			error_list.append(interface_id)
207
208			if not error_list:
209			return jsonify("Operation successful"), 201
210			msg_error = "Some interfaces couldn't be found and deactivated:"
211			return jsonify({msg_error:
212			error_list}), 409
213
214			@rest('v3/interfaces/<interface_id>/metadata')
215			def get_interface_metadata(self, interface_id):
216			"""Get metadata from an interface."""
217			switch_id = ":".join(interface_id.split(":")[:-1])
218			interface_number = int(interface_id.split(":")[-1])
219			try:
220			switch = self.controller.switches[switch_id]
221			except KeyError:
222			return jsonify("Switch not found"), 404
223
224			try:
225			interface = switch.interfaces[interface_number]
226	1		except KeyError:
227			return jsonify("Interface not found"), 404
228
229			return jsonify({"metadata": interface.metadata}), 200
230
231			@rest('v3/interfaces/<interface_id>/metadata', methods=['POST'])
232			def add_interface_metadata(self, interface_id):
233			"""Add metadata to an interface."""
234			metadata = request.get_json()
235
236			switch_id = ":".join(interface_id.split(":")[:-1])
237			interface_number = int(interface_id.split(":")[-1])
238			try:
239			switch = self.controller.switches[switch_id]
240			except KeyError:
241			return jsonify("Switch not found"), 404
242
243			try:
244			interface = switch.interfaces[interface_number]
245			except KeyError:
246			return jsonify("Interface not found"), 404
247
248			interface.extend_metadata(metadata)
249	1		self.notify_metadata_changes(interface, 'added')
250			return jsonify("Operation successful"), 201
251
252			@rest('v3/interfaces/<interface_id>/metadata/<key>', methods=['DELETE'])
253			def delete_interface_metadata(self, interface_id, key):
254			"""Delete metadata from an interface."""
255			switch_id = ":".join(interface_id.split(":")[:-1])
256			interface_number = int(interface_id.split(":")[-1])
257	1
258			try:
259			switch = self.controller.switches[switch_id]
260			except KeyError:
261			return jsonify("Switch not found"), 404
262
263			try:
264			interface = switch.interfaces[interface_number]
265			except KeyError:
266			return jsonify("Interface not found"), 404
267	1
268			if interface.remove_metadata(key) is False:
269			return jsonify("Metadata not found"), 404
270
271			self.notify_metadata_changes(interface, 'removed')
272			return jsonify("Operation successful"), 200
273
274			# Link related methods
275			@rest('v3/links')
276			def get_links(self):
277	1		"""Return a json with all the links in the topology.
278
279			Links are connections between interfaces.
280			"""
281			return jsonify(self._get_links_dict()), 200
282
283			@rest('v3/links/<link_id>/enable', methods=['POST'])
284			def enable_link(self, link_id):
285	1		"""Administratively enable a link in the topology."""
286			try:
287			self.links[link_id].enable()
288			except KeyError:
289			return jsonify("Link not found"), 404
290
291			return jsonify("Operation successful"), 201
292
293			@rest('v3/links/<link_id>/disable', methods=['POST'])
294			def disable_link(self, link_id):
295			"""Administratively disable a link in the topology."""
296			try:
297			self.links[link_id].disable()
298	1		except KeyError:
299			return jsonify("Link not found"), 404
300
301			return jsonify("Operation successful"), 201
302
303			@rest('v3/links/<link_id>/metadata')
304			def get_link_metadata(self, link_id):
305			"""Get metadata from a link."""
306			try:
307			return jsonify({"metadata": self.links[link_id].metadata}), 200
308			except KeyError:
309			return jsonify("Link not found"), 404
310
311			@rest('v3/links/<link_id>/metadata', methods=['POST'])
312	1		def add_link_metadata(self, link_id):
313			"""Add metadata to a link."""
314			metadata = request.get_json()
315			try:
316			link = self.links[link_id]
317			except KeyError:
318			return jsonify("Link not found"), 404
319
320			link.extend_metadata(metadata)
321			self.notify_metadata_changes(link, 'added')
322			return jsonify("Operation successful"), 201
323
324			@rest('v3/links/<link_id>/metadata/<key>', methods=['DELETE'])
325	1		def delete_link_metadata(self, link_id, key):
326			"""Delete metadata from a link."""
327			try:
328			link = self.links[link_id]
329			except KeyError:
330			return jsonify("Link not found"), 404
331
332			if link.remove_metadata(key) is False:
333			return jsonify("Metadata not found"), 404
334
335			self.notify_metadata_changes(link, 'removed')
336			return jsonify("Operation successful"), 200
337
338	1		@listen_to('.*.switch.(new\|reconnected)')
339			def handle_new_switch(self, event):
340			"""Create a new Device on the Topology.
341
342			Handle the event of a new created switch and update the topology with
343			this new device.
344			"""
345			switch = event.content['switch']
346			switch.activate()
347			log.debug('Switch %s added to the Topology.', switch.id)
348	1		self.notify_topology_update()
349			self.update_instance_metadata(switch)
350
351			@listen_to('.*.connection.lost')
352			def handle_connection_lost(self, event):
353	1		"""Remove a Device from the topology.
354
355			Remove the disconnected Device and every link that has one of its
356			interfaces.
357			"""
358			switch = event.content['source'].switch
359			if switch:
360			switch.deactivate()
361			log.debug('Switch %s removed from the Topology.', switch.id)
362			self.notify_topology_update()
363	1
364			def handle_interface_up(self, event):
365			"""Update the topology based on a Port Modify event.
366
367			The event notifies that an interface was changed to 'up'.
368	1		"""
369			interface = event.content['interface']
370			interface.activate()
371			self.notify_topology_update()
372			self.update_instance_metadata(interface)
373
374			@listen_to('.*.switch.interface.created')
375			def handle_interface_created(self, event):
376			"""Update the topology based on a Port Create event."""
377			self.handle_interface_up(event)
378
379			def handle_interface_down(self, event):
380			"""Update the topology based on a Port Modify event.
381
382	1		The event notifies that an interface was changed to 'down'.
383			"""
384			interface = event.content['interface']
385			interface.deactivate()
386			self.handle_interface_link_down(event)
387			self.notify_topology_update()
388
389			@listen_to('.*.switch.interface.deleted')
390			def handle_interface_deleted(self, event):
391			"""Update the topology based on a Port Delete event."""
392			self.handle_interface_down(event)
393
394			@listen_to('.*.switch.interface.link_up')
395	1		def handle_interface_link_up(self, event):
396			"""Update the topology based on a Port Modify event.
397
398			The event notifies that an interface's link was changed to 'up'.
399			"""
400			interface = event.content['interface']
401			link = self._get_link_from_interface(interface)
402			if link and not link.is_active():
403			link.activate()
404			self.notify_topology_update()
405			self.update_instance_metadata(interface.link)
406			self.notify_link_status_change(link)
407
408			@listen_to('.*.switch.interface.link_down')
409			def handle_interface_link_down(self, event):
410			"""Update the topology based on a Port Modify event.
411
412			The event notifies that an interface's link was changed to 'down'.
413			"""
414			interface = event.content['interface']
415			link = self._get_link_from_interface(interface)
416			if link and link.is_active():
417			link.deactivate()
418			self.notify_topology_update()
419			self.notify_link_status_change(link)
420
421			@listen_to('.*.interface.is.nni')
422			def add_links(self, event):
423			"""Update the topology with links related to the NNI interfaces."""
424			interface_a = event.content['interface_a']
425			interface_b = event.content['interface_b']
426
427	1		link = self._get_link_or_create(interface_a, interface_b)
428			interface_a.update_link(link)
429			interface_b.update_link(link)
430
431			interface_a.nni = True
432			interface_b.nni = True
433
434	1		self.notify_topology_update()
435
436			# def add_host(self, event):
437			# """Update the topology with a new Host."""
438
439			# interface = event.content['port']
440			# mac = event.content['reachable_mac']
441
442			# host = Host(mac)
443			# link = self.topology.get_link(interface.id)
444	1		# if link is not None:
445			# return
446
447			# self.topology.add_link(interface.id, host.id)
448			# self.topology.add_device(host)
449
450			# if settings.DISPLAY_FULL_DUPLEX_LINKS:
451			# self.topology.add_link(host.id, interface.id)
452
453			def notify_topology_update(self):
454			"""Send an event to notify about updates on the topology."""
455			name = 'kytos/topology.updated'
456			event = KytosEvent(name=name, content={'topology':
457			self._get_topology()})
458			self.controller.buffers.app.put(event)
459
460			def notify_link_status_change(self, link):
461			"""Send an event to notify about a status change on a link."""
462	1		name = 'kytos/topology.'
463			if link.is_active():
464			status = 'link_up'
465			else:
466			status = 'link_down'
467			event = KytosEvent(name=name+status, content={'link': link})
468			self.controller.buffers.app.put(event)
469	1
470			def notify_metadata_changes(self, obj, action):
471			"""Send an event to notify about metadata changes."""
472			if isinstance(obj, Switch):
473			entity = 'switch'
474			entities = 'switches'
475			elif isinstance(obj, Interface):
476			entity = 'interface'
477			entities = 'interfaces'
478			elif isinstance(obj, Link):
479			entity = 'link'
480			entities = 'links'
481
482			name = f'kytos/topology.{entities}.metadata.{action}'
483			event = KytosEvent(name=name, content={entity: obj,
			0 ignored issues – show introduced 2019-02-27 14:03 UTC by Report Bug Copy Issue Report The variable `entity` does not seem to be defined for all execution paths. Loading history...
484			'metadata': obj.metadata})
485			self.controller.buffers.app.put(event)
486			log.debug(f'Metadata from {obj.id} was {action}.')
487
488			@listen_to('.*.switch.port.created')
489			def notify_port_created(self, original_event):
490			"""Notify when a port is created."""
491			name = f'kytos/topology.port.created'
492			event = KytosEvent(name=name, content=original_event.content)
493			self.controller.buffers.app.put(event)
494
495	1		@listen_to('kytos/topology..metadata.')
496			def save_metadata_on_store(self, event):
497			"""Send to storehouse the data updated."""
498			name = 'kytos.storehouse.update'
499			if 'switch' in event.content:
500			store = self.store_items.get('switches')
501			obj = event.content.get('switch')
502			namespace = 'kytos.topology.switches.metadata'
503			elif 'interface' in event.content:
504	1		store = self.store_items.get('interfaces')
505			obj = event.content.get('interface')
506	1		namespace = 'kytos.topology.iterfaces.metadata'
507	1		elif 'link' in event.content:
508			store = self.store_items.get('links')
509	1		obj = event.content.get('link')
510	1		namespace = 'kytos.topology.links.metadata'
511	1
512			store.data[obj.id] = obj.metadata
			0 ignored issues – show introduced 2019-02-27 14:03 UTC by Report Bug Copy Issue Report The variable `store` does not seem to be defined for all execution paths. Loading history... introduced 2019-02-27 14:03 UTC by Report Bug Copy Issue Report The variable `obj` does not seem to be defined for all execution paths. Loading history...
513	1		content = {'namespace': namespace,
			0 ignored issues – show introduced 2019-02-27 14:03 UTC by Report Bug Copy Issue Report The variable `namespace` does not seem to be defined for all execution paths. Loading history...
514			'box_id': store.box_id,
515			'data': store.data,
516			'callback': self.update_instance}
517
518			event = KytosEvent(name=name, content=content)
519			self.controller.buffers.app.put(event)
520
521			@staticmethod
522			def update_instance(event, _data, error):
523			"""Display in Kytos console if the data was updated."""
524			entities = event.content.get('namespace', '').split('.')[-2]
525			if error:
526			log.error(f'Error trying to update storehouse {entities}.')
527			else:
528			log.debug(f'Storehouse update to entities: {entities}.')
529
530			def verify_storehouse(self, entities):
531			"""Request a list of box saved by specific entity."""
532	1		name = 'kytos.storehouse.list'
533			content = {'namespace': f'kytos.topology.{entities}.metadata',
534			'callback': self.request_retrieve_entities}
535			event = KytosEvent(name=name, content=content)
536			self.controller.buffers.app.put(event)
537			log.info(f'verify data in storehouse for {entities}.')
538
539			def request_retrieve_entities(self, event, data, _error):
540			"""Create a box or retrieve an existent box from storehouse."""
541	1		msg = ''
542			content = {'namespace': event.content.get('namespace'),
543			'callback': self.load_from_store,
544			'data': {}}
545
546			if not data:
547			name = 'kytos.storehouse.create'
548			msg = 'Create new box in storehouse'
549			else:
550			name = 'kytos.storehouse.retrieve'
551			content['box_id'] = data[0]
552			msg = 'Retrieve data from storeohouse.'
553
554			event = KytosEvent(name=name, content=content)
555			self.controller.buffers.app.put(event)
556			log.debug(msg)
557
558			def load_from_store(self, event, box, error):
559			"""Save the data retrived from storehouse."""
560			entities = event.content.get('namespace', '').split('.')[-2]
561			if error:
562			log.error('Error while get a box from storehouse.')
563			else:
564			self.store_items[entities] = box
565			log.debug('Data updated')
566
567			def update_instance_metadata(self, obj):
568			"""Update object instance with saved metadata."""
569			metadata = None
570			if isinstance(obj, Interface):
571			all_metadata = self.store_items.get('interfaces', None)
572			if all_metadata:
573			metadata = all_metadata.data.get(obj.id)
574			elif isinstance(obj, Switch):
575			all_metadata = self.store_items.get('switches', None)
576			if all_metadata:
577			metadata = all_metadata.data.get(obj.id)
578			elif isinstance(obj, Link):
579			all_metadata = self.store_items.get('links', None)
580			if all_metadata:
581			metadata = all_metadata.data.get(obj.id)
582
583			if metadata:
584			obj.extend_metadata(metadata)
585			log.debug(f'Metadata to {obj.id} was updated')
586

kytos / topology

Pull Request — master (#80)

build.main.Main._get_data() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like