|
|
|
# (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/>.
|
|
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
|
|
from ansible import constants as C
|
Become plugins (#50991)
* [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
5 years ago
|
|
|
from ansible import context
|
|
|
|
from ansible.errors import AnsibleParserError, AnsibleAssertionError
|
|
|
|
from ansible.module_utils.common.text.converters import to_native
|
|
|
|
from ansible.module_utils.common.collections import is_sequence
|
|
|
|
from ansible.module_utils.six import binary_type, string_types, text_type
|
|
|
|
from ansible.playbook.attribute import NonInheritableFieldAttribute
|
|
|
|
from ansible.playbook.base import Base
|
|
|
|
from ansible.playbook.block import Block
|
|
|
|
from ansible.playbook.collectionsearch import CollectionSearch
|
|
|
|
from ansible.playbook.helpers import load_list_of_blocks, load_list_of_roles
|
|
|
|
from ansible.playbook.role import Role
|
|
|
|
from ansible.playbook.task import Task
|
|
|
|
from ansible.playbook.taggable import Taggable
|
|
|
|
from ansible.vars.manager import preprocess_vars
|
|
|
|
from ansible.utils.display import Display
|
|
|
|
|
|
|
|
display = Display()
|
|
|
|
|
|
|
|
|
|
|
|
__all__ = ['Play']
|
|
|
|
|
|
|
|
|
|
|
|
class Play(Base, Taggable, CollectionSearch):
|
|
|
|
|
|
|
|
"""
|
|
|
|
A play is a language feature that represents a list of roles and/or
|
|
|
|
task/handler blocks to execute on a given set of hosts.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
|
|
|
Play.load(datastructure) -> Play
|
|
|
|
Play.something(...)
|
|
|
|
"""
|
|
|
|
|
|
|
|
# =================================================================================
|
|
|
|
hosts = NonInheritableFieldAttribute(isa='list', required=True, listof=string_types, always_post_validate=True, priority=-2)
|
|
|
|
|
|
|
|
# Facts
|
|
|
|
gather_facts = NonInheritableFieldAttribute(isa='bool', default=None, always_post_validate=True)
|
|
|
|
gather_subset = NonInheritableFieldAttribute(isa='list', default=None, listof=string_types, always_post_validate=True)
|
|
|
|
gather_timeout = NonInheritableFieldAttribute(isa='int', default=None, always_post_validate=True)
|
|
|
|
fact_path = NonInheritableFieldAttribute(isa='string', default=None)
|
|
|
|
|
|
|
|
# Variable Attributes
|
|
|
|
vars_files = NonInheritableFieldAttribute(isa='list', default=list, priority=99)
|
|
|
|
vars_prompt = NonInheritableFieldAttribute(isa='list', default=list, always_post_validate=False)
|
|
|
|
|
|
|
|
# Role Attributes
|
|
|
|
roles = NonInheritableFieldAttribute(isa='list', default=list, priority=90)
|
|
|
|
|
|
|
|
# Block (Task) Lists Attributes
|
|
|
|
handlers = NonInheritableFieldAttribute(isa='list', default=list, priority=-1)
|
|
|
|
pre_tasks = NonInheritableFieldAttribute(isa='list', default=list, priority=-1)
|
|
|
|
post_tasks = NonInheritableFieldAttribute(isa='list', default=list, priority=-1)
|
|
|
|
tasks = NonInheritableFieldAttribute(isa='list', default=list, priority=-1)
|
|
|
|
|
|
|
|
# Flag/Setting Attributes
|
|
|
|
force_handlers = NonInheritableFieldAttribute(isa='bool', default=context.cliargs_deferred_get('force_handlers'), always_post_validate=True)
|
|
|
|
max_fail_percentage = NonInheritableFieldAttribute(isa='percent', always_post_validate=True)
|
|
|
|
serial = NonInheritableFieldAttribute(isa='list', default=list, always_post_validate=True)
|
|
|
|
strategy = NonInheritableFieldAttribute(isa='string', default=C.DEFAULT_STRATEGY, always_post_validate=True)
|
|
|
|
order = NonInheritableFieldAttribute(isa='string', always_post_validate=True)
|
|
|
|
|
|
|
|
# =================================================================================
|
|
|
|
|
|
|
|
def __init__(self):
|
|
|
|
super(Play, self).__init__()
|
|
|
|
|
|
|
|
self._included_conditional = None
|
|
|
|
self._included_path = None
|
|
|
|
self._removed_hosts = []
|
|
|
|
self.role_cache = {}
|
|
|
|
|
Become plugins (#50991)
* [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
5 years ago
|
|
|
self.only_tags = set(context.CLIARGS.get('tags', [])) or frozenset(('all',))
|
|
|
|
self.skip_tags = set(context.CLIARGS.get('skip_tags', []))
|
|
|
|
|
|
|
|
self._action_groups = {}
|
|
|
|
self._group_actions = {}
|
|
|
|
|
|
|
|
def __repr__(self):
|
|
|
|
return self.get_name()
|
|
|
|
|
|
|
|
def _validate_hosts(self, attribute, name, value):
|
|
|
|
# Only validate 'hosts' if a value was passed in to original data set.
|
|
|
|
if 'hosts' in self._ds:
|
|
|
|
if not value:
|
|
|
|
raise AnsibleParserError("Hosts list cannot be empty. Please check your playbook")
|
|
|
|
|
|
|
|
if is_sequence(value):
|
|
|
|
# Make sure each item in the sequence is a valid string
|
|
|
|
for entry in value:
|
|
|
|
if entry is None:
|
|
|
|
raise AnsibleParserError("Hosts list cannot contain values of 'None'. Please check your playbook")
|
|
|
|
elif not isinstance(entry, (binary_type, text_type)):
|
|
|
|
raise AnsibleParserError("Hosts list contains an invalid host value: '{host!s}'".format(host=entry))
|
|
|
|
|
|
|
|
elif not isinstance(value, (binary_type, text_type)):
|
|
|
|
raise AnsibleParserError("Hosts list must be a sequence or string. Please check your playbook.")
|
|
|
|
|
|
|
|
def get_name(self):
|
|
|
|
''' return the name of the Play '''
|
|
|
|
if self.name:
|
|
|
|
return self.name
|
|
|
|
|
|
|
|
if is_sequence(self.hosts):
|
|
|
|
self.name = ','.join(self.hosts)
|
|
|
|
else:
|
|
|
|
self.name = self.hosts or ''
|
|
|
|
|
|
|
|
return self.name
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def load(data, variable_manager=None, loader=None, vars=None):
|
|
|
|
p = Play()
|
|
|
|
if vars:
|
|
|
|
p.vars = vars.copy()
|
|
|
|
return p.load_data(data, variable_manager=variable_manager, loader=loader)
|
|
|
|
|
|
|
|
def preprocess_data(self, ds):
|
|
|
|
'''
|
|
|
|
Adjusts play datastructure to cleanup old/legacy items
|
|
|
|
'''
|
|
|
|
|
|
|
|
if not isinstance(ds, dict):
|
|
|
|
raise AnsibleAssertionError('while preprocessing data (%s), ds should be a dict but was a %s' % (ds, type(ds)))
|
|
|
|
|
|
|
|
# The use of 'user' in the Play datastructure was deprecated to
|
|
|
|
# line up with the same change for Tasks, due to the fact that
|
|
|
|
# 'user' conflicted with the user module.
|
|
|
|
if 'user' in ds:
|
|
|
|
# this should never happen, but error out with a helpful message
|
|
|
|
# to the user if it does...
|
|
|
|
if 'remote_user' in ds:
|
|
|
|
raise AnsibleParserError("both 'user' and 'remote_user' are set for this play. "
|
|
|
|
"The use of 'user' is deprecated, and should be removed", obj=ds)
|
|
|
|
|
|
|
|
ds['remote_user'] = ds['user']
|
|
|
|
del ds['user']
|
|
|
|
|
|
|
|
return super(Play, self).preprocess_data(ds)
|
|
|
|
|
|
|
|
def _load_tasks(self, attr, ds):
|
|
|
|
'''
|
|
|
|
Loads a list of blocks from a list which may be mixed tasks/blocks.
|
|
|
|
Bare tasks outside of a block are given an implicit block.
|
|
|
|
'''
|
|
|
|
try:
|
|
|
|
return load_list_of_blocks(ds=ds, play=self, variable_manager=self._variable_manager, loader=self._loader)
|
|
|
|
except AssertionError as e:
|
|
|
|
raise AnsibleParserError("A malformed block was encountered while loading tasks: %s" % to_native(e), obj=self._ds, orig_exc=e)
|
|
|
|
|
|
|
|
def _load_pre_tasks(self, attr, ds):
|
|
|
|
'''
|
|
|
|
Loads a list of blocks from a list which may be mixed tasks/blocks.
|
|
|
|
Bare tasks outside of a block are given an implicit block.
|
|
|
|
'''
|
|
|
|
try:
|
|
|
|
return load_list_of_blocks(ds=ds, play=self, variable_manager=self._variable_manager, loader=self._loader)
|
|
|
|
except AssertionError as e:
|
|
|
|
raise AnsibleParserError("A malformed block was encountered while loading pre_tasks", obj=self._ds, orig_exc=e)
|
|
|
|
|
|
|
|
def _load_post_tasks(self, attr, ds):
|
|
|
|
'''
|
|
|
|
Loads a list of blocks from a list which may be mixed tasks/blocks.
|
|
|
|
Bare tasks outside of a block are given an implicit block.
|
|
|
|
'''
|
|
|
|
try:
|
|
|
|
return load_list_of_blocks(ds=ds, play=self, variable_manager=self._variable_manager, loader=self._loader)
|
|
|
|
except AssertionError as e:
|
|
|
|
raise AnsibleParserError("A malformed block was encountered while loading post_tasks", obj=self._ds, orig_exc=e)
|
|
|
|
|
|
|
|
def _load_handlers(self, attr, ds):
|
|
|
|
'''
|
|
|
|
Loads a list of blocks from a list which may be mixed handlers/blocks.
|
|
|
|
Bare handlers outside of a block are given an implicit block.
|
|
|
|
'''
|
|
|
|
try:
|
|
|
|
return self._extend_value(
|
|
|
|
self.handlers,
|
|
|
|
load_list_of_blocks(ds=ds, play=self, use_handlers=True, variable_manager=self._variable_manager, loader=self._loader),
|
|
|
|
prepend=True
|
|
|
|
)
|
|
|
|
except AssertionError as e:
|
|
|
|
raise AnsibleParserError("A malformed block was encountered while loading handlers", obj=self._ds, orig_exc=e)
|
|
|
|
|
|
|
|
def _load_roles(self, attr, ds):
|
|
|
|
'''
|
|
|
|
Loads and returns a list of RoleInclude objects from the datastructure
|
|
|
|
list of role definitions and creates the Role from those objects
|
|
|
|
'''
|
|
|
|
|
|
|
|
if ds is None:
|
|
|
|
ds = []
|
|
|
|
|
|
|
|
try:
|
|
|
|
role_includes = load_list_of_roles(ds, play=self, variable_manager=self._variable_manager,
|
|
|
|
loader=self._loader, collection_search_list=self.collections)
|
|
|
|
except AssertionError as e:
|
|
|
|
raise AnsibleParserError("A malformed role declaration was encountered.", obj=self._ds, orig_exc=e)
|
|
|
|
|
|
|
|
roles = []
|
|
|
|
for ri in role_includes:
|
|
|
|
roles.append(Role.load(ri, play=self))
|
|
|
|
|
|
|
|
self.roles[:0] = roles
|
|
|
|
|
|
|
|
return self.roles
|
|
|
|
|
|
|
|
def _load_vars_prompt(self, attr, ds):
|
|
|
|
new_ds = preprocess_vars(ds)
|
|
|
|
vars_prompts = []
|
|
|
|
if new_ds is not None:
|
|
|
|
for prompt_data in new_ds:
|
|
|
|
if 'name' not in prompt_data:
|
|
|
|
raise AnsibleParserError("Invalid vars_prompt data structure, missing 'name' key", obj=ds)
|
|
|
|
for key in prompt_data:
|
|
|
|
if key not in ('name', 'prompt', 'default', 'private', 'confirm', 'encrypt', 'salt_size', 'salt', 'unsafe'):
|
|
|
|
raise AnsibleParserError("Invalid vars_prompt data structure, found unsupported key '%s'" % key, obj=ds)
|
|
|
|
vars_prompts.append(prompt_data)
|
|
|
|
return vars_prompts
|
|
|
|
|
|
|
|
def _compile_roles(self):
|
|
|
|
'''
|
|
|
|
Handles the role compilation step, returning a flat list of tasks
|
|
|
|
with the lowest level dependencies first. For example, if a role R
|
|
|
|
has a dependency D1, which also has a dependency D2, the tasks from
|
|
|
|
D2 are merged first, followed by D1, and lastly by the tasks from
|
|
|
|
the parent role R last. This is done for all roles in the Play.
|
|
|
|
'''
|
|
|
|
|
|
|
|
block_list = []
|
|
|
|
|
|
|
|
if len(self.roles) > 0:
|
|
|
|
for r in self.roles:
|
|
|
|
# Don't insert tasks from ``import/include_role``, preventing
|
|
|
|
# duplicate execution at the wrong time
|
|
|
|
if r.from_include:
|
|
|
|
continue
|
|
|
|
block_list.extend(r.compile(play=self))
|
|
|
|
|
|
|
|
return block_list
|
|
|
|
|
|
|
|
def compile_roles_handlers(self):
|
|
|
|
'''
|
|
|
|
Handles the role handler compilation step, returning a flat list of Handlers
|
|
|
|
This is done for all roles in the Play.
|
|
|
|
'''
|
|
|
|
|
|
|
|
block_list = []
|
|
|
|
|
|
|
|
if len(self.roles) > 0:
|
|
|
|
for r in self.roles:
|
|
|
|
if r.from_include:
|
|
|
|
continue
|
|
|
|
block_list.extend(r.get_handler_blocks(play=self))
|
|
|
|
|
|
|
|
return block_list
|
|
|
|
|
|
|
|
def compile(self):
|
|
|
|
'''
|
|
|
|
Compiles and returns the task list for this play, compiled from the
|
|
|
|
roles (which are themselves compiled recursively) and/or the list of
|
|
|
|
tasks specified in the play.
|
|
|
|
'''
|
|
|
|
|
|
|
|
# create a block containing a single flush handlers meta
|
|
|
|
# task, so we can be sure to run handlers at certain points
|
|
|
|
# of the playbook execution
|
|
|
|
flush_block = Block.load(
|
|
|
|
data={'meta': 'flush_handlers'},
|
|
|
|
play=self,
|
|
|
|
variable_manager=self._variable_manager,
|
|
|
|
loader=self._loader
|
|
|
|
)
|
|
|
|
|
|
|
|
for task in flush_block.block:
|
|
|
|
task.implicit = True
|
|
|
|
|
|
|
|
block_list = []
|
|
|
|
if self.force_handlers:
|
|
|
|
noop_task = Task()
|
|
|
|
noop_task.action = 'meta'
|
|
|
|
noop_task.args['_raw_params'] = 'noop'
|
|
|
|
noop_task.implicit = True
|
|
|
|
noop_task.set_loader(self._loader)
|
|
|
|
|
|
|
|
b = Block(play=self)
|
|
|
|
b.block = self.pre_tasks or [noop_task]
|
|
|
|
b.always = [flush_block]
|
|
|
|
block_list.append(b)
|
|
|
|
|
|
|
|
tasks = self._compile_roles() + self.tasks
|
|
|
|
b = Block(play=self)
|
|
|
|
b.block = tasks or [noop_task]
|
|
|
|
b.always = [flush_block]
|
|
|
|
block_list.append(b)
|
|
|
|
|
|
|
|
b = Block(play=self)
|
|
|
|
b.block = self.post_tasks or [noop_task]
|
|
|
|
b.always = [flush_block]
|
|
|
|
block_list.append(b)
|
|
|
|
|
|
|
|
return block_list
|
|
|
|
|
|
|
|
block_list.extend(self.pre_tasks)
|
|
|
|
block_list.append(flush_block)
|
|
|
|
block_list.extend(self._compile_roles())
|
|
|
|
block_list.extend(self.tasks)
|
|
|
|
block_list.append(flush_block)
|
|
|
|
block_list.extend(self.post_tasks)
|
|
|
|
block_list.append(flush_block)
|
|
|
|
|
|
|
|
return block_list
|
|
|
|
|
|
|
|
def get_vars(self):
|
|
|
|
return self.vars.copy()
|
|
|
|
|
|
|
|
def get_vars_files(self):
|
|
|
|
if self.vars_files is None:
|
|
|
|
return []
|
|
|
|
elif not isinstance(self.vars_files, list):
|
|
|
|
return [self.vars_files]
|
|
|
|
return self.vars_files
|
|
|
|
|
|
|
|
def get_handlers(self):
|
|
|
|
return self.handlers[:]
|
|
|
|
|
|
|
|
def get_roles(self):
|
|
|
|
return self.roles[:]
|
|
|
|
|
|
|
|
def get_tasks(self):
|
|
|
|
tasklist = []
|
|
|
|
for task in self.pre_tasks + self.tasks + self.post_tasks:
|
|
|
|
if isinstance(task, Block):
|
|
|
|
tasklist.append(task.block + task.rescue + task.always)
|
|
|
|
else:
|
|
|
|
tasklist.append(task)
|
|
|
|
return tasklist
|
|
|
|
|
|
|
|
def serialize(self):
|
|
|
|
data = super(Play, self).serialize()
|
|
|
|
|
|
|
|
roles = []
|
|
|
|
for role in self.get_roles():
|
|
|
|
roles.append(role.serialize())
|
|
|
|
data['roles'] = roles
|
|
|
|
data['included_path'] = self._included_path
|
|
|
|
data['action_groups'] = self._action_groups
|
|
|
|
data['group_actions'] = self._group_actions
|
|
|
|
|
|
|
|
return data
|
|
|
|
|
|
|
|
def deserialize(self, data):
|
|
|
|
super(Play, self).deserialize(data)
|
|
|
|
|
|
|
|
self._included_path = data.get('included_path', None)
|
|
|
|
self._action_groups = data.get('action_groups', {})
|
|
|
|
self._group_actions = data.get('group_actions', {})
|
|
|
|
if 'roles' in data:
|
|
|
|
role_data = data.get('roles', [])
|
|
|
|
roles = []
|
|
|
|
for role in role_data:
|
|
|
|
r = Role()
|
|
|
|
r.deserialize(role)
|
|
|
|
roles.append(r)
|
|
|
|
|
|
|
|
setattr(self, 'roles', roles)
|
|
|
|
del data['roles']
|
|
|
|
|
|
|
|
def copy(self):
|
|
|
|
new_me = super(Play, self).copy()
|
|
|
|
new_me.role_cache = self.role_cache.copy()
|
|
|
|
new_me._included_conditional = self._included_conditional
|
|
|
|
new_me._included_path = self._included_path
|
|
|
|
new_me._action_groups = self._action_groups
|
|
|
|
new_me._group_actions = self._group_actions
|
|
|
|
return new_me
|