o2ims/adapter/clients/fault_client.py

   1 # Copyright (C) 2022 Wind River Systems, Inc.
   2 #
   3 #  Licensed under the Apache License, Version 2.0 (the "License");
   4 #  you may not use this file except in compliance with the License.
   5 #  You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #  Unless required by applicable law or agreed to in writing, software
  10 #  distributed under the License is distributed on an "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #  See the License for the specific language governing permissions and
  13 #  limitations under the License.
  14
  15 # client talking to Stx standalone
  16
  17 from typing import List  # Optional,  Set
  18 import uuid as uuid
  19
  20 from cgtsclient.client import get_client as get_stx_client
  21 from cgtsclient.exc import EndpointException
  22 from dcmanagerclient.api.client import client as get_dc_client
  23 from fmclient.client import get_client as get_fm_client
  24 from fmclient.common.exceptions import HTTPNotFound, HttpServerError
  25
  26 from o2app.adapter import unit_of_work
  27 from o2common.config import config
  28 from o2common.service.client.base_client import BaseClient
  29 from o2ims.domain import alarm_obj as alarmModel
  30
  31 from o2common.helper import o2logging
  32 logger = o2logging.get_logger(__name__)
  33
  34
  35 CGTSCLIENT_ENDPOINT_ERROR_MSG = \
  36     'Must provide Keystone credentials or user-defined endpoint and token'
  37
  38
  39 class StxAlarmClient(BaseClient):
  40     def __init__(self, uow: unit_of_work.AbstractUnitOfWork, driver=None):
  41         super().__init__()
  42         self.driver = driver if driver else StxFaultClientImp()
  43         self.uow = uow
  44
  45     def _get(self, id) -> alarmModel.FaultGenericModel:
  46         return self.driver.getAlarmInfo(id)
  47
  48     def _list(self, **filters) -> List[alarmModel.FaultGenericModel]:
  49         newmodels = self.driver.getAlarmList(**filters)
  50         uow = self.uow
  51         exist_alarms = {}
  52         with uow:
  53             rs = uow.session.execute(
  54                 '''
  55                 SELECT "alarmEventRecordId"
  56                 FROM "alarmEventRecord"
  57                 WHERE "perceivedSeverity" != :perceived_severity_enum
  58                 ''',
  59                 dict(perceived_severity_enum=alarmModel.PerceivedSeverityEnum.
  60                      CLEARED)
  61             )
  62             for row in rs:
  63                 id = row[0]
  64                 # logger.debug('Exist alarm: ' + id)
  65                 exist_alarms[id] = False
  66
  67         ret = []
  68         for m in newmodels:
  69             try:
  70                 if exist_alarms[m.id]:
  71                     ret.append(m)
  72                     exist_alarms[m.id] = True
  73             except KeyError:
  74                 logger.debug('alarm new: ' + m.id)
  75                 ret.append(m)
  76
  77         for alarm in exist_alarms:
  78             logger.debug('exist alarm: ' + alarm)
  79             if exist_alarms[alarm]:
  80                 # exist alarm is active
  81                 continue
  82             try:
  83                 event = self._get(alarm)
  84             except HTTPNotFound:
  85                 logger.debug('alarm {} not in this resource pool {}'
  86                              .format(alarm, self._pool_id))
  87                 continue
  88             except HttpServerError:
  89                 # TODO(jon): This exception needs to be removed when the
  90                 # INF-457 related FM client upgrade and issue fix occur.
  91                 logger.debug('alarm {} query failed'.format(alarm))
  92                 continue
  93             ret.append(event)
  94
  95         return ret
  96
  97     def _set_stx_client(self):
  98         self.driver.setFaultClient(self._pool_id)
  99
 100
 101 class StxEventClient(BaseClient):
 102     def __init__(self, driver=None):
 103         super().__init__()
 104         self.driver = driver if driver else StxFaultClientImp()
 105
 106     def _get(self, id) -> alarmModel.FaultGenericModel:
 107         return self.driver.getEventInfo(id)
 108
 109     def _list(self, **filters) -> List[alarmModel.FaultGenericModel]:
 110         return self.driver.getEventList(**filters)
 111
 112     def _set_stx_client(self):
 113         self.driver.setFaultClient(self._pool_id)
 114
 115
 116 # internal driver which implement client call to Stx Fault Management instance
 117 class StxFaultClientImp(object):
 118     def __init__(self, fm_client=None, stx_client=None, dc_client=None):
 119         super().__init__()
 120         self.fmclient = fm_client if fm_client else self.getFmClient()
 121         self.stxclient = stx_client if stx_client else self.getStxClient()
 122         self.dcclient = dc_client if dc_client else self.getDcmanagerClient()
 123
 124     def getStxClient(self):
 125         os_client_args = config.get_stx_access_info()
 126         config_client = get_stx_client(**os_client_args)
 127         return config_client
 128
 129     def getDcmanagerClient(self):
 130         os_client_args = config.get_dc_access_info()
 131         config_client = get_dc_client(**os_client_args)
 132         return config_client
 133
 134     def getFmClient(self):
 135         os_client_args = config.get_fm_access_info()
 136         config_client = get_fm_client(1, **os_client_args)
 137         return config_client
 138
 139     def getSubcloudList(self):
 140         self.dcclient = self.getDcmanagerClient()
 141         subs = self.dcclient.subcloud_manager.list_subclouds()
 142         known_subs = [sub for sub in subs if sub.sync_status != 'unknown']
 143         return known_subs
 144
 145     def getSubcloudFaultClient(self, subcloud_id):
 146         subcloud = self.dcclient.subcloud_manager.\
 147             subcloud_additional_details(subcloud_id)
 148         logger.debug('subcloud name: %s, oam_floating_ip: %s' %
 149                      (subcloud[0].name, subcloud[0].oam_floating_ip))
 150         try:
 151             sub_is_https = False
 152             os_client_args = config.get_stx_access_info(
 153                 region_name=subcloud[0].name,
 154                 subcloud_hostname=subcloud[0].oam_floating_ip)
 155             stx_client = get_stx_client(**os_client_args)
 156         except EndpointException as e:
 157             msg = e.format_message()
 158             if CGTSCLIENT_ENDPOINT_ERROR_MSG in msg:
 159                 sub_is_https = True
 160                 os_client_args = config.get_stx_access_info(
 161                     region_name=subcloud[0].name, sub_is_https=sub_is_https,
 162                     subcloud_hostname=subcloud[0].oam_floating_ip)
 163                 stx_client = get_stx_client(**os_client_args)
 164             else:
 165                 raise ValueError('Stx endpoint exception: %s' % msg)
 166         except Exception:
 167             raise ValueError('cgtsclient get subcloud client failed')
 168
 169         os_client_args = config.get_fm_access_info(
 170             sub_is_https=sub_is_https,
 171             subcloud_hostname=subcloud[0].oam_floating_ip)
 172         fm_client = get_fm_client(1, **os_client_args)
 173
 174         return stx_client, fm_client
 175
 176     def setFaultClient(self, resource_pool_id):
 177         systems = self.stxclient.isystem.list()
 178         if resource_pool_id == systems[0].uuid:
 179             logger.debug('Fault Client not change: %s' % resource_pool_id)
 180             self.fmclient = self.getFmClient()
 181             return
 182
 183         subclouds = self.getSubcloudList()
 184         for subcloud in subclouds:
 185             substxclient, subfaultclient = self.getSubcloudFaultClient(
 186                 subcloud.subcloud_id)
 187             systems = substxclient.isystem.list()
 188             if resource_pool_id == systems[0].uuid:
 189                 self.fmclient = subfaultclient
 190
 191     def getAlarmList(self, **filters) -> List[alarmModel.FaultGenericModel]:
 192         alarms = self.fmclient.alarm.list(expand=True)
 193         if len(alarms) == 0:
 194             return []
 195         logger.debug('alarm 1:' + str(alarms[0].to_dict()))
 196         # [print('alarm:' + str(alarm.to_dict())) for alarm in alarms if alarm]
 197         return [alarmModel.FaultGenericModel(
 198             alarmModel.EventTypeEnum.ALARM, self._alarmconverter(alarm))
 199             for alarm in alarms if alarm]
 200
 201     def getAlarmInfo(self, id) -> alarmModel.FaultGenericModel:
 202         try:
 203             alarm = self.fmclient.alarm.get(id)
 204             logger.debug('get alarm id ' + id + ':' + str(alarm.to_dict()))
 205         except HTTPNotFound:
 206             event = self.fmclient.event_log.get(id)
 207             return alarmModel.FaultGenericModel(
 208                 alarmModel.EventTypeEnum.ALARM, self._eventconverter(event,
 209                                                                      True))
 210         return alarmModel.FaultGenericModel(
 211             alarmModel.EventTypeEnum.ALARM, self._alarmconverter(alarm))
 212
 213     def getEventList(self, **filters) -> List[alarmModel.FaultGenericModel]:
 214         events = self.fmclient.event_log.list(alarms=True, expand=True)
 215         logger.debug('event 1:' + str(events[0].to_dict()))
 216         # [print('alarm:' + str(event.to_dict())) for event in events if event]
 217         return [alarmModel.FaultGenericModel(
 218             alarmModel.EventTypeEnum.EVENT, self._eventconverter(event))
 219             for event in events if event]
 220
 221     def getEventInfo(self, id) -> alarmModel.FaultGenericModel:
 222         event = self.fmclient.event_log.get(id)
 223         logger.debug('get event id ' + id + ':' + str(event.to_dict()))
 224         return alarmModel.FaultGenericModel(
 225             alarmModel.EventTypeEnum.EVENT, self._eventconverter(event))
 226
 227     @ staticmethod
 228     def _alarmconverter(alarm):
 229         selected_keys = [
 230             'alarm_id', 'alarm_state', 'entity_type_id', 'entity_instance_id',
 231             'reason_text', 'alarm_type', 'probable_cause',
 232             'proposed_repair_action', 'service_affecting', 'suppression',
 233             'suppression_status', 'mgmt_affecting', 'degrade_affecting'
 234         ]
 235         content = alarm.to_dict()
 236         filtered = dict(
 237             filter(lambda item: item[0] in selected_keys, content.items()))
 238         setattr(alarm, 'filtered', filtered)
 239         # setattr(alarm, 'alarm_def_id', uuid.uuid3(
 240         #         uuid.NAMESPACE_URL, alarm.alarm_id))
 241         setattr(alarm, 'state', alarm.alarm_state)
 242
 243         setattr(alarm, 'alarm_def_id', str(uuid.uuid3(
 244                 uuid.NAMESPACE_URL, alarm.alarm_id)))
 245         setattr(alarm, 'probable_cause_id', str(uuid.uuid3(
 246                 uuid.NAMESPACE_URL, alarm.probable_cause)))
 247         return alarm
 248
 249     @ staticmethod
 250     def _eventconverter(event, clear=False):
 251         selected_keys = [
 252             'event_log_id', 'state', 'entity_type_id',
 253             'entity_instance_id', 'reason_text', 'event_log_type',
 254             'probable_cause', 'proposed_repair_action',
 255             'service_affecting', 'suppression', 'suppression_status'
 256         ]
 257         content = event.to_dict()
 258         filtered = dict(
 259             filter(lambda item: item[0] in selected_keys, content.items()))
 260         setattr(event, 'filtered', filtered)
 261         setattr(event, 'alarm_id', event.event_log_id)
 262         setattr(event, 'alarm_type', event.event_log_type)
 263         if clear:
 264             logger.debug('alarm is clear')
 265             event.state = 'clear'
 266         setattr(event, 'alarm_def_id', str(uuid.uuid3(
 267                 uuid.NAMESPACE_URL, event.alarm_id)))
 268         setattr(event, 'probable_cause_id', str(uuid.uuid3(
 269                 uuid.NAMESPACE_URL, event.probable_cause)))
 270         return event
 271
 272     @ staticmethod
 273     def _alarmeventhasher(event, state=''):
 274         # The event model and the alarm model have different parameter name
 275         # of the state. alarm model is alarm_state, event model is state.
 276         status = event.alarm_state if state == '' else state
 277         return str(hash((event.uuid, event.timestamp, status)))