add support for '--list-search-paths'

This flag prints all search paths for config files (contains also files
that do not exist).

Author: thorsten-klein

src/west/app/config.py

@@ -54,8 +54,11 @@
 to contain all paths (separated by 'os.pathsep', which is ';' on Windows or
 ':' otherwise): Latter configuration files have precedence in such lists.
 
-The following command prints a list of all configuration files currently
-considered and existing (listed in the order as they are loaded):
+To list all configuration files searched by west config, in the order as they
+are looked up:
+    west config --list-search-paths
+
+To list only existing configs (listed in the order as they are loaded):
     west config --list-paths
 
 To get the value for config option <name>, type:
@@ -118,7 +121,12 @@ def do_add_parser(self, parser_adder):
         group.add_argument(
             '--list-paths',
             action='store_true',
-            help='list all config files that are currently considered by west config',
+            help='list paths of existing config files currently used by west config',
+        )
+        group.add_argument(
+            '--list-search-paths',
+            action='store_true',
+            help='list search paths for west config files',
         )
         group.add_argument(
             '-l', '--list', action='store_true', help='list all options and their values'
@@ -171,17 +179,28 @@ def do_add_parser(self, parser_adder):
 
     def do_run(self, args, user_args):
         delete = args.delete or args.delete_all
-        if args.list:
+        if any([args.list, args.list_paths, args.list_search_paths]):
             if args.name:
-                self.parser.error('-l cannot be combined with name argument')
-        elif not args.name and not args.list_paths:
+                self.parser.error(
+                    (
+                        '-l'
+                        if args.list
+                        else '--list-paths'
+                        if args.list_paths
+                        else '--list-search-paths'
+                    )
+                    + ' cannot be combined with name argument'
+                )
+        elif not args.name:
             self.parser.error('missing argument name (to list all options and values, use -l)')
         elif args.append:
             if args.value is None:
                 self.parser.error('-a requires both name and value')
 
         if args.list_paths:
             self.list_paths(args)
+        elif args.list_search_paths:
+            self.list_search_paths(args)
         elif args.list:
             self.list(args)
         elif delete:
@@ -198,6 +217,11 @@ def list_paths(self, args):
         for config_path in config_paths:
             self.inf(config_path)
 
+    def list_search_paths(self, args):
+        search_paths = self.config.get_search_paths(args.configfile or ALL)
+        for search_path in search_paths:
+            self.inf(search_path)
+
     def list(self, args):
         what = args.configfile or ALL
         for option, value in self.config.items(configfile=what):

tests/test_config.py

@@ -127,6 +127,9 @@ def test_config_list_paths_env(location):
 
 
 def test_config_list_paths():
+    _, err_msg = cmd_raises('config --list-paths pytest.foo', SystemExit)
+    assert '--list-paths cannot be combined with name argument' in err_msg
+
     WEST_CONFIG_LOCAL = os.environ['WEST_CONFIG_LOCAL']
     WEST_CONFIG_GLOBAL = os.environ['WEST_CONFIG_GLOBAL']
     WEST_CONFIG_SYSTEM = os.environ['WEST_CONFIG_SYSTEM']