255 lines
7.6 KiB
Python
255 lines
7.6 KiB
Python
# Copyright 2017 Red Hat, Inc.
|
|
# 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.
|
|
|
|
import json
|
|
import os
|
|
import requests
|
|
import tempfile
|
|
import yaml
|
|
import zlib
|
|
|
|
from heatclient.common import template_utils
|
|
from swiftclient import exceptions as swiftexceptions
|
|
|
|
from tripleo_common import constants
|
|
from tripleo_common.utils import swift as swiftutils
|
|
|
|
|
|
def update_in_env(swift, env, key, value='', delete_key=False):
|
|
"""Update plan environment."""
|
|
if delete_key:
|
|
try:
|
|
del env[key]
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
try:
|
|
env[key].update(value)
|
|
except (KeyError, AttributeError):
|
|
env[key] = value
|
|
|
|
put_env(swift, env)
|
|
return env
|
|
|
|
|
|
def get_env(swift, name):
|
|
"""Get plan environment from Swift and convert it to a dictionary."""
|
|
env = yaml.safe_load(
|
|
swiftutils.get_object_string(swift, name, constants.PLAN_ENVIRONMENT)
|
|
)
|
|
|
|
# Ensure the name is correct, as it will be used to update the
|
|
# container later
|
|
if env.get('name') != name:
|
|
env['name'] = name
|
|
|
|
return env
|
|
|
|
|
|
def put_env(swift, env):
|
|
"""Convert given environment to yaml and upload it to Swift."""
|
|
swiftutils.put_object_string(
|
|
swift,
|
|
env['name'],
|
|
constants.PLAN_ENVIRONMENT,
|
|
yaml.safe_dump(env, default_flow_style=False)
|
|
)
|
|
|
|
|
|
def get_user_env(swift, container_name):
|
|
"""Get user environment from Swift convert it to a dictionary."""
|
|
return yaml.safe_load(
|
|
swiftutils.get_object_string(swift, container_name,
|
|
constants.USER_ENVIRONMENT))
|
|
|
|
|
|
def put_user_env(swift, container_name, env):
|
|
"""Convert given user environment to yaml and upload it to Swift."""
|
|
swiftutils.put_object_string(
|
|
swift,
|
|
container_name,
|
|
constants.USER_ENVIRONMENT,
|
|
yaml.safe_dump(env, default_flow_style=False)
|
|
)
|
|
|
|
|
|
def write_json_temp_file(data):
|
|
"""Writes the provided data to a json file and return the filename"""
|
|
with tempfile.NamedTemporaryFile(delete=False, mode='wb') as temp_file:
|
|
temp_file.write(json.dumps(data).encode('utf-8'))
|
|
return temp_file.name
|
|
|
|
|
|
def object_request(method, url, token):
|
|
"""Fetch an object with the provided token"""
|
|
response = requests.request(
|
|
method, url, headers={'X-Auth-Token': token})
|
|
response.raise_for_status()
|
|
return response.content
|
|
|
|
|
|
def process_environments_and_files(swift, env_paths):
|
|
"""Wrap process_multiple_environments_and_files with swift object fetch"""
|
|
def _env_path_is_object(env_path):
|
|
return env_path.startswith(swift.url)
|
|
|
|
# XXX this should belong in heatclient, but for the time being and backport
|
|
# purposes, let's do that here for now.
|
|
_cache = {}
|
|
|
|
def _object_request(method, url, token=swift.token):
|
|
if url not in _cache:
|
|
_cache[url] = object_request(method, url, token)
|
|
return _cache[url]
|
|
|
|
return template_utils.process_multiple_environments_and_files(
|
|
env_paths=env_paths,
|
|
env_path_is_object=_env_path_is_object,
|
|
object_request=_object_request)
|
|
|
|
|
|
def get_template_contents(swift, template_object):
|
|
"""Wrap get_template_contents with swift object fetch"""
|
|
def _object_request(method, url, token=swift.token):
|
|
return object_request(method, url, token)
|
|
|
|
return template_utils.get_template_contents(
|
|
template_object=template_object,
|
|
object_request=_object_request)
|
|
|
|
|
|
def build_env_paths(swift, container, plan_env):
|
|
environments = plan_env.get('environments', [])
|
|
env_paths = []
|
|
temp_env_paths = []
|
|
|
|
for env in environments:
|
|
if env.get('path'):
|
|
env_paths.append(os.path.join(swift.url, container, env['path']))
|
|
elif env.get('data'):
|
|
env_file = write_json_temp_file(env['data'])
|
|
temp_env_paths.append(env_file)
|
|
|
|
# create a dict to hold all user set params and merge
|
|
# them in the appropriate order
|
|
merged_params = {}
|
|
# merge generated passwords into params first
|
|
passwords = plan_env.get('passwords', {})
|
|
merged_params.update(passwords)
|
|
|
|
# derived parameters are merged before 'parameter defaults'
|
|
# so that user-specified values can override the derived values.
|
|
derived_params = plan_env.get('derived_parameters', {})
|
|
merged_params.update(derived_params)
|
|
|
|
# handle user set parameter values next in case a user has set
|
|
# a new value for a password parameter
|
|
params = plan_env.get('parameter_defaults', {})
|
|
merged_params = template_utils.deep_update(merged_params, params)
|
|
|
|
if merged_params:
|
|
env_temp_file = write_json_temp_file(
|
|
{'parameter_defaults': merged_params})
|
|
temp_env_paths.append(env_temp_file)
|
|
|
|
registry = plan_env.get('resource_registry', {})
|
|
if registry:
|
|
env_temp_file = write_json_temp_file(
|
|
{'resource_registry': registry})
|
|
temp_env_paths.append(env_temp_file)
|
|
|
|
env_paths.extend(temp_env_paths)
|
|
return env_paths, temp_env_paths
|
|
|
|
|
|
def format_cache_key(plan_name, key_name):
|
|
return "__cache_{}_{}".format(plan_name, key_name)
|
|
|
|
|
|
def cache_get(swift, plan_name, key):
|
|
"""Retrieves the stored objects
|
|
|
|
Returns None if there are any issues or no objects found
|
|
|
|
"""
|
|
|
|
try:
|
|
headers, body = swift.get_object(
|
|
constants.TRIPLEO_CACHE_CONTAINER,
|
|
format_cache_key(plan_name, key)
|
|
)
|
|
result = json.loads(zlib.decompress(body).decode())
|
|
return result
|
|
except swiftexceptions.ClientException:
|
|
# cache does not exist, ignore
|
|
pass
|
|
except ValueError:
|
|
# the stored json is invalid. Deleting
|
|
cache_delete(swift, plan_name, key)
|
|
return None
|
|
|
|
|
|
def cache_set(swift, plan_name, key, contents):
|
|
"""Stores an object
|
|
|
|
Allows the storage of jsonable objects except for None
|
|
Storing None equals to a cache delete.
|
|
|
|
"""
|
|
|
|
if contents is None:
|
|
cache_delete(swift, plan_name, key)
|
|
return
|
|
|
|
try:
|
|
swift.head_container(constants.TRIPLEO_CACHE_CONTAINER)
|
|
except swiftexceptions.ClientException:
|
|
swift.put_container(constants.TRIPLEO_CACHE_CONTAINER)
|
|
|
|
swift.put_object(
|
|
constants.TRIPLEO_CACHE_CONTAINER,
|
|
format_cache_key(plan_name, key),
|
|
zlib.compress(json.dumps(contents).encode()))
|
|
|
|
|
|
def cache_delete(swift, plan_name, key):
|
|
try:
|
|
swift.delete_object(
|
|
constants.TRIPLEO_CACHE_CONTAINER,
|
|
format_cache_key(plan_name, key))
|
|
except swiftexceptions.ClientException:
|
|
# cache or container does not exist. Ignore
|
|
pass
|
|
|
|
|
|
def update_plan_environment(swift, environments,
|
|
container=constants.DEFAULT_CONTAINER_NAME):
|
|
env = get_env(swift, container)
|
|
for k, v in environments.items():
|
|
found = False
|
|
if {'path': k} in env['environments']:
|
|
found = True
|
|
if v:
|
|
if not found:
|
|
env['environments'].append({'path': k})
|
|
else:
|
|
if found:
|
|
env['environments'].remove({'path': k})
|
|
|
|
cache_delete(swift, container, "tripleo.parameters.get")
|
|
put_env(swift, env)
|
|
return env
|