| Server IP : 3.7.136.76 / Your IP : 216.73.216.142 Web Server : Apache/2.4.58 (Ubuntu) System : Linux ip-172-31-39-148 7.0.0-1010-aws #10~24.04.1-Ubuntu SMP PREEMPT Mon Jul 27 17:41:33 UTC 2026 x86_64 User : ubuntu ( 1000) PHP Version : 8.3.6 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /snap/core22/2987/usr/lib/python3/dist-packages/cloudinit/config/__pycache__/ |
Upload File : |
o
� �i
� � @ s6 d Z ddlZddlZddlZddlZddlZddlZddlZddlZ ddl
m Z ddl m
Z
ddlmZ ddlmZ ddlmZ ddlmZ dd lmZmZmZmZmZm Z m Z m 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/ ddl0m1Z1 ddl2m3Z3m4Z4 zddl5m6Z6 W n e7y� e8Z6Y nw z ddl9m:Z:m;Z; dZ<W n e7y� dZ<Y nw e�=e>�Z?dZ@dZAdZBdZCdZDeEdd � e(�F� D ��ZGer�ddlZdd lHmIZImJZJ G d d � d eJ�ZKneLZKG d d!� d!e6�ZMG d"d#� d#e�ZNeeN ZOG d$d%� d%e�ZPePjQd&eAiePjRd&eCiePjSd&eBiePjTd&eCiiZUG d'd(� d(e�ZVG d)d*� d*e�ZWG d+d,� d,e�ZXdd-d.�d/eOd0eeY d1eYd2eYfd3d4�ZZG d5d6� d6e[�Z\G d7d8� d8e\�Z]d9d:� Z^ d�d;eLd2eYfd<d=�Z_d2ee6 fd>d?�Z`eMfdead@eLdAeYdBe e8 fdCdD�ZbeMfdBe e8 fdEdF�ZceMfdBe e8 fdGdH�ZddIdJ� Zed�d@eLfdKdL�ZfdMeLd2eeg fdNdO�Zh d�dMeLdPeadQeadRead2eaf
dSdT�ZidUdV� Zjd@eLdWeafdXdY�Zke#�ldZ�dePjQddddfd;eLd@eeL d[ePdPeadWeadRead\ead2eafd]d^��ZmG d_d`� d`�Znddda�dbeYdceLddeeO deeeO d2e eYeof f
dfdg�ZpdheYd2eeN fdidj�Zq d�dkeYdheYdleeY d2eXfdmdn�ZrePjQddfdkeYd@eLd[ePdQeadleeY d2eaf dodp�Zsd2eYfdqdr�ZtePjQfd[ePd2eLfdsdt�Zud�dudv�Zvdwdx� Zwd2e eYeeW f fdydz�Zxd{d|� Zyd2eYfd}d~�Zzdd�� Z{e>d�k�r�e�|e{� � dS dS )�zFschema.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�ParserTFzUhttps://raw.githubusercontent.com/canonical/cloud-init/main/cloudinit/config/schemas/zschema-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" �9/usr/lib/python3/dist-packages/cloudinit/config/schema.py�
<listcomp>J s r& )� NotRequired� TypedDictc @ s< e Zd ZU eed< eje ed< eed< eee ed< dS )�
MetaSchema�id�distros� frequency�activate_by_schema_keysN)�__name__�
__module__� __qualname__�str�__annotations__�typingr
r' r" r" r" r% r) T s
r) c s& e Zd Zdedef� fdd� Z� ZS )�SchemaDeprecationError�message�versionc s t � j|fi |�� || _d S �N)�super�__init__r6 )�selfr5 r6 �kwargs�� __class__r" r% r9 _ s
z SchemaDeprecationError.__init__)r. r/ r0 r1 r9 �
__classcell__r" r" r< r% r4 ^ s ��r4 c @ s, e Zd ZU eed< eed< defdd�ZdS )�
SchemaProblem�pathr5 �returnc C s | j � d| j� �S )N�: )r@ r5 �r: r" r" r% �formatm s zSchemaProblem.formatN)r. r/ r0 r1 r2 rD r" r" r" r% r? i 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/ r0 �__doc__� CLOUD_CONFIG�NETWORK_CONFIG�NETWORK_CONFIG_V1�NETWORK_CONFIG_V2r" r" r" r% rE t s rE �latestc @ s( e Zd ZdZdZdZdZdZdd� ZdS ) �InstanceDataTypez-Types of instance data provided to cloud-initz user-datarF z vendor-dataz vendor2-datac C � | j S r7 )�valuerC r" r" r% �__str__� s zInstanceDataType.__str__N) r. r/ r0 rG �USERDATArI �
VENDORDATA� VENDOR2DATArP r" r" r" r% rM � s rM c @ s& e Zd ZU eed< eed< eed< dS )�InstanceDataPart� config_type� schema_type� config_pathN)r. r/ r0 rM r2 rE r1 r" r" r" r% rT � s
rT c @ s e Zd ZU eed< eed< dS )� UserDataTypeAndDecodedContent�
userdata_type�contentN)r. r/ r0 r1 r2 r" r" r" r% rX � s
rX �, ��prefix� separator�schema_problemsr] r^ rA c C s( |� tdd� | ��}|r|� |� �}|S )Nc S s | � � S r7 )rD )�pr" r" r% �<lambda>� s z)_format_schema_problems.<locals>.<lambda>)�join�map)r_ r] r^ � formattedr" r" r% �_format_schema_problems� s re c sF e Zd ZdZ d
dee dee f� fdd�
Zdefdd �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�setre )�problemsr] �r5 r" r% �handle_problems� s z7SchemaValidationError.__init__.<locals>.handle_problemsz Cloud config schema errors: rk �"Cloud config schema deprecations: N)rg rh r8 r9 )r: rg rh rq r< rp r% r9 � s
��z SchemaValidationError.__init__rA c C s
t | j�S r7 )�boolrg rC r" r" r% �
has_errors� s
z SchemaValidationError.has_errors)NN)
r. r/ r0 rG r �SchemaProblemsr9 rs rt r> r" r" r< r% rf � s ���"rf c @ s e Zd ZdZdS )�"SchemaValidationInvalidHeaderErrorz>Raised when no valid header is declared in the user-data file.N)r. r/ r0 rG r" r" r" r% rv � s rv c C s@ zddl m} W n
ty Y dS w |j�|d�p t|tf�S )zWTYPE_CHECKER override allowing bytes for string type
For jsonschema v. 3.0.0+
r )�Draft4ValidatorF�string)�
jsonschemarw � ImportError� TYPE_CHECKER�is_type�
isinstance�bytes)�checker�instancerw r" r" r% �is_schema_byte_string� s ��
�r� �configc sP dt f� �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|� �}� r1d|� �S d |�� � d
�S ) Nri � _description�_versionz <missing z'_version key, please file a bug report>z in version �. � z
*�*)�get�
capitalize�strip)r� �key_description�v�msg��annotater� r" r% �format_message� s
�
z:_add_deprecated_changed_or_new_msg.<locals>.format_message)r �changed�newri � description)r1 rb rc r� �rstrip)r� r� �
filter_keyr� � filter_keys�changed_new_deprecatedr� r" r� r% �"_add_deprecated_changed_or_new_msg� s � r� c C s� g }d}t |t�o d|v }| D ]\}|rO|d |j�di ��di ��dg �v r+|g S t|d�r?|jdd� dkr>|�|� q|jrN|jd dkrN|�|� qt|j�|kr\|�|� qt|j�|krkt|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� � best_matches�
path_depthr| �errr" r" r% �cloud_init_deepest_matches s2 ��
�
�
�r� r� r� �
error_typec c s2 � |rt |d|gd�}|||�dd��V dS 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� �deprecated_version�develN)r� r� )�
_validatorr � _instancer� r� r� r� r" r" r% r� 7 s �
��r� c # s� � ddl m} g }g }d}t|�D ]U\} }
t| j||
| d��} tt� fdd�| ��} tt� fdd�| ��}
| s>|�|
� n:t|t�rad|v rad |
� d
d �v rad |d � �|
d
v rad
}| E dH |�| � q|sn||�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�� schema_pathc � t | � � S r7 �r} ��e�r� r" r% ra r � z_anyOf.<locals>.<lambda>c �
t | � �S r7 r� r� r� r" r% ra t �
r� �
anyOf_typez$refri � anyOf_type_TNz.%r is not valid under any of the given schemas)�context) �jsonschema.exceptionsr� � enumeraterm �descend�filter�extendr} r� r� r )� validator�anyOfr� �_schemar� r� �
all_errors�all_deprecations�skip_best_match�index� subschema�all_errs�errs� deprecationsr" r� r% �_anyOfK s> � ��
�
�r� c # s� � t |�}g }g }|D ]4\}} t�j�| |d��}
tt� fdd�|
��} tt� fdd�|
��} | s:| }
|�| � n|�| � q t|��E dH ��fdd�|D �}|rn|�|
� d�d d
� |D ��}td �|f �V dS |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 r� r7 r� r� r� r" r% ra � r� z_oneOf.<locals>.<lambda>c r� r7 r� r� r� r" r% ra � r� Nc s g | ] \}}�� � |�r|�qS r" )�is_valid)r# �i�s)r� r� r" r% r& � s z_oneOf.<locals>.<listcomp>r[ c s � � | ]}t |�V qd S r7 )�repr)r# r� r" r" r% � <genexpr>� � � z_oneOf.<locals>.<genexpr>z %r is valid under each of %s) r� rm r� r� r� r� r� rb r )r� �oneOfr� r� r� �
subschemasr� r� r� r� r� r� r� � first_valid�
more_valid�reprsr" )r� r� r� r% �_oneOf� s4 � ��
�r� c C s� ddl m} m} ddlm} t| j�}ddi|d d< i }d|d < | j�dt �}d
|i}t
| j �}t t
d d �|t< t t
d
d �|d
< t|d< t|d< |d||dd�|��}ddd�}ddd�} |}
t|d�rg| }
|
|_||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 )rw �
FormatChecker)�creater� rx r� �labelF�additionalProperties� type_checkerr )r� r� r� r� �draft4)� meta_schema�
validatorsr6 Nc [ s$ t dd� | �||��}t|d�du S )�gOverride version of `is_valid`.
It does ignore instances of `SchemaDeprecationError`.
c S � t | t� S r7 �r} r4 r� r" r" r% ra � � �zFget_jsonschema_validator.<locals>.is_valid_pre_4_0_0.<locals>.<lambda>N)r� � iter_errors�next)r: r� r� �__r� r" r" r% �is_valid_pre_4_0_0� s
�z4get_jsonschema_validator.<locals>.is_valid_pre_4_0_0c [ s: |du r| n| j |d�}tdd� |�|��}t|d�du S )r� N)r� c S r� r7 r� r� r" r" r% ra � r� z<get_jsonschema_validator.<locals>.is_valid.<locals>.<lambda>)�evolver� r� r� )r: r� r� r� r� r� r" r" r% r� � s �z*get_jsonschema_validator.<locals>.is_validr� r" r7 )ry rw r� �jsonschema.validatorsr� r � META_SCHEMAr{ �redefiner� r� �
VALIDATORSr r� �DEPRECATED_KEYr� r� r� r� ) rw r� r� r� �validator_kwargsr� r� �cloudinitValidatorr� r� � is_valid_fnr" r" r% �get_jsonschema_validator� s<
��
��
r� c
C s| ddl m} z| �|� W dS |y= } z#|r,ttd�dd� |jD ��|j�gd�|�t� d|� W Y d}~dS d}~ww ) 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 � g | ]}t |��qS r" �r1 �r# r` r" r" r% r& ' � z3validate_cloudconfig_metaschema.<locals>.<listcomp>�rg zGMeta-schema validation failed, attempting to validate config anyway: %sN)
r� r� � check_schemarf r? rb r@ r5 �LOG�warning)r� r� �throwr� r� r" r" r% � validate_cloudconfig_metaschema s&
�������r� �network_configc C s d| v r | d � d�S | � d�S )z6Return the version of the network schema when present.�networkr6 )r� )r r" r" r% �network_schema_version2 s
r �strictr� � log_detailsc
C sJ t rt�d� nt�d� dS t� }tj�|d�}t| �}d|vr%d|i}t� |�}t
||dd� t � }g } z|� |� W n% t
yb }
z| �tdj|
j|
jd �d
|
j� ��� W Y d }
~
nd }
~
ww tj�|�rnt�|� | r�|r�|r�t�|�\} } tt|| | d �� t| ��|r�t| 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!
�
r\ �^ failed schema validation! You may run 'sudo cloud-init schema --system' to check the details.T) �LIBNETPLAN_AVAILABLEr� �debugr �osr@ rb r r �dumpsr r �load_yaml_hierarchyr r� r? rD r �columnr5 �exists�shutil�rmtree�load_with_marks�print�annotated_cloudconfig_filerf re rE rI rO r� )r r r� r � parse_dir� netplan_file�net_cfg� src_content�parserr� r� �_�marksr5 r" r" r% � netplan_validate_network_schema9 sd �
����
�� �
�
r c C s^ ddl }ddl}tj�| �}|jdkrtj�|j�}n |j� d| � ���|j
� t �
t|���S )z3Retrieve a "referencing" Resource from a given URI.r N�filezUnsupported URI: )� referencing�referencing.exceptions�urllib�parse�urlparse�scheme�unquoter@ �
exceptions�NoSuchResource�Resource�
from_contents�json�loadsr )�urir" �parsed�
local_pathr" r" r% �_resource_retriever� s
�r2 �strict_metaschemac C s� zt � \}}|rt|| dd� W n ty t�d� Y dS w zddl}|jtd�}|| |� |d�}W |S tyF || |� d�}Y |S w ) z1Get a JSON schema validator for the given schema.F)r� z5Ignoring schema validation. jsonschema is not presentNr )�retrieve)�format_checker�registry)r5 )r� r� rz r� r r" �Registryr2 )r� r3 r� r� r" r6 r� r" r" r% �_get_validator� s,
��
� � ��r8 zValidating schemarV �log_deprecationsc C s� ddl m} |tjkr"t| �}|dkrtj}n|dkr tj}t|�}|tjkr5t| ||d�r0dS |� r5dS |du r=t|�}t ||�} | sFdS g }
g } g } t
| � | �d d
� d �D ]U}
d � d
d� |
j
D ��}|s}|
jdkr}|
j|kr}t�d|
j�}|r}|d }t|
t�r�|
jdks�t�|
jtj�r�| �t||
j�� qW| �t||
j�� qW|
�t||
j�� qW|r�| r�t | dd�}t � |� | r�t | dd�}t � |� |r�|
s�| s�| r�t |
| | ��|
r�|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 TFNc S rN r7 )r@ r� r" r" r% ra s z-validate_cloudconfig_schema.<locals>.<lambda>)r� r� c S r� 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: rk r
r r\ r )#�cloudinit.net.netplanr; rE rI r rK rJ �
get_schemar r8 rl r� rb r@ r� r� �re�matchr5 r} r4 r6 r �should_log_deprecationr �DEPRECATION_INFO_BOUNDARYr� r? re r� �infor rf rO r� )r� r� rV r r3 r r9 �netplan_available�network_versionr� r� r� �info_deprecations� schema_errorr@ �
prop_matchr5 �detailsr" r" r% �validate_cloudconfig_schema� s� $
�
��
��
��
��
�
�
�
rL c @ s� e Zd Zdedefdd�Zededee defdd ��Zd
e fd d �Z
e
d dee dee dee de dede f dd��Z dee dededee fdd�Z
de de defd d �Zd S ) �
_Annotator�original_content� schemamarksc C s || _ || _d S r7 )�_original_content� _schemamarks)r: rN rO r" r" r% r9 N s
z_Annotator.__init__�titlerZ rA c C s d� |�}d| � d|� d�S )Nr �# z: -------------
rj )rb )rR rZ �bodyr" r" r% �
_build_footerV s
z_Annotator._build_footerr_ c C sz t t�}|D ]4\}}t�d|�}|r"|�� \}}|t|� �|� n d }|| 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 rm rA rB �groups�intr� rQ rD )r: r_ �errors_by_liner@ r� rB r r r" r" r% �_build_errors_by_line[ s ��z _Annotator._build_errors_by_lineri ro �labels�footerr� � label_prefixc C sB | D ] }|� |� �}|� |� |� d|� d|� �� |d7 }q|S )NrS rB r= )r� )ro rZ r[ r� r\ �problemr� r" r" r% �
_add_problemsk s
z_Annotator._add_problems�linesrX �deprecations_by_linec s� g }g }g }d}d}t |d�D ]8\} }
|| } || } | s | rBg }
� j| |
||dd�}� j| |
||dd�}|�|
d d�|
� � q|�|
� q|�t� fdd�td d� d
|fd |ff��� |S ) Nr= �E)r\ �Dz # �,c s
� j | � S r7 )rU ��seqrC r" r% ra � r� z._Annotator._annotate_content.<locals>.<lambda>c S s t | d �S )Nr= )rs rd r" r" r% ra � r� �Errors� Deprecations)r� r^ r� rb r� rc r� )r: r_ rX r` �annotated_content� error_footer�deprecation_footer� error_index�deprecation_index� line_numberr r� r� rZ r" rC r% �_annotate_contentz sD
��
���� z _Annotator._annotate_contentrg rh c C sF |s|s| j S | j �d�}| �|�}| �|�}| �|||�}d�|�S )Nr )rP �splitrY rn rb )r: rg rh r_ rX r` rh r" r" r% r� � s
�
z_Annotator.annotateN)ri )r. r/ r0 r1 r� r9 � staticmethodr
rU ru rY rW r^ rn r� r" r" r" r% rM M sP �
� ������ ����
�,���rM �rg rh rN rO rg rh c C s t | |��|pg |p g �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
)rM r� )rN rO rg rh r" r" r% r � s
�r rZ c C sb ddl m} || vr g S g }t| �� d�D ]\}}|�|�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: )� cloudinit.handlers.cloud_configrr r� �
splitlines�
startswithr� r? �replace)rZ rr r� �line_numr r" r" r% �)process_merged_cloud_config_part_problems� s"
���� rx rW �instance_data_pathc C s: ddl m}m}m}m} t|�}d}|dkrnz||| |�}W nI |y3 } z tt|d�g�| �d} ~ w |yN } ztdt | � dd � W Y d} ~ n d} ~ w |yg } ztt | �dd � W Y d} ~ nd} ~ ww d
}t|�}|s�|�
d �\}
} } t t|d | � d
|
� dd� t
�� ��g��|dkr�td|� 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: r[ �text/cloud-configzUser-data type 'z.' not currently evaluated by cloud-init schema)�!cloudinit.handlers.jinja_templaterz r{ r| r} r rf r? r r1 � partitionrv rb �USERDATA_VALID_HEADERSr rX ) rW rZ ry rz r{ r| r} �user_data_type�schema_positionr� � header_liner r" r" r% �&_get_config_type_and_rendered_userdata� sb ������
�� �������
�
r� c C s� ddl m} t| �}|std|j| f � dS |tjfv r$t|j|�}nt| ||�}|j dvr1dS |j
}t |�} z|rCt �
|�\}
} nt�|�}
i } W nd tjy� } zWd }
}d}t| d�rjt| d�rjt| d�}nt| d �ryt| d �ryt| d �}|r�|jd }
|jd }| �td
j|
|d �d �| t| ���� t| �}|r�tt|i |jd
�� || �d} ~ ww t |
t �s�|s�t |j� d| � d���|tjkr�|
� d|
�s�td� dS t |
�}|dkr�tj!}t"|
d|d�r�dS |� r�td� dS n |dkr�tj#}t$|�}zt%|
||ddd��std|j� d�� W dS W dS t�y[ } z9| �&� �r(| | j7 } |�r7tt|| | | j'd�� n| j'�rGt(| j'ddd �}t|� | �rPt| d
�| �W Y d} ~ dS d} ~ ww ) 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)rF r� r= N� context_mark� 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� rV r r9 z Skipping z2 schema validation. Jsonschema dependency missing.rq rr r[ r\ ))r? r; r r rO rE rI rX r� rY rZ rx r r �yaml� safe_load� YAMLErrorr� �getattrr r r� r? rD r1 rf r rg r} r� � RuntimeErrorr� r rK r rJ r@ rL rt rh re )rW r� rV r� ry rF �decoded_content�decoded_configrZ r� � cloudconfigr r� r r �markrI rG r5 r" r" r% �validate_cloudconfig_file0 s� �� ��
�
������
�
���� ��!�
���
���r� c C s t j�t j�t j�t��d�S )N�schemas)r r@ rb �dirname�abspath�__file__r" r" r" r% �get_schema_dir� s r� c C s\ t j�t� t| d �}d}z
t�t|��}W |S tt fy- t
� d| j |� i Y S w )ziReturn jsonschema for a specific type.
Return empty schema when no specific schema file exists.
rL Nz<Skipping %s schema validation. No JSON schema file found %s.)
r r@ rb r� �SCHEMA_FILES_BY_TYPEr- r. r �IOError�OSErrorr� r� rO )rV � schema_file� full_schemar" r" r% r@ � s ����r@ c C s� | s t 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� �choicesr� z-iz--instance-datazbPath to instance-data.json file for variable expansion of '##template: jinja' user-data. Default: �
instance_data)r� r� z--system�
store_trueFzVValidate the system instance-data provided as vendor-data user-data and network-config)�action�defaultr� z
--annotatez;Annotate existing instance-data files any discovered errors)
�argparse�ArgumentParser� add_argumentr1 rE rH rO rI r � get_runpath�r r" r" r% �
get_parser� sT �����
��
� �r� c C sN | j | jg}tdd� |D ��dkrtddd� | jr#| jr%td� dS dS 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 argumentsTr~ zMWARNING: The --schema-type parameter is inapplicable when --system is presentN)� config_file�systemr� r rV r )�args�exclusive_argsr" r" r% �_assert_exclusive_args s � ��r� c
C s� dt dtdtdtfdd�}ztdd�}W n3 ttfy7 } z|jtkr,t�d � t� }n� W Y d
}~nd
}~w t yG t� }t�
d � Y nw | j rO| j }nt �
� d kr[|�d
�}n|�d�}g }| jr�| jrnt| j�}ntj}|tjkrztj}ntj}|�t||| j�� nUt �
� d kr�tddd� ||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�d dd � ||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_keyrA c S s� | � |�pd}tt��- t�|�js(| � |�pd}t�|�jr0|W d � S W d � |S W d � |S 1 s;w 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.
ri N)� get_ipathr �FileNotFoundErrorr �stat�st_size)r� r� r� �primary_datapath�raw_pathr" r" r% � get_processed_or_fallback_path/ s
�
��
��zBget_config_paths_from_args.<locals>.get_processed_or_fallback_path�trust)�fetch_existing_datasourcez=Using default instance-data/user-data paths for non-root userNzEdatasource not detected, using default instance-data/user-data paths.r r� �instance_data_sensitivezNUnable to read system userdata or vendordata as non-root user. Try using sudo.Tr~ � cloud_config� userdata_raw�vendor_cloud_config�vendordata_raw�vendor2_cloud_config�vendordata2_rawr ri z Config file z does not existz Error: {}��fmtr ) r r1 r r� r� �errnor r� r r r� r� r �getuidr� r� rV rE rH rI rM rQ r� rT r rR rS r� rW r@ r ) r� r� r� r� ry � config_filesrV �instancedata_type�
userdata_file�supplemental_config_files� data_partr" r" r% �get_config_paths_from_args s� ���
�
� �� ��
� �������� ��
��r� c C s� t |� t� }t|�\}}d}tt|�dk�}|r)tdd�dd� |D �� � d}g }t|d�D ]�\}} d}
|rHtd |� d
| j� d | j � d �� | j
t j krTt| j
�} n|} z
t
| j | | j
|j|�}
W n^ ty� } z'|js�t|� d
| j� d| j � �� tt| �|d d� |�| j� W Y d} ~ q0d} ~ w ty� } z t|� d
| j��� tt| �|d d� |�| j� W Y d} ~ q0d} ~ ww |
r�|jr�| j }
nt| j�}
t|� d|
��� q0|r�td�dd� |D ��ddd� dS dS )z@Handle provided schema args and perform the appropriate actions.ri r= z!Found cloud-config data types: %sr[ c s s � | ]}t |j�V qd S r7 )r1 rU )r# �cfg_partr" r" r% r� � s � z%handle_schema_args.<locals>.<genexpr>z Fr r� z at �:zInvalid r� z
Error: {}
)r� Nz
Valid schema c s r� r7 r� )r# r� r" r" r% r� � r� zError: Invalid schema: {}
Tr� )r� r@ r� rs r� r rb r� rU rW rV rE rI r� r� rf r r1 r� r� r� )r> r� r� ry r� �nested_output_prefix�multi_config_output� error_types�idxr� �performed_schema_validation�
cfg_schemar� �cfgr" r" r% �handle_schema_args� s� ��� ��������
�
��r� c O s t jtdtjddd� dS )z�Provide a stub for backwards compatibility.
This function is no longer used, but earlier versions of modules
required this function for documentation purposes. This is a stub so
that custom modules do not break on upgrade.
z24.4zbThe 'get_meta_doc()' function is deprecated and will be removed in a future version of cloud-init.r" )�loggerr6 �requested_levelr� r� ri )r �log_with_downgradable_levelr� �logging�WARNING)�_args�_kwargsr" r" r% � get_meta_doc� s �
r� c C s t � } td| �� � dS )zDTool to validate schema of a cloud-config file or print schema docs.r� r )r� r� �
parse_argsr� r" r" r% �main� s r� �__main__)FN)T)FFTr7 )}rG r� r- r� r rA r �sys� urllib.parser$ � collectionsr �
contextlibr �copyr r� r r� r � functoolsr r3 r r r
r r r
r r r� � cloudinitr r r r �cloudinit.cmd.develr �cloudinit.handlersr r �cloudinit.helpersr �cloudinit.log.log_utilr �cloudinit.sourcesr �cloudinit.temp_utilsr �cloudinit.utilr r ry r rz � Exception�netplanr r r
� getLoggerr. r� �REMOTE_SCHEMA_BASE�USERDATA_SCHEMA_FILE� NETWORK_CONFIG_V1_SCHEMA_FILE� NETWORK_CONFIG_V2_SCHEMA_FILEr� rl �keysr� �typing_extensionsr' r( r) r� r4 r? ru rE rH rI rJ rK r� rM rT rX r1 re �
ValueErrorrf rv r� r� r� rs r� r� r� r� r� rW r r r2 r8 �timedrL rM r~ r rx r� r� r� r@ r� r� r� r� r� r� �exitr" r" r" r% �<module> s� ( � �
� �����
����
� )��
�#'����
��
�H�
�*W# �����
�_ �������� � m�����
��
�!����
�H������
�
;
�}@
�