o n�nht�@s<ddlmZddlZddlmZmZmZmZddlm Z ddl mZddl mZmZmZddlmZddlmZmZdd lmZdd lmZddlmZddlmZdd lmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/ddgZ0dd�Z1Gdd�deee%ee�Z2dS)�)�annotationsN)� Container�Mapping�Set�Sequence)�MappingProxyType)� constants)�AnsibleError�AnsibleParserError�AnsibleAssertionError)�to_text)�binary_type� text_type)�FieldAttribute)�Base)�CollectionSearch)�Conditional)�Delegatable)�load_list_of_blocks)�RoleMetadata)�Taggable)�add_all_plugin_dirs)�AnsibleCollectionConfig)� is_subpath)�Sentinel)�combine_vars�Role�hash_paramsc Cs�t|t�rpt|ttf�spt|t�r>z t|��}W|Sty=t�}|��D] \}}|� |t |�f�q(t|�}Y|Swt|ttf�rjzt|�}W|Styit�}|D] }|� t |��qXt|�}Y|Swt|�}|St|f�S)a� Construct a data structure of parameters that is hashable. This requires changing any mutable data structures into immutable ones. We chose a frozenset because role parameters have to be unique. .. warning:: this does not handle unhashable scalars. Two things mitigate that limitation: 1) There shouldn't be any unhashable scalars specified in the yaml 2) Our only choice would be to return an error anyway. ) � isinstancerrr r� frozenset�items� TypeError�set�addrrr)�params� new_params�k�v�r(�I/usr/local/lib/python3.10/dist-packages/ansible/playbook/role/__init__.pyr3s4 � � � � cs"eZdZd>�fdd� Zdd�Zd?dd �Zd d�Zdd �Zdd�Ze d>dd��Z d@dd�Zdd�Zdd�Z dd�ZdAdd�Zdd�Zdd�Zd d!�Zd"d#�Zd@d$d%�ZdAd&d'�Zd@d(d)�ZdBd*d+�Zd,d-�Zd.d/�Zd0d1�Zd@d2d3�Zd4d5�Zd@d6d7�Zd?�fd8d9� Zd?�fd:d;� Zd z Role.__init__cCs|��S�N)�get_name�rIr(r(r)�__repr__�sz Role.__repr__cCs&|rd�dd�|j|jfD��S|jS)N�.css�|]}|r|VqdSrQr()�.0�xr(r(r)� �s�z Role.get_name..)�joinr.r,)rI�include_role_fqcnr(r(r)rR�sz Role.get_namecCstj�|j�SrQ)�os�path�realpathr-rSr(r(r)� get_role_path�szRole.get_role_pathc CsP|jr|jSt|��|��t|��|j|jt|j�t|j�|j d��|_|jS)N)�namer\r$�when�tagsrK�varsrE) rFrrRr^�get_role_paramsr`rarDrbrErSr(r(r)�_get_hash_dict�s ��zRole._get_hash_dictcCst|t�sdS|��|��kS�NF)rrrd)rI�otherr(r(r)�__eq__�s zRole.__eq__c Cs�|duri}z1t||||||d�}|j||d�|��} | |jvr&g|j| <||j| vr5|j| �|�|WStyEtd|jd��w)N)rJrKrErLr6r2)�parent_rolezvA recursion loop was detected with the roles specified. Make sure child roles do not have dependencies on parent roles)�obj)r�_load_role_datar^� role_cache�append�RuntimeErrorr �_ds) �role_includerJrhrKrErLr6r2�r� role_pathr(r(r)�load�s ��z Role.loadc s�|j�_|��_|j�_|��_|��_|� ��_ |r#��|��jD]}t �d|��t|d|��t��q&�jd�j�d�dd��_�jdurOi�_n t�jt�s\td�j��jd�j�d�dd��_�jdurri�_n t�jt�std�j��d�}|r�tj|��j�j d ��_��_g�_�jr��j�d �j�ntj }|r��j�d |�t!�j��jjrʈj�"�fdd��jjD��jr�jr�d nd}d �jvr�d�jvr�j�#|��jd�j�d�d�}�j$r��%�}��&||�}|�r&zt'|�j(��j �jd��_)Wnt*�y%} z td�j|| d��d} ~ ww�jd�j�d�d�} | �r]zt'| �j(�d�j �jd��_+WdSt*�y\} z td�j| | d��d} ~ wwdS)N�_rbT)�main� allow_dirzKThe vars/main.yml file for role '%s' must contain a dictionary of variables�defaultszOThe defaults/main.yml file for role '%s' must contain a dictionary of variables�meta)�owner�variable_manager�loaderrc3s�|] }|�jvr|VqdSrQ)�collections)rV�crSr(r)rXs�z'Role._load_role_data..zansible.builtinzansible.legacy�tasks�rt)rJ�rolerzryzBThe tasks/main.yml file for role '%s' must contain a list of tasks)ri�orig_exc�handlers)rJr�use_handlersrzryzEThe handlers/main.yml file for role '%s' must contain a list of tasks),rr,r^r-r.rcr0�get_variable_manager�_variable_manager� get_loaderr1� add_parent�fattributes�setattr�getattrr�_load_role_yamlrD�getr@rrr r?rrrr7�_load_dependenciesr:r{�insertr�default_collectionr�extendrlrC�_get_role_argspecs�_prepend_validation_taskrr8r<�AssertionErrorr=)rIrorh� attr_name�metadatar��default_append_collection� task_data� role_argspecs�e�handler_datar(rSr)rj�s~ " �� zRole._load_role_datac Cs~tj�|jdd�}tjD]+}||}|j�|�r7|jddd�}z |� d�p&iWSt y6iYSwqt|jdi�S)a�Get the role argument spec data. Role arg specs can be in one of two files in the role meta subdir: argument_specs.yml or main.yml. The former has precedence over the latter. Data is not combined between the files. :returns: A dict of all data under the top-level ``argument_specs`` YAML key in the argument spec file. An empty dict is returned if there is no argspec data. rw�argument_specsr~) r[r\rYr-r3�YAML_FILENAME_EXTENSIONSr1�path_existsr�r��AttributeErrorr�r7)rI�base_argspec_path�ext� full_pathr�r(r(r)r�"s ��zRole._get_role_argspecscCsD|r |j�dd�}|�|�}|r |�||�}|sg}|�d|�|S)a�Insert a role validation task if we have a role argument spec. This method will prepend a validation task to the front of the role task list to perform argument spec validation before any other tasks, if an arg spec exists for the entry point. Entry point defaults to `main`. :param task_data: List of tasks loaded from the role. :param argspecs: The role argument spec data dict. :returns: The (possibly modified) task list. r}rtr)rDr��_create_validation_taskr�)rIr��argspecs� entrypoint�entrypoint_arg_spec�validation_taskr(r(r)r�>s zRole._prepend_validation_taskcCsPd|}d|vr|d|d}d|�di�|jd|j||jd�d�|d gd �S)a�Create a new task data structure that uses the validate_argument_spec action plugin. :param argument_spec: The arg spec definition for a particular role entry point. This will be the entire arg spec for the entry point as read from the input file. :param entrypoint_name: The name of the role entry point associated with the supplied `argument_spec`. z*Validating arguments against arg spec '%s'�short_descriptionz - z&ansible.builtin.validate_argument_spec�optionsr)�typer_�argument_spec_namer\)�module� argument_spec�provided_arguments�validate_args_context�always)�actionr_ra)r�r0r,r-)rIr��entrypoint_name� task_namer(r(r)r�[s ��zRole._create_validation_taskcCs�d}tj�|j|�}|j�|�r}|j�|�r}gd�}|dur&d}|�d�n|}|�dd�|j� ||||�}|rq|D]3} t | |�sPtdt| �|j t|�f��|j�| �} | rn|durgt| t�rgt|| �}n| }|sn|Sq;|S|dur}td||f��|S)aj Find and load role YAML files and return data found. :param subdir: subdir of role to search (vars, files, tasks, handlers, defaults) :type subdir: string :param main: filename to match, will default to 'main.' if not provided. :type main: string :param allow_dir: If true we combine results of multiple matching files found. If false, highlander rules. Only for vars(dicts) and not tasks(lists). :type allow_dir: bool :returns: data from the matched file(s), type can be dict or list depending on vars or tasks. N)z.ymlz.yamlz.jsonrt�rzRFailed loading '%s' for role (%s) as it is not inside the expected role path: '%s'z,Could not find specified file in role: %s/%s)r[r\rYr-r1r��is_directoryrlr��find_vars_filesrr rr,�load_from_filerrr)rI�subdirrtru�data� file_path� extensions�_main�found_files�found�new_datar(r(r)r�zs: ��zRole._load_role_yamlcCs6g}|jjD]}tj||j||jd�}|�|�q|S)zr Recursively loads role dependencies from the metadata list of dependencies, if it exists )rJrhr2)r7�dependenciesrrrr8r2rl)rI�depsrorpr(r(r)r��s zRole._load_dependenciescCs.t|t�st��||jvr|j�|�dSdS)z/ adds a role to the list of this roles parents N)rrrr9rl)rIrhr(r(r)r��s �zRole.add_parentcCs|jSrQ)r9rSr(r(r)�get_parents�szRole.get_parentscCs,g}|jD]}|�|��|�|�q|SrQ)r9r�� get_dep_chainrl)rI� dep_chain�parentr(r(r)r��s zRole.get_dep_chaincCs\|durgn|}t�}|��D] }t||��}q|r&|D]}t||j�}qt||j�}|SrQ)r/�get_all_dependenciesr�get_default_varsr?)rIr��default_vars�depr�r(r(r)r��szRole.get_default_varscCsD|durgn|}t�}|r |D]}|st||j�}t||j�}q|SrQ)r/rrbr@)rIr��only_exports�inherited_varsr�r(r(r)�get_inherited_vars�szRole.get_inherited_varscCs>|durgn|}i}|r|D]}t||j�}qt||j�}|SrQ)rr0)rIr�r$r�r(r(r)rc�szRole.get_role_paramscCs�|durgn|}i}|j||d�}g}|��D]}||vr,t||jddd��}|�|�qt||j�}|sF|r@t||j|d��}t||j�}|S)N)r�FT)�include_paramsr�)r�)r�r�r�get_varsrlr@rcrb)rIr�r�r��all_vars�seenr�r(r(r)r��s �z Role.get_varscC�|jdd�SrQ)r:rSr(r(r)�get_direct_dependencies�zRole.get_direct_dependenciescCsJ|jdur"g|_|��D]}|��D]}|j�|�q|j�|�q|jS)z� Returns a list of all deps, built recursively from all child dependencies, in the proper order in which they should be executed or evaluated. N)r;r�r�rl)rIr�� child_depr(r(r)r�s zRole.get_all_dependenciescCr�rQ)r<rSr(r(r)�get_task_blocks&r�zRole.get_task_blocksc Cs�|jr|jSg|_}|durg}||g}|��D]}|j||d�}|�|�q|jD]}|��}||_||_|�|�q,|S)N�rJr�) r>r��get_handler_blocksr�r=�copy� _dep_chainr8rl) rIrJr�� block_list� new_dep_chainr�� dep_blocks� task_block�new_task_blockr(r(r)r�)s zRole.get_handler_blockscCs|j|jvS)zs Returns true if this role has been iterated over completely and at least one task was run )r_rB)rI�hostr(r(r)�has_runEszRole.has_runcCs�ddlm}ddlm}g}|durg}||g}|��}|D]}|j||d�} |�| �q|jD]} | ��}||_ ||_ |�|�q1||d�}|j|_||_ |j|_d|_||d�} || _ d | _d di| _d| _d g| _d| _| g|_|�|�|S)a� Returns the task list for this role, which is created by first recursively compiling the tasks for all direct dependencies, and then adding on the tasks for this role. The role compile() also remembers and saves the dependency chain with each task, so tasks know by which route they were found, and can correctly take their parent's tags/conditionals into account. r)�Block)�TaskNr�)rJF)�blockrw�_raw_params� role_completeTr�)�ansible.playbook.blockr��ansible.playbook.taskr�r��compiler�r<r�r�r8rlr1�_roler��run_oncer��args�implicitrar`r�)rIrJr�r�r�r�r�r�r�r�r�r�� eor_block�eor_taskr(r(r)r�Ms< zRole.compilecs�tt|��}|j|d<|j|d<|j|d<|j|d<|j|d<|j� �|d<|j � �|d<|j��|d<|rKg}|��D] }|� |��q=||d <g}|jD]}|� |jd d��qP||d<|S) Nr,r-r@r0r?rArBr7r:F��include_depsr9)rGr� serializer,r-r@r0r?rAr�rBr7r�rlr9)rIr��resr�r�parentsr�rOr(r)r�s& zRole.serializecs(|�dd�|_|�dd�|_|�dt��|_|�dt��|_|�dt��|_|�dt��|_|�dt��|_|rVg}|�d g�D]}t �}|� |�|�|�q@t|d |�|�d g�}g}|D]}t �}|j |dd�|�|�q`t|d |�|�d �} | r�t �} | � | �| |_tt |�� |�dS)Nr,r�r-r@r0r?rArBr:r9Fr�r7)r�r,r-r/r@r0r?rArBr�deserializerlr�rr7rG)rIr�r�r�r�rp�parent_datar�r�� metadata_data�mrOr(r)r��s6 zRole.deserializecCs8||_|jD]}|�|�q|��D]}|�|�qdSrQ)r1r9� set_loaderr�)rIrzr�r�r(r(r)r��s �zRole.set_loader)NNFTNT)TrQre)NTF)"�__name__� __module__�__qualname__rHrTrRr^rdrg�staticmethodrrrjr�r�r�r�r�r�r�r�r�r�rcr�r�r�r�r�r�r�r�r�r�� __classcell__r(r(rOr)rcs>, S 6 ! 2!)3� __future__rr[�collections.abcrrrr�typesr�ansiblerr3�ansible.errorsr r r�+ansible.module_utils.common.text.convertersr�ansible.module_utils.sixr r�ansible.playbook.attributer�ansible.playbook.baser�!ansible.playbook.collectionsearchr�ansible.playbook.conditionalr�ansible.playbook.delegatabler�ansible.playbook.helpersr�ansible.playbook.role.metadatar�ansible.playbook.taggabler�ansible.plugins.loaderr�ansible.utils.collection_loaderr�ansible.utils.pathr�ansible.utils.sentinelr�ansible.utils.varsr�__all__rrr(r(r(r)�s00