def test_config_update_can_handle_comments(mutable_config):
# Create an outdated config file with comments
scope = spack.config.default_modify_scope()
cfg_file = spack.config.config.get_config_filename(scope, 'packages')
with open(cfg_file, mode='w') as f:
f.write("""
packages:
# system cmake in /usr
cmake:
paths:
[email protected]: /usr
# Another comment after the outdated section
buildable: False
""")
# Try to update it, it should not raise errors
config('update', '-y', 'packages')
# Check data
data = spack.config.get('packages', scope=scope)
assert 'paths' not in data['cmake']
assert 'externals' in data['cmake']
externals = data['cmake']['externals']
assert len(externals) == 1
assert externals[0]['spec'] == '[email protected]'
assert externals[0]['prefix'] == '/usr'
# Check the comment is there
with open(cfg_file) as f:
text = ''.join(f.readlines())
assert '# system cmake in /usr' in text
assert '# Another comment after the outdated section' in text
def test_config_update_can_handle_comments(mutable_config):
# Create an outdated config file with comments
scope = spack.config.default_modify_scope()
cfg_file = spack.config.config.get_config_filename(scope, 'config')
with open(cfg_file, mode='w') as f:
f.write("""
config:
# system cmake in /usr
install_tree: './foo'
# Another comment after the outdated section
install_hash_length: 7
""")
# Try to update it, it should not raise errors
config('update', '-y', 'config')
# Check data
data = spack.config.get('config', scope=scope)
assert 'root' in data['install_tree']
# Check the comment is there
with open(cfg_file) as f:
text = ''.join(f.readlines())
assert '# system cmake in /usr' in text
assert '# Another comment after the outdated section' in text
def test_config_update_config(config_yaml_v015):
config_yaml_v015()
config('update', '-y', 'config')
# Check the entires have been transformed
data = spack.config.get('config')
check_config_updated(data)
def test_config_add_update_dict_from_file(mutable_empty_config, tmpdir):
config('add', 'packages:all:compiler:[gcc]')
# contents to add to file
contents = """spack:
packages:
all:
version:
- 1.0.0
"""
# create temp file and add it to config
file = str(tmpdir.join('spack.yaml'))
with open(file, 'w') as f:
f.write(contents)
config('add', '-f', file)
# get results
output = config('get', 'packages')
# added config comes before prior config
expected = """packages:
all:
version:
- 1.0.0
compiler: [gcc]
"""
assert expected == output
def test_config_add_to_env_preserve_comments(mutable_empty_config,
mutable_mock_env_path, tmpdir):
filepath = str(tmpdir.join('spack.yaml'))
manifest = """# comment
spack: # comment
# comment
specs: # comment
- foo # comment
# comment
view: true # comment
packages: # comment
# comment
all: # comment
# comment
compiler: [gcc] # comment
"""
with open(filepath, 'w') as f:
f.write(manifest)
env = ev.Environment(str(tmpdir))
with env:
config('add', 'config:dirty:true')
output = config('get')
expected = manifest
expected += """ config:
dirty: true
"""
assert output == expected
def test_config_update_fail_on_permission_issue(packages_yaml_v015,
monkeypatch):
# The first time it will update and create the backup file
packages_yaml_v015()
# Mock a global scope where we cannot write
monkeypatch.setattr(spack.cmd.config, '_can_update_config_file',
lambda x, y: False)
with pytest.raises(spack.main.SpackCommandError):
config('update', '-y', 'packages')
def test_config_edit():
"""Ensure `spack config edit` edits the right paths."""
dms = spack.config.default_modify_scope('compilers')
dms_path = spack.config.config.scopes[dms].path
user_path = spack.config.config.scopes['user'].path
comp_path = os.path.join(dms_path, 'compilers.yaml')
repos_path = os.path.join(user_path, 'repos.yaml')
assert config('edit', '--print-file', 'compilers').strip() == comp_path
assert config('edit', '--print-file', 'repos').strip() == repos_path
def test_updating_multiple_scopes_at_once(packages_yaml_v015):
# Create 2 config files in the old format
packages_yaml_v015(scope='user')
packages_yaml_v015(scope='site')
# Update both of them at once
config('update', '-y', 'packages')
for scope in ('user', 'site'):
data = spack.config.get('packages', scope=scope)
check_update(data)
def test_config_revert_raise_if_cant_write(packages_yaml_v015, monkeypatch):
packages_yaml_v015()
config('update', '-y', 'packages')
# Mock a global scope where we cannot write
monkeypatch.setattr(spack.cmd.config, '_can_revert_update',
lambda x, y, z: False)
# The command raises with an helpful error if a configuration
# file is to be deleted and we don't have sufficient permissions
with pytest.raises(spack.main.SpackCommandError):
config('revert', '-y', 'packages')
def test_config_update_packages(packages_yaml_v015):
"""Test Spack updating old packages.yaml format for externals
to new format. Ensure that data is preserved and converted
properly.
"""
packages_yaml_v015()
config('update', '-y', 'packages')
# Check the entries have been transformed
data = spack.config.get('packages')
check_update(data)
def test_config_add_to_env(mutable_empty_config, mutable_mock_env_path):
env('create', 'test')
with ev.read('test'):
config('add', 'config:dirty:true')
output = config('get')
expected = """ config:
dirty: true
"""
assert expected in output
def test_remove_list(mutable_empty_config):
config('add', 'config:template_dirs:test1')
config('add', 'config:template_dirs:[test2]')
config('add', 'config:template_dirs:test3')
config('remove', 'config:template_dirs:[test2]')
output = config('get', 'config')
assert output == """config:
def test_config_with_c_argument(mutable_empty_config):
# I don't know how to add a spack argument to a Spack Command, so we test this way
config_file = 'config:install_root:root:/path/to/config.yaml'
parser = spack.main.make_argument_parser()
args = parser.parse_args(['-c', config_file])
assert config_file in args.config_vars
# Add the path to the config
config("add", args.config_vars[0], scope='command_line')
output = config("get", 'config')
assert "config:\n install_root:\n root: /path/to/config.yaml" in output
def test_config_add_to_env(mutable_empty_config, mutable_mock_env_path):
env = ev.create('test')
with env:
config('add', 'config:dirty:true')
output = config('get')
expected = ev.default_manifest_yaml
expected += """ config:
dirty: true
"""
assert output == expected
def test_config_add_from_file(mutable_empty_config, tmpdir):
contents = """spack:
config:
dirty: true
"""
file = str(tmpdir.join('spack.yaml'))
with open(file, 'w') as f:
f.write(contents)
config('add', '-f', file)
output = config('get', 'config')
assert output == """config:
def test_config_add_update_dict(mutable_empty_config):
config('add', 'packages:all:compiler:[gcc]')
config('add', 'packages:all:version:1.0.0')
output = config('get', 'packages')
expected = """packages:
all:
compiler: [gcc]
version:
- 1.0.0
"""
assert output == expected
def test_config_add_override_leaf_from_file(mutable_empty_config, tmpdir):
config('--scope', 'site', 'add', 'config:template_dirs:test1')
contents = """spack:
config:
template_dirs:: [test2]
"""
file = str(tmpdir.join('spack.yaml'))
with open(file, 'w') as f:
f.write(contents)
config('add', '-f', file)
output = config('get', 'config')
assert output == """config:
def test_config_remove_from_env(mutable_empty_config, mutable_mock_env_path):
env('create', 'test')
with ev.read('test'):
config('add', 'config:dirty:true')
with ev.read('test'):
config('rm', 'config:dirty')
output = config('get')
expected = ev.default_manifest_yaml()
expected += """ config: {}
"""
assert output == expected
def test_config_add_invalid_file_fails(tmpdir):
# contents to add to file
# invalid because version requires a list
contents = """spack:
packages:
all:
version: 1.0.0
"""
# create temp file and add it to config
file = str(tmpdir.join('spack.yaml'))
with open(file, 'w') as f:
f.write(contents)
with pytest.raises((spack.config.ConfigFormatError)):
config('add', '-f', file)
def test_config_revert(packages_yaml_v015):
cfg_file = packages_yaml_v015()
bkp_file = cfg_file + '.bkp'
config('update', '-y', 'packages')
# Check that the backup file exists, compute its md5 sum
assert os.path.exists(bkp_file)
md5bkp = fs.md5sum(bkp_file)
config('revert', '-y', 'packages')
# Check that the backup file does not exist anymore and
# that the md5 sum of the configuration file is the same
# as that of the old backup file
assert not os.path.exists(bkp_file)
assert md5bkp == fs.md5sum(cfg_file)
def test_config_add_override_leaf(mutable_empty_config):
config('--scope', 'site', 'add', 'config:template_dirs:test1')
config('add', 'config:template_dirs:[test2]')
output = config('get', 'config')
assert output == """config:
template_dirs:
- test2
- test1
"""
config('add', 'config:template_dirs::[test2]')
output = config('get', 'config')
assert output == """config:
def test_config_update_works_for_empty_paths(mutable_config):
scope = spack.config.default_modify_scope()
cfg_file = spack.config.config.get_config_filename(scope, 'config')
with open(cfg_file, mode='w') as f:
f.write("""
config:
install_tree: ''
""")
# Try to update it, it should not raise errors
output = config('update', '-y', 'config')
# This ensures that we updated the configuration
assert '[backup=' in output
def test_config_prefer_upstream(tmpdir_factory, install_mockery, mock_fetch,
mutable_config, gen_mock_layout, monkeypatch):
"""Check that when a dependency package is recorded as installed in
an upstream database that it is not reinstalled.
"""
mock_db_root = str(tmpdir_factory.mktemp('mock_db_root'))
prepared_db = spack.database.Database(mock_db_root)
upstream_layout = gen_mock_layout('/a/')
for spec in [
'hdf5 +mpi',
'hdf5 ~mpi',
'boost+debug~icu+graph',
'dependency-install',
'patch']:
dep = spack.spec.Spec(spec)
dep.concretize()
prepared_db.add(dep, upstream_layout)
downstream_db_root = str(
tmpdir_factory.mktemp('mock_downstream_db_root'))
db_for_test = spack.database.Database(
downstream_db_root, upstream_dbs=[prepared_db])
monkeypatch.setattr(spack.store, 'db', db_for_test)
output = config('prefer-upstream')
scope = spack.config.default_modify_scope('packages')
cfg_file = spack.config.config.get_config_filename(scope, 'packages')
packages = syaml.load(open(cfg_file))['packages']
# Make sure only the non-default variants are set.
assert packages['boost'] == {
'compiler': ['[email protected]'],
'variants': '+debug +graph',
'version': ['1.63.0']}
assert packages['dependency-install'] == {
'compiler': ['[email protected]'], 'version': ['2.0']}
# Ensure that neither variant gets listed for hdf5, since they conflict
assert packages['hdf5'] == {
'compiler': ['[email protected]'], 'version': ['2.3']}
# Make sure a message about the conflicting hdf5's was given.
assert '- hdf5' in output
def test_config_update_works_for_empty_paths(mutable_config):
# Create an outdated config file with empty "paths" and "modules"
scope = spack.config.default_modify_scope()
cfg_file = spack.config.config.get_config_filename(scope, 'packages')
with open(cfg_file, mode='w') as f:
f.write("""
packages:
cmake:
paths: {}
modules: {}
buildable: False
""")
# Try to update it, it should not raise errors
output = config('update', '-y', 'packages')
# This ensures that we updated the configuration
assert '[backup=' in output
def test_get_config_scope_merged(mock_low_high_config):
low_path = mock_low_high_config.scopes['low'].path
high_path = mock_low_high_config.scopes['high'].path
fs.mkdirp(low_path)
fs.mkdirp(high_path)
with open(os.path.join(low_path, 'repos.yaml'), 'w') as f:
f.write('''\
repos:
- repo3
''')
with open(os.path.join(high_path, 'repos.yaml'), 'w') as f:
f.write('''\
repos:
- repo1
- repo2
''')
assert config('get', 'repos').strip() == '''repos:
def test_config_get_gets_spack_yaml(mutable_mock_env_path):
env = ev.create('test')
config('get', fail_on_error=False)
assert config.returncode == 1
with env:
config('get', fail_on_error=False)
assert config.returncode == 1
env.write()
assert 'mpileaks' not in config('get')
env.add('mpileaks')
env.write()
assert 'mpileaks' in config('get')
def test_config_add_invalid_fails(mutable_empty_config):
config('add', 'packages:all:variants:+debug')
with pytest.raises((spack.config.ConfigFormatError, AttributeError)):
config('add', 'packages:all:True')
def test_config_update_not_needed(mutable_config):
data_before = spack.config.get('repos')
config('update', '-y', 'repos')
data_after = spack.config.get('repos')
assert data_before == data_after
def test_config_remove_dict(mutable_empty_config):
config('add', 'config:dirty:true')
config('rm', 'config:dirty')
output = config('get', 'config')
assert output == """config: {}
def test_get_config_scope(mock_low_high_config):
assert config('get', 'compilers').strip() == 'compilers: {}'
