Add ability to pass multiple config files

Co-authored-by: Anish Athalye <me@anishathalye.com>

Author: alipatti

src/dotbot/cli.py

@@ -3,7 +3,7 @@
 import subprocess
 import sys
 from argparse import ArgumentParser, RawTextHelpFormatter
-from typing import Any
+from typing import Any, List
 
 import dotbot
 from dotbot.config import ConfigReader, ReadingError
@@ -23,8 +23,10 @@ def add_options(parser: ArgumentParser) -> None:
         default=0,
         help="enable verbose output\n" "-v: typical verbose\n" "-vv: also, set shell commands stderr/stdout to true",
     )
-    parser.add_argument("-d", "--base-directory", help="execute commands from within BASEDIR", metavar="BASEDIR")
-    parser.add_argument("-c", "--config-file", help="run commands given in CONFIGFILE", metavar="CONFIGFILE")
+    parser.add_argument("-d", "--base-directory", help="execute commands from within BASE_DIR", metavar="BASE_DIR")
+    parser.add_argument(
+        "-c", "--config-file", help="run commands given in CONFIG_FILE", metavar="CONFIG_FILE", nargs="+"
+    )
     parser.add_argument(
         "-p",
         "--plugin",
@@ -57,8 +59,8 @@ def add_options(parser: ArgumentParser) -> None:
     )
 
 
-def read_config(config_file: str) -> Any:
-    reader = ConfigReader(config_file)
+def read_config(config_files: List[str]) -> Any:
+    reader = ConfigReader(config_files)
     return reader.get_config()
 
 
@@ -118,17 +120,13 @@ def main() -> None:
             log.error("No configuration file specified")
             sys.exit(1)
         tasks = read_config(options.config_file)
-        if tasks is None:
-            log.warning("Configuration file is empty, no work to do")
-            tasks = []
-        if not isinstance(tasks, list):
-            msg = "Configuration file must be a list of tasks"
-            raise ReadingError(msg)  # noqa: TRY301
+        if not tasks:
+            log.warning("No tasks given in configuration, no work to do")
         if options.base_directory:
             base_directory = os.path.abspath(options.base_directory)
         else:
-            # default to directory of config file
-            base_directory = os.path.dirname(os.path.abspath(options.config_file))
+            # default to directory of first config file
+            base_directory = os.path.dirname(os.path.abspath(options.config_file[0]))
         os.chdir(base_directory)
         _all_plugins[:] = plugins  # for backwards compatibility, see dispatcher.py
         dispatcher = Dispatcher(

src/dotbot/config.py

@@ -1,15 +1,25 @@
 import json
 import os.path
-from typing import Any
+from typing import Any, List
 
 import yaml
 
 from dotbot.util import string
 
 
 class ConfigReader:
-    def __init__(self, config_file_path: str):
-        self._config = self._read(config_file_path)
+    _config: List[Any]
+
+    def __init__(self, config_file_paths: List[str]):
+        self._config = []
+        for path in config_file_paths:
+            config = self._read(path)
+            if config is None:
+                continue
+            if not isinstance(config, list):
+                msg = "Configuration file must be a list of tasks"
+                raise ReadingError(msg)
+            self._config.extend(config)
 
     def _read(self, config_file_path: str) -> Any:
         try:

tests/test_config.py

@@ -37,3 +37,20 @@ def test_json_tabs(home: str, dotfiles: Dotfiles, run_dotbot: Callable[..., None
     run_dotbot("-c", os.path.join(dotfiles.directory, "config.json"), custom=True)
 
     assert os.path.isdir(os.path.join(home, "d"))
+
+
+def test_multiple_config(home: str, dotfiles: Dotfiles, run_dotbot: Callable[..., None]) -> None:
+    """Verify that passing multiple configs works."""
+
+    dotfiles.write("config1.json", json.dumps([{"create": ["~/d1"]}]))
+    dotfiles.write("config2.json", json.dumps([{"create": ["~/d2"]}]))
+
+    run_dotbot(
+        "-c",
+        os.path.join(dotfiles.directory, "config1.json"),
+        os.path.join(dotfiles.directory, "config2.json"),
+        custom=True,
+    )
+
+    assert os.path.isdir(os.path.join(home, "d1"))
+    assert os.path.isdir(os.path.join(home, "d2"))