Source code for deckhand.common.validation_message

# Copyright 2018 AT&T Intellectual Property.  All other rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Indicates document sanity-check validation failure pre- or post-rendering.
DOCUMENT_SANITY_CHECK_FAILURE = 'D001'
# Indicates document post-rendering validation failure.
DOCUMENT_POST_RENDERING_FAILURE = 'D002'


class ValidationMessage(object):
    """ValidationMessage per Airship convention:
    https://github.com/openstack/airship-in-a-bottle/blob/master/doc/source/api-conventions.rst#output-structure  # noqa

    Construction of ``ValidationMessage`` message:

    :param string message: Validation failure message.
    :param boolean error: True or False, if this is an error message.
    :param string name: Identifying name of the validation.
    :param string level: The severity of validation result, as "Error",
        "Warning", or "Info"
    :param string schema: The schema of the document being validated.
    :param string doc_name: The name of the document being validated.
    :param string diagnostic: Information about what lead to the message,
        or details for resolution.
    """

    def __init__(self,
                 message='Document validation error.',
                 error=True,
                 name='Deckhand validation error',
                 level='Error',
                 doc_schema='',
                 doc_name='',
                 doc_layer='',
                 diagnostic=''):
        level = 'Error' if error else 'Info'
        self._output = {
            'message': message,
            'error': error,
            'name': name,
            'documents': [],
            'level': level,
            'kind': self.__class__.__name__
        }
        self._output['documents'].append(
            dict(schema=doc_schema, name=doc_name, layer=doc_layer))
        if diagnostic:
            self._output.update(diagnostic=diagnostic)

    def format_message(self):
        """Return ``ValidationMessage`` message.

        :returns: The ``ValidationMessage`` for the Validation API response.
        :rtype: dict
        """
        return self._output