summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/pmsh_service/mod/aai_client.py
blob: 8b51a7121f49fc2ff7fd79ba7ed3eabb9d9cc614 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# ============LICENSE_START===================================================
#  Copyright (C) 2019-2020 Nordix Foundation.
# ============================================================================
# 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.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=====================================================
import json
import os
import uuid

import requests
from requests.auth import HTTPBasicAuth

import mod.pmsh_logging as logger
from mod.subscription import Subscription, XnfFilter


def get_pmsh_subscription_data(cbs_data):
    """
    Returns the PMSH subscription data

    Args:
        cbs_data: json app config from the Config Binding Service.

    Returns:
        Subscription, set(Xnf): `Subscription` <Subscription> object, set of XNFs to be added.

    Raises:
        RuntimeError: if AAI data cannot be retrieved.
    """
    aai_xnf_data = _get_all_aai_xnf_data()
    if aai_xnf_data:
        sub = Subscription(**cbs_data['policy']['subscription'])
        xnfs = _filter_xnf_data(aai_xnf_data, XnfFilter(**sub.nfFilter))
    else:
        raise RuntimeError('Failed to get data from AAI')
    return sub, xnfs


def _get_all_aai_xnf_data():
    """
    Return queried xnf data from the AAI service.

    Returns:
        json: the json response from AAI query, else None.
    """
    xnf_data = None
    try:
        session = requests.Session()
        aai_endpoint = f'{_get_aai_service_url()}{"/aai/v16/query"}'
        headers = {'accept': 'application/json',
                   'content-type': 'application/json',
                   'x-fromappid': 'dcae-pmsh',
                   'x-transactionid': str(uuid.uuid1())}
        json_data = """
                    {'start':
                        ['network/pnfs',
                        'network/generic-vnfs']
                    }"""
        params = {'format': 'simple', 'nodesOnly': 'true'}
        response = session.put(aai_endpoint, headers=headers,
                               auth=HTTPBasicAuth('AAI', 'AAI'),
                               data=json_data, params=params, verify=False)
        response.raise_for_status()
        if response.ok:
            xnf_data = json.loads(response.text)
    except Exception as e:
        logger.debug(e)
    return xnf_data


def _get_aai_service_url():
    """
    Returns the URL of the AAI kubernetes service.

    Returns:
        str: the AAI k8s service URL.

    Raises:
        KeyError: if AAI env vars not found.
    """
    try:
        aai_service = os.environ['AAI_SERVICE_HOST']
        aai_ssl_port = os.environ['AAI_SERVICE_PORT_AAI_SSL']
        return f'https://{aai_service}:{aai_ssl_port}'
    except KeyError as e:
        logger.debug(f'Failed to get AAI env vars: {e}')
        raise


def _filter_xnf_data(xnf_data, xnf_filter):
    """
    Returns a list of filtered xnfs using the xnf_filter .

    Args:
        xnf_data: the xnf json data from AAI.
        xnf_filter: the `XnfFilter <XnfFilter>` to be applied.

    Returns:
        set: a set of filtered xnfs.

    Raises:
        KeyError: if AAI data cannot be parsed.
    """
    xnf_set = set()
    try:
        for xnf in xnf_data['results']:
            name_identifier = 'pnf-name' if xnf['node-type'] == 'pnf' else 'vnf-name'
            if xnf_filter.is_xnf_in_filter(xnf['properties'].get(name_identifier)):
                xnf_set.add(Xnf(xnf_name=xnf['properties'].get('name_identifier'),
                                orchestration_status=xnf['properties'].get('orchestration-status')))
    except KeyError as e:
        logger.debug(f'Failed to parse AAI data: {e}')
        raise
    return xnf_set


class Xnf:
    def __init__(self, **kwargs):
        """
        Object representation of the XNF.
        """
        self.xnf_name = kwargs.get('xnf_name')
        self.orchestration_status = kwargs.get('orchestration_status')

    @classmethod
    def xnf_def(cls):
        return cls(xnf_name=None, orchestration_status=None)

    def __str__(self):
        return f'xnf-name: {self.xnf_name}, orchestration-status: {self.orchestration_status}'