plugins/OpenStack/common.py

# Copyright 2017 Intel Research and Development Ireland Limited
# *************************************************************

# This file is part of OSM Monitoring module
# All Rights Reserved to Intel Corporation

# 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.

# For those usages not covered by the Apache License, Version 2.0 please
# contact: helena.mcgough@intel.com or adrian.hoban@intel.com
##
"""Common methods for the OpenStack plugins."""

import logging
log = logging.getLogger(__name__)

from keystoneclient.v3 import client

from plugins.OpenStack.settings import Config

import requests

__author__ = "Helena McGough"


class Common(object):
    """Common calls for Gnocchi/Aodh plugins."""

    def __init__(self):
        """Create the common instance."""
        self._auth_token = None
        self._endpoint = None
        self._ks = None

    def _authenticate(self):
        """Authenticate and/or renew the authentication token."""
        if self._auth_token is not None:
            return self._auth_token

        try:
            cfg = Config.instance()
            self._ks = client.Client(auth_url=cfg.OS_AUTH_URL,
                                     username=cfg.OS_USERNAME,
                                     password=cfg.OS_PASSWORD,
                                     tenant_name=cfg.OS_TENANT_NAME)
            self._auth_token = self._ks.auth_token
        except Exception as exc:

            log.warn("Authentication failed: %s", exc)

            self._auth_token = None

        return self._auth_token

    def get_endpoint(self, service_type):
        """Get the endpoint for Gnocchi/Aodh."""
        try:
            return self._ks.service_catalog.url_for(
                service_type=service_type,
                endpoint_type='internalURL',
                region_name='RegionOne')
        except Exception as exc:
            log.warning("Failed to retreive endpoint for service due to: %s",
                        exc)
        return None

    @classmethod
    def _perform_request(cls, url, auth_token,
                         req_type=None, payload=None, params=None):
        """Perform the POST/PUT/GET/DELETE request."""
        # request headers
        headers = {'X-Auth-Token': auth_token,
                   'Content-type': 'application/json'}
        # perform request and return its result
        response = None
        try:
            if req_type == "put":
                response = requests.put(
                    url, data=payload, headers=headers,
                    timeout=1)
            elif req_type == "post":
                response = requests.post(
                    url, data=payload, headers=headers,
                    timeout=1)
            elif req_type == "get":
                response = requests.get(
                    url, params=params, headers=headers, timeout=1)
            elif req_type == "delete":
                response = requests.delete(
                    url, headers=headers, timeout=1)
            else:
                log.warn("Invalid request type")

        except Exception as e:
            log.warn("Exception thrown on request", e)
            if response is not None:
                log.warn("Request resulted in %s code and %s response",
                         response.status_code, response.text)

        return response