diff options
Diffstat (limited to 'lib/ansible/playbook/playbook_include.py')
-rw-r--r-- | lib/ansible/playbook/playbook_include.py | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/lib/ansible/playbook/playbook_include.py b/lib/ansible/playbook/playbook_include.py new file mode 100644 index 0000000..03210ea --- /dev/null +++ b/lib/ansible/playbook/playbook_include.py @@ -0,0 +1,171 @@ +# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com> +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see <http://www.gnu.org/licenses/>. + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os + +import ansible.constants as C +from ansible.errors import AnsibleParserError, AnsibleAssertionError +from ansible.module_utils._text import to_bytes +from ansible.module_utils.six import string_types +from ansible.parsing.splitter import split_args, parse_kv +from ansible.parsing.yaml.objects import AnsibleBaseYAMLObject, AnsibleMapping +from ansible.playbook.attribute import FieldAttribute +from ansible.playbook.base import Base +from ansible.playbook.conditional import Conditional +from ansible.playbook.taggable import Taggable +from ansible.utils.collection_loader import AnsibleCollectionConfig +from ansible.utils.collection_loader._collection_finder import _get_collection_name_from_path, _get_collection_playbook_path +from ansible.template import Templar +from ansible.utils.display import Display + +display = Display() + + +class PlaybookInclude(Base, Conditional, Taggable): + + import_playbook = FieldAttribute(isa='string') + vars_val = FieldAttribute(isa='dict', default=dict, alias='vars') + + @staticmethod + def load(data, basedir, variable_manager=None, loader=None): + return PlaybookInclude().load_data(ds=data, basedir=basedir, variable_manager=variable_manager, loader=loader) + + def load_data(self, ds, basedir, variable_manager=None, loader=None): + ''' + Overrides the base load_data(), as we're actually going to return a new + Playbook() object rather than a PlaybookInclude object + ''' + + # import here to avoid a dependency loop + from ansible.playbook import Playbook + from ansible.playbook.play import Play + + # first, we use the original parent method to correctly load the object + # via the load_data/preprocess_data system we normally use for other + # playbook objects + new_obj = super(PlaybookInclude, self).load_data(ds, variable_manager, loader) + + all_vars = self.vars.copy() + if variable_manager: + all_vars |= variable_manager.get_vars() + + templar = Templar(loader=loader, variables=all_vars) + + # then we use the object to load a Playbook + pb = Playbook(loader=loader) + + file_name = templar.template(new_obj.import_playbook) + + # check for FQCN + resource = _get_collection_playbook_path(file_name) + if resource is not None: + playbook = resource[1] + playbook_collection = resource[2] + else: + # not FQCN try path + playbook = file_name + if not os.path.isabs(playbook): + playbook = os.path.join(basedir, playbook) + + # might still be collection playbook + playbook_collection = _get_collection_name_from_path(playbook) + + if playbook_collection: + # it is a collection playbook, setup default collections + AnsibleCollectionConfig.default_collection = playbook_collection + else: + # it is NOT a collection playbook, setup adjecent paths + AnsibleCollectionConfig.playbook_paths.append(os.path.dirname(os.path.abspath(to_bytes(playbook, errors='surrogate_or_strict')))) + + pb._load_playbook_data(file_name=playbook, variable_manager=variable_manager, vars=self.vars.copy()) + + # finally, update each loaded playbook entry with any variables specified + # on the included playbook and/or any tags which may have been set + for entry in pb._entries: + + # conditional includes on a playbook need a marker to skip gathering + if new_obj.when and isinstance(entry, Play): + entry._included_conditional = new_obj.when[:] + + temp_vars = entry.vars | new_obj.vars + param_tags = temp_vars.pop('tags', None) + if param_tags is not None: + entry.tags.extend(param_tags.split(',')) + entry.vars = temp_vars + entry.tags = list(set(entry.tags).union(new_obj.tags)) + if entry._included_path is None: + entry._included_path = os.path.dirname(playbook) + + # Check to see if we need to forward the conditionals on to the included + # plays. If so, we can take a shortcut here and simply prepend them to + # those attached to each block (if any) + if new_obj.when: + for task_block in (entry.pre_tasks + entry.roles + entry.tasks + entry.post_tasks): + task_block._when = new_obj.when[:] + task_block.when[:] + + return pb + + def preprocess_data(self, ds): + ''' + Regorganizes the data for a PlaybookInclude datastructure to line + up with what we expect the proper attributes to be + ''' + + if not isinstance(ds, dict): + raise AnsibleAssertionError('ds (%s) should be a dict but was a %s' % (ds, type(ds))) + + # the new, cleaned datastructure, which will have legacy + # items reduced to a standard structure + new_ds = AnsibleMapping() + if isinstance(ds, AnsibleBaseYAMLObject): + new_ds.ansible_pos = ds.ansible_pos + + for (k, v) in ds.items(): + if k in C._ACTION_IMPORT_PLAYBOOK: + self._preprocess_import(ds, new_ds, k, v) + else: + # some basic error checking, to make sure vars are properly + # formatted and do not conflict with k=v parameters + if k == 'vars': + if 'vars' in new_ds: + raise AnsibleParserError("import_playbook parameters cannot be mixed with 'vars' entries for import statements", obj=ds) + elif not isinstance(v, dict): + raise AnsibleParserError("vars for import_playbook statements must be specified as a dictionary", obj=ds) + new_ds[k] = v + + return super(PlaybookInclude, self).preprocess_data(new_ds) + + def _preprocess_import(self, ds, new_ds, k, v): + ''' + Splits the playbook import line up into filename and parameters + ''' + if v is None: + raise AnsibleParserError("playbook import parameter is missing", obj=ds) + elif not isinstance(v, string_types): + raise AnsibleParserError("playbook import parameter must be a string indicating a file path, got %s instead" % type(v), obj=ds) + + # The import_playbook line must include at least one item, which is the filename + # to import. Anything after that should be regarded as a parameter to the import + items = split_args(v) + if len(items) == 0: + raise AnsibleParserError("import_playbook statements must specify the file name to import", obj=ds) + + new_ds['import_playbook'] = items[0].strip() |