aboutsummaryrefslogtreecommitdiffstats
path: root/config_binding_service/controller.py
blob: 80a932f9b3a2477870296301413ee5eef2a68547 (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
# ============LICENSE_START=======================================================
# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# 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.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.

import json
import requests
import connexion
import uuid
from flask import Response
from config_binding_service import client, exceptions
from config_binding_service import get_consul_uri
from config_binding_service.logging import audit, utc, error, metrics


def _get_helper(json_expecting_func, **kwargs):
    """
    Helper function used by several functions below
    """
    try:
        payload = json_expecting_func(**kwargs)
        response, status_code, mimetype = json.dumps(payload), 200, "application/json"
    except exceptions.BadRequest as exc:
        response, status_code, mimetype = exc.response, exc.code, "text/plain"
    except exceptions.CantGetConfig as exc:
        response, status_code, mimetype = exc.response, exc.code, "text/plain"
    except Exception:
        response, status_code, mimetype = "Unknown error", 500, "text/plain"
    return response, status_code, mimetype


def _get_or_generate_xer(raw_request):
    """get or generate the transaction id"""
    xer = raw_request.headers.get("x-onap-requestid", None)
    if xer is None:
        # some components are still using the old name
        xer = raw_request.headers.get("x-ecomp-requestid", None)
        if xer is None:
            # the user did NOT supply a request id, generate one
            xer = str(uuid.uuid4())
    return xer


def bind_all(service_component_name):
    """
    Get all the keys in Consul for this SCN, and bind the config
    """
    xer = _get_or_generate_xer(connexion.request)
    bts = utc()
    response, status_code, mimetype = _get_helper(
        client.resolve_all, service_component_name=service_component_name, raw_request=connexion.request, xer=xer
    )
    audit(connexion.request, bts, xer, status_code, __name__, "called for component {0}".format(service_component_name))
    # Even though some older components might be using the ecomp name, we return the proper one
    return Response(response=response, status=status_code, mimetype=mimetype, headers={"x-onap-requestid": xer})


def bind_config_for_scn(service_component_name):
    """
    Bind just the config for this SCN
    """
    xer = _get_or_generate_xer(connexion.request)
    bts = utc()
    response, status_code, mimetype = _get_helper(
        client.resolve, service_component_name=service_component_name, raw_request=connexion.request, xer=xer
    )
    audit(connexion.request, bts, xer, status_code, __name__, "called for component {0}".format(service_component_name))
    return Response(response=response, status=status_code, mimetype=mimetype, headers={"x-onap-requestid": xer})


def get_key(key, service_component_name):
    """
    Get a single key k of the form service_component_name:k from Consul.
    Should not be used and will return a BAD REQUEST for k=policies because it's a complex object
    """
    xer = _get_or_generate_xer(connexion.request)
    bts = utc()
    response, status_code, mimetype = _get_helper(
        client.get_key, key=key, service_component_name=service_component_name, raw_request=connexion.request, xer=xer
    )
    audit(connexion.request, bts, xer, status_code, __name__, "called for component {0}".format(service_component_name))
    return Response(response=response, status=status_code, mimetype=mimetype, headers={"x-onap-requestid": xer})


def healthcheck():
    """
    CBS Healthcheck
    """
    req = connexion.request
    xer = _get_or_generate_xer(req)
    path = "v1/catalog/service/config_binding_service"
    bts = utc()
    res = requests.get("{0}/{1}".format(get_consul_uri(), path))
    status = res.status_code
    if status == 200:
        msg = "CBS is alive and Consul connection OK"
    else:
        msg = "CBS is alive but cannot reach Consul"
        # treating this as a WARN because this could be a temporary network glitch. Also per EELF guidelines this is a 200 ecode (availability)
        error(req, xer, "WARN", 200, tgt_entity="Consul", tgt_path="/v1/catalog/service/config_binding_service", msg=msg)
    msg = ("Checking Consul connectivity during CBS healthcheck, {0}".format(msg),)
    metrics(connexion.request, bts, xer, "Consul", path, res.status_code, __name__, msg=msg)
    audit(connexion.request, bts, xer, status, __name__, msg=msg)
    return Response(response=msg, status=status)