mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-30 14:21:26 -07:00
f86345f777
* basic plugin loading working (with many hacks) * task collections working * play/block-level collection module/action working * implement PEP302 loader * implicit package support (no need for __init.py__ in collections) * provides future options for secure loading of content that shouldn't execute inside controller (eg, actively ignore __init__.py on content/module paths) * provide hook for synthetic collection setup (eg ansible.core pseudo-collection for specifying built-in plugins without legacy path, etc) * synthetic package support * ansible.core.plugins mapping works, others don't * synthetic collections working for modules/actions * fix direct-load legacy * change base package name to ansible_collections * note * collection role loading * expand paths from installed content root vars * feature complete? * rename ansible.core to ansible.builtin * and various sanity fixes * sanity tweaks * unittest fixes * less grabby error handler on has_plugin * probably need to replace with a or harden callers * fix win_ping test * disable module test with explicit file extension; might be able to support in some scenarios, but can't see any other tests that verify that behavior... * fix unicode conversion issues on py2 * attempt to keep things working-ish on py2.6 * python2.6 test fun round 2 * rename dirs/configs to "collections" * add wrapper dir for content-adjacent * fix pythoncheck to use localhost * unicode tweaks, native/bytes string prefixing * rename COLLECTION_PATHS to COLLECTIONS_PATHS * switch to pathspec * path handling cleanup * change expensive `all` back to or chain * unused import cleanup * quotes tweak * use wrapped iter/len in Jinja proxy * var name expansion * comment seemingly overcomplicated playbook_paths resolution * drop unnecessary conditional nesting * eliminate extraneous local * zap superfluous validation function * use slice for rolespec NS assembly * misc naming/unicode fixes * collection callback loader asks if valid FQ name instead of just '.' * switch collection role resolution behavior to be internally `text` as much as possible * misc fixmes * to_native in exception constructor * (slightly) detangle tuple accumulation mess in module_utils __init__ walker * more misc fixmes * tighten up action dispatch, add unqualified action test * rename Collection mixin to CollectionSearch * (attempt to) avoid potential confusion/conflict with builtin collections, etc * stale fixmes * tighten up pluginloader collections determination * sanity test fixes * ditch regex escape * clarify comment * update default collections paths config entry * use PATH format instead of list * skip integration tests on Python 2.6 ci_complete
108 lines
4.4 KiB
Python
108 lines
4.4 KiB
Python
# (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
|
|
|
|
from ansible import constants as C
|
|
from ansible.errors import AnsibleParserError
|
|
from ansible.module_utils._text import to_text, to_native
|
|
from ansible.playbook.play import Play
|
|
from ansible.playbook.playbook_include import PlaybookInclude
|
|
from ansible.utils.display import Display
|
|
|
|
display = Display()
|
|
|
|
|
|
__all__ = ['Playbook']
|
|
|
|
|
|
class Playbook:
|
|
|
|
def __init__(self, loader):
|
|
# Entries in the datastructure of a playbook may
|
|
# be either a play or an include statement
|
|
self._entries = []
|
|
self._basedir = to_text(os.getcwd(), errors='surrogate_or_strict')
|
|
self._loader = loader
|
|
self._file_name = None
|
|
|
|
@staticmethod
|
|
def load(file_name, variable_manager=None, loader=None):
|
|
pb = Playbook(loader=loader)
|
|
pb._load_playbook_data(file_name=file_name, variable_manager=variable_manager)
|
|
return pb
|
|
|
|
def _load_playbook_data(self, file_name, variable_manager, vars=None):
|
|
|
|
if os.path.isabs(file_name):
|
|
self._basedir = os.path.dirname(file_name)
|
|
else:
|
|
self._basedir = os.path.normpath(os.path.join(self._basedir, os.path.dirname(file_name)))
|
|
|
|
# set the loaders basedir
|
|
cur_basedir = self._loader.get_basedir()
|
|
self._loader.set_basedir(self._basedir)
|
|
|
|
self._file_name = file_name
|
|
|
|
try:
|
|
ds = self._loader.load_from_file(os.path.basename(file_name))
|
|
except UnicodeDecodeError as e:
|
|
raise AnsibleParserError("Could not read playbook (%s) due to encoding issues: %s" % (file_name, to_native(e)))
|
|
|
|
# check for errors and restore the basedir in case this error is caught and handled
|
|
if not ds:
|
|
self._loader.set_basedir(cur_basedir)
|
|
raise AnsibleParserError("Empty playbook, nothing to do", obj=ds)
|
|
elif not isinstance(ds, list):
|
|
self._loader.set_basedir(cur_basedir)
|
|
raise AnsibleParserError("A playbook must be a list of plays, got a %s instead" % type(ds), obj=ds)
|
|
|
|
# Parse the playbook entries. For plays, we simply parse them
|
|
# using the Play() object, and includes are parsed using the
|
|
# PlaybookInclude() object
|
|
for entry in ds:
|
|
if not isinstance(entry, dict):
|
|
# restore the basedir in case this error is caught and handled
|
|
self._loader.set_basedir(cur_basedir)
|
|
raise AnsibleParserError("playbook entries must be either a valid play or an include statement", obj=entry)
|
|
|
|
if any(action in entry for action in ('import_playbook', 'include')):
|
|
if 'include' in entry:
|
|
display.deprecated("'include' for playbook includes. You should use 'import_playbook' instead", version="2.12")
|
|
pb = PlaybookInclude.load(entry, basedir=self._basedir, variable_manager=variable_manager, loader=self._loader)
|
|
if pb is not None:
|
|
self._entries.extend(pb._entries)
|
|
else:
|
|
which = entry.get('import_playbook', entry.get('include', entry))
|
|
display.display("skipping playbook '%s' due to conditional test failure" % which, color=C.COLOR_SKIP)
|
|
else:
|
|
entry_obj = Play.load(entry, variable_manager=variable_manager, loader=self._loader, vars=vars)
|
|
self._entries.append(entry_obj)
|
|
|
|
# we're done, so restore the old basedir in the loader
|
|
self._loader.set_basedir(cur_basedir)
|
|
|
|
def get_loader(self):
|
|
return self._loader
|
|
|
|
def get_plays(self):
|
|
return self._entries[:]
|