armada/armada/common/client.py

165 lines
5.3 KiB
Python

# Copyright 2017 The Armada Authors.
#
# 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 yaml
from oslo_config import cfg
from oslo_log import log as logging
from armada.exceptions import api_exceptions as err
from armada.handlers.armada import Override
LOG = logging.getLogger(__name__)
CONF = cfg.CONF
API_VERSION = 'v{}/{}'
class ArmadaClient(object):
def __init__(self, session):
self.session = session
def _set_endpoint(self, version, action):
return API_VERSION.format(version, action)
def get_status(self, query, timeout=None):
endpoint = self._set_endpoint('1.0', 'status')
resp = self.session.get(endpoint, query=query, timeout=timeout)
self._check_response(resp)
return resp.json()
def get_releases(self, query, timeout=None):
endpoint = self._set_endpoint('1.0', 'releases')
resp = self.session.get(endpoint, query=query, timeout=timeout)
self._check_response(resp)
return resp.json()
def post_validate(self, manifest=None, timeout=None):
endpoint = self._set_endpoint('1.0', 'validatedesign')
# TODO(sh8121att) Look to update the UCP convention to
# allow a list of hrefs
req_body = {'href': manifest}
resp = self.session.post(
endpoint,
data=req_body,
headers={'content-type': 'application/json'},
timeout=timeout)
self._check_response(resp)
return resp.json()
def post_apply(self,
manifest=None,
manifest_ref=None,
values=None,
set=None,
query=None,
timeout=None):
"""Call the Armada API to apply a Manifest.
If ``manifest`` is not None, then the request body will be a fully
rendered set of YAML documents including overrides and
values-files application.
If ``manifest`` is None and ``manifest_ref`` is not, then the request
body will be a JSON structure providing a list of references
to Armada manifest documents and a list of overrides. Local
values files are not supported when using the API with references.
:param manifest: string of YAML formatted Armada manifests
:param manifest_ref: valid file paths or URIs referring to Armada
manifests
:param values: list of local files containing values.yaml overrides
:param set: list of single-value overrides
:param query: explicit query string parameters
:param timeout: a tuple of connect, read timeout (x, y)
"""
endpoint = self._set_endpoint('1.0', 'apply')
if manifest:
if values or set:
override = Override(
manifest, overrides=set, values=values).update_manifests()
manifest = yaml.dump(override)
resp = self.session.post(
endpoint,
body=manifest,
query=query,
headers={'content-type': 'application/x-yaml'},
timeout=timeout)
elif manifest_ref:
req_body = {
'hrefs': manifest_ref,
'overrides': set or [],
}
resp = self.session.post(
endpoint,
data=req_body,
query=query,
headers={'content-type': 'application/json'},
timeout=timeout)
self._check_response(resp)
return resp.json()
def post_rollback_release(self, release, query=None, timeout=None):
endpoint = self._set_endpoint('1.0', 'rollback/{}'.format(release))
resp = self.session.get(endpoint, query=query, timeout=timeout)
self._check_response(resp)
return resp.json()
def get_test_release(self, release=None, query=None, timeout=None):
endpoint = self._set_endpoint('1.0', 'test/{}'.format(release))
resp = self.session.get(endpoint, query=query, timeout=timeout)
self._check_response(resp)
return resp.json()
def post_test_manifest(self, manifest=None, query=None, timeout=None):
endpoint = self._set_endpoint('1.0', 'tests')
resp = self.session.post(
endpoint, body=manifest, query=query, timeout=timeout)
self._check_response(resp)
return resp.json()
def _check_response(self, resp):
if resp.status_code == 401:
raise err.ClientUnauthorizedError(
"Unauthorized access to %s, include valid token.".format(
resp.url))
elif resp.status_code == 403:
raise err.ClientForbiddenError("Forbidden access to %s" % resp.url)
elif not resp.ok:
raise err.ClientError(
"Error - received %d: %s" % (resp.status_code, resp.text))