ó
oBú]c @ s¦ d Z d d l m Z d d l m Z d d l m Z m Z d d l Z d d l m
Z
d d l m Z d d l
Z
d d l Z d d l Z d d l Z d d l Z i d e 6d e 6d
d 6Z d Z d Z d
Z d Z d Z d Z d e f d „ ƒ YZ e d „ Z d „ Z e d „ Z d „ Z! d „ Z" d d „ Z# d d „ Z$ d „ Z% d a& d „ Z' d „ Z( d d „ Z) d „ Z* d! „ Z+ e, d" k r¢e j- e+ ƒ ƒ n d S(# sF schema.py: Set of module functions for processing cloud-config schema.iÿÿÿÿ( t print_function( t importer( t find_modulest load_fileN( t defaultdict( t deepcopyt truet falset nullt UNDEFINEDs
#cloud-configsÍ
{name}
{title_underbar}
**Summary:** {title}
{description}
**Internal name:** ``{id}``
**Module frequency:** {frequency}
**Supported distros:** {distros}
**Config schema**:
{property_doc}
{examples}
s/ {prefix}**{prop_name}:** ({type}) {description}s
**Examples**::
s
# --- Example{0} ---t SchemaValidationErrorc B s e Z d Z d d „ Z RS( s< Raised when validating a cloud-config file against a schema.c C sf | | _ g | D] \ } } d j | | ƒ ^ q } d j d j | ƒ ƒ } t t | ƒ j | ƒ d S( s— Init the exception an n-tuple of schema errors.
@param schema_errors: An n-tuple of the format:
((flat.config.key, msg),)
s {0}: {1}s Cloud config schema errors: {0}s , N( t
schema_errorst formatt joint superR
t __init__( t selfR t
config_keyt messaget error_messages( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyR . s (( ( t __name__t
__module__t __doc__R ( ( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyR
+ s c
C s' y d d l m } m } Wn t k
r; t j d ƒ d SX| | d | ƒ ƒ} d } xg t | j | ƒ d d „ ƒD]G } d j g | j D] } t
| ƒ ^ qŒ ƒ } | | | j f f 7} qv W| r#| rÜ t | ƒ ‚ q#g | D] \ }
} d j
|
| ƒ ^ qã } t j d
d j | ƒ ƒ n d S(
sì Validate provided config meets the schema definition.
@param config: Dict of cloud configuration settings validated against
schema.
@param schema: jsonschema dict describing the supported schema definition
for the cloud config module (config.cc_*).
@param strict: Boolean, when True raise SchemaValidationErrors instead of
logging warnings.
@raises: SchemaValidationError when provided config does not validate
against the provided schema.
iÿÿÿÿ( t Draft4Validatort
FormatCheckers< Ignoring schema validation. python-jsonschema is not presentNt format_checkert keyc S s | j S( N( t path( t e( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt <lambda>R s t .s {0}: {1}s Invalid config:
%ss
( ( t
jsonschemaR R t ImportErrort loggingt debugt sortedt iter_errorsR
R t strR R
R t warning(
t configt schemat strictR R t validatort errorst errort pR t kt msgt messages( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt validate_cloudconfig_schema= s
%++c C s÷ | s
| Si } | r( t | | ƒ } n t t ƒ } d } g } g } xà | D]» \ } } t j d | ƒ }
|
r |
j ƒ \ } } | t | ƒ j | ƒ n d } | | | j | ƒ | d k rå d j d | d | d | ƒ } n | j d j | | ƒ ƒ | d 7} qM W| j
ƒ j d ƒ }
d } x¡ t |
ƒ D]“ \ } } | | d } | rºd j
g t d
t | ƒ ƒ D] } d j | | ƒ ^ qpƒ } | t | ƒ 7} | j | d | ƒ q4| j | ƒ q4W| j d
j d j
| ƒ ƒ ƒ d j
| ƒ S( s| Return contents of the cloud-config file annotated with schema errors.
@param cloudconfig: YAML-loaded dict from the original_content or empty
dict if unparseable.
@param original_content: The contents of a cloud-config file
@param schema_errors: List of tuples from a JSONSchemaValidationError. The
tuples consist of (schemapath, error_message).
i s& format-l(?P<line>\d+)\.c(?P<col>\d+).*s Line {line} column {col}: {msg}t linet colR/ s # E{0}: {1}s
t ,i s E{0}s # s # Errors: -------------
{0}
N( t _schemapath_for_cloudconfigR t listt ret matcht groupst intt appendt NoneR t decodet splitt enumerateR
t ranget len( t cloudconfigt original_contentR t schemapathst errors_by_linet error_countt error_footert annotated_contentR R/ R8 R2 R3 t linest line_numberR+ t countt error_label( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt annotated_cloudconfig_file] sH 5c C s t j j | ƒ s* t d j | ƒ ƒ ‚ n t | d t ƒ} | j t ƒ s£ d d j | t j ƒ ƒ f f } t
| ƒ } | rš t t i | | j
ƒ ƒ n | ‚ n y t j | ƒ } Wnt j k
rÈ} d } } d
}
t | d ƒ r t | d ƒ r t | d ƒ }
n0 t | d ƒ r;t | d ƒ r;t | d ƒ }
n |
r^|
j d } |
j d } n d j d | d
| ƒ d j | t | ƒ ƒ f f } t
| ƒ } | r¿t t i | | j
ƒ ƒ n | ‚ n Xy t | | d t ƒWn8 t
k
r} | rt t | | | j
ƒ ƒ n ‚ n Xd
S( sÖ Validate cloudconfig file adheres to a specific jsonschema.
@param config_path: Path to the yaml cloud-config file to parse.
@param schema: Dict describing a valid jsonschema to validate against.
@param annotate: Boolean set True to print original config file with error
annotations on the offending lines.
@raises SchemaValidationError containing any of schema_errors encountered.
@raises RuntimeError when config_path does not exist.
s Configfile {0} does not existR= s format-l1.c1s" File {0} needs to begin with "{1}"i t context_markt problem_marks format-l{line}.c{col}R2 R3 s File {0} is not valid yaml. {1}R) N( t osR t existst RuntimeErrorR R t Falset
startswitht CLOUD_CONFIG_HEADERR= R
t printRM R t yamlt safe_loadt YAMLErrorR< t hasattrt getattrR2 t columnR% R1 t True( t config_pathR( t annotatet contentR+ R, RB R R2 R\ t mark( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt validate_cloudconfig_fileŽ sJ
c C s | j ƒ j d ƒ } i } d } d } g } xÓt | d ƒ D]Â\ } } t t j | | ƒ j ƒ d ƒ } | j ƒ } | s= | j d ƒ r“ q= n | r¬ | d \ }
} n d }
d } | j d ƒ rê t | ƒ } | d }
| d 7} n d } | j d d ƒ \ } }
x7 | |
k rA| r2| j
ƒ \ }
} q d }
d } q W| rY| d
| } n | j | | f ƒ |
rõ|
j ƒ }
|
j d ƒ rõ| j | d | d
f ƒ xG t d t t
j |
ƒ ƒ ƒ D]$ } | d
t | ƒ } | | | <qÇWqõn | | | <q= W| S( sè Return a dictionary mapping schemapath to original_content line number.
@param config: The yaml.loaded config dictionary of a cloud-config file.
@param original_content: The simple file content of the cloud-config file
s
i s ^(\s*)i t #iÿÿÿÿt s - t :R t [i s .0( R= R> R? RA R7 R8 R9 t stripRT R% t popR; R@ RW RX ( R' RC t
content_linest schema_line_numberst
list_indext RE_YAML_INDENTt scopesRJ R2 t indent_deptht previous_deptht path_prefixR t valuet inner_list_indext list_key( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyR5 Á sJ "
%c C s | j d t ƒ } | t k r_ | j d ƒ r_ g | d D] } t t j | | ƒ ƒ ^ q8 } n t | t ƒ r€ d j | ƒ } n | j d i ƒ } | j d d ƒ } xE | j d i ƒ D]1 } | rÐ | d 7} n | d t | ƒ d 7} q· W| rd j | | ƒ S| S(
sE Return a string representing a property type from a given jsonschema.t typet enumt /t itemsRd t oneOft (t )s
{0} of {1}( t gett SCHEMA_UNDEFINEDR% t _YAML_MAPt
isinstanceR6 R
t _get_property_typeR ( t
property_dictt
property_typeR. Rw t sub_property_typet sub_item( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyR ò s 2
s c
C s½ | d } g } x | j d i ƒ j ƒ D]ƒ \ } } | j d d ƒ } | j t j d | d | d t | ƒ d | j d d ƒ ƒ ƒ d | k r) | j t | d | ƒƒ q) q) Wd j | ƒ S(
sD Return restructured text describing the supported schema properties.s t
propertiest descriptionRd t prefixt prop_nameRt s
s
( R{ Rw R; t SCHEMA_PROPERTY_TMPLR R t replacet _get_property_docR
( R( R† t
new_prefixR„ t prop_keyt prop_configR… ( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyRŠ s
% Rd c C s° | j d ƒ } | s d St } xŠ t | ƒ D]| \ } } | j d ƒ } g | D] } d j | ƒ ^ qN } | t k r• | j d t j | d ƒ ƒ n | d j | ƒ 7} q, W| S( sC Return restructured text describing the schema examples if present.t examplesRd s
s {0}i i ( R{ t SCHEMA_EXAMPLES_HEADERR? R> R t insertt SCHEMA_EXAMPLES_SPACER_TEMPLATER
( R( R† RŽ t rst_contentRK t exampleRI R2 t indented_lines( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt _get_schema_examples s " c C sm t | ƒ } t | ƒ | d <t | ƒ | d <d j | d ƒ | d <t j d d | d ƒ | d <t j | S( s¨ Return reStructured text rendering the provided jsonschema.
@param schema: Dict of jsonschema to render.
@raise KeyError: If schema lacks an expected key.
t property_docRŽ s , t distrosR t -t namet title_underbar( R RŠ R• R
R7 t subt SCHEMA_DOC_TMPLR ( R( t schema_copy( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt get_schema_doc) s c C sÇ t r
t Si d d 6d d 6g d 6} t j j t j j t ƒ ƒ } t | ƒ } xk | j ƒ D]] \ } } t j | d g d g ƒ \ } } | r\ t j
| d ƒ } | d j | j ƒ q\ q\ W| a | S( s> Return jsonschema coalesced from all cc_* cloud-config module.s' http://json-schema.org/draft-04/schema#s $schemas cloud-config-schemat idt allOfs cloudinit.configR( i (
t FULL_SCHEMARP R t dirnamet abspatht __file__R Rw R t find_modulet
import_moduleR; R( ( t full_schemat configs_dirt potential_handlerst _fnamet mod_namet mod_locst _looked_locst mod( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt
get_schema; s c C s$ t | d t j ƒt j d ƒ d S( Nt filei ( RV t syst stderrt exit( R ( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyR, P s c C s| | s! t j d d d d ƒ } n | j d d d d ƒ| j d d
d d d
t d d ƒ| j d d d d
t d d ƒ| S( s0 Return a parser for supported cmdline arguments.t progs cloudconfig-schemaR… s. Validate cloud-config files or document schemas -cs
--config-filet helps. Path of the cloud-config yaml file to validates -ds --doct actiont
store_truet defaults Print schema documentations
--annotates/ Annotate existing cloud-config file with errors( t argparset ArgumentParsert add_argumentRS ( t parser( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt
get_parserU s c C s | j | j g } t | ƒ s+ t | ƒ r8 t d ƒ n t ƒ } | j rÑ y t | j | | j ƒ WnQ t k
r• } | j sÎ t t | ƒ ƒ qÎ qÑ t
k
r· } t t | ƒ ƒ qÑ Xt d j | j ƒ ƒ n | j rx% | d D] } t t
| ƒ ƒ qå Wn d S( s@ Handle provided schema args and perform the appropriate actions.s/ Expected either --config-file argument or --docs Valid cloud-config file {0}R N( t config_filet doct anyt allR, R¯ Rb R_ R
R% RR RV R Rž ( R™ t argst exclusive_argsR§ R t subschema( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt handle_schema_argsd s"
c C s t ƒ } t d | j ƒ ƒ d S( sD Tool to validate schema of a cloud-config file or print schema docs.s cloudconfig-schemai ( R½ RÅ t
parse_args( R¼ ( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt mainz s t __main__(. R t
__future__R t cloudinitR t cloudinit.utilR R R¹ t collectionsR t copyR R! RP R7 R± RW R] RS R< R} R| RU Rœ Rˆ R R‘ t
ValueErrorR
R1 RM Rb R5 R RŠ R• Rž R¡ R¯ R, R½ RÅ RÇ R R³ ( ( ( s; /usr/lib/python2.7/site-packages/cloudinit/config/schema.pyt <module> sF 1 3 1