Test Failed
Pull Request — master (#396)
by
unknown
06:28
created

build.models.evc.EVCBase.as_dict()   B

Complexity

Conditions 7

Size

Total Lines 64
Code Lines 50

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 47
CRAP Score 7.0033

Importance

Changes 0
Metric Value
cc 7
eloc 50
nop 2
dl 0
loc 64
ccs 47
cts 49
cp 0.9592
crap 7.0033
rs 7.2363
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
"""Classes used in the main application."""  # pylint: disable=too-many-lines
2 1
import traceback
3 1
from collections import OrderedDict
4 1
from copy import deepcopy
5 1
from datetime import datetime
6 1
from operator import eq, ne
7 1
from threading import Lock
8 1
from typing import Union
9
from uuid import uuid4
10 1
11 1
import requests
12 1
from glom import glom
13
from requests.exceptions import Timeout
14 1
15 1
from kytos.core import log
16 1
from kytos.core.common import EntityStatus, GenericEntity
17 1
from kytos.core.exceptions import KytosNoTagAvailableError, KytosTagError
18 1
from kytos.core.helpers import get_time, now
19 1
from kytos.core.interface import UNI, Interface, TAGRange
20 1
from kytos.core.link import Link
21 1
from kytos.core.tag_ranges import range_difference
22 1
from napps.kytos.mef_eline import controllers, settings
23
from napps.kytos.mef_eline.exceptions import FlowModException, InvalidPath
24
from napps.kytos.mef_eline.utils import (check_disabled_component,
25
                                         compare_endpoint_trace,
26
                                         compare_uni_out_trace, emit_event,
27 1
                                         make_uni_list, map_dl_vlan,
28
                                         map_evc_event_content)
29
30 1
from .path import DynamicPathManager, Path
31
32
33 1
class EVCBase(GenericEntity):
34
    """Class to represent a circuit."""
35
36
    read_only_attributes = [
37
        "creation_time",
38
        "active",
39
        "current_path",
40
        "failover_path",
41 1
        "_id",
42
        "archived",
43
    ]
44
    attributes_requiring_redeploy = [
45
        "primary_path",
46
        "backup_path",
47
        "dynamic_backup_path",
48
        "queue_id",
49
        "sb_priority",
50
        "primary_constraints",
51
        "secondary_constraints",
52 1
        "uni_a",
53
        "uni_z",
54 1
    ]
55
    required_attributes = ["name", "uni_a", "uni_z"]
56
57
    def __init__(self, controller, **kwargs):
58
        """Create an EVC instance with the provided parameters.
59
60
        Args:
61
            id(str): EVC identifier. Whether it's None an ID will be genereted.
62
                     Only the first 14 bytes passed will be used.
63
            name: represents an EVC name.(Required)
64
            uni_a (UNI): Endpoint A for User Network Interface.(Required)
65
            uni_z (UNI): Endpoint Z for User Network Interface.(Required)
66
            start_date(datetime|str): Date when the EVC was registred.
67
                                      Default is now().
68
            end_date(datetime|str): Final date that the EVC will be fineshed.
69
                                    Default is None.
70
            bandwidth(int): Bandwidth used by EVC instance. Default is 0.
71
            primary_links(list): Primary links used by evc. Default is []
72
            backup_links(list): Backups links used by evc. Default is []
73
            current_path(list): Circuit being used at the moment if this is an
74
                                active circuit. Default is [].
75
            failover_path(list): Path being used to provide EVC protection via
76
                                failover during link failures. Default is [].
77
            primary_path(list): primary circuit offered to user IF one or more
78
                                links were provided. Default is [].
79
            backup_path(list): backup circuit offered to the user IF one or
80
                               more links were provided. Default is [].
81
            dynamic_backup_path(bool): Enable computer backup path dynamically.
82
                                       Dafault is False.
83
            creation_time(datetime|str): datetime when the circuit should be
84
                                         activated. default is now().
85
            enabled(Boolean): attribute to indicate the administrative state;
86
                              default is False.
87
            active(Boolean): attribute to indicate the operational state;
88
                             default is False.
89
            archived(Boolean): indicate the EVC has been deleted and is
90
                               archived; default is False.
91
            owner(str): The EVC owner. Default is None.
92
            sb_priority(int): Service level provided in the request.
93
                              Default is None.
94
            service_level(int): Service level provided. The higher the better.
95
                                Default is 0.
96
97
        Raises:
98 1
            ValueError: raised when object attributes are invalid.
99 1
100 1
        """
101
        self._controller = controller
102
        self._validate(**kwargs)
103 1
        super().__init__()
104 1
105 1
        # required attributes
106 1
        self._id = kwargs.get("id", uuid4().hex)[:14]
107
        self.uni_a = kwargs.get("uni_a")
108
        self.uni_z = kwargs.get("uni_z")
109 1
        self.name = kwargs.get("name")
110 1
111 1
        # optional attributes
112
        self.start_date = get_time(kwargs.get("start_date")) or now()
113 1
        self.end_date = get_time(kwargs.get("end_date")) or None
114 1
        self.queue_id = kwargs.get("queue_id", -1)
115 1
116 1
        self.bandwidth = kwargs.get("bandwidth", 0)
117 1
        self.primary_links = Path(kwargs.get("primary_links", []))
118 1
        self.backup_links = Path(kwargs.get("backup_links", []))
119 1
        self.current_path = Path(kwargs.get("current_path", []))
120 1
        self.failover_path = Path(kwargs.get("failover_path", []))
121 1
        self.primary_path = Path(kwargs.get("primary_path", []))
122 1
        self.backup_path = Path(kwargs.get("backup_path", []))
123 1
        self.dynamic_backup_path = kwargs.get("dynamic_backup_path", False)
124 1
        self.primary_constraints = kwargs.get("primary_constraints", {})
125 1
        self.secondary_constraints = kwargs.get("secondary_constraints", {})
126
        self.creation_time = get_time(kwargs.get("creation_time")) or now()
127
        self.owner = kwargs.get("owner", None)
128 1
        self.sb_priority = kwargs.get("sb_priority", None) or kwargs.get(
129 1
            "priority", None
130 1
        )
131 1
        self.service_level = kwargs.get("service_level", 0)
132 1
        self.circuit_scheduler = kwargs.get("circuit_scheduler", [])
133
        self.flow_removed_at = get_time(kwargs.get("flow_removed_at")) or None
134 1
        self.updated_at = get_time(kwargs.get("updated_at")) or now()
135 1
        self.execution_rounds = kwargs.get("execution_rounds", 0)
136 1
137
        self.current_links_cache = set()
138 1
        self.primary_links_cache = set()
139
        self.backup_links_cache = set()
140 1
141
        self.lock = Lock()
142 1
143
        self.archived = kwargs.get("archived", False)
144 1
145
        self.metadata = kwargs.get("metadata", {})
146 1
147 1
        self._mongo_controller = controllers.ELineController()
148
149 1
        if kwargs.get("active", False):
150
            self.activate()
151 1
        else:
152 1
            self.deactivate()
153
154 1
        if kwargs.get("enabled", False):
155
            self.enable()
156
        else:
157
            self.disable()
158 1
159
        # datetime of user request for a EVC (or datetime when object was
160 1
        # created)
161
        self.request_time = kwargs.get("request_time", now())
162
        # dict with the user original request (input)
163 1
        self._requested = kwargs
164 1
165
        # Special cases: No tag, any, untagged
166 1
        self.special_cases = {None, "4096/4096", 0}
167
        self.table_group = kwargs.get("table_group")
168 1
169 1
    def sync(self, keys: set = None):
170 1
        """Sync this EVC in the MongoDB."""
171 1
        self.updated_at = now()
172 1
        if keys:
173
            self._mongo_controller.update_evc(self.as_dict(keys))
174 1
            return
175
        self._mongo_controller.upsert_evc(self.as_dict())
176
177 1
    def _get_unis_use_tags(self, **kwargs) -> tuple[UNI, UNI]:
178 1
        """Obtain both UNIs (uni_a, uni_z).
179 1
        If a UNI is changing, verify tags"""
180 1
        uni_a = kwargs.get("uni_a", None)
181 1
        uni_a_flag = False
182 1
        if uni_a and uni_a != self.uni_a:
183 1
            uni_a_flag = True
184 1
            self._use_uni_vlan(uni_a, uni_dif=self.uni_a)
185
186 1
        uni_z = kwargs.get("uni_z", None)
187 1
        if uni_z and uni_z != self.uni_z:
188 1
            try:
189 1
                self._use_uni_vlan(uni_z, uni_dif=self.uni_z)
190 1
                self.make_uni_vlan_available(self.uni_z, uni_dif=uni_z)
191 1
            except KytosTagError as err:
192 1
                if uni_a_flag:
193 1
                    self.make_uni_vlan_available(uni_a, uni_dif=self.uni_a)
194 1
                raise err
195
        else:
196 1
            uni_z = self.uni_z
197
198 1
        if uni_a_flag:
199 1
            self.make_uni_vlan_available(self.uni_a, uni_dif=uni_a)
200
        else:
201 1
            uni_a = self.uni_a
202 1
        return uni_a, uni_z
203
204 1
    def update(self, **kwargs):
205
        """Update evc attributes.
206
207
        This method will raises an error trying to change the following
208
        attributes: [creation_time, active, current_path, failover_path,
209
        _id, archived]
210
        [name, uni_a and uni_z]
211
212
        Returns:
213
            the values for enable and a redeploy attribute, if exists and None
214
            otherwise
215
        Raises:
216
            ValueError: message with error detail.
217
218
        """
219 1
        enable, redeploy = (None, None)
220 1
        if not self._tag_lists_equal(**kwargs):
221 1
            raise ValueError(
222 1
                "UNI_A and UNI_Z tag lists should be the same."
223
            )
224
        uni_a, uni_z = self._get_unis_use_tags(**kwargs)
225
        check_disabled_component(uni_a, uni_z)
226
        self._validate_has_primary_or_dynamic(
227
            primary_path=kwargs.get("primary_path"),
228 1
            dynamic_backup_path=kwargs.get("dynamic_backup_path"),
229 1
            uni_a=uni_a,
230 1
            uni_z=uni_z,
231 1
        )
232 1
        for attribute, value in kwargs.items():
233 1
            if attribute in self.read_only_attributes:
234 1
                raise ValueError(f"{attribute} can't be updated.")
235 1
            if not hasattr(self, attribute):
236
                raise ValueError(f'The attribute "{attribute}" is invalid.')
237
            if attribute in ("primary_path", "backup_path"):
238 1
                try:
239 1
                    value.is_valid(
240
                        uni_a.interface.switch, uni_z.interface.switch
241
                    )
242 1
                except InvalidPath as exception:
243 1
                    raise ValueError(  # pylint: disable=raise-missing-from
244 1
                        f"{attribute} is not a " f"valid path: {exception}"
245 1
                    )
246
        for attribute, value in kwargs.items():
247 1
            if attribute in ("enable", "enabled"):
248 1
                if value:
249
                    self.enable()
250 1
                else:
251 1
                    self.disable()
252 1
                enable = value
253 1
            else:
254 1
                setattr(self, attribute, value)
255
                if attribute in self.attributes_requiring_redeploy:
256 1
                    redeploy = True
257
        self.sync(set(kwargs.keys()))
258
        return enable, redeploy
259
260 1
    def set_flow_removed_at(self):
261
        """Update flow_removed_at attribute."""
262
        self.flow_removed_at = now()
263
264
    def has_recent_removed_flow(self, setting=settings):
265
        """Check if any flow has been removed from the evc"""
266
        if self.flow_removed_at is None:
267 1
            return False
268
        res_seconds = (now() - self.flow_removed_at).seconds
269
        return res_seconds < setting.TIME_RECENT_DELETED_FLOWS
270
271
    def is_recent_updated(self, setting=settings):
272 1
        """Check if the evc has been updated recently"""
273
        res_seconds = (now() - self.updated_at).seconds
274 1
        return res_seconds < setting.TIME_RECENT_UPDATED
275
276 1
    def __repr__(self):
277
        """Repr method."""
278
        return f"EVC({self._id}, {self.name})"
279
280
    def _validate(self, **kwargs):
281
        """Do Basic validations.
282
283
        Verify required attributes: name, uni_a, uni_z
284
285
        Raises:
286 1
            ValueError: message with error detail.
287
288 1
        """
289 1
        for attribute in self.required_attributes:
290
291 1
            if attribute not in kwargs:
292 1
                raise ValueError(f"{attribute} is required.")
293 1
294
            if "uni" in attribute:
295
                uni = kwargs.get(attribute)
296 1
                if not isinstance(uni, UNI):
297
                    raise ValueError(f"{attribute} is an invalid UNI.")
298
299
    def _tag_lists_equal(self, **kwargs):
300
        """Verify that tag lists are the same."""
301
        uni_a = kwargs.get("uni_a") or self.uni_a
302
        uni_z = kwargs.get("uni_z") or self.uni_z
303
        uni_a_list = uni_z_list = False
304 1
        if (uni_a.user_tag and isinstance(uni_a.user_tag, TAGRange)):
305
            uni_a_list = True
306
        if (uni_z.user_tag and isinstance(uni_z.user_tag, TAGRange)):
307
            uni_z_list = True
308
        if uni_a_list and uni_z_list:
309 1
            return uni_a.user_tag.value == uni_z.user_tag.value
310
        return uni_a_list == uni_z_list
311
312
    def _validate_has_primary_or_dynamic(
313
        self,
314 1
        primary_path=None,
315 1
        dynamic_backup_path=None,
316 1
        uni_a=None,
317
        uni_z=None,
318
    ) -> None:
319
        """Validate that it must have a primary path or allow dynamic paths."""
320
        primary_path = (
321
            primary_path
322 1
            if primary_path is not None
323 1
            else self.primary_path
324
        )
325 1
        dynamic_backup_path = (
326
            dynamic_backup_path
327 1
            if dynamic_backup_path is not None
328
            else self.dynamic_backup_path
329
        )
330 1
        uni_a = uni_a if uni_a is not None else self.uni_a
331 1
        uni_z = uni_z if uni_z is not None else self.uni_z
332 1
        if (
333 1
            not primary_path
334 1
            and not dynamic_backup_path
335
            and uni_a and uni_z
336 1
            and uni_a.interface.switch != uni_z.interface.switch
337
        ):
338 1
            msg = "The EVC must have a primary path or allow dynamic paths."
339
            raise ValueError(msg)
340 1
341
    def __eq__(self, other):
342 1
        """Override the default implementation."""
343
        if not isinstance(other, EVC):
344
            return False
345
346 1
        attrs_to_compare = ["name", "uni_a", "uni_z", "owner", "bandwidth"]
347
        for attribute in attrs_to_compare:
348
            if getattr(other, attribute) != getattr(self, attribute):
349 1
                return False
350
        return True
351
352
    def is_intra_switch(self):
353 1
        """Check if the UNIs are in the same switch."""
354
        return self.uni_a.interface.switch == self.uni_z.interface.switch
355
356
    def shares_uni(self, other):
357
        """Check if two EVCs share an UNI."""
358
        if other.uni_a in (self.uni_a, self.uni_z) or other.uni_z in (
359
            self.uni_a,
360 1
            self.uni_z,
361
        ):
362 1
            return True
363 1
        return False
364 1
365
    def as_dict(self, keys: set = None):
366 1
        """Return a dictionary representing an EVC object.
367 1
            keys: Only fields on this variable will be
368 1
                  returned in the dictionary"""
369
        evc_dict = {
370 1
            "id": self.id,
371 1
            "name": self.name,
372 1
            "uni_a": self.uni_a.as_dict(),
373 1
            "uni_z": self.uni_z.as_dict(),
374 1
        }
375 1
376 1
        time_fmt = "%Y-%m-%dT%H:%M:%S"
377 1
378 1
        evc_dict["start_date"] = self.start_date
379 1
        if isinstance(self.start_date, datetime):
380
            evc_dict["start_date"] = self.start_date.strftime(time_fmt)
381 1
382 1
        evc_dict["end_date"] = self.end_date
383 1
        if isinstance(self.end_date, datetime):
384
            evc_dict["end_date"] = self.end_date.strftime(time_fmt)
385 1
386 1
        evc_dict["queue_id"] = self.queue_id
387
        evc_dict["bandwidth"] = self.bandwidth
388 1
        evc_dict["primary_links"] = self.primary_links.as_dict()
389 1
        evc_dict["backup_links"] = self.backup_links.as_dict()
390
        evc_dict["current_path"] = self.current_path.as_dict()
391
        evc_dict["failover_path"] = self.failover_path.as_dict()
392
        evc_dict["primary_path"] = self.primary_path.as_dict()
393 1
        evc_dict["backup_path"] = self.backup_path.as_dict()
394 1
        evc_dict["dynamic_backup_path"] = self.dynamic_backup_path
395 1
        evc_dict["metadata"] = self.metadata
396 1
397 1
        evc_dict["request_time"] = self.request_time
398 1
        if isinstance(self.request_time, datetime):
399 1
            evc_dict["request_time"] = self.request_time.strftime(time_fmt)
400 1
401 1
        time = self.creation_time.strftime(time_fmt)
402
        evc_dict["creation_time"] = time
403 1
404 1
        evc_dict["owner"] = self.owner
405 1
        evc_dict["circuit_scheduler"] = [
406 1
            sc.as_dict() for sc in self.circuit_scheduler
407
        ]
408
409 1
        evc_dict["active"] = self.is_active()
410 1
        evc_dict["enabled"] = self.is_enabled()
411 1
        evc_dict["archived"] = self.archived
412 1
        evc_dict["sb_priority"] = self.sb_priority
413
        evc_dict["service_level"] = self.service_level
414 1
        evc_dict["primary_constraints"] = self.primary_constraints
415 1
        evc_dict["secondary_constraints"] = self.secondary_constraints
416
        evc_dict["flow_removed_at"] = self.flow_removed_at
417 1
        evc_dict["updated_at"] = self.updated_at
418
419 1
        if keys:
420
            selected = {}
421 1
            for key in keys:
422
                if key == "enable":
423 1
                    selected["enabled"] = evc_dict["enabled"]
424
                    continue
425 1
                selected[key] = evc_dict[key]
426 1
            selected["id"] = evc_dict["id"]
427 1
            return selected
428 1
        return evc_dict
429 1
430 1
    @property
431
    def id(self):  # pylint: disable=invalid-name
432
        """Return this EVC's ID."""
433 1
        return self._id
434 1
435 1
    def archive(self):
436
        """Archive this EVC on deletion."""
437 1
        self.archived = True
438
439 1
    def _use_uni_vlan(
440 1
        self,
441 1
        uni: UNI,
442 1
        uni_dif: Union[None, UNI] = None
443 1
    ):
444 1
        """Use tags from UNI"""
445
        if uni.user_tag is None:
446
            return
447 1
        tag = uni.user_tag.value
448 1
        if not tag or isinstance(tag, str):
449 1
            return
450
        tag_type = uni.user_tag.tag_type
451 1
        if (uni_dif and isinstance(tag, list) and
452
                isinstance(uni_dif.user_tag.value, list)):
453 1
            tag = range_difference(tag, uni_dif.user_tag.value)
454 1
            if not tag:
455
                return
456
        uni.interface.use_tags(
457
            self._controller, tag, tag_type
458 1
        )
459
460
    def make_uni_vlan_available(
461 1
        self,
462
        uni: UNI,
463
        uni_dif: Union[None, UNI] = None,
464 1
    ):
465
        """Make available tag from UNI"""
466
        if uni.user_tag is None:
467
            return
468
        tag = uni.user_tag.value
469 1
        if not tag or isinstance(tag, str):
470
            return
471
        tag_type = uni.user_tag.tag_type
472
        if (uni_dif and isinstance(tag, list) and
473
                isinstance(uni_dif.user_tag.value, list)):
474
            tag = range_difference(tag, uni_dif.user_tag.value)
475
            if not tag:
476
                return
477
        try:
478 1
            conflict = uni.interface.make_tags_available(
479
                self._controller, tag, tag_type
480 1
            )
481
        except KytosTagError as err:
482
            log.error(f"Error in circuit {self._id}: {err}")
483 1
            return
484
        if conflict:
485
            intf = uni.interface.id
486 1
            log.warning(f"Tags {conflict} was already available in {intf}")
487
488 1
    def remove_uni_tags(self):
489
        """Remove both UNI usage of a tag"""
490 1
        self.make_uni_vlan_available(self.uni_a)
491
        self.make_uni_vlan_available(self.uni_z)
492
493
494 1
# pylint: disable=fixme, too-many-public-methods
495
class EVCDeploy(EVCBase):
496 1
    """Class to handle the deploy procedures."""
497
498
    def create(self):
499 1
        """Create a EVC."""
500
501 1
    def discover_new_paths(self):
502
        """Discover new paths to satisfy this circuit and deploy it."""
503 1
        return DynamicPathManager.get_best_paths(self,
504
                                                 **self.primary_constraints)
505 1
506
    def get_failover_path_candidates(self):
507 1
        """Get failover paths to satisfy this EVC."""
508
        # in the future we can return primary/backup paths as well
509
        # we just have to properly handle link_up and failover paths
510
        # if (
511 1
        #     self.is_using_primary_path() and
512
        #     self.backup_path.status is EntityStatus.UP
513
        # ):
514
        #     yield self.backup_path
515
        return DynamicPathManager.get_disjoint_paths(self, self.current_path)
516 1
517
    def change_path(self):
518 1
        """Change EVC path."""
519
520 1
    def reprovision(self):
521
        """Force the EVC (re-)provisioning."""
522 1
523
    def is_affected_by_link(self, link):
524 1
        """Return True if this EVC has the given link on its current path."""
525
        return link in self.current_path
526 1
527
    def link_affected_by_interface(self, interface):
528
        """Return True if this EVC has the given link on its current path."""
529
        return self.current_path.link_affected_by_interface(interface)
530
531
    def is_backup_path_affected_by_link(self, link):
532
        """Return True if the backup path of this EVC uses the given link."""
533 1
        return link in self.backup_path
534
535 1
    # pylint: disable=invalid-name
536
    def is_primary_path_affected_by_link(self, link):
537
        """Return True if the primary path of this EVC uses the given link."""
538
        return link in self.primary_path
539
540
    def is_failover_path_affected_by_link(self, link):
541
        """Return True if this EVC has the given link on its failover path."""
542
        return link in self.failover_path
543
544
    def is_eligible_for_failover_path(self):
545 1
        """Verify if this EVC is eligible for failover path (EP029)"""
546
        # In the future this function can be augmented to consider
547
        # primary/backup, primary/dynamic, and other path combinations
548
        return (
549 1
            self.dynamic_backup_path and
550 1
            not self.primary_path and not self.backup_path
551 1
        )
552
553 1
    def is_using_primary_path(self):
554 1
        """Verify if the current deployed path is self.primary_path."""
555
        return self.primary_path and (self.current_path == self.primary_path)
556 1
557 1
    def is_using_backup_path(self):
558
        """Verify if the current deployed path is self.backup_path."""
559
        return self.backup_path and (self.current_path == self.backup_path)
560
561 1
    def is_using_dynamic_path(self):
562
        """Verify if the current deployed path is a dynamic path."""
563
        if (
564
            self.current_path
565
            and not self.is_using_primary_path()
566
            and not self.is_using_backup_path()
567
            and self.current_path.status == EntityStatus.UP
568 1
        ):
569
            return True
570
        return False
571
572 1
    def deploy_to_backup_path(self):
573 1
        """Deploy the backup path into the datapaths of this circuit.
574 1
575
        If the backup_path attribute is valid and up, this method will try to
576 1
        deploy this backup_path.
577
578
        If everything fails and dynamic_backup_path is True, then tries to
579
        deploy a dynamic path.
580
        """
581
        # TODO: Remove flows from current (cookies)
582 1
        if self.is_using_backup_path():
583 1
            # TODO: Log to say that cannot move backup to backup
584 1
            return True
585 1
586 1
        success = False
587 1
        if self.backup_path.status is EntityStatus.UP:
588
            success = self.deploy_to_path(self.backup_path)
589 1
590 1
        if success:
591
            return True
592 1
593
        if self.dynamic_backup_path or self.is_intra_switch():
594 1
            return self.deploy_to_path()
595 1
596
        return False
597
598
    def deploy_to_primary_path(self):
599
        """Deploy the primary path into the datapaths of this circuit.
600 1
601 1
        If the primary_path attribute is valid and up, this method will try to
602
        deploy this primary_path.
603 1
        """
604 1
        # TODO: Remove flows from current (cookies)
605 1
        if self.is_using_primary_path():
606 1
            # TODO: Log to say that cannot move primary to primary
607
            return True
608
609
        if self.primary_path.status is EntityStatus.UP:
610
            return self.deploy_to_path(self.primary_path)
611 1
        return False
612
613 1
    def deploy(self):
614 1
        """Deploy EVC to best path.
615 1
616 1
        Best path can be the primary path, if available. If not, the backup
617 1
        path, and, if it is also not available, a dynamic path.
618
        """
619
        if self.archived:
620 1
            return False
621
        self.enable()
622
        success = self.deploy_to_primary_path()
623
        if not success:
624
            success = self.deploy_to_backup_path()
625
626
        if success:
627
            emit_event(self._controller, "deployed",
628 1
                       content=map_evc_event_content(self))
629 1
        return success
630 1
631 1
    @staticmethod
632 1
    def get_path_status(path):
633 1
        """Check for the current status of a path.
634 1
635 1
        If any link in this path is down, the path is considered down.
636 1
        """
637 1
        if not path:
638 1
            return EntityStatus.DISABLED
639 1
640 1
        for link in path:
641 1
            if link.status is not EntityStatus.UP:
642 1
                return link.status
643 1
        return EntityStatus.UP
644 1
645
    #    def discover_new_path(self):
646
    #        # TODO: discover a new path to satisfy this circuit and deploy
647
648
    def remove(self):
649
        """Remove EVC path and disable it."""
650
        self.remove_current_flows()
651
        self.remove_failover_flows()
652
        self.disable()
653
        self.sync()
654
        emit_event(self._controller, "undeployed",
655
                   content=map_evc_event_content(self))
656
657
    def remove_failover_flows(self, exclude_uni_switches=True,
658
                              force=True, sync=True) -> None:
659
        """Remove failover_flows.
660 1
661 1
        By default, it'll exclude UNI switches, if mef_eline has already
662 1
        called remove_current_flows before then this minimizes the number
663 1
        of FlowMods and IO.
664
        """
665 1
        if not self.failover_path:
666
            return
667 1
        switches, cookie, excluded = OrderedDict(), self.get_cookie(), set()
668
        links = set()
669 1
        if exclude_uni_switches:
670 1
            excluded.add(self.uni_a.interface.switch.id)
671 1
            excluded.add(self.uni_z.interface.switch.id)
672 1
        for link in self.failover_path:
673 1
            if link.endpoint_a.switch.id not in excluded:
674 1
                switches[link.endpoint_a.switch.id] = link.endpoint_a.switch
675 1
                links.add(link)
676
            if link.endpoint_b.switch.id not in excluded:
677 1
                switches[link.endpoint_b.switch.id] = link.endpoint_b.switch
678
                links.add(link)
679
        for switch in switches.values():
680
            try:
681
                self._send_flow_mods(
682 1
                    switch.id,
683 1
                    [
684 1
                        {
685 1
                            "cookie": cookie,
686 1
                            "cookie_mask": int(0xffffffffffffffff),
687
                        }
688
                    ],
689
                    "delete",
690
                    force=force,
691 1
                )
692 1
            except FlowModException as err:
693 1
                log.error(
694 1
                    f"Error removing flows from switch {switch.id} for"
695
                    f"EVC {self}: {err}"
696 1
                )
697
        try:
698 1
            self.failover_path.make_vlans_available(self._controller)
699 1
        except KytosTagError as err:
700
            log.error(f"Error when removing failover flows: {err}")
701 1
        self.failover_path = Path([])
702
        if sync:
703 1
            self.sync()
704 1
705
    def remove_current_flows(self, current_path=None, force=True):
706
        """Remove all flows from current path."""
707
        switches = set()
708
709
        switches.add(self.uni_a.interface.switch)
710
        switches.add(self.uni_z.interface.switch)
711 1
        if not current_path:
712 1
            current_path = self.current_path
713 1
        for link in current_path:
714 1
            switches.add(link.endpoint_a.switch)
715
            switches.add(link.endpoint_b.switch)
716
717
        match = {
718
            "cookie": self.get_cookie(),
719
            "cookie_mask": int(0xffffffffffffffff)
720 1
        }
721 1
722
        for switch in switches:
723
            try:
724
                self._send_flow_mods(switch.id, [match], 'delete', force=force)
725
            except FlowModException as err:
726
                log.error(
727
                    f"Error removing flows from switch {switch.id} for"
728 1
                    f"EVC {self}: {err}"
729 1
                )
730 1
        try:
731 1
            current_path.make_vlans_available(self._controller)
732
        except KytosTagError as err:
733
            log.error(f"Error when removing current path flows: {err}")
734
        self.current_path = Path([])
735
        self.deactivate()
736
        self.sync()
737 1
738 1
    def remove_path_flows(self, path=None, force=True):
739 1
        """Remove all flows from path."""
740 1
        if not path:
741 1
            return
742
743
        dpid_flows_match = {}
744
745
        try:
746 1
            nni_flows = self._prepare_nni_flows(path)
747
        # pylint: disable=broad-except
748 1
        except Exception:
749 1
            err = traceback.format_exc().replace("\n", ", ")
750
            log.error(f"Fail to remove NNI failover flows for {self}: {err}")
751 1
            nni_flows = {}
752
753 1
        for dpid, flows in nni_flows.items():
754
            dpid_flows_match.setdefault(dpid, [])
755 1
            for flow in flows:
756
                dpid_flows_match[dpid].append({
757 1
                    "cookie": flow["cookie"],
758 1
                    "match": flow["match"],
759 1
                    "cookie_mask": int(0xffffffffffffffff)
760
                })
761 1
762 1
        try:
763 1
            uni_flows = self._prepare_uni_flows(path, skip_in=True)
764
        # pylint: disable=broad-except
765 1
        except Exception:
766 1
            err = traceback.format_exc().replace("\n", ", ")
767 1
            log.error(f"Fail to remove UNI failover flows for {self}: {err}")
768
            uni_flows = {}
769 1
770
        for dpid, flows in uni_flows.items():
771 1
            dpid_flows_match.setdefault(dpid, [])
772
            for flow in flows:
773
                dpid_flows_match[dpid].append({
774
                    "cookie": flow["cookie"],
775
                    "match": flow["match"],
776
                    "cookie_mask": int(0xffffffffffffffff)
777
                })
778
779
        for dpid, flows in dpid_flows_match.items():
780
            try:
781
                self._send_flow_mods(dpid, flows, 'delete', force=force)
782
            except FlowModException as err:
783
                log.error(
784
                    "Error removing failover flows: "
785
                    f"dpid={dpid} evc={self} error={err}"
786 1
                )
787 1
        try:
788 1
            path.make_vlans_available(self._controller)
789 1
        except KytosTagError as err:
790 1
            log.error(f"Error when removing path flows: {err}")
791 1
792 1
    @staticmethod
793
    def links_zipped(path=None):
794 1
        """Return an iterator which yields pairs of links in order."""
795 1
        if not path:
796
            return []
797 1
        return zip(path[:-1], path[1:])
798 1
799 1
    def should_deploy(self, path=None):
800 1
        """Verify if the circuit should be deployed."""
801 1
        if not path:
802
            log.debug("Path is empty.")
803 1
            return False
804
805 1
        if not self.is_enabled():
806 1
            log.debug(f"{self} is disabled.")
807 1
            return False
808 1
809 1
        if not self.is_active():
810 1
            log.debug(f"{self} will be deployed.")
811 1
            return True
812
813 1
        return False
814
815
    def deploy_to_path(self, path=None):  # pylint: disable=too-many-branches
816 1
        """Install the flows for this circuit.
817 1
818 1
        Procedures to deploy:
819
820
        0. Remove current flows installed
821 1
        1. Decide if will deploy "path" or discover a new path
822 1
        2. Choose vlan
823 1
        3. Install NNI flows
824 1
        4. Install UNI flows
825 1
        5. Activate
826 1
        6. Update current_path
827 1
        7. Update links caches(primary, current, backup)
828
829 1
        """
830
        self.remove_current_flows()
831
        use_path = path
832
        if self.should_deploy(use_path):
833
            try:
834
                use_path.choose_vlans(self._controller)
835
            except KytosNoTagAvailableError:
836
                use_path = None
837
        else:
838
            for use_path in self.discover_new_paths():
839
                if use_path is None:
840
                    continue
841
                try:
842 1
                    use_path.choose_vlans(self._controller)
843 1
                    break
844
                except KytosNoTagAvailableError:
845
                    pass
846 1
            else:
847 1
                use_path = None
848
849 1
        try:
850 1
            if use_path:
851 1
                self._install_nni_flows(use_path)
852 1
                self._install_uni_flows(use_path)
853 1
            elif self.is_intra_switch():
854 1
                use_path = Path()
855 1
                self._install_direct_uni_flows()
856 1
            else:
857 1
                log.warning(
858 1
                    f"{self} was not deployed. No available path was found."
859 1
                )
860
                return False
861 1
        except FlowModException as err:
862 1
            log.error(
863
                f"Error deploying EVC {self} when calling flow_manager: {err}"
864 1
            )
865 1
            self.remove_current_flows(use_path)
866 1
            return False
867 1
        self.activate()
868 1
        self.current_path = use_path
869 1
        self.sync()
870 1
        log.info(f"{self} was deployed.")
871
        return True
872
873 1
    def setup_failover_path(self):
874 1
        """Install flows for the failover path of this EVC.
875
876 1
        Procedures to deploy:
877 1
878
        0. Remove flows currently installed for failover_path (if any)
879 1
        1. Discover a disjoint path from current_path
880 1
        2. Choose vlans
881
        3. Install NNI flows
882
        4. Install UNI egress flows
883 1
        5. Update failover_path
884 1
        """
885 1
        # Intra-switch EVCs have no failover_path
886
        if self.is_intra_switch():
887 1
            return False
888
889
        # For not only setup failover path for totally dynamic EVCs
890
        if not self.is_eligible_for_failover_path():
891
            return False
892
893
        reason = ""
894
        self.remove_path_flows(self.failover_path)
895 1
        self.failover_path = Path([])
896 1
        for use_path in self.get_failover_path_candidates():
897 1
            if not use_path:
898
                continue
899 1
            try:
900
                use_path.choose_vlans(self._controller)
901 1
                break
902 1
            except KytosNoTagAvailableError:
903
                pass
904 1
        else:
905
            use_path = Path([])
906
            reason = "No available path was found"
907
908 1
        try:
909
            if use_path:
910
                self._install_nni_flows(use_path)
911
                self._install_uni_flows(use_path, skip_in=True)
912
        except FlowModException as err:
913 1
            reason = "Error deploying failover path"
914 1
            log.error(
915
                f"{reason} for {self}. FlowManager error: {err}"
916 1
            )
917 1
            self.remove_path_flows(use_path)
918
            use_path = Path([])
919 1
920 1
        self.failover_path = use_path
921
        self.sync()
922
923 1
        if not use_path:
924 1
            log.warning(
925
                f"Failover path for {self} was not deployed: {reason}"
926
            )
927
            return False
928 1
        log.info(f"Failover path for {self} was deployed.")
929 1
        return True
930
931
    def get_failover_flows(self):
932 1
        """Return the flows needed to make the failover path active, i.e. the
933 1
        flows for ingress forwarding.
934
935
        Return:
936 1
            dict: A dict of flows indexed by the switch_id will be returned, or
937 1
                an empty dict if no failover_path is available.
938
        """
939 1
        if not self.failover_path:
940 1
            return {}
941
        return self._prepare_uni_flows(self.failover_path, skip_out=True)
942 1
943 1
    # pylint: disable=too-many-branches
944
    def _prepare_direct_uni_flows(self):
945 1
        """Prepare flows connecting two UNIs for intra-switch EVC."""
946
        vlan_a = self._get_value_from_uni_tag(self.uni_a)
947
        vlan_z = self._get_value_from_uni_tag(self.uni_z)
948
949 1
        flow_mod_az = self._prepare_flow_mod(
950
            self.uni_a.interface, self.uni_z.interface,
951
            self.queue_id, vlan_a
952
        )
953
        flow_mod_za = self._prepare_flow_mod(
954
            self.uni_z.interface, self.uni_a.interface,
955 1
            self.queue_id, vlan_z
956 1
        )
957
958 1 View Code Duplication
        if not isinstance(vlan_z, list) and vlan_z not in self.special_cases:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
959
            flow_mod_az["actions"].insert(
960 1
                0, {"action_type": "set_vlan", "vlan_id": vlan_z}
961 1
            )
962 1
            if not vlan_a:
963 1
                flow_mod_az["actions"].insert(
964 1
                    0, {"action_type": "push_vlan", "tag_type": "c"}
965 1
                )
966 1
            if vlan_a == 0:
967
                flow_mod_za["actions"].insert(0, {"action_type": "pop_vlan"})
968
        elif vlan_a == 0 and vlan_z == "4096/4096":
969
            flow_mod_za["actions"].insert(0, {"action_type": "pop_vlan"})
970 1
971 View Code Duplication
        if not isinstance(vlan_a, list) and vlan_a not in self.special_cases:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
972 1
            flow_mod_za["actions"].insert(
973
                    0, {"action_type": "set_vlan", "vlan_id": vlan_a}
974
                )
975
            if not vlan_z:
976
                flow_mod_za["actions"].insert(
977
                    0, {"action_type": "push_vlan", "tag_type": "c"}
978
                )
979
            if vlan_z == 0:
980
                flow_mod_az["actions"].insert(0, {"action_type": "pop_vlan"})
981
        elif vlan_a == "4096/4096" and vlan_z == 0:
982
            flow_mod_az["actions"].insert(0, {"action_type": "pop_vlan"})
983 1
984
        flows = []
985
        if isinstance(vlan_a, list):
986
            for mask_a in vlan_a:
987
                flow_aux = deepcopy(flow_mod_az)
988
                flow_aux["match"]["dl_vlan"] = mask_a
989
                flows.append(flow_aux)
990
        else:
991
            if vlan_a is not None:
992 1
                flow_mod_az["match"]["dl_vlan"] = vlan_a
993 1
            flows.append(flow_mod_az)
994 1
995
        if isinstance(vlan_z, list):
996 1
            for mask_z in vlan_z:
997
                flow_aux = deepcopy(flow_mod_za)
998 1
                flow_aux["match"]["dl_vlan"] = mask_z
999 1
                flows.append(flow_aux)
1000
        else:
1001 1
            if vlan_z is not None:
1002 1
                flow_mod_za["match"]["dl_vlan"] = vlan_z
1003
            flows.append(flow_mod_za)
1004
        return (
1005 1
            self.uni_a.interface.switch.id, flows
1006
        )
1007 1
1008 1
    def _install_direct_uni_flows(self):
1009 1
        """Install flows connecting two UNIs.
1010
1011
        This case happens when the circuit is between UNIs in the
1012 1
        same switch.
1013
        """
1014 1
        (dpid, flows) = self._prepare_direct_uni_flows()
1015 1
        self._send_flow_mods(dpid, flows)
1016 1
1017 1
    def _prepare_nni_flows(self, path=None):
1018
        """Prepare NNI flows."""
1019
        nni_flows = OrderedDict()
1020 1
        previous = self.uni_a.interface.switch.dpid
1021 1
        for incoming, outcoming in self.links_zipped(path):
1022
            in_vlan = incoming.get_metadata("s_vlan").value
1023 1
            out_vlan = outcoming.get_metadata("s_vlan").value
1024 1
            in_endpoint = self.get_endpoint_by_id(incoming, previous, ne)
1025
            out_endpoint = self.get_endpoint_by_id(
1026
                outcoming, in_endpoint.switch.id, eq
1027 1
            )
1028
1029
            flows = []
1030 1
            # Flow for one direction
1031
            flows.append(
1032
                self._prepare_nni_flow(
1033
                    in_endpoint,
1034
                    out_endpoint,
1035 1
                    in_vlan,
1036
                    out_vlan,
1037
                    queue_id=self.queue_id,
1038 1
                )
1039 1
            )
1040
1041
            # Flow for the other direction
1042
            flows.append(
1043
                self._prepare_nni_flow(
1044
                    out_endpoint,
1045
                    in_endpoint,
1046
                    out_vlan,
1047 1
                    in_vlan,
1048
                    queue_id=self.queue_id,
1049
                )
1050 1
            )
1051 1
            previous = in_endpoint.switch.id
1052
            nni_flows[in_endpoint.switch.id] = flows
1053
        return nni_flows
1054
1055
    def _install_nni_flows(self, path=None):
1056
        """Install NNI flows."""
1057 1
        for dpid, flows in self._prepare_nni_flows(path).items():
1058
            self._send_flow_mods(dpid, flows)
1059 1
1060
    @staticmethod
1061
    def _get_value_from_uni_tag(uni: UNI):
1062 1
        """Returns the value from tag. In case of any and untagged
1063
        it should return 4096/4096 and 0 respectively"""
1064
        special = {"any": "4096/4096", "untagged": 0}
1065 1
        if uni.user_tag:
1066 1
            value = uni.user_tag.value
1067
            if isinstance(value, list):
1068
                return uni.user_tag.mask_list
1069
            return special.get(value, value)
1070
        return None
1071
1072
    # pylint: disable=too-many-locals
1073
    def _prepare_uni_flows(self, path=None, skip_in=False, skip_out=False):
1074 1
        """Prepare flows to install UNIs."""
1075
        uni_flows = {}
1076
        if not path:
1077 1
            log.info("install uni flows without path.")
1078 1
            return uni_flows
1079
1080
        # Determine VLANs
1081
        in_vlan_a = self._get_value_from_uni_tag(self.uni_a)
1082
        out_vlan_a = path[0].get_metadata("s_vlan").value
1083
1084 1
        in_vlan_z = self._get_value_from_uni_tag(self.uni_z)
1085
        out_vlan_z = path[-1].get_metadata("s_vlan").value
1086 1
1087
        # Get endpoints from path
1088 1
        endpoint_a = self.get_endpoint_by_id(
1089
            path[0], self.uni_a.interface.switch.id, eq
1090 1
        )
1091
        endpoint_z = self.get_endpoint_by_id(
1092 1
            path[-1], self.uni_z.interface.switch.id, eq
1093
        )
1094 1
1095 1
        # Flows for the first UNI
1096
        flows_a = []
1097 1
1098 1
        # Flow for one direction, pushing the service tag
1099
        if not skip_in:
1100
            if isinstance(in_vlan_a, list):
1101
                for in_mask_a in in_vlan_a:
1102
                    push_flow = self._prepare_push_flow(
1103
                        self.uni_a.interface,
1104
                        endpoint_a,
1105
                        in_mask_a,
1106
                        out_vlan_a,
1107
                        in_vlan_z,
1108
                        queue_id=self.queue_id,
1109 1
                    )
1110
                    flows_a.append(push_flow)
1111 1
            else:
1112 1
                push_flow = self._prepare_push_flow(
1113 1
                    self.uni_a.interface,
1114 1
                    endpoint_a,
1115
                    in_vlan_a,
1116 1
                    out_vlan_a,
1117
                    in_vlan_z,
1118 1
                    queue_id=self.queue_id,
1119
                )
1120 1
                flows_a.append(push_flow)
1121 1
1122
        # Flow for the other direction, popping the service tag
1123 1
        if not skip_out:
1124 1
            pop_flow = self._prepare_pop_flow(
1125
                endpoint_a,
1126 1
                self.uni_a.interface,
1127
                out_vlan_a,
1128 1
                queue_id=self.queue_id,
1129 1
            )
1130 1
            flows_a.append(pop_flow)
1131 1
1132
        uni_flows[self.uni_a.interface.switch.id] = flows_a
1133 1
1134 1
        # Flows for the second UNI
1135
        flows_z = []
1136 1
1137 1
        # Flow for one direction, pushing the service tag
1138 1
        if not skip_in:
1139 1
            if isinstance(in_vlan_z, list):
1140 1
                for in_mask_z in in_vlan_z:
1141 1
                    push_flow = self._prepare_push_flow(
1142 1
                        self.uni_z.interface,
1143
                        endpoint_z,
1144 1
                        in_mask_z,
1145
                        out_vlan_z,
1146
                        in_vlan_a,
1147 1
                        queue_id=self.queue_id,
1148
                    )
1149
                    flows_z.append(push_flow)
1150 1
            else:
1151 1
                push_flow = self._prepare_push_flow(
1152
                    self.uni_z.interface,
1153
                    endpoint_z,
1154
                    in_vlan_z,
1155
                    out_vlan_z,
1156 1
                    in_vlan_a,
1157
                    queue_id=self.queue_id,
1158
                )
1159
                flows_z.append(push_flow)
1160
1161
        # Flow for the other direction, popping the service tag
1162
        if not skip_out:
1163 1
            pop_flow = self._prepare_pop_flow(
1164 1
                endpoint_z,
1165
                self.uni_z.interface,
1166
                out_vlan_z,
1167 1
                queue_id=self.queue_id,
1168 1
            )
1169
            flows_z.append(pop_flow)
1170 1
1171
        uni_flows[self.uni_z.interface.switch.id] = flows_z
1172 1
1173 1
        return uni_flows
1174
1175
    def _install_uni_flows(self, path=None, skip_in=False, skip_out=False):
1176 1
        """Install UNI flows."""
1177 1
        uni_flows = self._prepare_uni_flows(path, skip_in, skip_out)
1178 1
1179
        for (dpid, flows) in uni_flows.items():
1180 1
            self._send_flow_mods(dpid, flows)
1181
1182 1
    @staticmethod
1183
    def _send_flow_mods(dpid, flow_mods, command='flows', force=False):
1184
        """Send a flow_mod list to a specific switch.
1185
1186
        Args:
1187
            dpid(str): The target of flows (i.e. Switch.id).
1188
            flow_mods(dict): Python dictionary with flow_mods.
1189
            command(str): By default is 'flows'. To remove a flow is 'remove'.
1190
            force(bool): True to send via consistency check in case of errors
1191
1192
        """
1193
1194
        endpoint = f"{settings.MANAGER_URL}/{command}/{dpid}"
1195
1196
        data = {"flows": flow_mods, "force": force}
1197 1
        response = requests.post(endpoint, json=data)
1198 1
        if response.status_code >= 400:
1199
            raise FlowModException(str(response.text))
1200
1201
    def get_cookie(self):
1202 1
        """Return the cookie integer from evc id."""
1203 1
        return int(self.id, 16) + (settings.COOKIE_PREFIX << 56)
1204
1205 1
    @staticmethod
1206 1
    def get_id_from_cookie(cookie):
1207
        """Return the evc id given a cookie value."""
1208 1
        evc_id = cookie - (settings.COOKIE_PREFIX << 56)
1209
        return f"{evc_id:x}".zfill(14)
1210 1
1211
    def set_flow_table_group_id(self, flow_mod: dict, vlan) -> dict:
1212 1
        """Set table_group and table_id"""
1213
        table_group = "epl" if vlan is None else "evpl"
1214 1
        flow_mod["table_group"] = table_group
1215 1
        flow_mod["table_id"] = self.table_group[table_group]
1216
        return flow_mod
1217 1
1218
    @staticmethod
1219
    def get_priority(vlan):
1220 1
        """Return priority value depending on vlan value"""
1221 1
        if isinstance(vlan, list):
1222
            return settings.RANGE_SB_PRIORITY
1223 1
        if vlan not in {None, "4096/4096", 0}:
1224
            return settings.EVPL_SB_PRIORITY
1225
        if vlan == 0:
1226 1
            return settings.UNTAGGED_SB_PRIORITY
1227 1
        if vlan == "4096/4096":
1228
            return settings.ANY_SB_PRIORITY
1229 1
        return settings.EPL_SB_PRIORITY
1230
1231
    def _prepare_flow_mod(self, in_interface, out_interface,
1232 1
                          queue_id=None, vlan=True):
1233 1
        """Prepare a common flow mod."""
1234
        default_actions = [
1235 1
            {"action_type": "output", "port": out_interface.port_number}
1236
        ]
1237 1
        queue_id = settings.QUEUE_ID if queue_id == -1 else queue_id
1238
        if queue_id is not None:
1239
            default_actions.append(
1240
                {"action_type": "set_queue", "queue_id": queue_id}
1241
            )
1242 1
1243
        flow_mod = {
1244
            "match": {"in_port": in_interface.port_number},
1245 1
            "cookie": self.get_cookie(),
1246 1
            "actions": default_actions,
1247 1
            "owner": "mef_eline",
1248 1
        }
1249
1250 1
        self.set_flow_table_group_id(flow_mod, vlan)
1251 1
        if self.sb_priority:
1252
            flow_mod["priority"] = self.sb_priority
1253 1
        else:
1254 1
            flow_mod["priority"] = self.get_priority(vlan)
1255 1
        return flow_mod
1256 1
1257
    def _prepare_nni_flow(self, *args, queue_id=None):
1258
        """Create NNI flows."""
1259
        in_interface, out_interface, in_vlan, out_vlan = args
1260
        flow_mod = self._prepare_flow_mod(
1261
            in_interface, out_interface, queue_id
1262
        )
1263
        flow_mod["match"]["dl_vlan"] = in_vlan
1264 1
        new_action = {"action_type": "set_vlan", "vlan_id": out_vlan}
1265 1
        flow_mod["actions"].insert(0, new_action)
1266 1
1267 1
        return flow_mod
1268
1269
    def _prepare_push_flow(self, *args, queue_id=None):
1270
        """Prepare push flow.
1271 1
1272 1
        Arguments:
1273 1
            in_interface(str): Interface input.
1274
            out_interface(str): Interface output.
1275
            in_vlan(int,str,None): Vlan input.
1276
            out_vlan(str): Vlan output.
1277 1
            new_c_vlan(int,str,list,None): New client vlan.
1278 1
1279 1
        Return:
1280 1
            dict: An python dictionary representing a FlowMod
1281
1282
        """
1283 1
        # assign all arguments
1284 1
        in_interface, out_interface, in_vlan, out_vlan, new_c_vlan = args
1285
        vlan_pri = in_vlan if not isinstance(new_c_vlan, list) else new_c_vlan
1286 1
        flow_mod = self._prepare_flow_mod(
1287
            in_interface, out_interface, queue_id, vlan_pri
1288
        )
1289
        # the service tag must be always pushed
1290 1
        new_action = {"action_type": "set_vlan", "vlan_id": out_vlan}
1291 1
        flow_mod["actions"].insert(0, new_action)
1292 1
1293
        new_action = {"action_type": "push_vlan", "tag_type": "s"}
1294
        flow_mod["actions"].insert(0, new_action)
1295
1296 1
        if in_vlan is not None:
1297 1
            # if in_vlan is set, it must be included in the match
1298
            flow_mod["match"]["dl_vlan"] = in_vlan
1299 1
1300
        if (not isinstance(new_c_vlan, list) and in_vlan != new_c_vlan and
1301
                new_c_vlan not in self.special_cases):
1302 1
            # new_in_vlan is an integer but zero, action to set is required
1303 1
            new_action = {"action_type": "set_vlan", "vlan_id": new_c_vlan}
1304 1
            flow_mod["actions"].insert(0, new_action)
1305 1
1306
        if in_vlan not in self.special_cases and new_c_vlan == 0:
1307
            # # new_in_vlan is an integer but zero and new_c_vlan does not
1308
            # a pop action is required
1309
            new_action = {"action_type": "pop_vlan"}
1310 1
            flow_mod["actions"].insert(0, new_action)
1311 1
1312 1
        elif in_vlan == "4096/4096" and new_c_vlan == 0:
1313
            # if in_vlan match with any tags and new_c_vlan does not
1314
            # a pop action is required
1315
            new_action = {"action_type": "pop_vlan"}
1316
            flow_mod["actions"].insert(0, new_action)
1317 1
1318 1
        elif (not in_vlan and
1319
                (not isinstance(new_c_vlan, list) and
1320 1
                 new_c_vlan not in self.special_cases)):
1321
            # new_in_vlan is an integer but zero and in_vlan is not set
1322 1
            # then it is set now
1323 1
            new_action = {"action_type": "push_vlan", "tag_type": "c"}
1324
            flow_mod["actions"].insert(0, new_action)
1325 1
1326
        return flow_mod
1327 1
1328 1
    def _prepare_pop_flow(
1329 1
        self, in_interface, out_interface, out_vlan, queue_id=None
1330 1
    ):
1331
        # pylint: disable=too-many-arguments
1332 1
        """Prepare pop flow."""
1333 1
        flow_mod = self._prepare_flow_mod(
1334 1
            in_interface, out_interface, queue_id
1335 1
        )
1336
        flow_mod["match"]["dl_vlan"] = out_vlan
1337
        new_action = {"action_type": "pop_vlan"}
1338 1
        flow_mod["actions"].insert(0, new_action)
1339 1
        return flow_mod
1340 1
1341 1
    @staticmethod
1342 1
    def run_bulk_sdntraces(
1343
        uni_list: list[tuple[Interface, Union[str, int, None]]]
1344
    ) -> dict:
1345
        """Run SDN traces on control plane starting from EVC UNIs."""
1346
        endpoint = f"{settings.SDN_TRACE_CP_URL}/traces"
1347
        data = []
1348
        for interface, tag_value in uni_list:
1349
            data_uni = {
1350
                "trace": {
1351 1
                            "switch": {
1352
                                "dpid": interface.switch.dpid,
1353 1
                                "in_port": interface.port_number,
1354 1
                            }
1355
                        }
1356
                }
1357
            if tag_value:
1358
                uni_dl_vlan = map_dl_vlan(tag_value)
1359
                if uni_dl_vlan:
1360
                    data_uni["trace"]["eth"] = {
1361 1
                                            "dl_type": 0x8100,
1362 1
                                            "dl_vlan": uni_dl_vlan,
1363 1
                                            }
1364
            data.append(data_uni)
1365
        try:
1366 1
            response = requests.put(endpoint, json=data, timeout=30)
1367
        except Timeout as exception:
1368
            log.error(f"Request has timed out: {exception}")
1369 1
            return {"result": []}
1370
        if response.status_code >= 400:
1371
            log.error(f"Failed to run sdntrace-cp: {response.text}")
1372
            return {"result": []}
1373 1
        return response.json()
1374
1375 1
    # pylint: disable=too-many-return-statements, too-many-arguments
1376
    @staticmethod
1377 1
    def check_trace(
1378
        tag_a: Union[None, int, str],
1379 1
        tag_z: Union[None, int, str],
1380
        interface_a: Interface,
1381 1
        interface_z: Interface,
1382
        current_path: list,
1383 1
        trace_a: list,
1384
        trace_z: list
1385
    ) -> bool:
1386
        """Auxiliar function to check an individual trace"""
1387
        if (
1388
            len(trace_a) != len(current_path) + 1
1389
            or not compare_uni_out_trace(tag_z, interface_z, trace_a[-1])
1390 1
        ):
1391
            log.warning(f"Invalid trace from uni_a: {trace_a}")
1392 1
            return False
1393
        if (
1394 1
            len(trace_z) != len(current_path) + 1
1395 1
            or not compare_uni_out_trace(tag_a, interface_a, trace_z[-1])
1396 1
        ):
1397
            log.warning(f"Invalid trace from uni_z: {trace_z}")
1398 1
            return False
1399 1
1400
        for link, trace1, trace2 in zip(current_path,
1401 1
                                        trace_a[1:],
1402
                                        trace_z[:0:-1]):
1403 1
            metadata_vlan = None
1404
            if link.metadata:
1405
                metadata_vlan = glom(link.metadata, 's_vlan.value')
1406
            if compare_endpoint_trace(
1407
                                        link.endpoint_a,
1408
                                        metadata_vlan,
1409
                                        trace2
1410 1
                                    ) is False:
1411
                log.warning(f"Invalid trace from uni_a: {trace_a}")
1412
                return False
1413 1
            if compare_endpoint_trace(
1414 1
                                        link.endpoint_b,
1415
                                        metadata_vlan,
1416 1
                                        trace1
1417 1
                                    ) is False:
1418 1
                log.warning(f"Invalid trace from uni_z: {trace_z}")
1419
                return False
1420 1
1421 1
        return True
1422
1423
    @staticmethod
1424
    def check_range(circuit, traces: list) -> bool:
1425 1
        """Check traces when for UNI with TAGRange"""
1426 1
        check = True
1427
        for i, mask in enumerate(circuit.uni_a.user_tag.mask_list):
1428
            trace_a = traces[i*2]
1429
            trace_z = traces[i*2+1]
1430 1
            check &= EVCDeploy.check_trace(
1431 1
                mask, mask,
1432
                circuit.uni_a.interface,
1433
                circuit.uni_z.interface,
1434
                circuit.current_path,
1435 1
                trace_a, trace_z,
1436 1
            )
1437
        return check
1438 1
1439 1
    @staticmethod
1440
    def check_list_traces(list_circuits: list) -> dict:
1441 1
        """Check if current_path is deployed comparing with SDN traces."""
1442
        if not list_circuits:
1443 1
            return {}
1444
        uni_list = make_uni_list(list_circuits)
1445 1
        traces = EVCDeploy.run_bulk_sdntraces(uni_list)["result"]
1446
1447
        if not traces:
1448
            return {}
1449
1450
        try:
1451
            circuits_checked = {}
1452 1
            i = 0
1453 1
            for circuit in list_circuits:
1454 1
                if isinstance(circuit.uni_a.user_tag, TAGRange):
1455 1
                    length = len(circuit.uni_a.user_tag.mask_list)
1456 1
                    circuits_checked[circuit.id] = EVCDeploy.check_range(
1457
                        circuit, traces[i:i+length*2]
1458 1
                    )
1459 1
                    i += length*2
1460
                else:
1461 1
                    trace_a = traces[i]
1462 1
                    trace_z = traces[i+1]
1463
                    tag_a = None
1464 1
                    if circuit.uni_a.user_tag:
1465 1
                        tag_a = circuit.uni_a.user_tag.value
1466 1
                    tag_z = None
1467 1
                    if circuit.uni_z.user_tag:
1468
                        tag_z = circuit.uni_z.user_tag.value
1469 1
                    circuits_checked[circuit.id] = EVCDeploy.check_trace(
1470
                        tag_a,
1471 1
                        tag_z,
1472 1
                        circuit.uni_a.interface,
1473
                        circuit.uni_z.interface,
1474 1
                        circuit.current_path,
1475 1
                        trace_a, trace_z
1476 1
                    )
1477
                    i += 2
1478 1
        except IndexError as err:
1479
            log.error(
1480
                f"Bulk sdntraces returned fewer items than expected."
1481
                f"Error = {err}"
1482
            )
1483 1
            return {}
1484
1485 1
        return circuits_checked
1486 1
1487 1
    @staticmethod
1488 1
    def get_endpoint_by_id(
1489 1
        link: Link,
1490 1
        id_: str,
1491
        operator: Union[eq, ne]
1492 1
    ) -> Interface:
1493 1
        """Return endpoint from link
1494
        either equal(eq) or not equal(ne) to id"""
1495
        if operator(link.endpoint_a.switch.id, id_):
1496
            return link.endpoint_a
1497
        return link.endpoint_b
1498
1499 1
1500
class LinkProtection(EVCDeploy):
1501
    """Class to handle link protection."""
1502 1
1503 1
    def is_affected_by_link(self, link=None):
1504 1
        """Verify if the current path is affected by link down event."""
1505 1
        return self.current_path.is_affected_by_link(link)
1506
1507
    def is_using_primary_path(self):
1508 1
        """Verify if the current deployed path is self.primary_path."""
1509 1
        return self.current_path == self.primary_path
1510
1511 1
    def is_using_backup_path(self):
1512
        """Verify if the current deployed path is self.backup_path."""
1513 1
        return self.current_path == self.backup_path
1514
1515 1
    def is_using_dynamic_path(self):
1516 1
        """Verify if the current deployed path is dynamic."""
1517 1
        if (
1518 1
            self.current_path
1519
            and not self.is_using_primary_path()
1520 1
            and not self.is_using_backup_path()
1521 1
            and self.current_path.status is EntityStatus.UP
1522
        ):
1523
            return True
1524
        return False
1525
1526 1
    def deploy_to(self, path_name=None, path=None):
1527 1
        """Create a deploy to path."""
1528 1
        if self.current_path == path:
1529
            log.debug(f"{path_name} is equal to current_path.")
1530
            return True
1531
1532 1
        if path.status is EntityStatus.UP:
1533
            return self.deploy_to_path(path)
1534
1535
        return False
1536 1
1537
    def handle_link_up(self, link):
1538 1
        """Handle circuit when link up.
1539 1
1540 1
        Args:
1541
            link(Link): Link affected by link.up event.
1542 1
1543 1
        """
1544 1
        if self.is_intra_switch():
1545 1
            return True
1546 1
1547 1
        if self.is_using_primary_path():
1548
            return True
1549
1550 1
        success = False
1551
        if self.primary_path.is_affected_by_link(link):
1552
            success = self.deploy_to_primary_path()
1553
1554
        if success:
1555
            return True
1556
1557
        # We tried to deploy(primary_path) without success.
1558
        # And in this case is up by some how. Nothing to do.
1559
        if self.is_using_backup_path() or self.is_using_dynamic_path():
1560
            return True
1561
1562
        # In this case, probably the circuit is not being used and
1563
        # we can move to backup
1564
        if self.backup_path.is_affected_by_link(link):
1565
            success = self.deploy_to_backup_path()
1566
1567
        # In this case, the circuit is not being used and we should
1568
        # try a dynamic path
1569
        if not success and self.dynamic_backup_path:
1570
            success = self.deploy_to_path()
1571
1572
        if success:
1573
            emit_event(self._controller, "redeployed_link_up",
1574
                       content=map_evc_event_content(self))
1575
            return True
1576
1577
        return True
1578
1579
    def handle_link_down(self):
1580
        """Handle circuit when link down.
1581
1582
        Returns:
1583
            bool: True if the re-deploy was successly otherwise False.
1584
1585
        """
1586
        success = False
1587
        if self.is_using_primary_path():
1588
            success = self.deploy_to_backup_path()
1589
        elif self.is_using_backup_path():
1590
            success = self.deploy_to_primary_path()
1591
1592
        if not success and self.dynamic_backup_path:
1593
            success = self.deploy_to_path()
1594
1595
        if success:
1596
            log.debug(f"{self} deployed after link down.")
1597
        else:
1598
            self.deactivate()
1599
            self.current_path = Path([])
1600
            self.sync()
1601
            log.debug(f"Failed to re-deploy {self} after link down.")
1602
1603
        return success
1604
1605
    @staticmethod
1606
    def get_interface_from_switch(uni: UNI, switches: dict) -> Interface:
1607
        """Get interface from switch by uni"""
1608
        switch = switches[uni.interface.switch.dpid]
1609
        interface = switch.interfaces[uni.interface.port_number]
1610
        return interface
1611
1612
    def handle_topology_update(self, switches: dict):
1613
        """Handle changes in the topology"""
1614
        # All intra-switch EVCs do not have current_path.
1615
        # In case of inter-switch EVC and not current_path,
1616
        # link_down should take care of deactivation.
1617
        return
1618
        if not self.is_intra_switch and not self.current_path:
1619
            return
1620
        try:
1621
            interface_a = self.get_interface_from_switch(self.uni_a, switches)
1622
        except KeyError:
1623
            id_ = self.uni_a.interface.id
1624
            log.warning(f"The interface {id_} was not found")
1625
            return
1626
1627
        try:
1628
            interface_z = self.get_interface_from_switch(self.uni_z, switches)
1629
        except KeyError:
1630
            id_ = self.uni_z.interface.id
1631
            log.warning(f"The interface {id_} was not found")
1632
            return
1633
1634
        active, interfaces = self.is_uni_interface_active(
1635
            interface_a, interface_z
1636
        )
1637
        if self.is_active() != active:
1638
            if active:
1639
                self.activate()
1640
                log.info(f"Activating EVC {self.id}. Interfaces: "
1641
                         f"{interfaces}.")
1642
            else:
1643
                self.deactivate()
1644
                log.info(f"Deactivating EVC {self.id}. Interfaces: "
1645
                         f"{interfaces}.")
1646
            self.sync()
1647
1648
    def are_unis_active(self, switches: dict) -> bool:
1649
        """Determine whether this EVC should be active"""
1650
        interface_a = self.get_interface_from_switch(self.uni_a, switches)
1651
        interface_z = self.get_interface_from_switch(self.uni_z, switches)
1652
        active, _ = self.is_uni_interface_active(interface_a, interface_z)
1653
        return active
1654
1655
    @staticmethod
1656
    def is_uni_interface_active(
1657
        interface_a: Interface,
1658
        interface_z: Interface
1659
    ) -> tuple[bool, dict]:
1660
        """Determine whether a UNI should be active"""
1661
        active = True
1662
        interfaces = {}
1663
        interface_a_dict = {
1664
            "status": interface_a.status.value,
1665
            "status_reason": interface_a.status_reason
1666
        }
1667
        interface_z_dict = {
1668
            "status": interface_z.status.value,
1669
            "status_reason": interface_z.status_reason
1670
        }
1671
        if (interface_a.status != EntityStatus.UP
1672
                or interface_a.status_reason != set()):
1673
            active = False
1674
            interfaces[interface_a.id] = interface_a_dict
1675
        if (interface_z.status != EntityStatus.UP
1676
                or interface_z.status_reason != set()):
1677
            active = False
1678
            interfaces[interface_z.id] = interface_z_dict
1679
        if active:
1680
            interfaces[interface_a.id] = interface_a_dict
1681
            interfaces[interface_z.id] = interface_z_dict
1682
        return active, interfaces
1683
1684
1685
class EVC(LinkProtection):
1686
    """Class that represents a E-Line Virtual Connection."""
1687