add tests for multiple west config files

Verify that multiple config files can be specified in the according
environment variable (WEST_CONFIG_SYSTEM, WEST_CONFIG_GLOBAL,
WEST_CONFIG_LOCAL) for each config level.

Author: thorsten-klein

tests/test_config.py

@@ -9,7 +9,7 @@
 from typing import Any
 
 import pytest
-from conftest import chdir, cmd, cmd_raises, update_env
+from conftest import WINDOWS, chdir, cmd, cmd_raises, tmp_west_topdir, update_env
 
 from west import configuration as config
 from west.util import PathType, WestNotFound
@@ -614,6 +614,127 @@ def test_config_precedence():
     assert cfg(f=LOCAL)['pytest']['precedence'] == 'local'
 
 
+def test_config_multiple(config_tmpdir):
+    # Verify that local settings take precedence over global ones,
+    # but that both values are still available, and that setting
+    # either doesn't affect system settings.
+    def write_config(config_file, section, key1, value1, key2, value2):
+        config_file.parent.mkdir(exist_ok=True)
+
+        content = textwrap.dedent(f'''
+        [{section}]
+        {key1} = {value1}
+        {key2} = {value2}
+        ''')
+
+        with open(config_file, 'w') as conf:
+            conf.write(content)
+
+    # config file paths
+    config_dir = pathlib.Path(config_tmpdir) / 'configs'
+    config_s1 = config_dir / 'system 1'
+    config_s2 = config_dir / 'system 2'
+    config_g1 = config_dir / 'global 1'
+    config_g2 = config_dir / 'global 2'
+    config_l1 = config_dir / 'local 1'
+    config_l2 = config_dir / 'local 2'
+
+    # create some configs with
+    # - some individual option per config file
+    # - the same option defined in multiple configs
+    write_config(config_s1, 'sec', 's', '1 !"$&/()=?', 's1', '1 !"$&/()=?')
+    write_config(config_s2, 'sec', 's', '2', 's2', '2')
+    write_config(config_g1, 'sec', 'g', '1', 'g1', '1')
+    write_config(config_g2, 'sec', 'g', '2', 'g2', '2')
+    write_config(config_l1, 'sec', 'l', '1', 'l1', '1')
+    write_config(config_l2, 'sec', 'l', '2', 'l2', '2')
+
+    # use a non-readable config file (does not work on Windows)
+    if not WINDOWS:
+        config_non_readable = config_dir / 'non-readable'
+        config_non_readable.touch()
+        config_non_readable.chmod(0o000)
+        os.environ["WEST_CONFIG_GLOBAL"] = f'{config_g1}{os.pathsep}{config_non_readable}'
+        _, stderr = cmd_raises('config --global some.section', WestNotFound)
+        expected = f"Error while reading one of '{[config_g1, config_non_readable]}'"
+        assert expected in stderr
+
+    # specify multiple configs for each config level (separated by os.pathsep)
+    os.environ["WEST_CONFIG_GLOBAL"] = f'{config_g1}{os.pathsep}{config_g2}'
+    os.environ["WEST_CONFIG_SYSTEM"] = f'{config_s1}{os.pathsep}{config_s2}'
+    os.environ["WEST_CONFIG_LOCAL"] = f'{config_l1}{os.pathsep}{config_l2}'
+
+    # check that all individual options are applied
+    stdout = cmd('config --system sec.s1').rstrip()
+    assert stdout == '1 !"$&/()=?'
+    stdout = cmd('config --system sec.s2').rstrip()
+    assert stdout == '2'
+    stdout = cmd('config --global sec.g1').rstrip()
+    assert stdout == '1'
+    stdout = cmd('config --global sec.g2').rstrip()
+    assert stdout == '2'
+    stdout = cmd('config --local sec.l1').rstrip()
+    assert stdout == '1'
+    stdout = cmd('config --local sec.l2').rstrip()
+    assert stdout == '2'
+
+    # check that options from latest config overrides
+    stdout = cmd('config --system sec.s').rstrip()
+    assert stdout == '2'
+    stdout = cmd('config --global sec.g').rstrip()
+    assert stdout == '2'
+    stdout = cmd('config --local sec.l').rstrip()
+    assert stdout == '2'
+
+    # check that list-paths gives correct output
+    stdout = cmd('config --global --list-paths')
+    assert [str(config_g1), str(config_g2)] == stdout.rstrip().splitlines()
+    stdout = cmd('config --system --list-paths')
+    assert [str(config_s1), str(config_s2)] == stdout.rstrip().splitlines()
+    stdout = cmd('config --local --list-paths')
+    assert [str(config_l1), str(config_l2)] == stdout.rstrip().splitlines()
+
+    # writing not possible if multiple configs are used
+    _, stderr = cmd_raises('config --local sec.l3 3', ValueError)
+    assert f'Cannot set value if multiple configs in use: {[config_l1, config_l2]}' in stderr
+
+    # specify multiple configs for each config level (separated by os.pathsep).
+    # The paths may be relative relative paths, which are always anchored to
+    # west topdir. For the test, the cwd is changed to another cwd to ensure
+    # that relative paths are anchored correctly.
+    # - Step 1: if no west topdir exists it should fail as relative path
+    #           cannot be resolved
+    # - Step 2: relative paths are correctly resolved (anchored to west topdir)
+    msg = "'{file}' is relative but 'west topdir' is not defined"
+    cwd = pathlib.Path('any cwd')
+    cwd.mkdir()
+    with chdir(cwd):
+        config_rel = pathlib.Path('configs') / 'global 2'
+        with update_env({'WEST_CONFIG_GLOBAL': f'{config_g1}{os.pathsep}{config_rel}'}):
+            command = 'config --global --list-paths'
+            exc, _ = cmd_raises(command, WestNotFound)
+            assert msg.format(file=config_rel) in str(exc.value)
+            with tmp_west_topdir('..'):
+                stdout = cmd(command)
+                assert [str(config_g1), str(config_g2)] == stdout.rstrip().splitlines()
+        config_rel = pathlib.Path('configs') / 'system 2'
+        with update_env({'WEST_CONFIG_SYSTEM': f'{config_s1}{os.pathsep}{config_rel}'}):
+            command = 'config --system --list-paths'
+            exc, _ = cmd_raises(command, WestNotFound)
+            assert msg.format(file=config_rel) in str(exc.value)
+            with tmp_west_topdir('..'):
+                stdout = cmd(command)
+                assert [str(config_s1), str(config_s2)] == stdout.rstrip().splitlines()
+        config_rel = pathlib.Path('configs') / 'local 2'
+        with update_env({'WEST_CONFIG_LOCAL': f'{config_l1}{os.pathsep}{config_rel}'}):
+            command = 'config --local --list-paths'
+            exc, _ = cmd_raises(command, WestNotFound)
+            assert msg.format(file=config_rel) in str(exc.value)
+            with tmp_west_topdir('..'):
+                stdout = cmd(command)
+                assert [str(config_l1), str(config_l2)] == stdout.rstrip().splitlines()
+
+
 def test_config_missing_key():
     _, err_msg = cmd_raises('config pytest', SystemExit)
     assert 'invalid configuration option "pytest"; expected "section.key" format' in err_msg