def _check_replacement_not_itself_replaced_by_another(src_ref):
# If the document has a replacement, use the replacement as the
# substitution source instead.
if src_ref.is_replacement:
error_message = ('A replacement document cannot itself'
' be replaced by another document.')
raise errors.InvalidDocumentReplacement(schema=src_ref.schema,
name=src_ref.name,
layer=src_ref.layer,
reason=error_message)
def _check_document_with_replacement_field_has_parent(
parent_meta, parent, document):
if not parent_meta or not parent:
error_message = (
'Document replacement requires that the document with '
'`replacement: true` have a parent.')
raise errors.InvalidDocumentReplacement(schema=document.schema,
name=document.name,
layer=document.layer,
reason=error_message)
def _check_non_replacement_and_parent_different_schema_and_name(
parent, document):
if (parent and document.schema == parent.schema
and document.name == parent.name):
error_message = (
'Non-replacement documents cannot have the same `schema` '
'and `metadata.name` as their parent. Either add '
'`replacement: true` to the document or give the document '
'a different name.')
raise errors.InvalidDocumentReplacement(schema=document.schema,
name=document.name,
layer=document.layer,
reason=error_message)
def _check_replacement_and_parent_same_schema_and_name(
parent, document):
# This checks that a document can only be a replacement for
# another document with the same `metadata.name` and `schema`.
if not (document.schema == parent.schema
and document.name == parent.name):
error_message = (
'Document replacement requires that both documents '
'have the same `schema` and `metadata.name`.')
raise errors.InvalidDocumentReplacement(schema=document.schema,
name=document.name,
layer=document.layer,
reason=error_message)
def check_only_one_level_of_replacement(src_ref):
"""Validate that only one level of replacement exists, meaning that
a replacement document cannot itself be replaced by yet another
replacement document.
"""
# If the document has a replacement, use the replacement as the
# substitution source instead.
if src_ref.is_replacement:
error_message = ('A replacement document cannot itself be replaced by '
'another document.')
raise errors.InvalidDocumentReplacement(schema=src_ref.schema,
name=src_ref.name,
layer=src_ref.layer,
reason=error_message)
def check_replacement_and_parent_same_schema_and_name(parent, document):
"""Validate that replacement-child and replacement-parent documents have
the same ``schema`` and ``metadata.name`` values which is a hard
requirement for replacement.
"""
# This checks that a document can only be a replacement for
# another document with the same `metadata.name` and `schema`.
if not (document.schema == parent.schema and document.name == parent.name):
error_message = ('Document replacement requires that both documents '
'have the same `schema` and `metadata.name`.')
raise errors.InvalidDocumentReplacement(schema=document.schema,
name=document.name,
layer=document.layer,
reason=error_message)
def check_child_and_parent_different_metadata_name(parent, document):
"""Validate that "regular" child and parent documents (without a
replacement relationship) have the same ``schema`` but different
``metadata.name``.
"""
if (parent and document.schema == parent.schema
and document.name == parent.name):
error_message = (
'Non-replacement documents cannot have the same `schema` '
'and `metadata.name` as their parent. Either add '
'`replacement: true` to the document or give the document '
'a different name.')
raise errors.InvalidDocumentReplacement(schema=document.schema,
name=document.name,
layer=document.layer,
reason=error_message)
def check_replacement_is_false_uniqueness(document, non_replacement_documents):
"""Validate uniqueness of ``replacement: false`` for each document
identifier.
This check essentially validates that each raw document (which is uniquely
defined by (name, schema, layer)) maps to a unique rendered document
(which is uniquely defined by (name, schema)). This can be done by ensuring
that each (name, schema) pair only has one occurrence of
``replacement: false``.
Normally, a ``replacement: true`` document nukes the ``replacement: false``
parent. But when > 1 ``replacement: false`` documents with same (name,
schema) exist, the raw document unique constraint predominates over the
rendered document unique constraint, resulting in a breakdown in the
rendering process, as confusion occurs over which document to reference
for substitution data and the like.
:param document: current document in the collection that is being processed
:param non_replacement_documents: a set containing tuples of the names and
schemas of all the non-replacement documents
"""
if not document.is_control:
document_identifier = (document['metadata']['name'],
document['schema'])
if document_identifier in non_replacement_documents:
error_message = (
'More than one document with the same name and schema was '
'found, but none has `replacement: true`. Ensure that only 2 '
'documents exist for each replacement and that one has '
'`replacement: true` and the other `replacement: false`.')
raise errors.InvalidDocumentReplacement(schema=document.schema,
name=document.name,
layer=document.layer,
reason=error_message)
else:
non_replacement_documents.add(document_identifier)