mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
445ff39f94
* [WIP] become plugins
Move from hardcoded method to plugins for ease of use, expansion and overrides
- load into connection as it is going to be the main consumer
- play_context will also use to keep backwards compat API
- ensure shell is used to construct commands when needed
- migrate settings remove from base config in favor of plugin specific configs
- cleanup ansible-doc
- add become plugin docs
- remove deprecated sudo/su code and keywords
- adjust become options for cli
- set plugin options from context
- ensure config defs are avaialbe before instance
- refactored getting the shell plugin, fixed tests
- changed into regex as they were string matching, which does not work with random string generation
- explicitly set flags for play context tests
- moved plugin loading up front
- now loads for basedir also
- allow pyc/o for non m modules
- fixes to tests and some plugins
- migrate to play objects fro play_context
- simiplify gathering
- added utf8 headers
- moved option setting
- add fail msg to dzdo
- use tuple for multiple options on fail/missing
- fix relative plugin paths
- shift from play context to play
- all tasks already inherit this from play directly
- remove obsolete 'set play'
- correct environment handling
- add wrap_exe option to pfexec
- fix runas to noop
- fixed setting play context
- added password configs
- removed required false
- remove from doc building till they are ready
future development:
- deal with 'enable' and 'runas' which are not 'command wrappers' but 'state flags' and currently hardcoded in diff subsystems
* cleanup
remove callers to removed func
removed --sudo cli doc refs
remove runas become_exe
ensure keyerorr on plugin
also fix backwards compat, missing method is attributeerror, not ansible error
get remote_user consistently
ignore missing system_tmpdirs on plugin load
correct config precedence
add deprecation
fix networking imports
backwards compat for plugins using BECOME_METHODS
* Port become_plugins to context.CLIARGS
This is a work in progress:
* Stop passing options around everywhere as we can use context.CLIARGS
instead
* Refactor make_become_commands as asked for by alikins
* Typo in comment fix
* Stop loading values from the cli in more than one place
Both play and play_context were saving default values from the cli
arguments directly. This changes things so that the default values are
loaded into the play and then play_context takes them from there.
* Rename BECOME_PLUGIN_PATH to DEFAULT_BECOME_PLUGIN_PATH
As alikins said, all other plugin paths are named
DEFAULT_plugintype_PLUGIN_PATH. If we're going to rename these, that
should be done all at one time rather than piecemeal.
* One to throw away
This is a set of hacks to get setting FieldAttribute defaults to command
line args to work. It's not fully done yet.
After talking it over with sivel and jimi-c this should be done by
fixing FieldAttributeBase and _get_parent_attribute() calls to do the
right thing when there is a non-None default.
What we want to be able to do ideally is something like this:
class Base(FieldAttributeBase):
_check_mode = FieldAttribute([..] default=lambda: context.CLIARGS['check'])
class Play(Base):
# lambda so that we have a chance to parse the command line args
# before we get here. In the future we might be able to restructure
# this so that the cli parsing code runs before these classes are
# defined.
class Task(Base):
pass
And still have a playbook like this function:
---
- hosts:
tasks:
- command: whoami
check_mode: True
(The check_mode test that is added as a separate commit in this PR will
let you test variations on this case).
There's a few separate reasons that the code doesn't let us do this or
a non-ugly workaround for this as written right now. The fix that
jimi-c, sivel, and I talked about may let us do this or it may still
require a workaround (but less ugly) (having one class that has the
FieldAttributes with default values and one class that inherits from
that but just overrides the FieldAttributes which now have defaults)
* Revert "One to throw away"
This reverts commit 23aa883cbed11429ef1be2a2d0ed18f83a3b8064.
* Set FieldAttr defaults directly from CLIARGS
* Remove dead code
* Move timeout directly to PlayContext, it's never needed on Play
* just for backwards compat, add a static version of BECOME_METHODS to constants
* Make the become attr on the connection public, since it's used outside of the connection
* Logic fix
* Nuke connection testing if it supports specific become methods
* Remove unused vars
* Address rebase issues
* Fix path encoding issue
* Remove unused import
* Various cleanups
* Restore network_cli check in _low_level_execute_command
* type improvements for cliargs_deferred_get and swap shallowcopy to default to False
* minor cleanups
* Allow the su plugin to work, since it doesn't define a prompt the same way
* Fix up ksu become plugin
* Only set prompt if build_become_command was called
* Add helper to assist connection plugins in knowing they need to wait for a prompt
* Fix tests and code expectations
* Doc updates
* Various additional minor cleanups
* Make doas functional
* Don't change connection signature, load become plugin from TaskExecutor
* Remove unused imports
* Add comment about setting the become plugin on the playcontext
* Fix up tests for recent changes
* Support 'Password:' natively for the doas plugin
* Make default prompts raw
* wording cleanups. ci_complete
* Remove unrelated changes
* Address spelling mistake
* Restore removed test, and udpate to use new functionality
* Add changelog fragment
* Don't hard fail in set_attributes_from_cli on missing CLI keys
* Remove unrelated change to loader
* Remove internal deprecated FieldAttributes now
* Emit deprecation warnings now
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_bytes, 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[:]
|