4178a86975
Several improvements and fixes to enable the end-to-end functionality of all of the components in support of the O-RAN Spec Compliant Timing API Notification work. 1. Add time stamps to logging for notificationservice and notificationclient 2. Add support for the "optional" hierarchy in the resource address which allows the client to query the status of a specific ptp instances. ie. get the status of instance ptp1 rather than all ptp instances 3. Add a parent key to the returned notification data so that multiple statuses can be returned to the client with a single notification' 4. Reworked the notificationservice daemonset to start its process directly rather than using an intermediary script. This allows the container logs to show properly via kubectl logs and will also allow the container to crash properly if the program errors out. 5. Reworked the helm values for ptp4l and ts2phc instances to allow users to supply overrides with multiple instances Test plan: PASS: PTP notification v1 compatibility PASS: GET all v2 resources PASS: SUBSCRIBE/LIST/DELETE v2 resources PASS: Build and deploy containers/fluxcd app Story: 2010056 Task: 46226 Change-Id: Id471fdc0815afdcc5639e81c6457616e268e6cd7 Signed-off-by: Cole Walker <cole.walker@windriver.com>
110 lines
4.7 KiB
Python
110 lines
4.7 KiB
Python
#
|
|
# Copyright (c) 2021-2022 Wind River Systems, Inc.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
|
|
import json
|
|
import re
|
|
|
|
import requests
|
|
import logging
|
|
from datetime import datetime
|
|
from notificationclientsdk.common.helpers import constants
|
|
from notificationclientsdk.common.helpers import log_helper
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
log_helper.config_logger(LOG)
|
|
|
|
|
|
def notify(subscriptioninfo, notification, timeout=2, retry=3):
|
|
result = False
|
|
while True:
|
|
retry = retry - 1
|
|
try:
|
|
headers = {'Content-Type': 'application/json'}
|
|
data = format_notification_data(subscriptioninfo, notification)
|
|
data = json.dumps(data)
|
|
url = subscriptioninfo.EndpointUri
|
|
response = requests.post(url, data=data, headers=headers, timeout=timeout)
|
|
response.raise_for_status()
|
|
result = True
|
|
return response
|
|
except requests.exceptions.ConnectionError as errc:
|
|
if retry > 0:
|
|
LOG.warning("Retry notifying due to: {0}".format(str(errc)))
|
|
continue
|
|
raise errc
|
|
except requests.exceptions.Timeout as errt:
|
|
if retry > 0:
|
|
LOG.warning("Retry notifying due to: {0}".format(str(errt)))
|
|
continue
|
|
raise errt
|
|
except requests.exceptions.RequestException as ex:
|
|
LOG.warning("Failed to notify due to: {0}".format(str(ex)))
|
|
raise ex
|
|
except requests.exceptions.HTTPError as ex:
|
|
LOG.warning("Failed to notify due to: {0}".format(str(ex)))
|
|
raise ex
|
|
except Exception as ex:
|
|
LOG.warning("Failed to notify due to: {0}".format(str(ex)))
|
|
raise ex
|
|
|
|
return result
|
|
|
|
|
|
def format_notification_data(subscriptioninfo, notification):
|
|
if hasattr(subscriptioninfo, 'ResourceType'):
|
|
LOG.debug("format_notification_data: Found v1 subscription, no formatting required.")
|
|
return notification
|
|
elif hasattr(subscriptioninfo, 'ResourceAddress'):
|
|
_, _, resource_path, _, _ = parse_resource_address(subscriptioninfo.ResourceAddress)
|
|
resource_mapped_value = constants.RESOURCE_ADDRESS_MAPPINGS[resource_path]
|
|
formatted_notification = {resource_mapped_value: []}
|
|
for instance in notification:
|
|
# Add the instance identifier to ResourceAddress for PTP lock-state
|
|
# and PTP clockClass
|
|
if notification[instance]['source'] in [constants.SOURCE_SYNC_PTP_CLOCK_CLASS,
|
|
constants.SOURCE_SYNC_PTP_LOCK_STATE]:
|
|
temp_values = notification[instance].get('data', {}).get('values', [])
|
|
resource_address = temp_values[0].get('ResourceAddress', None)
|
|
if instance not in resource_address:
|
|
add_instance_name = resource_address.split('/', 3)
|
|
add_instance_name.insert(3, instance)
|
|
resource_address = '/'.join(add_instance_name)
|
|
notification[instance]['data']['values'][0]['ResourceAddress'] = resource_address
|
|
formatted_notification[resource_mapped_value].append(notification[instance])
|
|
for instance in formatted_notification[resource_mapped_value]:
|
|
this_delivery_time = instance['time']
|
|
if type(this_delivery_time) != str:
|
|
format_time = datetime.fromtimestamp(float(this_delivery_time)).\
|
|
strftime('%Y-%m-%dT%H:%M:%S%fZ')
|
|
instance['time'] = format_time
|
|
else:
|
|
raise Exception("format_notification_data: No valid source address found in notification")
|
|
LOG.debug(
|
|
"format_notification_data: Added parent key for client consumption: %s" %
|
|
formatted_notification)
|
|
return formatted_notification
|
|
|
|
|
|
def parse_resource_address(resource_address):
|
|
# The format of resource address is:
|
|
# /{clusterName}/{siteName}(/optional/hierarchy/..)/{nodeName}/{resource}
|
|
clusterName = resource_address.split('/')[1]
|
|
nodeName = resource_address.split('/')[2]
|
|
resource_path = '/' + re.split('[/]', resource_address, 3)[3]
|
|
resource_list = re.findall(r'[^/]+', resource_path)
|
|
if len(resource_list) == 4:
|
|
remove_optional = '/' + resource_list[0]
|
|
resource_path = resource_path.replace(remove_optional, '')
|
|
resource_address = resource_address.replace(remove_optional, '')
|
|
optional = resource_list[0]
|
|
LOG.debug("Optional hierarchy found when parsing resource address: %s" % optional)
|
|
else:
|
|
optional = None
|
|
|
|
# resource_address is the full address without any optional hierarchy
|
|
# resource_path is the specific identifier for the resource
|
|
return clusterName, nodeName, resource_path, optional, resource_address
|