Current File : //lib/python3/dist-packages/cloudinit/config/schema.py
# This file is part of cloud-init. See LICENSE file for license information.
"""schema.py: Set of module functions for processing cloud-config schema."""
import argparse
import json
import logging
import os
import re
import sys
import textwrap
from collections import defaultdict
from collections.abc import Iterable
from copy import deepcopy
from functools import partial
from itertools import chain
from typing import TYPE_CHECKING, List, NamedTuple, Optional, Type, Union, cast
import yaml
from cloudinit import importer, safeyaml
from cloudinit.stages import Init
from cloudinit.util import error, get_modules_from_dir, load_file
try:
from jsonschema import ValidationError as _ValidationError
ValidationError = _ValidationError
except ImportError:
ValidationError = Exception # type: ignore
LOG = logging.getLogger(__name__)
VERSIONED_USERDATA_SCHEMA_FILE = "versions.schema.cloud-config.json"
# Bump this file when introducing incompatible schema changes.
# Also add new version definition to versions.schema.json.
USERDATA_SCHEMA_FILE = "schema-cloud-config-v1.json"
_YAML_MAP = {True: "true", False: "false", None: "null"}
CLOUD_CONFIG_HEADER = b"#cloud-config"
SCHEMA_DOC_TMPL = """
{name}
{title_underbar}
**Summary:** {title}
{description}
**Internal name:** ``{id}``
**Module frequency:** {frequency}
**Supported distros:** {distros}
{activate_by_schema_keys}{property_header}
{property_doc}
{examples}
"""
SCHEMA_PROPERTY_HEADER = "**Config schema**:"
SCHEMA_PROPERTY_TMPL = "{prefix}**{prop_name}:** ({prop_type}){description}"
SCHEMA_LIST_ITEM_TMPL = (
"{prefix}Each object in **{prop_name}** list supports the following keys:"
)
SCHEMA_EXAMPLES_HEADER = "**Examples**::\n\n"
SCHEMA_EXAMPLES_SPACER_TEMPLATE = "\n # --- Example{0} ---"
DEPRECATED_KEY = "deprecated"
DEPRECATED_PREFIX = "DEPRECATED: "
# type-annotate only if type-checking.
# Consider to add `type_extensions` as a dependency when Bionic is EOL.
if TYPE_CHECKING:
import typing
from typing_extensions import NotRequired, TypedDict
class MetaSchema(TypedDict):
name: str
id: str
title: str
description: str
distros: typing.List[str]
examples: typing.List[str]
frequency: str
activate_by_schema_keys: NotRequired[List[str]]
else:
MetaSchema = dict
class SchemaDeprecationError(ValidationError):
pass
class SchemaProblem(NamedTuple):
path: str
message: str
def format(self) -> str:
return f"{self.path}: {self.message}"
SchemaProblems = List[SchemaProblem]
def _format_schema_problems(
schema_problems: SchemaProblems,
*,
prefix: Optional[str] = None,
separator: str = ", ",
) -> str:
formatted = separator.join(map(lambda p: p.format(), schema_problems))
if prefix:
formatted = f"{prefix}{formatted}"
return formatted
class SchemaValidationError(ValueError):
"""Raised when validating a cloud-config file against a schema."""
def __init__(
self,
schema_errors: Optional[SchemaProblems] = None,
schema_deprecations: Optional[SchemaProblems] = None,
):
"""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),)
"""
message = ""
if schema_errors:
message += _format_schema_problems(
schema_errors, prefix="Cloud config schema errors: "
)
if schema_deprecations:
if message:
message += "\n\n"
message += _format_schema_problems(
schema_deprecations,
prefix="Cloud config schema deprecations: ",
)
super().__init__(message)
self.schema_errors = schema_errors
self.schema_deprecations = schema_deprecations
def has_errors(self) -> bool:
return bool(self.schema_errors)
def is_schema_byte_string(checker, instance):
"""TYPE_CHECKER override allowing bytes for string type
For jsonschema v. 3.0.0+
"""
try:
from jsonschema import Draft4Validator
except ImportError:
return False
return Draft4Validator.TYPE_CHECKER.is_type(
instance, "string"
) or isinstance(instance, (bytes,))
def _add_deprecated_changed_or_new_msg(
config: dict, annotate=False, filter_key=None
) -> str:
"""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
"""
def format_message(key: str):
if not config.get(f"{key}"):
return ""
key_description = config.get(f"{key}_description", "")
v = config.get(
f"{key}_version",
f"<missing {key}_version key, please file a bug report>",
)
msg = f"{key.capitalize()} in version {v}. {key_description}"
if annotate:
return f" {msg}"
# italicised RST - no whitespace between astrisk and text
return f"\n\n*{msg.strip()}*"
# define print order
filter_keys = (
filter_key if filter_key else ["deprecated", "changed", "new"]
)
# build a deprecation/new/changed string
changed_new_deprecated = "".join(map(format_message, filter_keys))
description = config.get("description", "")
return f"{description}{changed_new_deprecated}".rstrip()
def _validator(
_validator,
deprecated: bool,
_instance,
schema: dict,
filter_key: str,
error_type: Type[Exception] = SchemaDeprecationError,
):
"""Jsonschema validator for `deprecated` items.
It raises a instance of `error_type` if deprecated that must be handled,
otherwise the instance is consider faulty.
"""
if deprecated:
msg = _add_deprecated_changed_or_new_msg(
schema, annotate=True, filter_key=[filter_key]
)
yield error_type(msg)
_validator_deprecated = partial(_validator, filter_key="deprecated")
_validator_changed = partial(_validator, filter_key="changed")
def _anyOf(
validator,
anyOf,
instance,
_schema,
error_type: Type[Exception] = SchemaDeprecationError,
):
"""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`.
"""
from jsonschema import ValidationError
all_errors = []
all_deprecations = []
for index, subschema in enumerate(anyOf):
all_errs = list(
validator.descend(instance, subschema, schema_path=index)
)
errs = list(filter(lambda e: not isinstance(e, error_type), all_errs))
deprecations = list(
filter(lambda e: isinstance(e, error_type), all_errs)
)
if not errs:
all_deprecations.extend(deprecations)
break
all_errors.extend(errs)
else:
yield ValidationError(
"%r is not valid under any of the given schemas" % (instance,),
context=all_errors,
)
yield from all_deprecations
def _oneOf(
validator,
oneOf,
instance,
_schema,
error_type: Type[Exception] = SchemaDeprecationError,
):
"""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`.
"""
from jsonschema import ValidationError
subschemas = enumerate(oneOf)
all_errors = []
all_deprecations = []
for index, subschema in subschemas:
all_errs = list(
validator.descend(instance, subschema, schema_path=index)
)
errs = list(filter(lambda e: not isinstance(e, error_type), all_errs))
deprecations = list(
filter(lambda e: isinstance(e, error_type), all_errs)
)
if not errs:
first_valid = subschema
all_deprecations.extend(deprecations)
break
all_errors.extend(errs)
else:
yield ValidationError(
"%r is not valid under any of the given schemas" % (instance,),
context=all_errors,
)
more_valid = [s for i, s in subschemas if validator.is_valid(instance, s)]
if more_valid:
more_valid.append(first_valid)
reprs = ", ".join(repr(schema) for schema in more_valid)
yield ValidationError(
"%r is valid under each of %s" % (instance, reprs)
)
else:
yield from all_deprecations
def get_jsonschema_validator():
"""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
"""
from jsonschema import Draft4Validator, FormatChecker
from jsonschema.validators import create
# Allow for bytes to be presented as an acceptable valid value for string
# type jsonschema attributes in cloud-init's schema.
# This allows #cloud-config to provide valid yaml "content: !!binary | ..."
strict_metaschema = deepcopy(Draft4Validator.META_SCHEMA)
strict_metaschema["additionalProperties"] = False
# This additional label allows us to specify a different name
# than the property key when generating docs.
# This is especially useful when using a "patternProperties" regex,
# otherwise the property label in the generated docs will be a
# regular expression.
# http://json-schema.org/understanding-json-schema/reference/object.html#pattern-properties
strict_metaschema["properties"]["label"] = {"type": "string"}
validator_kwargs = {}
if hasattr(Draft4Validator, "TYPE_CHECKER"): # jsonschema 3.0+
type_checker = Draft4Validator.TYPE_CHECKER.redefine(
"string", is_schema_byte_string
)
validator_kwargs = {
"type_checker": type_checker,
}
else: # jsonschema 2.6 workaround
types = Draft4Validator.DEFAULT_TYPES # pylint: disable=E1101
# Allow bytes as well as string (and disable a spurious unsupported
# assignment-operation pylint warning which appears because this
# code path isn't written against the latest jsonschema).
types["string"] = (str, bytes) # pylint: disable=E1137
validator_kwargs = {"default_types": types}
# Add deprecation handling
validators = dict(Draft4Validator.VALIDATORS)
validators[DEPRECATED_KEY] = _validator_deprecated
validators["changed"] = _validator_changed
validators["oneOf"] = _oneOf
validators["anyOf"] = _anyOf
cloudinitValidator = create(
meta_schema=strict_metaschema,
validators=validators,
version="draft4",
**validator_kwargs,
)
# Add deprecation handling
def is_valid(self, instance, _schema=None, **__):
"""Override version of `is_valid`.
It does ignore instances of `SchemaDeprecationError`.
"""
errors = filter(
lambda e: not isinstance( # pylint: disable=W1116
e, SchemaDeprecationError
),
self.iter_errors(instance, _schema),
)
return next(errors, None) is None
cloudinitValidator.is_valid = is_valid
return (cloudinitValidator, FormatChecker)
def validate_cloudconfig_metaschema(validator, schema: dict, throw=True):
"""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
"""
from jsonschema.exceptions import SchemaError
try:
validator.check_schema(schema)
except SchemaError as err:
# Raise SchemaValidationError to avoid jsonschema imports at call
# sites
if throw:
raise SchemaValidationError(
schema_errors=[
SchemaProblem(
".".join([str(p) for p in err.path]), err.message
)
]
) from err
LOG.warning(
"Meta-schema validation failed, attempting to validate config "
"anyway: %s",
err,
)
def validate_cloudconfig_schema(
config: dict,
schema: Optional[dict] = None,
strict: bool = False,
strict_metaschema: bool = False,
log_details: bool = True,
log_deprecations: bool = False,
):
"""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 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.
"""
if schema is None:
schema = get_schema()
try:
(cloudinitValidator, FormatChecker) = get_jsonschema_validator()
if strict_metaschema:
validate_cloudconfig_metaschema(
cloudinitValidator, schema, throw=False
)
except ImportError:
LOG.debug("Ignoring schema validation. jsonschema is not present")
return
validator = cloudinitValidator(schema, format_checker=FormatChecker())
errors: SchemaProblems = []
deprecations: SchemaProblems = []
for schema_error in sorted(
validator.iter_errors(config), key=lambda e: e.path
):
path = ".".join([str(p) for p in schema_error.path])
problem = (SchemaProblem(path, schema_error.message),)
if isinstance(
schema_error, SchemaDeprecationError
): # pylint: disable=W1116
deprecations += problem
else:
errors += problem
if log_deprecations and deprecations:
message = _format_schema_problems(
deprecations,
prefix="Deprecated cloud-config provided:\n",
separator="\n",
)
LOG.warning(message)
if strict and (errors or deprecations):
raise SchemaValidationError(errors, deprecations)
if errors:
if log_details:
details = _format_schema_problems(
errors,
prefix="Invalid cloud-config provided:\n",
separator="\n",
)
else:
details = (
"Invalid cloud-config provided: "
"Please run 'sudo cloud-init schema --system' to "
"see the schema errors."
)
LOG.warning(details)
class _Annotator:
def __init__(
self,
cloudconfig: dict,
original_content: bytes,
schemamarks: dict,
):
self._cloudconfig = cloudconfig
self._original_content = original_content
self._schemamarks = schemamarks
@staticmethod
def _build_footer(title: str, content: List[str]) -> str:
body = "\n".join(content)
return f"# {title}: -------------\n{body}\n\n"
def _build_errors_by_line(self, schema_problems: SchemaProblems):
errors_by_line = defaultdict(list)
for (path, msg) in schema_problems:
match = re.match(r"format-l(?P<line>\d+)\.c(?P<col>\d+).*", path)
if match:
line, col = match.groups()
errors_by_line[int(line)].append(msg)
else:
col = None
errors_by_line[self._schemamarks[path]].append(msg)
if col is not None:
msg = "Line {line} column {col}: {msg}".format(
line=line, col=col, msg=msg
)
return errors_by_line
@staticmethod
def _add_problems(
problems: List[str],
labels: List[str],
footer: List[str],
index: int,
label_prefix: str = "",
) -> int:
for problem in problems:
label = f"{label_prefix}{index}"
labels.append(label)
footer.append(f"# {label}: {problem}")
index += 1
return index
def _annotate_content(
self,
lines: List[str],
errors_by_line: dict,
deprecations_by_line: dict,
) -> List[str]:
annotated_content = []
error_footer: List[str] = []
deprecation_footer: List[str] = []
error_index = 1
deprecation_index = 1
for line_number, line in enumerate(lines, 1):
errors = errors_by_line[line_number]
deprecations = deprecations_by_line[line_number]
if errors or deprecations:
labels: List[str] = []
error_index = self._add_problems(
errors, labels, error_footer, error_index, label_prefix="E"
)
deprecation_index = self._add_problems(
deprecations,
labels,
deprecation_footer,
deprecation_index,
label_prefix="D",
)
annotated_content.append(line + "\t\t# " + ",".join(labels))
else:
annotated_content.append(line)
annotated_content.extend(
map(
lambda seq: self._build_footer(*seq),
filter(
lambda seq: bool(seq[1]),
(
("Errors", error_footer),
("Deprecations", deprecation_footer),
),
),
)
)
return annotated_content
def annotate(
self,
schema_errors: SchemaProblems,
schema_deprecations: SchemaProblems,
) -> Union[str, bytes]:
if not schema_errors and not schema_deprecations:
return self._original_content
lines = self._original_content.decode().split("\n")
if not isinstance(self._cloudconfig, dict):
# Return a meaningful message on empty cloud-config
return "\n".join(
lines
+ [
self._build_footer(
"Errors", ["# E1: Cloud-config is not a YAML dict."]
)
]
)
errors_by_line = self._build_errors_by_line(schema_errors)
deprecations_by_line = self._build_errors_by_line(schema_deprecations)
annotated_content = self._annotate_content(
lines, errors_by_line, deprecations_by_line
)
return "\n".join(annotated_content)
def annotated_cloudconfig_file(
cloudconfig: dict,
original_content: bytes,
schemamarks: dict,
*,
schema_errors: Optional[SchemaProblems] = None,
schema_deprecations: Optional[SchemaProblems] = None,
) -> Union[str, bytes]:
"""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 schemamarks: Dict with schema marks.
@param schema_errors: Instance of `SchemaProblems`.
@param schema_deprecations: Instance of `SchemaProblems`.
@return Annotated schema
"""
return _Annotator(cloudconfig, original_content, schemamarks).annotate(
schema_errors or [], schema_deprecations or []
)
def validate_cloudconfig_file(config_path, schema, annotate=False):
"""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 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.
"""
content = load_file(config_path, decode=False)
if not content.startswith(CLOUD_CONFIG_HEADER):
errors = [
SchemaProblem(
"format-l1.c1",
'File {0} needs to begin with "{1}"'.format(
config_path, CLOUD_CONFIG_HEADER.decode()
),
),
]
error = SchemaValidationError(errors)
if annotate:
print(
annotated_cloudconfig_file(
{}, content, {}, schema_errors=error.schema_errors
)
)
raise error
try:
if annotate:
cloudconfig, marks = safeyaml.load_with_marks(content)
else:
cloudconfig = safeyaml.load(content)
marks = {}
except (yaml.YAMLError) as e:
line = column = 1
mark = None
if hasattr(e, "context_mark") and getattr(e, "context_mark"):
mark = getattr(e, "context_mark")
elif hasattr(e, "problem_mark") and getattr(e, "problem_mark"):
mark = getattr(e, "problem_mark")
if mark:
line = mark.line + 1
column = mark.column + 1
errors = [
SchemaProblem(
"format-l{line}.c{col}".format(line=line, col=column),
"File {0} is not valid yaml. {1}".format(config_path, str(e)),
),
]
error = SchemaValidationError(errors)
if annotate:
print(
annotated_cloudconfig_file(
{}, content, {}, schema_errors=error.schema_errors
)
)
raise error from e
if not isinstance(cloudconfig, dict):
# Return a meaningful message on empty cloud-config
if not annotate:
raise RuntimeError("Cloud-config is not a YAML dict.")
try:
validate_cloudconfig_schema(
cloudconfig, schema, strict=True, log_deprecations=False
)
except SchemaValidationError as e:
if annotate:
print(
annotated_cloudconfig_file(
cloudconfig,
content,
marks,
schema_errors=e.schema_errors,
schema_deprecations=e.schema_deprecations,
)
)
elif e.schema_deprecations:
message = _format_schema_problems(
e.schema_deprecations,
prefix="Cloud config schema deprecations: ",
separator=", ",
)
print(message)
if e.has_errors(): # We do not consider deprecations as error
raise
def _sort_property_order(value):
"""Provide a sorting weight for documentation of property types.
Weight values ensure 'array' sorted after 'object' which is sorted
after anything else which remains unsorted.
"""
if value == "array":
return 2
elif value == "object":
return 1
return 0
def _flatten(xs):
for x in xs:
if isinstance(x, Iterable) and not isinstance(x, (str, bytes)):
yield from _flatten(x)
else:
yield x
def _collect_subschema_types(property_dict: dict, multi_key: str) -> List[str]:
property_types = []
for subschema in property_dict.get(multi_key, {}):
if subschema.get(DEPRECATED_KEY): # don't document deprecated types
continue
if subschema.get("enum"):
property_types.extend(
[
f"``{_YAML_MAP.get(enum_value, enum_value)}``"
for enum_value in subschema.get("enum", [])
]
)
elif subschema.get("type"):
property_types.append(subschema["type"])
return list(_flatten(property_types))
def _get_property_type(property_dict: dict, defs: dict) -> str:
"""Return a string representing a property type from a given
jsonschema.
"""
_flatten_schema_refs(property_dict, defs)
property_types = property_dict.get("type", [])
if not isinstance(property_types, list):
property_types = [property_types]
# A property_dict cannot have simultaneously more than one of these props
if property_dict.get("enum"):
property_types = [
f"``{_YAML_MAP.get(k, k)}``" for k in property_dict["enum"]
]
elif property_dict.get("oneOf"):
property_types.extend(_collect_subschema_types(property_dict, "oneOf"))
elif property_dict.get("anyOf"):
property_types.extend(_collect_subschema_types(property_dict, "anyOf"))
if len(property_types) == 1:
property_type = property_types[0]
else:
property_types.sort(key=_sort_property_order)
property_type = "/".join(property_types)
items = property_dict.get("items", {})
sub_property_types = items.get("type", [])
if not isinstance(sub_property_types, list):
sub_property_types = [sub_property_types]
# Collect each item type
prune_undefined = bool(sub_property_types)
for sub_item in chain(items.get("oneOf", {}), items.get("anyOf", {})):
sub_type = _get_property_type(sub_item, defs)
if prune_undefined and sub_type == "UNDEFINED":
# If the main object has a type, then sub-schemas are allowed to
# omit the type. Prune subschema undefined types.
continue
sub_property_types.append(sub_type)
if sub_property_types:
if len(sub_property_types) == 1:
return f"{property_type} of {sub_property_types[0]}"
sub_property_types.sort(key=_sort_property_order)
sub_property_doc = f"({'/'.join(sub_property_types)})"
return f"{property_type} of {sub_property_doc}"
return property_type or "UNDEFINED"
def _parse_description(description, prefix) -> str:
"""Parse description from the meta in a format that we can better
display in our docs. This parser does three things:
- Guarantee that a paragraph will be in a single line
- Guarantee that each new paragraph will be aligned with
the first paragraph
- Proper align lists of items
@param description: The original description in the meta.
@param prefix: The number of spaces used to align the current description
"""
list_paragraph = prefix * 3
description = re.sub(r"(\S)\n(\S)", r"\1 \2", description)
description = re.sub(r"\n\n", r"\n\n{}".format(prefix), description)
description = re.sub(
r"\n( +)-", r"\n{}-".format(list_paragraph), description
)
return description
def _flatten_schema_refs(src_cfg: dict, defs: dict):
"""Flatten schema: replace $refs in src_cfg with definitions from $defs."""
if "$ref" in src_cfg:
reference = src_cfg.pop("$ref").replace("#/$defs/", "")
# Update the defined references in subschema for doc rendering
src_cfg.update(defs[reference])
if "items" in src_cfg:
if "$ref" in src_cfg["items"]:
reference = src_cfg["items"].pop("$ref").replace("#/$defs/", "")
# Update the references in subschema for doc rendering
src_cfg["items"].update(defs[reference])
if "oneOf" in src_cfg["items"]:
for sub_schema in src_cfg["items"]["oneOf"]:
if "$ref" in sub_schema:
reference = sub_schema.pop("$ref").replace("#/$defs/", "")
sub_schema.update(defs[reference])
for sub_schema in chain(
src_cfg.get("oneOf", []),
src_cfg.get("anyOf", []),
src_cfg.get("allOf", []),
):
if "$ref" in sub_schema:
reference = sub_schema.pop("$ref").replace("#/$defs/", "")
sub_schema.update(defs[reference])
def _flatten_schema_all_of(src_cfg: dict):
"""Flatten schema: Merge allOf.
If a schema as allOf, then all of the sub-schemas must hold. Therefore
it is safe to merge them.
"""
sub_schemas = src_cfg.pop("allOf", None)
if not sub_schemas:
return
for sub_schema in sub_schemas:
src_cfg.update(sub_schema)
def _get_property_description(prop_config: dict) -> str:
"""Return accumulated property description.
Account for the following keys:
- top-level description key
- any description key present in each subitem under anyOf or allOf
Order and deprecated property description after active descriptions.
Add a trailing stop "." to any description not ending with ":".
"""
def assign_descriptions(
config: dict, descriptions: list, deprecated_descriptions: list
):
if any(
map(
config.get,
("deprecated_version", "changed_version", "new_version"),
)
):
deprecated_descriptions.append(
_add_deprecated_changed_or_new_msg(config)
)
elif config.get("description"):
descriptions.append(_add_deprecated_changed_or_new_msg(config))
oneOf = prop_config.get("oneOf", {})
anyOf = prop_config.get("anyOf", {})
descriptions: list = []
deprecated_descriptions: list = []
assign_descriptions(prop_config, descriptions, deprecated_descriptions)
for sub_item in chain(oneOf, anyOf):
assign_descriptions(sub_item, descriptions, deprecated_descriptions)
# order deprecated descrs last
description = ". ".join(chain(descriptions, deprecated_descriptions))
if description:
description = f" {description}"
return description
def _get_property_doc(schema: dict, defs: dict, prefix=" ") -> str:
"""Return restructured text describing the supported schema properties."""
new_prefix = prefix + " "
properties = []
if schema.get("hidden") is True:
return "" # no docs for this schema
property_keys = [
key
for key in ("properties", "patternProperties")
if "hidden" not in schema or key not in schema["hidden"]
]
property_schemas = [schema.get(key, {}) for key in property_keys]
for prop_schema in property_schemas:
for prop_key, prop_config in prop_schema.items():
_flatten_schema_refs(prop_config, defs)
_flatten_schema_all_of(prop_config)
if prop_config.get("hidden") is True:
continue # document nothing for this property
description = _get_property_description(prop_config)
# Define prop_name and description for SCHEMA_PROPERTY_TMPL
label = prop_config.get("label", prop_key)
properties.append(
SCHEMA_PROPERTY_TMPL.format(
prefix=prefix,
prop_name=label,
description=_parse_description(description, prefix),
prop_type=_get_property_type(prop_config, defs),
)
)
items = prop_config.get("items")
if items:
_flatten_schema_refs(items, defs)
if items.get("properties") or items.get("patternProperties"):
properties.append(
SCHEMA_LIST_ITEM_TMPL.format(
prefix=new_prefix, prop_name=label
)
)
new_prefix += " "
properties.append(
_get_property_doc(items, defs=defs, prefix=new_prefix)
)
for alt_schema in items.get("oneOf", []):
if alt_schema.get("properties") or alt_schema.get(
"patternProperties"
):
properties.append(
SCHEMA_LIST_ITEM_TMPL.format(
prefix=new_prefix, prop_name=label
)
)
new_prefix += " "
properties.append(
_get_property_doc(
alt_schema, defs=defs, prefix=new_prefix
)
)
if (
"properties" in prop_config
or "patternProperties" in prop_config
):
properties.append(
_get_property_doc(
prop_config, defs=defs, prefix=new_prefix
)
)
return "\n\n".join(properties)
def _get_examples(meta: MetaSchema) -> str:
"""Return restructured text describing the meta examples if present."""
examples = meta.get("examples")
if not examples:
return ""
rst_content = SCHEMA_EXAMPLES_HEADER
for count, example in enumerate(examples):
indented_lines = textwrap.indent(example, " ").split("\n")
if rst_content != SCHEMA_EXAMPLES_HEADER:
indented_lines.insert(
0, SCHEMA_EXAMPLES_SPACER_TEMPLATE.format(count + 1)
)
rst_content += "\n".join(indented_lines)
return rst_content
def _get_activate_by_schema_keys_doc(meta: MetaSchema) -> str:
if not meta.get("activate_by_schema_keys"):
return ""
schema_keys = ", ".join(
f"``{k}``" for k in meta["activate_by_schema_keys"]
)
return f"**Activate only on keys:** {schema_keys}\n\n"
def get_meta_doc(meta: MetaSchema, schema: Optional[dict] = None) -> str:
"""Return reStructured text rendering the provided metadata.
@param meta: Dict of metadata to render.
@param schema: Optional module schema, if absent, read global schema.
@raise KeyError: If metadata lacks an expected key.
"""
if schema is None:
schema = get_schema()
if not meta or not schema:
raise ValueError("Expected non-empty meta and schema")
keys = set(meta.keys())
required_keys = {
"id",
"title",
"examples",
"frequency",
"distros",
"description",
"name",
}
optional_keys = {"activate_by_schema_keys"}
error_message = ""
if required_keys - keys:
error_message = "Missing required keys in module meta: {}".format(
required_keys - keys
)
elif keys - required_keys - optional_keys:
error_message = (
"Additional unexpected keys found in module meta: {}".format(
keys - required_keys
)
)
if error_message:
raise KeyError(error_message)
# cast away type annotation
meta_copy = dict(deepcopy(meta))
meta_copy["property_header"] = ""
defs = schema.get("$defs", {})
if defs.get(meta["id"]):
schema = defs.get(meta["id"], {})
schema = cast(dict, schema)
try:
meta_copy["property_doc"] = _get_property_doc(schema, defs=defs)
except AttributeError:
LOG.warning("Unable to render property_doc due to invalid schema")
meta_copy["property_doc"] = ""
if meta_copy["property_doc"]:
meta_copy["property_header"] = SCHEMA_PROPERTY_HEADER
meta_copy["examples"] = _get_examples(meta)
meta_copy["distros"] = ", ".join(meta["distros"])
# Need an underbar of the same length as the name
meta_copy["title_underbar"] = re.sub(r".", "-", meta["name"])
meta_copy["activate_by_schema_keys"] = _get_activate_by_schema_keys_doc(
meta
)
template = SCHEMA_DOC_TMPL.format(**meta_copy)
return template
def get_modules() -> dict:
configs_dir = os.path.dirname(os.path.abspath(__file__))
return get_modules_from_dir(configs_dir)
def load_doc(requested_modules: list) -> str:
"""Load module docstrings
Docstrings are generated on module load. Reduce, reuse, recycle.
"""
docs = ""
all_modules = list(get_modules().values()) + ["all"]
invalid_docs = set(requested_modules).difference(set(all_modules))
if invalid_docs:
error(
"Invalid --docs value {}. Must be one of: {}".format(
list(invalid_docs),
", ".join(all_modules),
),
sys_exit=True,
)
for mod_name in all_modules:
if "all" in requested_modules or mod_name in requested_modules:
(mod_locs, _) = importer.find_module(
mod_name, ["cloudinit.config"], ["meta"]
)
if mod_locs:
mod = importer.import_module(mod_locs[0])
docs += mod.__doc__ or ""
return docs
def get_schema_dir() -> str:
return os.path.join(os.path.dirname(os.path.abspath(__file__)), "schemas")
def get_schema() -> dict:
"""Return jsonschema coalesced from all cc_* cloud-config modules."""
# Note versions.schema.json is publicly consumed by schemastore.org.
# If we change the location of versions.schema.json in github, we need
# to provide an updated PR to
# https://github.com/SchemaStore/schemastore.
# When bumping schema version due to incompatible changes:
# 1. Add a new schema-cloud-config-v#.json
# 2. change the USERDATA_SCHEMA_FILE to cloud-init-schema-v#.json
# 3. Add the new version definition to versions.schema.cloud-config.json
schema_file = os.path.join(get_schema_dir(), USERDATA_SCHEMA_FILE)
full_schema = None
try:
full_schema = json.loads(load_file(schema_file))
except Exception as e:
LOG.warning("Cannot parse JSON schema file %s. %s", schema_file, e)
if not full_schema:
LOG.warning(
"No base JSON schema files found at %s."
" Setting default empty schema",
schema_file,
)
full_schema = {
"$defs": {},
"$schema": "http://json-schema.org/draft-04/schema#",
"allOf": [],
}
return full_schema
def get_meta() -> dict:
"""Return metadata coalesced from all cc_* cloud-config module."""
full_meta = dict()
for (_, mod_name) in get_modules().items():
mod_locs, _ = importer.find_module(
mod_name, ["cloudinit.config"], ["meta"]
)
if mod_locs:
mod = importer.import_module(mod_locs[0])
full_meta[mod.meta["id"]] = mod.meta
return full_meta
def get_parser(parser=None):
"""Return a parser for supported cmdline arguments."""
if not parser:
parser = argparse.ArgumentParser(
prog="cloudconfig-schema",
description="Validate cloud-config files or document schema",
)
parser.add_argument(
"-c",
"--config-file",
help="Path of the cloud-config yaml file to validate",
)
parser.add_argument(
"--system",
action="store_true",
default=False,
help="Validate the system cloud-config userdata",
)
parser.add_argument(
"-d",
"--docs",
nargs="+",
help=(
"Print schema module docs. Choices: all or"
" space-delimited cc_names."
),
)
parser.add_argument(
"--annotate",
action="store_true",
default=False,
help="Annotate existing cloud-config file with errors",
)
return parser
def handle_schema_args(name, args):
"""Handle provided schema args and perform the appropriate actions."""
exclusive_args = [args.config_file, args.docs, args.system]
if len([arg for arg in exclusive_args if arg]) != 1:
error(
"Expected one of --config-file, --system or --docs arguments",
sys_exit=True,
)
if args.annotate and args.docs:
error(
"Invalid flag combination. Cannot use --annotate with --docs",
sys_exit=True,
)
full_schema = get_schema()
if args.docs:
print(load_doc(args.docs))
return
if args.config_file:
config_files = (("user-data", args.config_file),)
else:
if os.getuid() != 0:
error(
"Unable to read system userdata or vendordata as non-root"
" user. Try using sudo.",
sys_exit=True,
)
init = Init(ds_deps=[])
init.fetch(existing="trust")
userdata_file = init.paths.get_ipath("cloud_config")
if not userdata_file:
error(
"Unable to obtain user data file. No instance data available",
sys_exit=True,
)
return # Helps typing
config_files = (("user-data", userdata_file),)
vendor_config_files = (
("vendor-data", init.paths.get_ipath("vendor_cloud_config")),
("vendor2-data", init.paths.get_ipath("vendor2_cloud_config")),
)
for cfg_type, vendor_file in vendor_config_files:
if vendor_file and os.path.exists(vendor_file):
config_files += ((cfg_type, vendor_file),)
if not os.path.exists(config_files[0][1]):
error(
f"Config file {config_files[0][1]} does not exist",
fmt="Error: {}",
sys_exit=True,
)
nested_output_prefix = ""
multi_config_output = bool(len(config_files) > 1)
if multi_config_output:
print(
"Found cloud-config data types: %s"
% ", ".join(cfg_type for cfg_type, _ in config_files)
)
nested_output_prefix = " "
error_types = []
for idx, (cfg_type, cfg_file) in enumerate(config_files, 1):
if multi_config_output:
print(f"\n{idx}. {cfg_type} at {cfg_file}:")
try:
validate_cloudconfig_file(cfg_file, full_schema, args.annotate)
except SchemaValidationError as e:
if not args.annotate:
print(f"{nested_output_prefix}Invalid cloud-config {cfg_file}")
error(
str(e),
fmt=nested_output_prefix + "Error: {}\n",
)
error_types.append(cfg_type)
except RuntimeError as e:
print(f"{nested_output_prefix}Invalid cloud-config {cfg_type}")
error(str(e), fmt=nested_output_prefix + "Error: {}\n")
error_types.append(cfg_type)
else:
cfg = cfg_file if args.config_file else cfg_type
print(f"{nested_output_prefix}Valid cloud-config: {cfg}")
if error_types:
error(
", ".join(error_type for error_type in error_types),
fmt="Error: Invalid cloud-config schema: {}\n",
sys_exit=True,
)
def main():
"""Tool to validate schema of a cloud-config file or print schema docs."""
parser = get_parser()
handle_schema_args("cloudconfig-schema", parser.parse_args())
return 0
if __name__ == "__main__":
sys.exit(main())
# vi: ts=4 expandtab
Mini Shell