Tools.py

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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 json, logging, operator, requests
from requests.auth import HTTPBasicAuth
from typing import Dict, Optional
from device.service.driver_api._Driver import RESOURCE_ENDPOINTS, RESOURCE_SERVICES

LOGGER = logging.getLogger(__name__)

HTTP_OK_CODES = {
    200,    # OK
    201,    # Created
    202,    # Accepted
    204,    # No Content
}

def find_key(resource, key):
    return json.loads(resource[1])[key]

def get_resource(
    base_url : str, resource_key : str,
    auth : Optional[HTTPBasicAuth] = None, timeout : Optional[int] = None
):
    url = '{:s}/restconf/data/tapi-common:context'.format(base_url)
    result = []
    try:
        response = requests.get(url, timeout=timeout, verify=False, auth=auth)
    except requests.exceptions.Timeout:
        LOGGER.exception('Timeout connecting {:s}'.format(url))
        return result
    except Exception as e:  # pylint: disable=broad-except
        LOGGER.exception('Exception retrieving {:s}'.format(resource_key))
        result.append((resource_key, e))
        return result

    try:
        context = json.loads(response.content)
    except Exception as e:  # pylint: disable=broad-except
        LOGGER.warning('Unable to decode reply: {:s}'.format(str(response.content)))
        result.append((resource_key, e))
        return result

    if resource_key == RESOURCE_ENDPOINTS:
        if 'tapi-common:context' in context:
            context = context['tapi-common:context']
        elif 'context' in context:
            context = context['context']

        for sip in context['service-interface-point']:
            layer_protocol_name = sip.get('layer-protocol-name', '?')
            supportable_spectrum = sip.get('tapi-photonic-media:media-channel-service-interface-point-spec', {})
            supportable_spectrum = supportable_spectrum.get('mc-pool', {})
            supportable_spectrum = supportable_spectrum.get('supportable-spectrum', [])
            supportable_spectrum = supportable_spectrum[0] if len(supportable_spectrum) == 1 else {}
            grid_type = supportable_spectrum.get('frequency-constraint', {}).get('grid-type')
            granularity = supportable_spectrum.get('frequency-constraint', {}).get('adjustment-granularity')
            direction = sip.get('direction', '?')

            endpoint_type = [layer_protocol_name, grid_type, granularity, direction]
            str_endpoint_type = ':'.join(filter(lambda i: operator.is_not(i, None), endpoint_type))
            sip_uuid = sip['uuid']

            sip_names = sip.get('name', [])
            sip_name = next(iter([
                sip_name['value']
                for sip_name in sip_names
                if sip_name['value-name'] == 'local-name'
            ]), sip_uuid)

            endpoint_url = '/endpoints/endpoint[{:s}]'.format(sip_uuid)
            endpoint_data = {'uuid': sip_uuid, 'name': sip_name, 'type': str_endpoint_type}
            result.append((endpoint_url, endpoint_data))

    elif resource_key == RESOURCE_SERVICES:
        if 'tapi-common:context' in context:
            context = context['tapi-common:context']
        elif 'context' in context:
            context = context['context']

        if 'tapi-connectivity:connectivity-context' in context:
            context = context['tapi-connectivity:connectivity-context']
        elif 'connectivity-context' in context:
            context = context['connectivity-context']

        for conn_svc in context['connectivity-service']:
            service_uuid = conn_svc['uuid']
            constraints = conn_svc.get('connectivity-constraint', {})
            total_req_cap = constraints.get('requested-capacity', {}).get('total-size', {})

            service_url = '/services/service[{:s}]'.format(service_uuid)
            service_data = {
                'uuid': service_uuid,
                'direction': constraints.get('connectivity-direction', 'UNIDIRECTIONAL'),
                'capacity_unit': total_req_cap.get('unit', '<UNDEFINED>'),
                'capacity_value': total_req_cap.get('value', '<UNDEFINED>'),
            }

            for i,endpoint in enumerate(conn_svc.get('end-point', [])):
                layer_protocol_name = endpoint.get('layer-protocol-name')
                if layer_protocol_name is not None:
                    service_data['layer_protocol_name'] = layer_protocol_name

                layer_protocol_qualifier = endpoint.get('layer-protocol-qualifier')
                if layer_protocol_qualifier is not None:
                    service_data['layer_protocol_qualifier'] = layer_protocol_qualifier

                sip = endpoint['service-interface-point']['service-interface-point-uuid']
                service_data['input_sip' if i == 0 else 'output_sip'] = sip

            result.append((service_url, service_data))

    return result

def create_resource(
    base_url : str, resource_key : str, resource_value : Dict,
    auth : Optional[HTTPBasicAuth] = None, timeout : Optional[int] = None
):

    uuid = find_key(resource, 'uuid')
    input_sip = find_key(resource, 'input_sip_uuid')
    output_sip = find_key(resource, 'output_sip_uuid')
    capacity_value = find_key(resource, 'capacity_value')
    capacity_unit = find_key(resource, 'capacity_unit')
    layer_protocol_name = find_key(resource, 'layer_protocol_name')
    layer_protocol_qualifier = find_key(resource, 'layer_protocol_qualifier')
    direction = find_key(resource, 'direction')


    url = '{:s}/restconf/data/tapi-common:context/tapi-connectivity:connectivity-context'.format(base_url)
    headers = {'content-type': 'application/json'}
    data = compose_...
    results = []
    try:
        LOGGER.info('Connectivity service {:s}: {:s}'.format(str(uuid), str(data)))
        response = requests.post(
            url=url, data=json.dumps(data), timeout=timeout, headers=headers, verify=False, auth=auth)
        LOGGER.info('TAPI response: {:s}'.format(str(response)))
    except Exception as e:  # pylint: disable=broad-except
        LOGGER.exception('Exception creating ConnectivityService(uuid={:s}, data={:s})'.format(str(uuid), str(data)))
        results.append(e)
    else:
        if response.status_code not in HTTP_OK_CODES:
            msg = 'Could not create ConnectivityService(uuid={:s}, data={:s}). status_code={:s} reply={:s}'
            LOGGER.error(msg.format(str(uuid), str(data), str(response.status_code), str(response)))
        results.append(response.status_code in HTTP_OK_CODES)
    return results

def delete_resource(
    base_url : str, resource_key : str, resource_value : Dict,
    auth : Optional[HTTPBasicAuth] = None, timeout : Optional[int] = None
):
    uuid = find_key(resource_value, 'uuid')

    url = '{:s}/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={:s}'
    url = url.format(base_url, uuid)
    results = []
    try:
        response = requests.delete(url=url, timeout=timeout, verify=False, auth=auth)
    except Exception as e:  # pylint: disable=broad-except
        LOGGER.exception('Exception deleting ConnectivityService(uuid={:s})'.format(str(uuid)))
        results.append(e)
    else:
        if response.status_code not in HTTP_OK_CODES:
            msg = 'Could not delete ConnectivityService(uuid={:s}). status_code={:s} reply={:s}'
            LOGGER.error(msg.format(str(uuid), str(response.status_code), str(response)))
        results.append(response.status_code in HTTP_OK_CODES)
    return results