tripleo-common/tripleo_common/utils/plan.py
Ryan Brady e95d51f989 Fixes ordering of environment files in a deployment plan
Sometimes making changes in basic deployment breaks the order of
passed env files and leads to a failed deployment.  This patch
orders the environment files according to the rules defined in
the capabilities-map.yaml file.

Change-Id: Idbb6f0f3adebebd429bcb3447e559838180f4b1c
(cherry picked from commit bae4296502)
2018-07-12 11:26:36 -04:00

98 lines
3.1 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 yaml
from tripleo_common import constants
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(
swift.get_object(name, constants.PLAN_ENVIRONMENT)[1]
)
# 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."""
swift.put_object(
env['name'],
constants.PLAN_ENVIRONMENT,
yaml.safe_dump(env, default_flow_style=False)
)
def apply_environments_order(capabilities, environments):
"""traverses the capabilities and orders the environment files
by dependency rules defined in capabilities-map, so that parent
environments are first and children environments override these
parents
:param capabilities: dict representing capabilities-map.yaml file
:param environments: list representing the environments section of the
plan-environments.yaml file
:return: list containing ordered environments
"""
# get ordering rules from capabilities-map file
order_rules = {}
for topic in capabilities.get('topics', []):
for group in topic.get('environment_groups', []):
for environment in group.get('environments', []):
order_rules[environment['file']] = []
if 'requires' in environment:
order_rules[environment['file']] \
= environment.get('requires', [])
# apply ordering rules
for e in environments:
path = e.get('path', '')
if path not in order_rules:
continue
path_pos = environments.index(e)
for requirement in order_rules[path]:
if {'path': requirement} in environments:
requirement_pos = environments.index({'path': requirement})
if requirement_pos > path_pos:
item = environments.pop(requirement_pos)
environments.insert(path_pos, item)
return environments