Source code for spack.test.util.spack_yaml

# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

import re

import spack.config
from spack.main import SpackCommand

config_cmd = SpackCommand('config')


[docs]def get_config_line(pattern, lines): """Get a configuration line that matches a particular pattern.""" line = next((x for x in lines if re.search(pattern, x)), None) assert line is not None, 'no such line!' return line
[docs]def check_blame(element, file_name, line=None): """Check that `config blame config` gets right file/line for an element. This runs `spack config blame config` and scrapes the output for a particular YAML key. It thne checks that the requested file/line info is also on that line. Line is optional; if it is ``None`` we just check for the ``file_name``, which may just be a name for a special config scope like ``_builtin`` or ``command_line``. """ output = config_cmd('blame', 'config') blame_lines = output.rstrip().split('\n') element_line = get_config_line(element + ':', blame_lines) annotation = file_name if line is not None: annotation += ':%d' % line assert file_name in element_line
[docs]def test_config_blame(config): """check blame info for elements in mock configuration.""" config_file = config.get_config_filename('site', 'config') check_blame('install_tree', config_file, 2) check_blame('source_cache', config_file, 11) check_blame('misc_cache', config_file, 12) check_blame('verify_ssl', config_file, 13) check_blame('checksum', config_file, 14) check_blame('dirty', config_file, 15)
[docs]def test_config_blame_with_override(config): """check blame for an element from an override scope""" config_file = config.get_config_filename('site', 'config') with spack.config.override('config:install_tree', {'root': 'foobar'}): check_blame('install_tree', 'overrides') check_blame('source_cache', config_file, 11) check_blame('misc_cache', config_file, 12) check_blame('verify_ssl', config_file, 13) check_blame('checksum', config_file, 14) check_blame('dirty', config_file, 15)
[docs]def test_config_blame_defaults(): """check blame for an element from an override scope""" files = {} def get_file_lines(filename): if filename not in files: with open(filename, "r") as f: files[filename] = [""] + f.read().split("\n") return files[filename] config_blame = config_cmd("blame", "config") for line in config_blame.split("\n"): # currently checking only simple lines with dict keys match = re.match(r"^([^:]+):(\d+)\s+([^:]+):\s+(.*)", line) # check that matches are on the lines they say they are if match: filename, line, key, val = match.groups() line = int(line) if val.lower() in ("true", "false"): val = val.lower() lines = get_file_lines(filename) assert key in lines[line] assert val in lines[line]