1 # -*- coding: utf-8 -*-
3 # Copyright 2018 Telefonica
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
20 This WIM does nothing and allows using it for testing and when no WIM is needed
24 from uuid
import uuid4
25 from osm_ro_plugin
.sdnconn
import SdnConnectorBase
, SdnConnectorError
26 from http
import HTTPStatus
28 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
31 class SdnDummyConnector(SdnConnectorBase
):
32 """Abstract base class for all the WIM connectors
35 wim (dict): WIM record, as stored in the database
36 wim_account (dict): WIM account record, as stored in the database
37 config (dict): optional persistent information related to an specific
38 connector. Inside this dict, a special key,
39 ``service_endpoint_mapping`` provides the internal endpoint
41 logger (logging.Logger): optional logger object. If none is passed
42 ``openmano.wim.wimconn`` is used.
44 The arguments of the constructor are converted to object attributes.
45 An extra property, ``service_endpoint_mapping`` is created from ``config``.
48 def __init__(self
, wim
, wim_account
, config
=None, logger
=None):
49 self
.logger
= logger
or logging
.getLogger("ro.sdn.dummy")
50 super(SdnDummyConnector
, self
).__init
__(wim
, wim_account
, config
, self
.logger
)
51 self
.logger
.debug("__init: wim='{}' wim_account='{}'".format(wim
, wim_account
))
55 def check_credentials(self
):
56 """Check if the connector itself can access the WIM.
59 SdnConnectorError: Issues regarding authorization, access to
60 external URLs, etc are detected.
62 self
.logger
.debug("check_credentials")
66 def get_connectivity_service_status(self
, service_uuid
, conn_info
=None):
67 """Monitor the status of the connectivity service established
70 service_uuid (str): UUID of the connectivity service
71 conn_info (dict or None): Information returned by the connector
72 during the service creation/edition and subsequently stored in
76 dict: JSON/YAML-serializable dict that contains a mandatory key
77 ``sdn_status`` associated with one of the following values::
79 Additionally ``error_msg``(**str**) and ``sdn_info``(**dict**)
80 keys can be used to provide additional status explanation or
81 new information available for the connectivity service.
84 "get_connectivity_service_status: service_uuid='{}' conn_info='{}'".format(
85 service_uuid
, conn_info
89 return {"sdn_status": "ACTIVE", "sdn_info": self
.connections
.get(service_uuid
)}
91 def create_connectivity_service(self
, service_type
, connection_points
, **kwargs
):
92 """Establish WAN connectivity between the endpoints"""
94 "create_connectivity_service: service_type='{}' connection_points='{}', kwargs='{}'".format(
95 service_type
, connection_points
, kwargs
99 self
.connections
[_id
] = connection_points
.copy()
104 def delete_connectivity_service(self
, service_uuid
, conn_info
=None):
105 """Disconnect multi-site endpoints previously connected"""
107 "delete_connectivity_service: service_uuid='{}' conn_info='{}'".format(
108 service_uuid
, conn_info
112 if service_uuid
not in self
.connections
:
113 raise SdnConnectorError(
114 "connectivity {} not found".format(service_uuid
),
115 http_code
=HTTPStatus
.NOT_FOUND
.value
,
118 self
.connections
.pop(service_uuid
, None)
122 def edit_connectivity_service(
123 self
, service_uuid
, conn_info
=None, connection_points
=None, **kwargs
125 """Change an existing connectivity service.
127 This method's arguments and return value follow the same convention as
128 :meth:`~.create_connectivity_service`.
131 "edit_connectivity_service: service_uuid='{}' conn_info='{}', connection_points='{}'"
132 "kwargs='{}'".format(service_uuid
, conn_info
, connection_points
, kwargs
)
135 if service_uuid
not in self
.connections
:
136 raise SdnConnectorError(
137 "connectivity {} not found".format(service_uuid
),
138 http_code
=HTTPStatus
.NOT_FOUND
.value
,
141 self
.connections
[service_uuid
] = connection_points
.copy()
145 def clear_all_connectivity_services(self
):
146 """Delete all WAN Links in a WIM.
148 This method is intended for debugging only, and should delete all the
149 connections controlled by the WIM, not only the WIM connections that
150 a specific RO is aware of.
153 self
.logger
.debug("clear_all_connectivity_services")
154 self
.connections
.clear()
158 def get_all_active_connectivity_services(self
):
159 """Provide information about all active connections provisioned by a
163 SdnConnectorException: In case of error.
165 self
.logger
.debug("get_all_active_connectivity_services")
167 return self
.connections