tests/testutils/yaml.py

#
#  Copyright (C) 2019 Bloomberg Finance LP
#
#  This program is free software; you can redistribute it and/or
#  modify it under the terms of the GNU Lesser General Public
#  License as published by the Free Software Foundation; either
#  version 2 of the License, or (at your option) any later version.
#
#  This library is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
#  Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public
#  License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
#  Authors:
#        Angelos Evripiotis <jevripiotis@bloomberg.net>

from buildstream import _yaml


# yaml_file_get_provenance()
#
# Load a yaml file and return its _yaml.ProvenanceInformation object.
#
# This is useful for checking the provenance in BuildStream output is as
# expected.
#
# Args:
#   path (str): The path to the file to be loaded
#   shortname (str): How the path should appear in the error
#   key (str): Optional key to look up in the loaded file
#   indices (list of indexes): Optional index path, in the case of list values
#
# Returns:
#   The ProvenanceInformation of the dict, member or list element
#
def yaml_file_get_provenance(path, shortname, key=None, indices=None):
    file_node = _yaml.load(path, shortname)
    if key:
        required_node = _yaml.node_get(file_node, dict, key, indices=indices)
    else:
        required_node = file_node
    provenance = _yaml.node_get_provenance(required_node)
    assert provenance is not None
    return provenance