Newer
Older
# Copyright 2022-2024 ETSI OSG/SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import copy, grpc, json, logging, queue, threading
from typing import Any, Dict, List, Optional, Tuple, Union
from common.tools.grpc.Tools import grpc_message_to_json_string
from common.type_checkers.Checkers import chk_float, chk_length, chk_string, chk_type
from .gnmi.gnmi_pb2_grpc import gNMIStub
from .gnmi.gnmi_pb2 import Encoding, GetRequest, SetRequest, UpdateResult # pylint: disable=no-name-in-module
from .handlers import ALL_RESOURCE_KEYS, compose, get_path, parse
from .handlers.YangHandler import YangHandler
from .tools.Capabilities import check_capabilities
from .tools.Channel import get_grpc_channel
from .tools.Path import path_from_string, path_to_string #, compose_path
from .tools.Subscriptions import Subscriptions
from .tools.Value import decode_value #, value_exists
#from .MonitoringThread import MonitoringThread
class GnmiSessionHandler:
def __init__(self, address : str, port : int, settings : Dict, logger : logging.Logger) -> None:
self._address = address
self._port = port
self._settings = copy.deepcopy(settings)
self._logger = logger
self._lock = threading.Lock()
self._connected = threading.Event()
self._username = settings.get('username')
self._password = settings.get('password')
self._use_tls = settings.get('use_tls', False)
self._channel : Optional[grpc.Channel] = None
self._stub : Optional[gNMIStub] = None
self._yang_handler = YangHandler()
#self._monit_thread = None
self._subscriptions = Subscriptions()
self._in_subscriptions = queue.Queue()
self._out_samples = queue.Queue()
def __del__(self) -> None:
self._logger.warning('Destroying YangValidator...')
self._logger.warning('yang_validator.data:')
for path, dnode in self._yang_handler.get_data_paths().items():
self._logger.warning(' {:s}: {:s}'.format(str(path), json.dumps(dnode.print_dict())))
self._yang_handler.destroy()
self._logger.warning('DONE')
@property
def subscriptions(self): return self._subscriptions
@property
def in_subscriptions(self): return self._in_subscriptions
@property
def out_samples(self): return self._out_samples
def connect(self):
with self._lock:
self._channel = get_grpc_channel(self._address, self._port, self._use_tls, self._logger)
self._stub = gNMIStub(self._channel)
check_capabilities(self._stub, self._username, self._password, timeout=120)
#self._monit_thread = MonitoringThread(
# self._stub, self._logger, self._settings, self._in_subscriptions, self._out_samples)
#self._monit_thread.start()
self._connected.set()
def disconnect(self):
if not self._connected.is_set(): return
with self._lock:
#self._monit_thread.stop()
#self._monit_thread.join()
self._channel.close()
self._connected.clear()
def get(self, resource_keys : List[str]) -> List[Tuple[str, Union[Any, None, Exception]]]:
if len(resource_keys) == 0: resource_keys = ALL_RESOURCE_KEYS
chk_type('resources', resource_keys, list)
parsing_results = []
get_request = GetRequest()
get_request.type = GetRequest.DataType.ALL
get_request.encoding = Encoding.JSON_IETF
#get_request.use_models.add() # kept empty: return for all models supported
for i,resource_key in enumerate(resource_keys):
str_resource_name = 'resource_key[#{:d}]'.format(i)
try:
chk_string(str_resource_name, resource_key, allow_empty=False)
self._logger.debug('[GnmiSessionHandler:get] resource_key = {:s}'.format(str(resource_key)))
self._logger.debug('[GnmiSessionHandler:get] str_path = {:s}'.format(str(str_path)))
get_request.path.append(path_from_string(str_path))
except Exception as e: # pylint: disable=broad-except
MSG = 'Exception parsing {:s}: {:s}'
self._logger.exception(MSG.format(str_resource_name, str(resource_key)))
parsing_results.append((resource_key, e)) # if validation fails, store the exception
self._logger.debug('parsing_results={:s}'.format(str(parsing_results)))
if len(parsing_results) > 0:
return parsing_results
metadata = [('username', self._username), ('password', self._password)]
timeout = None # GNMI_SUBSCRIPTION_TIMEOUT = int(sampling_duration)
get_reply = self._stub.Get(get_request, metadata=metadata, timeout=timeout)
self._logger.debug('get_reply={:s}'.format(grpc_message_to_json_string(get_reply)))
results = []
#results[str_filter] = [i, None, False] # (index, value, processed?)
for notification in get_reply.notification:
#for delete_path in notification.delete:
# self._logger.info('delete_path={:s}'.format(grpc_message_to_json_string(delete_path)))
# str_path = path_to_string(delete_path)
# resource_key_tuple = results.get(str_path)
# if resource_key_tuple is None:
# # pylint: disable=broad-exception-raised
# MSG = 'Unexpected Delete Path({:s}); requested resource_keys({:s})'
# raise Exception(MSG.format(str(str_path), str(resource_keys)))
# resource_key_tuple[2] = True
for update in notification.update:
self._logger.debug('update={:s}'.format(grpc_message_to_json_string(update)))
str_path = path_to_string(update.path)
#resource_key_tuple = results.get(str_path)
#if resource_key_tuple is None:
# # pylint: disable=broad-exception-raised
# MSG = 'Unexpected Update Path({:s}); requested resource_keys({:s})'
# raise Exception(MSG.format(str(str_path), str(resource_keys)))
try:
value = decode_value(update.val)
#resource_key_tuple[1] = value
#resource_key_tuple[2] = True
results.extend(parse(str_path, value, self._yang_handler))
except Exception as e: # pylint: disable=broad-except
MSG = 'Exception processing update {:s}'
self._logger.exception(MSG.format(grpc_message_to_json_string(update)))
results.append((str_path, e)) # if validation fails, store the exception
#_results = sorted(results.items(), key=lambda x: x[1][0])
#results = list()
#for resource_key,resource_key_tuple in _results:
# _, value, processed = resource_key_tuple
# value = value if processed else Exception('Not Processed')
# results.append((resource_key, value))
return results
def set(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]:
#resource_keys = [key for key,_ in resources]
#current_values = self.get(resource_keys)
#resource_tuples = {
# resource_key : [i, value, value_exists(value), None]
# for i,(resource_key,value) in enumerate(current_values)
#}
#self._logger.info('---0')
#self._logger.info(str(resource_tuples))
set_request = SetRequest()
#for resource_key in resource_keys:
for resource_key, resource_value in resources:
#self._logger.info('---1')
#self._logger.info(str(resource_key))
#self._logger.info(str(resource_value))
#resource_tuple = resource_tuples.get(resource_key)
#if resource_tuple is None: continue
#_, value, exists, operation_done = resource_tuple
if isinstance(resource_value, str): resource_value = json.loads(resource_value)
str_path, str_data = compose(resource_key, resource_value, self._yang_handler, delete=False)
#self._logger.info('---3')
#self._logger.info(str(str_path))
#self._logger.info(str(str_data))
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
set_request_list = set_request.update #if exists else set_request.replace
set_request_entry = set_request_list.add()
set_request_entry.path.CopyFrom(path_from_string(str_path))
set_request_entry.val.json_val = str_data.encode('UTF-8')
self._logger.info('set_request={:s}'.format(grpc_message_to_json_string(set_request)))
metadata = [('username', self._username), ('password', self._password)]
timeout = None # GNMI_SUBSCRIPTION_TIMEOUT = int(sampling_duration)
set_reply = self._stub.Set(set_request, metadata=metadata, timeout=timeout)
self._logger.info('set_reply={:s}'.format(grpc_message_to_json_string(set_reply)))
results = []
for (resource_key, resource_value), update_result in zip(resources, set_reply.response):
operation = update_result.op
if operation == UpdateResult.UPDATE:
results.append((resource_key, True))
else:
results.append((resource_key, Exception('Unexpected')))
#str_path = path_to_string(update_result.path)
#resource_tuple = resource_tuples.get(str_path)
#if resource_tuple is None: continue
#resource_tuple[3] = operation
#resource_tuples = sorted(resource_tuples.items(), key=lambda x: x[1][0])
#results = list()
#for resource_key,resource_tuple in resource_tuples:
# _, _, exists, operation_done = resource_tuple
# desired_operation = 'update' if exists else 'replace'
#
# if operation_done == UpdateResult.INVALID:
# value = Exception('Invalid')
# elif operation_done == UpdateResult.DELETE:
# value = Exception('Unexpected Delete')
# elif operation_done == UpdateResult.REPLACE:
# value = True if desired_operation == 'replace' else Exception('Failed')
# elif operation_done == UpdateResult.UPDATE:
# value = True if desired_operation == 'update' else Exception('Failed')
# else:
# value = Exception('Unexpected')
# results.append((resource_key, value))
return results
def delete(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]:
#resource_keys = [key for key,_ in resources]
#current_values = self.get(resource_keys)
#resource_tuples = {
# resource_key : [i, value, value_exists(value), None]
# for i,(resource_key,value) in enumerate(current_values)
#}
#self._logger.info('---0')
#self._logger.info(str(resource_tuples))
set_request = SetRequest()
#for resource_key in resource_keys:
for resource_key, resource_value in resources:
#self._logger.info('---1')
#self._logger.info(str(resource_key))
#self._logger.info(str(resource_value))
#resource_tuple = resource_tuples.get(resource_key)
#if resource_tuple is None: continue
#_, value, exists, operation_done = resource_tuple
#if not exists: continue
if isinstance(resource_value, str): resource_value = json.loads(resource_value)
# pylint: disable=unused-variable
str_path, str_data = compose(resource_key, resource_value, self._yang_handler, delete=True)
#self._logger.info('---3')
#self._logger.info(str(str_path))
#self._logger.info(str(str_data))
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
set_request_entry = set_request.delete.add()
set_request_entry.CopyFrom(path_from_string(str_path))
self._logger.info('set_request={:s}'.format(grpc_message_to_json_string(set_request)))
metadata = [('username', self._username), ('password', self._password)]
timeout = None # GNMI_SUBSCRIPTION_TIMEOUT = int(sampling_duration)
set_reply = self._stub.Set(set_request, metadata=metadata, timeout=timeout)
self._logger.info('set_reply={:s}'.format(grpc_message_to_json_string(set_reply)))
results = []
for (resource_key, resource_value), update_result in zip(resources, set_reply.response):
operation = update_result.op
if operation == UpdateResult.DELETE:
results.append((resource_key, True))
else:
results.append((resource_key, Exception('Unexpected')))
#str_path = path_to_string(update_result.path)
#resource_tuple = resource_tuples.get(str_path)
#if resource_tuple is None: continue
#resource_tuple[3] = operation
#resource_tuples = sorted(resource_tuples.items(), key=lambda x: x[1][0])
#results = list()
#for resource_key,resource_tuple in resource_tuples:
# _, _, exists, operation_done = resource_tuple
# if operation_done == UpdateResult.INVALID:
# value = Exception('Invalid')
# elif operation_done == UpdateResult.DELETE:
# value = True
# elif operation_done == UpdateResult.REPLACE:
# value = Exception('Unexpected Replace')
# elif operation_done == UpdateResult.UPDATE:
# value = Exception('Unexpected Update')
# else:
# value = Exception('Unexpected')
# results.append((resource_key, value))
return results
def subscribe(self, subscriptions : List[Tuple[str, float, float]]) -> List[Union[bool, Exception]]:
results = []
for i,subscription in enumerate(subscriptions):
str_subscription_name = 'subscriptions[#{:d}]'.format(i)
try:
chk_type(str_subscription_name, subscription, (list, tuple))
chk_length(str_subscription_name, subscription, min_length=3, max_length=3)
resource_key, sampling_duration, sampling_interval = subscription
chk_string(str_subscription_name + '.resource_key', resource_key, allow_empty=False)
chk_float(str_subscription_name + '.sampling_duration', sampling_duration, min_value=0)
chk_float(str_subscription_name + '.sampling_interval', sampling_interval, min_value=0)
except Exception as e: # pylint: disable=broad-except
MSG = 'Exception validating {:s}: {:s}'
self._logger.exception(MSG.format(str_subscription_name, str(resource_key)))
results.append(e) # if validation fails, store the exception
continue
#resource_path = resource_key.split('/')
#self._subscriptions.add(resource_path, sampling_duration, sampling_interval, reference)
subscription = 'subscribe', resource_key, sampling_duration, sampling_interval
self._in_subscriptions.put_nowait(subscription)
results.append(True)
return results
def unsubscribe(self, subscriptions : List[Tuple[str, float, float]]) -> List[Union[bool, Exception]]:
results = []
for i,subscription in enumerate(subscriptions):
str_subscription_name = 'subscriptions[#{:d}]'.format(i)
try:
chk_type(str_subscription_name, subscription, (list, tuple))
chk_length(str_subscription_name, subscription, min_length=3, max_length=3)
resource_key, sampling_duration, sampling_interval = subscription
chk_string(str_subscription_name + '.resource_key', resource_key, allow_empty=False)
chk_float(str_subscription_name + '.sampling_duration', sampling_duration, min_value=0)
chk_float(str_subscription_name + '.sampling_interval', sampling_interval, min_value=0)
except Exception as e: # pylint: disable=broad-except
MSG = 'Exception validating {:s}: {:s}'
self._logger.exception(MSG.format(str_subscription_name, str(resource_key)))
results.append(e) # if validation fails, store the exception
continue
#resource_path = resource_key.split('/')
#reference = self._subscriptions.get(resource_path, sampling_duration, sampling_interval)
#if reference is None:
# results.append(False)
# continue
#self._subscriptions.delete(reference)
subscription = 'unsubscribe', resource_key, sampling_duration, sampling_interval
self._in_subscriptions.put_nowait(subscription)
results.append(True)
return results