File: //lib/python3.9/site-packages/ansible/playbook/__pycache__/base.cpython-39.pyc
a
�)g� � @ sZ d dl mZmZmZ eZd dlZd dlZd dlZd dl m Z
d dl m Z d dl
mZ d dlmZ d dlmZ d dlmZmZmZmZ d d lmZ d d
lmZ d d l m Z m Z d d l m Z d d
l!m"Z"m#Z#m$Z$m%Z% d dl&m'Z'm(Z( d dl)m*Z*m+Z+ d dl,m-Z- d dl.m/Z/ d dl0m1Z1m2Z2m3Z3 e-� Z4dd� Z5G dd� d�Z6G dd� d�Z7G dd� de7�Z8dS )� )�absolute_import�division�print_functionN)�copy)�cache)�UndefinedError)� constants)�context)� AnsibleError�AnsibleParserError�AnsibleUndefinedVariable�AnsibleAssertionError)� string_types)�boolean)�to_text� to_native)�
DataLoader)� Attribute�FieldAttribute�ConnectionFieldAttribute� NonInheritableFieldAttribute)�
module_loader�
action_loader)�_get_collection_metadata�AnsibleCollectionRef)�Display��Sentinel)� combine_vars� isidentifier�
get_unique_idc
C sv dt tfdd�i}g }tj}t| t�o8d| v o8t| �dk}|rh|shd�tt | ���}|� dj
|d�� n�|�rJ|r||� d � t| d t�s�|� d
j
| d d �� n�t | d � � �t |� � � }|r�|� d �
d�|��� g } |�
� D ]H\}
} |
| d vr�q�| d |
} t| | d
�s�| � d|
| | d f � q�| �rJ|� d�
d�| ��� |�rr|�dd�
|�� t�d�|�� d S )N� extend_group�list)�types� errortype�metadata� �, z7The only expected key is metadata, but got keys: {keys})�keysz-The group contains multiple metadata entries.z0The metadata is not a dictionary. Got {metadata})r% z*The metadata contains unexpected keys: {0}r# z%s is %s (expected type %s)r$ z/The metadata contains unexpected key types: {0}r zNInvalid metadata was found for action_group {0} while loading module_defaults.� )r" r �CZ VALIDATE_ACTION_GROUP_METADATA�
isinstance�dict�len�join�sorted�append�format�setr( �items�insert�display�warning)
�action�found_group_metadata�
fq_group_nameZvalid_metadataZmetadata_warnings�validateZ
metadata_onlyZ
found_keysZunexpected_keysZunexpected_typesZfieldZ requirement�value� r< �9/usr/lib/python3.9/site-packages/ansible/playbook/base.py� _validate_action_group_metadata" s> ��
r> c @ s e Zd Zdd� Zddd�ZdS )�_ClassPropertyc C s
|| _ d S �N)�name)�self�ownerrA r< r< r= � __set_name__J s z_ClassProperty.__set_name__Nc C s t |d| j� ��� S )N�_)�getattrrA )rB �objZobjtyper< r< r= �__get__M s z_ClassProperty.__get__)N)�__name__�
__module__� __qualname__rD rH r< r< r< r= r? I s r? c @ s e Zd Ze� Zeedd� ��Zdd� Ze dd� �Z
d;dd �Z d
d � Z d<d
d�Z
dd� Zdd� Zdd� Zdd� Zdd� Zd=dd�Zdd � Ze d d � �Zd>d d!�Zd?d"d#�Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Z d.d/� Z d@d1d2�Z d3d4� Z d5d6� Z d7d8� Z!d9d:� Z"d S )A�FieldAttributeBasec C sb i }t | j�D ]N}t|j�� �D ]:\}}t|t�s4q |||< |jr t||j|� |||j< q q|S r@ ) �reversed�__mro__r" �__dict__r3 r+ r �alias�setattr)�cls� fattributesZ class_objrA �attrr< r< r= � _fattributesU s
z FieldAttributeBase._fattributesc C s2 d | _ d | _d| _d| _d| _t� | _t� | _d S )NF) �_loader�_variable_manager�
_validated� _squashed�
_finalizedr �_uuidr, �vars�rB r< r< r= �__init__c s zFieldAttributeBase.__init__c C s | j S r@ )rZ r] r< r< r= � finalizedu s z FieldAttributeBase.finalizedr c C s� |dkrt �d� t �dd| | jj| t| �f � t| d�rz| jrz| j�|d � | j�� }|rz|D ]}|�|d � qft| d�r�| j r�| j �|d � dS ) zf this is never called from production code, it is here to be used when debugging as a 'complex print' r zEDUMPING OBJECT ------------------------------------------------------z%s- %s (%s, id=%s)r) �_parent� �_playN)
r5 �debug� __class__rI �id�hasattrr` �dump_me�
get_dep_chainrb )rB �depth� dep_chainZdepr< r< r= rg y s
"
zFieldAttributeBase.dump_mec C s |S )zD infrequently used method to do some pre-processing of legacy terms r< )rB �dsr< r< r= �preprocess_data� s z"FieldAttributeBase.preprocess_dataNc C s� |du rt d| ��t| d|� || _|dur6|| _nt� | _| �|�}| �|� t| j� � t
� d�d�D ]L\}}||v rjt | d| d�}|r�t| ||||| �� qjt| ||| � qj| �
� | S )z4 walk the input datastructure and assign any values Nz%ds (%s) should not be None but it is.�_dsr& )�keyz_load_%s)r
rQ rW rV r rl �_validate_attributesr/ rS r3 �operator�
itemgetterrF r: )rB rk Zvariable_manager�loaderrA rT �methodr< r< r= � load_data� s"
z FieldAttributeBase.load_datac C s& z t | d�W S ty Y d S 0 d S )Nrm )rF �AttributeErrorr] r< r< r= �get_ds� s zFieldAttributeBase.get_dsc C s | j S r@ )rV r] r< r< r= �
get_loader� s z FieldAttributeBase.get_loaderc C s | j S r@ )rW r] r< r< r= �get_variable_manager� s z'FieldAttributeBase.get_variable_managerc C sJ |� |�}td�}|rFt|t�rF||vrFtd|d�|�f | �� d��|S )N)�alwaysZ on_failedZon_unreachableZ
on_skipped�neverz9'%s' is not a valid value for debugger. Must be one of %sr' �rG )�template� frozensetr+ r r r. rv )rB rT r; �templarZ valid_valuesr< r< r= �_post_validate_debugger� s
z*FieldAttributeBase._post_validate_debuggerc C s8 t | j�}|D ]$}||vrtd|| jjf |d��qdS )z}
Ensures that there are no keys in the datastructure which do
not map to attributes for this object.
z&'%s' is not a valid attribute for a %sr{ N)r} rS r rd rI )rB rk Z valid_attrsrn r< r< r= ro � s
z'FieldAttributeBase._validate_attributesc C s� |du r i n|}| j s�| j�� D ]~\}}t| d| d�}|rP|||t| |�� q t| d|� �t�}|dur |jdkr t|ttf�r t d|t
|�f | � � d��q d| _ dS )z6 validation that is done at parse time, not load time Nz _validate_%srE �stringz[The field '%s' is supposed to be a string type, however the incoming data structure is a %sr{ T) rX rS r3 rF r �isar+ r" r, r �typerv )rB �all_varsrA � attributers r; r< r< r= r: � s
��zFieldAttributeBase.validatec C s� |d u r d S t |t�s |g}g }|D ]�}t |t�s:td��i }|�� D ]�\}}|�d�r�|�d�d }| jd ur~| �|�\}} d| }|||< qFt |�d��dk r�d| }| �
|�}
|
r�|||
< |�d�rF| j
|� dd�dd �}
|
rF|||
< qF|� |� q$|S )
Nz�The field 'module_defaults' is supposed to be a dictionary or list of dictionaries, the keys of which must be static action, module, or group names. Only the values may contain templates. For example: {'ping': "{{ ping_defaults }}"}zgroup/����.� zansible.legacy.zansible.builtin.F�� mandatory)
r+ r" r, r r3 �
startswith�split�play�_resolve_groupr- �_resolve_action�replacer0 ) rB rA r; Zvalidated_module_defaultsZ
defaults_dictZvalidated_defaults_dictZdefaults_entry�defaultsZ
group_name�dummy�resolved_actionr< r< r= �_load_module_defaults� s@
�
�
z(FieldAttributeBase._load_module_defaultsc C sJ t | d�r| j}n$t | d�r2t | jd�r2| jj}n| }|jjdkrFd S |S )Nrb r` ZPlay)rf rb r` rd rI )rB r� r< r< r= r� ! s
zFieldAttributeBase.playTc C sz t �|�s d}|d | }nd�|�d�dd� �}|| jjv rP|| jj| fS zt|��di �}W n< ty� |s�t �
d| � |g f Y S t d| ��Y n0 |�|d �d }|�||�|��}|d u r�|s�t �
d| � |g fS t d| ��g }g }d} |D ]�}
t |
t
��sjt|
| |� t |
d t��rd
} |
d �d g �}t |t
��rV|g}t |t��sg }�qt �|
��s�|d |
}
| j|
dd �} | �r|�| � �q|D ]2}
|
| jjv�r�g | jj|
< | jj|
�|� �q�|| jj|< |D ]�} t �| ��s|d | } | j| dd �\}
}|D ]2}
|
| jjv�r<g | jj|
< | jj|
�|� �q | jj| �|� |�|� �q�||fS )
Nzansible.builtinr� r ra �
action_groupszMError loading module_defaults: could not resolve the module_defaults group %sr� Fr% Tr! r� )r Z
is_valid_fqcrr. r� r� �_group_actionsr �get�
ValueErrorr5 �vvvvvr r+ r r> r, r" r� r0 �_action_groupsr� �extend)rB r9 r� Zcollection_namer� �
resource_name� action_groupZresolved_actionsZinclude_groupsr8 r7 r� Z
include_groupr� �
group_actionsr< r< r= r� 0 st
� z!FieldAttributeBase._resolve_groupc C sj t �|�}|jr,|js,t�|�}|jr<|}n|js<t�|�}|jrH|jS |rXtd| ��t�d| � d S )Nz.Could not resolve action %s in module_defaults) r Zfind_plugin_with_contextZresolvedZ
action_pluginr Z
resolved_fqcnr r5 r� )rB � action_namer� r Zpreferr< r< r= r� � s
z"FieldAttributeBase._resolve_actionc C s. | j s*| jD ]}t| |t| |�� q d| _ dS )z�
Evaluates all attributes and sets them to the evaluated version,
so that all future accesses of attributes do not need to evaluate
parent attributes.
TN)rY rS rQ rF )rB rA r< r< r= �squash� s
zFieldAttributeBase.squashc
C s� z | � � }W n0 ty< } ztd|d��W Y d}~n
d}~0 0 | jD ]"}t||tt| d|� �t��� qD| j|_| j |_ | j
|_
| j |_ | j |_ t
| d�r�| j|_|S )z=
Create a copy of this object and return it.
zTExceeded maximum object depth. This may have been caused by excessive role recursion)�orig_excNrE rm )rd � RuntimeErrorr
rS rQ � shallowcopyrF r rV rW rX rZ r[ rf rm )rB Znew_me�erA r< r< r= r � s "
zFieldAttributeBase.copyc C s |j dkrt|�}�n |j dkr,t|�}�n�|j dkrBt|�}�n�|j dkr\t|dd�}�n�|j dkr�t|t�r�d|v r�|�dd �}t|�}�n�|j d
k�r>|d u r�g }nt|t�s�|g}|j d u�r|D ]p}t||j �s�t
d ||j |t |�f | � � d ��q�|j
r�|j tkr�|d u �s$|�� d kr�t
d
|f | � � d ��q�n�|j dk�r�|d u �r\t� }n.t|ttf��s�t|t��r�|�d�}n|g}t|t��st|�}nv|j dk�r�|d u �r�t� }nt|t��std| ��n>|j dk�rt||j��s
td||jt |�f ��|j|d� |S )Nr� �int�float�boolT)�strict�percent�%� r" z@the field '%s' should be a list of %s, but the item '%s' is a %sr{ z8the field '%s' is required, and cannot have empty valuesr2 �,r, z%s is not a dictionary�classz'%s is not a valid %s (got a %s instead))r~ )r� r r� r� r r+ r r� r" Zlistofr r� rv �required�stripr2 r� r, � TypeError�
class_type�
post_validate)rB rA r� r; r~ �itemr< r< r= �get_validated_value� s^
��
z&FieldAttributeBase.get_validated_valuec C s` | j | }t|t�r"t| |t� n:zt| || j|dd�� W n tyZ t| |t� Y n0 dS )z9 set to parent inherited value or Sentinel as appropriateT)�omitN)rS r+ r rQ r Z_get_parent_attributeru )rB rA r� r< r< r= �set_to_context� s
z!FieldAttributeBase.set_to_contextc C s� |j �d�}| j�� D �]�\}}|jrVt| |�}|dvr|�|�rt�d||f � qt| |�du r||j snqq�t
d| ��n|j s�| j j
dvr�qz�t| d| d�}|r�||t| |�|�}n&|jdkr�t| |�}n|�t| |��}|dur�||kr�| �|� W q|du�r| �||||�}t| ||� W q ttf�yz } z6t| |�}t
d |||j|f | �� |d
��W Y d}~qd}~0 ttf�y� } zX|j�r�|d k�r�|d k�r�d
t|� }nd|t|�f }t
|| �� |d
��W Y d}~qd}~0 0 qd| _dS )z�
we can't tell that everything is of the right type until we have
all the variables. Run basic types (from isa) as well as
any _post_validate_<foo> functions.
r� )r\ z]"%s" is not templatable, but we found: %s, it will not be templated and will be used "as is".Nz*the field '%s' is required but was not set)ZTaskZHandlerZ PlayContextz_post_validate_%sr� z_the field '%s' has an invalid value (%s), and could not be converted to an %s.The error was: %s�rG r� rA �argszIThe task includes an option with an undefined variable. The error was: %sz\The field '%s' has an invalid value, which includes an undefined variable. The error was: %sT)Zavailable_variablesr� rS r3 �staticrF Z is_templater5 r6 r� r �always_post_validaterd rI r� r| r� r� rQ r� r� rv r r Z_fail_on_undefined_errorsr rZ ) rB r~ Z
omit_valuerA r� r; rs r� �msgr< r< r= r� � sT
�
��
*z FieldAttributeBase.post_validatec
C s� dd� }zvt |t�r*||� t| j|�W S t |t�rj| j}|D ]$}t |t�sPt�||� t||�}q>|W S |du rxi W S t�W nv ty� } z"td| jj ||d��W Y d}~nFd}~0 t y� } z&td| jj|f ||d��W Y d}~n
d}~0 0 dS )z�
Vars in a play can be specified either as a dictionary directly, or
as a list of dictionaries. If the later, this method will turn the
list into a single dictionary.
c S s" | D ]}t |�std| ��qd S )Nz!'%s' is not a valid variable name)r r� )rk rn r< r< r= �_validate_variable_keysE s z>FieldAttributeBase._load_vars.<locals>._validate_variable_keysNzIVars in a %s must be specified as a dictionary, or a list of dictionariesr� z2Invalid variable name in vars specified for %s: %s)
r+ r, r r\ r" r� r rd rI r� )rB rT rk r� r� r� r� r< r< r= �
_load_vars> s,
�z FieldAttributeBase._load_varsFc C sf t |t�s|g}t |t�s |g}dd� |D �}dd� |D �}|rJ|| }n|| }dd� t�|�D �S )z�
Will extend the value given with new_value (and will turn both
into lists if they are not so already). The values are run through
a set to remove duplicate values.
c S s g | ]}|t ur|�qS r< r ��.0�vr< r< r= �
<listcomp>o � z4FieldAttributeBase._extend_value.<locals>.<listcomp>c S s g | ]}|t ur|�qS r< r r� r< r< r= r� p r� c S s g | ]\}}|d ur|�qS r@ r< )r� �irE r< r< r= r� w r� )r+ r" � itertools�groupby)rB r; Z new_value�prependZcombinedr< r< r= �
_extend_value` s
z FieldAttributeBase._extend_valuec C sP i }| j �� D ]<\}}t| |�}|jdkrBt|d�rB|�� ||< q|||< q|S )z6
Dumps all attributes to a dictionary
r� � serialize)rS r3 rF r� rf r� )rB �attrsrA r� rT r< r< r= �
dump_attrsy s
z FieldAttributeBase.dump_attrsc C sv |� � D ]\\}}|| jv r| j| }|jdkrXt|t�rX|�� }|�|� t| ||� qt| ||� qd| _d| _ dS )z4
Loads attributes from a dictionary
r� TN)
r3 rS r� r+ r, r� � deserializerQ rZ rY )rB r� rT r; r� rG r< r< r= �
from_attrs� s
z FieldAttributeBase.from_attrsc C s* | � � }| j|d< | j|d< | j|d< |S )a0
Serializes the object derived from the base object into
a dictionary of values. This only serializes the field
attributes for the object, so this may need to be overridden
for any classes which wish to add additional items not stored
as field attributes.
�uuidr_ �squashed)r� r[ rZ rY )rB �reprr< r< r= r� � s
z FieldAttributeBase.serializec C s� t |t�s td|t|�f ��| j�� D ],\}}||v rJt| ||| � q(| �|� q(t| d|�d�� |�dd�| _ |�dd�| _
dS )z�
Given a dictionary of values, load up the field attributes for
this object. As with serialize(), if there are any non-field
attribute data members, this method will need to be overridden
and extended.
z&data (%s) should be a dict but is a %sr[ r� r_ Fr� N) r+ r, r
r� rS r3 rQ r� r� rZ rY )rB �datarA r� r< r< r= r� � s
z FieldAttributeBase.deserialize)r )NN)N)T)T)F)#rI rJ rK r? rS � classmethodr rU r^ �propertyr_ rg rl rt rv rw rx r ro r: r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r< r< r< r= rL Q s@
*
7
U
3E"
rL c @ sj e Zd Zedddd�Zede�d�d�Ze dd�Z
e de�d �d�Z ed
d dd �Z e d
ddd�Z
e d
ddd�Ze dejd�Ze dd�Ze dd�Ze dd�Ze de�d�d�Ze de�d�d�Ze dejd�Ze ddd�Ze dejd�Ze dd�Z e de�d�d�Z e de�d�d�Z e de�d�d�Z e de�d�d�Z e de�d�d�Z!g Z"dd� Z#dd� Z$d d � Z%d S ) �Baser� r� T)r� �defaultr� �
connection)r� r� r� )r� � remote_userr, �d )r� �priorityr� r" )r� r� r� r� �check�diffr �become�
become_method� become_user� become_flags�
become_exec C sh d}zd| j j| j jf }W nF tyb z d| jjj j| jjj jf }W n ty\ Y n0 Y n0 |S )zE return the absolute path of the playbook object and its line number r� z%s:%s)rm Z _data_sourceZ _line_numberru r` rb )rB �pathr< r< r= �get_path� s z
Base.get_pathc C s" t | d�r| jr| j�� S d S d S )Nr` )rf r` rh r] r< r< r= rh � s
zBase.get_dep_chainc C sN g }| � � }|r(|�tdd� |D ��� tj�| �� �}||vrJ|�|� |S )z�
Return the list of paths you should search for files, in order.
This follows role/playbook dependency chain.
c S s g | ]}t |d �r|j�qS )�
_role_path)rf r� )r� �xr< r< r= r�
r� z(Base.get_search_path.<locals>.<listcomp>)rh r� rM �osr� �dirnamer� r0 )rB Z
path_stackrj Ztask_dirr< r< r= �get_search_path s
zBase.get_search_pathN)&rI rJ rK r rA r r Zcliargs_deferred_getr� r �portr� r\ Zmodule_defaultsZ environmentr* ZDEFAULT_NO_LOGZno_logZrun_once�
ignore_errorsZignore_unreachableZ
check_moder� ZANY_ERRORS_FATALZany_errors_fatalZthrottleZ TASK_TIMEOUT�timeoutZdebuggerr� r� r� r� r� ZDEPRECATED_ATTRIBUTESr� rh r� r< r< r< r= r� � s4
r� )9Z
__future__r r r r� Z
__metaclass__r� rp r� r r� � functoolsr Zjinja2.exceptionsr Zansibler r* r Zansible.errorsr
r r r
Zansible.module_utils.sixr Z)ansible.module_utils.parsing.convert_boolr Zansible.module_utils._textr r Zansible.parsing.dataloaderr Zansible.playbook.attributer r r r Zansible.plugins.loaderr r Z2ansible.utils.collection_loader._collection_finderr r Zansible.utils.displayr Zansible.utils.sentinelr Zansible.utils.varsr r r r5 r> r? rL r� r< r< r< r= �<module> s: ' w