관리-도구
편집 파일: schema.cpython-39.pyc
a '�Dg� � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddlmZ ddlmZ ddlmZ dd lmZmZmZmZmZmZmZm Z ddl Z dd l m Z m Z m!Z!m"Z" dd l#m$Z$ dd l%m&Z&m'Z' dd l(m)Z) ddl*m+Z+ ddl,m-Z- ddl.m/Z/ ddl0m1Z1m2Z2 zddl3m4Z4 W n e5�yP e6Z4Y n0 zddl7m8Z8m9Z9 dZ:W n e5�y� dZ:Y n0 e�;e<�Z=dZ>dZ?dZ@dZAeBdd� e&�C� D ��ZDe�r�ddlZdd lEmFZFmGZG G d d � d eG�ZHneIZHG d d � d e4�ZJG d!d"� d"e�ZKeeK ZLG d#d$� d$e�ZMeMjNd%e>ieMjOd%e@ieMjPd%e?ieMjQd%e@iiZRG d&d'� d'e�ZSG d(d)� d)e�ZTG d*d+� d+e�ZUdd,d-�eLeeV eVeVd.�d/d0�ZWG d1d2� d2eX�ZYG d3d4� d4eY�ZZd5d6� Z[dueIeVd7�d8d9�Z\ee4 d:�d;d<�Z]eJfe^eIeVee6 d=�d>d?�Z_ee_dd@�Z`ee_dAd@�ZaeJfee6 dB�dCdD�ZbeJfee6 dB�dEdF�ZcdGdH� ZddveIdI�dJdK�ZeeIeef dL�dMdN�ZgdweIe^e^e^e^dO�dPdQ�Zhe!�idR�deMjNddddfeIeeI eMe^e^e^e^e^dS�dTdU��ZjG dVdW� dW�ZkdddX�eVeIeeL eeL e eVelf dY�dZd[�ZmeVeeK d\�d]d^�ZndxeVeVeeV eUd_�d`da�ZoeMjNddfeVeIeMe^eeV e^db�dcdd�ZpeVd:�dedf�ZqeMjNfeMeIdg�dhdi�Zrdydjdk�Zsdldm� ZteeVeeT f d:�dndo�Zudpdq� Zvdrds� Zwe<dtk�r�e�xew� � dS )zzFschema.py: Set of module functions for processing cloud-config schema.� N)� defaultdict)�suppress)�deepcopy)�Enum)�EACCES)�partial)� TYPE_CHECKING� DefaultDict�List� NamedTuple�Optional�Tuple�Type�Union)�features� lifecycle� performance�safeyaml)�read_cfg_paths)�INCLUSION_TYPES_MAP�type_from_starts_with)�Paths)�error)�DataSourceNotFoundException)�mkdtemp)�load_text_file� write_file)�ValidationError)�NetplanParserException�ParserTFzschema-cloud-config-v1.jsonz schema-network-config-v1.jsonz schema-network-config-v2.json� deprecatedc C s g | ]}|d dkr|�qS )r �#� )�.0�tr" r" �;/usr/lib/python3.9/site-packages/cloudinit/config/schema.py� <listcomp>G � r& )� NotRequired� TypedDictc @ s< e Zd ZU eed< eje ed< eed< eee ed< dS )� MetaSchema�idZdistrosZ frequencyZactivate_by_schema_keysN)�__name__� __module__� __qualname__�str�__annotations__�typingr r( r" r" r" r% r* Q s r* c s$ e Zd Zeed�� fdd� Z� ZS )�SchemaDeprecationError)�message�versionc s t � j|fi |�� || _d S �N)�super�__init__r4 )�selfr3 r4 �kwargs�� __class__r" r% r7 \ s z SchemaDeprecationError.__init__)r, r- r. r/ r7 � __classcell__r" r" r: r% r2 [ s �r2 c @ s, e Zd ZU eed< eed< ed�dd�ZdS )� SchemaProblem�pathr3 ��returnc C s | j � d| j� �S )N�: )r> r3 �r8 r" r" r% �formatj s zSchemaProblem.formatN)r, r- r. r/ r0 rC r" r" r" r% r= f s r= c @ s e Zd ZdZdZdZdZdZdS )� SchemaTypea Supported schema types are either cloud-config or network-config. Vendordata and Vendordata2 format adheres to cloud-config schema type. Cloud Metadata is unique schema to each cloud platform and likely will not be represented in this enum. z cloud-config�network-configznetwork-config-v1znetwork-config-v2N)r, r- r. �__doc__� CLOUD_CONFIG�NETWORK_CONFIG�NETWORK_CONFIG_V1�NETWORK_CONFIG_V2r" r" r" r% rD q s rD �latestc @ s( e Zd ZdZdZdZdZdZdd� ZdS ) �InstanceDataTypez-Types of instance data provided to cloud-initz user-datarE z vendor-dataz vendor2-datac C s | j S r5 )�valuerB r" r" r% �__str__� s zInstanceDataType.__str__N) r, r- r. rF �USERDATArH � VENDORDATA� VENDOR2DATArN r" r" r" r% rL � s rL c @ s& e Zd ZU eed< eed< eed< dS )�InstanceDataPart� config_type� schema_type� config_pathN)r, r- r. rL r0 rD r/ r" r" r" r% rR � s rR c @ s e Zd ZU eed< eed< dS )� UserDataTypeAndDecodedContent� userdata_type�contentN)r, r- r. r/ r0 r" r" r" r% rV � s rV �, ��prefix� separator)�schema_problemsr[ r\ r@ c C s( |� tdd� | ��}|r$|� |� �}|S )Nc S s | � � S r5 )rC )�pr" r" r% �<lambda>� r' z)_format_schema_problems.<locals>.<lambda>)�join�map)r] r[ r\ � formattedr" r" r% �_format_schema_problems� s rc c s@ e Zd ZdZd ee ee d�� fdd� Zed�dd�Z� Z S ) �SchemaValidationErrorz<Raised when validating a cloud-config file against a schema.N�� schema_errors�schema_deprecationsc s< d� � fdd�}||dd�| _ ||dd�| _t� �� � dS )z�Init the exception an n-tuple of schema errors. @param schema_errors: An n-tuple of the format: ((flat.config.key, msg),) @param schema_deprecations: An n-tuple of the format: ((flat.config.key, msg),) � c s8 | s| S � r� d7 � t tt| ���} � t| |d�7 � | S )N� �r[ )�sorted�list�setrc )�problemsr[ �r3 r" r% �handle_problems� s z7SchemaValidationError.__init__.<locals>.handle_problemsz Cloud config schema errors: rj �"Cloud config schema deprecations: N)rf rg r6 r7 )r8 rf rg rp r: ro r% r7 � s ��z SchemaValidationError.__init__r? c C s t | j�S r5 )�boolrf rB r" r" r% � has_errors� s z SchemaValidationError.has_errors)NN) r, r- r. rF r �SchemaProblemsr7 rr rs r< r" r" r: r% rd � s ��"rd c @ s e Zd ZdZdS )�"SchemaValidationInvalidHeaderErrorz>Raised when no valid header is declared in the user-data file.N)r, r- r. rF r" r" r" r% ru � s ru c C s@ zddl m} W n ty$ Y dS 0 |j�|d�p>t|tf�S )zWTYPE_CHECKER override allowing bytes for string type For jsonschema v. 3.0.0+ r )�Draft4ValidatorF�string)� jsonschemarv � ImportError� TYPE_CHECKER�is_type� isinstance�bytes)Zchecker�instancerv r" r" r% �is_schema_byte_string� s � �r )�configr@ c sP t d�� �fdd� }|r |ng d�}d�t||��}��dd�}|� |� ��� S )z�combine description with new/changed/deprecated message deprecated/changed/new keys require a _version key (this is verified in a unittest), a _description key is optional ��keyc sr �� | � �sdS �� | � d�d�}�� | � d�d| � d��}| �� � d|� d|� �}� rbd|� �S d |�� � d �S ) Nrh Z _description�_versionz <missing z'_version key, please file a bug report>z in version �. � z *�*)�get� capitalize�strip)r� Zkey_description�v�msg��annotater� r" r% �format_message� s � z:_add_deprecated_changed_or_new_msg.<locals>.format_message)r �changed�newrh � description)r/ r` ra r� �rstrip)r� r� � filter_keyr� Z filter_keysZchanged_new_deprecatedr� r" r� r% �"_add_deprecated_changed_or_new_msg� s � r� r? c C s� g }d}t |t�od|v }| D ]�}|r�|d |j�di ��di ��dg �v rV|g S t|d�r~|jdd� dkr�|�|� q�|jr�|jd dkr�|�|� q t|j�|kr�|�|� q t|j�|kr t|j�}|g}q |S )z�Return the best_match errors based on the deepest match in the json_path This is useful for anyOf and oneOf subschemas where the most-specific error tends to be the most appropriate. r �type� properties�enum� json_path���N) r| �dict�schemar� �hasattrr� �appendr> �len)�errorsr~ Z best_matchesZ path_depthr{ �errr" r" r% �cloud_init_deepest_matches s, �� r� )r r� r� � error_typec c s, |r(t |d|gd�}|||�dd��V dS )z�Jsonschema validator for `deprecated` items. It yields an instance of `error_type` if deprecated that must be handled, otherwise the instance is consider faulty. T)r� r� Zdeprecated_version�develN)r� r� )� _validatorr Z _instancer� r� r� r� r" r" r% r� 4 s �r� )r� r� �r� c # s� ddl m} g }g }d}t|�D ]�\} } t| j|| | d��} tt� fdd�| ��} tt� fdd�| ��} | sz|�| � q�t|t�r�d|v r�d | � d d �v r�d |d � �| d v r�d }| E dH |�| � q |s�||�V t d|f |d�V |E dH dS )a� Jsonschema validator for `anyOf`. It treats occurrences of `error_type` as non-errors, but yield them for external processing. Useful to process schema annotations, as `deprecated`. Cloud-init's network schema under the `config` key has a complexity of allowing each list dict item to declare it's type with a `type` key which can contain the values: bond, bridge, nameserver, physical, route, vlan. This schema 'flexibility' makes it hard for the default jsonschema.exceptions.best_match function to find the correct schema failure because it typically returns the failing schema error based on the schema of greatest match depth. Since each anyOf dict matches the same depth into the network schema path, `best_match` just returns the first set of schema errors, which is almost always incorrect. To find a better schema match when encountering schema validation errors, cloud-init network schema introduced schema $defs with the prefix `anyOf_type_`. If the object we are validating contains a 'type' key, and one of the failing schema objects in an anyOf clause has a name of the format anyOf_type_XXX, raise those schema errors instead of calling best_match. r )� best_matchF�Z schema_pathc s t | � � S r5 �r| ��er� r" r% r_ s r' z_anyOf.<locals>.<lambda>c s t | � �S r5 r� r� r� r" r% r_ u r' r� Z anyOf_typez$refrh Z anyOf_type_TNz.%r is not valid under any of the given schemas)�context) �jsonschema.exceptionsr� � enumeraterl �descend�filter�extendr| r� r� r )� validator�anyOfr~ �_schemar� r� � all_errors�all_deprecationsZskip_best_match�index� subschema�all_errs�errs� deprecationsr" r� r% �_anyOfL s@ �� ��� �r� c # s� t |�}g }g }|D ]h\}} t�j�| |d��} tt� fdd�| ��} tt� fdd�| ��} | sr| } |�| � q�|�| � qt|��E dH ��fdd�|D �}|r�|�| � d�d d � |D ��}td �|f �V n |E dH dS ) z�Jsonschema validator for `oneOf`. It treats occurrences of `error_type` as non-errors, but yield them for external processing. Useful to process schema annotations, as `deprecated`. r� c s t | � � S r5 r� r� r� r" r% r_ � r' z_oneOf.<locals>.<lambda>c s t | � �S r5 r� r� r� r" r% r_ � r' Nc s g | ]\}}�� � |�r|�qS r" )�is_valid)r# �i�s)r~ r� r" r% r& � r' z_oneOf.<locals>.<listcomp>rY c s s | ]}t |�V qd S r5 )�repr)r# r� r" r" r% � <genexpr>� r' z_oneOf.<locals>.<genexpr>z %r is valid under each of %s) r� rl r� r� r� r� r� r` r )r� �oneOfr~ r� r� Z subschemasr� r� r� r� r� r� r� Z first_validZ more_validZreprsr" )r� r~ r� r% �_oneOf� s2 �� �r� c C s� ddl m} m} ddlm} t| j�}ddi|d d< i }d|d < | j�dt �}d |i}t | j �}t |t < t|d < t|d < t|d < |f ||dd�|��}ddd�}ddd�} |} t|d�r�| } | |_||fS )z�Get metaschema validator and format checker Older versions of jsonschema require some compatibility changes. @returns: Tuple: (jsonschema.Validator, FormatChecker) @raises: ImportError when jsonschema is not present r )rv � FormatChecker)�creater� rw r� �labelF�additionalProperties� type_checkerr� r� r� Zdraft4)� meta_schema� validatorsr4 Nc [ s$ t dd� | �||��}t|d�du S )�gOverride version of `is_valid`. It does ignore instances of `SchemaDeprecationError`. c S s t | t� S r5 �r| r2 r� r" r" r% r_ � s �zFget_jsonschema_validator.<locals>.is_valid_pre_4_0_0.<locals>.<lambda>N)r� � iter_errors�next�r8 r~ r� �__r� r" r" r% �is_valid_pre_4_0_0� s �z4get_jsonschema_validator.<locals>.is_valid_pre_4_0_0c [ s* t dd� | j|d��|��}t|d�du S )r� c S s t | t� S r5 r� r� r" r" r% r_ � s �z<get_jsonschema_validator.<locals>.is_valid.<locals>.<lambda>�r� N)r� �evolver� r� r� r" r" r% r� � s �z*get_jsonschema_validator.<locals>.is_validr� )N)N)rx rv r� Zjsonschema.validatorsr� r Z META_SCHEMArz Zredefiner r� Z VALIDATORS�_validator_deprecated�DEPRECATED_KEY�_validator_changedr� r� r� r� ) rv r� r� r� Zvalidator_kwargsr� r� �cloudinitValidatorr� r� Z is_valid_fnr" r" r% �get_jsonschema_validator� s< �� �� r� r� c C s| ddl m} z| �|� W n\ |yv } zD|rVttd�dd� |jD ��|j�gd�|�t� d|� W Y d}~n d}~0 0 dS ) a Validate provided schema meets the metaschema definition. Return strict Validator and FormatChecker for use in validation @param validator: Draft4Validator instance used to validate the schema @param schema: schema to validate @param throw: Sometimes the validator and checker are required, even if the schema is invalid. Toggle for whether to raise SchemaValidationError or log warnings. @raises: ImportError when jsonschema is not present @raises: SchemaValidationError when the schema is invalid r )� SchemaError�.c S s g | ] }t |��qS r" �r/ �r# r^ r" r" r% r& ' r' z3validate_cloudconfig_metaschema.<locals>.<listcomp>�rf zGMeta-schema validation failed, attempting to validate config anyway: %sN) r� r� Z check_schemard r= r` r> r3 �LOG�warning)r� r� �throwr� r� r" r" r% � validate_cloudconfig_metaschema s" �����r� )�network_configr@ c C s d| v r| d � d�S | � d�S )z6Return the version of the network schema when present.�networkr4 )r� )r� r" r" r% �network_schema_version2 s r� )r� �strictr� � log_detailsr@ c C sR t rt�d� nt�d� dS t� }tj�|d�}t| �}d|vrJd|i}t� |�}t ||dd� t � }g } z|� |� W nJ t y� } z2| �tdj| j| jd �d | j� ��� W Y d } ~ n d } ~ 0 0 tj�|�r�t�|� | �rN|�r|�rt�|�\} } tt|| | d �� t| ��|�r6t| t j j � d �dd�} nt j j � d�} t� | � dS )aj On systems with netplan, validate network_config schema for file Leverage NetplanParser for error annotation line, column and detailed errors. @param network_config: Dict of network configuration settings validated against @param strict: Boolean, when True raise SchemaValidationErrors instead of logging warnings. @param annotate: Boolean, when True, print original network_config_file content with error annotations @param log_details: Boolean, when True logs details of validation errors. If there are concerns about logging sensitive userdata, this should be set to False. @return: True when schema validation was performed. False when not on a system with netplan and netplan python support. @raises: SchemaValidationError when netplan's parser raises NetplanParserExceptions. z*Validating network-config with netplan APIz<Skipping netplan schema validation. No netplan API availableFz etc/netplan/network-config.yamlr� i� )�mode�format-l{line}.c{col}��line�colzInvalid netplan schema. Nr� � failed schema validation! � rZ �^ failed schema validation! You may run 'sudo cloud-init schema --system' to check the details.T) �LIBNETPLAN_AVAILABLEr� �debugr �osr> r` r r �dumpsr r Zload_yaml_hierarchyr r� r= rC r� �columnr3 �exists�shutil�rmtree�load_with_marks�print�annotated_cloudconfig_filerd rc rD rH rM r� )r� r� r� r� Z parse_dirZ netplan_fileZnet_cfgZ src_content�parserr� r� �_�marksr3 r" r" r% � netplan_validate_network_schema9 s` � �� �� � � r� zValidating schema)r� r� rT r� �strict_metaschemar� �log_deprecationsr@ c C sF ddl m} |tjkrDt| �}|dkr.tj}n|dkr<tj}t|�}|tjkrjt| ||d�r`dS |� rjdS |du rzt|�}z t � \} } |r�t | |dd � W n t y� t � d � Y dS 0 | || � d �} g } g } g }t| �| �d d � d�D ]�}d�dd� |jD ��}|�s>|jdk�r>|j|k�r>t�d|j�}|�r>|d }t|t��r�|jdk�sht�|jt j ��r|| � t ||j�� n|� t ||j�� q�| � t ||j�� q�|�r�|�r�t |dd�}t �!|� | �r�t | dd�}t �"|� |�r| �s�| �s�|�rt#| | | ��| �rB|�r,t | |j$� d�dd�}n |j$� d�}t �%|� dS ) aP Validate provided config meets the schema definition. @param config: Dict of cloud configuration settings validated against schema. Ignored if strict_metaschema=True @param schema: jsonschema dict describing the supported schema definition for the cloud config module (config.cc_*). If None, validate against global schema. @param schema_type: Optional SchemaType. One of: SchemaType.CLOUD_CONFIG or SchemaType.NETWORK_CONFIG_V1 or SchemaType.NETWORK_CONFIG_V2 Default: SchemaType.CLOUD_CONFIG @param strict: Boolean, when True raise SchemaValidationErrors instead of logging warnings. @param strict_metaschema: Boolean, when True validates schema using strict metaschema definition at runtime (currently unused) @param log_details: Boolean, when True logs details of validation errors. If there are concerns about logging sensitive userdata, this should be set to False. @param log_deprecations: Controls whether to log deprecations or not. @raises: SchemaValidationError when provided config does not validate against the provided schema. @raises: RuntimeError when provided config sourced from YAML is not a dict. @raises: ValueError on invalid schema_type not in CLOUD_CONFIG or NETWORK_CONFIG_V1 or NETWORK_CONFIG_V2 r �� available� � )r� r� r� TFN)r� z5Ignoring schema validation. jsonschema is not present)Zformat_checkerc S s | j S r5 )r> r� r" r" r% r_ � r' z-validate_cloudconfig_schema.<locals>.<lambda>r� r� c S s g | ] }t |��qS r" r� r� r" r" r% r& � r' z/validate_cloudconfig_schema.<locals>.<listcomp>r� z#.*\('(?P<name>.*)' was unexpected\)�namer� z"Deprecated cloud-config provided: rj r� r� rZ r� )&�cloudinit.net.netplanr rD rH r� rJ rI � get_schemar� r� r� ry r� r� rk r� r` r> r� r� �re�matchr3 r| r2 r4 r Zshould_log_deprecationr ZDEPRECATION_INFO_BOUNDARYr� r= rc �infor rd rM r� )r� r� rT r� r� r� r� �netplan_available�network_versionr� r� r� r� r� Zinfo_deprecations� schema_errorr> Z prop_matchr3 �detailsr" r" r% �validate_cloudconfig_schema� s� $ � � � �������� �� � � � r c @ s� e Zd Zeed�dd�Zeeee ed�dd��Ze d�dd �Z edee ee ee e ee d �d d ��Z ee eeee d�dd�Z e e ed�dd�ZdS )� _Annotator)�original_content� schemamarksc C s || _ || _d S r5 )�_original_content� _schemamarks)r8 r r r" r" r% r7 ) s z_Annotator.__init__)�titlerX r@ c C s d� |�}d| � d|� d�S )Nr� �# z: ------------- ri )r` )r rX �bodyr" r" r% � _build_footer1 s z_Annotator._build_footer)r] c C sz t t�}|D ]h\}}t�d|�}|rD|�� \}}|t|� �|� nd }|| j| �|� |d ur dj|||d�}q |S )Nz&format-l(?P<line>\d+)\.c(?P<col>\d+).*z Line {line} column {col}: {msg})r� r� r� ) r rl r r �groups�intr� r rC )r8 r] �errors_by_liner> r� r r� r� r" r" r% �_build_errors_by_line6 s �z _Annotator._build_errors_by_linerh )rn �labels�footerr� � label_prefixr@ c C sB | D ]8}|� |� �}|� |� |� d|� d|� �� |d7 }q|S )Nr rA r )r� )rn r r r� r Zproblemr� r" r" r% � _add_problemsF s z_Annotator._add_problems)�linesr �deprecations_by_liner@ c s� g }g }g }d}d}t |d�D ]p\} } || } || } | s>| r�g } � j| | ||dd�}� j| | ||dd�}|�| d d�| � � q |�| � q |�t� fdd�td d� d |fd |ff��� |S ) Nr �E)r �Dz # �,c s � j | � S r5 )r ��seqrB r" r% r_ u r' z._Annotator._annotate_content.<locals>.<lambda>c S s t | d �S )Nr )rr r$ r" r" r% r_ w r' ZErrorsZ Deprecations)r� r r� r` r� ra r� )r8 r r r �annotated_contentZ error_footerZdeprecation_footerZ error_indexZdeprecation_indexZ line_numberr� r� r� r r" rB r% �_annotate_contentU sD �� ���� z _Annotator._annotate_content)rf rg r@ c C sF |s|s| j S | j �d�}| �|�}| �|�}| �|||�}d�|�S )Nr� )r �splitr r' r` )r8 rf rg r r r r& r" r" r% r� � s �z_Annotator.annotateN)rh )r, r- r. r/ r� r7 � staticmethodr r rt r r r r' r� r" r" r" r% r ( s2 � ��� .�r re )r r rf rg r@ c C s t | |��|pg |pg �S )a� Return contents of the cloud-config file annotated with schema errors. @param cloudconfig: YAML-loaded dict from the original_content or empty dict if unparsable. @param original_content: The contents of a cloud-config file @param schemamarks: Dict with schema marks. @param schema_errors: Instance of `SchemaProblems`. @param schema_deprecations: Instance of `SchemaProblems`. @return Annotated schema )r r� )r r rf rg r" r" r% r� � s �r� )rX r@ c C sb ddl m} || vrg S g }t| �� d�D ]2\}}|�|�r*|�td|� d�|�|d��� q*|S )a� Annotate and return schema validation errors in merged cloud-config.txt When merging multiple cloud-config parts cloud-init logs an error and ignores any user-data parts which are declared as #cloud-config but cannot be processed. the handler.cloud_config module also leaves comments in the final merged config for every invalid part file which begin with MERGED_CONFIG_SCHEMA_ERROR_PREFIX to aid in triage. r )� MERGED_PART_SCHEMA_ERROR_PREFIXr zformat-lz.c1zIgnored invalid user-data: )Z cloudinit.handlers.cloud_configr* r� � splitlines� startswithr� r= �replace)rX r* r� Zline_numr� r" r" r% �)process_merged_cloud_config_part_problems� s ��� r. )rU rX �instance_data_pathr@ c C sL ddl m}m}m}m} t|�}d}|dkr�z||| |�}W n� |yr } z tt|d�g�| �W Y d} ~ nrd} ~ 0 |y� } z tdt | � dd � W Y d} ~ n<d} ~ 0 |y� } z tt | �dd � W Y d} ~ n d} ~ 0 0 d }t|�}|�s(|� d �\} } } t t|d | � d | � dd� t �� ��g��n|dk�rBtd|� d�� t||�S )a� Return tuple of user-data-type and rendered content. When encountering jinja user-data, render said content. :return: UserDataTypeAndDecodedContent :raises: SchemaValidationError when non-jinja content found but header declared ## template: jinja. :raises JinjaSyntaxParsingException when jinja syntax error found. :raises JinjaLoadError when jinja template fails to load. r )�JinjaLoadError�JinjaSyntaxParsingException� NotJinjaError� render_jinja_payload_from_filez format-l1.c1z text/jinja2zRDetected type '{user_data_type}' from header. But, content is not a jinja templateNz&Failed to render templated user-data. T��sys_exitz format-l2.c1r� z!Unrecognized user-data header in z: "z%". Expected first line to be one of: rY �text/cloud-configzUser-data type 'z.' not currently evaluated by cloud-init schema)Z!cloudinit.handlers.jinja_templater0 r1 r2 r3 r rd r= r r/ � partitionru r` �USERDATA_VALID_HEADERSr� rV ) rU rX r/ r0 r1 r2 r3 Zuser_data_typeZschema_positionr� Z header_liner� r" r" r% �&_get_config_type_and_rendered_userdata� sZ ����� �&����� �r9 )rU r� rT r� r/ r@ c C s� ddl m} t| �}|s.td|j| f � dS |tjfv rHt|j|�}n t| ||�}|j dvrbdS |j }t |�} z&|r�t � |�\} } nt�|�} i } W n� tj�yp } z�d } }d}t| d�r�t| d�r�t| d�}n t| d �r�t| d �r�t| d �}|�r|jd } |jd }| �td j| |d �d �| t| ���� t| �}|�rVtt|i |jd �� || �W Y d} ~ n d} ~ 0 0 t | t ��s�|�s�t |j� d| � d���|tjk�r| � d| ��s�td� dS t | �}|dk�rtj!}t"| d|d��r�dS |� �rtd� dS n|dk�rtj#}t$|�}z0t%| ||ddd��sHtd|j� d�� W dS W n� t�y� } zp| �&� �rp| | j7 } |�r�tt|| | | j'd�� n | j'�r�t(| j'ddd �}t|� | �r�t| d �| �W Y d} ~ n d} ~ 0 0 dS ) a� Validate cloudconfig file adheres to a specific jsonschema. @param config_path: Path to the yaml cloud-config file to parse, or None to default to system userdata from Paths object. @param schema: Dict describing a valid jsonschema to validate against. @param schema_type: One of SchemaType.NETWORK_CONFIG or CLOUD_CONFIG @param annotate: Boolean set True to print original config file with error annotations on the offending lines. @param instance_data_path: Path to instance_data JSON, used for text/jinja rendering. :return: True when validation was performed successfully :raises SchemaValidationError containing any of schema_errors encountered. :raises RuntimeError when config_path does not exist. r r� z,Empty '%s' found at %s. Nothing to validate.F)rE r6 r NZ context_markZ problem_markr� r� z File {0} is not valid YAML. {1}r� r� z is not a YAML dict.r� z:Skipping network-config schema validation on empty config.r T)r� r� r� zSSkipping network-config schema validation for version: 2. No netplan API available.)r� rT r� r� z Skipping z2 schema validation. Jsonschema dependency missing.re rq rY rZ ))r r r r� rM rD rH rV r9 rW rX r. r r� �yamlZ safe_loadZ YAMLErrorr� �getattrr� r� r� r= rC r/ rd r� rf r| r� � RuntimeErrorr� r� rJ r� rI r r rs rg rc )rU r� rT r� r/ r Zdecoded_contentZdecoded_configrX r� Z cloudconfigr� r� r� r� Zmarkr r r3 r" r" r% �validate_cloudconfig_file s� �� �� ���� � �� � � ���"r= c C s t j�t j�t j�t��d�S )NZschemas)r� r> r` �dirname�abspath�__file__r" r" r" r% �get_schema_dir� s rA )rT r@ c C s^ t j�t� t| d �}d}zt�t|��}W n* tt fyX t � d| j |� i Y S 0 |S )ziReturn jsonschema for a specific type. Return empty schema when no specific schema file exists. rK Nz<Skipping %s schema validation. No JSON schema file found %s.) r� r> r` rA �SCHEMA_FILES_BY_TYPE�json�loadsr �IOError�OSErrorr� r� rM )rT Z schema_file� full_schemar" r" r% r � s �� r c C s� | st jddd�} | jdddd� | jdd ttjjtjjgd tj� �d � | jd d tdt� � d�� �d� | jddddd� | jddddd� | S )z0Return a parser for supported cmdline arguments.�cloudconfig-schemaz�Schema validation and documentation of instance-data configuration provided to cloud-init. This includes: user-data, vendor-data and network-config)�progr� z-cz --config-filez@Path of the cloud-config or network-config YAML file to validate)�helpz-tz --schema-typezSWhen providing --config-file, the schema type to validate config against. Default: )r� �choicesrJ z-iz--instance-datazbPath to instance-data.json file for variable expansion of '##template: jinja' user-data. Default: � instance_data)r� rJ z--system� store_trueFzVValidate the system instance-data provided as vendor-data user-data and network-config)�action�defaultrJ z --annotatez;Annotate existing instance-data files any discovered errors) �argparse�ArgumentParser� add_argumentr/ rD rG rM rH r � get_runpath�r� r" r" r% � get_parser� sT ����� �� � �rU c C sF | j | jg}tdd� |D ��dkr.tddd� | jrB| jrBtd� dS ) z:Error or warn on invalid exclusive parameter combinations.c S s g | ] }|r|�qS r" r" )r# �argr" r" r% r& � r' z*_assert_exclusive_args.<locals>.<listcomp>r z3Expected one of --config-file or --system argumentsTr4 zMWARNING: The --schema-type parameter is inapplicable when --system is presentN)� config_file�systemr� r rT r� )�argsZexclusive_argsr" r" r% �_assert_exclusive_args� s � �rZ c C s� t tttd�dd�}ztdd�}W nf ttfyh } z*|jtkrRt�d� t� }n� W Y d}~n*d}~0 t y� t� }t� d� Y n0 | j r�| j }n"t � � d kr�|�d �}n |�d �}g }| j�r | jr�t| j�}ntj}|tjkr�tj}ntj}|�t||| j�� n�t � � d k�r&td d d� ||dd�}|�ttjtj|�� ttjtj||dd��ttjtj||dd��ttjtj|�d��p�d�g} | D ](} | j �r�t j � | j ��r�|�| � �q�t j � |d j ��s�td|d j � d�dd d� ||fS )a Return appropriate instance-data.json and instance data parts Based on command line args, and user permissions, determine the appropriate instance-data.json to source for jinja templates and a list of applicable InstanceDataParts such as user-data, vendor-data and network-config for which to validate schema. Avoid returning any InstanceDataParts when the expected config_path does not exist. :return: A tuple of the instance-data.json path and a list of viable InstanceDataParts present on the system. )�paths�primary_path_key�raw_fallback_path_keyr@ c S sr | � |�p d}tt��H t�|�jsP| � |�p0d}t�|�jrP|W d � S W d � n1 sd0 Y |S )ak Get processed data path when non-empty of fallback to raw data path. - When primary path and raw path exist and are empty, prefer primary path. - When primary path is empty but the raw fallback path is non-empty, this indicates an invalid and ignored raw user-data was provided and cloud-init emitted a warning and did not process unknown raw user-data. In the case of invalid raw user-data header, prefer raw_fallback_path_key so actionable sensible warnings can be reported to the user about the raw unparsable user-data. rh N)� get_ipathr �FileNotFoundErrorr� �stat�st_size)r[ r\ r] Zprimary_datapathZraw_pathr" r" r% � get_processed_or_fallback_path s 0zBget_config_paths_from_args.<locals>.get_processed_or_fallback_pathZtrust)Zfetch_existing_datasourcez=Using default instance-data/user-data paths for non-root userNzEdatasource not detected, using default instance-data/user-data paths.r rL Zinstance_data_sensitivezNUnable to read system userdata or vendordata as non-root user. Try using sudo.Tr4 Z cloud_configZ userdata_rawZvendor_cloud_configZvendordata_rawZvendor2_cloud_configZvendordata2_rawr� rh z Config file z does not existz Error: {}��fmtr5 ) r r/ r rE rF �errnor r� r� r r� rL r� �getuidrS rW rT rD rG rH rL rO r� rR r rP rQ r^ rU r> r� ) rY rb r[ r� r/ � config_filesrT Zinstancedata_typeZ userdata_fileZsupplemental_config_filesZ data_partr" r" r% �get_config_paths_from_args� s� � � � ������������rh c C s� t |� t� }t|�\}}d}tt|�dk�}|rRtdd�dd� |D �� � d}g }t|d�D �]Z\}} d} |r�td |� d | j� d | j � d �� | j t j kr�t| j �} n|} zt | j | | j |j|�} W n� t�y2 } zP|j�st|� d | j� d| j � �� tt| �|d d� |�| j� W Y d} ~ q`d} ~ 0 t�y� } z@t|� d | j��� tt| �|d d� |�| j� W Y d} ~ q`d} ~ 0 0 | r`|j�r�| j } n t| j�} t|� d| ��� q`|�r�td�dd� |D ��ddd� dS )z@Handle provided schema args and perform the appropriate actions.rh r z!Found cloud-config data types: %srY c s s | ]}t |j�V qd S r5 )r/ rS )r# �cfg_partr" r" r% r� � r' z%handle_schema_args.<locals>.<genexpr>z Fr� r� z at �:zInvalid r� z Error: {} )rd Nz Valid schema c s s | ]}t |�V qd S r5 r� )r# r� r" r" r% r� � r' zError: Invalid schema: {} Trc )rZ r rh rr r� r� r` r� rS rU rT rD rH r= r� rd r r/ r� r< rW )r rY rG r/ rg Znested_output_prefixZmulti_config_outputZ error_types�idxri Zperformed_schema_validationZ cfg_schemar� Zcfgr" r" r% �handle_schema_argsx sv ��� ����� " �rl c C s t � } td| �� � dS )zDTool to validate schema of a cloud-config file or print schema docs.rH r )rU rl � parse_argsrT r" r" r% �main� s rn �__main__)FN)T)FFT)N)N)yrF rP rC Zloggingr� r r� �sys� collectionsr � contextlibr �copyr r� r re r � functoolsr r1 r r r r r r r r r: Z cloudinitr r r r Zcloudinit.cmd.develr Zcloudinit.handlersr r Zcloudinit.helpersr Zcloudinit.log.log_utilr Zcloudinit.sourcesr Zcloudinit.temp_utilsr Zcloudinit.utilr r rx r ry � ExceptionZnetplanr r r� Z getLoggerr, r� ZUSERDATA_SCHEMA_FILEZ NETWORK_CONFIG_V1_SCHEMA_FILEZ NETWORK_CONFIG_V2_SCHEMA_FILEr� rk �keysr8 Ztyping_extensionsr( r) r* r� r2 r= rt rD rG rH rI rJ rB rL rR rV r/ rc � ValueErrorrd ru r r� r� rr r� r� r� r� r� r� r� r r� r� Ztimedr r r} r� r. r9 r= rA r rU rZ rh rl rn �exitr" r" r" r% �<module> sX ( � ����� �� ) �� #'�� �� H�� *V# �� _�� m� � � ! �� H�� ;� }@